SAML2\Binding Class Reference

Inheritance diagram for SAML2\Binding:

Collaboration diagram for SAML2\Binding:

Public Member Functions
	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...

Static Public Member Functions
static	getBinding ($urn)
	Retrieve a binding with the given URN. More...
static	getCurrentBinding ()
	Guess the current binding. More...

Protected Attributes
	$destination
	The destination of messages. More...

Detailed Description

Definition at line 10 of file Binding.php.

Member Function Documentation

getBinding()

static SAML2\Binding::getBinding (   $urn )

static

Retrieve a binding with the given URN.

Will throw an exception if it is unable to locate the binding.

Parameters

string

$urn

The URN of the binding.

Returns

\SAML2\Binding The binding.

Exceptions

Exception

Definition at line 28 of file Binding.php.

    {
        assert(is_string($urn));
 
        switch ($urn) {
            case Constants::BINDING_HTTP_POST:
                return new HTTPPost();
            case Constants::BINDING_HTTP_REDIRECT:
                return new HTTPRedirect();
            case Constants::BINDING_HTTP_ARTIFACT:
                return new HTTPArtifact();
            case Constants::BINDING_HOK_SSO:
                return new HTTPPost();
            // ECP ACS is defined with the PAOS binding, but as the IdP, we
            // talk to the ECP using SOAP -- if support for ECP as an SP is
            // implemented, this logic may need to change
            case Constants::BINDING_PAOS:
                return new SOAP();
            default:
                throw new \Exception('Unsupported binding: ' . var_export($urn, true));
        }
    }

Referenced by sspmod_saml_IdP_SAML2\handleAuthError(), sspmod_saml_IdP_SAML2\sendLogoutRequest(), sspmod_saml_IdP_SAML2\sendLogoutResponse(), sspmod_saml_IdP_SAML2\sendResponse(), sspmod_saml_Auth_Source_SP\startSLO2(), and sspmod_saml_Auth_Source_SP\startSSO2().

Here is the caller graph for this function:

getCurrentBinding()

static SAML2\Binding::getCurrentBinding ( )

static

Guess the current binding.

This function guesses the current binding and creates an instance of \SAML2\Binding matching that binding.

An exception will be thrown if it is unable to guess the binding.

Returns

\SAML2\Binding The binding.

Exceptions

Exception

Definition at line 62 of file Binding.php.

    {
        switch ($_SERVER['REQUEST_METHOD']) {
            case 'GET':
                if (array_key_exists('SAMLRequest', $_GET) || array_key_exists('SAMLResponse', $_GET)) {
                    return new HTTPRedirect();
                } elseif (array_key_exists('SAMLart', $_GET)) {
                    return new HTTPArtifact();
                }
                break;
 
            case 'POST':
                if (isset($_SERVER['CONTENT_TYPE'])) {
                    $contentType = $_SERVER['CONTENT_TYPE'];
                    $contentType = explode(';', $contentType);
                    $contentType = $contentType[0]; /* Remove charset. */
                } else {
                    $contentType = null;
                }
                if (array_key_exists('SAMLRequest', $_POST) || array_key_exists('SAMLResponse', $_POST)) {
                    return new HTTPPost();
                } elseif (array_key_exists('SAMLart', $_POST)) {
                    return new HTTPArtifact();
                } elseif ($contentType === 'text/xml') {
                    return new SOAP();
                }
                break;
        }
 
        $logger = Utils::getContainer()->getLogger();
        $logger->warning('Unable to find the SAML 2 binding used for this request.');
        $logger->warning('Request method: ' . var_export($_SERVER['REQUEST_METHOD'], true));
        if (!empty($_GET)) {
            $logger->warning("GET parameters: '" . implode("', '", array_map('addslashes', array_keys($_GET))) . "'");
        }
        if (!empty($_POST)) {
            $logger->warning("POST parameters: '" . implode("', '", array_map('addslashes', array_keys($_POST))) . "'");
        }
        if (isset($_SERVER['CONTENT_TYPE'])) {
            $logger->warning('Content-Type: ' . var_export($_SERVER['CONTENT_TYPE'], true));
        }
 
        throw new \Exception('Unable to find the current binding.');
    }

References $_GET, $_POST, $_SERVER, and $contentType.

Referenced by sspmod_saml_IdP_SAML2\receiveAuthnRequest(), and sspmod_saml_IdP_SAML2\receiveLogoutMessage().

Here is the caller graph for this function:

getDestination()

SAML2\Binding::getDestination

(

)

Retrieve the destination of a message.

Returns

string|null $destination The destination the message will be delivered to.

Definition at line 112 of file Binding.php.

    {
        return $this->destination;
    }

References $destination.

receive()

SAML2\Binding::receive ( )

abstract

Receive a SAML 2 message.

This function will extract the message from the current request. An exception will be thrown if we are unable to process the message.

Returns

\SAML2\Message The received message.

Reimplemented in SAML2\HTTPPost, SAML2\HTTPRedirect, and SAML2\SOAP.

send()

SAML2\Binding::send ( Message  $message )

abstract

Send a SAML 2 message.

This function will send a message using the specified binding. The message will be delivered to the destination set in the message.

Parameters

\SAML2\Message

$message

The message which should be sent.

Reimplemented in SAML2\HTTPArtifact, SAML2\HTTPPost, SAML2\HTTPRedirect, and SAML2\SOAP.

setDestination()

SAML2\Binding::setDestination

(

$destination

)

Override the destination of a message.

Set to null to use the destination set in the message.

Parameters

string | null

$destination

The destination the message should be delivered to.

Definition at line 124 of file Binding.php.

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

References $destination.

Field Documentation

$destination

SAML2\Binding::$destination

protected

The destination of messages.

This can be null, in which case the destination in the message is used.

Definition at line 17 of file Binding.php.

---

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

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