Inheritance diagram for sspmod_core_Auth_UserPassBase:

Collaboration diagram for sspmod_core_Auth_UserPassBase:

Public Member Functions
	__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...

Static Public Member Functions
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
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...

Protected Member Functions
	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...

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

	$rememberUsernameEnabled = FALSE

	$rememberUsernameChecked = FALSE

	$rememberMeEnabled = FALSE

	$rememberMeChecked = FALSE

Protected Attributes inherited from SimpleSAML_Auth_Source
	$authId

Private Attributes
	$forcedUsername
	Username we should force. More...

Additional Inherited Members
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...

Detailed Description

Definition at line 12 of file UserPassBase.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_core_Auth_UserPassBase::__construct	(		$info,
		&	$config
	)

Constructor for this authentication source.

All subclasses who implement their own constructor must call this constructor before using $config for anything.

Parameters

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

Reimplemented from SimpleSAML_Auth_Source.

Definition at line 84 of file UserPassBase.php.

                                                     {
                assert('is_array($info)');
                assert('is_array($config)');
                
                if (isset($config['core:loginpage_links'])) {
                        $this->loginLinks = $config['core:loginpage_links'];
                }
 
                // Call the parent constructor first, as required by the interface
                parent::__construct($info, $config);
 
                // Get the remember username config options
                if (isset($config['remember.username.enabled'])) {
                        $this->rememberUsernameEnabled = (bool) $config['remember.username.enabled'];
                        unset($config['remember.username.enabled']);
                }
                if (isset($config['remember.username.checked'])) {
                        $this->rememberUsernameChecked = (bool) $config['remember.username.checked'];
                        unset($config['remember.username.checked']);
                }
 
        // get the "remember me" config options
        $sspcnf = SimpleSAML_Configuration::getInstance();
        $this->rememberMeEnabled = $sspcnf->getBoolean('session.rememberme.enable', FALSE);
        $this->rememberMeChecked = $sspcnf->getBoolean('session.rememberme.checked', FALSE);
        }

References $config, $info, and SimpleSAML_Configuration\getInstance().

Here is the call graph for this function:

Member Function Documentation

◆ authenticate()

sspmod_core_Auth_UserPassBase::authenticate ( & $state )

Initialize login.

This function saves the information about the login, and redirects to a login page.

Parameters

array &$state Information about the current authentication.

Reimplemented from SimpleSAML_Auth_Source.

Definition at line 169 of file UserPassBase.php.

                                              {
                assert('is_array($state)');
 
                /*
                 * Save the identifier of this authentication source, so that we can
                 * retrieve it later. This allows us to call the login()-function on
                 * the current object.
                 */
                $state[self::AUTHID] = $this->authId;
 
                // What username we should force, if any
                if ($this->forcedUsername !== NULL) {
                        /*
                         * This is accessed by the login form, to determine if the user
                         * is allowed to change the username.
                         */
                        $state['forcedUsername'] = $this->forcedUsername;
                }
 
                /* Save the $state-array, so that we can restore it after a redirect. */
                $id = SimpleSAML_Auth_State::saveState($state, self::STAGEID);
 
                /*
                 * Redirect to the login form. We include the identifier of the saved
                 * state array as a parameter to the login form.
                 */
                $url = SimpleSAML\Module::getModuleURL('core/loginuserpass.php');
                $params = array('AuthState' => $id);
                \SimpleSAML\Utils\HTTP::redirectTrustedURL($url, $params);
 
                /* The previous function never returns, so this code is never executed. */
                assert('FALSE');
        }

References SimpleSAML_Auth_Source\$authId, $forcedUsername, $id, $params, $state, $url, AUTHID, SimpleSAML\Module\getModuleURL(), SimpleSAML\Utils\HTTP\redirectTrustedURL(), and SimpleSAML_Auth_State\saveState().

Here is the call graph for this function:

◆ getLoginLinks()

sspmod_core_Auth_UserPassBase::getLoginLinks ( )

Return login links from configuration.

Definition at line 125 of file UserPassBase.php.

                                        {
                return $this->loginLinks;
        }

References $loginLinks.

◆ getRememberUsernameChecked()

sspmod_core_Auth_UserPassBase::getRememberUsernameChecked ( )

Getter for the authsource config option remember.username.checked.

Returns: bool

Definition at line 141 of file UserPassBase.php.

                                                     {
                return $this->rememberUsernameChecked;
        }

References $rememberUsernameChecked.

◆ getRememberUsernameEnabled()

sspmod_core_Auth_UserPassBase::getRememberUsernameEnabled ( )

Getter for the authsource config option remember.username.enabled.

Returns: bool

Definition at line 133 of file UserPassBase.php.

                                                     {
                return $this->rememberUsernameEnabled;
        }

References $rememberUsernameEnabled.

◆ handleLogin()

static sspmod_core_Auth_UserPassBase::handleLogin	(	$authStateId,
		$username,
		$password
	)

static

Handle login request.

This function is used by the login form (core/www/loginuserpass.php) when the user enters a username and password. On success, it will not return. On wrong username/password failure, and other errors, it will throw an exception.

Parameters

string	$authStateId	The identifier of the authentication state.
string	$username	The username the user wrote.
string	$password	The password the user wrote.

