【PHP8.x】DOMNotation::C14N()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * XML文書をC14N（正規化）し、その結果を表示するサンプルコード。
7 * C14Nは "Canonical XML" の略で、XML文書を意味的に等価な
8 * 一意の物理表現（バイト列）に変換するプロセスです。
9 * これにより、デジタル署名や内容の比較が容易になります。
10 */
11function executeXmlC14nExample(): void
12{
13    // 正規化の対象となるXML文字列を定義します。
14    // 属性の順序が 'b', 'a' となっており、要素内に余分な空白が含まれています。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<document>
18  <element b="value2" a="value1">
19    Some   text
20  </element>
21</document>
22XML;
23
24    try {
25        // DOMDocumentオブジェクトを作成し、XMLを読み込みます。
26        $doc = new DOMDocument();
27        $doc->loadXML($xmlString);
28
29        // ドキュメント全体（ルート要素）に対してC14Nメソッドを呼び出します。
30        // このメソッドは DOMNode クラスで定義されており、DOMElement なども継承しています。
31        // 第1引数 (exclusive): 排他的正規化を行うか
32        // 第2引数 (withComments): コメントノードを含めるか
33        $canonicalXmlString = $doc->documentElement->C14N(false, false);
34
35        // 失敗した場合は false が返ります。
36        if ($canonicalXmlString === false) {
37            echo 'XMLの正規化に失敗しました。' . PHP_EOL;
38            return;
39        }
40
41        // 元のXMLと正規化後のXMLを比較して出力します。
42        echo '--- 元のXML ---' . PHP_EOL;
43        echo $xmlString . PHP_EOL . PHP_EOL;
44
45        echo '--- C14N (正規化) 後のXML ---' . PHP_EOL;
46        // 属性がアルファベット順 ('a', 'b') にソートされ、
47        // テキストノード周りの空白が整理されていることがわかります。
48        echo $canonicalXmlString . PHP_EOL;
49
50    } catch (Exception $e) {
51        // XMLのパースエラーなど、例外が発生した場合の処理
52        echo 'エラーが発生しました: ' . $e->getMessage() . PHP_EOL;
53    }
54}
55
56// この関数を実行します。
57executeXmlC14nExample();

DOMNode::C14N()は、XML文書を正規化（C14N）するためのメソッドです。正規化とは、XMLの意味的な内容を保ったまま、その物理的な表現を標準的で一意な形式に変換する処理を指します。これにより、属性の記述順や空白の有無といった表現上の差異を吸収できるため、XML文書が実質的に同一であるかを文字列として比較することが可能になります。デジタル署名の検証など、データの一貫性が求められる場面で利用されます。

サンプルコードでは、まずDOMDocumentオブジェクトに属性の順序が不揃いなXML文字列を読み込みます。次に、ドキュメントのルート要素に対してC14N()メソッドを実行し、正規化処理を行っています。

第1引数の$exclusiveは排他的正規化を行うか、第2引数の$withCommentsはコメントノードを出力に含めるかを真偽値で指定します。このメソッドは、処理が成功すると正規化されたXML文字列を返し、失敗した場合はfalseを返します。実行結果では、属性がアルファベット順にソートされ、テキストノード周りの不要な空白が整理されていることが確認できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * XML文字列を排他的正規化(Exclusive C14N)するサンプルコード
7 *
8 * この関数は、XML文字列からDOMDocumentオブジェクトを生成し、
9 * C14N()メソッドを使用してXMLを正規化形式の文字列に変換します。
10 * 正規化により、属性の順序が統一され、不要な空白やコメントが削除されます。
11 * これは、XML署名などで文書の一貫性を保証するために利用されます。
12 *
13 * @see https://www.php.net/manual/ja/domnode.c14n.php
14 */
15function generateCanonicalXmlExample(): void
16{
17    // 正規化対象のXMLデータ。
18    // 属性の順序が統一されておらず、余分な空白やコメントが含まれています。
19    $originalXml = <<<XML
20<?xml version="1.0" encoding="UTF-8"?>
21<root xmlns:ns1="http://example.com/ns1">
22    <!-- This is a comment -->
23    <child   attr2="value2"   attr1="value1">
24        Some Text
25    </child>
26</root>
27XML;
28
29    // DOMDocumentオブジェクトをインスタンス化
30    $doc = new DOMDocument();
31
32    // XML文字列を読み込む
33    if (!$doc->loadXML($originalXml)) {
34        echo "Failed to load XML." . PHP_EOL;
35        return;
36    }
37
38    // XMLを排他的正規化（Exclusive XML Canonicalization）します。
39    // キーワード 'c14n11' は、多くの場合この排他的正規化を指します。
40    // 第1引数 (exclusive) を true に設定します。
41    // 第2引数 (with_comments) を false に設定し、コメントを除外します。
42    $canonicalXmlString = $doc->C14N(true, false);
43
44    // --- 結果の出力 ---
45    echo "--- Original XML ---" . PHP_EOL;
46    echo $originalXml . PHP_EOL;
47    echo PHP_EOL;
48
49    echo "--- Canonicalized XML (Exclusive C14N) ---" . PHP_EOL;
50    if ($canonicalXmlString !== false) {
51        // 正規化されたXMLは、属性が統一された順序になり、
52        // コメントや余分な空白が除去されます。
53        echo $canonicalXmlString . PHP_EOL;
54    } else {
55        echo "Failed to canonicalize XML." . PHP_EOL;
56    }
57}
58
59// 関数を実行して正規化の例を表示
60generateCanonicalXmlExample();

このサンプルコードは、PHPのDOMDocumentクラスが持つC14Nメソッドを使い、XMLデータを正規化（Canonicalization）する方法を解説するものです。正規化とは、意味が同じでもテキスト表現が異なるXML文書を、決められたルールに従って一意の形式に変換する処理を指します。これにより、属性の順序が統一され、不要な空白やコメントが削除されます。この技術は、XML署名などで文書の同一性を厳密に検証する際に不可欠です。

コード内では、C14Nメソッドの第1引数にtrueを指定し、「排他的正規化（Exclusive C14N）」を実行しています。これはXML文書の一部を扱う際に、その部分に関連する名前空間宣言だけを保持する正規化方式です。第2引数にfalseを指定することで、XML内のコメントは除去されます。このメソッドは、処理が成功すると正規化されたXML文字列を返し、失敗した場合はfalseを返します。

実行結果では、元のXMLに含まれていたコメントや要素内の余分な空白が取り除かれ、child要素の属性がアルファベット順（attr1, attr2）に並べ替えられた、一貫性のあるXML文字列が出力されることを確認できます。