SAML2\AuthnRequest Class Reference

Inheritance diagram for SAML2\AuthnRequest:

Collaboration diagram for SAML2\AuthnRequest:

Public Member Functions
	__construct (\DOMElement $xml=null)
	Constructor for SAML 2 authentication request messages. More...
	getNameIdPolicy ()
	Retrieve the NameIdPolicy. More...
	setNameIdPolicy (array $nameIdPolicy)
	Set the NameIDPolicy. More...
	getForceAuthn ()
	Retrieve the value of the ForceAuthn attribute. More...
	setForceAuthn ($forceAuthn)
	Set the value of the ForceAuthn attribute. More...
	getProviderName ()
	Retrieve the value of the ProviderName attribute. More...
	setProviderName ($ProviderName)
	Set the value of the ProviderName attribute. More...
	getIsPassive ()
	Retrieve the value of the IsPassive attribute. More...
	setIsPassive ($isPassive)
	Set the value of the IsPassive attribute. More...
	setIDPList (array $IDPList)
	This function sets the scoping for the request. More...
	getIDPList ()
	This function retrieves the list of providerIDs from this authentication request. More...
	setProxyCount ($ProxyCount)
	getProxyCount ()
	setRequesterID (array $RequesterID)
	getRequesterID ()
	getAssertionConsumerServiceURL ()
	Retrieve the value of the AssertionConsumerServiceURL attribute. More...
	setAssertionConsumerServiceURL ($assertionConsumerServiceURL)
	Set the value of the AssertionConsumerServiceURL attribute. More...
	getProtocolBinding ()
	Retrieve the value of the ProtocolBinding attribute. More...
	setProtocolBinding ($protocolBinding)
	Set the value of the ProtocolBinding attribute. More...
	getAttributeConsumingServiceIndex ()
	Retrieve the value of the AttributeConsumingServiceIndex attribute. More...
	setAttributeConsumingServiceIndex ($attributeConsumingServiceIndex)
	Set the value of the AttributeConsumingServiceIndex attribute. More...
	getAssertionConsumerServiceIndex ()
	Retrieve the value of the AssertionConsumerServiceIndex attribute. More...
	setAssertionConsumerServiceIndex ($assertionConsumerServiceIndex)
	Set the value of the AssertionConsumerServiceIndex attribute. More...
	getRequestedAuthnContext ()
	Retrieve the RequestedAuthnContext. More...
	setRequestedAuthnContext ($requestedAuthnContext)
	Set the RequestedAuthnContext. More...
	getNameId ()
	Retrieve the NameId of the subject in the assertion. More...
	setNameId ($nameId)
	Set the NameId of the subject in the assertion. More...
	encryptNameId (XMLSecurityKey $key)
	Encrypt the NameID in the AuthnRequest. More...
	decryptNameId (XMLSecurityKey $key, array $blacklist=array())
	Decrypt the NameId of the subject in the assertion. More...
	getSubjectConfirmation ()
	Retrieve the SubjectConfirmation elements we have in our Subject element. More...
	setSubjectConfirmation (array $subjectConfirmation)
	Set the SubjectConfirmation elements that should be included in the assertion. More...
	toUnsignedXML ()
	Convert this authentication request to an XML element. More...
Public Member Functions inherited from SAML2\Message
	addValidator ($function, $data)
	Add a method for validating this message. More...
	validate (XMLSecurityKey $key)
	Validate this message against a public key. More...
	getId ()
	Retrieve the identifier of this message. More...
	setId ($id)
	Set the identifier of this message. More...
	getIssueInstant ()
	Retrieve the issue timestamp of this message. More...
	setIssueInstant ($issueInstant)
	Set the issue timestamp of this message. More...
	getDestination ()
	Retrieve the destination of this message. More...
	setDestination ($destination)
	Set the destination of this message. More...
	setConsent ($consent)
	Set the given consent for this message. More...
	getConsent ()
	Set the given consent for this message. More...
	getIssuer ()
	Retrieve the issuer if this message. More...
	setIssuer ($issuer)
	Set the issuer of this message. More...
	isMessageConstructedWithSignature ()
	Query whether or not the message contained a signature at the root level when the object was constructed. More...
	getRelayState ()
	Retrieve the RelayState associated with this message. More...
	setRelayState ($relayState)
	Set the RelayState associated with this message. More...
	toUnsignedXML ()
	Convert this message to an unsigned XML document. More...
	toSignedXML ()
	Convert this message to a signed XML document. More...
	getSignatureKey ()
	Retrieve the private key we should use to sign the message. More...
	setSignatureKey (XMLSecurityKey $signatureKey=null)
	Set the private key we should use to sign the message. More...
	setCertificates (array $certificates)
	Set the certificates that should be included in the message. More...
	getCertificates ()
	Retrieve the certificates that are included in the message. More...
	getExtensions ()
	Retrieve the Extensions. More...
	setExtensions ($extensions)
	Set the Extensions. More...
	getSignatureMethod ()

