geekdenz / silverstripe-jwt-utils

Utilities for dealing with JWT in SilverStripe

JWT Utils for SilverStripe

Lean set of helper classes to deal with JWT in SilverStripe setups.

Example

class MyTokenController extends Controller {

    private static $allowed_actions = ['token'];
    
    public function token() {
        try {
            $payload = JWTUtils::inst()->byBasicAuth();
            
            return Convert::array2json($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": "[e-mail]",
		"firstName": "Julian",
		"surname": "Scheuchenzuber"
	}
}

Config

JWTUtils:
  secret: 'my-super-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 instance
• byBasicAuth($includeMemberData: bool = true): array: Creates a new token from Basic Auth member data
• renew($token: string): string: Checks if the given token is valid and needs to be renewed
• check($token: string): bool: Checks if token is valid and non-expired

Tests

sake dev/tests/JWTUtilsTest db=sqlite3

Todos

• Option to en-/decrypt the tokens with extra algorithm, e.g. Blowfish
• Tests for time sensitive claims exp, iat and rat

Maintainer

• JZubero [e-mail]