SimpleSAML\IdP\TraditionalLogoutHandler Class Reference

Inheritance diagram for SimpleSAML\IdP\TraditionalLogoutHandler:

Collaboration diagram for SimpleSAML\IdP\TraditionalLogoutHandler:

Public Member Functions
	__construct (\SimpleSAML_IdP $idp)
	TraditionalLogout constructor. More...
	startLogout (array &$state, $assocId)
	Start the logout operation. More...
	onResponse ($assocId, $relayState, \SimpleSAML_Error_Exception $error=null)
	Continue the logout operation. More...
	__construct (\SimpleSAML_IdP $idp)
	Initialize this logout handler. More...
	startLogout (array &$state, $assocId)
	Start a logout operation. More...
	onResponse ($assocId, $relayState, \SimpleSAML_Error_Exception $error=null)
	Handles responses to our logout requests. More...

Private Member Functions
	logoutNextSP (array &$state)
	Picks the next SP and issues a logout request. More...

Private Attributes
	$idp

Detailed Description

Definition at line 14 of file TraditionalLogoutHandler.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\IdP\TraditionalLogoutHandler::__construct

(

\SimpleSAML_IdP

$idp

)

TraditionalLogout constructor.

Parameters

\SimpleSAML_IdP

$idp

The IdP to log out from.

Implements SimpleSAML\IdP\LogoutHandlerInterface.

Definition at line 30 of file TraditionalLogoutHandler.php.

    {
        $this->idp = $idp;
    }

References SimpleSAML\IdP\TraditionalLogoutHandler\$idp.

Member Function Documentation

logoutNextSP()

SimpleSAML\IdP\TraditionalLogoutHandler::logoutNextSP ( array &  $state )

private

Picks the next SP and issues a logout request.

This function never returns.

Parameters

array

&$state

The logout state.

Definition at line 43 of file TraditionalLogoutHandler.php.

    {
        $association = array_pop($state['core:LogoutTraditional:Remaining']);
        if ($association === null) {
            $this->idp->finishLogout($state);
        }
 
        $relayState = \SimpleSAML_Auth_State::saveState($state, 'core:LogoutTraditional', true);
 
        $id = $association['id'];
        Logger::info('Logging out of '.var_export($id, true).'.');
 
        try {
            $idp = \SimpleSAML_IdP::getByState($association);
            $url = call_user_func(array($association['Handler'], 'getLogoutURL'), $idp, $association, $relayState);
            HTTP::redirectTrustedURL($url);
        } catch (\Exception $e) {
            Logger::warning('Unable to initialize logout to '.var_export($id, true).'.');
            $this->idp->terminateAssociation($id);
            $state['core:Failed'] = true;
 
            // Try the next SP
            $this->logoutNextSP($state);
            assert('FALSE');
        }
    }

References $association, $id, SimpleSAML\IdP\TraditionalLogoutHandler\$idp, $relayState, $state, $url, SimpleSAML_IdP\getByState(), SimpleSAML\Logger\info(), SimpleSAML\IdP\TraditionalLogoutHandler\logoutNextSP(), SimpleSAML\Utils\HTTP\redirectTrustedURL(), SimpleSAML_Auth_State\saveState(), and SimpleSAML\Logger\warning().

Referenced by SimpleSAML\IdP\TraditionalLogoutHandler\logoutNextSP(), SimpleSAML\IdP\TraditionalLogoutHandler\onResponse(), and SimpleSAML\IdP\TraditionalLogoutHandler\startLogout().

Here is the call graph for this function:

Here is the caller graph for this function:

onResponse()

SimpleSAML\IdP\TraditionalLogoutHandler::onResponse	(		$assocId,
			$relayState,
		\SimpleSAML_Error_Exception	$error = null
	)

Continue the logout operation.

This function will never return.

Parameters

string	$assocId	The association that is terminated.
string | null	$relayState	The RelayState from the start of the logout.
\SimpleSAML_Error_Exception | null	$error	The error that occurred during session termination (if any).

Exceptions

SimpleSAML_Error_Exception If the RelayState was lost during logout.

Implements SimpleSAML\IdP\LogoutHandlerInterface.

Definition at line 98 of file TraditionalLogoutHandler.php.

    {
        assert('is_string($assocId)');
        assert('is_string($relayState) || is_null($relayState)');
 
        if ($relayState === null) {
            throw new \SimpleSAML_Error_Exception('RelayState lost during logout.');
        }
 
        $state = \SimpleSAML_Auth_State::loadState($relayState, 'core:LogoutTraditional');
 
        if ($error === null) {
            Logger::info('Logged out of '.var_export($assocId, true).'.');
            $this->idp->terminateAssociation($assocId);
        } else {
            Logger::warning('Error received from '.var_export($assocId, true).' during logout:');
            $error->logWarning();
            $state['core:Failed'] = true;
        }
 
        self::logoutNextSP($state);
    }

References $assocId, $error, $relayState, $state, SimpleSAML\Logger\info(), SimpleSAML_Auth_State\loadState(), SimpleSAML\IdP\TraditionalLogoutHandler\logoutNextSP(), and SimpleSAML\Logger\warning().

Here is the call graph for this function:

startLogout()

SimpleSAML\IdP\TraditionalLogoutHandler::startLogout	(	array &	$state,
			$assocId
	)

Start the logout operation.

This function never returns.

Parameters

array	&$state	The logout state.
string	$assocId	The association that started the logout.

Implements SimpleSAML\IdP\LogoutHandlerInterface.

Definition at line 79 of file TraditionalLogoutHandler.php.

    {
        $state['core:LogoutTraditional:Remaining'] = $this->idp->getAssociations();
 
        self::logoutNextSP($state);
    }

References $state, and SimpleSAML\IdP\TraditionalLogoutHandler\logoutNextSP().

Here is the call graph for this function:

Field Documentation

$idp

SimpleSAML\IdP\TraditionalLogoutHandler::$idp

private

Definition at line 22 of file TraditionalLogoutHandler.php.

Referenced by SimpleSAML\IdP\TraditionalLogoutHandler\__construct(), and SimpleSAML\IdP\TraditionalLogoutHandler\logoutNextSP().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/IdP/TraditionalLogoutHandler.php