Base class for all SAML 2 messages. More...

Inheritance diagram for SAML2\Message:

Collaboration diagram for SAML2\Message:

Public Member Functions
	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 ()

Static Public Member Functions
static	fromXML (\DOMElement $xml)
	Convert an XML element into a message. More...

Protected Member Functions
	__construct ($tagName, \DOMElement $xml=null)
	Initialize a message. More...

Protected Attributes
	$extensions

	$document

	$messageContainedSignatureUponConstruction = false

Private Attributes
	$tagName

	$id

	$issueInstant

	$destination

	$consent = Constants::CONSENT_UNSPECIFIED

	$issuer

	$relayState

	$signatureKey

	$certificates

	$validators

	$signatureMethod

Detailed Description

Base class for all SAML 2 messages.

Implements what is common between the samlp:RequestAbstractType and samlp:StatusResponseType element types.

(PHPMD.ExcessiveClassComplexity)

Definition at line 18 of file Message.php.

Constructor & Destructor Documentation

◆ __construct()

SAML2\Message::__construct	(		$tagName,
		\DOMElement	$xml = `null`
	)

protected

Initialize a message.

This constructor takes an optional parameter with a . If this parameter is given, the message will be initialized with data from that XML element.

If no XML element is given, the message is initialized with suitable default values.

Parameters

string	$tagName	The tag name of the root element
\DOMElement \| null	$xml	The input message

Exceptions

Definition at line 136 of file Message.php.

References $issuer, $xml, and array.

     {
         assert(is_string($tagName));
         $this->tagName = $tagName;
 
         $this->id = Utils::getContainer()->generateId();
         $this->issueInstant = Temporal::getTime();
         $this->certificates = array();
         $this->validators = array();
 
         if ($xml === null) {
             return;
         }
 
         if (!$xml->hasAttribute('ID')) {
             throw new \Exception('Missing ID attribute on SAML message.');
         }
         $this->id = $xml->getAttribute('ID');
 
         if ($xml->getAttribute('Version') !== '2.0') {
             /* Currently a very strict check. */
             throw new \Exception('Unsupported version: '.$xml->getAttribute('Version'));
         }
 
         $this->issueInstant = Utils::xsDateTimeToTimestamp($xml->getAttribute('IssueInstant'));
 
         if ($xml->hasAttribute('Destination')) {
             $this->destination = $xml->getAttribute('Destination');
         }
 
         if ($xml->hasAttribute('Consent')) {
             $this->consent = $xml->getAttribute('Consent');
         }
 
         $issuer = Utils::xpQuery($xml, './saml_assertion:Issuer');
         if (!empty($issuer)) {
             $this->issuer = new XML\saml\Issuer($issuer[0]);
             if ($this->issuer->Format === Constants::NAMEID_ENTITY) {
                 $this->issuer = $this->issuer->value;
             }
         }
 
         $this->validateSignature($xml);
 
         $this->extensions = Extensions::getList($xml);
     }

Member Function Documentation

◆ addValidator()

SAML2\Message::addValidator	(	$function,
		$data
	)

Add a method for validating this message.

This function is used by the HTTP-Redirect binding, to make it possible to check the signature against the one included in the query string.

Parameters

callback	$function	The function which should be called
mixed	$data	The data that should be included as the first parameter to the function

Definition at line 225 of file Message.php.

References $data, $function, and array.

Referenced by SAML2\SOAPClient\addSSLValidator().

     {
         assert(is_callable($function));
 
         $this->validators[] = array(
             'Function' => $function,
             'Data' => $data,
         );
     }

Here is the caller graph for this function:

◆ fromXML()

static SAML2\Message::fromXML ( \DOMElement $xml )

static

Convert an XML element into a message.

Parameters

\DOMElement $xml The root XML element

Returns: The message

Exceptions

Definition at line 562 of file Message.php.

     {
         if ($xml->namespaceURI !== Constants::NS_SAMLP) {
             throw new \Exception('Unknown namespace of SAML message: '.var_export($xml->namespaceURI, true));
         }
 
         switch ($xml->localName) {
             case 'AttributeQuery':
                 return new AttributeQuery($xml);
             case 'AuthnRequest':
                 return new AuthnRequest($xml);
             case 'LogoutResponse':
                 return new LogoutResponse($xml);
             case 'LogoutRequest':
                 return new LogoutRequest($xml);
             case 'Response':
                 return new Response($xml);
             case 'ArtifactResponse':
                 return new ArtifactResponse($xml);
             case 'ArtifactResolve':
                 return new ArtifactResolve($xml);
             default:
                 throw new \Exception('Unknown SAML message: '.var_export($xml->localName, true));
         }
     }

