SimpleSAML\Bindings\Shib13\Artifact Class Reference

Collaboration diagram for SimpleSAML\Bindings\Shib13\Artifact:

Static Private Member Functions
static	getArtifacts ()
	Parse the query string, and extract the SAMLart parameters. More...
static	buildRequest (array $artifacts)
	Build the request we will send to the IdP. More...
static	extractResponse ($soapResponse)
	Extract the response element from the SOAP response. More...

Detailed Description

Definition at line 19 of file Artifact.php.

Member Function Documentation

buildRequest()

static SimpleSAML\Bindings\Shib13\Artifact::buildRequest ( array  $artifacts )

staticprivate

Build the request we will send to the IdP.

Parameters

array

$artifacts

The artifacts we will request.

Returns

string The request, as an XML string.

Definition at line 59 of file Artifact.php.

References SimpleSAML\Utils\Random\generateID(), and SimpleSAML\Utils\Time\generateTimestamp().

    {
        $msg = '<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">' .
            '<SOAP-ENV:Body>' .
            '<samlp:Request xmlns:samlp="urn:oasis:names:tc:SAML:1.0:protocol"' .
            ' RequestID="' . Random::generateID() . '"' .
            ' MajorVersion="1" MinorVersion="1"' .
            ' IssueInstant="' . Time::generateTimestamp() . '"' .
            '>';

        foreach ($artifacts as $a) {
            $msg .= '<samlp:AssertionArtifact>' . htmlspecialchars($a) . '</samlp:AssertionArtifact>';
        }

        $msg .= '</samlp:Request>' .
            '</SOAP-ENV:Body>' .
            '</SOAP-ENV:Envelope>';

        return $msg;
    }

Here is the call graph for this function:

extractResponse()

static SimpleSAML\Bindings\Shib13\Artifact::extractResponse (   $soapResponse )

staticprivate

Extract the response element from the SOAP response.

Parameters

string

$soapResponse

The SOAP response.

Returns

string The <saml1p:Response> element, as a string.

Exceptions

Definition at line 88 of file Artifact.php.

References $idpMetadata, $key, $request, $response, $spMetadata, $url, SAML2\DOMDocumentFactory\create(), SimpleSAML\Utils\XML\debugSAMLMessage(), SimpleSAML\Utils\HTTP\fetch(), SAML2\DOMDocumentFactory\fromString(), SimpleSAML\Utils\Config\getCertPath(), SimpleSAML_Configuration\getDefaultEndpoint(), SimpleSAML_Configuration\getPublicKeys(), SimpleSAML_Configuration\getString(), SimpleSAML\Utils\System\getTempDir(), SimpleSAML\Utils\XML\isDOMNodeOfType(), and SimpleSAML\Utils\System\writeFile().

    {
        assert(is_string($soapResponse));

        try {
            $doc = DOMDocumentFactory::fromString($soapResponse);
        } catch (\Exception $e) {
            throw new \SimpleSAML_Error_Exception('Error parsing SAML 1 artifact response.');
        }

        $soapEnvelope = $doc->firstChild;
        if (!XML::isDOMNodeOfType($soapEnvelope, 'Envelope', 'http://schemas.xmlsoap.org/soap/envelope/')) {
            throw new \SimpleSAML_Error_Exception('Expected artifact response to contain a <soap:Envelope> element.');
        }

        $soapBody = XML::getDOMChildren($soapEnvelope, 'Body', 'http://schemas.xmlsoap.org/soap/envelope/');
        if (count($soapBody) === 0) {
            throw new \SimpleSAML_Error_Exception('Couldn\'t find <soap:Body> in <soap:Envelope>.');
        }
        $soapBody = $soapBody[0];


        $responseElement = XML::getDOMChildren($soapBody, 'Response', 'urn:oasis:names:tc:SAML:1.0:protocol');
        if (count($responseElement) === 0) {
            throw new \SimpleSAML_Error_Exception('Couldn\'t find <saml1p:Response> in <soap:Body>.');
        }
        $responseElement = $responseElement[0];

        /*
         * Save the <saml1p:Response> element. Note that we need to import it
         * into a new document, in order to preserve namespace declarations.
         */
        $newDoc = DOMDocumentFactory::create();
        $newDoc->appendChild($newDoc->importNode($responseElement, true));
        $responseXML = $newDoc->saveXML();

        return $responseXML;
    }

Here is the call graph for this function:

getArtifacts()

static SimpleSAML\Bindings\Shib13\Artifact::getArtifacts ( )

staticprivate

Parse the query string, and extract the SAMLart parameters.

This function is required because each query contains multiple artifact with the same parameter name.

Returns

array The artifacts.

Definition at line 30 of file Artifact.php.

References $_SERVER, and $name.

    {
        assert(array_key_exists('QUERY_STRING', $_SERVER));

        // We need to process the query string manually, to capture all SAMLart parameters

        $artifacts = array();

        $elements = explode('&', $_SERVER['QUERY_STRING']);
        foreach ($elements as $element) {
            list($name, $value) = explode('=', $element, 2);
            $name = urldecode($name);
            $value = urldecode($value);

            if ($name === 'SAMLart') {
                $artifacts[] = $value;
            }
        }

        return $artifacts;
    }

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Bindings/Shib13/Artifact.php