Protected Member Functions
	parseNameIdPolicy (\DOMElement $xml)
	parseRequestedAuthnContext (\DOMElement $xml)
	parseScoping (\DOMElement $xml)
Protected Member Functions inherited from SAML2\Message
	__construct ($tagName, \DOMElement $xml=null)
	Initialize a message. More...

Private Member Functions
	parseSubject (\DOMElement $xml)
	addSubject (\DOMElement $root)
	Add a Subject-node to the assertion. More...

Private Attributes
	$nameIdPolicy
	$forceAuthn
	$ProviderName
	$isPassive
	$IDPList = array()
	$ProxyCount = null
	$RequesterID = array()
	$assertionConsumerServiceURL
	$protocolBinding
	$attributeConsumingServiceIndex
	$assertionConsumerServiceIndex
	$requestedAuthnContext
	$subjectConfirmation = array()
	$encryptedNameId
	$nameId

Additional Inherited Members
Static Public Member Functions inherited from SAML2\Message
static	fromXML (\DOMElement $xml)
	Convert an XML element into a message. More...
Protected Attributes inherited from SAML2\Message
	$extensions
	$document
	$messageContainedSignatureUponConstruction = false

Detailed Description

Definition at line 15 of file AuthnRequest.php.

Constructor & Destructor Documentation

__construct()

SAML2\AuthnRequest::__construct

(

\DOMElement

$xml = null

)

Constructor for SAML 2 authentication request messages.

Parameters

\DOMElement | null

$xml

The input message.

Exceptions

Definition at line 132 of file AuthnRequest.php.

References $xml.

    {
        parent::__construct('AuthnRequest', $xml);

        $this->nameIdPolicy = array();
        $this->forceAuthn = false;
        $this->isPassive = false;

        if ($xml === null) {
            return;
        }

        $this->forceAuthn = Utils::parseBoolean($xml, 'ForceAuthn', false);
        $this->isPassive = Utils::parseBoolean($xml, 'IsPassive', false);

        if ($xml->hasAttribute('AssertionConsumerServiceURL')) {
            $this->assertionConsumerServiceURL = $xml->getAttribute('AssertionConsumerServiceURL');
        }

        if ($xml->hasAttribute('ProtocolBinding')) {
            $this->protocolBinding = $xml->getAttribute('ProtocolBinding');
        }

        if ($xml->hasAttribute('AttributeConsumingServiceIndex')) {
            $this->attributeConsumingServiceIndex = (int) $xml->getAttribute('AttributeConsumingServiceIndex');
        }

        if ($xml->hasAttribute('AssertionConsumerServiceIndex')) {
            $this->assertionConsumerServiceIndex = (int) $xml->getAttribute('AssertionConsumerServiceIndex');
        }

        if ($xml->hasAttribute('ProviderName')) {
            $this->ProviderName = $xml->getAttribute('ProviderName');
        }

        $this->parseSubject($xml);
        $this->parseNameIdPolicy($xml);
        $this->parseRequestedAuthnContext($xml);
        $this->parseScoping($xml);
    }

Member Function Documentation

addSubject()

SAML2\AuthnRequest::addSubject ( \DOMElement  $root )

private

Add a Subject-node to the assertion.

Parameters

\DOMElement

$root

The assertion element we should add the subject to.

Definition at line 787 of file AuthnRequest.php.

