Inheritance diagram for sspmod_ldap_Auth_Source_LDAPMulti:

Collaboration diagram for sspmod_ldap_Auth_Source_LDAPMulti:

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

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

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

	getOrganizations ()
	Retrieve list of organizations. More...

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

Private Attributes
	$orgs
	An array with descriptions for organizations. More...

	$ldapOrgs
	An array of organization IDs to LDAP configuration objects. More...

	$includeOrgInUsername
	Whether we should include the organization as part of the username. More...

Additional Inherited Members
Static Public Member Functions inherited from sspmod_core_Auth_UserPassOrgBase
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 inherited from sspmod_core_Auth_UserPassOrgBase
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...

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_UserPassOrgBase
	$rememberUsernameEnabled = FALSE

	$rememberUsernameChecked = FALSE

Protected Attributes inherited from SimpleSAML_Auth_Source
	$authId

Detailed Description

Definition at line 13 of file LDAPMulti.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_ldap_Auth_Source_LDAPMulti::__construct	(	$info,
		$config
	)

Constructor for this authentication source.

Parameters

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

Definition at line 38 of file LDAPMulti.php.

    {
        assert('is_array($info)');
        assert('is_array($config)');
 
        // Call the parent constructor first, as required by the interface
        parent::__construct($info, $config);
 
        $cfgHelper = SimpleSAML_Configuration::loadFromArray($config,
            'Authentication source ' . var_export($this->authId, true));
 
 
        $this->orgs = array();
        $this->ldapOrgs = array();
        foreach ($config as $name => $value) {
 
            if ($name === 'username_organization_method') {
                $usernameOrgMethod = $cfgHelper->getValueValidate(
                    'username_organization_method',
                    array('none', 'allow', 'force'));
                $this->setUsernameOrgMethod($usernameOrgMethod);
                continue;
            }
 
            if ($name === 'include_organization_in_username') {
                $this->includeOrgInUsername = $cfgHelper->getBoolean(
                    'include_organization_in_username', false);
                continue;
            }
 
            $orgCfg = $cfgHelper->getArray($name);
            $orgId = $name;
 
            if (array_key_exists('description', $orgCfg)) {
                $this->orgs[$orgId] = $orgCfg['description'];
            } else {
                $this->orgs[$orgId] = $orgId;
            }
 
            $orgCfg = new sspmod_ldap_ConfigHelper($orgCfg,
                'Authentication source ' . var_export($this->authId, true) .
                ', organization ' . var_export($orgId, true));
            $this->ldapOrgs[$orgId] = $orgCfg;
        }
    }

References $config, $info, $name, sspmod_core_Auth_UserPassOrgBase\$usernameOrgMethod, SimpleSAML_Configuration\loadFromArray(), and sspmod_core_Auth_UserPassOrgBase\setUsernameOrgMethod().

Here is the call graph for this function:

Member Function Documentation

◆ getOrganizations()

sspmod_ldap_Auth_Source_LDAPMulti::getOrganizations ( )

protected

Retrieve list of organizations.

Returns: array Associative array with the organizations.

Reimplemented from sspmod_core_Auth_UserPassOrgBase.

Definition at line 120 of file LDAPMulti.php.

    {
        return $this->orgs;
    }

References $orgs.

◆ login()

sspmod_ldap_Auth_Source_LDAPMulti::login	(		$username,
			$password,
			$org,
		array	$sasl_args = `null`
	)

protected

Attempt to log in using the given username and password.

Parameters

string	$username	The username the user wrote.
string	$password	The password the user wrote.
string	$org	The organization the user chose.

Returns: array Associative array with the users attributes.

Definition at line 93 of file LDAPMulti.php.

    {
        assert('is_string($username)');
        assert('is_string($password)');
        assert('is_string($org)');
 
        if (!array_key_exists($org, $this->ldapOrgs)) {
            // The user has selected an organization which doesn't exist anymore.
            SimpleSAML\Logger::warning('Authentication source ' . var_export($this->authId, true) .
                ': Organization seems to have disappeared while the user logged in.' .
                ' Organization was ' . var_export($org, true));
            throw new SimpleSAML_Error_Error('WRONGUSERPASS');
        }
 
        if ($this->includeOrgInUsername) {
            $username = $username . '@' . $org;
        }
 
        return $this->ldapOrgs[$org]->login($username, $password, $sasl_args);
    }

References $password, and SimpleSAML\Logger\warning().

Here is the call graph for this function:

Field Documentation

◆ $includeOrgInUsername

sspmod_ldap_Auth_Source_LDAPMulti::$includeOrgInUsername

private

Whether we should include the organization as part of the username.

Definition at line 29 of file LDAPMulti.php.

◆ $ldapOrgs

sspmod_ldap_Auth_Source_LDAPMulti::$ldapOrgs

private

An array of organization IDs to LDAP configuration objects.

Definition at line 24 of file LDAPMulti.php.

◆ $orgs

sspmod_ldap_Auth_Source_LDAPMulti::$orgs

private

An array with descriptions for organizations.

Definition at line 19 of file LDAPMulti.php.

Referenced by getOrganizations().

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/ldap/lib/Auth/Source/LDAPMulti.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getOrganizations()

◆ login()

Field Documentation

◆ $includeOrgInUsername

◆ $ldapOrgs

◆ $orgs