SimpleSAML\Bindings\Shib13\HTTPPost Class Reference

Collaboration diagram for SimpleSAML\Bindings\Shib13\HTTPPost:

Public Member Functions
	__construct (\SimpleSAML_Configuration $configuration, \SimpleSAML_Metadata_MetaDataStorageHandler $metadatastore)
	Constructor for the \SimpleSAML\Bindings\Shib13\HTTPPost class. More...
	sendResponse ( $response, \SimpleSAML_Configuration $idpmd, \SimpleSAML_Configuration $spmd, $relayState, $shire)
	Send an authenticationResponse using HTTP-POST. More...
	decodeResponse ($post)
	Decode a received response. More...

Private Attributes
	$configuration = null
	$metadata = null

Detailed Description

Definition at line 20 of file HTTPPost.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\Bindings\Shib13\HTTPPost::__construct	(	\SimpleSAML_Configuration	$configuration,
		\SimpleSAML_Metadata_MetaDataStorageHandler	$metadatastore
	)

Constructor for the \SimpleSAML\Bindings\Shib13\HTTPPost class.

Parameters

\SimpleSAML_Configuration	$configuration	The configuration to use.
\SimpleSAML_Metadata_MetaDataStorageHandler	$metadatastore	A store where to find metadata.

Definition at line 40 of file HTTPPost.php.

      {
        $this->configuration = $configuration;
        $this->metadata = $metadatastore;
    }

References SimpleSAML\Bindings\Shib13\HTTPPost\$configuration.

Member Function Documentation

decodeResponse()

SimpleSAML\Bindings\Shib13\HTTPPost::decodeResponse

(

$post

)

Decode a received response.

Parameters

array

$post

POST data received.

Returns

\SimpleSAML\XML\Shib13\AuthnResponse The response decoded into an object.

Exceptions

Exception If there is no SAMLResponse parameter.

Definition at line 131 of file HTTPPost.php.

    {
        assert('is_array($post)');
 
        if (!array_key_exists('SAMLResponse', $post)) {
            throw new \Exception('Missing required SAMLResponse parameter.');
        }
        $rawResponse = $post['SAMLResponse'];
        $samlResponseXML = base64_decode($rawResponse);
 
        XML::debugSAMLMessage($samlResponseXML, 'in');
 
        XML::checkSAMLMessage($samlResponseXML, 'saml11');
 
        $samlResponse = new AuthnResponse();
        $samlResponse->setXML($samlResponseXML);
 
        if (array_key_exists('TARGET', $post)) {
            $samlResponse->setRelayState($post['TARGET']);
        }
 
        return $samlResponse;
    }

References $post, SimpleSAML\Utils\XML\checkSAMLMessage(), and SimpleSAML\Utils\XML\debugSAMLMessage().

Here is the call graph for this function:

sendResponse()

SimpleSAML\Bindings\Shib13\HTTPPost::sendResponse	(		$response,
		\SimpleSAML_Configuration	$idpmd,
		\SimpleSAML_Configuration	$spmd,
			$relayState,
			$shire
	)

Send an authenticationResponse using HTTP-POST.

Parameters

string	$response	The response which should be sent.
\SimpleSAML_Configuration	$idpmd	The metadata of the IdP which is sending the response.
\SimpleSAML_Configuration	$spmd	The metadata of the SP which is receiving the response.
string | null	$relayState	The relaystate for the SP.
string	$shire	The shire which should receive the response.

Definition at line 58 of file HTTPPost.php.

      {
        XML::checkSAMLMessage($response, 'saml11');
 
        $privatekey = Crypto::loadPrivateKey($idpmd, true);
        $publickey = Crypto::loadPublicKey($idpmd, true);
 
        $responsedom = DOMDocumentFactory::fromString(str_replace("\r", "", $response));
 
        $responseroot = $responsedom->getElementsByTagName('Response')->item(0);
        $firstassertionroot = $responsedom->getElementsByTagName('Assertion')->item(0);
 
        /* Determine what we should sign - either the Response element or the Assertion. The default is to sign the
         * Assertion, but that can be overridden by the 'signresponse' option in the SP metadata or
         * 'saml20.signresponse' in the global configuration.
         *
         * TODO: neither 'signresponse' nor 'shib13.signresponse' are valid options any longer. Remove!
         */
        if ($spmd->hasValue('signresponse')) {
            $signResponse = $spmd->getBoolean('signresponse');
        } else {
            $signResponse = $this->configuration->getBoolean('shib13.signresponse', true);
        }
 
        // check if we have an assertion to sign. Force to sign the response if not
        if ($firstassertionroot === null) {
            $signResponse = true;
        }
 
        $signer = new Signer(array(
            'privatekey_array' => $privatekey,
            'publickey_array'  => $publickey,
            'id'               => ($signResponse ? 'ResponseID' : 'AssertionID'),
        ));
 
        if ($idpmd->hasValue('certificatechain')) {
            $signer->addCertificate($idpmd->getString('certificatechain'));
        }
 
        if ($signResponse) {
            // sign the response - this must be done after encrypting the assertion
            // we insert the signature before the saml2p:Status element
            $statusElements = XML::getDOMChildren($responseroot, 'Status', '@saml1p');
            assert('count($statusElements) === 1');
            $signer->sign($responseroot, $responseroot, $statusElements[0]);
        } else {
            // Sign the assertion
            $signer->sign($firstassertionroot, $firstassertionroot);
        }
 
        $response = $responsedom->saveXML();
 
        XML::debugSAMLMessage($response, 'out');
 
        HTTP::submitPOSTData($shire, array(
            'TARGET'       => $relayState,
            'SAMLResponse' => base64_encode($response),
        ));
    }

References $idpmd, $relayState, $response, $spmd, SimpleSAML\Utils\XML\checkSAMLMessage(), SimpleSAML\Utils\XML\debugSAMLMessage(), SAML2\DOMDocumentFactory\fromString(), SimpleSAML\Utils\Crypto\loadPrivateKey(), SimpleSAML\Utils\Crypto\loadPublicKey(), and SimpleSAML\Utils\HTTP\submitPOSTData().

Here is the call graph for this function:

Field Documentation

$configuration

SimpleSAML\Bindings\Shib13\HTTPPost::$configuration = null

private

Definition at line 26 of file HTTPPost.php.

Referenced by SimpleSAML\Bindings\Shib13\HTTPPost\__construct().

$metadata

SimpleSAML\Bindings\Shib13\HTTPPost::$metadata = null

private

Definition at line 31 of file HTTPPost.php.

---

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

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