References $sc.

    {
        // If there is no nameId (encrypted or not) there is nothing to create a subject for
        if ($this->nameId === null && $this->encryptedNameId === null) {
            return;
        }

        $subject = $root->ownerDocument->createElementNS(Constants::NS_SAML, 'saml:Subject');
        $root->appendChild($subject);

        if ($this->encryptedNameId === null) {
            $this->nameId->toXML($subject);
        } else {
            $eid = $subject->ownerDocument->createElementNS(Constants::NS_SAML, 'saml:EncryptedID');
            $eid->appendChild($subject->ownerDocument->importNode($this->encryptedNameId, true));
            $subject->appendChild($eid);
        }

        foreach ($this->subjectConfirmation as $sc) {
            $sc->toXML($subject);
        }
    }

decryptNameId()

SAML2\AuthnRequest::decryptNameId	(	XMLSecurityKey	$key,
		array	$blacklist = array()
	)

Decrypt the NameId of the subject in the assertion.

Parameters

XMLSecurityKey	$key	The decryption key.
array	$blacklist	Blacklisted decryption algorithms.

Definition at line 649 of file AuthnRequest.php.

References $nameId.

    {
        if ($this->encryptedNameId === null) {
            /* No NameID to decrypt. */
            return;
        }

        $nameId = Utils::decryptElement($this->encryptedNameId, $key, $blacklist);
        Utils::getContainer()->debugMessage($nameId, 'decrypt');
        $this->nameId = new XML\saml\NameID($nameId);

        $this->encryptedNameId = null;
    }

encryptNameId()

SAML2\AuthnRequest::encryptNameId

(

XMLSecurityKey

$key

)

Encrypt the NameID in the AuthnRequest.

Parameters

XMLSecurityKey

$key

The encryption key.

Definition at line 617 of file AuthnRequest.php.

References $nameId, and $root.

    {
        /* First create a XML representation of the NameID. */
        $doc  = new \DOMDocument();
        $root = $doc->createElement('root');
        $doc->appendChild($root);
        $this->nameId->toXML($root);
        $nameId = $root->firstChild;

        Utils::getContainer()->debugMessage($nameId, 'encrypt');

        /* Encrypt the NameID. */
        $enc = new XMLSecEnc();
        $enc->setNode($nameId);
        // @codingStandardsIgnoreStart
        $enc->type = XMLSecEnc::Element;
        // @codingStandardsIgnoreEnd

        $symmetricKey = new XMLSecurityKey(XMLSecurityKey::AES128_CBC);
        $symmetricKey->generateSessionKey();
        $enc->encryptKey($key, $symmetricKey);

        $this->encryptedNameId = $enc->encryptNode($symmetricKey);
        $this->nameId          = null;
    }

getAssertionConsumerServiceIndex()

SAML2\AuthnRequest::getAssertionConsumerServiceIndex

(

)

Retrieve the value of the AssertionConsumerServiceIndex attribute.

Returns

int|null The AssertionConsumerServiceIndex attribute.

Definition at line 543 of file AuthnRequest.php.

    {
        return $this->assertionConsumerServiceIndex;
    }

getAssertionConsumerServiceURL()

SAML2\AuthnRequest::getAssertionConsumerServiceURL

(

)

Retrieve the value of the AssertionConsumerServiceURL attribute.

Returns

string|null The AssertionConsumerServiceURL attribute.

Definition at line 477 of file AuthnRequest.php.

    {
        return $this->assertionConsumerServiceURL;
    }

getAttributeConsumingServiceIndex()

SAML2\AuthnRequest::getAttributeConsumingServiceIndex

(

)

Retrieve the value of the AttributeConsumingServiceIndex attribute.

Returns

int|null The AttributeConsumingServiceIndex attribute.

Definition at line 521 of file AuthnRequest.php.

    {
        return $this->attributeConsumingServiceIndex;
    }

getForceAuthn()

SAML2\AuthnRequest::getForceAuthn

(

)

Retrieve the value of the ForceAuthn attribute.

Returns

bool The ForceAuthn attribute.

Definition at line 341 of file AuthnRequest.php.

    {
        return $this->forceAuthn;
    }

getIDPList()

SAML2\AuthnRequest::getIDPList

(

)

This function retrieves the list of providerIDs from this authentication request.

