CRM_Utils_Signer

class CRM_Utils_Signer

A utility which signs and verifies a list of key-value pairs

FIXME: Add TTL support?

Constants

SALT_LEN

Expected length of the salt

Methods

__construct(string $secret, array $paramNames)

Instantiate a signature-processor

string,
sign(array $params, string $salt = NULL)

Generate a signature for a set of key-value pairs

bool,
validate(string $token, array $params)

Determine whether a token represents a proper signature for $params

string
createSalt()

No description

Details

at line 66
__construct(string $secret, array $paramNames)

Instantiate a signature-processor

Parameters

string $secret private.
array $paramNames Array, fields which should be part of the signature.

at line 83
string, sign(array $params, string $salt = NULL)

Generate a signature for a set of key-value pairs

Parameters

array $params Array, key-value pairs.
string $salt the salt (if known) or NULL (for auto-generated).

Return Value

string, the full public token representing the signature

at line 121
bool, validate(string $token, array $params)

Determine whether a token represents a proper signature for $params

Parameters

string $token the full public token representing the signature.
array $params Array, key-value pairs.

Return Value

bool, TRUE iff all $paramNames for the submitted validate($params) and the original sign($params)

Exceptions

Exception

at line 133
string createSalt()

Return Value

string