Inheritance diagram for sspmod_core_Auth_UserPassOrgBase:

Collaboration diagram for sspmod_core_Auth_UserPassOrgBase:

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

	getUsernameOrgMethod ()
	Retrieve the way organizations as part of the username should be handled. More...

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

	getRememberUsernameChecked ()
	Getter for the authsource config option remember.username.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, $organization)
	Handle login request. More...

static	listOrganizations ($authStateId)
	Get available organizations. 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_UserPassOrgBase.state'
	The string used to identify our states. More...

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

const	ORGID = 'sspmod_core_Auth_UserPassOrgBase.SelectedOrg'
	The key of the OrgId field in the state, identifies which org was selected. More...

Protected Member Functions
	setUsernameOrgMethod ($usernameOrgMethod)
	Configure the way organizations as part of the username is handled. More...

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

	getOrganizations ()
	Retrieve list of organizations. 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
	$rememberUsernameEnabled = FALSE

	$rememberUsernameChecked = FALSE

Protected Attributes inherited from SimpleSAML_Auth_Source
	$authId

Private Attributes
	$usernameOrgMethod
	What way do we handle the organization as part of the username. 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 14 of file UserPassOrgBase.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_core_Auth_UserPassOrgBase::__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.

Definition at line 70 of file UserPassOrgBase.php.

References $config, and $info.

                                                      {
                 assert('is_array($info)');
                 assert('is_array($config)');
 
                 // 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']);
                 }
 
                 $this->usernameOrgMethod = 'none';
         }

Member Function Documentation

◆ authenticate()

sspmod_core_Auth_UserPassOrgBase::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.

Definition at line 149 of file UserPassOrgBase.php.

References SimpleSAML_Auth_Source\$authId, $id, $params, $password, $state, $url, array, SimpleSAML\Module\getModuleURL(), getOrganizations(), login(), SimpleSAML\Utils\HTTP\redirectTrustedURL(), and SimpleSAML_Auth_State\saveState().

                                               {
                 assert('is_array($state)');
 
                 // We are going to need the authId in order to retrieve this authentication source later
                 $state[self::AUTHID] = $this->authId;
 
                 $id = SimpleSAML_Auth_State::saveState($state, self::STAGEID);
 
                 $url = SimpleSAML\Module::getModuleURL('core/loginuserpassorg.php');
                 $params = array('AuthState' => $id);
                 \SimpleSAML\Utils\HTTP::redirectTrustedURL($url, $params);
         }

Here is the call graph for this function:

◆ getOrganizations()

sspmod_core_Auth_UserPassOrgBase::getOrganizations ( )

abstractprotected

Retrieve list of organizations.

The list of organizations is an associative array. The key of the array is the id of the organization, and the value is the description. The value can be another array, in which case that array is expected to contain language-code to description mappings.

Returns: array Associative array with the organizations.

Referenced by authenticate().

Here is the caller graph for this function:

◆ getRememberUsernameChecked()

sspmod_core_Auth_UserPassOrgBase::getRememberUsernameChecked ( )

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

Returns: bool

Definition at line 136 of file UserPassOrgBase.php.

References $rememberUsernameChecked.

                                                      {
                 return $this->rememberUsernameChecked;
         }

◆ getRememberUsernameEnabled()

sspmod_core_Auth_UserPassOrgBase::getRememberUsernameEnabled ( )

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

Returns: bool

Definition at line 128 of file UserPassOrgBase.php.

References $rememberUsernameEnabled.

                                                      {
                 return $this->rememberUsernameEnabled;
         }

◆ getUsernameOrgMethod()

sspmod_core_Auth_UserPassOrgBase::getUsernameOrgMethod ( )

Retrieve the way organizations as part of the username should be handled.

There are three possible values:

'none': Force the user to select the correct organization from the dropdown box.
'allow': Allow the user to enter the organization as part of the username.
'force': Remove the dropdown box.

Returns: string The method which should be used.

Definition at line 120 of file UserPassOrgBase.php.

References $usernameOrgMethod.

                                                {
                 return $this->usernameOrgMethod;
         }

◆ handleLogin()

static sspmod_core_Auth_UserPassOrgBase::handleLogin	(	$authStateId,
		$username,
		$password,
		$organization
	)

static

Handle login request.

This function is used by the login form (core/www/loginuserpassorg.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.
string	$organization	The id of the organization the user chose.

Definition at line 205 of file UserPassOrgBase.php.

References $attributes, $authStateId, $password, $source, $state, SimpleSAML_Auth_Source\completeAuth(), SimpleSAML_Auth_Source\getById(), and SimpleSAML_Auth_State\loadState().

                                                                                               {
                 assert('is_string($authStateId)');
                 assert('is_string($username)');
                 assert('is_string($password)');
                 assert('is_string($organization)');
 
                 /* Retrieve the authentication state. */
                 $state = SimpleSAML_Auth_State::loadState($authStateId, self::STAGEID);
 
                 /* Find authentication source. */
                 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]);
                 }
 
                 $orgMethod = $source->getUsernameOrgMethod();
                 if ($orgMethod !== 'none') {
                         $tmp = explode('@', $username, 2);
                         if (count($tmp) === 2) {
                                 $username = $tmp[0];
                                 $organization = $tmp[1];
                         } else {
                                 if ($orgMethod === 'force') {
                                         /* The organization should be a part of the username, but isn't. */
                                         throw new SimpleSAML_Error_Error('WRONGUSERPASS');
                                 }
                         }
                 }
 
                 /* Attempt to log in. */
                 $attributes = $source->login($username, $password, $organization);
 
                 // Add the selected Org to the state
                 $state[self::ORGID] = $organization;
                 $state['PersistentAuthData'][] = self::ORGID;
 
                 $state['Attributes'] = $attributes;
                 SimpleSAML_Auth_Source::completeAuth($state);
         }

