Add testable CustomSignable and CustomSigned

Author: tvdijen

bin/generate_CustomSignable.php

@@ -0,0 +1,16 @@
+<?php
+
+require_once('../vendor/autoload.php');
+
+use SimpleSAML\XML\Chunk;
+use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XMLSecurity\Test\XML\CustomSignable;
+use SimpleSAML\XMLSecurity\TestUtils\PEMCertificatesMock;
+use SimpleSAML\XMLSecurity\XMLSecurityKey;
+
+$chunk = new Chunk(DOMDocumentFactory::fromString('<some>Chunk</some>')->documentElement);
+$signable = new CustomSignable($chunk);
+
+$privateKey = PEMCertificatesMock::getPrivateKey(XMLSecurityKey::RSA_SHA256, PEMCertificatesMock::SELFSIGNED_PRIVATE_KEY);
+$x = $signable->sign($privateKey);
+echo $x->ownerDocument->saveXML();

tests/XML/CustomSignable.php

@@ -0,0 +1,134 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Test\XML;
+
+use DOMElement;
+use SimpleSAML\XML\AbstractXMLElement;
+use SimpleSAML\XML\Chunk;
+use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\Exception\TooManyElementsException;
+use SimpleSAML\XMLSecurity\XML\SignableElementInterface;
+use SimpleSAML\XMLSecurity\XML\SignableElementTrait;
+use SimpleSAML\XMLSecurity\XML\SignedElementInterface;
+use SimpleSAML\XMLSecurity\XMLSecurityKey;
+
+/**
+ * @package simplesamlphp\saml2
+ */
+final class CustomSignable extends AbstractXMLElement implements SignableElementInterface
+{
+    use SignableElementTrait;
+
+    /** @var string */
+    public const NS = 'urn:simplesamlphp:test';
+
+    /** @var string */
+    public const NS_PREFIX = 'ssp';
+
+    /** @var \SimpleSAML\XML\Chunk $element */
+    protected $element;
+
+    /**
+     * Constructor
+     *
+     * @param \SimpleSAML\XML\Chunk $elt
+     */
+    public function __construct(Chunk $elt) {
+        $this->setElement($elt);
+    }
+
+
+    /**
+     * Get the namespace for the element.
+     *
+     * @return string
+     */
+    public static function getNamespaceURI(): string
+    {
+        return static::NS;
+    }
+
+
+    /**
+     * Get the namespace-prefix for the element.
+     *
+     * @return string
+     */
+    public static function getNamespacePrefix(): string
+    {
+        return static::NS_PREFIX;
+    }
+
+
+    /**
+     * Collect the value of the $element property
+     *
+     * @return \SimpleSAML\XML\XML\Chunk
+     */
+    public function getElement(): Chunk
+    {
+        return $this->element;
+    }
+
+
+    /**
+     * Set the value of the elment-property
+     *
+     * @param \SimpleSAML\XML\Chunk $elt
+     */
+    private function setElement(Chunk $elt): void
+    {
+        $this->element = $elt;
+    }
+
+
+    /**
+     * Sign the 'Element' and return a 'SignedElement'
+     *
+     * @param \SimpleSAML\XMLSecurity\XMLSecurityKey $signingKey  The private key we should use to sign the message
+     * @param string[] $certificates  The certificates should be strings with the PEM encoded data
+     * @return \SimpleSAML\XMLSecurity\XML\SignedElementInterface
+     */
+    public function sign(XMLSecurityKey $signingKey, array $certificates = []): SignedElementInterface
+    {
+        return CustomSigned::fromXML($this->toSignedXML($signingKey, $certificates));
+    }
+
+
+    /**
+     * Convert XML into a CustomSignable
+     *
+     * @param \DOMElement $xml The XML element we should load
+     * @return \SimpleSAML\XMLSecurity\Test\XML\CustomSignable
+     *
+     * @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, 'CustomSignable', InvalidDOMElementException::class);
+        Assert::same($xml->namespaceURI, static::NS, InvalidDOMElementException::class);
+
+        Assert::count($xml->childNodes, 1, TooManyElementsException);
+        $element = new Chunk($xml->childNodes[0]);
+
+        return new self($element);
+    }
+
+
+    /**
+     * Convert this CustomSignable to XML.
+     *
+     * @param \DOMElement|null $element The element we are converting to XML.
+     * @return \DOMElement The XML element after adding the data corresponding to this CustomSignable.
+     */
+    public function toXML(DOMElement $parent = null): DOMElement
+    {
+        /** @psalm-var \DOMDocument $e->ownerDocument */
+        $e = $this->instantiateParentElement($parent);
+
+        $e->appendChild($e->ownerDocument->importNode($this->element->getXML(), true));
+        return $e;
+    }
+}

tests/XML/CustomSigned.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Test\XML;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\TooManyElementsException;
+use SimpleSAML\XML\Utils as XMLUtils;
+use SimpleSAML\XMLSecurity\XML\ds\Signature;
+use SimpleSAML\XMLSecurity\XML\AbstractSignedXMLElement;
+use SimpleSAML\XMLSecurity\XML\SignedElementInterface;
+use SimpleSAML\XMLSecurity\XML\SignedElementTrait;
+
+/**
+ * @package simplesamlphp\saml2
+ */
+final class CustomSigned extends AbstractSignedXMLElement
+{
+    use SignedElementTrait;
+
+
+    /**
+     * Create a class from XML
+     *
+     * @param \DOMElement $xml
+     * @return self
+     */
+    public static function fromXML(DOMElement $xml): object
+    {
+// Empty array
+$s = XMLUtils::xpQuery($xml, './ssp:CustomSignable/ds:Signature');
+var_dump($s);
+
+// Also empty array
+        $signature = Signature::getChildrenOfClass($xml);
+        Assert::count($signature, 1, TooManyElementsException::class);
+
+        $element = CustomSignable::getChildrenOfClass($xml);
+        Assert::count($element, 1, TooManyElementsException::class);
+
+        return new self(
+            $xml,
+            array_pop($element),
+            array_pop($signature)
+        );
+    }
+}