Currently we only support a list of ipd ientity id's.

Returns

array List of idp EntityIDs from the request

Definition at line 434 of file AuthnRequest.php.

    {
        return $this->IDPList;
    }

getIsPassive()

SAML2\AuthnRequest::getIsPassive

(

)

Retrieve the value of the IsPassive attribute.

Returns

bool The IsPassive attribute.

Definition at line 389 of file AuthnRequest.php.

    {
        return $this->isPassive;
    }

getNameId()

SAML2\AuthnRequest::getNameId

(

)

Retrieve the NameId of the subject in the assertion.

Returns

|null The name identifier of the assertion.

Exceptions

Definition at line 588 of file AuthnRequest.php.

References $nameId.

    {
        if ($this->encryptedNameId !== null) {
            throw new \Exception('Attempted to retrieve encrypted NameID without decrypting it first.');
        }

        return $this->nameId;
    }

getNameIdPolicy()

SAML2\AuthnRequest::getNameIdPolicy

(

)

Retrieve the NameIdPolicy.

See also

::setNameIdPolicy()

Returns

array The NameIdPolicy.

Definition at line 304 of file AuthnRequest.php.

    {
        return $this->nameIdPolicy;
    }

getProtocolBinding()

SAML2\AuthnRequest::getProtocolBinding

(

)

Retrieve the value of the ProtocolBinding attribute.

Returns

string|null The ProtocolBinding attribute.

Definition at line 499 of file AuthnRequest.php.

    {
        return $this->protocolBinding;
    }

getProviderName()

SAML2\AuthnRequest::getProviderName

(

)

Retrieve the value of the ProviderName attribute.

Returns

string The ProviderName attribute.

Definition at line 365 of file AuthnRequest.php.

    {
        return $this->ProviderName;
    }

getProxyCount()

SAML2\AuthnRequest::getProxyCount

(

)

Returns

int|null

Definition at line 451 of file AuthnRequest.php.

    {
        return $this->ProxyCount;
    }

getRequestedAuthnContext()

SAML2\AuthnRequest::getRequestedAuthnContext

(

)

Retrieve the RequestedAuthnContext.

Returns

array|null The RequestedAuthnContext.

Definition at line 565 of file AuthnRequest.php.

    {
        return $this->requestedAuthnContext;
    }

getRequesterID()

SAML2\AuthnRequest::getRequesterID

(

)

Returns

array

Definition at line 467 of file AuthnRequest.php.

    {
        return $this->RequesterID;
    }

getSubjectConfirmation()

SAML2\AuthnRequest::getSubjectConfirmation

(

)

Retrieve the SubjectConfirmation elements we have in our Subject element.

Returns

[]

Definition at line 668 of file AuthnRequest.php.

    {
        return $this->subjectConfirmation;
    }

parseNameIdPolicy()

SAML2\AuthnRequest::parseNameIdPolicy ( \DOMElement  $xml )

protected

Parameters

\DOMElement

$xml

Exceptions

Definition at line 218 of file AuthnRequest.php.

    {
        $nameIdPolicy = Utils::xpQuery($xml, './saml_protocol:NameIDPolicy');
        if (empty($nameIdPolicy)) {
            return;
        }

        $nameIdPolicy = $nameIdPolicy[0];
        if ($nameIdPolicy->hasAttribute('Format')) {
            $this->nameIdPolicy['Format'] = $nameIdPolicy->getAttribute('Format');
        }
        if ($nameIdPolicy->hasAttribute('SPNameQualifier')) {
            $this->nameIdPolicy['SPNameQualifier'] = $nameIdPolicy->getAttribute('SPNameQualifier');
        }
        if ($nameIdPolicy->hasAttribute('AllowCreate')) {
            $this->nameIdPolicy['AllowCreate'] = Utils::parseBoolean($nameIdPolicy, 'AllowCreate', false);
        }
    }

parseRequestedAuthnContext()

SAML2\AuthnRequest::parseRequestedAuthnContext ( \DOMElement  $xml )

protected

Parameters

\DOMElement

$xml

Definition at line 240 of file AuthnRequest.php.

