Fix namespaced IncludeToken-attribute (both sp-versions and coverage)

tvdijen · tvdijen · commit 5c34f92ae78d · 2026-06-16T19:12:32.000+02:00
diff --git a/src/XML/sp_200507/Type/IncludeTokenValue.php b/src/XML/sp_200507/Type/IncludeTokenValue.php
@@ -4,16 +4,35 @@
 
 namespace SimpleSAML\WebServices\SecurityPolicy\XML\sp_200507\Type;
 
+use SimpleSAML\Assert\Assert;
 use SimpleSAML\WebServices\SecurityPolicy\XML\sp_200507\AbstractSpElement;
 use SimpleSAML\WebServices\SecurityPolicy\XML\sp_200507\IncludeToken;
 use SimpleSAML\XML\Attribute as XMLAttribute;
-use SimpleSAML\XMLSchema\Type\AnyURIValue as BaseAnyURIValue;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
+use SimpleSAML\XMLSchema\Type\AnyURIValue;
+
+use function array_column;
 
 /**
  * @package simplesaml/xml-ws-security-policy
  */
-class IncludeTokenValue extends BaseAnyURIValue
+class IncludeTokenValue extends AnyURIValue
 {
+    /**
+     * Validate the value.
+     *
+     * @throws \SimpleSAML\XMLSchema\Exception\SchemaViolationException on failure
+     */
+    protected function validateValue(string $value): void
+    {
+        Assert::oneOf(
+            $this->sanitizeValue($value),
+            array_column(IncludeToken::cases(), 'value'),
+            SchemaViolationException::class,
+        );
+    }
+
+
     /**
      * Convert this value to an attribute
      *
diff --git a/src/XML/sp_200702/AbstractIssuedTokenType.php b/src/XML/sp_200702/AbstractIssuedTokenType.php
@@ -25,6 +25,7 @@ abstract class AbstractIssuedTokenType extends AbstractSpElement
 {
     use ExtendableAttributesTrait;
     use ExtendableElementTrait;
+    use IncludeTokenTypeTrait;
 
 
     /** The namespace-attribute for the xs:any element */
@@ -54,6 +55,7 @@ final public function __construct(
         array $elts = [],
         array $namespacedAttributes = [],
     ) {
+        $this->setIncludeToken($namespacedAttributes);
         $this->setElements($elts);
         $this->setAttributesNS($namespacedAttributes);
     }
diff --git a/src/XML/sp_200702/AbstractKeyValueTokenType.php b/src/XML/sp_200702/AbstractKeyValueTokenType.php
@@ -22,6 +22,7 @@ abstract class AbstractKeyValueTokenType extends AbstractSpElement
 {
     use ExtendableAttributesTrait;
     use ExtendableElementTrait;
+    use IncludeTokenTypeTrait;
 
 
     /** The namespace-attribute for the xs:any element */
@@ -41,6 +42,7 @@ final public function __construct(
         array $elts = [],
         array $namespacedAttributes = [],
     ) {
+        $this->setIncludeToken($namespacedAttributes);
         $this->setElements($elts);
         $this->setAttributesNS($namespacedAttributes);
     }
diff --git a/src/XML/sp_200702/AbstractSecureConversationTokenType.php b/src/XML/sp_200702/AbstractSecureConversationTokenType.php
@@ -23,6 +23,7 @@ abstract class AbstractSecureConversationTokenType extends AbstractSpElement
 {
     use ExtendableAttributesTrait;
     use ExtendableElementTrait;
+    use IncludeTokenTypeTrait;
 
 
     /** The namespace-attribute for the xs:any element */
@@ -48,6 +49,7 @@ final public function __construct(
         array $elts = [],
         array $namespacedAttributes = [],
     ) {
+        $this->setIncludeToken($namespacedAttributes);
         $this->setElements($elts);
         $this->setAttributesNS($namespacedAttributes);
     }
diff --git a/src/XML/sp_200702/AbstractSpnegoContextTokenType.php b/src/XML/sp_200702/AbstractSpnegoContextTokenType.php
@@ -23,6 +23,7 @@ abstract class AbstractSpnegoContextTokenType extends AbstractSpElement
 {
     use ExtendableAttributesTrait;
     use ExtendableElementTrait;
+    use IncludeTokenTypeTrait;
 
 
     /** The namespace-attribute for the xs:any element */
@@ -48,6 +49,7 @@ final public function __construct(
         array $elts = [],
         array $namespacedAttributes = [],
     ) {
+        $this->setIncludeToken($namespacedAttributes);
         $this->setElements($elts);
         $this->setAttributesNS($namespacedAttributes);
     }
diff --git a/src/XML/sp_200702/AbstractTokenAssertionType.php b/src/XML/sp_200702/AbstractTokenAssertionType.php
@@ -22,6 +22,7 @@ abstract class AbstractTokenAssertionType extends AbstractSpElement
 {
     use ExtendableAttributesTrait;
     use ExtendableElementTrait;
+    use IncludeTokenTypeTrait;
 
 
     /** The namespace-attribute for the xs:any element */
@@ -41,6 +42,7 @@ final public function __construct(
         array $elts = [],
         array $namespacedAttributes = [],
     ) {
+        $this->setIncludeToken($namespacedAttributes);
         $this->setElements($elts);
         $this->setAttributesNS($namespacedAttributes);
     }
diff --git a/src/XML/sp_200702/Type/IncludeTokenValue.php b/src/XML/sp_200702/Type/IncludeTokenValue.php
@@ -4,16 +4,33 @@
 
 namespace SimpleSAML\WebServices\SecurityPolicy\XML\sp_200702\Type;
 
+use SimpleSAML\Assert\Assert;
 use SimpleSAML\WebServices\SecurityPolicy\XML\sp_200702\AbstractSpElement;
 use SimpleSAML\WebServices\SecurityPolicy\XML\sp_200702\IncludeToken;
 use SimpleSAML\XML\Attribute as XMLAttribute;
-use SimpleSAML\XMLSchema\Type\AnyURIValue as BaseAnyURIValue;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
+use SimpleSAML\XMLSchema\Type\AnyURIValue;
 
 /**
  * @package simplesaml/xml-ws-security-policy
  */
-class IncludeTokenValue extends BaseAnyURIValue
+class IncludeTokenValue extends AnyURIValue
 {
+    /**
+     * Validate the value.
+     *
+     * @throws \SimpleSAML\XMLSchema\Exception\SchemaViolationException on failure
+     */
+    protected function validateValue(string $value): void
+    {
+        Assert::oneOf(
+            $this->sanitizeValue($value),
+            array_column(IncludeToken::cases(), 'value'),
+            SchemaViolationException::class,
+        );
+    }
+
+
     /**
      * Convert this value to an attribute
      *
diff --git a/tests/SecurityPolicy/XML/sp_200507/IssuedTokenTest.php b/tests/SecurityPolicy/XML/sp_200507/IssuedTokenTest.php
@@ -193,5 +193,8 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($issuedToken),
         );
+
+        $this->assertFalse($issuedToken->isEmptyElement());
+        $this->assertEquals($issuedToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200507/SecureConversationTokenTest.php b/tests/SecurityPolicy/XML/sp_200507/SecureConversationTokenTest.php
@@ -181,5 +181,11 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($secureConversationToken),
         );
+
+        $this->assertFalse($secureConversationToken->isEmptyElement());
+        $this->assertEquals(
+            $secureConversationToken->getIncludeToken(),
+            IncludeTokenValue::fromEnum(IncludeToken::Always),
+        );
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200507/SpnegoContextTokenTest.php b/tests/SecurityPolicy/XML/sp_200507/SpnegoContextTokenTest.php
@@ -181,5 +181,8 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($spnegoContextToken),
         );
+
+        $this->assertFalse($spnegoContextToken->isEmptyElement());
+        $this->assertEquals($spnegoContextToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200507/Type/IncludeTokenValueTest.php b/tests/SecurityPolicy/XML/sp_200507/Type/IncludeTokenValueTest.php
@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\WebServices\SecurityPolicy\XML\sp_200507\Type;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Group;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\WebServices\SecurityPolicy\Constants as C;
+use SimpleSAML\WebServices\SecurityPolicy\XML\sp_200507\IncludeToken;
+use SimpleSAML\WebServices\SecurityPolicy\XML\sp_200507\Type\IncludeTokenValue;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
+
+/**
+ * Class \SimpleSAML\Test\WebServices\SecurityPolicy\XML\sp_200507\Type\IncludeTokenValueTest
+ *
+ * @package simplesamlphp/xml-ws-security-policy
+ */
+#[Group('type')]
+#[CoversClass(IncludeTokenValue::class)]
+final class IncludeTokenValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $uri
+     */
+    #[DataProvider('provideURI')]
+    public function testIncludeToken(bool $shouldPass, string $uri): void
+    {
+        try {
+            IncludeTokenValue::fromString($uri);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * Test helpers
+     */
+    public function testToAttribute(): void
+    {
+        $includeToken = IncludeTokenValue::fromString(IncludeToken::Always->value);
+        $attr = $includeToken->toAttribute();
+
+        $this->assertEquals($attr->getNamespaceURI(), C::NS_SEC_POLICY_11);
+        $this->assertEquals($attr->getNamespacePrefix(), 'sp');
+        $this->assertEquals($attr->getAttrName(), 'IncludeToken');
+        $this->assertEquals($attr->getAttrValue(), IncludeToken::Always->value);
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideURI(): array
+    {
+        return [
+            'Always' => [true, IncludeToken::Always->value],
+            'AlwaysToRecipient' => [true, IncludeToken::AlwaysToRecipient->value],
+            'Once' => [true, IncludeToken::Once->value],
+            'Never' => [true, IncludeToken::Never->value],
+            'urn' => [false, 'urn:x-simplesamlphp:phpunit'],
+            'same-doc' => [false, '#_53d830ab1be17291a546c95c7f1cdf8d3d23c959e6'],
+            'url' => [false, 'https://www.simplesamlphp.org'],
+            'diacritical' => [false, 'https://aä.com'],
+            'spn' => [false, 'spn:a4cf592f-a64c-46ff-a788-b260f474525b'],
+            'typos' => [false, 'https//www.uni.l/en/'],
+            'spaces' => [false, 'this is silly'],
+            'empty' => [false, ''],
+            'azure-common' => [false, 'https://sts.windows.net/{tenantid}/'],
+        ];
+    }
+}
diff --git a/tests/SecurityPolicy/XML/sp_200702/HttpsTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/HttpsTokenTest.php
@@ -83,5 +83,8 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($httpsToken),
         );
+
+        $this->assertFalse($httpsToken->isEmptyElement());
+        $this->assertEquals($httpsToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200702/IssuedTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/IssuedTokenTest.php
@@ -123,5 +123,8 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($issuedToken),
         );
+
+        $this->assertFalse($issuedToken->isEmptyElement());
+        $this->assertEquals($issuedToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200702/KerberosTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/KerberosTokenTest.php
@@ -83,5 +83,8 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($kerberosToken),
         );
+
+        $this->assertFalse($kerberosToken->isEmptyElement());
+        $this->assertEquals($kerberosToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200702/KeyValueTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/KeyValueTokenTest.php
@@ -83,5 +83,8 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($keyValueToken),
         );
+
+        $this->assertFalse($keyValueToken->isEmptyElement());
+        $this->assertEquals($keyValueToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200702/RelTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/RelTokenTest.php
@@ -83,5 +83,8 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($relToken),
         );
+
+        $this->assertFalse($relToken->isEmptyElement());
+        $this->assertEquals($relToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200702/SamlTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/SamlTokenTest.php
@@ -79,9 +79,13 @@ public function testMarshalling(): void
 
         $includeToken = IncludeTokenValue::fromEnum(IncludeToken::Always);
         $samlToken = new SamlToken([$chunk], [$includeToken->toAttribute(), $attr]);
+
         $this->assertEquals(
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($samlToken),
         );
+
+        $this->assertFalse($samlToken->isEmptyElement());
+        $this->assertEquals($samlToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200702/SecureConversationTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/SecureConversationTokenTest.php
@@ -113,5 +113,11 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($secureConversationToken),
         );
+
+        $this->assertFalse($secureConversationToken->isEmptyElement());
+        $this->assertEquals(
+            $secureConversationToken->getIncludeToken(),
+            IncludeTokenValue::fromEnum(IncludeToken::Always),
+        );
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200702/SecurityContextTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/SecurityContextTokenTest.php
@@ -79,9 +79,16 @@ public function testMarshalling(): void
 
         $includeToken = IncludeTokenValue::fromEnum(IncludeToken::Always);
         $securityContextToken = new SecurityContextToken([$chunk], [$includeToken->toAttribute(), $attr]);
+
         $this->assertEquals(
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($securityContextToken),
         );
+
+        $this->assertFalse($securityContextToken->isEmptyElement());
+        $this->assertEquals(
+            $securityContextToken->getIncludeToken(),
+            IncludeTokenValue::fromEnum(IncludeToken::Always),
+        );
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200702/SpnegoContextTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/SpnegoContextTokenTest.php
@@ -104,5 +104,8 @@ public function testMarshalling(): void
             self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
             strval($spnegoContextToken),
         );
+
+        $this->assertFalse($spnegoContextToken->isEmptyElement());
+        $this->assertEquals($spnegoContextToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));
     }
 }
diff --git a/tests/SecurityPolicy/XML/sp_200702/Type/IncludeTokenValueTest.php b/tests/SecurityPolicy/XML/sp_200702/Type/IncludeTokenValueTest.php
diff --git a/tests/SecurityPolicy/XML/sp_200702/UsernameTokenTest.php b/tests/SecurityPolicy/XML/sp_200702/UsernameTokenTest.php
diff --git a/tests/SecurityPolicy/XML/sp_200702/X509TokenTest.php b/tests/SecurityPolicy/XML/sp_200702/X509TokenTest.php

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ abstract class AbstractIssuedTokenType extends AbstractSpElement`
`25`	`25`	`{`
`26`	`26`	`use ExtendableAttributesTrait;`
`27`	`27`	`use ExtendableElementTrait;`
	`28`	`+ use IncludeTokenTypeTrait;`
`28`	`29`
`29`	`30`
`30`	`31`	`/** The namespace-attribute for the xs:any element */`
`@@ -54,6 +55,7 @@ final public function __construct(`
`54`	`55`	`array $elts = [],`
`55`	`56`	`array $namespacedAttributes = [],`
`56`	`57`	`) {`
	`58`	`+ $this->setIncludeToken($namespacedAttributes);`
`57`	`59`	`$this->setElements($elts);`
`58`	`60`	`$this->setAttributesNS($namespacedAttributes);`
`59`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ abstract class AbstractKeyValueTokenType extends AbstractSpElement`
`22`	`22`	`{`
`23`	`23`	`use ExtendableAttributesTrait;`
`24`	`24`	`use ExtendableElementTrait;`
	`25`	`+ use IncludeTokenTypeTrait;`
`25`	`26`
`26`	`27`
`27`	`28`	`/** The namespace-attribute for the xs:any element */`
`@@ -41,6 +42,7 @@ final public function __construct(`
`41`	`42`	`array $elts = [],`
`42`	`43`	`array $namespacedAttributes = [],`
`43`	`44`	`) {`
	`45`	`+ $this->setIncludeToken($namespacedAttributes);`
`44`	`46`	`$this->setElements($elts);`
`45`	`47`	`$this->setAttributesNS($namespacedAttributes);`
`46`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ abstract class AbstractSecureConversationTokenType extends AbstractSpElement`
`23`	`23`	`{`
`24`	`24`	`use ExtendableAttributesTrait;`
`25`	`25`	`use ExtendableElementTrait;`
	`26`	`+ use IncludeTokenTypeTrait;`
`26`	`27`
`27`	`28`
`28`	`29`	`/** The namespace-attribute for the xs:any element */`
`@@ -48,6 +49,7 @@ final public function __construct(`
`48`	`49`	`array $elts = [],`
`49`	`50`	`array $namespacedAttributes = [],`
`50`	`51`	`) {`
	`52`	`+ $this->setIncludeToken($namespacedAttributes);`
`51`	`53`	`$this->setElements($elts);`
`52`	`54`	`$this->setAttributesNS($namespacedAttributes);`
`53`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -193,5 +193,8 @@ public function testMarshalling(): void`
`193`	`193`	`self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),`
`194`	`194`	`strval($issuedToken),`
`195`	`195`	`);`
	`196`	`+`
	`197`	`+ $this->assertFalse($issuedToken->isEmptyElement());`
	`198`	`+ $this->assertEquals($issuedToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));`
`196`	`199`	`}`
`197`	`200`	`}`
Original file line number	Diff line number	Diff line change
`@@ -181,5 +181,11 @@ public function testMarshalling(): void`
`181`	`181`	`self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),`
`182`	`182`	`strval($secureConversationToken),`
`183`	`183`	`);`
	`184`	`+`
	`185`	`+ $this->assertFalse($secureConversationToken->isEmptyElement());`
	`186`	`+ $this->assertEquals(`
	`187`	`+ $secureConversationToken->getIncludeToken(),`
	`188`	`+ IncludeTokenValue::fromEnum(IncludeToken::Always),`
	`189`	`+ );`
`184`	`190`	`}`
`185`	`191`	`}`
Original file line number	Diff line number	Diff line change
`@@ -181,5 +181,8 @@ public function testMarshalling(): void`
`181`	`181`	`self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),`
`182`	`182`	`strval($spnegoContextToken),`
`183`	`183`	`);`
	`184`	`+`
	`185`	`+ $this->assertFalse($spnegoContextToken->isEmptyElement());`
	`186`	`+ $this->assertEquals($spnegoContextToken->getIncludeToken(), IncludeTokenValue::fromEnum(IncludeToken::Always));`
`184`	`187`	`}`
`185`	`188`	`}`