AuthnAuthorityDescriptor::getNameIDFormat() - Code Metrics - Inspection of "Constructor promotion (#317)" - simplesamlphp/saml2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 7a371e...4a8d98 )

by Tim

created 2023-01-26 11:16 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\Assert\Assert;
use SimpleSAML\XML\Exception\InvalidDOMElementException;
use SimpleSAML\XML\Exception\TooManyElementsException;
use SimpleSAML\XML\Utils as XMLUtils;
use SimpleSAML\XMLSecurity\XML\ds\Signature;

use function preg_split;

/**
 * Class representing SAML 2 metadata AuthnAuthorityDescriptor.
 *
 * @package simplesamlphp/saml2
 */
final class AuthnAuthorityDescriptor extends AbstractRoleDescriptor
{
    /**
     * AuthnAuthorityDescriptor constructor.
     *
     * @param array $authnQueryService
     * @param array $protocolSupportEnumeration
     * @param array $assertionIDRequestService
     * @param array $nameIDFormat
     * @param string|null $ID
     * @param int|null $validUntil
     * @param string|null $cacheDuration
     * @param \SimpleSAML\SAML2\XML\md\Extensions|null $extensions
     * @param string|null $errorURL
     * @param \SimpleSAML\SAML2\XML\md\Organization|null $organization
     * @param array $keyDescriptor
     * @param array $contact
     */
    public function __construct(
        protected array $authnQueryService,
        array $protocolSupportEnumeration,
        protected array $assertionIDRequestService = [],
        protected array $nameIDFormat = [],
        string $ID = null,
        ?int $validUntil = null,
        ?string $cacheDuration = null,
        ?Extensions $extensions = null,
        ?string $errorURL = null,
        ?Organization $organization = null,
        array $keyDescriptor = [],
        array $contact = [],
    ) {
        Assert::minCount($authnQueryService, 1, 'Missing at least one AuthnQueryService in AuthnAuthorityDescriptor.');
        Assert::allIsInstanceOf(
            $authnQueryService,
            AbstractEndpointType::class,
            'AuthnQueryService must be an instance of EndpointType',
        );
        Assert::allIsInstanceOf(
            $assertionIDRequestService,
            AbstractEndpointType::class,
            'AssertionIDRequestServices must be an instance of EndpointType',
        );
        Assert::allIsInstanceOf($nameIDFormat, NameIDFormat::class);

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


    /**
     * 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 self
     *
     * @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): static
    {
        Assert::same($xml->localName, 'AuthnAuthorityDescriptor', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, AuthnAuthorityDescriptor::NS, InvalidDOMElementException::class);

        $protocols = self::getAttribute($xml, 'protocolSupportEnumeration');

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

        $validUntil = self::getAttribute($xml, 'validUntil', null);

        $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,
            preg_split('/[\s]+/', trim($protocols)),
            $assertionIDRequestServices,
            $nameIDFormats,
            self::getAttribute($xml, 'ID', null),
            $validUntil !== null ? XMLUtils::xsDateTimeToTimestamp($validUntil) : null,
            self::getAttribute($xml, 'cacheDuration', null),
            !empty($extensions) ? $extensions[0] : null,
            self::getAttribute($xml, 'errorURL', null),
            !empty($orgs) ? $orgs[0] : null,
            KeyDescriptor::getChildrenOfClass($xml),
            ContactPerson::getChildrenOfClass($xml),
filter:
    dependency_paths: ["lib/*"]
        );
        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\Assert\Assert;
9			use SimpleSAML\XML\Exception\InvalidDOMElementException;
10			use SimpleSAML\XML\Exception\TooManyElementsException;
11			use SimpleSAML\XML\Utils as XMLUtils;
12			use SimpleSAML\XMLSecurity\XML\ds\Signature;
13
14			use function preg_split;
15
16			/**
17			* Class representing SAML 2 metadata AuthnAuthorityDescriptor.
18			*
19			* @package simplesamlphp/saml2
20			*/
21			final class AuthnAuthorityDescriptor extends AbstractRoleDescriptor
22			{
23			/**
24			* AuthnAuthorityDescriptor constructor.
25			*
26			* @param array $authnQueryService
27			* @param array $protocolSupportEnumeration
28			* @param array $assertionIDRequestService
29			* @param array $nameIDFormat
30			* @param string\|null $ID
31			* @param int\|null $validUntil
32			* @param string\|null $cacheDuration
33			* @param \SimpleSAML\SAML2\XML\md\Extensions\|null $extensions
34			* @param string\|null $errorURL
35			* @param \SimpleSAML\SAML2\XML\md\Organization\|null $organization
36			* @param array $keyDescriptor
37			* @param array $contact
38			*/
39			public function __construct(
40			protected array $authnQueryService,
41			array $protocolSupportEnumeration,
42			protected array $assertionIDRequestService = [],
43			protected array $nameIDFormat = [],
44			string $ID = null,
45			?int $validUntil = null,
46			?string $cacheDuration = null,
47			?Extensions $extensions = null,
48			?string $errorURL = null,
49			?Organization $organization = null,
50			array $keyDescriptor = [],
51			array $contact = [],
52			) {
53			Assert::minCount($authnQueryService, 1, 'Missing at least one AuthnQueryService in AuthnAuthorityDescriptor.');
54			Assert::allIsInstanceOf(
55			$authnQueryService,
56			AbstractEndpointType::class,
57			'AuthnQueryService must be an instance of EndpointType',
58			);
59			Assert::allIsInstanceOf(
60			$assertionIDRequestService,
61			AbstractEndpointType::class,
62			'AssertionIDRequestServices must be an instance of EndpointType',
63			);
64			Assert::allIsInstanceOf($nameIDFormat, NameIDFormat::class);
65
66			parent::__construct(
67			$protocolSupportEnumeration,
68			$ID,
69			$validUntil,
70			$cacheDuration,
71			$extensions,
72			$errorURL,
73			$keyDescriptor,
74			$organization,
75			$contact,
76			);
77			}
78
79
80			/**
81			* Collect the AuthnQueryService endpoints
82			*
83			* @return \SimpleSAML\SAML2\XML\md\AbstractEndpointType[]
84			*/
85			public function getAuthnQueryService(): array
86			{
87			return $this->authnQueryService;
88			}
89
90
91			/**
92			* Collect the AssertionIDRequestService endpoints
93			*
94			* @return \SimpleSAML\SAML2\XML\md\AbstractEndpointType[]
95			*/
96			public function getAssertionIDRequestService(): array
97			{
98			return $this->assertionIDRequestService;
99			}
100
101
102			/**
103			* Collect the values of the NameIDFormat
104			*
105			* @return \SimpleSAML\SAML2\XML\md\NameIDFormat[]
106			*/
107			public function getNameIDFormat(): array
108			{
109			return $this->nameIDFormat;
110			}
111
112
113			/**
114			* Initialize an IDPSSODescriptor from an existing XML document.
115			*
116			* @param \DOMElement $xml The XML element we should load.
117			* @return self
118			*
119			* @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
120			* if the qualified name of the supplied element is wrong
121			* @throws \SimpleSAML\XML\Exception\MissingAttributeException
122			* if the supplied element is missing one of the mandatory attributes
123			* @throws \SimpleSAML\XML\Exception\TooManyElementsException
124			* if too many child-elements of a type are specified
125			*/
126			public static function fromXML(DOMElement $xml): static
127			{
128			Assert::same($xml->localName, 'AuthnAuthorityDescriptor', InvalidDOMElementException::class);
129			Assert::same($xml->namespaceURI, AuthnAuthorityDescriptor::NS, InvalidDOMElementException::class);
130
131			$protocols = self::getAttribute($xml, 'protocolSupportEnumeration');
132
133			$authnQueryServices = AuthnQueryService::getChildrenOfClass($xml);
134			$assertionIDRequestServices = AssertionIDRequestService::getChildrenOfClass($xml);
135			$nameIDFormats = NameIDFormat::getChildrenOfClass($xml);
136
137			$validUntil = self::getAttribute($xml, 'validUntil', null);
138
139			$orgs = Organization::getChildrenOfClass($xml);
140			Assert::maxCount(
141			$orgs,
142			1,
143			'More than one Organization found in this descriptor',
144			TooManyElementsException::class,
145			);
146
147			$extensions = Extensions::getChildrenOfClass($xml);
148			Assert::maxCount(
149			$extensions,
150			1,
151			'Only one md:Extensions element is allowed.',
152			TooManyElementsException::class,
153			);
154
155			$signature = Signature::getChildrenOfClass($xml);
156			Assert::maxCount(
157			$signature,
158			1,
159			'Only one ds:Signature element is allowed.',
160			TooManyElementsException::class,
161			);
162
163			$authority = new static(
164			$authnQueryServices,
165			preg_split('/[\s]+/', trim($protocols)),
166			$assertionIDRequestServices,
167			$nameIDFormats,
168			self::getAttribute($xml, 'ID', null),
169			$validUntil !== null ? XMLUtils::xsDateTimeToTimestamp($validUntil) : null,
170			self::getAttribute($xml, 'cacheDuration', null),
171			!empty($extensions) ? $extensions[0] : null,
172			self::getAttribute($xml, 'errorURL', null),
173			!empty($orgs) ? $orgs[0] : null,
174			KeyDescriptor::getChildrenOfClass($xml),
175			ContactPerson::getChildrenOfClass($xml),
			0 ignored issues – show Bug introduced 2023-01-26 11:04 UTC by Report Bug Copy Issue Report The type `SimpleSAML\SAML2\XML\md\ContactPerson` 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...
176			);
177			if (!empty($signature)) {
178			$authority->setSignature($signature[0]);
179			$authority->setXML($xml);
180			}
181			return $authority;
182			}
183
184
185			/**
186			* Add this IDPSSODescriptor to an EntityDescriptor.
187			*
188			* @param \DOMElement\|null $parent The EntityDescriptor we should append this AuthnAuthorityDescriptor to.
189			*
190			* @return \DOMElement
191			* @throws \Exception
192			*/
193			public function toUnsignedXML(?DOMElement $parent = null): DOMElement
194			{
195			$e = parent::toUnsignedXML($parent);
196
197			foreach ($this->getAuthnQueryService() as $ep) {
198			$ep->toXML($e);
199			}
200
201			foreach ($this->getAssertionIDRequestService() as $ep) {
202			$ep->toXML($e);
203			}
204
205			foreach ($this->getNameIDFormat() as $nidFormat) {
206			$nidFormat->toXML($e);
207			}
208
209			return $e;
210			}
211			}
212

simplesamlphp / saml2

Push — master ( 7a371e...4a8d98 )

AuthnAuthorityDescriptor::getNameIDFormat() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like