References $i.

    {
        $requestedAuthnContext = Utils::xpQuery($xml, './saml_protocol:RequestedAuthnContext');
        if (empty($requestedAuthnContext)) {
            return;
        }

        $requestedAuthnContext = $requestedAuthnContext[0];

        $rac = array(
            'AuthnContextClassRef' => array(),
            'Comparison'           => Constants::COMPARISON_EXACT,
        );

        $accr = Utils::xpQuery($requestedAuthnContext, './saml_assertion:AuthnContextClassRef');
        foreach ($accr as $i) {
            $rac['AuthnContextClassRef'][] = trim($i->textContent);
        }

        if ($requestedAuthnContext->hasAttribute('Comparison')) {
            $rac['Comparison'] = $requestedAuthnContext->getAttribute('Comparison');
        }

        $this->requestedAuthnContext = $rac;
    }

parseScoping()

SAML2\AuthnRequest::parseScoping ( \DOMElement  $xml )

protected

Parameters

\DOMElement

$xml

Exceptions

Definition at line 271 of file AuthnRequest.php.

    {
        $scoping = Utils::xpQuery($xml, './saml_protocol:Scoping');
        if (empty($scoping)) {
            return;
        }

        $scoping = $scoping[0];

        if ($scoping->hasAttribute('ProxyCount')) {
            $this->ProxyCount = (int) $scoping->getAttribute('ProxyCount');
        }
        $idpEntries = Utils::xpQuery($scoping, './saml_protocol:IDPList/saml_protocol:IDPEntry');

        foreach ($idpEntries as $idpEntry) {
            if (!$idpEntry->hasAttribute('ProviderID')) {
                throw new \Exception("Could not get ProviderID from Scoping/IDPEntry element in AuthnRequest object");
            }
            $this->IDPList[] = $idpEntry->getAttribute('ProviderID');
        }

        $requesterIDs = Utils::xpQuery($scoping, './saml_protocol:RequesterID');
        foreach ($requesterIDs as $requesterID) {
            $this->RequesterID[] = trim($requesterID->textContent);
        }
    }

parseSubject()

SAML2\AuthnRequest::parseSubject ( \DOMElement  $xml )

private

Parameters

$xml

Exceptions

Definition at line 178 of file AuthnRequest.php.

References $nameId, and $sc.

    {
        $subject = Utils::xpQuery($xml, './saml_assertion:Subject');
        if (empty($subject)) {
            return;
        }

        if (count($subject) > 1) {
            throw new \Exception('More than one <saml:Subject> in <saml:AuthnRequest>.');
        }
        $subject = $subject[0];

        $nameId = Utils::xpQuery(
            $subject,
            './saml_assertion:NameID | ./saml_assertion:EncryptedID/xenc:EncryptedData'
        );
        if (empty($nameId)) {
            throw new \Exception('Missing <saml:NameID> or <saml:EncryptedID> in <saml:Subject>.');
        } elseif (count($nameId) > 1) {
            throw new \Exception('More than one <saml:NameID> or <saml:EncryptedID> in <saml:Subject>.');
        }
        $nameId = $nameId[0];
        if ($nameId->localName === 'EncryptedData') {
            /* The NameID element is encrypted. */
            $this->encryptedNameId = $nameId;
        } else {
            $this->nameId = new XML\saml\NameID($nameId);
        }

        $subjectConfirmation = Utils::xpQuery($subject, './saml_assertion:SubjectConfirmation');
        foreach ($subjectConfirmation as $sc) {
            $this->subjectConfirmation[] = new SubjectConfirmation($sc);
        }
    }

setAssertionConsumerServiceIndex()

SAML2\AuthnRequest::setAssertionConsumerServiceIndex

(

$assertionConsumerServiceIndex

)

Set the value of the AssertionConsumerServiceIndex attribute.

Parameters

int | null

$assertionConsumerServiceIndex

The AssertionConsumerServiceIndex attribute.

Definition at line 553 of file AuthnRequest.php.

    {
        assert(is_int($assertionConsumerServiceIndex) || is_null($assertionConsumerServiceIndex));

        $this->assertionConsumerServiceIndex = $assertionConsumerServiceIndex;
    }

setAssertionConsumerServiceURL()

SAML2\AuthnRequest::setAssertionConsumerServiceURL

(

$assertionConsumerServiceURL

)

