JWT-Guard
JWT-Guard is a Laravel package that allow authentication and authorization as a guard driver using JWT tokens., (*1)
, (*2)
Quick Installation
Begin by installing this package through Composer., (*3)
You can run:, (*4)
composer require paulvl/jwt-guard 1.*
Or edit your project's composer.json file to require paulvl/jwt-guard., (*5)
"require": {
"paulvl/jwt-guard": "1.*"
}
Next, update Composer from the Terminal:, (*6)
composer update
Once the package's installation completes, the final step is to add the service provider. Open config/app.php, and add a new item to the providers array:, (*7)
Paulvl\JWTGuard\Auth\AuthServiceProvider::class,
Finally publish package's configuration file:, (*8)
php artisan vendor:publish --provider="Paulvl\JWTGuard\Auth\AuthServiceProvider"
Then the file config/jwt.php will be created., (*9)
JWT Guard
JWT driver setup!
To start using JWT drive you need to create anew guard on config/auth.php file:, (*10)
...
'guards' => [
...
'jwt' => [
'driver' => 'jwt',
'provider' => 'users',
],
...
],
...
You can use any Eloquent provider that you want., (*11)
Using JWT Guard
attempt
// Assuming you retrieve your credentials from request
$credentials = [
'email' => 'test@example.com',
'password' => 'password'
];
//this will return a token array
return Auth::guard('jwt')->attempt($credentials);
blacklistToken
//this will blacklist current jwt-token and referenced refresh token if exists
return Auth::guard('jwt')->blacklistToken();
Using Valid JWT Middleware
if you need to validate Authentication using JWT token request just add Paulvl\JWTGuard\Auth\Middleware\ValidJwt::class to routeMiddleware on Http/Kernel.php file:, (*12)
protected $routeMiddleware = [
...
'valid-jwt' => \Paulvl\JWTGuard\Auth\Middleware\ValidJwt::class,
...
];
then if you need to verify a valid jwt-token, (*13)
Route::middleware('valid-jwt:api_token')->get('/your-route', function (Request $request) {
// any thing tha you need to protect
});
or if you need to verify a valid refresh-token, (*14)
Route::middleware('valid-jwt:refresh_token')->get('/your-route', function (Request $request) {
// your refresh action for example
});
Using Prebuild Controller
JWT-Guard includes a prebuild controller that will handle Login, Token Refreshing and Blacklisting for you. Just add this to your routes file:, (*15)
Route::post('/jwt/login', '\Paulvl\JWTGuard\Http\Controllers\Auth\LoginController@login')->name('jwt.login');
Route::post('/jwt/refresh', '\Paulvl\JWTGuard\Http\Controllers\Auth\LoginController@refresh')->name('jwt.refresh');
Route::post('/jwt/blacklist', '\Paulvl\JWTGuard\Http\Controllers\Auth\LoginController@blacklist')->name('jwt.blacklist');
Contribute and share ;-)
If you like this little piece of code share it with you friends and feel free to contribute with any improvements., (*16)
Wallogit.com
