SAML2\SOAP Class Reference

Inheritance diagram for SAML2\SOAP:

Collaboration diagram for SAML2\SOAP:

Public Member Functions
	getOutputToSend (Message $message)
	send (Message $message)
	Send a SAML 2 message using the SOAP 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...

Protected Member Functions
	getInputStream ()

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 14 of file SOAP.php.

Member Function Documentation

getInputStream()

SAML2\SOAP::getInputStream ( )

protected

Definition at line 101 of file SOAP.php.

    {
        return file_get_contents('php://input');
    }

getOutputToSend()

SAML2\SOAP::getOutputToSend

(

Message

$message

)

Definition at line 16 of file SOAP.php.

    {
        $envelope = <<<SOAP
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="%s">
    <SOAP-ENV:Header />
    <SOAP-ENV:Body />
</SOAP-ENV:Envelope>
SOAP;
        $envelope = sprintf($envelope, Constants::NS_SOAP);
 
        $doc = new DOMDocument;
        $doc->loadXML($envelope);
 
        // In the Artifact Resolution profile, this will be an ArtifactResolve
        // containing another message (e.g. a Response), however in the ECP
        // profile, this is the Response itself.
        if ($message instanceof Response) {
            $header = $doc->getElementsByTagNameNS(Constants::NS_SOAP, 'Header')->item(0);
 
            $response = new ECPResponse;
            $response->AssertionConsumerServiceURL = $this->getDestination() ?: $message->getDestination();
 
            $response->toXML($header);
 
            // TODO We SHOULD add ecp:RequestAuthenticated SOAP header if we
            // authenticated the AuthnRequest. It may make sense to have a
            // standardized way for Message objects to contain (optional) SOAP
            // headers for use with the SOAP binding.
            //
            // https://docs.oasis-open.org/security/saml/Post2.0/saml-ecp/v2.0/cs01/saml-ecp-v2.0-cs01.html#_Toc366664733
            // See Section 2.3.6.1
        }
 
        $body = $doc->getElementsByTagNameNs(Constants::NS_SOAP, 'Body')->item(0);
 
        $body->appendChild($doc->importNode($message->toSignedXML(), true));
 
        return $doc->saveXML();
    }

References $header, $message, and $response.

receive()

SAML2\SOAP::receive

(

)

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

Throws an exception if it is unable receive the message.

Returns

\SAML2\Message The received message.

Exceptions

Exception

Reimplemented from SAML2\Binding.

Definition at line 85 of file SOAP.php.

    {
        $postText = $this->getInputStream();
 
        if (empty($postText)) {
            throw new \Exception('Invalid message received to AssertionConsumerService endpoint.');
        }
 
        $document = DOMDocumentFactory::fromString($postText);
        $xml = $document->firstChild;
        Utils::getContainer()->debugMessage($xml, 'in');
        $results = Utils::xpQuery($xml, '/soap-env:Envelope/soap-env:Body/*[1]');
 
        return Message::fromXML($results[0]);
    }

References $results, and $xml.

send()

SAML2\SOAP::send

(

Message

$message

)

Send a SAML 2 message using the SOAP binding.

Note: This function never returns.

Parameters

\SAML2\Message

$message

The message we should send.

@SuppressWarnings(PHPMD.ExitExpression)

Reimplemented from SAML2\Binding.

Definition at line 66 of file SOAP.php.

    {
        header('Content-Type: text/xml', true);
 
        $xml = $this->getOutputToSend($message);
        Utils::getContainer()->debugMessage($xml, 'out');
        echo $xml;
 
        exit(0);
    }

References $message, $xml, and exit.

---

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

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