Inheritance diagram for sspmod_ldap_Auth_Source_LDAP:

Collaboration diagram for sspmod_ldap_Auth_Source_LDAP:

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, array $sasl_args=null)
	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
	$ldapConfig
	A LDAP configuration object. 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 13 of file LDAP.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_ldap_Auth_Source_LDAP::__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 LDAP.php.

    {
        assert('is_array($info)');
        assert('is_array($config)');
 
        // Call the parent constructor first, as required by the interface
        parent::__construct($info, $config);
 
        $this->ldapConfig = new sspmod_ldap_ConfigHelper($config,
            'Authentication source ' . var_export($this->authId, true));
    }

References $config, and $info.

Member Function Documentation

◆ login()

sspmod_ldap_Auth_Source_LDAP::login	(		$username,
			$password,
		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. param array $sasl_arg Associative array of SASL options

Returns: array Associative array with the users attributes.

Definition at line 49 of file LDAP.php.

    {
        assert('is_string($username)');
        assert('is_string($password)');
 
        return $this->ldapConfig->login($username, $password, $sasl_args);
    }

References $password.

Field Documentation

◆ $ldapConfig

sspmod_ldap_Auth_Source_LDAP::$ldapConfig

private

A LDAP configuration object.

Definition at line 19 of file LDAP.php.

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

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

Public Member Functions

Protected Member Functions

Private Attributes