Add auth:ClaimType

1

@@ -0,0 +1,26 @@
+# This is a combination of 2 commits.
+# This is the 1st commit message:
+
+Add auth:ClaimType
+
+# This is the commit message #2:
+
+#dd auth:ClaimType
+
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+#
+# Date:      Sat Jul 29 17:32:16 2023 +0200
+#
+# interactive rebase in progress; onto 5a63e8d
+# Last commands done (4 commands done):
+#    pick c7752fb Add auth:ClaimType
+#    squash 7ebaaf7 Add auth:ClaimType
+# No commands remaining.
+# You are currently rebasing branch 'master' on '5a63e8d'.
+#
+# Changes to be committed:
+#	modified:   resources/schemas/ws-authorization.xsd
+#	new file:   src/XML/auth/AbstractClaimType.php
+#	new file:   src/XML/auth/ClaimType.php
+#

resources/schemas/ws-authorization.xsd

@@ -142,4 +142,4 @@ MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
     </xs:choice>
   </xs:complexType>
 
-</xs:schema>
+</xs:schema>

src/XML/auth/AbstractClaimType.php

@@ -0,0 +1,237 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\WSSecurity\XML\auth;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\WSSecurity\Constants as C;
+use SimpleSAML\WSSecurity\XML\auth\ConstrainedValue;
+use SimpleSAML\WSSecurity\XML\auth\Description;
+use SimpleSAML\WSSecurity\XML\auth\DisplayName;
+use SimpleSAML\WSSecurity\XML\auth\DisplayValue;
+use SimpleSAML\WSSecurity\XML\auth\EncryptedValue;
+use SimpleSAML\WSSecurity\XML\auth\StructuredValue;
+use SimpleSAML\WSSecurity\XML\auth\Value;
+use SimpleSAML\XML\Chunk;
+use SimpleSAML\XML\ExtendableAttributesTrait;
+use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\Exception\MissingElementException;
+use SimpleSAML\XML\Exception\TooManyElementsException;
+use SimpleSAML\XML\SerializableElementInterface;
+
+use function array_filter;
+use function array_merge;
+use function array_pop;
+
+/**
+ * Class defining the ClaimType element
+ *
+ * @package tvdijen/ws-security
+ */
+abstract class AbstractClaimType extends AbstractAuthElement
+{
+    use ExtendableAttributesTrait;
+
+    /** The namespace-attribute for the xs:anyAttribute */
+    public const XS_ANY_ATTR_NAMESPACE = C::XS_ANY_NS_OTHER;
+
+
+    /**
+     * AbstractClaimType constructor
+     *
+     * @param string $uri
+     * @param bool|null $optional
+     * @param \SimpleSAML\WSSecurity\XML\auth\DisplayName|null $displayName
+     * @param \SimpleSAML\WSSecurity\XML\auth\Description|null $description
+     * @param \SimpleSAML\WSSecurity\XML\auth\DisplayValue|null $displayValue
+     * @param (
+     *   \SimpleSAML\WSSecurity\XML\auth\Value|
+     *   \SimpleSAML\WSSecurity\XML\auth\EncryptedValue|
+     *   \SimpleSAML\WSSecurity\XML\auth\StructuredValue|
+     *   \SimpleSAML\WSSecurity\XML\auth\ConstrainedValue|
+     *   \SimpleSAML\XML\SerializableElementInterface|
+     *   null
+     * ) $value
+     * @param list<\SimpleSAML\XML\Attribute> $namespacedAttributes
+     */
+    public function __construct(
+        protected string $uri,
+        protected ?bool $optional = null,
+        protected ?DisplayName $displayName = null,
+        protected ?Description $description = null,
+        protected ?DisplayValue $displayValue = null,
+        protected null|Value|EncryptedValue|StructuredValue|ConstrainedValue|SerializableElementInterface $value = null,
+        array $namespacedAttributes = [],
+    ) {
+        Assert::validURI($uri);
+        if (
+            !($value === null ||
+                $value instanceof Value ||
+                $value instanceof ConstrainedValue ||
+                $value instanceof StructuredValue ||
+                $value instanceof EncryptedValue)
+        ) {
+            /** @psalm-var \SimpleSAML\XML\AbstractElement|\SimpleSAML\XML\Chunk $value */
+            Assert::notSame($value->getNamespaceURI(), static::NS);
+        }
+        $this->setAttributesNS($namespacedAttributes);
+    }
+
+
+    /**
+     * Get the value of the $value property.
+     *
+     * @return (
+     *   \SimpleSAML\WSSecurity\XML\auth\Value|
+     *   \SimpleSAML\WSSecurity\XML\auth\EncryptedValue|
+     *   \SimpleSAML\WSSecurity\XML\auth\StructuredValue|
+     *   \SimpleSAML\WSSecurity\XML\auth\ConstrainedValue|
+     *   \SimpleSAML\XML\SerializableElementInterface|
+     *   null
+     * ) $value
+     */
+    public function getValue(): null|Value|EncryptedValue|StructuredValue|ConstrainedValue|SerializableElementInterface
+    {
+        return $this->value;
+    }
+
+
+    /**
+     * Get the value of the displayName property.
+     *
+     * @return \SimpleSAML\WSSecurity\XML\auth\DisplayName|null
+     */
+    public function getDisplayName(): ?DisplayName
+    {
+        return $this->displayName;
+    }
+
+
+    /**
+     * Get the value of the displayValue property.
+     *
+     * @return \SimpleSAML\WSSecurity\XML\auth\DisplayValue|null
+     */
+    public function getDisplayValue(): ?DisplayValue
+    {
+        return $this->displayValue;
+    }
+
+
+    /**
+     * Get the value of the description property.
+     *
+     * @return \SimpleSAML\WSSecurity\XML\auth\Description|null
+     */
+    public function getDescription(): ?Description
+    {
+        return $this->description;
+    }
+
+
+    /**
+     * Get the value of the uri property.
+     *
+     * @return string
+     */
+    public function getURI(): string
+    {
+        return $this->uri;
+    }
+
+
+    /**
+     * Get the value of the optional property.
+     *
+     * @return bool|null
+     */
+    public function getOptional(): ?bool
+    {
+        return $this->optional;
+    }
+
+
+    /**
+     * Create an instance of this object from its XML representation.
+     *
+     * @param \DOMElement $xml
+     * @return static
+     *
+     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
+     *   if the qualified name of the supplied element is wrong
+     */
+    public static function fromXML(DOMElement $xml): static
+    {
+        Assert::same($xml->localName, static::getLocalName(), InvalidDOMElementException::class);
+        Assert::same($xml->namespaceURI, static::NS, InvalidDOMElementException::class);
+
+        $displayName = DisplayName::getChildrenOfClass($xml);
+        Assert::maxCount($displayName, 1, TooManyElementsException::class);
+
+        $displayValue = DisplayValue::getChildrenOfClass($xml);
+        Assert::maxCount($displayValue, 1, TooManyElementsException::class);
+
+        $description = Description::getChildrenOfClass($xml);
+        Assert::maxCount($description, 1, TooManyElementsException::class);
+
+        $simpleValue = Value::getChildrenOfClass($xml);
+        $structuredValue = StructuredValue::getChildrenOfClass($xml);
+        $encryptedValue = EncryptedValue::getChildrenOfClass($xml);
+        $constrainedValue = ConstrainedValue::getChildrenOfClass($xml);
+
+        $otherValue = [];
+        foreach ($xml->childNodes as $child) {
+            if ($child->namespaceURI !== static::NS) {
+                $otherValue[] = new Chunk($child);
+            }
+        }
+
+        $value = array_filter(array_merge(
+            $simpleValue,
+            $structuredValue,
+            $encryptedValue,
+            $constrainedValue,
+        ));
+        Assert::maxCount($value, 1, TooManyElementsException::class);
+
+        return new static(
+            self::getAttribute($xml, 'Uri'),
+            self::getOptionalBooleanAttribute($xml, 'Optional', null),
+            array_pop($displayName),
+            array_pop($description),
+            array_pop($displayValue),
+            array_pop($value),
+            self::getAttributesNSFromXML($xml),
+        );
+    }
+
+
+    /**
+     * Add this ClaimType to an XML element.
+     *
+     * @param \DOMElement $parent The element we should append this username token to.
+     * @return \DOMElement
+     */
+    public function toXML(DOMElement $parent = null): DOMElement
+    {
+        $e = $this->instantiateParentElement($parent);
+
+        $e->setAttribute('Uri', $this->getURI());
+        if ($this->getOptional() !== null) {
+            $e->setAttribute('Optional', $this->getOptional() ? 'true' : 'false');
+        }
+
+        $this->getDisplayName()?->toXML($e);
+        $this->getDescription()?->toXML($e);
+        $this->getDisplayValue()?->toXML($e);
+        $this->getValue()->toXML($e);
+
+        foreach ($this->getAttributesNS() as $attr) {
+            $attr->toXML($e);
+        }
+
+        return $e;
+    }
+}

src/XML/auth/ClaimType.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\WSSecurity\XML\auth;
+
+/**
+ * Class representing WS-authorization ClaimType.
+ *
+ * @package tvdijen/ws-security
+ */
+final class ClaimType extends AbstractClaimType
+{
+}