Inheritance diagram for sspmod_multiauth_Auth_Source_MultiAuth:

Collaboration diagram for sspmod_multiauth_Auth_Source_MultiAuth:

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

	authenticate (&$state)
	Prompt the user with a list of authentication sources. More...

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

	setPreviousSource ($source)
	Set the previous authentication source. More...

	getPreviousSource ()
	Get the previous authentication source. 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	delegateAuthentication ($authId, $state)
	Delegate authentication. 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	AUTHID = 'sspmod_multiauth_Auth_Source_MultiAuth.AuthId'
	The key of the AuthId field in the state. More...

const	STAGEID = 'sspmod_multiauth_Auth_Source_MultiAuth.StageId'
	The string used to identify our states. More...

const	SOURCESID = 'sspmod_multiauth_Auth_Source_MultiAuth.SourceId'
	The key where the sources is saved in the state. More...

const	SESSION_SOURCE = 'multiauth:selectedSource'
	The key where the selected source is saved in the session. More...

Private Attributes
	$sources
	Array of sources we let the user chooses among. More...

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

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 SimpleSAML_Auth_Source
	$authId

Detailed Description

Definition at line 11 of file MultiAuth.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_multiauth_Auth_Source_MultiAuth::__construct	(	$info,
		$config
	)

Constructor for this authentication source.

Parameters

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

Definition at line 44 of file MultiAuth.php.

