Add dsig11:Prime-element

Author: tvdijen

src/XML/dsig11/AbstractPrimeFieldParamsType.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\dsig11;
+
+use DOMElement;
+
+/**
+ * Abstract class representing a dsig11:PrimeFieldParamsType
+ *
+ * @package simplesaml/xml-security
+ */
+abstract class AbstractPrimeFieldParamsType extends AbstractDsig11Element
+{
+    /**
+     * Initialize a PrimeFieldParamsType element.
+     *
+     * @param \SimpleSAML\XMLSecurity\XML\dsig11\P $p
+     */
+    public function __construct(
+        protected P $p,
+    ) {
+    }
+
+
+    /**
+     * Collect the value of the p-property
+     *
+     * @return \SimpleSAML\XMLSecurity\XML\dsig11\P
+     */
+    public function getP(): P
+    {
+        return $this->p;
+    }
+
+
+    /**
+     * Convert this PrimeFieldParamsType element to XML.
+     *
+     * @param \DOMElement|null $parent The element we should append this PrimeFieldParamsType element to.
+     * @return \DOMElement
+     */
+    public function toXML(?DOMElement $parent = null): DOMElement
+    {
+        $e = $this->instantiateParentElement($parent);
+        $this->getP()->toXML($e);
+
+        return $e;
+    }
+}

src/XML/dsig11/Prime.php

@@ -0,0 +1,48 @@
+<?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:Prime element.
+ *
+ * @package simplesaml/xml-security
+ */
+final class Prime extends AbstractPrimeFieldParamsType implements SchemaValidatableElementInterface
+{
+    use SchemaValidatableElementTrait;
+
+    /**
+     * Convert XML into a Prime 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);
+
+        $p = P::getChildrenOfClass($xml);
+        Assert::minCount($p, 1, MissingElementException::class);
+        Assert::maxCount($p, 1, TooManyElementsException::class);
+
+        return new static(
+            array_pop($p),
+        );
+    }
+}

tests/XML/dsig11/PrimeTest.php

@@ -0,0 +1,60 @@
+<?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\SchemaValidationTestTrait;
+use SimpleSAML\XML\TestUtils\SerializableElementTestTrait;
+use SimpleSAML\XMLSecurity\Test\XML\XMLDumper;
+use SimpleSAML\XMLSecurity\XML\dsig11\AbstractDsig11Element;
+use SimpleSAML\XMLSecurity\XML\dsig11\AbstractPrimeFieldParamsType;
+use SimpleSAML\XMLSecurity\XML\dsig11\P;
+use SimpleSAML\XMLSecurity\XML\dsig11\Prime;
+
+use function dirname;
+use function strval;
+
+/**
+ * Class \SimpleSAML\XMLSecurity\Test\XML\dsig11\PrimeTest
+ *
+ * @package simplesamlphp/xml-security
+ */
+#[CoversClass(AbstractDsig11Element::class)]
+#[CoversClass(AbstractPrimeFieldParamsType::class)]
+#[CoversClass(P::class)]
+#[CoversClass(Prime::class)]
+final class PrimeTest extends TestCase
+{
+    use SchemaValidationTestTrait;
+    use SerializableElementTestTrait;
+
+
+    /**
+     */
+    public static function setUpBeforeClass(): void
+    {
+        self::$testedClass = Prime::class;
+
+        self::$xmlRepresentation = DOMDocumentFactory::fromFile(
+            dirname(__FILE__, 3) . '/resources/xml/dsig11_Prime.xml',
+        );
+    }
+
+
+    /**
+     */
+    public function testMarshalling(): void
+    {
+        $p = new P('6tN39Q9d6IevlAWLeM7lQGazUnVlJOe1wCk3sro2rfE=');
+        $prime = new Prime($p);
+
+        $this->assertEquals(
+            XMLDumper::dumpDOMDocumentXMLWithBase64Content(self::$xmlRepresentation),
+            strval($prime),
+        );
+    }
+}

tests/resources/xml/dsig11_Prime.xml

@@ -0,0 +1,3 @@
+<dsig11:Prime xmlns:dsig11="http://www.w3.org/2009/xmldsig11#">
+  <dsig11:P>6tN39Q9d6IevlAWLeM7lQGazUnVlJOe1wCk3sro2rfE=</dsig11:P>
+</dsig11:Prime>