AuthnRequest::toXML() - Code Metrics - Inspection of "Rewrite signed elements" - simplesamlphp/saml2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#280)

by Tim

created 2021-07-25 22:40 UTC

AuthnRequest::toXML() F

↳ Parent: AuthnRequest

Complexity

Conditions	16
Paths	8640

Size

Total Lines	58
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	16
eloc	30
nc	8640
nop	1
dl	0
loc	58
rs	1.4
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\samlp;

use DOMElement;
use SimpleSAML\Assert\Assert;
use SimpleSAML\SAML2\Exception\InvalidArgumentException;
use SimpleSAML\SAML2\Exception\ProtocolViolationException;
use SimpleSAML\SAML2\XML\saml\Conditions;
use SimpleSAML\SAML2\XML\saml\Issuer;
use SimpleSAML\SAML2\XML\saml\Subject;
use SimpleSAML\SAML2\XML\saml\SubjectConfirmation;
use SimpleSAML\XML\Exception\InvalidDOMElementException;
use SimpleSAML\XML\Exception\TooManyElementsException;
use SimpleSAML\XML\Utils as XMLUtils;
use SimpleSAML\XMLSecurity\XML\ds\Signature;

use function array_pop;
use function filter_var;
use function is_null;
use function strval;

/**
 * Class for SAML 2 authentication request messages.
 *
 * @package simplesamlphp/saml2
 */
class AuthnRequest extends AbstractRequest
{
    /**
     * @var \SimpleSAML\SAML2\XML\saml\Subject|null
     */
    protected ?Subject $subject = null;

    /**
     * @var \SimpleSAML\SAML2\XML\samlp\Scoping|null
     */
    protected ?Scoping $scoping = null;

    /**
     * The options for what type of name identifier should be returned.
     *
     * @var \SimpleSAML\SAML2\XML\samlp\NameIDPolicy|null
     */
    protected ?NameIDPolicy $nameIdPolicy = null;

    /**
     * Whether the Identity Provider must authenticate the user again.
     *
     * @var bool|null
     */
    protected ?bool $forceAuthn = false;

    /**
     * Optional ProviderID attribute
     *
     * @var string|null
     */
    protected ?string $ProviderName = null;

    /**
     * Set to true if this request is passive.
     *
     * @var bool|null
     */
    protected ?bool $isPassive = false;

    /**
     * The URL of the assertion consumer service where the response should be delivered.
     *
     * @var string|null
     */
    protected ?string $assertionConsumerServiceURL;

    /**
     * What binding should be used when sending the response.
     *
     * @var string|null
     */
    protected ?string $protocolBinding;

    /**
     * The index of the AttributeConsumingService.
     *
     * @var int|null
     */
    protected ?int $attributeConsumingServiceIndex;

    /**
     * The index of the AssertionConsumerService.
     *
     * @var int|null
     */
    protected ?int $assertionConsumerServiceIndex = null;

    /**
     * What authentication context was requested.
     *
     * @var \SimpleSAML\SAML2\XML\samlp\RequestedAuthnContext|null
     */
    protected ?RequestedAuthnContext $requestedAuthnContext;

    /**
     * @var \SimpleSAML\SAML2\XML\saml\Conditions|null
     */
    protected ?Conditions $conditions = null;


    /**
     * Constructor for SAML 2 AuthnRequest
     *
     * @param \SimpleSAML\SAML2\XML\samlp\RequestedAuthnContext $requestedAuthnContext
     * @param \SimpleSAML\SAML2\XML\saml\Subject $subject
     * @param \SimpleSAML\SAML2\XML\samlp\NameIDPolicy $nameIdPolicy
     * @param \SimpleSAML\SAML2\XML\saml\Conditions $conditions
     * @param bool $forceAuthn
     * @param bool $isPassive
     * @param string|null $assertionConsumerServiceUrl
     * @param int|null $assertionConsumerServiceIndex
     * @param string|null $protocolBinding
     * @param int|null $attributeConsumingServiceIndex
     * @param string|null $providerName
     * @param \SimpleSAML\SAML2\XML\saml\Issuer|null $issuer
     * @param string|null $id
     * @param int|null $issueInstant
     * @param string|null $destination
     * @param string|null $consent
     * @param \SimpleSAML\SAML2\XML\samlp\Extensions|null $extensions
     * @param \SimpleSAML\SAML2\XML\samlp\Scoping|null $scoping
     * @throws \Exception
     */
    public function __construct(
        ?RequestedAuthnContext $requestedAuthnContext = null,
        ?Subject $subject = null,
        ?NameIDPolicy $nameIdPolicy = null,
        Conditions $conditions = null,
        ?bool $forceAuthn = null,
        ?bool $isPassive = null,
        ?string $assertionConsumerServiceUrl = null,
        ?int $assertionConsumerServiceIndex = null,
        ?string $protocolBinding = null,
        ?int $attributeConsumingServiceIndex = null,
        ?string $providerName = null,
        ?Issuer $issuer = null,
        ?string $id = null,
        ?int $issueInstant = null,
        ?string $destination = null,
        ?string $consent = null,
        ?Extensions $extensions = null,
        ?Scoping $scoping = null
    ) {
        parent::__construct($issuer, $id, $issueInstant, $destination, $consent, $extensions);

        $this->setRequestedAuthnContext($requestedAuthnContext);
        $this->setSubject($subject);
        $this->setNameIdPolicy($nameIdPolicy);
        $this->setConditions($conditions);

        $this->setForceAuthn($forceAuthn);
        $this->setIsPassive($isPassive);
        $this->setAssertionConsumerServiceUrl($assertionConsumerServiceUrl);
        $this->setAssertionConsumerServiceIndex($assertionConsumerServiceIndex);
        $this->setProtocolBinding($protocolBinding);
        $this->setAttributeConsumingServiceIndex($attributeConsumingServiceIndex);
        $this->setProviderName($providerName);
        $this->setScoping($scoping);
    }


