xaamin/jwt

PHP Implementation of JSON Web token with RSA

v2.0.2 2024-02-14 01:44 UTC

Requires

• php: ^7.2 || ^8.0
• ext-openssl: *

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^7.5 || ^8.5 || ^9.6
• squizlabs/php_codesniffer: ^3.7

Suggests

• illuminate/support: To use with Laravel/Lumen
• phpseclib/phpseclib: To generate RSA keys to be used for JWT token generation.

MIT

• Benjamín Martínez Mateos

• token
• jwt
• laravel jwt

README

PHP Implementation of JSON Web token with RSA.

Supported algorithms:

RSA (Public Key/Private Key pair)

RS256 - RSA using SHA-256 hash algorithm
RS384 - RSA using SHA-384 hash algorithm
RS512 - RSA using SHA-512 hash algorithm

HMAC algorithms : 

HS256 - HMAC using SHA-256 hash algorithm (default)
HS384 - HMAC using SHA-384 hash algorithm
HS512 - HMAC using SHA-512 hash algorithm

Install

With composer

composer require xaamin/jwt

How to use with RSA public/private key

Set configuration in src/Config/config.php. Don't use key provided here in production.

    'algorithm' => 'RS512',
    
    // ... Other stuff here
    
    'keys' => [
        'public' => '../keys/public_key.pem',
        'private' => '../keys/private_key.pem',
        
        'passphrase' => null,
    ],

	$payload = [
			'sub'   => 1,
			'username' => 'xaamin'
	    ];

	// Generate token
	$token = Xaamin\JWT\Facade\Native\JWT::encode($payload);

	// Verify the token
	try{
		$token = Xaamin\JWT\Facade\Native\JWT::decode($token->get());

	    var_dump($token);
	} catch (Exception $e) {
		echo $e->getMessage();
	}

How to use with HMAC

Set configuration in src/Config/config.php

    'algorithm' => 'HS512',

    'secret' => 'some-random-string'

	$payload = [
			'sub'   => 1,
			'username' => 'xaamin'
	    ];

	// Generate token
	$token = Xaamin\JWT\Facade\Native\JWT::encode($payload);

	// Verify the token
	try{
		$token = Xaamin\JWT\Facade\Native\JWT::decode($token->get());

	    var_dump($token);
	} catch (Exception $e) {
		echo $e->getMessage();
	}