Further finalize abstract

Author: tvdijen

src/XML/AbstractSignedXMLElement.php

@@ -5,10 +5,9 @@
 namespace SimpleSAML\XML;
 
 use DOMElement;
-use SimpleSAML\XML\DOMDocumentFactory;
-use SimpleSAML\XML\Exception\MissingAttributeException;
-use Serializable;
-use SimpleSAML\Assert\Assert;
+use SimpleSAML\XMLSecurity\XML\ds\Signature;
+use SimpleSAML\XMLSecurity\XML\SignableElementInterface;
+use SimpleSAML\XMLSecurity\XML\SignedElementInterface;
 
 /**
  * Abstract class to be implemented by all signed classes
@@ -19,12 +18,6 @@ abstract class AbstractSignedXMLElement implements SignedElementInterface
 {
     use SignedElementTrait;
 
-    /**
-     * Create a document structure for this element
-     *
-     * @param \DOMElement|null $parent The element we should append to.
-     * @return \DOMElement
-     */
     /**
      * The signed DOM structure.
      *
@@ -35,7 +28,87 @@ abstract class AbstractSignedXMLElement implements SignedElementInterface
     /**
      * The unsigned elelement.
      *
-     * @var \SimpleSAML\XML\AbstractXMLElement
+     * @var \SimpleSAML\XMLSecurity\SignableElementInterface
+     */
+    protected SignableElementInterface $element;
+
+
+    /**
+     * Create/parse an alg:SigningMethod element.
+     *
+     * @param \DOMElement $xml
+     * @param \SimpleSAML\XMLSecurity\XML\SignedElementInterface $elt
+     * @param \SimpleSAML\XMLSecurity\XML\ds\Signature $signature
+     */
+    private function __construct(DOMElement $xml, SignedElementInterface $elt, Signature $signature)
+    {
+        $this->setStructure($xml);
+        $this->setElement($elt);
+        $this->setSignature($signature);
+    }
+
+
+    /**
+     * Collect the value of the unsigned element
+     *
+     * @return \SimpleSAML\XMLSecurity\XML\SignableElementInterface
+     */
+    public function getElement(): SignableElementInterface
+    {
+        return $this->element;
+    }
+
+
+    /**
+     * Set the value of the elment-property
+     *
+     * @param \SimpleSAML\XMLSecurity\XML\SignableElementInterface $elt
+     */
+    private function setElement(SignableElementInterface $elt): void
+    {
+        $this->element = $elt;
+    }
+
+
+    /**
+     * Collect the value of the structure-property
+     *
+     * @return \DOMElement
+     */
+    public function getStructure(): DOMElement
+    {
+        return $this->structure;
+    }
+
+
+    /**
+     * Set the value of the structure-property
+     *
+     * @param \DOMElement $structure
+     */
+    private function setStructure(DOMElement $structure): void
+    {
+        $this->structure = $structure;
+    }
+
+
+    /**
+     * Create XML from this class
+     *
+     * @param \DOMElement|null $parent
+     * @return \DOMElement
+     */
+    public function toXML(DOMElement $parent = null): DOMElement
+    {
+        return $this->structure;
+    }
+
+
+    /**
+     * Create a class from XML
+     *
+     * @param \DOMElement $xml
+     * @return self
      */
-    protected AbstractXMLElement $elt;
+    abstract public static function fromXML(DOMElement $xml): object;
 }

src/XML/SignableElementInterface.php

@@ -1,8 +1,10 @@
 <?php
 
-namespace SimpleSAML\SAML2\XML;
+declare(strict_types=1);
 
-use SimpleSAML\XMLSecurity\SignedElementInterface;
+namespace SimpleSAML\XMLSecurity\XML;
+
+use SimpleSAML\XMLSecurity\XML\SignedElementInterface;
 use SimpleSAML\XMLSecurity\XMLSecurityKey;
 
 /**
@@ -17,7 +19,7 @@ interface SignableElementInterface
      *
      * @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\SignedElementInterface
+     * @return \SimpleSAML\XMLSecurity\XML\SignedElementInterface
      */
     public function sign(XMLSecurityKey $signingKey, array $certificates): SignedElementInterface;
 }

src/XML/SignableElementTrait.php

@@ -22,21 +22,21 @@ trait SignableElementTrait
     /**
      * Sign the given XML element.
      *
-     * @param \SimpleSAML\XMLSecurity\XMLSecurityKey $signKey The private key used for signing.
+     * @param \SimpleSAML\XMLSecurity\XMLSecurityKey $signingKey The private key used for signing.
      * @param array $certificates  Any public key to be added to the ds:Signature
      * @param \DOMNode|null $insertBefore  A specific node in the DOM structure where the ds:Signature should be put in front.
      * @return \DOMElement The signed element.
      * @throws \Exception If an error occurs while trying to sign.
      */
-    private function toSignedXML(XMLSecurityKey $signKey, array $certificates, DOMNode $insertBefore = null): DOMElement
+    private function toSignedXML(XMLSecurityKey $signingKey, array $certificates, DOMNode $insertBefore = null): DOMElement
     {
         $root = $this->toXML();
 
         if ($insertBefore !== null) {
-            XMLSecurityUtils::insertSignature($this->signingKey, $this->certificates, $root, $insertBefore);
+            XMLSecurityUtils::insertSignature($signingKey, $certificates, $root, $insertBefore);
             $doc = clone $root->ownerDocument;
         } else {
-            $signature = new Signature($this->signingKey->getAlgorithm(), $this->certificates, $this->signingKey);
+            $signature = new Signature($signingKey->getAlgorithm(), $certificates, $signingKey);
             $signature->toXML($root);
         }
 

src/XML/SignedElementInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace SimpleSAML\SAML2\XML;
 
 use SimpleSAML\XMLSecurity\XMLSecurityKey;