abstract class AuthenticationPlugin (View source)

Provides a common interface that will have to be implemented by all the authentication plugins.

Properties

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

Methods

__construct()

No description

Response|null
showLoginForm()

Displays authentication form

bool
readCredentials()

Gets authentication credentials

bool
storeCredentials()

Set the user and password after last checkings if required

Response|null
rememberCredentials()

Stores user credentials after successful login.

showFailure(AuthenticationFailure $failure)

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

void
logFailure(AuthenticationFailure $failure)

No description

void
logOut()

Perform logout

string
getLoginFormURL()

Returns URL for login form.

string
getErrorMessage(AuthenticationFailure $failure)

Returns error message for failed authentication.

void
handlePasswordChange(string $password)

Callback when user changes password.

void
setSessionAccessTime()

Store session access time in session.

Response|null
authenticate()

High level authentication interface

void
checkRules()

Check configuration defined restrictions for authentication

Response|null
checkTwoFactor(ServerRequest $request)

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

Details

__construct()

No description

abstract Response|null showLoginForm()

Displays authentication form

Return Value

Response|null

abstract bool readCredentials()

Gets authentication credentials

Return Value

bool

Exceptions

AuthenticationFailure
Exception

bool storeCredentials()

Set the user and password after last checkings if required

Return Value

bool

Response|null rememberCredentials()

Stores user credentials after successful login.

Return Value

Response|null

abstract Response showFailure(AuthenticationFailure $failure)

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

Parameters

AuthenticationFailure $failure

Return Value

Response

protected void logFailure(AuthenticationFailure $failure)

No description

Parameters

AuthenticationFailure $failure

Return Value

void

void logOut()

Perform logout

Return Value

void

string getLoginFormURL()

Returns URL for login form.

Return Value

string

string getErrorMessage(AuthenticationFailure $failure)

Returns error message for failed authentication.

Parameters

AuthenticationFailure $failure

Return Value

string

void handlePasswordChange(string $password)

Callback when user changes password.

Parameters

string $password

New password to set

Return Value

void

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

Response|null authenticate()

High level authentication interface

Gets the credentials or shows login form if necessary

Return Value

Response|null

Exceptions

AuthenticationFailure
Exception

void checkRules()

Check configuration defined restrictions for authentication

Return Value

void

Exceptions

AuthenticationFailure

Response|null checkTwoFactor(ServerRequest $request)

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

Parameters

ServerRequest $request

Return Value

Response|null