SAML2\LogoutRequest Class Reference

Inheritance diagram for SAML2\LogoutRequest:

Collaboration diagram for SAML2\LogoutRequest:

Public Member Functions
	__construct (\DOMElement $xml=null)
	Constructor for SAML 2 logout request messages. More...
	getNotOnOrAfter ()
	Retrieve the expiration time of this request. More...
	setNotOnOrAfter ($notOnOrAfter)
	Set the expiration time of this request. More...
	isNameIdEncrypted ()
	Check whether the NameId is encrypted. More...
	encryptNameId (XMLSecurityKey $key)
	Encrypt the NameID in the LogoutRequest. More...
	decryptNameId (XMLSecurityKey $key, array $blacklist=array())
	Decrypt the NameID in the LogoutRequest. More...
	getNameId ()
	Retrieve the name identifier of the session that should be terminated. More...
	setNameId ($nameId)
	Set the name identifier of the session that should be terminated. More...
	getSessionIndexes ()
	Retrieve the SessionIndexes of the sessions that should be terminated. More...
	setSessionIndexes (array $sessionIndexes)
	Set the SessionIndexes of the sessions that should be terminated. More...
	getSessionIndex ()
	Retrieve the sesion index of the session that should be terminated. More...
	setSessionIndex ($sessionIndex)
	Set the sesion index of the session that should be terminated. More...
	toUnsignedXML ()
	Convert this logout request message to an XML element. More...
Public Member Functions inherited from SAML2\Message
	addValidator ($function, $data)
	Add a method for validating this message. More...
	validate (XMLSecurityKey $key)
	Validate this message against a public key. More...
	getId ()
	Retrieve the identifier of this message. More...
	setId ($id)
	Set the identifier of this message. More...
	getIssueInstant ()
	Retrieve the issue timestamp of this message. More...
	setIssueInstant ($issueInstant)
	Set the issue timestamp of this message. More...
	getDestination ()
	Retrieve the destination of this message. More...
	setDestination ($destination)
	Set the destination of this message. More...
	setConsent ($consent)
	Set the given consent for this message. More...
	getConsent ()
	Set the given consent for this message. More...
	getIssuer ()
	Retrieve the issuer if this message. More...
	setIssuer ($issuer)
	Set the issuer of this message. More...
	isMessageConstructedWithSignature ()
	Query whether or not the message contained a signature at the root level when the object was constructed. More...
	getRelayState ()
	Retrieve the RelayState associated with this message. More...
	setRelayState ($relayState)
	Set the RelayState associated with this message. More...
	toUnsignedXML ()
	Convert this message to an unsigned XML document. More...
	toSignedXML ()
	Convert this message to a signed XML document. More...
	getSignatureKey ()
	Retrieve the private key we should use to sign the message. More...
	setSignatureKey (XMLSecurityKey $signatureKey=null)
	Set the private key we should use to sign the message. More...
	setCertificates (array $certificates)
	Set the certificates that should be included in the message. More...
	getCertificates ()
	Retrieve the certificates that are included in the message. More...
	getExtensions ()
	Retrieve the Extensions. More...
	setExtensions ($extensions)
	Set the Extensions. More...
	getSignatureMethod ()
	validate (XMLSecurityKey $key)
	Validate this element against a public key. More...
	setCertificates (array $certificates)
	Set the certificates that should be included in the element. More...
	getCertificates ()
	Retrieve the certificates that are included in the element (if any). More...
	getSignatureKey ()
	Retrieve the private key we should use to sign the element. More...
	setSignatureKey (XMLSecurityKey $signatureKey=null)
	Set the private key we should use to sign the element. More...

Private Attributes
	$notOnOrAfter
	$encryptedNameId
	$nameId
	$sessionIndexes

Additional Inherited Members
Static Public Member Functions inherited from SAML2\Message
static	fromXML (\DOMElement $xml)
	Convert an XML element into a message. More...
Protected Member Functions inherited from SAML2\Message
	__construct ($tagName, \DOMElement $xml=null)
	Initialize a message. More...
Protected Attributes inherited from SAML2\Message
	$extensions
	$document
	$messageContainedSignatureUponConstruction = false

Detailed Description

Definition at line 13 of file LogoutRequest.php.

Constructor & Destructor Documentation

__construct()

SAML2\LogoutRequest::__construct

(

\DOMElement

$xml = null

)

Constructor for SAML 2 logout request messages.

Parameters

\DOMElement | null

$xml

The input message.

