Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chantouchsek/laravel-jwtredis
This package allows JWT-authenticated users to be stored and management in Redis with their roles, permissions, statuses and anything you want.
https://github.com/chantouchsek/laravel-jwtredis
auth authorization jwt jwt-laravel jwt-redis jwt-token laravel redis
Last synced: 2 months ago
JSON representation
This package allows JWT-authenticated users to be stored and management in Redis with their roles, permissions, statuses and anything you want.
- Host: GitHub
- URL: https://github.com/chantouchsek/laravel-jwtredis
- Owner: chantouchsek
- License: mit
- Created: 2020-05-23T12:52:15.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T11:18:04.000Z (10 months ago)
- Last Synced: 2024-08-08T21:34:37.697Z (5 months ago)
- Topics: auth, authorization, jwt, jwt-laravel, jwt-redis, jwt-token, laravel, redis
- Language: PHP
- Size: 202 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# laravel-jwt-redis
[](https://packagist.org/packages/chantouch/laravel-jwt-redis)
[](https://github.styleci.io/repos/234304505)
[](https://raw.githubusercontent.com/chantouch/laravel-jwt-redis/master/LICENSE)
[](https://packagist.org/packages/chantouch/laravel-jwt-redis)
> This package allows JWT-authenticated users to be stored and management in Redis with
their roles, permissions, statuses and anything you want.
> This package is originally forked from [sametsahindogan/laravel-jwtredis](https://github.com/sametsahindogan/laravel-jwtredis)
>Also, this package has an observer for listening and updating to your user model
on Redis. This observer is triggered `when you assign roles & permissions to user, or update
and delete to your user` model.
## Requirements
This package works with together [php-open-source-saver/jwt-auth](https://github.com/PHP-Open-Source-Saver/jwt-auth) and [spatie/laravel-permission](https://github.com/spatie/laravel-permission) package under the hood.
 `Make sure to install and configure these dependencies. You must publish, migrate etc. all packages.` 
- [predis/predis](https://github.com/predis/predis) **>= 2.0** (**Recommended 2.2**)
- [php-open-source-saver/jwt-auth](https://github.com/PHP-Open-Source-Saver/jwt-auth) **>= 2.0** (**Recommended 2.2.x**)
- [spatie/laravel-permission](https://github.com/spatie/laravel-permission) **>= 6.0** (**Recommended 6.4**) (Optional)
## Installation
```bash
composer require chantouch/laravel-jwt-redis
```
Once this has finished, you will need to add&change these values in `.env` file:
```dotenv
CACHE_DRIVER=redis
REDIS_CLIENT=predis
```
Next, you will need to change the `guards` and `providers` arrays in your `config/auth.php` config as follows:
```php
[
'api' => [
'driver' => 'jwt_redis',
'provider' => 'users'
],
],
'providers' => [
'users' => [
'driver' => 'jwt_redis_user',
'model' => App\Models\User::class, /* Your User Model */
],
],
];
```
This package uses auto-discovery to register the service provider,
but if you'd rather do it manually, the service provider is:
add to `providers` array in your `config/app.php` config as follows:
```php
Chantouch\JWTRedis\JWTRedisServiceProvider::class,
```
You will want to publish the config using the following command:
```bash
php artisan vendor:publish --provider='Chantouch\JWTRedis\JWTRedisServiceProvider'
```
## Configurations
When everything is done,
remember
to add this Trait to your user model
if you are going to use with [spatie/laravel-permission](https://github.com/spatie/laravel-permission).
```php
use JWTRedisHasRoles;
```
When everything is done, remember to add this Trait to your user model, if you are not use with `laravel-permission`.
```php
use JWTRedis;
```
You need to add `$routeMiddleware` array in `app/Http/Kernel.php`
```php
\Chantouch\JWTRedis\Http\Middleware\Authenticate::class,
'refreshable' => \Chantouch\JWTRedis\Http\Middleware\Refreshable::class,
'role' => \Chantouch\JWTRedis\Http\Middleware\RoleMiddleware::class, // Optional
'permission' => \Chantouch\JWTRedis\Http\Middleware\PermissionMiddleware::class, // Optional
'role_or_permission' => \Chantouch\JWTRedis\Http\Middleware\RoleOrPermissionMiddleware::class, // Optional
];
```
## Usage
You do not have any instructions for use. This package only affects the background, functions in an almost identical way to Laravel session authentication, with a few exceptions. `All you have to do is change your middleware.(I mention this below)` You can use Laravel's Auth facade,
Php saver's JWTAuth facade and all [spatie/laravel-permission](https://github.com/spatie/laravel-permission) package methods as usual.
* For user authentication by token;
(Use this middleware
if the user's identity is not important. This middleware only checks
if Token is valid. Doesn't send any query to any database.)
```php
Route::get("/example", "ExampleController@example")->middleware('auth');
```
* To check user authorization, you need to this one of these middlewares;
( Use this middleware if the user's identity is important. This middlewares fetch user from Redis and mark as authorized
to Laravel's Request object. And you will reach all default Auth facade's methods you want. Just call Laravel's Auth facades.)
```php
Route::get("/example", "ExampleController@example")->middleware('role:admin|user');
Route::get("/example", "ExampleController@example")->middleware('permissions:get-user|set-user');
Route::get("/example", "ExampleController@example")->middleware('role_or_permission:admin|get-user');
```
* To refresh the token, you can add the `refreshable` middleware to the required route. You don't need to take any action on the controller of this route;
(Also this middleware can refresh user from Redis if necessary.)
```php
Route::get("/example", "ExampleController@example")->middleware('refreshable');
```
`If you want to do different things, you can override those mentioned middlewares.`
**After using it as above, every authorization you made in your
application, such as `Auth::user()` or `$user->can('permission')`, is always checked from Redis, not from the database.**
## Options
You can customize some options in that package. Check `config/jwt-redis.php` file.
* User Model
```php
\App\Models\User::class,
];
```
* Observer
```php
Chantouch\JWTRedis\Observers\UserRedisObserver::class,
];
```
* Events Queue
```php
true,
];
```
* Cache Time
```php
true,
/*
|--------------------------------------------------------------------------
| Cache on Redis up to specific time
|--------------------------------------------------------------------------
|
| If you don't want to store user in Redis until JWT expire time,
| you can set this value as minute.
|
*/
'redis_ttl' => 60,
];
```
* Cache Prefix
```php
'auth_',
];
```
* Banned User Check
```php
false,
/*
|--------------------------------------------------------------------------
| Status Column For Banned User Checking
|--------------------------------------------------------------------------
|
| You can set your specific column name of your user model.
|
*/
'status_column_title' => 'status',
/*
|--------------------------------------------------------------------------
| Restricted statuses For Banned User Checking
|--------------------------------------------------------------------------
|
| If the user has one of these statuses and trying to reach your application,
| JWTRedis throws AccountBlockedException.
| You can set the message (check it an error array) that will return in this
| exception.
|
*/
'banned_statuses' => [
'banned',
'deactivate'
],
];
```
* Relation Caching
```php
[
'roles.permissions',
'permissions'
],
];
```
* Customize Exceptions
```php
[
'TokenNotProvidedException' => [
'title' => 'Your custom title',
'message' => 'Your custom error message.',
'code' => 99999
]
],
];
```
## Example Project
Here is an [example](https://github.com/chantouch/laravel-jwt-redis-example) using laravel-jwt-redis. You can examine in detail.
## Performance Improvements Tips
This package requirement the predis package by default.
You may install the PhpRedis PHP extension via PECL. The extension is more complex to install but may yield better performance for applications that make heavy use of Redis. Predis is the alternative for PhpRedis on pure PHP and does not require any additional C extension by default.
"PhpRedis is faster about x6 times.
Using binary serializer reduces stored data size about 3x times.
If Redis installed on separate machines, reducing network traffic is a very significant speedup."
In my opinion, using [PhpRedis](https://github.com/phpredis/phpredis) and serializer as igbinary ([Lodash](https://github.com/akalongman/laravel-lodash) package it provides this for Laravel.) in production environment gives a great performance.
You can review this [article](https://medium.com/@akalongman/phpredis-vs-predis-comparison-on-real-production-data-a819b48cbadb) for performance comparison [PhpRedis](https://github.com/phpredis/phpredis) vs. [Predis](https://github.com/nrk/predis).
## License
MIT © [Sek Chantouch](https://github.com/chantouch/laravel-jwt-redis/blob/master/LICENSE)