wolfpack-it/yii2-oauth

Yii2 OAuth2 server implementation of https://oauth2.thephpleague.com/

v2.2.0 2024-03-21 12:01 UTC

Requires

• php: ^8.1
• jc-it/yii2-blameable-behavior: ^1.0.0
• jc-it/yii2-timestamp-behavior: ^1.0.0
• kartik-v/yii2-builder: ^1.6.5
• kartik-v/yii2-icons: ^1.4.5
• lcobucci/jwt: ^5.2.0
• league/oauth2-server: ^8.5.2
• sam-it/yii2-magic: ^2.2.0
• unclead/yii2-multiple-input: ^2.21.3
• yiisoft/yii2: ~2.0.19
• yiisoft/yii2-bootstrap4: ~2.0.1

MIT

• Joey Claessen

README

This extension provides The PHP League: OAuth 2.0 Server module for the Yii2 Framework.

The PHP League: OAuth 2.0 Server is a package that makes setting up a OAuth2 server easy.

Installation

The preferred way to install this extension is through composer.

Either run

$ composer require wolfpack-it/yii2-oauth

or add

"wolfpack-it/yii2-oauth": "^<latest version>"

to the require section of your composer.json file.

Configuring

Configure module

The basic configuration is a module in your application:

'modules' => [
    'oauth' => [
        'class' => \WolfpackIT\oauth\Module::class,
        'userClass' => '<class of ActiveRecordUser implementing UserEntityInterface>',
        'db' => 'db', // component that should be used for the database connection
        'publicKey' => '<path to public key file te be used by CryptKey, or configuration>',
        'privateKey' => '<path to private key file te be used by CryptKey, or configuration>',
        'encryptionKey' => '<random string for encryption>',
        'tokenValidationLeeway' => null|int, // The number of seconds to use as leeway when validating access tokens
    ]
]

See the public variables of the Module for the full configuration options.

An example on how to generate keys can be found here.

Whenever the AccessTokenService is being injected via DI, the module needs to be added to the bootstrap of the application.

Running migrations

The migrations can be ran automatically by adding them to the migration namespaces:

'migrationNamespaces' => [
    'WolfpackIT\oauth\migrations',
    'console\migrations',
]

To get this working, you will need to add an alias:

'aliases' => [
    '@WolfpackIT/oauth' => '@vendor/wolfpack-it/yii2-oauth/src',
]

If you want to override the database connection in the migrations, you will need to bootstrap the oauth module also in the console.

Add routes

To have the module accessible, make sure the correct routes are set in your urlManager.

For example when your module is called oauth:

'urlManager' => [
    'rules' => [
        'oauth/<controller:[\w-]+>/<action:[\w-]+>' => 'oauth/<controller>/<action>'
    ]
]

TODO

• Add tests

Credits

• Joey Claessen
• Wolfpack IT

License

The MIT License (MIT). Please see LICENSE for more information.