◆ getCertificates()

SAML2\Message::getCertificates ( )

Retrieve the certificates that are included in the message.

Returns: array An array of certificates

Implements SAML2\SignedElement.

Definition at line 548 of file Message.php.

References $certificates.

     {
         return $this->certificates;
     }

◆ getConsent()

SAML2\Message::getConsent ( )

Set the given consent for this message.

Most likely (though not required) a value of rn:oasis:names:tc:SAML:2.0:consent.

See also

Returns: string Consent

Definition at line 365 of file Message.php.

     {
         return $this->consent;
     }

◆ getDestination()

SAML2\Message::getDestination ( )

Retrieve the destination of this message.

Returns: string|null The destination of this message, or NULL if no destination is given

Definition at line 323 of file Message.php.

References $destination.

Referenced by SAML2\SOAP\getOutputToSend(), SAML2\HTTPRedirect\getRedirectURL(), SAML2\HTTPArtifact\getRedirectURL(), SAML2\HTTPPost\send(), SAML2\SOAPClient\send(), and SAML2\Response\Validation\ConstraintValidator\DestinationMatches\validate().

     {
         return $this->destination;
     }

Here is the caller graph for this function:

◆ getExtensions()

SAML2\Message::getExtensions ( )

Retrieve the Extensions.

Returns

Definition at line 593 of file Message.php.

     {
         return $this->extensions;
     }

◆ getId()

SAML2\Message::getId ( )

Retrieve the identifier of this message.

Returns: string The identifier of this message

Definition at line 279 of file Message.php.

References $id.

Referenced by SAML2\Response\Processor\verifySignature().

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getIssueInstant()

SAML2\Message::getIssueInstant ( )

Retrieve the issue timestamp of this message.

Returns: int The issue timestamp of this message, as an UNIX timestamp

Definition at line 301 of file Message.php.

     {
         return $this->issueInstant;
     }

◆ getIssuer()

SAML2\Message::getIssuer ( )

Retrieve the issuer if this message.

Returns: string||null The issuer of this message, or NULL if no issuer is given

Definition at line 375 of file Message.php.

References $issuer.