    /**
     * @param \SimpleSAML\SAML2\XML\saml\Subject|null $subject
     */
    private function setSubject(?Subject $subject): void
    {
        $this->subject = $subject;
    }


    /**
     * @return \SimpleSAML\SAML2\XML\saml\Subject|null
     */
    public function getSubject(): ?Subject
    {
        return $this->subject;
    }


    /**
     * @param \SimpleSAML\SAML2\XML\samlp\Scoping|null $scoping
     */
    private function setScoping(?Scoping $scoping): void
    {
        $this->scoping = $scoping;
    }


    /**
     * @return \SimpleSAML\SAML2\XML\samlp\Scoping|null
     */
    public function getScoping(): ?Scoping
    {
        return $this->scoping;
    }


    /**
     * @param \SimpleSAML\SAML2\XML\saml\Conditions|null $conditions
     */
    private function setConditions(?Conditions $conditions): void
    {
        $this->conditions = $conditions;
    }


    /**
     * @return \SimpleSAML\SAML2\XML\saml\Conditions|null
     */
    public function getConditions(): ?Conditions
    {
        return $this->conditions;
    }


    /**
     * Retrieve the NameIdPolicy.
     *
     * @see \SimpleSAML\SAML2\AuthnRequest::setNameIdPolicy()
     * @return \SimpleSAML\SAML2\XML\samlp\NameIDPolicy|null The NameIdPolicy.
     */
    public function getNameIdPolicy(): ?NameIDPolicy
    {
        return $this->nameIdPolicy;
    }


    /**
     * Set the NameIDPolicy.
     *
     * @param \SimpleSAML\SAML2\XML\samlp\NameIDPolicy|null $nameIdPolicy The NameIDPolicy.
     */
    private function setNameIdPolicy(?NameIDPolicy $nameIdPolicy): void
    {
        $this->nameIdPolicy = $nameIdPolicy;
    }


    /**
     * Retrieve the value of the ForceAuthn attribute.
     *
     * @return bool|null The ForceAuthn attribute.
     */
    public function getForceAuthn(): ?bool
    {
        return $this->forceAuthn;
    }


    /**
     * Set the value of the ForceAuthn attribute.
     *
     * @param bool $forceAuthn The ForceAuthn attribute.
     */
    private function setForceAuthn(?bool $forceAuthn): void
    {
        $this->forceAuthn = $forceAuthn;
    }


    /**
     * Retrieve the value of the ProviderName attribute.
     *
     * @return string|null The ProviderName attribute.
     */
    public function getProviderName(): ?string
    {
        return $this->ProviderName;
    }


    /**
     * Set the value of the ProviderName attribute.
     *
     * @param string|null $ProviderName The ProviderName attribute.
     */
    private function setProviderName(?string $ProviderName): void
    {
        Assert::nullOrNotWhitespaceOnly($ProviderName);
        $this->ProviderName = $ProviderName;
    }


    /**
     * Retrieve the value of the IsPassive attribute.
     *
     * @return bool|null The IsPassive attribute.
     */
    public function getIsPassive(): ?bool
    {
        return $this->isPassive;
    }


    /**
     * Set the value of the IsPassive attribute.
     *
     * @param bool|null $isPassive The IsPassive attribute.
     */
    private function setIsPassive(?bool $isPassive): void
    {
        $this->isPassive = $isPassive;
    }


    /**
     * Retrieve the value of the AssertionConsumerServiceURL attribute.
     *
     * @return string|null The AssertionConsumerServiceURL attribute.
     */
    public function getAssertionConsumerServiceURL(): ?string
    {
        return $this->assertionConsumerServiceURL;
    }


