class AuthenticationHttp extends AuthenticationPlugin

Handles the HTTP authentication methods

Properties

string $user Username from AuthenticationPlugin
string $password Password from AuthenticationPlugin
protected IpAllowDeny $ipAllowDeny from AuthenticationPlugin
Template $template from AuthenticationPlugin

Methods

__construct()

No description

bool
showLoginForm()

Displays authentication form and redirect as necessary

bool
readCredentials()

Gets authentication credentials

bool
storeCredentials()

Set the user and password after last checkings if required

void
rememberCredentials()

Stores user credentials after successful login.

void
showFailure(string $failure)

User is not allowed to login to MySQL -> authentication failed

void
logOut()

Perform logout

string
getLoginFormURL()

Returns URL for login form.

string
getErrorMessage(string $failure)

Returns error message for failed authentication.

void
handlePasswordChange(string $password)

Callback when user changes password.

void
setSessionAccessTime()

Store session access time in session.

void
authenticate()

High level authentication interface

void
checkRules()

Check configuration defined restrictions for authentication

bool|void
checkTwoFactor()

Checks whether two factor authentication is active for given user and performs it.

bool
authForm()

Displays authentication form

Details

in AuthenticationPlugin at line 55
__construct()

at line 34
bool showLoginForm()

Displays authentication form and redirect as necessary

Return Value

bool

at line 109
bool readCredentials()

Gets authentication credentials

Return Value

bool

in AuthenticationPlugin at line 80
bool storeCredentials()

Set the user and password after last checkings if required

Return Value

bool

in AuthenticationPlugin at line 97
void rememberCredentials()

Stores user credentials after successful login.

Return Value

void

at line 195
void showFailure(string $failure)

User is not allowed to login to MySQL -> authentication failed

Parameters

string $failure String describing why authentication has failed

Return Value

void

in AuthenticationPlugin at line 118
void logOut()

Perform logout

Return Value

void

at line 211
string getLoginFormURL()

Returns URL for login form.

Return Value

string

in AuthenticationPlugin at line 182
string getErrorMessage(string $failure)

Returns error message for failed authentication.

Parameters

string $failure String describing why authentication has failed

Return Value

string

in AuthenticationPlugin at line 216
void handlePasswordChange(string $password)

Callback when user changes password.

Parameters

string $password New password to set

Return Value

void

in AuthenticationPlugin at line 228
void setSessionAccessTime()

Store session access time in session.

Tries to workaround PHP 5 session garbage collection which looks at the session file's last modified time

Return Value

void

in AuthenticationPlugin at line 255
void authenticate()

High level authentication interface

Gets the credentials or shows login form if necessary

Return Value

void

in AuthenticationPlugin at line 277
void checkRules()

Check configuration defined restrictions for authentication

Return Value

void

in AuthenticationPlugin at line 333
bool|void checkTwoFactor()

Checks whether two factor authentication is active for given user and performs it.

Return Value

bool|void

at line 56
bool authForm()

Displays authentication form

Return Value

bool