mirror of https://github.com/elyby/oauth2-server.git synced 2024-12-27 15:30:24 +05:30

A spec compliant, secure by default PHP OAuth 2.0 Server

Go to file

Alex Bilbie 4a71c376b8 Merge branch 'refs/heads/master' into develop Conflicts: .travis.yml README.md		2013-09-26 11:18:10 +01:00
sql	Added cascading relationship between oauth_sessions_authcodes and oauth_sessions	2013-05-10 17:32:39 -07:00
src/League/OAuth2/Server	Merge branch 'refs/heads/master' into develop	2013-09-26 11:18:10 +01:00
tests	Normalizing headers to a Ucfirst-With-Dashes format.	2013-08-20 11:40:02 -04:00
.gitattributes	Merge branch 'refs/heads/master' into develop	2013-09-26 11:18:10 +01:00
.gitignore	Cleaned up .gitignore	2013-03-06 17:04:31 +00:00
.travis.yml	Merge branch 'refs/heads/master' into develop	2013-09-26 11:18:10 +01:00
build.xml	Don't remove composer.json and vendor dir	2012-08-06 16:13:27 +01:00
CHANGELOG.md	Updated changelog	2013-06-02 13:54:54 +01:00
composer.json	Added Nyan printer for the lolz	2013-07-30 10:10:59 +01:00
license.txt	Updated License	2013-05-08 19:04:40 -07:00
phpunit.xml	Removed all code coverage output except text to stdout	2013-09-06 10:39:08 +01:00
phpunit.xml.dist	Removed printer [ci skip]	2013-07-30 10:13:47 +01:00
README.md	Merge branch 'refs/heads/master' into develop	2013-09-26 11:18:10 +01:00

README.md

PHP OAuth 2.0 Server

A standards compliant OAuth 2.0 authorization server and resource server written in PHP.

Package Installation

The framework is provided as a Composer package which can be installed by adding the package to your composer.json file:

{
	"require": {
		"league/oauth2-server": "2.*"
	}
}

Master branch

Latest stable version - Code coverage - Downloads -

Develop branch

Latest unstable version - Code coverage -

The library features 100% unit test code coverage. To run the tests yourself run phpunit from the project root.

Current Features

Authorization Server

The authorization server is a flexible class and the following core specification grants are implemented:

authorization code (section 4.1)
refresh token (section 6)
client credentials (section 2.3.1)
password (user credentials) (section 4.3)

An overview of the different OAuth 2.0 grants can be found in the wiki https://github.com/php-loep/oauth2-server/wiki/Which-OAuth-2.0-grant-should-I-use%3F.

Resource Server

The resource server allows you to secure your API endpoints by checking for a valid OAuth access token in the request and ensuring the token has the correct scope(s) (i.e. permissions) to access resources.

Custom grants

Custom grants can be created easily by implementing an interface. Check out a guide here https://github.com/php-loep/oauth2-server/wiki/Creating-custom-grants.

PDO driver

If you are using MySQL and want to very quickly implement the library then all of the storage interfaces have been implemented with PDO classes. Check out the guide here https://github.com/php-loep/oauth2-server/wiki/Using-the-PDO-storage-classes.

Tutorials and documentation

The wiki has lots of guides on how to use this library, check it out - https://github.com/php-loep/oauth2-server/wiki.

A simple tutorial on how to use the authorization server can be found at https://github.com/php-loep/oauth2-server/wiki/Developing-an-OAuth-2.0-authorization-server.

A simple tutorial on how to use the resource server to secure an API server can be found at https://github.com/php-loep/oauth2-server/wiki/Securing-your-API-with-OAuth-2.0.

Changelog

See the project releases page

Contributing

Please see CONTRIBUTING for details.

Support

Bugs and feature request are tracked on GitHub

License

This package is released under the MIT License. See the bundled LICENSE file for details.

Credits

This code is principally developed and maintained by Alex Bilbie.

Special thanks to:

The initial code was developed as part of the Linkey project which was funded by JISC under the Access and Identity Management programme.