Security class - Documentation for SproutCMS

Info Page:

Page options:

class Security

Functions for implementing security, including secure random numbers

File: /sprout/Helpers/Security.php
Namespace: Sprout\Helpers

Functions

Name	Visibility	Description
compareStrings	public (static)	Constant-time string comparison
getServerKey	protected (static)	Return the server key
passwordComplexity	public (static)	Check the given password meets complexity requirements
randByte	public (static)	Return a single random byte
randBytes	public (static)	Returns a binary string of random bytes
randStr	public (static)	Returns a string of random characters
serverKeySign	public (static)	Generate a signature from a given set of fields, using the server key
serverKeyVerify	public (static)	Verify a signature which was generated by Security::serverKeySign

public compareStrings

bool Security::compareStrings ( string $known_string , string $user_string );

Constant-time string comparison

protected getServerKey

string Security::getServerKey ( );

Return the server key

public passwordComplexity

array Security::passwordComplexity ( string $str , int $length , int $classes , bool $bad_list );

Check the given password meets complexity requirements

public randByte

string Security::randByte ( );

Return a single random byte

public randBytes

string Security::randBytes ( int $length );

Returns a binary string of random bytes

public randStr

string Security::randStr ( [ int $length [, mixed $chars ]] );

Returns a string of random characters

public serverKeySign

string Security::serverKeySign ( array $fields );

Generate a signature from a given set of fields, using the server key

For a given set of fields, the signature will always be the same value.
Returned signatures are always URL and HTML safe

public serverKeyVerify

void Security::serverKeyVerify ( array $fields , string $signature );

Verify a signature which was generated by Security::serverKeySign

SproutCMS

Search documentation