mirror of https://github.com/elyby/oauth2-server.git synced 2024-11-01 08:23:03 +05:30

A spec compliant, secure by default PHP OAuth 2.0 Server

Go to file

Simon Hamp 009c109716 TravisCI fix for PHPStan		2018-02-26 16:04:48 +00:00
examples	Removing call to setEncryptionKey as no such function on the authorization server	2017-12-29 12:29:47 +00:00
src	TravisCI fix for PHPStan	2018-02-26 16:04:48 +00:00
tests	Fix #837	2018-02-26 15:56:28 +00:00
.gitattributes	fix .gitattributes	2018-01-03 09:41:39 +01:00
.gitignore	Updated .gitignore / .gitattributes files	2016-02-12 17:51:28 +00:00
.scrutinizer.yml	Updated .scrutenizer.yml	2016-04-18 12:23:13 +01:00
.styleci.yml	Create .styleci.yml	2016-02-19 23:08:32 +00:00
.travis.yml	Add code coverage for scrutinizer	2018-02-18 15:33:41 +00:00
CHANGELOG.md	Update changelog	2018-02-26 12:57:11 +00:00
composer.json	Remove paragonie/random_compat	2018-02-26 12:38:31 +00:00
CONDUCT.md	Added code of conduct	2016-01-13 00:46:18 +00:00
CONTRIBUTING.md	Fix #772 - PR should be based on master branch	2017-07-29 17:41:44 +02:00
LICENSE	Rename license file	2015-12-03 14:30:37 +01:00
phpstan.neon	Updated dependencies, more strict static analysis	2018-02-17 18:07:16 +01:00
phpunit.xml.dist	Ignore TemplateRenderer method	2016-03-10 17:45:31 +00:00
README.md	Update changelog link	2018-02-18 15:29:59 +00:00

README.md

PHP OAuth 2.0 Server

league/oauth2-server is a standards compliant implementation of an OAuth 2.0 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.

Out of the box it supports the following grants:

Authorization code grant
Implicit grant
Client credentials grant
Resource owner password credentials grant
Refresh grant

The following RFCs are implemented:

This library was created by Alex Bilbie. Find him on Twitter at @alexbilbie.

Requirements

The following versions of PHP are supported:

PHP 7.0
PHP 7.1
PHP 7.2

The openssl extension is also required.

Installation

composer require league/oauth2-server

Documentation

The library documentation can be found at https://oauth2.thephpleague.com. You can contribute to the documentation in the gh-pages branch.

Testing

The library uses PHPUnit for unit tests and PHPStan for static analysis of the code.

vendor/bin/phpunit
vendor/bin/phpstan analyse -l 6 -c phpstan.neon src tests

Continous Integration

We use Travis CI, Scrutinizer, and StyleCI for continuous integration. Check out our configuration files if you'd like to know more.

Community Integrations

Changelog

See the project changelog

Contributing

Contributions are always welcome. Please see CONTRIBUTING.md and CONDUCT.md for details.

Support

Bugs and feature request are tracked on GitHub.

If you have any questions about OAuth please open a ticket here; please don't email the address below.

Commercial Support

If you would like help implementing this library into your existing platform, or would be interested in OAuth advice or training for you and your team please get in touch with Glynde Labs.

Security

If you discover any security related issues, please email hello@alexbilbie.com instead of using the issue tracker.

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 Andy Millington and Simon Hamp.

Between 2012 and 2017 this library was developed and maintained by Alex Bilbie.

PHP OAuth 2.0 Server is one of many packages provided by The PHP League. To find out more, please visit our website.

Special thanks to all of these awesome contributors.

Additional thanks go to the Mozilla Secure Open Source Fund for funding a security audit of this library.

The initial code was developed as part of the Linkey project which was funded by JISC under the Access and Identity Management programme.