Here is the call graph for this function:

◆ listOrganizations()

static sspmod_core_Auth_UserPassOrgBase::listOrganizations ( $authStateId )

static

Get available organizations.

This function is used by the login form to get the available organizations.

Parameters

string $authStateId The identifier of the authentication state.

Returns: array|NULL Array of organizations. NULL if the user must enter the organization as part of the username.

Definition at line 256 of file UserPassOrgBase.php.

References $authStateId, $source, $state, SimpleSAML_Auth_Source\getById(), and SimpleSAML_Auth_State\loadState().

                                                                {
                 assert('is_string($authStateId)');
 
                 /* Retrieve the authentication state. */
                 $state = SimpleSAML_Auth_State::loadState($authStateId, self::STAGEID);
 
                 /* Find authentication source. */
                 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]);
                 }
 
                 $orgMethod = $source->getUsernameOrgMethod();
                 if ($orgMethod === 'force') {
                         return NULL;
                 }
 
                 return $source->getOrganizations();
         }

Here is the call graph for this function:

◆ login()

sspmod_core_Auth_UserPassOrgBase::login	(	$username,
		$password,
		$organization
	)

abstractprotected

Attempt to log in using the given username, password and organization.

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.
string	$organization	The id of the organization the user chose.

Returns: array Associative array with the user's attributes.

Referenced by authenticate().

Here is the caller graph for this function:

◆ setUsernameOrgMethod()

sspmod_core_Auth_UserPassOrgBase::setUsernameOrgMethod ( $usernameOrgMethod )

protected

Configure the way organizations as part of the username is handled.

There are three possible values:

'none': Force the user to select the correct organization from the dropdown box.
'allow': Allow the user to enter the organization as part of the username.
'force': Remove the dropdown box.

If unconfigured, the default is 'none'.

Parameters

string $usernameOrgMethod The method which should be used.

Definition at line 103 of file UserPassOrgBase.php.

References $usernameOrgMethod.

Referenced by sspmod_ldap_Auth_Source_LDAPMulti\__construct().

                                                                     {
                 assert('in_array($usernameOrgMethod, array("none", "allow", "force"), TRUE)');
 
                 $this->usernameOrgMethod = $usernameOrgMethod;
         }

Here is the caller graph for this function:

Field Documentation

◆ $rememberUsernameChecked

sspmod_core_Auth_UserPassOrgBase::$rememberUsernameChecked = FALSE

protected

Definition at line 58 of file UserPassOrgBase.php.

Referenced by getRememberUsernameChecked().

◆ $rememberUsernameEnabled

sspmod_core_Auth_UserPassOrgBase::$rememberUsernameEnabled = FALSE

protected

Definition at line 50 of file UserPassOrgBase.php.

Referenced by getRememberUsernameEnabled().

◆ $usernameOrgMethod

sspmod_core_Auth_UserPassOrgBase::$usernameOrgMethod

private

What way do we handle the organization as part of the username.

Three values: 'none': Force the user to select the correct organization from the dropdown box. 'allow': Allow the user to enter the organization as part of the username. 'force': Remove the dropdown box.

Definition at line 42 of file UserPassOrgBase.php.

Referenced by sspmod_ldap_Auth_Source_LDAPMulti\__construct(), getUsernameOrgMethod(), and setUsernameOrgMethod().

◆ AUTHID

const sspmod_core_Auth_UserPassOrgBase::AUTHID = 'sspmod_core_Auth_UserPassOrgBase.AuthId'

The key of the AuthId field in the state.

Definition at line 26 of file UserPassOrgBase.php.

◆ ORGID

const sspmod_core_Auth_UserPassOrgBase::ORGID = 'sspmod_core_Auth_UserPassOrgBase.SelectedOrg'

The key of the OrgId field in the state, identifies which org was selected.

Definition at line 32 of file UserPassOrgBase.php.

◆ STAGEID

const sspmod_core_Auth_UserPassOrgBase::STAGEID = 'sspmod_core_Auth_UserPassOrgBase.state'

The string used to identify our states.

Definition at line 20 of file UserPassOrgBase.php.

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/core/lib/Auth/UserPassOrgBase.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()

◆ getOrganizations()

◆ getRememberUsernameChecked()

◆ getRememberUsernameEnabled()

◆ getUsernameOrgMethod()

◆ handleLogin()

◆ listOrganizations()

◆ login()

◆ setUsernameOrgMethod()

Field Documentation

◆ $rememberUsernameChecked

◆ $rememberUsernameEnabled

◆ $usernameOrgMethod

◆ AUTHID

◆ ORGID

◆ STAGEID