Exceptions

Exception

Definition at line 51 of file LogoutRequest.php.

    {
        parent::__construct('LogoutRequest', $xml);
 
        $this->sessionIndexes = array();
 
        if ($xml === null) {
            return;
        }
 
        if ($xml->hasAttribute('NotOnOrAfter')) {
            $this->notOnOrAfter = Utils::xsDateTimeToTimestamp($xml->getAttribute('NotOnOrAfter'));
        }
 
        $nameId = Utils::xpQuery($xml, './saml_assertion:NameID | ./saml_assertion:EncryptedID/xenc:EncryptedData');
        if (empty($nameId)) {
            throw new \Exception('Missing <saml:NameID> or <saml:EncryptedID> in <samlp:LogoutRequest>.');
        } elseif (count($nameId) > 1) {
            throw new \Exception('More than one <saml:NameID> or <saml:EncryptedD> in <samlp:LogoutRequest>.');
        }
        $nameId = $nameId[0];
        if ($nameId->localName === 'EncryptedData') {
            /* The NameID element is encrypted. */
            $this->encryptedNameId = $nameId;
        } else {
            $this->nameId = new XML\saml\NameID($nameId);
        }
 
        $sessionIndexes = Utils::xpQuery($xml, './saml_protocol:SessionIndex');
        foreach ($sessionIndexes as $sessionIndex) {
            $this->sessionIndexes[] = trim($sessionIndex->textContent);
        }
    }

References $nameId, $sessionIndex, and $xml.

Member Function Documentation

decryptNameId()

SAML2\LogoutRequest::decryptNameId	(	XMLSecurityKey	$key,
		array	$blacklist = array()
	)

Decrypt the NameID in the LogoutRequest.

Parameters

XMLSecurityKey	$key	The decryption key.
array	$blacklist	Blacklisted decryption algorithms.

Definition at line 156 of file LogoutRequest.php.

    {
        if ($this->encryptedNameId === null) {
            /* No NameID to decrypt. */
 
            return;
        }
 
        $nameId = Utils::decryptElement($this->encryptedNameId, $key, $blacklist);
        Utils::getContainer()->debugMessage($nameId, 'decrypt');
        $this->nameId = new XML\saml\NameID($nameId);
 
        $this->encryptedNameId = null;
    }

References $key, and $nameId.

encryptNameId()

SAML2\LogoutRequest::encryptNameId

(

XMLSecurityKey

$key

)

Encrypt the NameID in the LogoutRequest.

Parameters

XMLSecurityKey

$key

The encryption key.

Definition at line 126 of file LogoutRequest.php.

    {
        /* First create a XML representation of the NameID. */
        $doc = DOMDocumentFactory::create();
        $root = $doc->createElement('root');
        $doc->appendChild($root);
        $this->nameId->toXML($root);
        $nameId = $root->firstChild;
 
        Utils::getContainer()->debugMessage($nameId, 'encrypt');
 
        /* Encrypt the NameID. */
        $enc = new XMLSecEnc();
        $enc->setNode($nameId);
        $enc->type = XMLSecEnc::Element;
 
        $symmetricKey = new XMLSecurityKey(XMLSecurityKey::AES128_CBC);
        $symmetricKey->generateSessionKey();
        $enc->encryptKey($key, $symmetricKey);
 
        $this->encryptedNameId = $enc->encryptNode($symmetricKey);
        $this->nameId = null;
    }

References $key, $nameId, and $root.

getNameId()

SAML2\LogoutRequest::getNameId

(

)

Retrieve the name identifier of the session that should be terminated.

Returns

\SAML2\XML\saml\NameID The name identifier of the session that should be terminated.

Exceptions

Exception

Definition at line 177 of file LogoutRequest.php.

    {
        if ($this->encryptedNameId !== null) {
            throw new \Exception('Attempted to retrieve encrypted NameID without decrypting it first.');
        }
 
        return $this->nameId;
    }

References $nameId.

getNotOnOrAfter()

SAML2\LogoutRequest::getNotOnOrAfter

(

)

Retrieve the expiration time of this request.

Returns

int|null The expiration time of this request.

Definition at line 90 of file LogoutRequest.php.

    {
        return $this->notOnOrAfter;
    }

getSessionIndex()

SAML2\LogoutRequest::getSessionIndex

(

)

Retrieve the sesion index of the session that should be terminated.

Returns

string|null The sesion index of the session that should be terminated.