    /**
     * Set the value of the AssertionConsumerServiceURL attribute.
     *
     * @param string|null $assertionConsumerServiceURL The AssertionConsumerServiceURL attribute.
     */
    private function setAssertionConsumerServiceURL(string $assertionConsumerServiceURL = null): void
    {
        if (!is_null($assertionConsumerServiceURL) && !filter_var($assertionConsumerServiceURL, FILTER_VALIDATE_URL)) {
            throw new InvalidArgumentException('AuthnRequest AssertionConsumerServiceURL is not a valid URL.');
        }

        $this->assertionConsumerServiceURL = $assertionConsumerServiceURL;
    }


    /**
     * Retrieve the value of the ProtocolBinding attribute.
     *
     * @return string|null The ProtocolBinding attribute.
     */
    public function getProtocolBinding(): ?string
    {
        return $this->protocolBinding;
    }


    /**
     * Set the value of the ProtocolBinding attribute.
     *
     * @param string|null $protocolBinding The ProtocolBinding attribute.
     */
    private function setProtocolBinding(?string $protocolBinding): void
    {
        Assert::nullOrNotWhitespaceOnly($protocolBinding);

        $this->protocolBinding = $protocolBinding;
    }


    /**
     * Retrieve the value of the AttributeConsumingServiceIndex attribute.
     *
     * @return int|null The AttributeConsumingServiceIndex attribute.
     */
    public function getAttributeConsumingServiceIndex(): ?int
    {
        return $this->attributeConsumingServiceIndex;
    }


    /**
     * Set the value of the AttributeConsumingServiceIndex attribute.
     *
     * @param int|null $attributeConsumingServiceIndex The AttributeConsumingServiceIndex attribute.
     */
    private function setAttributeConsumingServiceIndex(?int $attributeConsumingServiceIndex): void
    {
        Assert::nullOrRange($attributeConsumingServiceIndex, 0, 65535);
        $this->attributeConsumingServiceIndex = $attributeConsumingServiceIndex;
    }


    /**
     * Retrieve the value of the AssertionConsumerServiceIndex attribute.
     *
     * @return int|null The AssertionConsumerServiceIndex attribute.
     */
    public function getAssertionConsumerServiceIndex(): ?int
    {
        return $this->assertionConsumerServiceIndex;
    }


    /**
     * Set the value of the AssertionConsumerServiceIndex attribute.
     *
     * @param int|null $assertionConsumerServiceIndex The AssertionConsumerServiceIndex attribute.
     */
    private function setAssertionConsumerServiceIndex(?int $assertionConsumerServiceIndex): void
    {
        Assert::nullOrRange($assertionConsumerServiceIndex, 0, 65535);
        $this->assertionConsumerServiceIndex = $assertionConsumerServiceIndex;
    }


    /**
     * Retrieve the RequestedAuthnContext.
     *
     * @return \SimpleSAML\SAML2\XML\samlp\RequestedAuthnContext|null The RequestedAuthnContext.
     */
    public function getRequestedAuthnContext(): ?RequestedAuthnContext
    {
        return $this->requestedAuthnContext;
    }


    /**
     * Set the RequestedAuthnContext.
     *
     * @param \SimpleSAML\SAML2\XML\samlp\RequestedAuthnContext|null $requestedAuthnContext The RequestedAuthnContext.
     */
    private function setRequestedAuthnContext(RequestedAuthnContext $requestedAuthnContext = null): void
    {
        $this->requestedAuthnContext = $requestedAuthnContext;
    }


