oauth2-server/README.md

72 lines
3.3 KiB
Markdown
Raw Normal View History

2014-10-03 19:12:01 +05:30
# PHP OAuth 2.0 Server by [@alexbilbie](https://twitter.com/alexbilbie)
2013-12-06 03:02:29 +05:30
2014-10-01 03:42:43 +05:30
[![Latest Version](http://img.shields.io/packagist/v/league/oauth2-server.svg?style=flat-square)](https://github.com/thephpleague/oauth2-server/releases)
2014-10-03 19:12:01 +05:30
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
2014-10-01 03:42:43 +05:30
[![Build Status](https://img.shields.io/travis/thephpleague/oauth2-server/master.svg?style=flat-square)](https://travis-ci.org/thephpleague/oauth2-server)
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/thephpleague/oauth2-server.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/oauth2-server/code-structure)
[![Quality Score](https://img.shields.io/scrutinizer/g/thephpleague/oauth2-server.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/oauth2-server)
2016-02-22 16:34:03 +05:30
[![Total Downloads](https://img.shields.io/packagist/dt/league/oauth2-server.svg?style=flat-square)](https://packagist.org/packages/league/oauth2-server)
2013-12-06 03:02:29 +05:30
2016-01-13 06:17:27 +05:30
`league/oauth2-server` is a a standards compliant implementation of an [OAuth 2.0](https://tools.ietf.org/html/rfc6749) authorization server written in PHP which makes working with OAuth 2.0 trivial. You can easily configure an OAuth 2.0 server to protect your API with access tokens, or allow clients to request new access tokens and refresh them.
2014-10-01 03:42:43 +05:30
It supports out of the box the following grants:
2014-10-01 03:42:43 +05:30
* Authorization code grant
2016-02-22 16:34:03 +05:30
* Implicit grant
2014-10-01 03:42:43 +05:30
* Client credentials grant
* Resource owner password credentials grant
* Refresh grant
2012-08-27 20:13:17 +05:30
2016-02-22 16:34:03 +05:30
You can also easily define your own grants.
2012-08-27 20:13:17 +05:30
2016-01-13 06:16:08 +05:30
In addition it supports the following token response types:
2013-07-26 15:38:24 +05:30
2016-01-13 06:16:08 +05:30
* Bearer (JWT) tokens
2014-12-28 04:25:30 +05:30
* MAC tokens
2013-07-26 15:38:24 +05:30
2014-12-28 04:25:30 +05:30
You can also create you own tokens.
2014-10-01 03:42:43 +05:30
## Requirements
2013-12-19 18:03:39 +05:30
2014-10-01 03:42:43 +05:30
The following versions of PHP are supported:
2013-12-19 18:03:39 +05:30
2016-01-13 06:16:08 +05:30
* PHP 5.5 (>=5.5.9)
2014-10-01 03:42:43 +05:30
* PHP 5.6
2016-01-13 06:16:08 +05:30
* PHP 7.0
2014-10-01 03:42:43 +05:30
* HHVM
2013-12-19 18:03:39 +05:30
2014-10-01 03:42:43 +05:30
## Documentation
2012-08-27 20:13:17 +05:30
2016-01-15 20:38:10 +05:30
The library documentation can be found at [http://oauth2.thephpleague.com](http://oauth2.thephpleague.com).
2016-01-13 06:16:08 +05:30
You can contribute to this documentation in the [gh-pages branch](https://github.com/thephpleague/oauth2-server/tree/gh-pages/).
2013-02-22 19:01:05 +05:30
## Changelog
2012-08-27 20:13:17 +05:30
2014-10-01 04:46:26 +05:30
[See the project releases page](https://github.com/thephpleague/oauth2-server/releases)
2012-08-27 20:13:17 +05:30
## Contributing
2012-08-27 20:13:17 +05:30
2016-01-13 06:16:08 +05:30
Please see [CONTRIBUTING.md](https://github.com/thephpleague/oauth2-server/blob/master/CONTRIBUTING.md) and [CONDUCT.md](https://github.com/thephpleague/oauth2-server/blob/master/CONDUCT.md) for details.
2013-07-24 22:44:48 +05:30
## Support
2013-07-24 22:44:48 +05:30
2016-02-22 16:34:03 +05:30
Bugs and feature request are tracked on [GitHub](https://github.com/thephpleague/oauth2-server/issues).
If you have any questions about OAuth _please_ open a ticket here; please **don't** email the address below.
2013-07-24 22:44:48 +05:30
2015-02-05 21:44:59 +05:30
## Security
If you discover any security related issues, please email hello@alexbilbie.com instead of using the issue tracker.
## License
2013-07-24 22:44:48 +05:30
2014-10-01 04:46:26 +05:30
This package is released under the MIT License. See the bundled [LICENSE](https://github.com/thephpleague/oauth2-server/blob/master/LICENSE) file for details.
2013-07-24 22:44:48 +05:30
## Credits
2013-07-24 22:44:48 +05:30
This code is principally developed and maintained by [Alex Bilbie](https://twitter.com/alexbilbie).
2012-09-07 16:29:41 +05:30
2016-01-13 06:16:08 +05:30
Special thanks to [all of these awesome contributors](https://github.com/thephpleague/oauth2-server/contributors)
2013-12-06 02:50:48 +05:30
2014-08-06 22:46:16 +05:30
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.