Class SimpleID\Crypt\SecurityToken

A security token generator based on the branca token specification.

A security token contains signed and encrypted data which only the generator can decode. It is used for various purposes, such as:

encoding state data to be passed between HTTP requests
generating CSRF tokens

The payload of the token is a JSON object with the following keys defined:

i - a random generated identifier for the token
o - token options, consisting of the sum of the OPTION_ constants defined by this class
p - the payload
s (optional) - the session ID

Located at core/Crypt/SecurityToken.php

Methods


					
	public

__construct(string $key = null)

Creates a token generator.

The encryption and signing keys should be formatted as a 32-byte binary string

Parameters

$key

the encryption and signing keys as a base64url encoded string


					
	public

getPayload(string $token, int $ttl = null): mixed

Checks whether the token string is valid and if so, obtains the payload.

Parameters

`$token`	the token string
`$ttl`	the number of seconds from which the token is considered expired

Returns

the payload or NULL if the security token is not valid


					
	public

verify(string $token, string $expected, int $ttl = null): bool

Convenience function to verify a token whose payload is a simple string

Parameters

`$token`	the token string
`$expected`	the expected payload
`$ttl`	the number of seconds from which the token is considered expired

Returns

true if the token is valid and the payload matches the expected string


					
	public

generate(mixed $payload, int $options = self::OPTION_DEFAULT): string

Generates a token.

Note that as part of creating the token, $payload is encoded using json_encode(). Therefore $payload must be capable of being JSON encoded. In particular, all strings within $payload must be UTF-8 encoded.

Parameters

`$payload`	the payload to include in the token
`$options`	the options for generating the token

Returns

the token string

Constants
`public`	`OPTION_DEFAULT = 0`	#
`public`	`OPTION_BIND_SESSION = 1` The security token is bound to the current session ID The security token is bound to the current session ID	#
`public`	`OPTION_NONCE = 2` The security token can only be verified once The security token can only be verified once	#

Namespaces

Classes

Class SimpleID\Crypt\SecurityToken

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns