level51 / silverstripe-jwt-utils
Utilities for dealing with JWT in SilverStripe
Installs: 5 700
Dependents: 1
Suggesters: 0
Security: 0
Stars: 2
Watchers: 4
Forks: 3
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- firebase/php-jwt: ^6.0.0
- nesbot/carbon: ^2.70.0
- ramsey/uuid: ^4.7.4
Requires (Dev)
- phpunit/phpunit: ^9.6.12
- silverstripe/sqlite3: ^3.0.0
This package is auto-updated.
Last update: 2024-10-18 17:50:11 UTC
README
Lean set of helper classes to deal with JWT in SilverStripe setups.
Install
composer require level51/silverstripe-jwt-utils
Example
use Level51\JWTUtils\JWTUtils; use Level51\JWTUtils\JWTUtilsException; class MyTokenController extends Controller { private static $allowed_actions = ['token']; public function token() { try { $payload = JWTUtils::inst()->byBasicAuth($this->request); return json_encode($payload); } catch(JWTUtilsException $e) { return $this->httpError(403, $e->getMessage()); } } }
With correct config and credentials there will be a payload like the following:
{ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZW1iZXJJZCI6MSwiaXNzIjoiaHR0cDpcL1wvc2lsdmVyZ3JvdW5kLm1lXC8iLCJleHAiOjE1MTgyNzMwMjIsImlhdCI6MTUxNzY2ODIyMiwicmF0IjoxNTE3NjY4MjIyLCJqdGkiOiI0ZjIyMjViNS0wMzE5LTQ3YTMtYWNjMy1jOWJlNDk4MDc1NTIifQ.vQLLzmB7rWkwQDomAuC6Bfm-J0ITsIfFq4wL8UMAAJs", "member": { "id": 1, "email": "js@lvl51.de", "firstName": "Julian", "surname": "Scheuchenzuber" } }
Config
Make sure to include an environment variable JWT_SECRET
and pick a random value.
Level51\JWTUtils\JWTUtils: secret: '`JWT_SECRET`' # Secret for signature. This is mandatory and there is no default value lifetime_in_days: 7 # Term of validity renew_threshold_in_minutes: 60 # Keep JWT for at least 60 minutes
API
static inst()
: Get singleton instancebyBasicAuth($request, $includeMemberData: bool = true): array
: Creates a new token from Basic Auth member datarenew($token: string): string
: Checks if the given token is valid and needs to be renewedcheck($token: string): bool
: Checks if token is valid and non-expired
Maintainer
- JZubero js@lvl51.de