Download the PHP package kr-digital/oauth2-bundle without Composer

Trikoder OAuth 2 Bundle

Symfony bundle which provides OAuth 2.0 authorization/resource server capabilities. The authorization and resource server actors are implemented using the thephpleague/oauth2-server library.

Important notes

This bundle provides the "glue" between thephpleague/oauth2-server library and Symfony. It implements thephpleague/oauth2-server library in a way specified by its official documentation. For implementation into Symfony project, please see Symfony security documentation.

Status

This package is currently in the active development.

Features

• API endpoint for client authorization and token issuing
• Configurable client and token persistance (includes Doctrine support)
• Integration with Symfony's Security layer

Requirements

• PHP 7.2 or greater
• Symfony 4.2 or Symfony 3.4
• league/oauth2-server (version 8.x)

Installation

1. Require the bundle and a PSR 7/17 implementation with Composer:

   If your project is managed using Symfony Flex, the rest of the steps are not required. Just follow the post-installation instructions instead! :tada:

   NOTE: This bundle requires a PSR 7/17 implementation to operate. We recommend that you use nyholm/psr7. Check out this document if you wish to use a different implementation.

2. Create the bundle configuration file under config/packages/trikoder_oauth2.yaml. Here is a reference configuration file:

3. Enable the bundle in config/bundles.php by adding it to the array:

4. Update the database so bundle entities can be persisted using Doctrine:

5. Import the routes inside your config/routes.yaml file:

You can verify that everything is working by issuing a POST request to the /token endpoint.

❮ NOTE ❯ It is recommended to control the access to the authorization endpoint so that only logged in users can approve authorization requests. You should review your security.yml file. Here is a sample configuration:

Configuration

• Basic setup
• Controlling token scopes
• Password grant handling

Development

Docker 18.03+ and Docker Compose 1.13+ are required for the development environment.

Building the environment

Make sure your Docker images are all built and up-to-date using the following command:

NOTE: You can target a different version of PHP during development by appending the --build-arg PHP_VERSION=<version> argument.

After that, install all the needed packages required to develop the project:

Testing

You can run the test suite using the following command:

Debugging

You can run the debugger using the following command:

Make sure your IDE is setup properly, for more information check out the dedicated documentation.

Code linting

This bundle enforces the PSR-2 and Symfony code standards during development using the PHP CS Fixer utility. Before committing any code, you can run the utility so it can fix any potential rule violations for you:

Changes

All the package releases are recorded in the CHANGELOG file.

Reporting issues

Use the issue tracker to report any issues you might have.

License

See the LICENSE file for license rights and limitations (MIT).