Move utilities to the place where they belong

Author: tvdijen

src/Utils/XML.php

@@ -5,7 +5,11 @@
 namespace SimpleSAML\XMLSecurity\XML;
 
 use DOMElement;
-use SimpleSAML\XMLSecurity\Utils\XML;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XMLSecurity\Constants as C;
+use SimpleSAML\XMLSecurity\Exception\ReferenceValidationFailedException;
+use SimpleSAML\XMLSecurity\Utils\XPath;
+use SimpleSAML\XMLSecurity\XML\ds\Transforms;
 
 /**
  * A trait implementing the CanonicalizableElementInterface.
@@ -25,6 +29,64 @@ trait CanonicalizableElementTrait
     abstract protected function getOriginalXML(): DOMElement;
 
 
+    /**
+     * Canonicalize any given node.
+     *
+     * @param \DOMElement $element The DOM element that needs canonicalization.
+     * @param string $c14nMethod The identifier of the canonicalization algorithm to use.
+     *   See \SimpleSAML\XMLSecurity\Constants.
+     * @param string[]|null $xpaths An array of xpaths to filter the nodes by. Defaults to null (no filters).
+     * @param string[]|null $prefixes An array of namespace prefixes to filter the nodes by.
+     *   Defaults to null (no filters).
+     *
+     * @return string The canonical representation of the given DOM node, according to the algorithm requested.
+     */
+    public function canonicalizeData(
+        DOMElement $element,
+        string $c14nMethod,
+        ?array $xpaths = null,
+        ?array $prefixes = null,
+    ): string {
+        $withComments = match ($c14nMethod) {
+            C::C14N_EXCLUSIVE_WITH_COMMENTS, C::C14N_INCLUSIVE_WITH_COMMENTS => true,
+            default => false,
+        };
+        $exclusive = match ($c14nMethod) {
+            C::C14N_EXCLUSIVE_WITH_COMMENTS, C::C14N_EXCLUSIVE_WITHOUT_COMMENTS => true,
+            default => false,
+        };
+
+        if (
+            is_null($xpaths)
+            && ($element->ownerDocument !== null)
+            && ($element->ownerDocument->documentElement !== null)
+            && $element->isSameNode($element->ownerDocument->documentElement)
+        ) {
+            // check for any PI or comments as they would have been excluded
+            $current = $element;
+            for ($refNode = $current->previousSibling; $refNode !== null; $current = $refNode) {
+                if (
+                    (($refNode->nodeType === XML_COMMENT_NODE) && $withComments)
+                    || $refNode->nodeType === XML_PI_NODE
+                ) {
+                    break;
+                }
+            }
+
+            if ($refNode === null) {
+                $element = $element->ownerDocument;
+            }
+        }
+
+        $ret = $element->C14N($exclusive, $withComments, $xpaths, $prefixes);
+        if ($ret === false) {
+            // GHSA-h25p-2wxc-6584
+            throw new CanonicalizationFailedException();
+        }
+        return $ret;
+    }
+
+
     /**
      * Get the canonical (string) representation of this object.
      *
@@ -43,6 +105,60 @@ public function canonicalize(string $method, ?array $xpaths = null, ?array $pref
     }
 
 
+    /**
+     * Process all transforms specified by a given Reference element.
+     *
+     * @param \SimpleSAML\XMLSecurity\XML\ds\Transforms $transforms The transforms to apply.
+     * @param \DOMElement $data The data referenced.
+     *
+     * @return string The canonicalized data after applying all transforms specified by $ref.
+     *
+     * @see http://www.w3.org/TR/xmldsig-core/#sec-ReferenceProcessingModel
+     */
+    public function processTransforms(
+        Transforms $transforms,
+        DOMElement $data,
+    ): string {
+        $canonicalMethod = C::C14N_EXCLUSIVE_WITHOUT_COMMENTS;
+        $arXPath = null;
+        $prefixList = null;
+        foreach ($transforms->getTransform() as $transform) {
+            $canonicalMethod = $transform->getAlgorithm()->getValue();
+            switch ($canonicalMethod) {
+                case C::C14N_EXCLUSIVE_WITHOUT_COMMENTS:
+                case C::C14N_EXCLUSIVE_WITH_COMMENTS:
+                    $inclusiveNamespaces = $transform->getInclusiveNamespaces();
+                    if ($inclusiveNamespaces !== null) {
+                        $prefixes = $inclusiveNamespaces->getPrefixes();
+                        if ($prefixes !== null) {
+                            $prefixList = array_map('strval', $prefixes->toArray());
+                        }
+                    }
+                    break;
+                case XPATH_C::XPATH10_URI:
+                    $xpath = $transform->getXPath();
+                    if ($xpath !== null) {
+                        $arXPath = [];
+                        $xpathValue = $xpath->getContent()->getValue();
+                        $arXPath['query'] = '(.//. | .//@* | .//namespace::*)[' . $xpathValue . ']';
+
+//                        $arXpath['namespaces'] = $xpath->getNamespaces();
+                        // TODO: review if $nsnode->localName is equivalent to the keys in getNamespaces()
+//                        $nslist = $xp->query('./namespace::*', $node);
+//                        foreach ($nslist as $nsnode) {
+//                            if ($nsnode->localName != "xml") {
+//                                $arXPath['namespaces'][$nsnode->localName] = $nsnode->nodeValue;
+//                            }
+//                        }
+                    }
+                    break;
+            }
+        }
+
+        return $this->canonicalizeData($data, $canonicalMethod, $arXPath, $prefixList);
+    }
+
+
     /**
      * Serialize this canonicalisable element.
      *