mirror of https://github.com/elyby/oauth2-server.git synced 2024-11-10 07:22:11 +05:30

A spec compliant, secure by default PHP OAuth 2.0 Server

Go to file

Alex Bilbie cf32b5dd1b Readme update		2014-05-23 16:23:40 +01:00
examples/relational	Added ircmaxell/password-compat so PHP 5.4 doesn't error out	2014-05-09 11:15:24 +01:00
src	Removed example SQL	2014-05-09 10:08:00 +01:00
tests	Ensure token works via header	2014-05-10 11:58:00 +01:00
.gitattributes	Merge branch 'refs/heads/master' into develop	2013-09-26 11:18:10 +01:00
.gitignore	Ignore codecept test logs	2014-05-10 11:54:26 +01:00
.travis.yml	Create the codecept logs path and ensure it is writeable	2014-05-10 12:07:33 +01:00
CHANGELOG.md	Updated change log for 3.2	2014-04-09 08:53:45 +01:00
composer.json	Run codesniffer	2014-05-03 11:08:43 +01:00
license.txt	Copyright change	2014-03-09 20:02:06 +00:00
phpunit.xml	First commit of relational example	2014-05-09 10:46:59 +01:00
README.md	Readme update	2014-05-23 16:23:40 +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": "4.*"
	}
}

Storage Adapters

The following adapters have been created by other developers to help you easily integrate this library into your project.

Redis storage adapter by @jasonlewis

If you want to roll your own adapter check out the docs.

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.

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.