Inheritance diagram for sspmod_exampleauth_Auth_Source_UserPass:

Collaboration diagram for sspmod_exampleauth_Auth_Source_UserPass:

Public Member Functions
	__construct ($info, $config)
	Constructor for this authentication source. More...

Public Member Functions inherited from sspmod_core_Auth_UserPassBase
	__construct ($info, &$config)
	Constructor for this authentication source. More...

	setForcedUsername ($forcedUsername)
	Set forced username. More...

	getLoginLinks ()
	Return login links from configuration. More...

	getRememberUsernameEnabled ()
	Getter for the authsource config option remember.username.enabled. More...

	getRememberUsernameChecked ()
	Getter for the authsource config option remember.username.checked. More...

	isRememberMeEnabled ()
	Check if the "remember me" feature is enabled. More...

	isRememberMeChecked ()
	Check if the "remember me" checkbox should be checked. More...

	authenticate (&$state)
	Initialize login. More...

Public Member Functions inherited from SimpleSAML_Auth_Source
	__construct ($info, &$config)
	Constructor for an authentication source. More...

	getAuthId ()
	Retrieve the ID of this authentication source. More...

	authenticate (&$state)
	Process a request. More...

	reauthenticate (array &$state)
	Reauthenticate an user. More...

	initLogin ($return, $errorURL=null, array $params=array())
	Start authentication. More...

	logout (&$state)
	Log out from this authentication source. More...

Protected Member Functions
	login ($username, $password)
	Attempt to log in using the given username and password. More...

Protected Member Functions inherited from sspmod_core_Auth_UserPassBase
	login ($username, $password)
	Attempt to log in using the given username and password. More...

Protected Member Functions inherited from SimpleSAML_Auth_Source
	addLogoutCallback ($assoc, $state)
	Add a logout callback association. More...

	callLogoutCallback ($assoc)
	Call a logout callback based on association. More...

Private Attributes
	$users
	Our users, stored in an associative array. More...

Additional Inherited Members
Static Public Member Functions inherited from sspmod_core_Auth_UserPassBase
static	handleLogin ($authStateId, $username, $password)
	Handle login request. More...

Static Public Member Functions inherited from SimpleSAML_Auth_Source
static	getSourcesOfType ($type)
	Get sources of a specific type. More...

static	completeAuth (&$state)
	Complete authentication. More...

static	loginCompleted ($state)
	Called when a login operation has finished. More...

static	completeLogout (&$state)
	Complete logout. More...

static	getById ($authId, $type=null)
	Retrieve authentication source. More...

static	logoutCallback ($state)
	Called when the authentication source receives an external logout request. More...

static	getSources ()
	Retrieve list of authentication sources. More...

Data Fields inherited from sspmod_core_Auth_UserPassBase
const	STAGEID = 'sspmod_core_Auth_UserPassBase.state'
	The string used to identify our states. More...

const	AUTHID = 'sspmod_core_Auth_UserPassBase.AuthId'
	The key of the AuthId field in the state. More...

Static Protected Member Functions inherited from SimpleSAML_Auth_Source
static	validateSource ($source, $id)
	Make sure that the first element of an auth source is its identifier. More...

Protected Attributes inherited from sspmod_core_Auth_UserPassBase
	$loginLinks
	Links to pages from login page. More...

	$rememberUsernameEnabled = FALSE

	$rememberUsernameChecked = FALSE

	$rememberMeEnabled = FALSE

	$rememberMeChecked = FALSE

Protected Attributes inherited from SimpleSAML_Auth_Source
	$authId

Detailed Description

Definition at line 12 of file UserPass.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_exampleauth_Auth_Source_UserPass::__construct	(	$info,
		$config
	)

Constructor for this authentication source.

Parameters

array	$info	Information about this authentication source.
array	$config	Configuration.

Definition at line 28 of file UserPass.php.

References $attributes, $config, $info, $password, array, and SimpleSAML\Utils\Attributes\normalizeAttributesArray().

                                                     {
                 assert('is_array($info)');
                 assert('is_array($config)');
 
                 // Call the parent constructor first, as required by the interface
                 parent::__construct($info, $config);
 
                 $this->users = array();
 
                 // Validate and parse our configuration
                 foreach ($config as $userpass => $attributes) {
                         if (!is_string($userpass)) {
                                 throw new Exception('Invalid <username>:<password> for authentication source ' .
                                         $this->authId . ': ' . $userpass);
                         }
 
                         $userpass = explode(':', $userpass, 2);
                         if (count($userpass) !== 2) {
                                 throw new Exception('Invalid <username>:<password> for authentication source ' .
                                         $this->authId . ': ' . $userpass[0]);
                         }
                         $username = $userpass[0];
                         $password = $userpass[1];
 
                         try {
                                 $attributes = SimpleSAML\Utils\Attributes::normalizeAttributesArray($attributes);
                         } catch(Exception $e) {
                                 throw new Exception('Invalid attributes for user ' . $username .
                                         ' in authentication source ' . $this->authId . ': ' .
                                         $e->getMessage());
                         }
 
                         $this->users[$username . ':' . $password] = $attributes;
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ login()

sspmod_exampleauth_Auth_Source_UserPass::login	(	$username,
		$password
	)

protected

Attempt to log in using the given username and password.

On a successful login, this function should return the users attributes. On failure, it should throw an exception. If the error was caused by the user entering the wrong username or password, a SimpleSAML_Error_Error('WRONGUSERPASS') should be thrown.

Note that both the username and the password are UTF-8 encoded.

Parameters

string	$username	The username the user wrote.
string	$password	The password the user wrote.

Returns: array Associative array with the users attributes.

Definition at line 78 of file UserPass.php.

References $password.

                                                        {
                 assert('is_string($username)');
                 assert('is_string($password)');
 
                 $userpass = $username . ':' . $password;
                 if (!array_key_exists($userpass, $this->users)) {
                         throw new SimpleSAML_Error_Error('WRONGUSERPASS');
                 }
 
                 return $this->users[$userpass];
         }

Field Documentation

◆ $users

sspmod_exampleauth_Auth_Source_UserPass::$users

private

Our users, stored in an associative array.

The key of the array is "<username>:<password>", while the value of each element is a new array with the attributes for each user.

Definition at line 19 of file UserPass.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/exampleauth/lib/Auth/Source/UserPass.php

Public Member Functions

Protected Member Functions

Private Attributes