Add dsig11:DEREncodedKeyValue

Author: tvdijen

src/XML/ds/AbstractKeyInfoType.php

@@ -12,7 +12,7 @@
 use SimpleSAML\XMLSecurity\Assert\Assert;
 use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\Exception\InvalidArgumentException;
-use SimpleSAML\XMLSecurity\XML\ds\AbstractDsElement;
+use SimpleSAML\XMLSecurity\XML\dsig11\DEREncodedKeyValue;
 
 /**
  * Abstract class representing the KeyInfoType.
@@ -38,6 +38,7 @@ abstract class AbstractKeyInfoType extends AbstractDsElement
      *     \SimpleSAML\XMLSecurity\XML\ds\PGPData|
      *     \SimpleSAML\XMLSecurity\XML\ds\SPKIData|
      *     \SimpleSAML\XMLSecurity\XML\ds\MgmtData|
+     *     \SimpleSAML\XMLSecurity\XML\dsig11\DEREncodedKeyValue|
      *     \SimpleSAML\XML\SerializableElementInterface
      * )[] $info
      * @param string|null $Id
@@ -78,6 +79,14 @@ final public function __construct(
                     ],
                     SchemaViolationException::class,
                 );
+            } elseif ($item instanceof AbstractDsElement) {
+                Assert::isInstanceOfAny(
+                    $item,
+                    [
+                        DEREncodedKeyValue::class,
+                    ],
+                    SchemaViolationException::class,
+                );
             }
         }
     }

src/XML/ds/KeyInfo.php

@@ -7,8 +7,8 @@
 use DOMElement;
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
-use SimpleSAML\XML\SchemaValidatableElementInterface;
-use SimpleSAML\XML\SchemaValidatableElementTrait;
+use SimpleSAML\XML\{SchemaValidatableElementInterface, SchemaValidatableElementTrait};
+use SimpleSAML\XMLSecurity\XML\dsig11\DEREncodedKeyValue;
 
 use function array_merge;
 
@@ -44,6 +44,7 @@ public static function fromXML(DOMElement $xml): static
         $pgpData = PGPData::getChildrenOfClass($xml);
         $spkiData = SPKIData::getChildrenOfClass($xml);
         $mgmtData = MgmtData::getChildrenOfClass($xml);
+        $derEncodedKeyValue = DEREncodedKeyValue::getChildrenOfClass($xml);
         $other = self::getChildElementsFromXML($xml);
 
         $info = array_merge(
@@ -54,6 +55,7 @@ public static function fromXML(DOMElement $xml): static
             $pgpData,
             $spkiData,
             $mgmtData,
+            $derEncodedKeyValue,
             $other,
         );
 

src/XML/dsig11/DEREncodedKeyValue.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\dsig11;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Base64ElementTrait;
+use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+use SimpleSAML\XML\SchemaValidatableElementInterface;
+use SimpleSAML\XML\SchemaValidatableElementTrait;
+use SimpleSAML\XMLSecurity\Constants as C;
+use SimpleSAML\XMLSecurity\Exception\InvalidArgumentException;
+
+/**
+ * Class representing a dsig11:DEREncodedKeyValue element.
+ *
+ * @package simplesaml/xml-security
+ */
+final class DEREncodedKeyValue extends AbstractDsig11Element implements SchemaValidatableElementInterface
+{
+    use Base64ElementTrait;
+    use SchemaValidatableElementTrait;
+
+
+    /**
+     * Initialize a DEREncodedKeyValue element.
+     *
+     * @param string $value
+     * @param string|null $Id
+     */
+    public function __construct(
+        string $value,
+        protected ?string $Id = null,
+    ) {
+        Assert::validNCName($Id, SchemaViolationException::class);
+
+        $this->setContent($value);
+    }
+
+
+    /**
+     * Collect the value of the Id-property
+     *
+     * @return string|null
+     */
+    public function getId(): ?string
+    {
+        return $this->Id;
+    }
+
+
+    /**
+     * Convert XML into a DEREncodedKeyValue
+     *
+     * @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::LOCALNAME, InvalidDOMElementException::class);
+        Assert::same($xml->namespaceURI, static::NS, InvalidDOMElementException::class);
+
+        return new static(
+            $xml->textContent,
+            self::getOptionalAttribute($xml, 'Id', null),
+        );
+    }
+
+
+    /**
+     * Convert this DEREncodedKeyValue element to XML.
+     *
+     * @param \DOMElement|null $parent The element we should append this DEREncodedKeyValue element to.
+     * @return \DOMElement
+     */
+    public function toXML(?DOMElement $parent = null): DOMElement
+    {
+        $e = $this->instantiateParentElement($parent);
+        $e->textContent = $this->getContent();
+
+        if ($this->getId() !== null) {
+            $e->setAttribute('Id', $this->getId());
+        }
+
+        return $e;
+    }
+}

