PHP Class Airship\Engine\Security\CSRF

Protected Properties

Property	Type	Description
$expireOld	boolean
$hmacIP		Default to FALSE to be friendly to Tor/Mobile users
$recycleAfter	integer
$sessionIndex	string

Method	Description
__construct ( array $options = [] )	CSRF constructor.
check ( ) : boolean	Validate a request based on $_SESSION and $_POST data
getTokenString ( string $lockTo = '' ) : string	Retrieve a token array for unit testing endpoints
insertToken ( string $lockTo = '', boolean $echo = true ) : string	Insert a CSRF token to a form
reconfigure ( array $options = [] )	Use this to change the configuration settings.

Method	Description
generateToken ( string $lockTo = '' ) : array	Generate, store, and return the index and token
recycleTokens ( )	Enforce an upper limit on the number of tokens stored in session state by removing the oldest tokens first.

CSRF constructor.

public __construct ( array $options = [] )
$options	array

Validate a request based on $_SESSION and $_POST data

public check ( ) : boolean
return	boolean

Generate, store, and return the index and token

protected generateToken ( string $lockTo = '' ) : array
$lockTo	string	What URI endpoint this is valid for
return	array	[string, string]

Retrieve a token array for unit testing endpoints

public getTokenString ( string $lockTo = '' ) : string
$lockTo	string	- Only get tokens locked to a particular form
return	string

Insert a CSRF token to a form

public insertToken ( string $lockTo = '', boolean $echo = true ) : string
$lockTo	string	This CSRF token is only valid for this HTTP request endpoint
$echo	boolean	if true, echo instead of returning
return	string

Only use this if you know what you are doing.

public reconfigure ( array $options = [] )
$options	array

Enforce an upper limit on the number of tokens stored in session state by removing the oldest tokens first.

protected recycleTokens ( )

protected bool $expireOld
return	boolean

Default to FALSE to be friendly to Tor/Mobile users

protected $hmacIP

protected int $recycleAfter
return	integer

protected string $sessionIndex
return	string