SAML2\HTTPPost Class Reference

Inheritance diagram for SAML2\HTTPPost:

Collaboration diagram for SAML2\HTTPPost:

Public Member Functions
	send (Message $message)
	Send a SAML 2 message using the HTTP-POST binding. More...
	receive ()
	Receive a SAML 2 message sent using the HTTP-POST binding. More...
Public Member Functions inherited from SAML2\Binding
	getDestination ()
	Retrieve the destination of a message. More...
	setDestination ($destination)
	Override the destination of a message. More...
	send (Message $message)
	Send a SAML 2 message. More...
	receive ()
	Receive a SAML 2 message. More...

Additional Inherited Members
Static Public Member Functions inherited from SAML2\Binding
static	getBinding ($urn)
	Retrieve a binding with the given URN. More...
static	getCurrentBinding ()
	Guess the current binding. More...
Protected Attributes inherited from SAML2\Binding
	$destination
	The destination of messages. More...

Detailed Description

Definition at line 10 of file HTTPPost.php.

Member Function Documentation

receive()

SAML2\HTTPPost::receive

(

)

Receive a SAML 2 message sent using the HTTP-POST binding.

Throws an exception if it is unable receive the message.

Returns

The received message.

Exceptions

Definition at line 59 of file HTTPPost.php.

References $_POST, and $xml.

    {
        if (array_key_exists('SAMLRequest', $_POST)) {
            $msg = $_POST['SAMLRequest'];
        } elseif (array_key_exists('SAMLResponse', $_POST)) {
            $msg = $_POST['SAMLResponse'];
        } else {
            throw new \Exception('Missing SAMLRequest or SAMLResponse parameter.');
        }

        $msg = base64_decode($msg);

        Utils::getContainer()->debugMessage($msg, 'in');

        $document = DOMDocumentFactory::fromString($msg);
        $xml = $document->firstChild;

        $msg = Message::fromXML($xml);

        if (array_key_exists('RelayState', $_POST)) {
            $msg->setRelayState($_POST['RelayState']);
        }

        return $msg;
    }

send()

SAML2\HTTPPost::send

(

Message

$message

)

Send a SAML 2 message using the HTTP-POST binding.

Note: This function never returns.

Parameters

\SAML2\Message

$message

The message we should send.

Definition at line 19 of file HTTPPost.php.

References $destination, $post, $relayState, SAML2\Message\getDestination(), SAML2\Message\getRelayState(), and SAML2\Message\toSignedXML().

    {
        if ($this->destination === null) {
            $destination = $message->getDestination();
        } else {
            $destination = $this->destination;
        }
        $relayState = $message->getRelayState();

        $msgStr = $message->toSignedXML();
        $msgStr = $msgStr->ownerDocument->saveXML($msgStr);

        Utils::getContainer()->debugMessage($msgStr, 'out');

        $msgStr = base64_encode($msgStr);

        if ($message instanceof Request) {
            $msgType = 'SAMLRequest';
        } else {
            $msgType = 'SAMLResponse';
        }

        $post = array();
        $post[$msgType] = $msgStr;

        if ($relayState !== null) {
            $post['RelayState'] = $relayState;
        }

        Utils::getContainer()->postRedirect($destination, $post);
    }

Here is the call graph for this function:

---

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

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