Class Firebase\JWT\JWT

JSON Web Token implementation, based on this spec: https://tools.ietf.org/html/rfc7519

PHP version 5

Located at class\libraries\vendor\firebase\php-jwt\src\JWT.php

Methods


					
	public
					static

decode(string $jwt, Key|array<string, Key> $keyOrKeyArray): object

Decodes a JWT string into a PHP object.

Parameters

`$jwt`	The JWT
`$keyOrKeyArray`	The Key or associative array of key IDs (kid) to Key objects. If the algorithm used is asymmetric, this is the public key Each Key object contains an algorithm and matching key. Supported algorithms are 'ES384','ES256', 'HS256', 'HS384', 'HS512', 'RS256', 'RS384', and 'RS512'

Returns

The JWT's payload as a PHP object

Throws

`InvalidArgumentException`	Provided key/key-array was empty
`DomainException`	Provided JWT is malformed
`UnexpectedValueException`	Provided JWT was invalid
`Firebase\JWT\SignatureInvalidException`	Provided JWT was invalid because the signature verification failed
`Firebase\JWT\BeforeValidException`	Provided JWT is trying to be used before it's eligible as defined by 'nbf'
`Firebase\JWT\BeforeValidException`	Provided JWT is trying to be used before it's been created as defined by 'iat'
`Firebase\JWT\ExpiredException`	Provided JWT has since expired, as defined by the 'exp' claim


					
	public
					static

encode(object|array $payload, string|resource $key, string $alg, mixed $keyId = null, array $head = null): string

Converts and signs a PHP object or array into a JWT string.

Parameters

`$payload`	PHP object or array
`$key`	The secret key. If the algorithm used is asymmetric, this is the private key
`$alg`	The signing algorithm. Supported algorithms are 'ES384','ES256', 'HS256', 'HS384', 'HS512', 'RS256', 'RS384', and 'RS512'
`$head`	An array with header elements to attach

Returns

A signed JWT


					
	public
					static

sign(string $msg, string|resource $key, string $alg): string

Sign a string with a given key and algorithm.

Parameters

`$msg`	The message to sign
`$key`	The secret key
`$alg`	The signing algorithm. Supported algorithms are 'ES384','ES256', 'HS256', 'HS384', 'HS512', 'RS256', 'RS384', and 'RS512'

Returns

An encrypted message

Throws

DomainException

Unsupported algorithm or bad key was specified


					
	public
					static

jsonDecode(string $input): object

Decode a JSON string into a PHP object.

Parameters

$input

JSON string

Returns

Object representation of JSON string

Throws

DomainException

Provided string was invalid JSON


					
	public
					static

jsonEncode(object|array $input): string

Encode a PHP object into a JSON string.

Parameters

$input

A PHP object or array

Returns

JSON representation of the PHP object or array

Throws

DomainException

Provided object could not be encoded to valid JSON


					
	public
					static

urlsafeB64Decode(string $input): string

Decode a string with URL-safe Base64.

Parameters

$input

A Base64 encoded string

Returns

A decoded string


					
	public
					static

urlsafeB64Encode(string $input): string

Encode a string with URL-safe Base64.

Parameters

$input

The string you want encoded

Returns

The base64 encode of what you passed in


					
	public
					static

constantTimeEquals(string $left, string $right): bool

Properties
`public static`	`$leeway = 0` When checking nbf, iat or expiration times, we want to provide some extra leeway time to account for clock skew. When checking nbf, iat or expiration times, we want to provide some extra leeway time to account for clock skew.	#
`public static`	`$timestamp = null` Allow the current timestamp to be specified. Useful for fixing a value within unit testing. Allow the current timestamp to be specified. Useful for fixing a value within unit testing. Will default to PHP time() value if null.	#
`public static`	`$supported_algs = [ 'ES384' => ['openssl', 'SHA384'], 'ES256' => ['openssl', 'SHA256'], 'HS256' => ['hash_hmac', 'SHA256'], 'HS384' => ['hash_hmac', 'SHA384'], 'HS512' => ['hash_hmac', 'SHA512'], 'RS256' => ['openssl', 'SHA256'], 'RS384' => ['openssl', 'SHA384'], 'RS512' => ['openssl', 'SHA512'], 'EdDSA' => ['sodium_crypto', 'EdDSA'], ]`	#

Namespaces

Classes

Exceptions

Class Firebase\JWT\JWT

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns