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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * XML文字列から特定の処理命令ノードを抽出し、正規化（C14N）するサンプル関数。
7 *
8 * XMLの正規化（Canonicalization, C14N）とは、論理的に等価なXML文書を
9 * バイトレベルで同一の表現に変換するプロセスです。
10 * これは主にXMLデジタル署名などで、署名対象の一意性を保証するために使用されます。
11 *
12 * このサンプルでは、XML文書内の <?xml-stylesheet ... ?> という処理命令ノードを対象に、
13 * DOMProcessingInstruction::C14N() メソッドを使って正規化を行います。
14 *
15 * @return void
16 */
17function demonstrateProcessingInstructionC14N(): void
18{
19    // サンプルとなるXML文字列を定義します。
20    // <?xml-stylesheet ... ?> の部分が「処理命令 (Processing Instruction)」です。
21    $xmlString = <<<XML
22<?xml version="1.0" encoding="UTF-8"?>
23<?xml-stylesheet type="text/css" href="style.css" ?>
24<document>
25  <title>Sample Document</title>
26</document>
27XML;
28
29    // DOMDocumentオブジェクトを生成し、XMLを読み込みます。
30    $dom = new DOMDocument();
31    if (!$dom->loadXML($xmlString)) {
32        echo "XMLの読み込みに失敗しました。" . PHP_EOL;
33        return;
34    }
35
36    // 処理命令ノード (DOMProcessingInstruction) を探します。
37    $piNode = null;
38    foreach ($dom->childNodes as $node) {
39        // ノードの型が処理命令 (XML_PI_NODE) であるかチェックします。
40        if ($node instanceof DOMProcessingInstruction) {
41            $piNode = $node;
42            break; // 最初に見つかった処理命令ノードを使用します。
43        }
44    }
45
46    // 処理命令ノードが見つかった場合のみ、正規化を実行します。
47    if ($piNode) {
48        // DOMProcessingInstruction::C14N() を呼び出して、ノードを正規化された文字列に変換します。
49        // 引数はデフォルト値（排他的正規化なし、コメントなし）を使用します。
50        $canonicalizedString = $piNode->C14N();
51
52        if ($canonicalizedString !== false) {
53            echo "元の処理命令ノードのターゲット: " . $piNode->target . PHP_EOL;
54            echo "元の処理命令ノードのデータ: " . $piNode->data . PHP_EOL;
55            echo "---" . PHP_EOL;
56            echo "正規化(C14N)された文字列:" . PHP_EOL;
57            echo $canonicalizedString . PHP_EOL;
58        } else {
59            echo "処理命令ノードの正規化に失敗しました。" . PHP_EOL;
60        }
61    } else {
62        echo "XML内に処理命令ノードが見つかりませんでした。" . PHP_EOL;
63    }
64}
65
66// 関数を実行して結果を表示します。
67demonstrateProcessingInstructionC14N();
68

DOMProcessingInstructionクラスのC14N()メソッドは、XMLの処理命令ノードを「正規化（C14N）」し、その結果を文字列として返します。XMLの正規化とは、意味が同じであれば異なる書き方（例: 属性の順序や空白）が許されるXML文書を、バイトレベルで完全に同一の表現に統一する処理です。これにより、デジタル署名などでデータが改ざんされていないことを正確に検証できます。

このサンプルコードでは、まずXML文字列を読み込み、ループ処理で<?xml-stylesheet ... ?>という処理命令ノード（DOMProcessingInstructionオブジェクト）を取得します。次に、そのオブジェクトに対してC14N()メソッドを呼び出すことで、ノードを正規化された文字列に変換しています。引数を省略しているため、デフォルトの設定（排他的正規化なし、コメントを含まない）で処理が実行されます。

戻り値は、処理が成功した場合は正規化された文字列、失敗した場合はfalseです。コード内では、戻り値がfalseでないことを確認してから結果を出力しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMProcessingInstruction::C14N() の使用例を示します。
7 *
8 * XMLドキュメント内の処理命令ノード（Processing Instruction Node）を取得し、
9 * それを正規化（Canonicalization）して文字列として出力します。
10 */
11function demonstrateProcessingInstructionC14N(): void
12{
13    // 処理命令（<?xml-stylesheet ...?>）を含むXML文字列を準備します。
14    $xmlString = <<<XML
15    <?xml version="1.0" encoding="UTF-8"?>
16    <?xml-stylesheet type="text/css" href="style.css"?>
17    <root>
18      <item>This is a sample XML.</item>
19    </root>
20    XML;
21
22    // DOMDocumentオブジェクトを作成し、XMLを読み込みます。
23    $document = new DOMDocument();
24    $document->loadXML($xmlString);
25
26    // 処理命令ノード（型が XML_PI_NODE）を検索します。
27    $piNode = null;
28    foreach ($document->childNodes as $node) {
29        if ($node->nodeType === XML_PI_NODE) {
30            // DOMProcessingInstructionオブジェクトが見つかったらループを抜けます。
31            /** @var DOMProcessingInstruction $node */
32            $piNode = $node;
33            break;
34        }
35    }
36
37    // 処理命令ノードが見つからない場合は処理を中断します。
38    if ($piNode === null) {
39        echo 'Processing Instruction node not found.' . PHP_EOL;
40        return;
41    }
42
43    // C14N()メソッドを呼び出して、ノードを正規化された文字列に変換します。
44    // C14N (Canonicalization) は、論理的に等価なXML文書が
45    // バイトレベルで同一表現となるように変換するプロセスです。
46    $canonicalizedString = $piNode->C14N();
47
48    // 結果を出力します。
49    if ($canonicalizedString !== false) {
50        echo '--- Original Processing Instruction Node ---' . PHP_EOL;
51        echo $document->saveXML($piNode) . PHP_EOL;
52        echo PHP_EOL;
53        echo '--- Canonicalized (C14N) String ---' . PHP_EOL;
54        echo $canonicalizedString . PHP_EOL;
55    } else {
56        echo 'Failed to canonicalize the node.' . PHP_EOL;
57    }
58}
59
60// 関数を実行してサンプルコードの動作を確認します。
61demonstrateProcessingInstructionC14N();

このPHPサンプルコードは、XML文書内の処理命令ノード（DOMProcessingInstruction）を正規化（C14N）する方法を示します。処理命令ノードとは、<?xml-stylesheet ...?>のように、XMLプロセッサに特定の指示を与えるためのノードです。

コードはまず、処理命令を含むXML文字列をDOMDocumentオブジェクトに読み込みます。次に、DOMツリーの中から目的の処理命令ノードを探し出し、DOMProcessingInstructionオブジェクトとして取得します。

そして、このオブジェクトに対してC14N()メソッドを呼び出します。C14N()は「Canonicalization」の略で、XMLの論理的な意味を保ったまま、物理的な表現（バイト列）を標準的な形式に統一する処理です。これにより、見た目が少し違うXMLでも、内容が同じであれば同一の文字列として比較できるようになります。

このメソッドは、引数を指定することで正規化のルールを細かく制御できますが、このサンプルではデフォルト設定で実行しています。戻り値として正規化された文字列を返しますが、処理に失敗した場合はfalseが返されます。最終的に、元のノードのXML表現と、C14N()によって生成された正規化後の文字列を並べて出力し、その結果を確認できます。