Set the value of the AssertionConsumerServiceURL attribute.

Parameters

string | null

$assertionConsumerServiceURL

The AssertionConsumerServiceURL attribute.

Definition at line 487 of file AuthnRequest.php.

    {
        assert(is_string($assertionConsumerServiceURL) || is_null($assertionConsumerServiceURL));

        $this->assertionConsumerServiceURL = $assertionConsumerServiceURL;
    }

setAttributeConsumingServiceIndex()

SAML2\AuthnRequest::setAttributeConsumingServiceIndex

(

$attributeConsumingServiceIndex

)

Set the value of the AttributeConsumingServiceIndex attribute.

Parameters

int | null

$attributeConsumingServiceIndex

The AttributeConsumingServiceIndex attribute.

Definition at line 531 of file AuthnRequest.php.

    {
        assert(is_int($attributeConsumingServiceIndex) || is_null($attributeConsumingServiceIndex));

        $this->attributeConsumingServiceIndex = $attributeConsumingServiceIndex;
    }

setForceAuthn()

SAML2\AuthnRequest::setForceAuthn

(

$forceAuthn

)

Set the value of the ForceAuthn attribute.

Parameters

bool

$forceAuthn

The ForceAuthn attribute.

Definition at line 352 of file AuthnRequest.php.

    {
        assert(is_bool($forceAuthn));

        $this->forceAuthn = $forceAuthn;
    }

setIDPList()

SAML2\AuthnRequest::setIDPList

(

array

$IDPList

)

This function sets the scoping for the request.

See Core 3.4.1.2 for the definition of scoping. Currently we support an IDPList of idpEntries.

Each idpEntries consists of an array, containing keys (mapped to attributes) and corresponding values. Allowed attributes: Loc, Name, ProviderID.

For backward compatibility, an idpEntries can also be a string instead of an array, where each string is mapped to the value of attribute ProviderID.

Parameters

array

List of idpEntries to scope the request to.

Definition at line 423 of file AuthnRequest.php.

    {
        $this->IDPList = $IDPList;
    }

setIsPassive()

SAML2\AuthnRequest::setIsPassive

(

$isPassive

)

Set the value of the IsPassive attribute.

Parameters

bool

$isPassive

The IsPassive attribute.

Definition at line 400 of file AuthnRequest.php.

    {
        assert(is_bool($isPassive));

        $this->isPassive = $isPassive;
    }

setNameId()

SAML2\AuthnRequest::setNameId

(

$nameId

)

Set the NameId of the subject in the assertion.

Parameters

\SAML2\XML\saml\NameID | null

$nameId

The name identifier of the assertion.

Definition at line 602 of file AuthnRequest.php.

References $nameId.

    {
        assert(is_array($nameId) || is_null($nameId) || $nameId instanceof XML\saml\NameID);

        if (is_array($nameId)) {
            $nameId = XML\saml\NameID::fromArray($nameId);
        }
        $this->nameId = $nameId;
    }

setNameIdPolicy()

SAML2\AuthnRequest::setNameIdPolicy

(

array

$nameIdPolicy

)

Set the NameIDPolicy.

This function accepts an array with the following options:

• 'Format' (string)
• 'SPNameQualifier' (string)
• 'AllowCreate' (bool)

Parameters

array

$nameIdPolicy

The NameIDPolicy.

Definition at line 320 of file AuthnRequest.php.

    {
        if (isset($nameIdPolicy['Format']) && !is_string($nameIdPolicy['Format'])) {
            throw InvalidArgumentException::invalidType('string', $nameIdPolicy['Format']);
        }
        if (isset($nameIdPolicy['SPNameQualifier']) && !is_string($nameIdPolicy['SPNameQualifier'])) {
            throw InvalidArgumentException::invalidType('string', $nameIdPolicy['SPNameQualifier']);
        }
        if (isset($nameIdPolicy['AllowCreate']) && !is_bool($nameIdPolicy['AllowCreate'])) {
            throw InvalidArgumentException::invalidType('bool', $nameIdPolicy['AllowCreate']);
        }

        $this->nameIdPolicy = $nameIdPolicy;
    }

setProtocolBinding()

SAML2\AuthnRequest::setProtocolBinding

