Add XML-representation for ds:CanonicalizationMethod element (#9)

Author: tvdijen

src/XML/ds/CanonicalizationMethod.php

@@ -0,0 +1,106 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\ds;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XMLSecurity\Constants;
+use SimpleSAML\XMLSecurity\Exception\InvalidArgumentException;
+
+/**
+ * Class representing a ds:CanonicalizationMethod element.
+ *
+ * @package simplesamlphp/xml-security
+ */
+final class CanonicalizationMethod extends AbstractDsElement
+{
+    /**
+     * The algorithm.
+     *
+     * @var string
+     */
+    protected string $Algorithm;
+
+
+    /**
+     * Initialize a CanonicalizationMethod element.
+     *
+     * @param string $algorithm
+     */
+    public function __construct(string $algorithm)
+    {
+        $this->setAlgorithm($algorithm);
+    }
+
+
+    /**
+     * Collect the value of the Algorithm-property
+     *
+     * @return string
+     */
+    public function getAlgorithm(): string
+    {
+        return $this->Algorithm;
+    }
+
+
+    /**
+     * Set the value of the Algorithm-property
+     *
+     * @param string $algorithm
+     */
+    private function setAlgorithm(string $algorithm): void
+    {
+        Assert::oneOf(
+            $algorithm,
+            [
+                Constants::C14N_EXCLUSIVE_WITH_COMMENTS,
+                Constants::C14N_EXCLUSIVE_WITHOUT_COMMENTS,
+                Constants::C14N_INCLUSIVE_WITH_COMMENTS,
+                Constants::C14N_INCLUSIVE_WITHOUT_COMMENTS
+            ],
+            'Invalid canonicalization method',
+            InvalidArgumentException::class
+        );
+
+        $this->Algorithm = $algorithm;
+    }
+
+
+    /**
+     * Convert XML into a CanonicalizationMethod
+     *
+     * @param \DOMElement $xml The XML element we should load
+     * @return self
+     *
+     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
+     *   If the qualified name of the supplied element is wrong
+     */
+    public static function fromXML(DOMElement $xml): object
+    {
+        Assert::same($xml->localName, 'CanonicalizationMethod', InvalidDOMElementException::class);
+        Assert::same($xml->namespaceURI, CanonicalizationMethod::NS, InvalidDOMElementException::class);
+
+        $Algorithm = CanonicalizationMethod::getAttribute($xml, 'Algorithm');
+
+        return new self($Algorithm);
+    }
+
+
+    /**
+     * Convert this CanonicalizationMethod element to XML.
+     *
+     * @param \DOMElement|null $parent The element we should append this KeyName element to.
+     * @return \DOMElement
+     */
+    public function toXML(DOMElement $parent = null): DOMElement
+    {
+        $e = $this->instantiateParentElement($parent);
+        $e->setAttribute('Algorithm', $this->Algorithm);
+
+        return $e;
+    }
+}

tests/XML/ds/CanonicalizationMethodTest.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Test\XML\ds;
+
+use DOMDocument;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XMLSecurity\Constants;
+use SimpleSAML\XMLSecurity\XML\ds\CanonicalizationMethod;
+
+/**
+ * Class \SimpleSAML\XMLSecurity\XML\ds\CanonicalizationMethodTest
+ *
+ * @covers \SimpleSAML\XMLSecurity\XML\ds\AbstractDsElement
+ * @covers \SimpleSAML\XMLSecurity\XML\ds\CanonicalizationMethod
+ *
+ * @package simplesamlphp/xml-security
+ */
+final class CanonicalizationMethodTest extends TestCase
+{
+    /** @var \DOMDocument */
+    private DOMDocument $document;
+
+    /**
+     */
+    protected function setUp(): void
+    {
+        $this->document = DOMDocumentFactory::fromFile(
+            dirname(dirname(dirname(dirname(__FILE__)))) . '/tests/resources/xml/ds_CanonicalizationMethod.xml'
+        );
+    }
+
+
+    /**
+     */
+    public function testMarshalling(): void
+    {
+        $CanonicalizationMethod = new CanonicalizationMethod(Constants::C14N_EXCLUSIVE_WITHOUT_COMMENTS);
+
+        $this->assertEquals(Constants::C14N_EXCLUSIVE_WITHOUT_COMMENTS, $CanonicalizationMethod->getAlgorithm());
+
+        $this->assertEquals($this->document->saveXML($this->document->documentElement), strval($CanonicalizationMethod));
+    }
+
+
+    /**
+     */
+    public function testUnmarshalling(): void
+    {
+        $CanonicalizationMethod = CanonicalizationMethod::fromXML($this->document->documentElement);
+
+        $this->assertEquals(Constants::C14N_EXCLUSIVE_WITHOUT_COMMENTS, $CanonicalizationMethod->getAlgorithm());
+    }
+
+
+    /**
+     * Test serialization / unserialization
+     */
+    public function testSerialization(): void
+    {
+        $this->assertEquals(
+            $this->document->saveXML($this->document->documentElement),
+            strval(unserialize(serialize(CanonicalizationMethod::fromXML($this->document->documentElement))))
+        );
+    }
+}

tests/resources/xml/ds_CanonicalizationMethod.xml

@@ -0,0 +1 @@
+<ds:CanonicalizationMethod xmlns:ds="http://www.w3.org/2000/09/xmldsig#" Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" />