Fix several issues reported by PHPStan

tvdijen · tvdijen · commit 64050b9cf696 · 2024-01-25T18:19:10.000+01:00
diff --git a/src/SAML2/XML/saml/AttributeValue.php b/src/SAML2/XML/saml/AttributeValue.php
@@ -56,11 +56,9 @@ public function getXsiType(): string
             case "NULL":
                 return "xs:nil";
             case "object":
-                /** @var \SimpleSAML\XML\AbstractElement $this->value */
                 return sprintf(
                     '%s:%s',
                     $this->value::getNamespacePrefix(),
-                    ":",
                     AbstractElement::getClassName(get_class($this->value)),
                 );
             default:
diff --git a/src/SAML2/XML/saml/AuthzDecisionStatement.php b/src/SAML2/XML/saml/AuthzDecisionStatement.php
@@ -7,6 +7,7 @@
 use DOMElement;
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\SAML2\Constants as C;
+use SimpleSAML\SAML2\Exception\ProtocolViolationException;
 use SimpleSAML\SAML2\XML\Decision;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
 use SimpleSAML\XML\Exception\MissingElementException;
@@ -121,10 +122,11 @@ public static function fromXML(DOMElement $xml): static
             TooManyElementsException::class,
         );
 
+        $decision = self::getAttribute($xml, 'Decision');
         try {
-            $decision = Decision::from(self::getAttribute($xml, 'Decision'));
+            $decision = Decision::from($decision);
         } catch (ValueError) {
-            throw ProtocolViolationException(sprintf('Unknown value \'%s\' for Decision attribute.', $decision));
+            throw new ProtocolViolationException(sprintf('Unknown value \'%s\' for Decision attribute.', $decision));
         }
 
         return new static(
diff --git a/src/SAML2/XML/saml/NameID.php b/src/SAML2/XML/saml/NameID.php
@@ -7,7 +7,7 @@
 use DOMElement;
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\SAML2\Compat\ContainerSingleton;
-use SimpleSAML\XML\Exception\ArrayValidationException;
+use SimpleSAML\SAML2\Exception\ArrayValidationException;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
 use SimpleSAML\XMLSecurity\Backend\EncryptionBackend;
 use SimpleSAML\XMLSecurity\XML\EncryptableElementInterface;
diff --git a/src/SAML2/XML/samlp/StatusDetail.php b/src/SAML2/XML/samlp/StatusDetail.php
@@ -76,7 +76,7 @@ public static function fromXML(DOMElement $xml): static
     /**
      * Convert this StatusDetail to XML.
      *
-     * @param \DOMElement|null $element The element we are converting to XML.
+     * @param \DOMElement|null $parent The element we are converting to XML.
      * @return \DOMElement The XML element after adding the data corresponding to this StatusDetail.
      */
     public function toXML(DOMElement $parent = null): DOMElement
diff --git a/src/SAML2/XML/shibmd/KeyAuthority.php b/src/SAML2/XML/shibmd/KeyAuthority.php
@@ -32,7 +32,7 @@ final class KeyAuthority extends AbstractShibmdElement
      * Create a KeyAuthority.
      *
      * @param \SimpleSAML\XMLSecurity\XML\ds\KeyInfo[] $keys
-     * @param int|null $verifyDepth
+     * @param int|null $VerifyDepth
      * @param list<\SimpleSAML\XML\Attribute> $namespacedAttributes
      */
     public function __construct(
@@ -101,7 +101,6 @@ public static function fromXML(DOMElement $xml): static
      */
     public function toXML(DOMElement $parent = null): DOMElement
     {
-        /** @psalm-var \DOMDocument $e->ownerDocument */
         $e = $this->instantiateParentElement($parent);
 
         foreach ($this->getAttributesNS() as $attr) {
diff --git a/src/SAML2/XML/shibmd/Scope.php b/src/SAML2/XML/shibmd/Scope.php
@@ -87,7 +87,6 @@ public static function fromXML(DOMElement $xml): static
      */
     public function toXML(DOMElement $parent = null): DOMElement
     {
-        /** @psalm-var \DOMDocument $e->ownerDocument */
         $e = $this->instantiateParentElement($parent);
         $e->textContent = $this->getContent();
         $e->setAttribute('regexp', $this->isRegexpScope() ? 'true' : 'false');
diff --git a/tests/SAML2/Assertion/ProcessorTest.php b/tests/SAML2/Assertion/ProcessorTest.php
@@ -35,7 +35,7 @@ final class ProcessorTest extends MockeryTestCase
     private static Processor $processor;
 
     /**
-     * @var m\MockInterface&Decrypter
+     * @var MockInterface&Decrypter
      */
     private static MockInterface $decrypter;
 
diff --git a/tests/SAML2/Assertion/Transformer/NameIdDecryptionTransformerTest.php b/tests/SAML2/Assertion/Transformer/NameIdDecryptionTransformerTest.php
@@ -68,7 +68,7 @@ final class NameIdDecryptionTransformerTest extends TestCase
     /** @var \SimpleSAML\SAML2\Configuration\Destination */
     protected static Destination $destination;
 
-    /** @var \SimpleSAML\SAML2\xml\samlp\Response */
+    /** @var \SimpleSAML\SAML2\XML\samlp\Response */
     protected static Response $response;
 
     /** @var string */
diff --git a/tests/SAML2/Assertion/Validation/AssertionValidatorTest.php b/tests/SAML2/Assertion/Validation/AssertionValidatorTest.php
@@ -56,7 +56,7 @@ final class AssertionValidatorTest extends TestCase
     /** @var \SimpleSAML\SAML2\Configuration\Destination */
     protected static Destination $destination;
 
-    /** @var \SimpleSAML\SAML2\xml\samlp\Response */
+    /** @var \SimpleSAML\SAML2\XML\samlp\Response */
     protected static Response $response;
 
 
diff --git a/tests/SAML2/Assertion/Validation/ConstraintValidator/SpIsValidAudienceTest.php b/tests/SAML2/Assertion/Validation/ConstraintValidator/SpIsValidAudienceTest.php
@@ -37,7 +37,7 @@ final class SpIsValidAudienceTest extends MockeryTestCase
     /** @var \SimpleSAML\SAML2\XML\saml\Conditions */
     private static Conditions $conditions;
 
-    /** @var \SimpleSAML\SAML2\XML\saml\Isssuer */
+    /** @var \SimpleSAML\SAML2\XML\saml\Issuer */
     private static Issuer $issuer;
 
     /** @var \Mockery\MockInterface */
diff --git a/tests/SAML2/Assertion/Validation/SubjectConfirmationValidatorTest.php b/tests/SAML2/Assertion/Validation/SubjectConfirmationValidatorTest.php
@@ -56,7 +56,7 @@ final class SubjectConfirmationValidatorTest extends TestCase
     /** @var \SimpleSAML\SAML2\Configuration\Destination */
     private static Destination $destination;
 
-    /** @var \SimpleSAML\SAML2\xml\samlp\Response */
+    /** @var \SimpleSAML\SAML2\XML\samlp\Response */
     private static Response $response;
 
 
diff --git a/tests/SAML2/BindingTest.php b/tests/SAML2/BindingTest.php
@@ -119,7 +119,8 @@ public function testBindingGuesserPOST(): void
         $q = ['AAP' => 'Noot'];
         $request = new ServerRequest('POST', 'http://tnyholm.se');
         $request = $request->withParsedBody($q);
-        $this->expectException(UnsupportedBindingException::class, 'Unable to find the current binding.');
+        $this->expectException(UnsupportedBindingException::class);
+        $this->expectExceptionMessage('Unable to find the SAML 2 binding used for this request.');
         Binding::getCurrentBinding($request);
     }
 
diff --git a/tests/SAML2/CustomBaseID.php b/tests/SAML2/CustomBaseID.php
@@ -10,6 +10,7 @@
 use SimpleSAML\SAML2\XML\saml\Audience;
 use SimpleSAML\Test\SAML2\Constants as C;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\Exception\SchemaViolationException;
 
 /**
  * Example class to demonstrate how BaseID can be extended.
diff --git a/tests/SAML2/CustomRoleDescriptor.php b/tests/SAML2/CustomRoleDescriptor.php
@@ -49,7 +49,7 @@ final class CustomRoleDescriptor extends AbstractRoleDescriptor
      *   Defaults to an empty array.
      * @param \SimpleSAML\SAML2\XML\md\Organization|null $organization
      *   The organization running this entity. Defaults to null.
-     * @param \SimpleSAML\SAML2\XML\md\ContactPerson[] $contacts
+     * @param \SimpleSAML\SAML2\XML\md\ContactPerson[] $contact
      *   An array of contacts for this entity. Defaults to an empty array.
      * @param list<\SimpleSAML\XML\Attribute> $namespacedAttributes
      */
diff --git a/tests/SAML2/UtilsTest.php b/tests/SAML2/UtilsTest.php
@@ -54,6 +54,8 @@ public function testXpQuery(): void
         $xpCache = XPath::getXPath($xml);
         $nameId_after = XPath::xpQuery($xml, './saml_assertion:Subject/saml_assertion:NameID', $xpCache);
         $this->assertTrue(count($nameId_after) === 1);
+
+        /** @var \DOMNode $nameId_after[0] */
         $this->assertEquals('NameIDValue', $nameId_after[0]->textContent);
         $this->assertEquals(C::NAMEID_TRANSIENT, $nameId_after[0]->getAttribute("Format"));
         $this->assertEquals('OurNameQualifier', $nameId_after[0]->getAttribute("NameQualifier"));
diff --git a/tests/SAML2/XML/samlp/MessageFactoryTest.php b/tests/SAML2/XML/samlp/MessageFactoryTest.php
@@ -46,7 +46,7 @@ public static function provideMessages(): array
 
     /**
      * @param string $file
-     * @param class-string class
+     * @param class-string $class
      * @dataProvider provideMessages
      */
     public function testMessageFactory(string $file, string $class): void
diff --git a/tests/bin/authnrequest.php b/tests/bin/authnrequest.php
@@ -3,6 +3,8 @@
 
 require_once(dirname(__FILE__, 3) . '/vendor/autoload.php');
 
+use DateTimeImmutable;
+use DateTimeZone;
 use SimpleSAML\SAML2\Compat\ContainerSingleton;
 use SimpleSAML\SAML2\Compat\MockContainer;
 use SimpleSAML\SAML2\XML\saml\EncryptedID;
@@ -11,6 +13,7 @@
 use SimpleSAML\SAML2\XML\saml\Subject;
 use SimpleSAML\SAML2\XML\samlp\AuthnRequest;
 use SimpleSAML\XMLSecurity\Alg\KeyTransport\KeyTransportAlgorithmFactory;
+use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
 
 $container = new MockContainer();
@@ -30,6 +33,7 @@
 
 $authnRequest = new AuthnRequest(
     subject: $subject,
+    issueInstant: new DateTimeImmutable('now', new DateTimeZone('Z')),
     issuer: $issuer,
     id: '123',
     destination: 'https://tiqr.example.org/idp/profile/saml2/Redirect/SSO',
diff --git a/tests/bin/encryptedassertion.php b/tests/bin/encryptedassertion.php
@@ -9,6 +9,7 @@
 use SimpleSAML\SAML2\XML\saml\EncryptedAssertion;
 use SimpleSAML\XML\DOMDocumentFactory;
 use SimpleSAML\XMLSecurity\Alg\KeyTransport\KeyTransportAlgorithmFactory;
+use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
 
 $container = new MockContainer();
diff --git a/tests/bin/encryptedattribute.php b/tests/bin/encryptedattribute.php
@@ -9,6 +9,7 @@
 use SimpleSAML\SAML2\XML\saml\AttributeValue;
 use SimpleSAML\SAML2\XML\saml\EncryptedAttribute;
 use SimpleSAML\XMLSecurity\Alg\KeyTransport\KeyTransportAlgorithmFactory;
+use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
 
 $container = new MockContainer();
@@ -20,8 +21,8 @@
     PEMCertificatesMock::getPublicKey(PEMCertificatesMock::PUBLIC_KEY)
 );
 $attribute = new Attribute(
-    Name: 'urn:encrypted:attribute',
-    AttributeValues: [new AttributeValue('very secret data')],
+    name: 'urn:encrypted:attribute',
+    attributeValue: [new AttributeValue('very secret data')],
 );
 $encAttribute = new EncryptedAttribute($attribute->encrypt($encryptor));
 
diff --git a/tests/bin/encryptedid.php b/tests/bin/encryptedid.php
@@ -8,6 +8,7 @@
 use SimpleSAML\SAML2\XML\saml\EncryptedID;
 use SimpleSAML\SAML2\XML\saml\NameID;
 use SimpleSAML\XMLSecurity\Alg\KeyTransport\KeyTransportAlgorithmFactory;
+use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
 
 $container = new MockContainer();
diff --git a/tests/bin/entityattributes.php b/tests/bin/entityattributes.php
@@ -3,6 +3,8 @@
 
 namespace SimpleSAML;
 
+use DateTimeImmutable;
+use DateTimeZone;
 use SimpleSAML\SAML2\Constants as C;
 use SimpleSAML\SAML2\XML\mdattr\EntityAttributes;
 use SimpleSAML\SAML2\XML\saml\Assertion;
@@ -27,6 +29,7 @@
 
 $unsignedAssertion = new Assertion(
     issuer: new Issuer('testIssuer'),
+    issueInstant: new DateTimeImmutable('now', new DateTimeZone('Z')),
     id: '_93af655219464fb403b34436cfb0c5cb1d9a5502',
     subject: new Subject(new NameID(
         value: 'some:entity',
@@ -43,43 +46,43 @@
     ),
     statements: [new AttributeStatement([
         new Attribute(
-            Name: 'urn:mace:dir:attribute-def:uid',
-            NameFormat: C::NAMEFORMAT_URI,
-            AttibuteValues: [new AttributeValue('student2')],
+            name: 'urn:mace:dir:attribute-def:uid',
+            nameFormat: C::NAMEFORMAT_URI,
+            attributeValue: [new AttributeValue('student2')],
         ),
         new Attribute(
-            Name: 'urn:mace:terena.org:attribute-def:schacHomeOrganization',
-            NameFormat: C::NAMEFORMAT_URI,
-            AttributesValues: [new AttributeValue('university.example.org'), new AttributeValue('bbb.cc')],
+            name: 'urn:mace:terena.org:attribute-def:schacHomeOrganization',
+            nameFormat: C::NAMEFORMAT_URI,
+            attributeValue: [new AttributeValue('university.example.org'), new AttributeValue('bbb.cc')],
         ),
         new Attribute(
-            Name: 'urn:schac:attribute-def:schacPersonalUniqueCode',
-            NameFormat: C::NAMEFORMAT_URI,
-            AttributeValues: [
+            name: 'urn:schac:attribute-def:schacPersonalUniqueCode',
+            nameFormat: C::NAMEFORMAT_URI,
+            attributeValue: [
                 new AttributeValue('urn:schac:personalUniqueCode:nl:local:uvt.nl:memberid:524020'),
                 new AttributeValue('urn:schac:personalUniqueCode:nl:local:surfnet.nl:studentid:12345'),
             ],
         ),
         new Attribute(
-            Name: 'urn:mace:dir:attribute-def:eduPersonAffiliation',
-            NameFormat: C::NAMEFORMAT_URI,
-            AttributeValues: [new AttributeValue('member'), new AttributeValue('student')],
+            name: 'urn:mace:dir:attribute-def:eduPersonAffiliation',
+            nameFormat: C::NAMEFORMAT_URI,
+            attributeValue: [new AttributeValue('member'), new AttributeValue('student')],
         ),
     ])],
 );
 $unsignedAssertion->sign($signer);
 $signedAssertion = Assertion::fromXML($unsignedAssertion->toXML());
 $entityAttributes = new EntityAttributes([
     new Attribute(
-        Name: 'attrib1',
-        NameFormat: C::NAMEFORMAT_URI,
-        AttributeValues: [new AttributeValue('is'), new AttributeValue('really'), new AttributeValue('cool')],
+        name: 'attrib1',
+        nameFormat: C::NAMEFORMAT_URI,
+        attributeValue: [new AttributeValue('is'), new AttributeValue('really'), new AttributeValue('cool')],
     ),
     $signedAssertion,
     new Attribute(
-        Name: 'foo',
-        NameFormat: 'urn:simplesamlphp:v1:simplesamlphp',
-        AttributeValues: [new AttributeValue('is'), new AttributeValue('really'), new AttributeValue('cool')],
+        name: 'foo',
+        nameFormat: 'urn:simplesamlphp:v1:simplesamlphp',
+        attributeValue: [new AttributeValue('is'), new AttributeValue('really'), new AttributeValue('cool')],
     ),
 ]);
 
diff --git a/tests/bin/logoutrequest.php b/tests/bin/logoutrequest.php
@@ -3,6 +3,8 @@
 
 require_once(dirname(__FILE__, 3) . '/vendor/autoload.php');
 
+use DateTimeImmutable;
+use DateTimeZone;
 use SimpleSAML\SAML2\Compat\ContainerSingleton;
 use SimpleSAML\SAML2\Compat\MockContainer;
 use SimpleSAML\SAML2\XML\saml\EncryptedID;
@@ -11,6 +13,7 @@
 use SimpleSAML\SAML2\XML\samlp\LogoutRequest;
 use SimpleSAML\SAML2\XML\samlp\SessionIndex;
 use SimpleSAML\XMLSecurity\Alg\KeyTransport\KeyTransportAlgorithmFactory;
+use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
 
 $container = new MockContainer();
@@ -26,6 +29,7 @@
 
 $logoutRequest = new LogoutRequest(
     identifier: $eid,
+    issueInstant: new DateTimeImmutable('now', new DateTimeZone('Z')),
     sessionIndexes: [new SessionIndex('SomeSessionIndex1'), new SessionIndex('SomeSessionIndex2')],
     issuer: new Issuer('urn:test:TheIssuer')
 );
diff --git a/tests/bin/signedassertion.php b/tests/bin/signedassertion.php
@@ -6,6 +6,7 @@
 use SimpleSAML\SAML2\XML\saml\Assertion;
 use SimpleSAML\XML\DOMDocumentFactory;
 use SimpleSAML\XMLSecurity\Alg\Signature\SignatureAlgorithmFactory;
+use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
 
 $document = DOMDocumentFactory::fromFile(dirname(__FILE__, 2) . '/resources/xml/saml_Assertion.xml');
diff --git a/tests/bin/signedassertion_tampered.php b/tests/bin/signedassertion_tampered.php
@@ -6,6 +6,7 @@
 use SimpleSAML\SAML2\XML\saml\Assertion;
 use SimpleSAML\XML\DOMDocumentFactory;
 use SimpleSAML\XMLSecurity\Alg\Signature\SignatureAlgorithmFactory;
+use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
 
 $document = DOMDocumentFactory::fromFile(dirname(__FILE__, 2) . '/resources/xml/saml_Assertion.xml');
diff --git a/tests/bin/signedassertion_with_comments.php b/tests/bin/signedassertion_with_comments.php
@@ -6,6 +6,7 @@
 use SimpleSAML\SAML2\XML\saml\Assertion;
 use SimpleSAML\XML\DOMDocumentFactory;
 use SimpleSAML\XMLSecurity\Alg\Signature\SignatureAlgorithmFactory;
+use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
 
 $document = DOMDocumentFactory::fromFile(dirname(__FILE__, 2) . '/resources/xml/saml_Assertion.xml');
diff --git a/tests/bin/signedresponse_with_signedassertion.php b/tests/bin/signedresponse_with_signedassertion.php
@@ -3,7 +3,10 @@
 
 require_once(dirname(__FILE__, 3) . '/vendor/autoload.php');
 
+use DateTimeImmutable;
+use DateTimeZone;
 use SimpleSAML\SAML2\XML\saml\Assertion;
+use SimpleSAML\SAML2\XML\saml\Issuer;
 use SimpleSAML\SAML2\XML\samlp\Response;
 use SimpleSAML\SAML2\XML\samlp\Status;
 use SimpleSAML\SAML2\XML\samlp\StatusCode;
@@ -24,7 +27,8 @@
 
 $unsignedResponse = new Response(
     status: new Status(new StatusCode(C::STATUS_SUCCESS)),
-    issuer: Issuer('https://IdentityProvider.com'),
+    issuer: new Issuer('https://IdentityProvider.com'),
+    issueInstant: new DateTimeImmutable('now', new DateTimeZone('Z')),
     id: 'abc123',
     inResponseTo: 'PHPUnit',
     destination: C::ENTITY_OTHER,
diff --git a/tests/bin/signedresponse_with_unsignedassertion.php b/tests/bin/signedresponse_with_unsignedassertion.php
@@ -3,11 +3,14 @@
 
 require_once(dirname(__FILE__, 3) . '/vendor/autoload.php');
 
+use DateTimeImmutable;
+use DateTimeZone;
 use SimpleSAML\SAML2\XML\saml\Assertion;
 use SimpleSAML\SAML2\XML\saml\Issuer;
 use SimpleSAML\SAML2\XML\samlp\Response;
 use SimpleSAML\SAML2\XML\samlp\Status;
 use SimpleSAML\SAML2\XML\samlp\StatusCode;
+use SimpleSAML\Test\SAML2\Constants as C;
 use SimpleSAML\XML\DOMDocumentFactory;
 use SimpleSAML\XMLSecurity\Alg\Signature\SignatureAlgorithmFactory;
 use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
@@ -18,6 +21,7 @@
 $unsignedResponse = new Response(
     status: new Status(new StatusCode(C::STATUS_SUCCESS)),
     issuer: new Issuer('https://IdentityProvider.com'),
+    issueInstant: new DateTimeImmutable('now', new DateTimeZone('Z')),
     id: 'abc123',
     inResponseTo: 'PHPUnit',
     destination: C::ENTITY_OTHER,
diff --git a/tests/bin/unsignedresponse_with_signedassertion.php b/tests/bin/unsignedresponse_with_signedassertion.php

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ public static function fromXML(DOMElement $xml): static`
`76`	`76`	`/**`
`77`	`77`	`* Convert this StatusDetail to XML.`
`78`	`78`	`*`
`79`		`- * @param \DOMElement\|null $element The element we are converting to XML.`
	`79`	`+ * @param \DOMElement\|null $parent The element we are converting to XML.`
`80`	`80`	`* @return \DOMElement The XML element after adding the data corresponding to this StatusDetail.`
`81`	`81`	`*/`
`82`	`82`	`public function toXML(DOMElement $parent = null): DOMElement`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,6 @@ public static function fromXML(DOMElement $xml): static`
`87`	`87`	`*/`
`88`	`88`	`public function toXML(DOMElement $parent = null): DOMElement`
`89`	`89`	`{`
`90`		`- /** @psalm-var \DOMDocument $e->ownerDocument */`
`91`	`90`	`$e = $this->instantiateParentElement($parent);`
`92`	`91`	`$e->textContent = $this->getContent();`
`93`	`92`	`$e->setAttribute('regexp', $this->isRegexpScope() ? 'true' : 'false');`