ElyBy-Mirror/oauth2-server
1
0
Fork 0
mirror of https://github.com/elyby/oauth2-server.git synced 2025-01-09 13:27:51 +05:30
Code Issues Packages Projects Releases Wiki Activity

Updated the README

Browse Source
This commit is contained in:
Alex Bilbie 2013-05-08 10:51:56 -07:00
parent 037fd6e4f7
commit 41eef0c3e2
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,6 +1,6 @@
# PHP OAuth Framework # The League of Extraordinary Packages presents: PHP OAuth 2.0 Server
The goal of this project is to develop a standards compliant [OAuth 2](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-v2/) authorization server and resource server. The goal of this project is to develop a standards compliant [OAuth 2.0](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-v2/) authorization server and resource server.
## Package Installation ## Package Installation
@ -9,20 +9,20 @@ The framework is provided as a Composer package which can be installed by adding
```javascript ```javascript
{ {
"require": { "require": {
"league/oauth2server": "2.*" "league/oauth2-server": "2.*"
} }
} }
``` ```
--- ---
The library features 100% unit test code coverage. To run the tests yourself run `phpunit -c build/phpunit.xml`. The library features 100% unit test code coverage. To run the tests yourself run `phpunit` from the project root.
## Current Features ## Current Features
### Authorization Server ### Authorization Server
The authorization server is a flexible class and following core specification grants are implemented: The authorization server is a flexible class and the following core specification grants are implemented:
* authorization code ([section 4.1](http://tools.ietf.org/html/rfc6749#section-4.1)) * authorization code ([section 4.1](http://tools.ietf.org/html/rfc6749#section-4.1))
* refresh token ([section 6](http://tools.ietf.org/html/rfc6749#section-6)) * refresh token ([section 6](http://tools.ietf.org/html/rfc6749#section-6))
@ -33,8 +33,15 @@ An overview of the different OAuth 2.0 grants can be found at [http://alexbilbie
### Resource Server ### 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 permission to access resources. 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](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](https://github.com/php-loep/oauth2-server/wiki/Using-the-PDO-storage-classes).
## Tutorials ## Tutorials
@ -53,6 +60,6 @@ A tutorial on how to use the resource server to secure an API server can be foun
The initial code was developed as part of the [Linkey](http://linkey.blogs.lincoln.ac.uk) project which was funded by [JISC](http://jisc.ac.uk) under the Access and Identity Management programme. The initial code was developed as part of the [Linkey](http://linkey.blogs.lincoln.ac.uk) project which was funded by [JISC](http://jisc.ac.uk) under the Access and Identity Management programme.
This code is principally developed by [Alex Bilbie](http://alexbilbie.com/) ([Twitter](https://twitter.com/alexbilbie)|[Github](https://github.com/alexbilbie)). This code is principally developed and maintained by [@alexbilbie](https://twitter.com/alexbilbie).
A list of contributors can be found at [https://github.com/php-loep/oauth2-server/contributors](https://github.com/php-loep/oauth2-server/contributors). A list of contributors can be found at [https://github.com/php-loep/oauth2-server/contributors](https://github.com/php-loep/oauth2-server/contributors).