Add xenc11:KeyDerivationMethod element

Author: tvdijen

src/XML/xenc11/AbstractKeyDerivationMethodType.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\xenc11;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\Exception\MissingElementException;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+use SimpleSAML\XML\ExtendableElementTrait;
+use SimpleSAML\XML\XsNamespace as NS;
+
+/**
+ * Class representing <xenc11:KeyDerivationMethodType>.
+ *
+ * @package simplesamlphp/xml-security
+ */
+abstract class AbstractKeyDerivationMethodType extends AbstractXenc11Element
+{
+    use ExtendableElementTrait;
+
+    /** The namespace-attribute for the xs:any element */
+    public const XS_ANY_ELT_NAMESPACE = NS::ANY;
+
+
+    /**
+     * KeyDerivationMethod constructor.
+     *
+     * @param string $Algorithm
+     * @param \SimpleSAML\XML\SerializableElementInterface[] $children
+     */
+    final public function __construct(
+        protected string $Algorithm,
+        array $children,
+    ) {
+        Assert::validURI($Algorithm, SchemaViolationException::class);
+
+        $this->setElements($children);
+    }
+
+
+    /**
+     * Get the value of the $Algorithm property.
+     *
+     * @return string
+     */
+    public function getAlgorithm(): string
+    {
+        return $this->Algorithm;
+    }
+
+
+    /**
+     * @inheritDoc
+     *
+     * @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);
+
+        return new static(
+            self::getOptionalAttribute($xml, 'Algorithm'),
+            self::getChildElementsFromXML($xml),
+        );
+    }
+
+
+    /**
+     * @inheritDoc
+     */
+    public function toXML(?DOMElement $parent = null): DOMElement
+    {
+        $e = $this->instantiateParentElement($parent);
+        $e->setAttribute('Algorithm', $this->getAlgorithm());
+
+        foreach ($this->getElements() as $child) {
+            if (!$child->isEmptyElement()) {
+                $child->toXML($e);
+            }
+        }
+
+        return $e;
+    }
+}

src/XML/xenc11/AbstractXenc11Element.php

@@ -12,7 +12,7 @@
  *
  * @package simplesamlphp/xml-security
  */
-abstract class AbstractXencElement extends AbstractElement
+abstract class AbstractXenc11Element extends AbstractElement
 {
     /** @var string */
     public const NS = C::NS_XENC11;

src/XML/xenc11/KeyDerivationMethod.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\xenc11;
+
+/**
+ * A class implementing the xenc11:KeyDerivationMethod element.
+ *
+ * @package simplesamlphp/xml-security
+ */
+final class KeyDerivationMethod extends AbstractKeyDerivationMethodType
+{
+}

tests/XML/xenc11/KeyDerivationMethodTest.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Test\XML\xenc11;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XML\Exception\MissingAttributeException;
+use SimpleSAML\XML\TestUtils\SchemaValidationTestTrait;
+use SimpleSAML\XML\TestUtils\SerializableElementTestTrait;
+use SimpleSAML\XMLSecurity\XML\ds\KeyName;
+use SimpleSAML\XMLSecurity\XML\xenc11\AbstractKeyDerivationMethodType;
+use SimpleSAML\XMLSecurity\XML\xenc11\AbstractXenc11Element;
+use SimpleSAML\XMLSecurity\XML\xenc11\KeyDerivationMethod;
+
+use function dirname;
+use function strval;
+
+/**
+ * Tests for the xenc:KeyDerivationMethod element.
+ *
+ * @covers \SimpleSAML\XMLSecurity\XML\xenc11\AbstractXenc11Element
+ * @covers \SimpleSAML\XMLSecurity\XML\xenc11\AbstractKeyDerivationMethodType
+ * @covers \SimpleSAML\XMLSecurity\XML\xenc11\KeyDerivationMethod
+ * @package simplesamlphp/xml-security
+ */
+#[CoversClass(AbstractXenc11Element::class)]
+#[CoversClass(AbstractKeyDerivationMethodType::class)]
+#[CoversClass(KeyDerivationMethod::class)]
+final class KeyDerivationMethodTest extends TestCase
+{
+    use SchemaValidationTestTrait;
+    use SerializableElementTestTrait;
+
+    /**
+     */
+    public static function setUpBeforeClass(): void
+    {
+        self::$testedClass = KeyDerivationMethod::class;
+
+        self::$schemaFile = dirname(__FILE__, 4) . '/resources/schemas/xenc-schema-11.xsd';
+
+        self::$xmlRepresentation = DOMDocumentFactory::fromFile(
+            dirname(__FILE__, 3) . '/resources/xml/xenc11_KeyDerivationMethod.xml',
+        );
+    }
+
+
+    // test marshalling
+
+
+    /**
+     * Test creating an KeyDerivationMethod object from scratch.
+     */
+    public function testMarshalling(): void
+    {
+        $alg = 'http://www.w3.org/2009/xmlenc11#ConcatKDF';
+        $keyName = new KeyName('testkey');
+
+        $kdm = new KeyDerivationMethod($alg, [$keyName]);
+
+        $this->assertEquals(
+            self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
+            strval($kdm),
+        );
+    }
+}

tests/resources/xml/xenc11_KeyDerivationMethod.xml

@@ -0,0 +1,3 @@
+<xenc11:KeyDerivationMethod xmlns:xenc11="http://www.w3.org/2009/xmlenc11#" Algorithm="http://www.w3.org/2009/xmlenc11#ConcatKDF">
+  <ds:KeyName xmlns:ds="http://www.w3.org/2000/09/xmldsig#">testkey</ds:KeyName>
+</xenc11:KeyDerivationMethod>