Definition at line 226 of file LogoutRequest.php.

    {
        if (empty($this->sessionIndexes)) {
            return null;
        }
 
        return $this->sessionIndexes[0];
    }

getSessionIndexes()

SAML2\LogoutRequest::getSessionIndexes

(

)

Retrieve the SessionIndexes of the sessions that should be terminated.

Returns

array The SessionIndexes, or an empty array if all sessions should be terminated.

Definition at line 206 of file LogoutRequest.php.

    {
        return $this->sessionIndexes;
    }

isNameIdEncrypted()

SAML2\LogoutRequest::isNameIdEncrypted

(

)

Check whether the NameId is encrypted.

Returns

true if the NameId is encrypted, false if not.

Definition at line 112 of file LogoutRequest.php.

    {
        if ($this->encryptedNameId !== null) {
            return true;
        }
 
        return false;
    }

setNameId()

SAML2\LogoutRequest::setNameId

(

$nameId

)

Set the name identifier of the session that should be terminated.

Parameters

\SAML2\XML\saml\NameID | array | null

$nameId

The name identifier of the session that should be terminated.

Definition at line 191 of file LogoutRequest.php.

    {
        assert(is_array($nameId) || $nameId instanceof XML\saml\NameID);
 
        if (is_array($nameId)) {
            $nameId = XML\saml\NameID::fromArray($nameId);
        }
        $this->nameId = $nameId;
    }

References $nameId.

setNotOnOrAfter()

SAML2\LogoutRequest::setNotOnOrAfter

(

$notOnOrAfter

)

Set the expiration time of this request.

Parameters

int | null

$notOnOrAfter

The expiration time of this request.

Definition at line 100 of file LogoutRequest.php.

    {
        assert(is_int($notOnOrAfter) || is_null($notOnOrAfter));
 
        $this->notOnOrAfter = $notOnOrAfter;
    }

setSessionIndex()

SAML2\LogoutRequest::setSessionIndex

(

$sessionIndex

)

Set the sesion index of the session that should be terminated.

Parameters

string | null

$sessionIndex

The sesion index of the session that should be terminated.

Definition at line 240 of file LogoutRequest.php.

    {
        assert(is_string($sessionIndex) || is_null($sessionIndex));
 
        if (is_null($sessionIndex)) {
            $this->sessionIndexes = array();
        } else {
            $this->sessionIndexes = array($sessionIndex);
        }
    }

References $sessionIndex.

setSessionIndexes()

SAML2\LogoutRequest::setSessionIndexes

(

array

$sessionIndexes

)

Set the SessionIndexes of the sessions that should be terminated.

Parameters

array

$sessionIndexes

The SessionIndexes, or an empty array if all sessions should be terminated.

Definition at line 216 of file LogoutRequest.php.

    {
        $this->sessionIndexes = $sessionIndexes;
    }

toUnsignedXML()

SAML2\LogoutRequest::toUnsignedXML

(

)

Convert this logout request message to an XML element.

Returns

\DOMElement This logout request.

Reimplemented from SAML2\Message.

Definition at line 256 of file LogoutRequest.php.

    {
        $root = parent::toUnsignedXML();
 
        if ($this->notOnOrAfter !== null) {
            $root->setAttribute('NotOnOrAfter', gmdate('Y-m-d\TH:i:s\Z', $this->notOnOrAfter));
        }
 
        if ($this->encryptedNameId === null) {
            $this->nameId->toXML($root);
        } else {
            $eid = $root->ownerDocument->createElementNS(Constants::NS_SAML, 'saml:' . 'EncryptedID');
            $root->appendChild($eid);
            $eid->appendChild($root->ownerDocument->importNode($this->encryptedNameId, true));
        }
 
        foreach ($this->sessionIndexes as $sessionIndex) {
            Utils::addString($root, Constants::NS_SAMLP, 'SessionIndex', $sessionIndex);
        }
 
        return $root;
    }

References $root, and $sessionIndex.

Field Documentation

$encryptedNameId

SAML2\LogoutRequest::$encryptedNameId

private

Definition at line 29 of file LogoutRequest.php.

$nameId

SAML2\LogoutRequest::$nameId

private

Definition at line 36 of file LogoutRequest.php.

$notOnOrAfter

SAML2\LogoutRequest::$notOnOrAfter

private

Definition at line 20 of file LogoutRequest.php.

$sessionIndexes

SAML2\LogoutRequest::$sessionIndexes

private

Definition at line 43 of file LogoutRequest.php.

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/LogoutRequest.php