    /**
     * Convert XML into an AuthnRequest
     *
     * @param \DOMElement $xml The XML element we should load
     * @return \SimpleSAML\SAML2\XML\samlp\AuthnRequest
     *
     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException if the qualified name of the supplied element is wrong
     * @throws \SimpleSAML\XML\Exception\MissingAttributeException if the supplied element is missing one of the mandatory attributes
     * @throws \SimpleSAML\XML\Exception\TooManyElementsException if too many child-elements of a type are specified
     */
    public static function fromXML(DOMElement $xml): object
    {
        Assert::same($xml->localName, 'AuthnRequest', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, AuthnRequest::NS, InvalidDOMElementException::class);
        Assert::same('2.0', self::getAttribute($xml, 'Version'));

        $issueInstant = self::getAttribute($xml, 'IssueInstant');
        Assert::validDateTimeZulu($issueInstant, ProtocolViolationException::class);
        $issueInstant = XMLUtils::xsDateTimeToTimestamp($issueInstant);

        $attributeConsumingServiceIndex = self::getIntegerAttribute($xml, 'AttributeConsumingServiceIndex', null);
        $assertionConsumerServiceIndex = self::getIntegerAttribute($xml, 'AssertionConsumerServiceIndex', null);

        $conditions = Conditions::getChildrenOfClass($xml);
        Assert::maxCount($conditions, 1, 'Only one <saml:Conditions> element is allowed.', TooManyElementsException::class);

        $nameIdPolicy = NameIDPolicy::getChildrenOfClass($xml);
        Assert::maxCount($nameIdPolicy, 1, 'Only one <samlp:NameIDPolicy> element is allowed.', TooManyElementsException::class);

        $subject = Subject::getChildrenOfClass($xml);
        Assert::maxCount($subject, 1, 'Only one <saml:Subject> element is allowed.', TooManyElementsException::class);

        $issuer = Issuer::getChildrenOfClass($xml);
        Assert::maxCount($issuer, 1, 'Only one <saml:Issuer> element is allowed.', TooManyElementsException::class);

        $requestedAuthnContext = RequestedAuthnContext::getChildrenOfClass($xml);
        Assert::maxCount(
            $requestedAuthnContext,
            1,
            'Only one <samlp:RequestedAuthnContext> element is allowed.',
            TooManyElementsException::class
        );

        $extensions = Extensions::getChildrenOfClass($xml);
        Assert::maxCount($extensions, 1, 'Only one <samlp:Extensions> element is allowed.', TooManyElementsException::class);

        $signature = Signature::getChildrenOfClass($xml);
        Assert::maxCount($signature, 1, 'Only one <ds:Signature> element is allowed.', TooManyElementsException::class);

        $scoping = Scoping::getChildrenOfClass($xml);
        Assert::maxCount($scoping, 1, 'Only one <samlp:Scoping> element is allowed.', TooManyElementsException::class);

        $request = new self(
            array_pop($requestedAuthnContext),
            array_pop($subject),
            array_pop($nameIdPolicy),
            array_pop($conditions),
            self::getBooleanAttribute($xml, 'ForceAuthn', null),
            self::getBooleanAttribute($xml, 'IsPassive', null),
            self::getAttribute($xml, 'AssertionConsumerServiceURL', null),
            $assertionConsumerServiceIndex,
            self::getAttribute($xml, 'ProtocolBinding', null),
            $attributeConsumingServiceIndex,
            self::getAttribute($xml, 'ProviderName', null),
            array_pop($issuer),
            self::getAttribute($xml, 'ID'),
            $issueInstant,
            self::getAttribute($xml, 'Destination', null),
            self::getAttribute($xml, 'Consent', null),
            array_pop($extensions),
            array_pop($scoping)
        );

        if (!empty($signature)) {
            $request->setSignature($signature[0]);
            $request->messageContainedSignatureUponConstruction = true;
        }

        $request->setXML($xml);
        return $request;
    }