(

$protocolBinding

)

Set the value of the ProtocolBinding attribute.

Parameters

string

$protocolBinding

The ProtocolBinding attribute.

Definition at line 509 of file AuthnRequest.php.

    {
        assert(is_string($protocolBinding) || is_null($protocolBinding));

        $this->protocolBinding = $protocolBinding;
    }

setProviderName()

SAML2\AuthnRequest::setProviderName

(

$ProviderName

)

Set the value of the ProviderName attribute.

Parameters

string

$ProviderName

The ProviderName attribute.

Definition at line 376 of file AuthnRequest.php.

    {
        assert(is_string($ProviderName));

        $this->ProviderName = $ProviderName;
    }

setProxyCount()

SAML2\AuthnRequest::setProxyCount

(

$ProxyCount

)

Parameters

int

$ProxyCount

Definition at line 442 of file AuthnRequest.php.

    {
        assert(is_int($ProxyCount));
        $this->ProxyCount = $ProxyCount;
    }

setRequestedAuthnContext()

SAML2\AuthnRequest::setRequestedAuthnContext

(

$requestedAuthnContext

)

Set the RequestedAuthnContext.

Parameters

array | null

$requestedAuthnContext

The RequestedAuthnContext.

Definition at line 575 of file AuthnRequest.php.

    {
        assert(is_array($requestedAuthnContext) || is_null($requestedAuthnContext));

        $this->requestedAuthnContext = $requestedAuthnContext;
    }

setRequesterID()

SAML2\AuthnRequest::setRequesterID

(

array

$RequesterID

)

Parameters

array

$RequesterID

Definition at line 459 of file AuthnRequest.php.

    {
        $this->RequesterID = $RequesterID;
    }

setSubjectConfirmation()

SAML2\AuthnRequest::setSubjectConfirmation

(

array

$subjectConfirmation

)

Set the SubjectConfirmation elements that should be included in the assertion.

Parameters

array

[]

Definition at line 678 of file AuthnRequest.php.

    {
        $this->subjectConfirmation = $subjectConfirmation;
    }

toUnsignedXML()

SAML2\AuthnRequest::toUnsignedXML

(

)

Convert this authentication request to an XML element.

Returns

This authentication request.

Definition at line 688 of file AuthnRequest.php.

