4.2 KiB
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": "3.*"
}
}
Framework Integrations
- Laravel 4 service provider by @lucadegasperi
- Laravel 4 Eloquent implementation by @ScubaClick (under development)
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
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.