yiisoft / auth-jwt
Yii auth JWT method
Fund package maintenance!
Opencollective
yiisoft
Installs: 2 322
Dependents: 0
Suggesters: 0
Security: 0
Stars: 34
Watchers: 18
Forks: 10
Open Issues: 1
Requires
- php: ^8.1
- psr/http-message: ^1.0|^2.0
- web-token/jwt-library: ^3.3
- yiisoft/auth: ^3.0
- yiisoft/http: ^1.2
- yiisoft/json: ^1.0
Requires (Dev)
- maglnet/composer-require-checker: ^3.8|^4.2
- nyholm/psr7: ^1.3
- phpunit/phpunit: ^9.5
- rector/rector: ^1.0.0
- roave/infection-static-analysis-plugin: ^1.16
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.30|^5.21
- yiisoft/di: ^1.1
- yiisoft/injector: ^1.1
README
Yii Auth JWT
The package provides JWT authentication method for Yii Auth.
Requirements
- PHP 8.1 or higher.
Installation
The package could be installed with Composer:
composer require yiisoft/auth-jwt
General usage
Configuring within Yii
-
Set JWT parameters in your
params.php
config file:'yiisoft/auth-jwt' => [ 'algorithms' => [ // your signature algorithms ], 'serializers' => [ // your token serializers ], 'key' => [ 'secret' => 'your-secret', 'file' => 'your-certificate-file', ], ],
-
Setup definitions, required for
\Yiisoft\Auth\Middleware\Authentication
middleware in a config, for example, inconfig/web/auth.php
:/** @var array $params */ use Yiisoft\Auth\Jwt\TokenManagerInterface; use Yiisoft\Auth\Jwt\TokenManager; use Yiisoft\Auth\AuthenticationMethodInterface; use Yiisoft\Auth\Jwt\JwtMethod; return [ KeyFactoryInterface::class => [ 'class' => FromSecret::class, '__construct()' => [ $params['yiisoft/auth-jwt']['key']['secret'] ], ], AuthenticationMethodInterface::class => JwtMethod::class, ];
Note: Don't forget to declare your implementations of
\Yiisoft\Auth\IdentityInterface
and\Yiisoft\Auth\IdentityRepositoryInterface
. -
Use
Yiisoft\Auth\Middleware\Authentication
middleware. Read more about middlewares in the middleware guide.
Configuring independently
You can configure Authentication
middleware manually:
/** @var \Yiisoft\Auth\IdentityRepositoryInterface $identityRepository */ $identityRepository = getIdentityRepository(); $tokenRepository = $container->get(\Yiisoft\Auth\Jwt\TokenRepositoryInterface::class); $authenticationMethod = new \Yiisoft\Auth\Jwt\JwtMethod($identityRepository, $tokenRepository); $middleware = new \Yiisoft\Auth\Middleware\Authentication( $authenticationMethod, $responseFactory, // PSR-17 ResponseFactoryInterface. $failureHandler // Optional, \Yiisoft\Auth\Handler\AuthenticationFailureHandler by default. );
Documentation
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii Auth JWT is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.