Referenced by SAML2\HTTPArtifact\getRedirectURL(), and SAML2\SOAPClient\send().

     {
         if (is_string($this->issuer) || $this->issuer instanceof XML\saml\Issuer) {
             return $this->issuer;
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getRelayState()

SAML2\Message::getRelayState ( )

Retrieve the RelayState associated with this message.

Returns: string|null The RelayState, or NULL if no RelayState is given

Definition at line 411 of file Message.php.

References $relayState.

Referenced by SAML2\HTTPRedirect\getRedirectURL(), SAML2\HTTPArtifact\getRedirectURL(), and SAML2\HTTPPost\send().

     {
         return $this->relayState;
     }

Here is the caller graph for this function:

◆ getSignatureKey()

SAML2\Message::getSignatureKey ( )

Retrieve the private key we should use to sign the message.

Returns: XMLSecurityKey|null The key, or NULL if no key is specified

Implements SAML2\SignedElement.

Definition at line 514 of file Message.php.

Referenced by SAML2\HTTPRedirect\getRedirectURL().

     {
         return $this->signatureKey;
     }

Here is the caller graph for this function:

◆ getSignatureMethod()

SAML2\Message::getSignatureMethod ( )

Returns: null|string

Definition at line 613 of file Message.php.

     {
         return $this->signatureMethod;
     }

◆ isMessageConstructedWithSignature()

SAML2\Message::isMessageConstructedWithSignature ( )

Query whether or not the message contained a signature at the root level when the object was constructed.

Returns: bool

Definition at line 401 of file Message.php.

Referenced by SAML2\Response\Processor\verifySignature().

     {
         return $this->messageContainedSignatureUponConstruction;
     }

Here is the caller graph for this function:

◆ setCertificates()

SAML2\Message::setCertificates ( array $certificates )

Set the certificates that should be included in the message.

The certificates should be strings with the PEM encoded data.

Parameters

array $certificates An array of certificates

Implements SAML2\SignedElement.

Definition at line 538 of file Message.php.

References $certificates.

     {
         $this->certificates = $certificates;
     }

◆ setConsent()

SAML2\Message::setConsent ( $consent )

Set the given consent for this message.

Most likely (though not required) a value of rn:oasis:names:tc:SAML:2.0:consent.

See also

Parameters

string $consent

Definition at line 349 of file Message.php.

     {
         assert(is_string($consent));
 
         $this->consent = $consent;
     }

◆ setDestination()

SAML2\Message::setDestination ( $destination )

Set the destination of this message.

Parameters

string | null $destination The new destination of this message

Definition at line 333 of file Message.php.

References $destination.

     {
         assert(is_string($destination) || is_null($destination));
 
         $this->destination = $destination;
     }

◆ setExtensions()

SAML2\Message::setExtensions ( $extensions )

Set the Extensions.

Parameters

array | null $extensions The Extensions

Definition at line 603 of file Message.php.

     {
         assert(is_array($extensions) || is_null($extensions));
 
         $this->extensions = $extensions;
     }

◆ setId()

SAML2\Message::setId ( $id )

Set the identifier of this message.

Parameters

string $id The new identifier of this message

Definition at line 289 of file Message.php.

References $id.

     {
         assert(is_string($id));
 
         $this->id = $id;
     }

◆ setIssueInstant()

SAML2\Message::setIssueInstant ( $issueInstant )

Set the issue timestamp of this message.

Parameters

int $issueInstant The new issue timestamp of this message, as an UNIX timestamp

Definition at line 311 of file Message.php.

     {
         assert(is_int($issueInstant));
 
         $this->issueInstant = $issueInstant;
     }

◆ setIssuer()

SAML2\Message::setIssuer ( $issuer )

Set the issuer of this message.

Parameters

string | \SAML2\XML\saml\Issuer | null $issuer The new issuer of this message

Definition at line 389 of file Message.php.

References $issuer.

     {
         assert(is_string($issuer) || $issuer instanceof XML\saml\Issuer || is_null($issuer));
 
         $this->issuer = $issuer;
     }

◆ setRelayState()

SAML2\Message::setRelayState ( $relayState )

Set the RelayState associated with this message.

Parameters

string | null $relayState The new RelayState

Definition at line 421 of file Message.php.

References $relayState.

     {
         assert(is_string($relayState) || is_null($relayState));
 
         $this->relayState = $relayState;
     }

◆ setSignatureKey()

SAML2\Message::setSignatureKey ( XMLSecurityKey $signatureKey = null )

Set the private key we should use to sign the message.

If the key is null, the message will be sent unsigned.

Parameters

XMLSecurityKey | null $signatureKey

Implements SAML2\SignedElement.

Definition at line 526 of file Message.php.

     {
         $this->signatureKey = $signatureKey;
     }

◆ toSignedXML()

SAML2\Message::toSignedXML ( )

Convert this message to a signed XML document.

This method sign the resulting XML document if the private key for the signature is set.

Returns: The root element of the DOM tree

Definition at line 481 of file Message.php.

Referenced by SAML2\SOAP\getOutputToSend(), SAML2\HTTPPost\send(), and SAML2\SOAPClient\send().

     {
         $root = $this->toUnsignedXML();
 
         if ($this->signatureKey === null) {
             /* We don't have a key to sign it with. */
 
             return $root;
         }
 
         /* Find the position we should insert the signature node at. */
         if ($this->issuer !== null) {
             /*
              * We have an issuer node. The signature node should come
              * after the issuer node.
              */
             $issuerNode = $root->firstChild;
             $insertBefore = $issuerNode->nextSibling;
         } else {
             /* No issuer node - the signature element should be the first element. */
             $insertBefore = $root->firstChild;
         }
 
         Utils::insertSignature($this->signatureKey, $this->certificates, $root, $insertBefore);
 
         return $root;
     }

Here is the caller graph for this function:

◆ toUnsignedXML()

SAML2\Message::toUnsignedXML ( )

Convert this message to an unsigned XML document.

This method does not sign the resulting XML document.

Returns: The root element of the DOM tree

Definition at line 435 of file Message.php.

Referenced by SAML2\HTTPRedirect\getRedirectURL(), and SAML2\HTTPArtifact\getRedirectURL().

     {
         $this->document = DOMDocumentFactory::create();
 
         $root = $this->document->createElementNS(Constants::NS_SAMLP, 'samlp:'.$this->tagName);
         $this->document->appendChild($root);
 
         /* Ugly hack to add another namespace declaration to the root element. */
         $root->setAttributeNS(Constants::NS_SAML, 'saml:tmp', 'tmp');
         $root->removeAttributeNS(Constants::NS_SAML, 'tmp');
 
         $root->setAttribute('ID', $this->id);
         $root->setAttribute('Version', '2.0');
         $root->setAttribute('IssueInstant', gmdate('Y-m-d\TH:i:s\Z', $this->issueInstant));
 
         if ($this->destination !== null) {
             $root->setAttribute('Destination', $this->destination);
         }
         if ($this->consent !== null && $this->consent !== Constants::CONSENT_UNSPECIFIED) {
             $root->setAttribute('Consent', $this->consent);
         }
 
         if ($this->issuer !== null) {
             if (is_string($this->issuer)) {
                 Utils::addString($root, Constants::NS_SAML, 'saml:Issuer', $this->issuer);
             } elseif ($this->issuer instanceof XML\saml\Issuer) {
                 $this->issuer->toXML($root);
             }
         }
 
         if (!empty($this->extensions)) {
             Extensions::addList($root, $this->extensions);
         }
 
         return $root;
     }

Here is the caller graph for this function:

◆ validate()

SAML2\Message::validate ( XMLSecurityKey $key )

Validate this message against a public key.

true is returned on success, false is returned if we don't have any signature we can validate. An exception is thrown if the signature validation fails.

Parameters

XMLSecurityKey $key The key we should check against

Returns: bool true on success, false when we don't have a signature

Exceptions

Implements SAML2\SignedElement.

Definition at line 248 of file Message.php.

References $data, $exceptions, $function, and array.

Referenced by SAML2\HTTPArtifact\validateSignature().

     {
         if (count($this->validators) === 0) {
             return false;
         }
 
         $exceptions = array();
 
         foreach ($this->validators as $validator) {
             $function = $validator['Function'];
             $data = $validator['Data'];
 
             try {
                 call_user_func($function, $data, $key);
                 /* We were able to validate the message with this validator. */
 
                 return true;
             } catch (\Exception $e) {
                 $exceptions[] = $e;
             }
         }
 
         /* No validators were able to validate the message. */
         throw $exceptions[0];
     }

Here is the caller graph for this function:

Field Documentation

◆ $certificates

SAML2\Message::$certificates

private

Definition at line 107 of file Message.php.

◆ $consent

SAML2\Message::$consent = Constants::CONSENT_UNSPECIFIED

private

Definition at line 62 of file Message.php.

◆ $destination

SAML2\Message::$destination

private

Definition at line 55 of file Message.php.

Referenced by SAML2\Response\Validation\ConstraintValidator\DestinationMatches\__construct(), and SAML2\Response\Validation\ConstraintValidator\DestinationMatches\validate().

◆ $document

SAML2\Message::$document

protected

Definition at line 86 of file Message.php.

◆ $extensions

SAML2\Message::$extensions

protected

Definition at line 25 of file Message.php.

◆ $id

SAML2\Message::$id

private

Definition at line 41 of file Message.php.

◆ $issueInstant

SAML2\Message::$issueInstant

private

Definition at line 48 of file Message.php.

◆ $issuer

SAML2\Message::$issuer

private

Definition at line 69 of file Message.php.

◆ $messageContainedSignatureUponConstruction

SAML2\Message::$messageContainedSignatureUponConstruction = false

protected

Definition at line 100 of file Message.php.

◆ $relayState

SAML2\Message::$relayState

private

Definition at line 76 of file Message.php.

◆ $signatureKey

SAML2\Message::$signatureKey

private

Definition at line 95 of file Message.php.

◆ $signatureMethod

SAML2\Message::$signatureMethod

private

Definition at line 119 of file Message.php.

◆ $tagName

SAML2\Message::$tagName

private

Definition at line 34 of file Message.php.

◆ $validators

SAML2\Message::$validators

private

Definition at line 114 of file Message.php.

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

libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Message.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addValidator()

◆ fromXML()

◆ getCertificates()

◆ getConsent()

◆ getDestination()

◆ getExtensions()

◆ getId()

◆ getIssueInstant()

◆ getIssuer()

◆ getRelayState()

◆ getSignatureKey()

◆ getSignatureMethod()

◆ isMessageConstructedWithSignature()

◆ setCertificates()

◆ setConsent()

◆ setDestination()

◆ setExtensions()

◆ setId()

◆ setIssueInstant()

◆ setIssuer()

◆ setRelayState()

◆ setSignatureKey()

◆ toSignedXML()

◆ toUnsignedXML()

◆ validate()

Field Documentation

◆ $certificates

◆ $consent

◆ $destination

◆ $document

◆ $extensions

◆ $id

◆ $issueInstant

◆ $issuer

◆ $messageContainedSignatureUponConstruction

◆ $relayState

◆ $signatureKey

◆ $signatureMethod

◆ $tagName

◆ $validators