    /**
     * Convert this message to an unsigned XML document.
     * This method does not sign the resulting XML document.
     *
     * @param \DOMElement|null $parent
     * @return \DOMElement The root element of the DOM tree
     */
    protected function toUnsignedXML(?DOMElement $parent = null): DOMElement
    {
        $e = parent::toUnsignedXML($parent);

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

        if (!empty($this->ProviderName)) {
            $e->setAttribute('ProviderName', $this->ProviderName);
        }

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

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

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

        if ($this->subject !== null) {
            $this->subject->toXML($e);
        }

        if ($this->nameIdPolicy !== null) {
            if (!$this->nameIdPolicy->isEmptyElement()) {
                $this->nameIdPolicy->toXML($e);
            }
        }

        if ($this->conditions !== null) {
            if (!$this->conditions->isEmptyElement()) {
                $this->conditions->toXML($e);
            }
        }

        if (!empty($this->requestedAuthnContext)) {
            $this->requestedAuthnContext->toXML($e);
        }

        if ($this->scoping !== null) {
            if (!$this->scoping->isEmptyElement()) {
                $this->scoping->toXML($e);
            }
        }

        return $e;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\SAML2\XML\samlp;
6
7			use DOMElement;
8			use SimpleSAML\Assert\Assert;
9			use SimpleSAML\SAML2\Exception\InvalidArgumentException;
10			use SimpleSAML\SAML2\Exception\ProtocolViolationException;
11			use SimpleSAML\SAML2\XML\saml\Conditions;
12			use SimpleSAML\SAML2\XML\saml\Issuer;
13			use SimpleSAML\SAML2\XML\saml\Subject;
14			use SimpleSAML\SAML2\XML\saml\SubjectConfirmation;
15			use SimpleSAML\XML\Exception\InvalidDOMElementException;
16			use SimpleSAML\XML\Exception\TooManyElementsException;
17			use SimpleSAML\XML\Utils as XMLUtils;
18			use SimpleSAML\XMLSecurity\XML\ds\Signature;
19
20			use function array_pop;
21			use function filter_var;
22			use function is_null;
23			use function strval;
24
25			/**
26			* Class for SAML 2 authentication request messages.
27			*
28			* @package simplesamlphp/saml2
29			*/
30			class AuthnRequest extends AbstractRequest
31			{
32			/**
33			* @var \SimpleSAML\SAML2\XML\saml\Subject\|null
34			*/
35			protected ?Subject $subject = null;
36
37			/**
38			* @var \SimpleSAML\SAML2\XML\samlp\Scoping\|null
39			*/
40			protected ?Scoping $scoping = null;
41
42			/**
43			* The options for what type of name identifier should be returned.
44			*
45			* @var \SimpleSAML\SAML2\XML\samlp\NameIDPolicy\|null
46			*/
47			protected ?NameIDPolicy $nameIdPolicy = null;
48
49			/**
50			* Whether the Identity Provider must authenticate the user again.
51			*
52			* @var bool\|null
53			*/
54			protected ?bool $forceAuthn = false;
55
56			/**
57			* Optional ProviderID attribute
58			*
59			* @var string\|null
60			*/
61			protected ?string $ProviderName = null;
62
63			/**
64			* Set to true if this request is passive.
65			*
66			* @var bool\|null
67			*/
68			protected ?bool $isPassive = false;
69
70			/**
71			* The URL of the assertion consumer service where the response should be delivered.
72			*
73			* @var string\|null
74			*/
75			protected ?string $assertionConsumerServiceURL;
76
77			/**
78			* What binding should be used when sending the response.
79			*
80			* @var string\|null
81			*/
82			protected ?string $protocolBinding;
83
84			/**
85			* The index of the AttributeConsumingService.
86			*
87			* @var int\|null
88			*/
89			protected ?int $attributeConsumingServiceIndex;
90
91			/**
92			* The index of the AssertionConsumerService.
93			*
94			* @var int\|null
95			*/
96			protected ?int $assertionConsumerServiceIndex = null;
97
98			/**
99			* What authentication context was requested.
100			*
101			* @var \SimpleSAML\SAML2\XML\samlp\RequestedAuthnContext\|null
102			*/
103			protected ?RequestedAuthnContext $requestedAuthnContext;
104
105			/**
106			* @var \SimpleSAML\SAML2\XML\saml\Conditions\|null
107			*/
108			protected ?Conditions $conditions = null;
109
110
111			/**
112			* Constructor for SAML 2 AuthnRequest
113			*
114			* @param \SimpleSAML\SAML2\XML\samlp\RequestedAuthnContext $requestedAuthnContext
115			* @param \SimpleSAML\SAML2\XML\saml\Subject $subject
116			* @param \SimpleSAML\SAML2\XML\samlp\NameIDPolicy $nameIdPolicy
117			* @param \SimpleSAML\SAML2\XML\saml\Conditions $conditions
118			* @param bool $forceAuthn
119			* @param bool $isPassive
120			* @param string\|null $assertionConsumerServiceUrl
121			* @param int\|null $assertionConsumerServiceIndex
122			* @param string\|null $protocolBinding
123			* @param int\|null $attributeConsumingServiceIndex
124			* @param string\|null $providerName
125			* @param \SimpleSAML\SAML2\XML\saml\Issuer\|null $issuer
126			* @param string\|null $id
127			* @param int\|null $issueInstant
128			* @param string\|null $destination
129			* @param string\|null $consent
130			* @param \SimpleSAML\SAML2\XML\samlp\Extensions\|null $extensions
131			* @param \SimpleSAML\SAML2\XML\samlp\Scoping\|null $scoping
132			* @throws \Exception
133			*/
134			public function __construct(
135			?RequestedAuthnContext $requestedAuthnContext = null,
136			?Subject $subject = null,
137			?NameIDPolicy $nameIdPolicy = null,
138			Conditions $conditions = null,
139			?bool $forceAuthn = null,
140			?bool $isPassive = null,
141			?string $assertionConsumerServiceUrl = null,
142			?int $assertionConsumerServiceIndex = null,
143			?string $protocolBinding = null,
144			?int $attributeConsumingServiceIndex = null,
145			?string $providerName = null,
146			?Issuer $issuer = null,
147			?string $id = null,
148			?int $issueInstant = null,
149			?string $destination = null,
150			?string $consent = null,
151			?Extensions $extensions = null,
152			?Scoping $scoping = null
153			) {
154			parent::__construct($issuer, $id, $issueInstant, $destination, $consent, $extensions);
155
156			$this->setRequestedAuthnContext($requestedAuthnContext);
157			$this->setSubject($subject);
158			$this->setNameIdPolicy($nameIdPolicy);
159			$this->setConditions($conditions);
160
161			$this->setForceAuthn($forceAuthn);
162			$this->setIsPassive($isPassive);
163			$this->setAssertionConsumerServiceUrl($assertionConsumerServiceUrl);
164			$this->setAssertionConsumerServiceIndex($assertionConsumerServiceIndex);
165			$this->setProtocolBinding($protocolBinding);
166			$this->setAttributeConsumingServiceIndex($attributeConsumingServiceIndex);
167			$this->setProviderName($providerName);
168			$this->setScoping($scoping);
169			}
170
171
172			/**
173			* @param \SimpleSAML\SAML2\XML\saml\Subject\|null $subject
174			*/
175			private function setSubject(?Subject $subject): void
176			{
177			$this->subject = $subject;
178			}
179
180
181			/**
182			* @return \SimpleSAML\SAML2\XML\saml\Subject\|null
183			*/
184			public function getSubject(): ?Subject
185			{
186			return $this->subject;
187			}
188
189
190			/**
191			* @param \SimpleSAML\SAML2\XML\samlp\Scoping\|null $scoping
192			*/
193			private function setScoping(?Scoping $scoping): void
194			{
195			$this->scoping = $scoping;
196			}
197
198
199			/**
200			* @return \SimpleSAML\SAML2\XML\samlp\Scoping\|null
201			*/
202			public function getScoping(): ?Scoping
203			{
204			return $this->scoping;
205			}
206
207
208			/**
209			* @param \SimpleSAML\SAML2\XML\saml\Conditions\|null $conditions
210			*/
211			private function setConditions(?Conditions $conditions): void
212			{
213			$this->conditions = $conditions;
214			}
215
216
217			/**
218			* @return \SimpleSAML\SAML2\XML\saml\Conditions\|null
219			*/
220			public function getConditions(): ?Conditions
221			{
222			return $this->conditions;
223			}
224
225
226			/**
227			* Retrieve the NameIdPolicy.
228			*
229			* @see \SimpleSAML\SAML2\AuthnRequest::setNameIdPolicy()
230			* @return \SimpleSAML\SAML2\XML\samlp\NameIDPolicy\|null The NameIdPolicy.
231			*/
232			public function getNameIdPolicy(): ?NameIDPolicy
233			{
234			return $this->nameIdPolicy;
235			}
236
237
238			/**
239			* Set the NameIDPolicy.
240			*
241			* @param \SimpleSAML\SAML2\XML\samlp\NameIDPolicy\|null $nameIdPolicy The NameIDPolicy.
242			*/
243			private function setNameIdPolicy(?NameIDPolicy $nameIdPolicy): void
244			{
245			$this->nameIdPolicy = $nameIdPolicy;
246			}
247
248
249			/**
250			* Retrieve the value of the ForceAuthn attribute.
251			*
252			* @return bool\|null The ForceAuthn attribute.
253			*/
254			public function getForceAuthn(): ?bool
255			{
256			return $this->forceAuthn;
257			}
258
259
260			/**
261			* Set the value of the ForceAuthn attribute.
262			*
263			* @param bool $forceAuthn The ForceAuthn attribute.
264			*/
265			private function setForceAuthn(?bool $forceAuthn): void
266			{
267			$this->forceAuthn = $forceAuthn;
268			}
269
270
271			/**
272			* Retrieve the value of the ProviderName attribute.
273			*
274			* @return string\|null The ProviderName attribute.
275			*/
276			public function getProviderName(): ?string
277			{
278			return $this->ProviderName;
279			}
280
281
282			/**
283			* Set the value of the ProviderName attribute.
284			*
285			* @param string\|null $ProviderName The ProviderName attribute.
286			*/
287			private function setProviderName(?string $ProviderName): void
288			{
289			Assert::nullOrNotWhitespaceOnly($ProviderName);
290			$this->ProviderName = $ProviderName;
291			}
292
293
294			/**
295			* Retrieve the value of the IsPassive attribute.
296			*
297			* @return bool\|null The IsPassive attribute.
298			*/
299			public function getIsPassive(): ?bool
300			{
301			return $this->isPassive;
302			}
303
304
305			/**
306			* Set the value of the IsPassive attribute.
307			*
308			* @param bool\|null $isPassive The IsPassive attribute.
309			*/
310			private function setIsPassive(?bool $isPassive): void
311			{
312			$this->isPassive = $isPassive;
313			}
314
315
316			/**
317			* Retrieve the value of the AssertionConsumerServiceURL attribute.
318			*
319			* @return string\|null The AssertionConsumerServiceURL attribute.
320			*/
321			public function getAssertionConsumerServiceURL(): ?string
322			{
323			return $this->assertionConsumerServiceURL;
324			}
325
326
327			/**
328			* Set the value of the AssertionConsumerServiceURL attribute.
329			*
330			* @param string\|null $assertionConsumerServiceURL The AssertionConsumerServiceURL attribute.
331			*/
332			private function setAssertionConsumerServiceURL(string $assertionConsumerServiceURL = null): void
333			{
334			if (!is_null($assertionConsumerServiceURL) && !filter_var($assertionConsumerServiceURL, FILTER_VALIDATE_URL)) {
335			throw new InvalidArgumentException('AuthnRequest AssertionConsumerServiceURL is not a valid URL.');
336			}
337
338			$this->assertionConsumerServiceURL = $assertionConsumerServiceURL;
339			}
340
341
342			/**
343			* Retrieve the value of the ProtocolBinding attribute.
344			*
345			* @return string\|null The ProtocolBinding attribute.
346			*/
347			public function getProtocolBinding(): ?string
348			{
349			return $this->protocolBinding;
350			}
351
352
353			/**
354			* Set the value of the ProtocolBinding attribute.
355			*
356			* @param string\|null $protocolBinding The ProtocolBinding attribute.
357			*/
358			private function setProtocolBinding(?string $protocolBinding): void
359			{
360			Assert::nullOrNotWhitespaceOnly($protocolBinding);
361
362			$this->protocolBinding = $protocolBinding;
363			}
364
365
366			/**
367			* Retrieve the value of the AttributeConsumingServiceIndex attribute.
368			*
369			* @return int\|null The AttributeConsumingServiceIndex attribute.
370			*/
371			public function getAttributeConsumingServiceIndex(): ?int
372			{
373			return $this->attributeConsumingServiceIndex;
374			}
375
376
377			/**
378			* Set the value of the AttributeConsumingServiceIndex attribute.
379			*
380			* @param int\|null $attributeConsumingServiceIndex The AttributeConsumingServiceIndex attribute.
381			*/
382			private function setAttributeConsumingServiceIndex(?int $attributeConsumingServiceIndex): void
383			{
384			Assert::nullOrRange($attributeConsumingServiceIndex, 0, 65535);
385			$this->attributeConsumingServiceIndex = $attributeConsumingServiceIndex;
386			}
387
388
389			/**
390			* Retrieve the value of the AssertionConsumerServiceIndex attribute.
391			*
392			* @return int\|null The AssertionConsumerServiceIndex attribute.
393			*/
394			public function getAssertionConsumerServiceIndex(): ?int
395			{
396			return $this->assertionConsumerServiceIndex;
397			}
398
399
400			/**
401			* Set the value of the AssertionConsumerServiceIndex attribute.
402			*
403			* @param int\|null $assertionConsumerServiceIndex The AssertionConsumerServiceIndex attribute.
404			*/
405			private function setAssertionConsumerServiceIndex(?int $assertionConsumerServiceIndex): void
406			{
407			Assert::nullOrRange($assertionConsumerServiceIndex, 0, 65535);
408			$this->assertionConsumerServiceIndex = $assertionConsumerServiceIndex;
409			}
410
411
412			/**
413			* Retrieve the RequestedAuthnContext.
414			*
415			* @return \SimpleSAML\SAML2\XML\samlp\RequestedAuthnContext\|null The RequestedAuthnContext.
416			*/
417			public function getRequestedAuthnContext(): ?RequestedAuthnContext
418			{
419			return $this->requestedAuthnContext;
420			}
421
422
423			/**
424			* Set the RequestedAuthnContext.
425			*
426			* @param \SimpleSAML\SAML2\XML\samlp\RequestedAuthnContext\|null $requestedAuthnContext The RequestedAuthnContext.
427			*/
428			private function setRequestedAuthnContext(RequestedAuthnContext $requestedAuthnContext = null): void
429			{
430			$this->requestedAuthnContext = $requestedAuthnContext;
431			}
432
433
434			/**
435			* Convert XML into an AuthnRequest
436			*
437			* @param \DOMElement $xml The XML element we should load
438			* @return \SimpleSAML\SAML2\XML\samlp\AuthnRequest
439			*
440			* @throws \SimpleSAML\XML\Exception\InvalidDOMElementException if the qualified name of the supplied element is wrong
441			* @throws \SimpleSAML\XML\Exception\MissingAttributeException if the supplied element is missing one of the mandatory attributes
442			* @throws \SimpleSAML\XML\Exception\TooManyElementsException if too many child-elements of a type are specified
443			*/
444			public static function fromXML(DOMElement $xml): object
445			{
446			Assert::same($xml->localName, 'AuthnRequest', InvalidDOMElementException::class);
447			Assert::same($xml->namespaceURI, AuthnRequest::NS, InvalidDOMElementException::class);
448			Assert::same('2.0', self::getAttribute($xml, 'Version'));
449
450			$issueInstant = self::getAttribute($xml, 'IssueInstant');
451			Assert::validDateTimeZulu($issueInstant, ProtocolViolationException::class);
452			$issueInstant = XMLUtils::xsDateTimeToTimestamp($issueInstant);
453
454			$attributeConsumingServiceIndex = self::getIntegerAttribute($xml, 'AttributeConsumingServiceIndex', null);
455			$assertionConsumerServiceIndex = self::getIntegerAttribute($xml, 'AssertionConsumerServiceIndex', null);
456
457			$conditions = Conditions::getChildrenOfClass($xml);
458			Assert::maxCount($conditions, 1, 'Only one <saml:Conditions> element is allowed.', TooManyElementsException::class);
459
460			$nameIdPolicy = NameIDPolicy::getChildrenOfClass($xml);
461			Assert::maxCount($nameIdPolicy, 1, 'Only one <samlp:NameIDPolicy> element is allowed.', TooManyElementsException::class);
462
463			$subject = Subject::getChildrenOfClass($xml);
464			Assert::maxCount($subject, 1, 'Only one <saml:Subject> element is allowed.', TooManyElementsException::class);
465
466			$issuer = Issuer::getChildrenOfClass($xml);
467			Assert::maxCount($issuer, 1, 'Only one <saml:Issuer> element is allowed.', TooManyElementsException::class);
468
469			$requestedAuthnContext = RequestedAuthnContext::getChildrenOfClass($xml);
470			Assert::maxCount(
471			$requestedAuthnContext,
472			1,
473			'Only one <samlp:RequestedAuthnContext> element is allowed.',
474			TooManyElementsException::class
475			);
476
477			$extensions = Extensions::getChildrenOfClass($xml);
478			Assert::maxCount($extensions, 1, 'Only one <samlp:Extensions> element is allowed.', TooManyElementsException::class);
479
480			$signature = Signature::getChildrenOfClass($xml);
481			Assert::maxCount($signature, 1, 'Only one <ds:Signature> element is allowed.', TooManyElementsException::class);
482
483			$scoping = Scoping::getChildrenOfClass($xml);
484			Assert::maxCount($scoping, 1, 'Only one <samlp:Scoping> element is allowed.', TooManyElementsException::class);
485
486			$request = new self(
487			array_pop($requestedAuthnContext),
488			array_pop($subject),
489			array_pop($nameIdPolicy),
490			array_pop($conditions),
491			self::getBooleanAttribute($xml, 'ForceAuthn', null),
492			self::getBooleanAttribute($xml, 'IsPassive', null),
493			self::getAttribute($xml, 'AssertionConsumerServiceURL', null),
494			$assertionConsumerServiceIndex,
495			self::getAttribute($xml, 'ProtocolBinding', null),
496			$attributeConsumingServiceIndex,
497			self::getAttribute($xml, 'ProviderName', null),
498			array_pop($issuer),
499			self::getAttribute($xml, 'ID'),
500			$issueInstant,
501			self::getAttribute($xml, 'Destination', null),
502			self::getAttribute($xml, 'Consent', null),
503			array_pop($extensions),
504			array_pop($scoping)
505			);
506
507			if (!empty($signature)) {
508			$request->setSignature($signature[0]);
509			$request->messageContainedSignatureUponConstruction = true;
510			}
511
512			$request->setXML($xml);
513			return $request;
514			}
515
516
517			/**
518			* Convert this message to an unsigned XML document.
519			* This method does not sign the resulting XML document.
520			*
521			* @param \DOMElement\|null $parent
522			* @return \DOMElement The root element of the DOM tree
523			*/
524			protected function toUnsignedXML(?DOMElement $parent = null): DOMElement
525			{
526			$e = parent::toUnsignedXML($parent);
527
528			if ($this->forceAuthn === true) {
529			$e->setAttribute('ForceAuthn', 'true');
530			}
531
532			if (!empty($this->ProviderName)) {
533			$e->setAttribute('ProviderName', $this->ProviderName);
534			}
535
536			if ($this->isPassive === true) {
537			$e->setAttribute('IsPassive', 'true');
538			}
539
540			if ($this->assertionConsumerServiceIndex !== null) {
541			$e->setAttribute('AssertionConsumerServiceIndex', strval($this->assertionConsumerServiceIndex));
542			} else {
543			if ($this->assertionConsumerServiceURL !== null) {
544			$e->setAttribute('AssertionConsumerServiceURL', $this->assertionConsumerServiceURL);
545			}
546			if ($this->protocolBinding !== null) {
547			$e->setAttribute('ProtocolBinding', $this->protocolBinding);
548			}
549			}
550
551			if ($this->attributeConsumingServiceIndex !== null) {
552			$e->setAttribute('AttributeConsumingServiceIndex', strval($this->attributeConsumingServiceIndex));
553			}
554
555			if ($this->subject !== null) {
556			$this->subject->toXML($e);
557			}
558
559			if ($this->nameIdPolicy !== null) {
560			if (!$this->nameIdPolicy->isEmptyElement()) {
561			$this->nameIdPolicy->toXML($e);
562			}
563			}
564
565			if ($this->conditions !== null) {
566			if (!$this->conditions->isEmptyElement()) {
567			$this->conditions->toXML($e);
568			}
569			}
570
571			if (!empty($this->requestedAuthnContext)) {
572			$this->requestedAuthnContext->toXML($e);
573			}
574
575			if ($this->scoping !== null) {
576			if (!$this->scoping->isEmptyElement()) {
577			$this->scoping->toXML($e);
578			}
579			}
580
581			return $e;
582			}
583			}
584

simplesamlphp / saml2

Pull Request — master (#280)

AuthnRequest::toXML() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like