Add xenc11:Parameters element

Author: tvdijen

src/XML/xenc11/Parameters.php

@@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\xenc11;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\ExtendableAttributesTrait;
+use SimpleSAML\XML\ExtendableElementTrait;
+use SimpleSAML\XML\XsNamespace as NS;
+
+/**
+ * Class representing xenc11:Parameters
+ *
+ * @package simplesamlphp/xml-security
+ */
+final class Parameters extends AbstractXenc11Element
+{
+    use ExtendableAttributesTrait;
+    use ExtendableElementTrait;
+
+    /** The namespace-attribute for the xs:any element */
+    public const XS_ANY_ELT_NAMESPACE = NS::ANY;
+
+    /** The namespace-attribute for the xs:anyAttribute element */
+    public const XS_ANY_ATTR_NAMESPACE = NS::ANY;
+
+
+    /**
+     * Initialize a Parameters element.
+     *
+     * @param \SimpleSAML\XML\Chunk[] $elements
+     * @param \SimpleSAML\XML\Attribute[] $attributes
+     */
+    public function __construct(array $elements = [], array $attributes = [])
+    {
+        $this->setElements($elements);
+        $this->setAttributesNS($attributes);
+    }
+
+
+
+    /**
+     * Test if an object, at the state it's in, would produce an empty XML-element
+     *
+     * @return bool
+     */
+    public function isEmptyElement(): bool
+    {
+        return empty($this->getAttributesNS())
+            && empty($this->getElements());
+    }
+
+
+    /**
+     * Convert XML into a Parameters 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, 'Parameters', InvalidDOMElementException::class);
+        Assert::same($xml->namespaceURI, Parameters::NS, InvalidDOMElementException::class);
+
+        return new static(
+            self::getChildElementsFromXML($xml),
+            self::getAttributesNSFromXML($xml),
+        );
+    }
+
+
+    /**
+     * Convert this Parameters element to XML.
+     *
+     * @param \DOMElement|null $parent The element we should append this Parameters to.
+     * @return \DOMElement
+     */
+    public function toXML(?DOMElement $parent = null): DOMElement
+    {
+        $e = $this->instantiateParentElement($parent);
+
+        foreach ($this->getAttributesNS() as $attr) {
+            $attr->toXML($e);
+        }
+
+        foreach ($this->getElements() as $element) {
+            /** @psalm-var \SimpleSAML\XML\SerializableElementInterface $element */
+            $element->toXML($e);
+        }
+
+        return $e;
+    }
+}

tests/XML/xenc11/ParametersTest.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\SAML2\XML\xenc11;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\XMLSecurity\XML\xenc11\AbstractXenc11Element;
+use SimpleSAML\XMLSecurity\XML\xenc11\Parameters;
+use SimpleSAML\XML\Attribute as XMLAttribute;
+use SimpleSAML\XML\Chunk;
+use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XML\TestUtils\SerializableElementTestTrait;
+
+use function dirname;
+use function strval;
+
+/**
+ * Class \SimpleSAML\XMLSecurity\XML\xenc11\ParametersTest
+ *
+ * @package simplesamlphp/xml-security
+ */
+#[CoversClass(Parameters::class)]
+#[CoversClass(AbstractXenc11Element::class)]
+final class ParametersTest extends TestCase
+{
+    use SerializableElementTestTrait;
+
+    /**
+     */
+    public static function setUpBeforeClass(): void
+    {
+        self::$testedClass = Parameters::class;
+
+        self::$xmlRepresentation = DOMDocumentFactory::fromFile(
+            dirname(__FILE__, 3) . '/resources/xml/xenc11_Parameters.xml',
+        );
+    }
+
+
+    // marshalling
+
+
+    /**
+     */
+    public function testMarshalling(): void
+    {
+        $chunk = new Chunk(DOMDocumentFactory::fromString(
+            <<<XML
+  <ssp:AuthenticationContextDeclaration xmlns:ssp="urn:x-simplesamlphp:namespace">
+    <ssp:Identification nym="verinymity">
+      <ssp:Extension>
+        <ssp:NoVerification/>
+      </ssp:Extension>
+    </ssp:Identification>
+  </ssp:AuthenticationContextDeclaration>
+XML
+            ,
+        )->documentElement);
+
+        $parameters = new Parameters(
+            [$chunk],
+            [new XMLAttribute('urn:x-simplesamlphp:namespace', 'ssp', 'attr1', 'testval1')],
+        );
+
+        $this->assertEquals(
+            self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
+            strval($parameters),
+        );
+    }
+}

tests/resources/xml/xenc11_Parameters.xml

@@ -0,0 +1,9 @@
+<xenc11:Parameters xmlns:xenc11="http://www.w3.org/2009/xmlenc11#" xmlns:ssp="urn:x-simplesamlphp:namespace" ssp:attr1="testval1">
+  <ssp:AuthenticationContextDeclaration>
+    <ssp:Identification nym="verinymity">
+      <ssp:Extension>
+        <ssp:NoVerification/>
+      </ssp:Extension>
+    </ssp:Identification>
+  </ssp:AuthenticationContextDeclaration>
+</xenc11:Parameters>