Add dsig11:TnB-element

Author: tvdijen

src/XML/dsig11/AbstractTnBFieldParamsType.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\dsig11;
+
+use DOMElement;
+
+/**
+ * Abstract class representing a dsig11:TnBFieldParamsType
+ *
+ * @package simplesaml/xml-security
+ */
+abstract class AbstractTnBFieldParamsType extends AbstractCharTwoFieldParamsType
+{
+    /**
+     * Initialize a TnBFieldParamsType element.
+     *
+     * @param \SimpleSAML\XMLSecurity\XML\dsig11\M $m
+     * @param \SimpleSAML\XMLSecurity\XML\dsig11\K $k
+     */
+    public function __construct(
+        M $m,
+        protected K $k,
+    ) {
+        parent::__construct($m);
+    }
+
+
+    /**
+     * Collect the value of the k-property
+     *
+     * @return \SimpleSAML\XMLSecurity\XML\dsig11\K
+     */
+    public function getK(): K
+    {
+        return $this->k;
+    }
+
+
+    /**
+     * Convert this TnBFieldParamsType element to XML.
+     *
+     * @param \DOMElement|null $parent The element we should append this TnBFieldParamsType element to.
+     * @return \DOMElement
+     */
+    public function toXML(?DOMElement $parent = null): DOMElement
+    {
+        $e = parent::toXML($parent);
+        $this->getK()->toXML($e);
+
+        return $e;
+    }
+}

src/XML/dsig11/TnB.php

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

tests/XML/dsig11/TnBTest.php

@@ -0,0 +1,81 @@
+<?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\XML\dsig11\AbstractCharTwoFieldParamsType;
+use SimpleSAML\XMLSecurity\XML\dsig11\AbstractDsig11Element;
+use SimpleSAML\XMLSecurity\XML\dsig11\AbstractTnBFieldParamsType;
+use SimpleSAML\XMLSecurity\XML\dsig11\K;
+use SimpleSAML\XMLSecurity\XML\dsig11\M;
+use SimpleSAML\XMLSecurity\XML\dsig11\TnB;
+
+use function dirname;
+use function strval;
+
+/**
+ * Class \SimpleSAML\XMLSecurity\Test\XML\dsig11\TnBTest
+ *
+ * @package simplesamlphp/xml-security
+ */
+#[CoversClass(AbstractDsig11Element::class)]
+#[CoversClass(AbstractCharTwoFieldParamsType::class)]
+#[CoversClass(AbstractTnBFieldParamsType::class)]
+#[CoversClass(K::class)]
+#[CoversClass(M::class)]
+#[CoversClass(TnB::class)]
+final class TnBTest extends TestCase
+{
+    use SchemaValidationTestTrait;
+    use SerializableElementTestTrait;
+
+
+    /**
+     */
+    public static function setUpBeforeClass(): void
+    {
+        self::$testedClass = TnB::class;
+
+        self::$xmlRepresentation = DOMDocumentFactory::fromFile(
+            dirname(__FILE__, 3) . '/resources/xml/dsig11_TnB.xml',
+        );
+    }
+
+
+    /**
+     */
+    public function testMarshalling(): void
+    {
+        $m = new M(1024);
+        $k = new K(64);
+        $tnb = new TnB($m, $k);
+
+        $this->assertEquals(
+            self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
+            strval($tnb),
+        );
+    }
+
+
+    /**
+     */
+    public function testMarshallingElementOrder(): void
+    {
+        $m = new M(1024);
+        $k = new K(64);
+        $tnb = new TnB($m, $k);
+
+        $tnbElement = $tnb->toXML();
+        /** @var \DOMElement[] $children */
+        $children = $tnbElement->childNodes;
+
+        $this->assertEquals('dsig11:M', $children[0]->tagName);
+        $this->assertEquals('dsig11:K', $children[1]->tagName);
+    }
+}

tests/resources/xml/dsig11_TnB.xml

@@ -0,0 +1,4 @@
+<dsig11:TnB xmlns:dsig11="http://www.w3.org/2009/xmldsig11#">
+  <dsig11:M>1024</dsig11:M>
+  <dsig11:K>64</dsig11:K>
+</dsig11:TnB>