AuthnAuthorityDescriptor::getNameIDFormat() - Code Metrics - Inspection of "Migrate to xsd-types" - simplesamlphp/saml2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#374)

by Tim

created 2025-10-02 19:06 UTC

AuthnAuthorityDescriptor::getNameIDFormat() A

↳ Parent: AuthnAuthorityDescriptor

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\md;

use DOMElement;
use SimpleSAML\SAML2\Assert\Assert;
use SimpleSAML\SAML2\Type\AnyURIListValue;
use SimpleSAML\SAML2\Type\SAMLAnyURIValue;
use SimpleSAML\SAML2\Type\SAMLDateTimeValue;
use SimpleSAML\XML\Constants as C;
use SimpleSAML\XML\SchemaValidatableElementInterface;
use SimpleSAML\XML\SchemaValidatableElementTrait;
use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
use SimpleSAML\XMLSchema\Exception\TooManyElementsException;
use SimpleSAML\XMLSchema\Type\DurationValue;
use SimpleSAML\XMLSchema\Type\IDValue;
use SimpleSAML\XMLSecurity\XML\ds\Signature;

/**
 * Class representing SAML 2 metadata AuthnAuthorityDescriptor.
 *
 * @package simplesamlphp/saml2
 */
final class AuthnAuthorityDescriptor extends AbstractRoleDescriptorType implements SchemaValidatableElementInterface
{
    use SchemaValidatableElementTrait;


    /**
     * AuthnAuthorityDescriptor constructor.
     *
     * @param array $authnQueryService
     * @param \SimpleSAML\SAML2\Type\AnyURIListValue $protocolSupportEnumeration
     * @param array $assertionIDRequestService
     * @param array $nameIDFormat
     * @param \SimpleSAML\XMLSchema\Type\IDValue|null $ID
     * @param \SimpleSAML\SAML2\Type\SAMLDateTimeValue|null $validUntil
     * @param \SimpleSAML\XMLSchema\Type\DurationValue|null $cacheDuration
     * @param \SimpleSAML\SAML2\XML\md\Extensions|null $extensions
     * @param \SimpleSAML\SAML2\Type\SAMLAnyURIValue|null $errorURL
     * @param \SimpleSAML\SAML2\XML\md\Organization|null $organization
     * @param array $keyDescriptor
     * @param array $contact
     * @param list<\SimpleSAML\XML\Attribute> $namespacedAttributes
filter:
    dependency_paths: ["lib/*"]
     */
    public function __construct(
        protected array $authnQueryService,
        AnyURIListValue $protocolSupportEnumeration,
        protected array $assertionIDRequestService = [],
        protected array $nameIDFormat = [],
        ?IDValue $ID = null,
        ?SAMLDateTimeValue $validUntil = null,
        ?DurationValue $cacheDuration = null,
        ?Extensions $extensions = null,
        ?SAMLAnyURIValue $errorURL = null,
        ?Organization $organization = null,
        array $keyDescriptor = [],
        array $contact = [],
        array $namespacedAttributes = [],
    ) {
        Assert::maxCount($authnQueryService, C::UNBOUNDED_LIMIT);
        Assert::minCount($authnQueryService, 1, 'Missing at least one AuthnQueryService in AuthnAuthorityDescriptor.');
        Assert::allIsInstanceOf(
            $authnQueryService,
            AbstractEndpointType::class,
            'AuthnQueryService must be an instance of EndpointType',
        );
        Assert::maxCount($assertionIDRequestService, C::UNBOUNDED_LIMIT);
        Assert::allIsInstanceOf(
            $assertionIDRequestService,
            AbstractEndpointType::class,
            'AssertionIDRequestServices must be an instance of EndpointType',
        );
        Assert::maxCount($nameIDFormat, C::UNBOUNDED_LIMIT);
        Assert::allIsInstanceOf($nameIDFormat, NameIDFormat::class);

        parent::__construct(
            $protocolSupportEnumeration,
            $ID,
            $validUntil,
            $cacheDuration,
            $extensions,
            $errorURL,
            $keyDescriptor,
            $organization,
            $contact,
            $namespacedAttributes,
        );
    }


