Add ds:SignatureValue (#15)

* Add ds:SignatureValue

* Use the new SignatureValue

* Fix test value

* Bump dependency on our assert library

* Fix test namespace

* Fix namespaces

Co-authored-by: Tim van Dijen <tvdijen@gmail.com>

Author: jaimeperez

composer.json

@@ -39,7 +39,7 @@
         "ext-dom": "*",
 
         "robrichards/xmlseclibs": "^3.1.1",
-        "simplesamlphp/assert": "~0.2.1",
+        "simplesamlphp/assert": "~0.2.2",
         "simplesamlphp/xml-common": "~0.3.2"
     },
     "require-dev": {

src/XML/ds/Signature.php

@@ -7,9 +7,7 @@
 use DOMElement;
 use Exception;
 use SimpleSAML\Assert\Assert;
-use SimpleSAML\XML\AbstractXMLElement;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
-use SimpleSAML\XML\Exception\MissingAttributeException;
 use SimpleSAML\XML\Utils as XMLUtils;
 use SimpleSAML\XMLSecurity\Utils\Certificate;
 use SimpleSAML\XMLSecurity\Utils\Security;
@@ -29,6 +27,9 @@ final class Signature extends AbstractDsElement
     /** @var string[] */
     protected array $certificates = [];
 
+    /** @var SignatureValue */
+    protected SignatureValue $value;
+
     /** @var \SimpleSAML\XMLSecurity\XMLSecurityKey|null */
     protected ?XMLSecurityKey $key;
 
@@ -47,6 +48,7 @@ final class Signature extends AbstractDsElement
      */
     public function __construct(
         string $algorithm,
+        SignatureValue $value,
         array $certificates = [],
         ?XMLSecurityKey $key = null
     ) {
@@ -121,6 +123,28 @@ protected function setKey(?XMLSecurityKey $key): void
     }
 
 
+    /**
+     * Get the SignatureValue corresponding to this signature.
+     *
+     * @return SignatureValue
+     */
+    public function getSignatureValue(): SignatureValue
+    {
+        return $this->value;
+    }
+
+
+    /**
+     * Set the SignatureValue.
+     *
+     * @param SignatureValue $value
+     */
+    protected function setSignatureValue(SignatureValue $value): void
+    {
+        $this->value = $value;
+    }
+
+
     /**
      * @return XMLSecurityDSig
      */
@@ -165,7 +189,10 @@ public static function fromXML(DOMElement $xml): object
             );
         }
 
-        $signature = new self(self::getAttribute($sigMethod, 'Algorithm'), $certificates);
+        $value = SignatureValue::getChildrenOfClass($xml);
+        Assert::count($value, 1, 'ds:Signature needs exactly one ds:SignatureValue');
+
+        $signature = new self(self::getAttribute($sigMethod, 'Algorithm'), $value[0], $certificates);
 
         $signature->signer->sigNode = $xml;
 

src/XML/ds/SignatureValue.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\XML\ds;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\InvalidDOMElementException;
+
+/**
+ * Class representing a ds:SignatureValue element.
+ *
+ * @package simplesaml/xml-security
+ */
+final class SignatureValue extends AbstractDsElement
+{
+    /** @var string */
+    protected string $value;
+
+
+    /**
+     * Initialize a SignatureValue element.
+     *
+     * @param string $value
+     */
+    public function __construct(string $value) {
+        $this->setValue($value);
+    }
+
+
+    /**
+     * Get the signature value.
+     *
+     * @return string
+     */
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+
+    /**
+     * Set the value.
+     *
+     * @param string $value
+     */
+    private function setValue(string $value): void
+    {
+        Assert::notEmpty($value, 'SignatureValue cannot be empty');
+        Assert::stringPlausibleBase64($value, 'SignatureValue is not a valid Base64 encoded string');
+        $this->value = $value;
+    }
+
+
+    /**
+     * Convert XML into a SignatureValue
+     *
+     * @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, 'SignatureValue', InvalidDOMElementException::class);
+        Assert::same($xml->namespaceURI, SignatureValue::NS, InvalidDOMElementException::class);
+
+        return new self($xml->textContent);
+    }
+
+
+    /**
+     * Convert this SignatureValue to XML.
+     *
+     * @param DOMElement|null $parent The element we should append this SignatureValue element to.
+     * @return DOMElement
+     */
+    public function toXML(DOMElement $parent = null): \DOMElement
+    {
+        $e = $this->instantiateParentElement($parent);
+        $e->textContent = $this->value;
+
+        return $e;
+    }
+}

tests/XML/ds/KeyNameTest.php

@@ -4,12 +4,10 @@
 
 namespace SimpleSAML\XMLSecurity\Test\XML\ds;
 
-use DOMDocument;
 use PHPUnit\Framework\TestCase;
 use SimpleSAML\Test\XML\SerializableXMLTestTrait;
 use SimpleSAML\XML\DOMDocumentFactory;
 use SimpleSAML\XMLSecurity\XML\ds\KeyName;
