Auth class - Documentation for SproutCMS

Info Page:

Page options:

class Auth

Provides user authentication functions for the admin

Name	Visibility	Description
checkAlgorithm	public (static)	Checks if a given password algorithm is available
defaultAlgorithm	public (static)	Return the algorithm for new accounts.
doPasswordCheck	public (static)	Check a password hash against an entered password
hashPassword	public (static)	Return a hashed password, password algorithm, and salt, for inserting into the database

bool Auth::checkAlgorithm ( int $algorithm );

Checks if a given password algorithm is available

int Auth::defaultAlgorithm ( );

Return the algorithm for new accounts.
Existing accounts will be re-crypted into this algorithm upon next login.

bool Auth::doPasswordCheck ( string $known_hash , int $algorithm , string $salt , string $user_string );

Check a password hash against an entered password

array Auth::hashPassword ( string $password [, int $algorithm ] );

Return a hashed password, password algorithm, and salt, for inserting into the database