    /**
     * Collect the AuthnQueryService endpoints
     *
     * @return \SimpleSAML\SAML2\XML\md\AbstractEndpointType[]
     */
    public function getAuthnQueryService(): array
    {
        return $this->authnQueryService;
    }


    /**
     * Collect the AssertionIDRequestService endpoints
     *
     * @return \SimpleSAML\SAML2\XML\md\AbstractEndpointType[]
     */
    public function getAssertionIDRequestService(): array
    {
        return $this->assertionIDRequestService;
    }


    /**
     * Collect the values of the NameIDFormat
     *
     * @return \SimpleSAML\SAML2\XML\md\NameIDFormat[]
     */
    public function getNameIDFormat(): array
    {
        return $this->nameIDFormat;
    }


    /**
     * Initialize an IDPSSODescriptor from an existing XML document.
     *
     * @param \DOMElement $xml The XML element we should load.
     * @return static
     *
     * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
     *   if the qualified name of the supplied element is wrong
     * @throws \SimpleSAML\XMLSchema\Exception\MissingAttributeException
     *   if the supplied element is missing one of the mandatory attributes
     * @throws \SimpleSAML\XMLSchema\Exception\TooManyElementsException
     *   if too many child-elements of a type are specified
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, 'AuthnAuthorityDescriptor', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, AuthnAuthorityDescriptor::NS, InvalidDOMElementException::class);

        $authnQueryServices = AuthnQueryService::getChildrenOfClass($xml);
        $assertionIDRequestServices = AssertionIDRequestService::getChildrenOfClass($xml);
        $nameIDFormats = NameIDFormat::getChildrenOfClass($xml);

        $orgs = Organization::getChildrenOfClass($xml);
        Assert::maxCount(
            $orgs,
            1,
            'More than one Organization found in this descriptor',
            TooManyElementsException::class,
        );

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

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

        $authority = new static(
            $authnQueryServices,
            self::getAttribute($xml, 'protocolSupportEnumeration', AnyURIListValue::class),
            $assertionIDRequestServices,
            $nameIDFormats,
            self::getOptionalAttribute($xml, 'ID', IDValue::class, null),
            self::getOptionalAttribute($xml, 'validUntil', SAMLDateTimeValue::class, null),
            self::getOptionalAttribute($xml, 'cacheDuration', DurationValue::class, null),
            !empty($extensions) ? $extensions[0] : null,
            self::getOptionalAttribute($xml, 'errorURL', SAMLAnyURIValue::class, null),
            !empty($orgs) ? $orgs[0] : null,
            KeyDescriptor::getChildrenOfClass($xml),
            ContactPerson::getChildrenOfClass($xml),
            self::getAttributesNSFromXML($xml),
        );

        if (!empty($signature)) {
            $authority->setSignature($signature[0]);
            $authority->setXML($xml);
        }

        return $authority;
    }


    /**
     * Add this IDPSSODescriptor to an EntityDescriptor.
     *
     * @param \DOMElement|null $parent The EntityDescriptor we should append this AuthnAuthorityDescriptor to.
     *
     * @return \DOMElement
     * @throws \Exception
     */
    public function toUnsignedXML(?DOMElement $parent = null): DOMElement
    {
        $e = parent::toUnsignedXML($parent);

        foreach ($this->getAuthnQueryService() as $ep) {
            $ep->toXML($e);
        }

        foreach ($this->getAssertionIDRequestService() as $ep) {
            $ep->toXML($e);
        }

        foreach ($this->getNameIDFormat() as $nidFormat) {
            $nidFormat->toXML($e);
        }

        return $e;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\SAML2\XML\md;
6
7			use DOMElement;
8			use SimpleSAML\SAML2\Assert\Assert;
9			use SimpleSAML\SAML2\Type\AnyURIListValue;
10			use SimpleSAML\SAML2\Type\SAMLAnyURIValue;
11			use SimpleSAML\SAML2\Type\SAMLDateTimeValue;
12			use SimpleSAML\XML\Constants as C;
13			use SimpleSAML\XML\SchemaValidatableElementInterface;
14			use SimpleSAML\XML\SchemaValidatableElementTrait;
15			use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
16			use SimpleSAML\XMLSchema\Exception\TooManyElementsException;
17			use SimpleSAML\XMLSchema\Type\DurationValue;
18			use SimpleSAML\XMLSchema\Type\IDValue;
19			use SimpleSAML\XMLSecurity\XML\ds\Signature;
20
21			/**
22			* Class representing SAML 2 metadata AuthnAuthorityDescriptor.
23			*
24			* @package simplesamlphp/saml2
25			*/
26			final class AuthnAuthorityDescriptor extends AbstractRoleDescriptorType implements SchemaValidatableElementInterface
27			{
28			use SchemaValidatableElementTrait;
29
30
31			/**
32			* AuthnAuthorityDescriptor constructor.
33			*
34			* @param array $authnQueryService
35			* @param \SimpleSAML\SAML2\Type\AnyURIListValue $protocolSupportEnumeration
36			* @param array $assertionIDRequestService
37			* @param array $nameIDFormat
38			* @param \SimpleSAML\XMLSchema\Type\IDValue\|null $ID
39			* @param \SimpleSAML\SAML2\Type\SAMLDateTimeValue\|null $validUntil
40			* @param \SimpleSAML\XMLSchema\Type\DurationValue\|null $cacheDuration
41			* @param \SimpleSAML\SAML2\XML\md\Extensions\|null $extensions
42			* @param \SimpleSAML\SAML2\Type\SAMLAnyURIValue\|null $errorURL
43			* @param \SimpleSAML\SAML2\XML\md\Organization\|null $organization
44			* @param array $keyDescriptor
45			* @param array $contact
46			* @param list<\SimpleSAML\XML\Attribute> $namespacedAttributes
			0 ignored issues – show Bug introduced 2024-02-20 20:07 UTC by Report Bug Copy Issue Report The type `SimpleSAML\SAML2\XML\md\list` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
47			*/
48			public function __construct(
49			protected array $authnQueryService,
50			AnyURIListValue $protocolSupportEnumeration,
51			protected array $assertionIDRequestService = [],
52			protected array $nameIDFormat = [],
53			?IDValue $ID = null,
54			?SAMLDateTimeValue $validUntil = null,
55			?DurationValue $cacheDuration = null,
56			?Extensions $extensions = null,
57			?SAMLAnyURIValue $errorURL = null,
58			?Organization $organization = null,
59			array $keyDescriptor = [],
60			array $contact = [],
61			array $namespacedAttributes = [],
62			) {
63			Assert::maxCount($authnQueryService, C::UNBOUNDED_LIMIT);
64			Assert::minCount($authnQueryService, 1, 'Missing at least one AuthnQueryService in AuthnAuthorityDescriptor.');
65			Assert::allIsInstanceOf(
66			$authnQueryService,
67			AbstractEndpointType::class,
68			'AuthnQueryService must be an instance of EndpointType',
69			);
70			Assert::maxCount($assertionIDRequestService, C::UNBOUNDED_LIMIT);
71			Assert::allIsInstanceOf(
72			$assertionIDRequestService,
73			AbstractEndpointType::class,
74			'AssertionIDRequestServices must be an instance of EndpointType',
75			);
76			Assert::maxCount($nameIDFormat, C::UNBOUNDED_LIMIT);
77			Assert::allIsInstanceOf($nameIDFormat, NameIDFormat::class);
78
79			parent::__construct(
80			$protocolSupportEnumeration,
81			$ID,
82			$validUntil,
83			$cacheDuration,
84			$extensions,
85			$errorURL,
86			$keyDescriptor,
87			$organization,
88			$contact,
89			$namespacedAttributes,
90			);
91			}
92
93
94			/**
95			* Collect the AuthnQueryService endpoints
96			*
97			* @return \SimpleSAML\SAML2\XML\md\AbstractEndpointType[]
98			*/
99			public function getAuthnQueryService(): array
100			{
101			return $this->authnQueryService;
102			}
103
104
105			/**
106			* Collect the AssertionIDRequestService endpoints
107			*
108			* @return \SimpleSAML\SAML2\XML\md\AbstractEndpointType[]
109			*/
110			public function getAssertionIDRequestService(): array
111			{
112			return $this->assertionIDRequestService;
113			}
114
115
116			/**
117			* Collect the values of the NameIDFormat
118			*
119			* @return \SimpleSAML\SAML2\XML\md\NameIDFormat[]
120			*/
121			public function getNameIDFormat(): array
122			{
123			return $this->nameIDFormat;
124			}
125
126
127			/**
128			* Initialize an IDPSSODescriptor from an existing XML document.
129			*
130			* @param \DOMElement $xml The XML element we should load.
131			* @return static
132			*
133			* @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
134			* if the qualified name of the supplied element is wrong
135			* @throws \SimpleSAML\XMLSchema\Exception\MissingAttributeException
136			* if the supplied element is missing one of the mandatory attributes
137			* @throws \SimpleSAML\XMLSchema\Exception\TooManyElementsException
138			* if too many child-elements of a type are specified
139			*/
140			public static function fromXML(DOMElement $xml): static
141			{
142			Assert::same($xml->localName, 'AuthnAuthorityDescriptor', InvalidDOMElementException::class);
143			Assert::same($xml->namespaceURI, AuthnAuthorityDescriptor::NS, InvalidDOMElementException::class);
144
145			$authnQueryServices = AuthnQueryService::getChildrenOfClass($xml);
146			$assertionIDRequestServices = AssertionIDRequestService::getChildrenOfClass($xml);
147			$nameIDFormats = NameIDFormat::getChildrenOfClass($xml);
148
149			$orgs = Organization::getChildrenOfClass($xml);
150			Assert::maxCount(
151			$orgs,
152			1,
153			'More than one Organization found in this descriptor',
154			TooManyElementsException::class,
155			);
156
157			$extensions = Extensions::getChildrenOfClass($xml);
158			Assert::maxCount(
159			$extensions,
160			1,
161			'Only one md:Extensions element is allowed.',
162			TooManyElementsException::class,
163			);
164
165			$signature = Signature::getChildrenOfClass($xml);
166			Assert::maxCount(
167			$signature,
168			1,
169			'Only one ds:Signature element is allowed.',
170			TooManyElementsException::class,
171			);
172
173			$authority = new static(
174			$authnQueryServices,
175			self::getAttribute($xml, 'protocolSupportEnumeration', AnyURIListValue::class),
176			$assertionIDRequestServices,
177			$nameIDFormats,
178			self::getOptionalAttribute($xml, 'ID', IDValue::class, null),
179			self::getOptionalAttribute($xml, 'validUntil', SAMLDateTimeValue::class, null),
180			self::getOptionalAttribute($xml, 'cacheDuration', DurationValue::class, null),
181			!empty($extensions) ? $extensions[0] : null,
182			self::getOptionalAttribute($xml, 'errorURL', SAMLAnyURIValue::class, null),
183			!empty($orgs) ? $orgs[0] : null,
184			KeyDescriptor::getChildrenOfClass($xml),
185			ContactPerson::getChildrenOfClass($xml),
186			self::getAttributesNSFromXML($xml),
187			);
188
189			if (!empty($signature)) {
190			$authority->setSignature($signature[0]);
191			$authority->setXML($xml);
192			}
193
194			return $authority;
195			}
196
197
198			/**
199			* Add this IDPSSODescriptor to an EntityDescriptor.
200			*
201			* @param \DOMElement\|null $parent The EntityDescriptor we should append this AuthnAuthorityDescriptor to.
202			*
203			* @return \DOMElement
204			* @throws \Exception
205			*/
206			public function toUnsignedXML(?DOMElement $parent = null): DOMElement
207			{
208			$e = parent::toUnsignedXML($parent);
209
210			foreach ($this->getAuthnQueryService() as $ep) {
211			$ep->toXML($e);
212			}
213
214			foreach ($this->getAssertionIDRequestService() as $ep) {
215			$ep->toXML($e);
216			}
217
218			foreach ($this->getNameIDFormat() as $nidFormat) {
219			$nidFormat->toXML($e);
220			}
221
222			return $e;
223			}
224			}
225

simplesamlphp / saml2

Pull Request — master (#374)

AuthnAuthorityDescriptor::getNameIDFormat() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like