mrgswift/oauth2-base-library

A lightweight and powerful OAuth 2.0 authorization and resource server library with support for all the core specification grants. This library will allow you to secure your API with OAuth and allow your applications users to approve apps that want to access their data from your API (modified).

4.2.4 2023-11-13 02:45 UTC

Requires

• php: ^7.3.0|^8.2
• illuminate/database: ^6.20.26 || 7.* || 8.* || 9.*
• league/event: ^2.1 || 3.*
• symfony/http-foundation: ~2.4|~3.0|~4.0|~5.0|~6.0

Requires (Dev)

• mockery/mockery: 0.9.* || ^1.3.1
• phpunit/phpunit: ^6.0 || ^7.0 || ^8.0 || ^9.0

Replaces

• league/oauth2server: *
• lncd/oauth2: *

MIT

• Alex Bilbie

• authorization
• api
• Authentication
• oauth
• oauth2
• server
• auth
• oauth 2.0
• secure
• resource
• protect
• authorisation
• oauth 2

README

A standards compliant OAuth 2.0 authorization server and resource 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.

It supports out of the box the following grants:

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

You can also define your own grants.

In addition it supports the following token types:

• Bearer tokens
• MAC tokens
• JSON web tokens (coming soon)

You can also create you own tokens.

Requirements

The following versions of PHP are supported:

• PHP 5.4
• PHP 5.5
• PHP 5.6
• HHVM

Documentation

This library has full documentation, powered by Jekyll.

Contribute to this documentation in the gh-pages branch.

Changelog

See the project releases page

Contributing

Please see CONTRIBUTING for details.

Integration

• CakePHP 3
• Laravel

Support

Bugs and feature request are tracked on GitHub

Security

If you discover any security related issues, please email [e-mail] 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 Alex Bilbie.

Special thanks to:

• Dan Horrigan
• Nick Jackson
• Michael Gooden
• Phil Sturgeon
• and all the other contributors

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