diff --git a/README.md b/README.md index 06e193a5..d65bcaf3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # PHP OAuth Framework -The goal of this project is to develop a standards compliant [OAuth 2](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-v2/) authentication server, resource server and client library with support for a major OAuth 2 providers. +The goal of this project is to develop a standards compliant [OAuth 2](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-v2/) authentication server and resource server. ## Package Installation @@ -14,28 +14,25 @@ The framework is provided as a Composer package which can be installed by adding } ``` -## Package Integration +--- -Check out the [wiki](https://github.com/lncd/OAuth2/wiki) +The library features 100% unit test code coverage. To run the tests yourself run `phpunit -c build/phpunit.xml`. ## Current Features ### Authentication Server -The authentication server is a flexible class that supports the following grants: +The authentication server is a flexible class and following core specification grants are implemented: -* authentication code -* refresh token -* client credentials -* password (user credentials) +* authentication 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)) +* client credentials ([section 2.3.1](http://tools.ietf.org/html/rfc6749#section-2.3.1)) +* password (user credentials) ([section 4.3](http://tools.ietf.org/html/rfc6749#section-4.3)) ### 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. - - - ## Future Goals ### Authentication Server @@ -43,10 +40,13 @@ The resource server allows you to secure your API endpoints by checking for a va * Support for [JSON web tokens](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-json-web-token/). * Support for [SAML assertions](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-saml2-bearer/). -### Client support - -* Merge in https://github.com/philsturgeon/codeigniter-oauth2 - --- -This code will be developed as part of the [Linkey](http://linkey.blogs.lincoln.ac.uk) project which has been funded by [JISC](http://jisc.ac.uk) under the Access and Identity Management programme. \ No newline at end of file +This code will be developed as part of the [Linkey](http://linkey.blogs.lincoln.ac.uk) project which has been funded by [JISC](http://jisc.ac.uk) under the Access and Identity Management programme. + +This code was principally developed by [Alex Bilbie](http://alexbilbie.com/) ([Twitter](https://twitter.com/alexbilbie)|[Github](https://github.com/alexbilbie)). + +Valuable contribtions have been made by the following: + +* [Dan Horrigan](http://dandoescode.com) ([Twitter](https://twitter.com/dandoescode)|[Github](https://github.com/dandoescode)) +* [Nick Jackson](http://nickjackson.me) ([Twitter](https://twitter.com/jacksonj04)|[Github](https://github.com/jacksonj04)) \ No newline at end of file