SimpleJWT is a simple JSON web token library written in PHP.
- JSON web token RFC7519 and JSON web signatures RFC7515
- JSON web keys RFC7517
- Signature algorithms
- HMAC family (HS256, HS384, HS512)
- RSA family (RS256, RS384, RS512)
- ECDSA family (ES256, ES384, ES512)
- PHP 5.4.0 or later
hash
extensionopenssl
extension
You can install via Composer.
{
"require": {
"kelvinmo/simplejwt": "0.1.*"
}
}
Keys used to sign or verify a JWT must firstly be added to a KeySet. You can add keys in the following ways:
- By loading a JSON object formatted as a JWK Set object as per RFC7517:
$set = new SimpleJWT\Keys\KeySet();
$set->load(file_get_contents('private.json'));
- By adding a key manually:
$set = new SimpleJWT\Keys\KeySet();
// JWK format
$key = new SimpleJWT\Keys\RSAKey(file_get_contents('jwk.json'), 'json');
// PEM format - note raw key only, no X.509 certificates
$key = new SimpleJWT\Keys\RSAKey(file_get_contents('rsa.pem'), 'pem');
$set->add($key);
- For a secret used in HMAC signatures, directly:
$set = SimpleJWT\Keys\KeySet::createFromSecret('secret123');
To create a JWT, set up the desired headers and claims as separate arrays, then
create a JWT
object:
// Note $headers['alg'] is required
$headers = array('alg' => 'HS256', 'typ' => 'JWT');
$claims = array('iss' => 'me', 'exp' => 1234567);
$jwt = new SimpleJWT\JWT($headers, $claims);
The JWT can then be signed and encoded:
try {
print $jwt->encode($set);
} catch (\RuntimeException $e) {
}
To consume and verify a JWT, use the decode function. Note that you will need to supply the expected alg
parameter that has been previously agreed out-of-band.
try {
$jwt = SimpleJWT\JWT::decode('abc.def.ghigjghr', $set, 'HS256');
} catch (SimpleJWT\InvalidTokenException $e) {
}
print $jwt->getHeader('alg');
print $jwt->getClaim('sub');
To create a JWE, set up the desired header array and plaintext, then
create a JWE
object:
// Note $headers['alg'] and $headers['enc'] are required
$headers = array('alg' => 'PBES2-HS256+A128KW', 'enc' => 'A128CBC-HS256');
$plaintext = 'This is the plaintext I want to encrypt.';
$jwt = new SimpleJWT\JWE($headers, $plaintext);
The JWT can then be encrypted:
try {
print $jwt->encrypt($set);
} catch (\RuntimeException $e) {
}
To decrypt a JWE, use the decrypt function:
try {
$jwt = SimpleJWT\JWT::decrypt('abc.def.ghi.klm.nop', $set, 'PBES2-HS256+A128KW');
} catch (SimpleJWT\InvalidTokenException $e) {
}
print $jwt->getHeader('alg');
print $jwt->getPlaintext();
BSD 3 clause