ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Public Member Functions | Private Attributes
SimpleSAML\IdP\IFrameLogoutHandler Class Reference
+ Inheritance diagram for SimpleSAML\IdP\IFrameLogoutHandler:
+ Collaboration diagram for SimpleSAML\IdP\IFrameLogoutHandler:

Public Member Functions

 __construct (\SimpleSAML_IdP $idp)
 LogoutIFrame constructor. More...
 
 startLogout (array &$state, $assocId)
 Start the logout operation. More...
 
 onResponse ($assocId, $relayState, \SimpleSAML_Error_Exception $error=null)
 Continue the logout operation. More...
 

Private Attributes

 $idp
 

Detailed Description

Definition at line 13 of file IFrameLogoutHandler.php.

Constructor & Destructor Documentation

◆ __construct()

SimpleSAML\IdP\IFrameLogoutHandler::__construct ( \SimpleSAML_IdP  $idp)

LogoutIFrame constructor.

Parameters
\SimpleSAML_IdP$idpThe IdP to log out from.

Implements SimpleSAML\IdP\LogoutHandlerInterface.

Definition at line 29 of file IFrameLogoutHandler.php.

References SimpleSAML\IdP\IFrameLogoutHandler\$idp.

30  {
31  $this->idp = $idp;
32  }

Member Function Documentation

◆ onResponse()

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

Continue the logout operation.

This function will never return.

Parameters
string$assocIdThe association that is terminated.
string | null$relayStateThe RelayState from the start of the logout.
\SimpleSAML_Error_Exception | null$errorThe error that occurred during session termination (if any).

Implements SimpleSAML\IdP\LogoutHandlerInterface.

Definition at line 89 of file IFrameLogoutHandler.php.

References $assocId, $header, exit, and html().

90  {
91  assert(is_string($assocId));
92 
93  $spId = sha1($assocId);
94  $this->idp->terminateAssociation($assocId);
95 
96  $header = <<<HEADER
97 <!DOCTYPE html>
98 <html>
99  <head>
100  <title>Logout response from %s</title>
101  <script>
102 HEADER;
103  printf($header, htmlspecialchars(var_export($assocId, true)));
104  if ($error) {
105  $errorMsg = $error->getMessage();
106  echo('window.parent.logoutFailed("'.$spId.'", "'.addslashes($errorMsg).'");');
107  } else {
108  echo('window.parent.logoutCompleted("'.$spId.'");');
109  }
110  echo <<<FOOTER
111  </script>
112  </head>
113  <body>
114  </body>
115 </html>
116 FOOTER;
117  exit(0);
118  }
$header
$header
Definition: no_cookie.tpl.php:6
exit
exit
Definition: backend.php:16
html
html()
Definition: IntegrationTest.php:14
$assocId
if(!isset($_REQUEST['association'])) $assocId
Definition: logout-iframe-post.php:12
+ Here is the call graph for this function:

◆ startLogout()

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

Start the logout operation.

Parameters
array&$stateThe logout state.
string | null$assocIdThe SP we are logging out from.

Implements SimpleSAML\IdP\LogoutHandlerInterface.

Definition at line 40 of file IFrameLogoutHandler.php.

References $association, $associations, $assocId, $id, SimpleSAML\IdP\IFrameLogoutHandler\$idp, PHPMailer\PHPMailer\$params, $url, SimpleSAML_IdP\getByState(), SimpleSAML\Module\getModuleURL(), SimpleSAML\Utils\HTTP\redirectTrustedURL(), and SimpleSAML_Auth_State\saveState().

41  {
42  assert(is_string($assocId) || $assocId === null);
43 
44  $associations = $this->idp->getAssociations();
45 
46  if (count($associations) === 0) {
47  $this->idp->finishLogout($state);
48  }
49 
50  foreach ($associations as $id => &$association) {
51  $idp = \SimpleSAML_IdP::getByState($association);
52  $association['core:Logout-IFrame:Name'] = $idp->getSPName($id);
53  $association['core:Logout-IFrame:State'] = 'onhold';
54  }
55  $state['core:Logout-IFrame:Associations'] = $associations;
56 
57  if (!is_null($assocId)) {
58  $spName = $this->idp->getSPName($assocId);
59  if ($spName === null) {
60  $spName = array('en' => $assocId);
61  }
62 
63  $state['core:Logout-IFrame:From'] = $spName;
64  } else {
65  $state['core:Logout-IFrame:From'] = null;
66  }
67 
68  $params = array(
69  'id' => \SimpleSAML_Auth_State::saveState($state, 'core:Logout-IFrame'),
70  );
71  if (isset($state['core:Logout-IFrame:InitType'])) {
72  $params['type'] = $state['core:Logout-IFrame:InitType'];
73  }
74 
75  $url = Module::getModuleURL('core/idp/logout-iframe.php', $params);
76  HTTP::redirectTrustedURL($url);
77  }
SimpleSAML_IdP\getByState
static getByState(array &$state)
Retrieve the IdP "owning" the state.
Definition: IdP.php:145
$id
if(!array_key_exists('StateId', $_REQUEST)) $id
Definition: expirywarning.php:14
SimpleSAML\Utils\HTTP\redirectTrustedURL
static redirectTrustedURL($url, $parameters=array())
This function redirects to the specified URL without performing any security checks.
Definition: HTTP.php:959
SimpleSAML\Module\getModuleURL
static getModuleURL($resource, array $parameters=array())
Get absolute URL to a specified module resource.
Definition: Module.php:220
$state
if(!array_key_exists('stateid', $_REQUEST)) $state
Handle linkback() response from LinkedIn.
Definition: linkback.php:10
$association
if(!isset($associations[$assocId])) $association
Definition: logout-iframe-post.php:23
$assocId
if(!isset($_REQUEST['association'])) $assocId
Definition: logout-iframe-post.php:12
$url
$url
Definition: proxy_ylocal.php:28
SimpleSAML_Auth_State\saveState
static saveState(&$state, $stage, $rawId=false)
Save the state.
Definition: State.php:194
$associations
$associations
Definition: logout-iframe-done.php:9
+ Here is the call graph for this function:

Field Documentation

◆ $idp

SimpleSAML\IdP\IFrameLogoutHandler::$idp
private

Definition at line 21 of file IFrameLogoutHandler.php.

Referenced by SimpleSAML\IdP\IFrameLogoutHandler\__construct(), and SimpleSAML\IdP\IFrameLogoutHandler\startLogout().

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