-use SimpleSAML\XMLSecurity\XMLSecurityDSig;
 
 /**
  * Class \SimpleSAML\XMLSecurity\XML\ds\KeyNameTest

tests/XML/ds/SignatureValueTest.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML\ds;
+
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\Test\XML\SerializableXMLTestTrait;
+use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XMLSecurity\XML\ds\SignatureValue;
+
+/**
+ * Class \SimpleSAML\XMLSecurity\XML\ds\SignatureValue
+ *
+ * @covers \SimpleSAML\XMLSecurity\XML\ds\AbstractDsElement
+ * @covers \SimpleSAML\XMLSecurity\\XML\ds\SignatureValue
+ *
+ * @package simplesamlphp/xml-security
+ */
+final class SignatureValueTest extends TestCase
+{
+    use SerializableXMLTestTrait;
+
+
+    /**
+     * Set up the test.
+     */
+    protected function setUp(): void
+    {
+        $this->testedClass = SignatureValue::class;
+
+        $this->xmlRepresentation = DOMDocumentFactory::fromFile(
+            dirname(dirname(dirname(dirname(__FILE__)))) . '/tests/resources/xml/ds_SignatureValue.xml'
+        );
+    }
+
+
+    /**
+     * Test creating a SignatureValue from scratch.
+     */
+    public function testMarshalling(): void
+    {
+        $this->assertEquals(
+            $this->xmlRepresentation->saveXML($this->xmlRepresentation->documentElement),
+            strval(new SignatureValue(
+                'j14G9v6AnsOiEJYgkTg864DG3e/KLqoGpuybPGSGblVTn7ST6M/BsvP7YiVZjLqJEuEvWmf2mW4DPb+pbArzzDcsLWEtNveMrw+F' .
+                'kWehDUQV9oe20iepo+W46wmj7zB/eWL+Z8MrGvlycoTndJU6CVwHTLsB+dq2FDa7JV4pAPjMY32JZTbiwKhzqw3nEi/eVrujJE4Y' .
+                'RrlW28D+rXhITfoUAGGvsqPzcwGzp02lnMe2SmXADY1u9lbVjOhUrJpgvWfn9YuiCR+wjvaGMwIwzfJxChLJZOBV+1ad1CyNTiu6' .
+                'qAblxZ4F8cWlMWJ7f0KkWvtw66HOf2VNR6Qan2Ra7Q=='))
+        );
+    }
+
+
+    /**
+     * Test creating a SignatureValue object from XML.
+     */
+    public function testUnmarshalling(): void
+    {
+        $signatureValue = SignatureValue::fromXML($this->xmlRepresentation->documentElement);
+        $this->assertEquals(
+            'j14G9v6AnsOiEJYgkTg864DG3e/KLqoGpuybPGSGblVTn7ST6M/BsvP7YiVZjLqJEuEvWmf2mW4DPb+pbArzzDcsLWEtNveMrw+F' .
+            'kWehDUQV9oe20iepo+W46wmj7zB/eWL+Z8MrGvlycoTndJU6CVwHTLsB+dq2FDa7JV4pAPjMY32JZTbiwKhzqw3nEi/eVrujJE4Y' .
+            'RrlW28D+rXhITfoUAGGvsqPzcwGzp02lnMe2SmXADY1u9lbVjOhUrJpgvWfn9YuiCR+wjvaGMwIwzfJxChLJZOBV+1ad1CyNTiu6' .
+            'qAblxZ4F8cWlMWJ7f0KkWvtw66HOf2VNR6Qan2Ra7Q==',
+            $signatureValue->getValue()
+        );
+    }
+}

tests/XML/ds/TransformTest.php

@@ -2,24 +2,24 @@
 
 declare(strict_types=1);
 
-namespace SimpleSAML\Test\SAML2\XML\ds;
+namespace SimpleSAML\Test\XML\ds;
 
 use DOMDocument;
 use PHPUnit\Framework\TestCase;
-use SimpleSAML\SAML2\Constants;
+use SimpleSAML\Constants;
 use SimpleSAML\Test\XML\SerializableXMLTestTrait;
 use SimpleSAML\XML\DOMDocumentFactory;
 use SimpleSAML\XML\Chunk;
 use SimpleSAML\XML\Utils as XMLUtils;
 use SimpleSAML\XMLSecurity\XML\ds\Transform;
 
 /**
- * Class \SAML2\XML\ds\TransformTest
+ * Class \SimpleSAML\XMLSecurity\XML\ds\TransformTest
  *
- * @covers \SimpleSAML\SAML2\XML\ds\Transform
- * @covers \SimpleSAML\SAML2\XML\ds\AbstractDsElement
+ * @covers \SimpleSAML\XMLSecurity\XML\ds\Transform
+ * @covers \SimpleSAML\XMLSecurity\XML\ds\AbstractDsElement
  *
- * @package simplesamlphp/saml2
+ * @package simplesamlphp/xml-security
  */
 final class TransformTest extends TestCase
 {

tests/resources/xml/ds_SignatureValue.xml

@@ -0,0 +1 @@
+<ds:SignatureValue xmlns:ds="http://www.w3.org/2000/09/xmldsig#">j14G9v6AnsOiEJYgkTg864DG3e/KLqoGpuybPGSGblVTn7ST6M/BsvP7YiVZjLqJEuEvWmf2mW4DPb+pbArzzDcsLWEtNveMrw+FkWehDUQV9oe20iepo+W46wmj7zB/eWL+Z8MrGvlycoTndJU6CVwHTLsB+dq2FDa7JV4pAPjMY32JZTbiwKhzqw3nEi/eVrujJE4YRrlW28D+rXhITfoUAGGvsqPzcwGzp02lnMe2SmXADY1u9lbVjOhUrJpgvWfn9YuiCR+wjvaGMwIwzfJxChLJZOBV+1ad1CyNTiu6qAblxZ4F8cWlMWJ7f0KkWvtw66HOf2VNR6Qan2Ra7Q==</ds:SignatureValue>