klsoft/yii2-jwt-auth

The package provides a Yii 2 authentication method based on a JWT token.

1.0.0 2025-12-31 12:35 UTC

Requires

• php: >=8.0
• firebase/php-jwt: ~7.0.2
• yiisoft/yii2: ~2.0.45

MIT

• yii2 jwt auth

README

The package provides a Yii 2 authentication method based on a JWT token.

Requirement

• PHP 8.0 or higher.

Installation

composer require klsoft/yii2-jwt-auth

How to use

1. Implement Klsoft\Yii2JwtAuth\JwksProviderInterface

Example:

namespace MyNamespace;

use Klsoft\Yii2JwtAuth\JwksProviderInterface;

class JwksProvider implements JwksProviderInterface
{
    private const JWKS = 'jwks';

    public function __construct(private string $jwksUrl)
    {
    }

    function getKeys(): array
    {
        $keys = Yii::$app->cache->get(JwksProvider::JWKS);
        if ($keys === false) {
            $options = [
                'http' => [
                    'ignore_errors' => true,
                    'method' => 'GET'
                ],
            ];
            $responseData = file_get_contents($this->jwksUrl, false, stream_context_create($options));
            if (!empty($responseData)) {
                $keys = json_decode($responseData, true);
                Yii::$app->cache->set(
                    JwksProvider::JWKS, 
                    $keys, Yii::$app->params['jwksKeysCacheDuration']);
                    return $keys;
            }
        } else {
            return $keys;
        }

        return [];
    }
}

2. Add the JWKS URL to param.php

Example:

return [
    'jwksUrl' => 'http://localhost:8080/realms/myrealm/protocol/openid-connect/certs',
    'jwksCacheDuration' => 60 * 3
];

3. Register dependencies

Example of registering dependencies using the application configuration:

'container' => [
        'definitions' => [
            'Klsoft\Yii2JwtAuth\HttpJwtAuth' => [
                'Klsoft\Yii2JwtAuth\HttpJwtAuth',
                [Instance::of('Klsoft\Yii2JwtAuth\JwksProviderInterface')]
            ],
        ],
        'singletons' => [
            'Klsoft\Yii2JwtAuth\JwksProviderInterface' => [
                'MyNamespace\JwksProvider',
                [$params['jwksUrl']]
            ]
        ]
    ]

4. Configure the authenticator behavior

Example:

class MyController extends Controller
{
    public function __construct(private HttpJwtAuth $httpJwtAuth)
    {
    }

    public function behaviors()
    {
        $behaviors = parent::behaviors();
        $behaviors['authenticator'] = $this->httpJwtAuth;
        return $behaviors;
    }
}