src/XML/element.registry.php

@@ -30,7 +30,7 @@
         'X509Data' => '\SimpleSAML\XMLSecurity\XML\ds\X509Data',
     ],
     'http://www.w3.org/2009/xmldsig11#' => [
-//        'DEREncodedKeyValue' => '\SimpleSAML\XMLSecurity\XML\dsig11\DEREncodedKeyValue',
+        'DEREncodedKeyValue' => '\SimpleSAML\XMLSecurity\XML\dsig11\DEREncodedKeyValue',
 //        'ECKeyValue' => '\SimpleSAML\XMLSecurity\XML\dsig11\ECKeyValue',
 //        'GnB' => '\SimpleSAML\XMLSecurity\XML\dsig11\GnB',
         'KeyInfoReference' => '\SimpleSAML\XMLSecurity\XML\dsig11\KeyInfoReference',

tests/XML/dsig11/DEREncodedKeyValueTest.php

@@ -0,0 +1,66 @@
+<?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\Constants as C;
+use SimpleSAML\XMLSecurity\CryptoEncoding\PEM;
+use SimpleSAML\XMLSecurity\Key;
+use SimpleSAML\XMLSecurity\Test\XML\XMLDumper;
+use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
+use SimpleSAML\XMLSecurity\XML\dsig11\AbstractDsig11Element;
+use SimpleSAML\XMLSecurity\XML\dsig11\DEREncodedKeyValue;
+
+use function base64_encode;
+use function dirname;
+use function hex2bin;
+use function strval;
+
+/**
+ * Class \SimpleSAML\XMLSecurity\Test\XML\dsig11\DEREncodedKeyValueTest
+ *
+ * @package simplesamlphp/xml-security
+ */
+#[CoversClass(AbstractDsig11Element::class)]
+#[CoversClass(DEREncodedKeyValue::class)]
+final class DEREncodedKeyValueTest extends TestCase
+{
+    use SchemaValidationTestTrait;
+    use SerializableElementTestTrait;
+
+
+    /**
+     */
+    public static function setUpBeforeClass(): void
+    {
+        self::$testedClass = DEREncodedKeyValue::class;
+
+        self::$xmlRepresentation = DOMDocumentFactory::fromFile(
+            dirname(__FILE__, 3) . '/resources/xml/dsig11_DEREncodedKeyValue.xml',
+        );
+    }
+
+
+    /**
+     */
+    public function testMarshalling(): void
+    {
+        $derEncodedKeyValue = new DEREncodedKeyValue(
+            'MGYwHwYIKoUDBwEBAQEwEwYHKoUDAgIkAAYIKoUDBwEBAgIDQwAEQLrf0MNTFKvS'
+            . 'j6pHRwtsQBdyu07oB36PZ+duQ9rOZhWXQ+acH/dP4uLxdJhZq/Z30cDGD+KND4NZ'
+            . 'jp+UZWlzWK0=',
+            'phpunit',
+        );
+
+        $this->assertEquals(
+            XMLDumper::dumpDOMDocumentXMLWithBase64Content(self::$xmlRepresentation),
+            strval($derEncodedKeyValue),
+        );
+    }
+}

tests/resources/xml/dsig11_DEREncodedKeyValue.xml

@@ -0,0 +1 @@
+<dsig11:DEREncodedKeyValue xmlns:dsig11="http://www.w3.org/2009/xmldsig11#" Id="phpunit">MGYwHwYIKoUDBwEBAQEwEwYHKoUDAgIkAAYIKoUDBwEBAgIDQwAEQLrf0MNTFKvSj6pHRwtsQBdyu07oB36PZ+duQ9rOZhWXQ+acH/dP4uLxdJhZq/Z30cDGD+KND4NZjp+UZWlzWK0=</dsig11:DEREncodedKeyValue>