References $config, $defaultLanguage, $info, $source, $text, SimpleSAML_Configuration\getConfig(), and SimpleSAML_Configuration\getInstance().

                                                     {
                 assert(is_array($info));
                 assert(is_array($config));
 
                 // Call the parent constructor first, as required by the interface
                 parent::__construct($info, $config);
 
                 if (!array_key_exists('sources', $config)) {
                         throw new Exception('The required "sources" config option was not found');
                 }
 
                 $globalConfiguration = SimpleSAML_Configuration::getInstance();
                 $defaultLanguage = $globalConfiguration->getString('language.default', 'en');
                 $authsources = SimpleSAML_Configuration::getConfig('authsources.php');
                 $this->sources = array();
                 foreach($config['sources'] as $source => $info) {
 
                         if (is_int($source)) { // Backwards compatibility 
                                 $source = $info;
                                 $info = array();
                         }
 
                         if (array_key_exists('text', $info)) {
                                 $text = $info['text'];
                         } else {
                                 $text = array($defaultLanguage => $source);
                         }
 
                         if (array_key_exists('css-class', $info)) {
                                 $css_class = $info['css-class'];
                         } else {
                                 // Use the authtype as the css class
                                 $authconfig = $authsources->getArray($source, NULL);
                                 if (!array_key_exists(0, $authconfig) || !is_string($authconfig[0])) {
                                         $css_class = "";
                                 } else {
                                         $css_class = str_replace(":", "-", $authconfig[0]);
                                 }
                         }
 
                         $this->sources[] = array(
                                 'source' => $source,
                                 'text' => $text,
                                 'css_class' => $css_class,
                         );
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ authenticate()

sspmod_multiauth_Auth_Source_MultiAuth::authenticate ( & $state )

Prompt the user with a list of authentication sources.

This method saves the information about the configured sources, and redirects to a page where the user must select one of these authentication sources.

This method never return. The authentication process is finished in the delegateAuthentication method.

Parameters

array &$state Information about the current authentication.

Definition at line 104 of file MultiAuth.php.

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

                                               {
                 assert(is_array($state));
 
                 $state[self::AUTHID] = $this->authId;
                 $state[self::SOURCESID] = $this->sources;
 
                 /* Save the $state array, so that we can restore if after a redirect */
                 $id = SimpleSAML_Auth_State::saveState($state, self::STAGEID);
 
                 /* Redirect to the select source page. We include the identifier of the
                 saved state array as a parameter to the login form */
                 $url = SimpleSAML\Module::getModuleURL('multiauth/selectsource.php');
                 $params = array('AuthState' => $id);
 
                 // Allowes the user to specify the auth souce to be used
                 if(isset($_GET['source'])) {
                         $params['source'] = $_GET['source'];
                 }
 
                 \SimpleSAML\Utils\HTTP::redirectTrustedURL($url, $params);
 
                 /* The previous function never returns, so this code is never
                 executed */
                 assert(false);
         }

Here is the call graph for this function:

◆ delegateAuthentication()

static sspmod_multiauth_Auth_Source_MultiAuth::delegateAuthentication	(	$authId,
		$state
	)

static

Delegate authentication.

This method is called once the user has choosen one authentication source. It saves the selected authentication source in the session to be able to logout properly. Then it calls the authenticate method on such selected authentication source.

Parameters

string	$authId	Selected authentication source
array	$state	Information about the current authentication.

Definition at line 141 of file MultiAuth.php.

References $as, SimpleSAML_Auth_Source\$authId, $session, $state, SimpleSAML_Auth_Source\completeAuth(), SimpleSAML_Session\DATA_TIMEOUT_SESSION_END, SimpleSAML_Auth_Source\getById(), SimpleSAML_Session\getSessionFromRequest(), and SimpleSAML_Auth_State\throwException().

                                                                        {
                 assert(is_string($authId));
                 assert(is_array($state));
 
                 $as = SimpleSAML_Auth_Source::getById($authId);
                 $valid_sources = array_map(
                         function($src) {
                                 return $src['source'];
                         },
                         $state[self::SOURCESID]
         );
                 if ($as === NULL || !in_array($authId, $valid_sources, true)) {
                         throw new Exception('Invalid authentication source: ' . $authId);
                 }
 
                 /* Save the selected authentication source for the logout process. */
                 $session = SimpleSAML_Session::getSessionFromRequest();
                 $session->setData(self::SESSION_SOURCE, $state[self::AUTHID], $authId, SimpleSAML_Session::DATA_TIMEOUT_SESSION_END);
 
                 try {
                         $as->authenticate($state);
                 } catch (SimpleSAML_Error_Exception $e) {
                         SimpleSAML_Auth_State::throwException($state, $e);
                 } catch (Exception $e) {
                         $e = new SimpleSAML_Error_UnserializableException($e);
                         SimpleSAML_Auth_State::throwException($state, $e);
                 }
                 SimpleSAML_Auth_Source::completeAuth($state);
         }

Here is the call graph for this function:

◆ getPreviousSource()

sspmod_multiauth_Auth_Source_MultiAuth::getPreviousSource ( )

Get the previous authentication source.

This method retrieves the authentication source that the user selected last time or NULL if this is the first time or remembering is disabled.

Definition at line 226 of file MultiAuth.php.

References $_COOKIE, SimpleSAML_Auth_Source\$authId, and $cookieName.

                                             {
                 $cookieName = 'multiauth_source_' . $this->authId;
                 if(array_key_exists($cookieName, $_COOKIE)) {
                         return $_COOKIE[$cookieName];
                 } else {
                         return NULL;
                 }
         }

◆ logout()

sspmod_multiauth_Auth_Source_MultiAuth::logout ( & $state )

Log out from this authentication source.

This method retrieves the authentication source used for this session and then call the logout method on it.

Parameters

array &$state Information about the current logout operation.

Definition at line 179 of file MultiAuth.php.

References SimpleSAML_Auth_Source\$authId, $session, $source, $state, SimpleSAML_Auth_Source\getById(), and SimpleSAML_Session\getSessionFromRequest().

                                         {
                 assert(is_array($state));
 
                 /* Get the source that was used to authenticate */
                 $session = SimpleSAML_Session::getSessionFromRequest();
                 $authId = $session->getData(self::SESSION_SOURCE, $this->authId);
 
                 $source = SimpleSAML_Auth_Source::getById($authId);
                 if ($source === NULL) {
                         throw new Exception('Invalid authentication source during logout: ' . $source);
                 }
                 /* Then, do the logout on it */
                 $source->logout($state);
         }

Here is the call graph for this function:

◆ setPreviousSource()

sspmod_multiauth_Auth_Source_MultiAuth::setPreviousSource ( $source )

Set the previous authentication source.

This method remembers the authentication source that the user selected by storing its name in a cookie.

Parameters

string $source Name of the authentication source the user selected.

Definition at line 202 of file MultiAuth.php.

References SimpleSAML_Auth_Source\$authId, $config, $cookieName, PHPMailer\PHPMailer\$params, $source, SimpleSAML_Configuration\getInstance(), and SimpleSAML\Utils\HTTP\setCookie().

                                                    {
                 assert(is_string($source));
 
                 $cookieName = 'multiauth_source_' . $this->authId;
 
                 $config = SimpleSAML_Configuration::getInstance();
                 $params = array(
                         /* We save the cookies for 90 days. */
                         'lifetime' => (60*60*24*90),
                         /* The base path for cookies.
                         This should be the installation directory for SimpleSAMLphp. */
                         'path' => $config->getBasePath(),
                         'httponly' => FALSE,
                 );
 
         \SimpleSAML\Utils\HTTP::setCookie($cookieName, $source, $params, FALSE);
         }

Here is the call graph for this function:

Field Documentation

◆ $sources

sspmod_multiauth_Auth_Source_MultiAuth::$sources

private

Array of sources we let the user chooses among.

Definition at line 36 of file MultiAuth.php.

Referenced by authenticate().

◆ AUTHID

const sspmod_multiauth_Auth_Source_MultiAuth::AUTHID = 'sspmod_multiauth_Auth_Source_MultiAuth.AuthId'

The key of the AuthId field in the state.

Definition at line 16 of file MultiAuth.php.

◆ SESSION_SOURCE

const sspmod_multiauth_Auth_Source_MultiAuth::SESSION_SOURCE = 'multiauth:selectedSource'

The key where the selected source is saved in the session.

Definition at line 31 of file MultiAuth.php.

◆ SOURCESID

const sspmod_multiauth_Auth_Source_MultiAuth::SOURCESID = 'sspmod_multiauth_Auth_Source_MultiAuth.SourceId'

The key where the sources is saved in the state.

Definition at line 26 of file MultiAuth.php.

◆ STAGEID

const sspmod_multiauth_Auth_Source_MultiAuth::STAGEID = 'sspmod_multiauth_Auth_Source_MultiAuth.StageId'

The string used to identify our states.

Definition at line 21 of file MultiAuth.php.

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/multiauth/lib/Auth/Source/MultiAuth.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ authenticate()

◆ delegateAuthentication()

◆ getPreviousSource()

◆ logout()

◆ setPreviousSource()

Field Documentation

◆ $sources

◆ AUTHID

◆ SESSION_SOURCE

◆ SOURCESID

◆ STAGEID