scaffoldeducation/jwt-manager-php

PHP library to manage JWT authentication

1.2.0 2021-03-18 17:15 UTC

Requires

• php: ^7.1

Requires (Dev)

• mockery/mockery: ^1.4
• phpmd/phpmd: ^2.8
• phpunit/phpunit: ^9.2
• squizlabs/php_codesniffer: ^3.5

GPL-3.0-only

• Developer

README

PHP library to manage JWT authentication

Installation

Requires PHP 7.1.

• Original source and doc: Kiwfy - JWT Manager PHP

The recommended way to install is through Composer.

composer require scaffoldeducation/jwt-manager-php

Migration

To execute migration on a Lumen system, you will need import JwtManagerServiceProvider in you application:

Open .\bootstrap\app.php and add this line: $app->register(JwtManager\JwtManagerServiceProvider::class);

You can custom blacklist table name at your .env file (default: oauth_jwt_blacklist):

OAUTH_TABLE_BLACKLIST=oauth_jwt_blacklist

Now execute on your terminal this command: php artisan migratre

Usage

Import this library in your application and use:

// expire and renew is seconds (900 = 15 minutes)
$jwt = new JwtManager(string $appSecret, string $context, int $expire, int $renew);

// generete a new token
$token = $jwt->generate(string $audience, string $subject, array $payload);

// to invalid this token, use:
$jwt->turnInvalid($token);

Sample

it's a good idea to look in the sample folder to understand how it works.

First verify if all dependencies is installed (if need anyelse)

composer install --no-dev --prefer-dist

and run

php sample/jwtManager-sample.php