Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sametsahindogan/laravel-jwtredis
:rocket: 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/sametsahindogan/laravel-jwtredis
facades igbinary jwt jwt-token laravel laravel-framework laravel-jwtredis laravel-permission laravel-swoole middleware php php7 php8 phpredis redis spatie swoole tymondesigns user-identity
Last synced: 23 days ago
JSON representation
:rocket: 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/sametsahindogan/laravel-jwtredis
- Owner: sametsahindogan
- License: mit
- Created: 2020-01-16T11:23:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-10T05:37:37.000Z (over 3 years ago)
- Last Synced: 2024-09-28T19:22:57.900Z (about 1 month ago)
- Topics: facades, igbinary, jwt, jwt-token, laravel, laravel-framework, laravel-jwtredis, laravel-permission, laravel-swoole, middleware, php, php7, php8, phpredis, redis, spatie, swoole, tymondesigns, user-identity
- Language: PHP
- Homepage:
- Size: 113 KB
- Stars: 124
- Watchers: 7
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - sametsahindogan/laravel-jwtredis - :rocket: This package allows JWT-authenticated users to be stored and management in Redis with their roles, permissions, statuses and anything you want. (PHP)
README
# laravel-jwtredis
[](https://packagist.org/packages/sametsahindogan/laravel-jwtredis)
[](https://github.styleci.io/repos/234304505)
[](https://raw.githubusercontent.com/sametsahindogan/laravel-jwtredis/master/LICENSE)
[](https://packagist.org/packages/sametsahindogan/laravel-jwtredis)
> This package allows JWT-authenticated users to be stored and management in Redis with
their roles, permissions, statuses and anything you want.
>Also this package have 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 work with together [tymondesigns/jwt-auth](https://github.com/tymondesigns/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.`!
- If your PHP setup does not have the [Redis](https://github.com/phpredis/phpredis) extension or Laravel's Redis driver is not selected as [phpredis](https://laravel.com/docs/7.x/redis#phpredis), you must install [nrk/predis](https://github.com/nrk/predis) **>= 1.1** (**Recommended 1.1**)
- PHP **>= 7.2.5**
- Laravel **>= 6.0**
- [tymondesigns/jwt-auth](https://github.com/tymondesigns/jwt-auth) **>= 1.0** (**Recommended 1.0.2**)
- [spatie/laravel-permission](https://github.com/spatie/laravel-permission) **>= 4.0** (**Recommended 4.0.0**)
- [sametsahindogan/response-object-creator](https://github.com/sametsahindogan/response-object-creator) **>= 1.0** (**Recommended 1.0.2**)
## Installation
```bash
composer require sametsahindogan/laravel-jwtredis
```
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
'guards' => [
'api' => [
'driver' => 'jwt_redis_guard',
'provider' => 'users'
],
],
'providers' => [
'users' => [
'driver' => 'jwt_redis_user_provider',
'model' => App\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
Sametsahindogan\JWTRedis\JWTRedisServiceProvider::class,
```
You will want to publish the config using the following command:
```bash
php artisan vendor:publish --provider='Sametsahindogan\JWTRedis\JWTRedisServiceProvider'
```
## Configurations
When everything is done, don't forget to add this Trait to your user model.
```php
use JWTRedisHasRoles;
```
You need to add `$routeMiddleware` array in `app/Http/Kernel.php`
```php
'auth' => \Sametsahindogan\JWTRedis\Http\Middleware\Authenticate::class,
'refreshable' => \Sametsahindogan\JWTRedis\Http\Middleware\Refreshable::class,
'role' => \Sametsahindogan\JWTRedis\Http\Middleware\RoleMiddleware::class,
'permission' => \Sametsahindogan\JWTRedis\Http\Middleware\PermissionMiddleware::class,
'role_or_permission' => \Sametsahindogan\JWTRedis\Http\Middleware\RoleOrPermissionMiddleware::class,
```
## 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,
Tymon'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 to 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 refreshes 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/jwtredis.php` file.
* User Model
```php
/*
|--------------------------------------------------------------------------
| Your User Model
|--------------------------------------------------------------------------
|
| You can set specific user model.
|
*/
'user_model' => \App\Models\User::class,
```
* Observer
```php
/*
|--------------------------------------------------------------------------
| JWTRedis User Model Observer
|--------------------------------------------------------------------------
|
| This observer class, listening all events on your user model. Is triggered
| when you assign roles & permissions to user, or update and delete to
| your user model.
|
*/
'observer' => \Sametsahindogan\JWTRedis\Observers\UserRedisObserver::class,
```
* Events Queue
```php
/*
|--------------------------------------------------------------------------
| Observer Events Are Queued
|--------------------------------------------------------------------------
|
| If this option is true, model's events are processed as a job on queue.
| The job will be executed after the database transactions are commit.
|
| * ~ Don't forget to run Queue Worker if this option is true. ~ *
|
*/
'observer_events_queue' => env('JWTREDIS_OBSERVER_EVENTS_QUEUE', false),
```
* Cache Time
```php
/*
|--------------------------------------------------------------------------
| Cache on Redis up to jwt_ttl value.
|--------------------------------------------------------------------------
|
| If it's option is true, user stored in Redis up to jwt_ttl value time.
|
*/
'redis_ttl_jwt' => 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' => env('JWTREDIS_REDIS_TTL', 60),
```
* Cache Prefix
```php
/*
|--------------------------------------------------------------------------
| Cache Prefix
|--------------------------------------------------------------------------
|
| If it's user id is 1, this user stored in Redis as auth_1.
|
*/
'redis_auth_prefix' => env('JWTREDIS_REDIS_AUTH_PREFIX', 'auth_'),
```
* Serialization
```php
/*
|--------------------------------------------------------------------------
| Igbinary Serialization
|--------------------------------------------------------------------------
|
| Igbinary Serialization provides a better performance and lower memory
| usage than PHP Serialization.
|
| * ~ Don't forget to enable igbinary extension if this option is true. ~ *
|
*/
'igbinary_serialization' => env('JWTREDIS_IGBINARY_SERIALIZATION', false),
```
* Banned User Check
```php
/*
|--------------------------------------------------------------------------
| Banned User Checking
|--------------------------------------------------------------------------
|
| If the check_banned_user option is true, that users cannot access
| the your application.
|
*/
'check_banned_user' => env('JWTREDIS_CHECK_BANNED_USER', 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 errors array) that will return in this
| exception.
|
*/
'banned_statuses' => [
'banned',
'deactivate'
],
```
* Relation Caching
```php
/*
|--------------------------------------------------------------------------
| Cache This Relations When User Has Authenticated
|--------------------------------------------------------------------------
|
| You can add this array to your own relations, anything you want to store
| in Redis. We recommend caching only roles and permissions here as much as
| possible.
|
*/
'cache_relations' => [
'roles.permissions',
'permissions'
],
```
* Customize Exceptions
```php
/*
|--------------------------------------------------------------------------
| Customize All Exception Messages and Codes
|--------------------------------------------------------------------------
|
| You can customize error code,message,title for your application.
|
*/
'errors' => [
'TokenNotProvidedException' => [
'title' => 'Your custom title',
'message' => 'Your custom error message.',
'code' => 99999
]
]
```
## Example Project
Here is an [example](https://github.com/sametsahindogan/laravel-jwtredis-example) using laravel-jwtredis. You can examine in detail.
## Performance Improvements Tips
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 igbinary 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 ( Laravel does not support igbinary serialization on Redis. However, this package provides igbinary serialization support for Laravel. Please check `config/jwtredis.php` file. ) 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).
## Integrate with [Laravel Swoole Package](https://github.com/swooletw/laravel-swoole)
This package fully compatible with [Laravel Swoole](https://github.com/swooletw/laravel-swoole) package. If you want to use it together, all you have to do is change the `instances` and `providers` arrays in your `config/swoole_http.php` config as follows:
```php
/*
|--------------------------------------------------------------------------
| Instances here will be cleared on every request.
|--------------------------------------------------------------------------
*/
'instances' => [
'auth'
],
/*
|--------------------------------------------------------------------------
| Providers here will be registered on every request.
|--------------------------------------------------------------------------
*/
'providers' => [
\Sametsahindogan\JWTRedis\JWTRedisServiceProvider::class,
],
```
## License
MIT © [Samet Sahindogan](https://github.com/sametsahindogan/laravel-jwtredis/blob/master/LICENSE)