businessprocess / oidc-auth
Package for JWT token auth
v1.0.7
2024-11-27 10:42 UTC
Requires
- php: ^8.0
- firebase/php-jwt: ^6.9
- guzzlehttp/guzzle: ^7.0
Requires (Dev)
- laravel/framework: ^9.0
- laravel/pint: ^1.1
- phpunit/phpunit: ^9.3.3
README
JWT token auth service
Notification messenger channel to Laravel FrameWork v6.0 and above.
Installation
The recommended way to install package is through Composer.
composer require businessprocess/oidc-auth
Usage Laravel
Use middleware 'auth:oidc'
\Illuminate\Support\Facades\Route::middleware(['auth:oidc'])->group(fn() => { })
Configuration setting
Add to auth config file
//Guard [ 'driver' => 'oidc', 'provider' => null, // if null return OidcUser model 'decoder' => null, // Jwt token decoder (JwtDecoder), if null use service decoder ]
Configuration model
class User extends Authenticatable { use \OidcAuth\HasJwtToken; }
Available Methods
| Methods | Description | Return value |
|---|---|---|
| serviceToken | Get service token | string |
| token | Get user token | string |
| userAuthorize | Authorize user by credentials | OidcUser |
| serviceAuthorize | Authorize service by credentials | OidcUser |
| reauthorize | Reauthorize by refresh token | OidcUser |
| check | Validate token | Payload,bool |
| short | Get service short token | string |
| shortUser | Get user short token | string |
| tokenFromShort | Get jwt token from short token | string |
| userFromShort | Get jwt user from short token | User |
| publicKey | Get public key | string |
| alive | Check is node is alive | bool |