longthanhtran/yii2-oauth2-server

Yii2 OAuth2 authorization server

1.2.0 2021-09-17 10:30 UTC

Requires

• php: >=7.4 || ^8.0
• ext-json: *
• andreyv/yii2-ip-ratelimiter: ^2.3
• guzzlehttp/guzzle: ^7.3
• lcobucci/jwt: ^4.1
• league/oauth2-server: ^8.3
• nesbot/carbon: ^2.52
• yiisoft/yii2: ~2.0.14
• yiisoft/yii2-twig: ^2.4

MIT

• oauth2
• module
• extension
• yii

README

Installation

composer require longthanhtran/yii2-oauth2-server

Notes

• The package serves as Yii2 module to perform 2 main functions of OAuth2 Authorization server. This bases on league/oauth2-server and can run on PHP 7.4 or 8.0.

• Sample module config Review and create a file name modules.php inside config folder with following content. Then append 'modules' => $modules, right inside @app/config/web.php (behind $params key)

use longthanhtran\oauth2\Module;
use League\OAuth2\Server\Grant\AuthCodeGrant;
use League\OAuth2\Server\Grant\ClientCredentialsGrant;
use League\OAuth2\Server\Grant\PasswordGrant;
use League\OAuth2\Server\Grant\RefreshTokenGrant;

return [
    'oauth2' => [
        'class' => 'longthanhtran\oauth2\Module',
        'privateKey' => __DIR__ . '/../keys/private.key',
        'publicKey' => __DIR__ . '/../keys/public.key',
        'encryptionKey' => "you-need-to-prepare-this-encryption-key",
        'enableGrantTypes' => function(Module $module) {
            $server = $module->authorizationServer;

            // Client Credentials Grant
            $server->enableGrantType(
                new ClientCredentialsGrant(),
                new DateInterval('PT1H') // expires after 1 hour
            );

            // Authorization Code Grant
            $authCodeGrant = new AuthCodeGrant(
                $module->authCodeRepository,
                $module->refreshTokenRepository,
                new DateInterval('PT10M') // expires after 10 minutes
            );
            $authCodeGrant->setRefreshTokenTTL(
                new DateInterval('P1M') // expires after 1 month
            );
            $server->enableGrantType(
                $authCodeGrant,
                new DateInterval('PT1H') // expires after 1 hour
            );

            // Refresh Token Grant
            $refreshTokenGrant = new RefreshTokenGrant(
                $module->refreshTokenRepository
            );
            $refreshTokenGrant->setRefreshTokenTTL(
                new DateInterval('P1M') // expires after 1 month
            );
            $server->enableGrantType(
                $refreshTokenGrant,
                new DateInterval('PT1H') // expires after 1 hour
            );
            // Password Grant - legacy grant
            $passwordGrant = new PasswordGrant(
                $module->userRepository,
                $module->refreshTokenRepository
            );
            $passwordGrant->setRefreshTokenTTL(new DateInterval('P1M'));
            $server->enableGrantType(
                $passwordGrant,
                new DateInterval('PT1H') // expires after 1 hour
            );
        }
    ]
];

Be sure to prepare the privateKey, publicKey (in @app/keys folder) and encryption Key. With encryptionKey, you can refer to Cryptography guideline on Yii2's guide.

• To prepare the schema, run migration with

yii migrate --migrationPath=@vendor/longthanhtran/yii2-oauth2-server/oauth2/migrations

• To validate user's credential, you can implement UserEntityInterface for your User class, sample provide below. Be sure to use UserQueryTrait in User

namespace app\models;

use League\OAuth2\Server\Entities\ClientEntityInterface;

trait UserQueryTrait {

    public function getUserEntityByUserCredentials($username,
                                                   $password,
                                                   $grantType,
                                                   ClientEntityInterface $clientEntity)
    {
        $user = User::findOne(['username' => $username]);
        if ($user && $user->validatePassword($password)) {
            return $user;
        }
        return null;
    }
}