References PHPMailer\PHPMailer\$provider, and $root.

    {
        $root = parent::toUnsignedXML();

        if ($this->forceAuthn) {
            $root->setAttribute('ForceAuthn', 'true');
        }

        if ($this->ProviderName !== null) {
            $root->setAttribute('ProviderName', $this->ProviderName);
        }

        if ($this->isPassive) {
            $root->setAttribute('IsPassive', 'true');
        }

        if ($this->assertionConsumerServiceIndex !== null) {
            $root->setAttribute('AssertionConsumerServiceIndex', $this->assertionConsumerServiceIndex);
        } else {
            if ($this->assertionConsumerServiceURL !== null) {
                $root->setAttribute('AssertionConsumerServiceURL', $this->assertionConsumerServiceURL);
            }
            if ($this->protocolBinding !== null) {
                $root->setAttribute('ProtocolBinding', $this->protocolBinding);
            }
        }

        if ($this->attributeConsumingServiceIndex !== null) {
            $root->setAttribute('AttributeConsumingServiceIndex', $this->attributeConsumingServiceIndex);
        }

        $this->addSubject($root);

        if (!empty($this->nameIdPolicy)) {
            $nameIdPolicy = $this->document->createElementNS(Constants::NS_SAMLP, 'NameIDPolicy');
            if (array_key_exists('Format', $this->nameIdPolicy)) {
                $nameIdPolicy->setAttribute('Format', $this->nameIdPolicy['Format']);
            }
            if (array_key_exists('SPNameQualifier', $this->nameIdPolicy)) {
                $nameIdPolicy->setAttribute('SPNameQualifier', $this->nameIdPolicy['SPNameQualifier']);
            }
            if (array_key_exists('AllowCreate', $this->nameIdPolicy)) {
                $nameIdPolicy->setAttribute('AllowCreate', ($this->nameIdPolicy['AllowCreate']) ? 'true' : 'false');
            }
            $root->appendChild($nameIdPolicy);
        }

        $rac = $this->requestedAuthnContext;
        if (!empty($rac) && !empty($rac['AuthnContextClassRef'])) {
            $e = $this->document->createElementNS(Constants::NS_SAMLP, 'RequestedAuthnContext');
            $root->appendChild($e);
            if (isset($rac['Comparison']) && $rac['Comparison'] !== Constants::COMPARISON_EXACT) {
                $e->setAttribute('Comparison', $rac['Comparison']);
            }
            foreach ($rac['AuthnContextClassRef'] as $accr) {
                Utils::addString($e, Constants::NS_SAML, 'AuthnContextClassRef', $accr);
            }
        }

        if ($this->ProxyCount !== null || count($this->IDPList) > 0 || count($this->RequesterID) > 0) {
            $scoping = $this->document->createElementNS(Constants::NS_SAMLP, 'Scoping');
            $root->appendChild($scoping);
            if ($this->ProxyCount !== null) {
                $scoping->setAttribute('ProxyCount', $this->ProxyCount);
            }
            if (count($this->IDPList) > 0) {
                $idplist = $this->document->createElementNS(Constants::NS_SAMLP, 'IDPList');
                foreach ($this->IDPList as $provider) {
                    $idpEntry = $this->document->createElementNS(Constants::NS_SAMLP, 'IDPEntry');
                    if (is_string($provider)) {
                        $idpEntry->setAttribute('ProviderID', $provider);
                    } elseif (is_array($provider)) {
                        foreach ($provider as $attribute => $value) {
                            if (in_array($attribute, array(
                                'ProviderID',
                                'Loc',
                                'Name'
                            ), true)) {
                                $idpEntry->setAttribute($attribute, $value);
                            }
                        }
                    }
                    $idplist->appendChild($idpEntry);
                }
                $scoping->appendChild($idplist);
            }
            if (count($this->RequesterID) > 0) {
                Utils::addStrings($scoping, Constants::NS_SAMLP, 'RequesterID', false, $this->RequesterID);
            }
        }

        return $root;
    }

Field Documentation

$assertionConsumerServiceIndex

SAML2\AuthnRequest::$assertionConsumerServiceIndex

private

Definition at line 97 of file AuthnRequest.php.

$assertionConsumerServiceURL

SAML2\AuthnRequest::$assertionConsumerServiceURL

private

Definition at line 74 of file AuthnRequest.php.

$attributeConsumingServiceIndex

SAML2\AuthnRequest::$attributeConsumingServiceIndex

private

Definition at line 90 of file AuthnRequest.php.

$encryptedNameId

SAML2\AuthnRequest::$encryptedNameId

private

Definition at line 119 of file AuthnRequest.php.

$forceAuthn

SAML2\AuthnRequest::$forceAuthn

private

Definition at line 29 of file AuthnRequest.php.

$IDPList

SAML2\AuthnRequest::$IDPList = array()

private

Definition at line 52 of file AuthnRequest.php.

$isPassive

SAML2\AuthnRequest::$isPassive

private

Definition at line 45 of file AuthnRequest.php.

$nameId

SAML2\AuthnRequest::$nameId

private

Definition at line 124 of file AuthnRequest.php.

$nameIdPolicy

SAML2\AuthnRequest::$nameIdPolicy

private

Definition at line 22 of file AuthnRequest.php.

$protocolBinding

SAML2\AuthnRequest::$protocolBinding

private

Definition at line 82 of file AuthnRequest.php.

$ProviderName

SAML2\AuthnRequest::$ProviderName

private

Definition at line 37 of file AuthnRequest.php.

$ProxyCount

SAML2\AuthnRequest::$ProxyCount = null

private

Definition at line 59 of file AuthnRequest.php.

$requestedAuthnContext

SAML2\AuthnRequest::$requestedAuthnContext

private

Definition at line 109 of file AuthnRequest.php.

$RequesterID

SAML2\AuthnRequest::$RequesterID = array()

private

Definition at line 67 of file AuthnRequest.php.

$subjectConfirmation

SAML2\AuthnRequest::$subjectConfirmation = array()

private

Definition at line 114 of file AuthnRequest.php.

---

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

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