Public Member Functions
	__construct ($policy)
	\ElggPAM constructor More...

	authenticate ($credentials=array())
	Authenticate a set of credentials against a policy This function will process all registered PAM handlers or stop when the first handler fails. More...

	getFailureMessage ()
	Get a failure message to display to user. More...

Protected Attributes
	$policy

	$messages

Detailed Description

Definition at line 8 of file ElggPAM.php.

Constructor & Destructor Documentation

◆ __construct()

ElggPAM::__construct ( $policy )

\ElggPAM constructor

Parameters

string $policy PAM policy type: user, api, or plugin-defined policies

Definition at line 24 of file ElggPAM.php.

Member Function Documentation

◆ authenticate()

ElggPAM::authenticate ( $credentials = array() )

Authenticate a set of credentials against a policy This function will process all registered PAM handlers or stop when the first handler fails.

A handler fails by either returning false or throwing an exception. The advantage of throwing an exception is that it returns a message that can be passed to the user. The processing order of the handlers is determined by the order that they were registered.

If $credentials are provided, the PAM handler should authenticate using the provided credentials. If not, then credentials should be prompted for or otherwise retrieved (eg from the HTTP header or $_SESSION).

Parameters

array $credentials Credentials array dependant on policy type

Returns: bool

Definition at line 44 of file ElggPAM.php.

◆ getFailureMessage()

ElggPAM::getFailureMessage ( )

Get a failure message to display to user.

Returns: string

Definition at line 95 of file ElggPAM.php.

Member Data Documentation

◆ $messages

ElggPAM::$messages

protected

Definition at line 17 of file ElggPAM.php.

◆ $policy

ElggPAM::$policy