https://github.com/kakadu-dev/yii2-jwt-auth
Extension provide JWT auth for Yii2
https://github.com/kakadu-dev/yii2-jwt-auth
api authentication jwt rest yii2
Last synced: 12 months ago
JSON representation
Extension provide JWT auth for Yii2
- Host: GitHub
- URL: https://github.com/kakadu-dev/yii2-jwt-auth
- Owner: kakadu-dev
- License: mit
- Created: 2018-10-25T07:28:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-08T07:45:47.000Z (over 6 years ago)
- Last Synced: 2025-06-07T07:15:40.193Z (about 1 year ago)
- Topics: api, authentication, jwt, rest, yii2
- Language: PHP
- Size: 29.3 KB
- Stars: 10
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yii2-jwt-auth
Yii2 JWT Auth
## Installation
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```bash
php composer.phar require --prefer-dist kakadu-dev/yii2-jwt-auth "@dev"
```
or add
```
"kakadu-dev/yii2-jwt-auth": "@dev"
```
to the require section of your `composer.json` file.
## Usage
Once the extension is installed, simply use it in your code by:
Add this package migration namespace, to you console config (console/config/main.php):
```php
return [
'components' => [
'migrate' => [
'class' => yii\console\controllers\MigrateController::class,
// set false if you use namespaces
'migrationPath' => '@console/migrations',
'migrationNamespaces' => [
// ...
'Kakadu\Yii2JwtAuth\migrations',
],
],
],
];
```
Configure api tokens component (e.g. common/config/main.php):
```php
return [
'components' => [
'apiTokens' => [
'class' => \Kakadu\Yii2JwtAuth\ApiTokenService::class,
'secretKey' => '', // set in main-local.php or yii-params.domainSecretKey
'issuer' => 'you-domain-name', // or yii-params.domain
'audience' => ['you-domain-name', 'second-domain-name'], // or yii-params.domain
'audienceSecrets' => [
'you-domain-name' => '', // or yii-params.domainSecretKey
'second-domain-name' => '', // or yii-params.secondDomainSecretKey
],
'seamlessLogin' => false,
],
],
];
```
All values in _secretKey_, _issuer_, _audience_, _audienceSecrets_ which contain _yii-params.param-name_ will be converted to Yii::$app->params['param-name']
TBD: add example for `yii-params.*` config (e.g. for `audienceSecrets`).
Now, after user registration, create JWT tokens and add their in response headers.
Also add an action to update tokens.
E.g.:
```php
class AuthController extends yii\rest\Controller
{
public function actionSignUp()
{
// After create user $newUser
// Same actions for login url
$tokens = \Yii::$app->apiTokens->create($newUser->id, ['someField' => 'someValue']);
\Kakadu\Yii2JwtAuth\JwtBearerAuth::addJwtToHeader(\Yii::$app->response, $tokens);
}
public function actionSignIn()
{
// After verify user login and password
$tokens = \Yii::$app->apiTokens->create($user->id, ['someField' => 'someValue']);
\Kakadu\Yii2JwtAuth\JwtBearerAuth::addJwtToHeader(\Yii::$app->response, $tokens);
}
/**
* Autologin, if access token expired and refresh token not expired.
* This action needed only if 'seamlessLogin' set to false.
*/
public function actionRefreshTokens()
{
// Get from post or headers or ...
$accessToken = Yii::$app->request->post('access_token');
$refreshToken = Yii::$app->request->post('refresh_token');
// Convert to jwt token model
$jwtAccessToken = \Yii::$app->apiTokens->getJwtToken($accessToken);
$jwtRefreshToken = \Yii::$app->apiTokens->getJwtToken($refreshToken);
// Renew
$newTokens = \Yii::$app->apiTokens->renewJwtToken($jwtAccessToken, $jwtRefreshToken);
\Kakadu\Yii2JwtAuth\JwtBearerAuth::addJwtToHeader(\Yii::$app->response, $newTokens);
}
}
```
or use renew tokens action:
```php
use Kakadu\Yii2JwtAuth\RefreshTokensAction;
class AuthController extends yii\rest\Controller
{
/**
* @inheritdoc
*/
public function behaviors(): array
{
return ArrayHelper::merge(parent::behaviors(), [
'authenticator' => [
'class' => JwtBearerAuth::class,
'except' => ['renew-token'],
],
'access' => [
'class' => AccessControl::class,
'rules' => [
[
'allow' => true,
'actions' => ['renew-token'],
'roles' => ['?'],
],
],
],
];
}
/**
* @inheritdoc
*/
public function actions(): array
{
return ArrayHelper::merge(parent::actions(), [
'renew-token' => RefreshTokensAction::class,
]);
}
}
```
And finally add Jwt Auth to secure controller:
```php
class SecureController extends yii\rest\Controller
{
/**
* @inheritdoc
*/
public function behaviors(): array
{
return ArrayHelper::merge(parent::behaviors(), [
'authenticator' => [
'class' => \Kakadu\Yii2JwtAuth\JwtBearerAuth::class,
],
'access' => [
'class' => AccessControl::class,
'rules' => [
...
],
],
]);
}
}
```
**Procedure:**
- seamlessLogin is false
1. Register, get access and refresh token and save their on client side.
1. Use only access token for request to security endpoint.
1. After access token expired, you get 401 Unauthorized exception.
1. _Use expire access and not expire refresh token to get new tokens._ (/refresh-token url)
1. If refresh token expire, go to sign in
- seamlessLogin is true
1. Register, get access and refresh token and save their on client side.
1. Use only access token for request to security endpoint.
1. After access token expired, you get 401 Unauthorized exception.
1. _Repeat request use expire access and not expire refresh token to get new tokens._ (/same url)
1. If refresh token expire, go to sign in.
That's all. Check it.