Definition at line 231 of file UserPassBase.php.

                                                                               {
                assert('is_string($authStateId)');
                assert('is_string($username)');
                assert('is_string($password)');
 
                /* Here we retrieve the state array we saved in the authenticate-function. */
                $state = SimpleSAML_Auth_State::loadState($authStateId, self::STAGEID);
 
                /* Retrieve the authentication source we are executing. */
                assert('array_key_exists(self::AUTHID, $state)');
                $source = SimpleSAML_Auth_Source::getById($state[self::AUTHID]);
                if ($source === NULL) {
                        throw new Exception('Could not find authentication source with id ' . $state[self::AUTHID]);
                }
 
                /*
                 * $source now contains the authentication source on which authenticate()
                 * was called. We should call login() on the same authentication source.
                 */
 
                /* Attempt to log in. */
                try {
                        $attributes = $source->login($username, $password);
                } catch (Exception $e) {
                        SimpleSAML\Logger::stats('Unsuccessful login attempt from '.$_SERVER['REMOTE_ADDR'].'.');
                        throw $e;
                }
 
                SimpleSAML\Logger::stats('User \''.$username.'\' successfully authenticated from '.$_SERVER['REMOTE_ADDR']);
 
                /* Save the attributes we received from the login-function in the $state-array. */
                assert('is_array($attributes)');
                $state['Attributes'] = $attributes;
 
                /* Return control to SimpleSAMLphp after successful authentication. */
                SimpleSAML_Auth_Source::completeAuth($state);
        }

References $_SERVER, $attributes, $authStateId, $password, $source, $state, SimpleSAML_Auth_Source\getById(), SimpleSAML_Auth_State\loadState(), and SimpleSAML\Logger\stats().

Here is the call graph for this function:

◆ isRememberMeChecked()

sspmod_core_Auth_UserPassBase::isRememberMeChecked ( )

Check if the "remember me" checkbox should be checked.

Returns: bool TRUE if enabled, FALSE otherwise.

Definition at line 157 of file UserPassBase.php.

                                          {
        return $this->rememberMeChecked;
    }

References $rememberMeChecked.

◆ isRememberMeEnabled()

sspmod_core_Auth_UserPassBase::isRememberMeEnabled ( )

Check if the "remember me" feature is enabled.

Returns: bool TRUE if enabled, FALSE otherwise.

Definition at line 149 of file UserPassBase.php.

                                          {
        return $this->rememberMeEnabled;
    }

References $rememberMeEnabled.

◆ login()

sspmod_core_Auth_UserPassBase::login	(	$username,
		$password
	)

abstractprotected

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/error. 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 user's attributes.

Reimplemented in sspmod_authcrypt_Auth_Source_Hash, sspmod_authcrypt_Auth_Source_Htpasswd, sspmod_core_Auth_Source_AdminPassword, sspmod_exampleauth_Auth_Source_UserPass, sspmod_radius_Auth_Source_Radius, and sspmod_sqlauth_Auth_Source_SQL.

◆ setForcedUsername()

sspmod_core_Auth_UserPassBase::setForcedUsername ( $forcedUsername )

Set forced username.

Parameters

string | NULL $forcedUsername The forced username.

Definition at line 117 of file UserPassBase.php.

                                                           {
                assert('is_string($forcedUsername) || is_null($forcedUsername)');
                $this->forcedUsername = $forcedUsername;
        }

References $forcedUsername.

Referenced by sspmod_core_Auth_Source_AdminPassword\__construct().

Here is the caller graph for this function:

Field Documentation

◆ $forcedUsername

sspmod_core_Auth_UserPassBase::$forcedUsername

private

Username we should force.

A forced username cannot be changed by the user. If this is NULL, we won't force any username.

Definition at line 33 of file UserPassBase.php.

Referenced by authenticate(), and setForcedUsername().

◆ $loginLinks

sspmod_core_Auth_UserPassBase::$loginLinks

protected

Links to pages from login page.

From configuration

Definition at line 39 of file UserPassBase.php.

Referenced by getLoginLinks().

◆ $rememberMeChecked

sspmod_core_Auth_UserPassBase::$rememberMeChecked = FALSE

protected

Definition at line 73 of file UserPassBase.php.

Referenced by isRememberMeChecked().

◆ $rememberMeEnabled

sspmod_core_Auth_UserPassBase::$rememberMeEnabled = FALSE

protected

Definition at line 65 of file UserPassBase.php.

Referenced by isRememberMeEnabled().

◆ $rememberUsernameChecked

sspmod_core_Auth_UserPassBase::$rememberUsernameChecked = FALSE

protected

Definition at line 55 of file UserPassBase.php.

Referenced by getRememberUsernameChecked().

◆ $rememberUsernameEnabled

sspmod_core_Auth_UserPassBase::$rememberUsernameEnabled = FALSE

protected

Definition at line 47 of file UserPassBase.php.

Referenced by getRememberUsernameEnabled().

◆ AUTHID

const sspmod_core_Auth_UserPassBase::AUTHID = 'sspmod_core_Auth_UserPassBase.AuthId'

The key of the AuthId field in the state.

Definition at line 24 of file UserPassBase.php.

Referenced by authenticate().

◆ STAGEID

const sspmod_core_Auth_UserPassBase::STAGEID = 'sspmod_core_Auth_UserPassBase.state'

The string used to identify our states.

Definition at line 18 of file UserPassBase.php.

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/core/lib/Auth/UserPassBase.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ authenticate()

◆ getLoginLinks()

◆ getRememberUsernameChecked()

◆ getRememberUsernameEnabled()

◆ handleLogin()

◆ isRememberMeChecked()

◆ isRememberMeEnabled()

◆ login()

◆ setForcedUsername()

Field Documentation

◆ $forcedUsername

◆ $loginLinks

◆ $rememberMeChecked

◆ $rememberMeEnabled

◆ $rememberUsernameChecked

◆ $rememberUsernameEnabled

◆ AUTHID

◆ STAGEID