Raydium Framework

AuthValidator
in package

Table of Contents

$authKey  : string|null
$authSalt  : string|null
$secureAuthKey  : string|null
$secureAuthSalt  : string|null
$sessionTokens  : array<string|int, mixed>|null
$userMeta  : object|null
$wpUser  : object|null
__construct()  : mixed
getUser()  : mixed
validate()  : array<string|int, null|bool|mixed|string>
Validate the authentication cookie.
getHashKey()  : mixed
getKeyForScheme()  : null|string
Get the key for the specified scheme.
getMessage()  : string
isValidExpiration()  : bool

Properties

$sessionTokens

private array<string|int, mixed>|null $sessionTokens

Methods

__construct()

public __construct(string $authKey, string $authSalt, string $secureAuthKey, string $secureAuthSalt) : mixed
Parameters
$authKey : string
$authSalt : string
$secureAuthKey : string
$secureAuthSalt : string
Return values
mixed —

getUser()

public getUser(string $username) : mixed
Parameters
$username : string
Return values
mixed —

validate()

Validate the authentication cookie.

public validate(string $cookie[, bool $verifyHash = true ][, string $scheme = 'auth' ]) : array<string|int, null|bool|mixed|string>
Parameters
$cookie : string

The cookie string in the format "username|expiration|hmac".

$verifyHash : bool = true
$scheme : string = 'auth'

Either 'auth' or 'secure_auth'.

Tags
psalm-return

array{user: mixed|null, auth: bool, message: string}

Return values
array<string|int, null|bool|mixed|string> —

getHashKey()

private static getHashKey(string $username, string $passFrag, string $expiration, string $token, string $schemeKey) : mixed
Parameters
$username : string
$passFrag : string
$expiration : string
$token : string
$schemeKey : string
Return values
mixed —

getKeyForScheme()

Get the key for the specified scheme.

private getKeyForScheme(string $scheme) : null|string
Parameters
$scheme : string
Return values
null|string —

getMessage()

private static getMessage(string $key) : string
Parameters
$key : string
Return values
string —

isValidExpiration()

private isValidExpiration(int $cookieExpiration) : bool
Parameters
$cookieExpiration : int
Return values
bool —

Search results