Add dsig11:ValidationData-element

Author: tvdijen

src/XML/dsig11/AbstractECValidationDataType.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\dsig11;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * Abstract class representing a dsig11:ECValidationDataType
+ *
+ * @package simplesaml/xml-security
+ */
+abstract class AbstractECValidationDataType extends AbstractDsig11Element
+{
+    /**
+     * Initialize a ECValidationDataType element.
+     *
+     * @param \SimpleSAML\XMLSecurity\XML\dsig11\Seed $seed
+     * @param string $hashAlgorithm
+     */
+    public function __construct(
+        protected Seed $seed,
+        protected string $hashAlgorithm,
+    ) {
+        Assert::validURI($hashAlgorithm, SchemaViolationException::class);
+    }
+
+
+    /**
+     * Collect the value of the seed-property
+     *
+     * @return \SimpleSAML\XMLSecurity\XML\dsig11\Seed
+     */
+    public function getSeed(): Seed
+    {
+        return $this->seed;
+    }
+
+
+    /**
+     * Collect the value of the hashAlgorithm-property
+     *
+     * @return string
+     */
+    public function getHashAlgorithm(): string
+    {
+        return $this->hashAlgorithm;
+    }
+
+
+    /**
+     * Convert this ECValidationDataType element to XML.
+     *
+     * @param \DOMElement|null $parent The element we should append this ECValidationDataType element to.
+     * @return \DOMElement
+     */
+    public function toXML(?DOMElement $parent = null): DOMElement
+    {
+        $e = $this->instantiateParentElement($parent);
+        $e->setAttribute('hashAlgorithm', $this->getHashAlgorithm());
+
+        $this->getSeed()->toXML($e);
+
+        return $e;
+    }
+}

src/XML/dsig11/ValidationData.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\dsig11;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\Exception\MissingElementException;
+use SimpleSAML\XML\Exception\TooManyElementsException;
+use SimpleSAML\XML\SchemaValidatableElementInterface;
+use SimpleSAML\XML\SchemaValidatableElementTrait;
+
+use function array_pop;
+
+/**
+ * Class representing a dsig11:ValidationData element.
+ *
+ * @package simplesaml/xml-security
+ */
+final class ValidationData extends AbstractECValidationDataType implements SchemaValidatableElementInterface
+{
+    use SchemaValidatableElementTrait;
+
+    /**
+     * Convert XML into a ValidationData element
+     *
+     * @param \DOMElement $xml The XML element we should load
+     * @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::getNamespaceURI(), InvalidDOMElementException::class);
+
+        $seed = Seed::getChildrenOfClass($xml);
+        Assert::minCount($seed, 1, MissingElementException::class);
+        Assert::maxCount($seed, 1, TooManyElementsException::class);
+
+        return new static(
+            array_pop($seed),
+            self::getAttribute($xml, 'hashAlgorithm'),
+        );
+    }
+}

tests/XML/dsig11/ValidationDataTest.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Test\XML\dsig11;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XML\TestUtils\SerializableElementTestTrait;
+use SimpleSAML\XMLSecurity\Constants as C;
+use SimpleSAML\XMLSecurity\XML\dsig11\AbstractDsig11Element;
+use SimpleSAML\XMLSecurity\XML\dsig11\AbstractECValidationDataType;
+use SimpleSAML\XMLSecurity\XML\dsig11\Seed;
+use SimpleSAML\XMLSecurity\XML\dsig11\ValidationData;
+
+use function dirname;
+use function strval;
+
+/**
+ * Class \SimpleSAML\XMLSecurity\Test\XML\dsig11\ValidationDataTest
+ *
+ * @package simplesamlphp/xml-security
+ */
+#[CoversClass(AbstractDsig11Element::class)]
+#[CoversClass(AbstractECValidationDataType::class)]
+#[CoversClass(ValidationData::class)]
+final class ValidationDataTest extends TestCase
+{
+    use SerializableElementTestTrait;
+
+
+    /**
+     */
+    public static function setUpBeforeClass(): void
+    {
+        self::$testedClass = ValidationData::class;
+
+        self::$xmlRepresentation = DOMDocumentFactory::fromFile(
+            dirname(__FILE__, 3) . '/resources/xml/dsig11_ValidationData.xml',
+        );
+    }
+
+
+    /**
+     */
+    public function testMarshalling(): void
+    {
+        $seed = new Seed('6tN39Q9d6IevlAWLeM7lQGazUnVlJOe1wCk3sro2rfE=');
+        $validationData = new ValidationData($seed, C::DIGEST_SHA1);
+
+        $this->assertEquals(
+            self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
+            strval($validationData),
+        );
+    }
+}

tests/resources/xml/dsig11_ValidationData.xml

@@ -0,0 +1,3 @@
+<dsig11:ValidationData xmlns:dsig11="http://www.w3.org/2009/xmldsig11#" hashAlgorithm="http://www.w3.org/2000/09/xmldsig#sha1">
+  <dsig11:Seed>6tN39Q9d6IevlAWLeM7lQGazUnVlJOe1wCk3sro2rfE=</dsig11:Seed>
+</dsig11:ValidationData>