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

Copy
1<?php
2
3/**
4 * Dom\EntityReference::C14N の使用例を示します。
5 *
6 * この関数は、DTD（文書型定義）で定義されたエンティティ参照を含むXMLを作成し、
7 * そのエンティティ参照ノードを正規化（C14N）して結果を出力します。
8 * 正規化とは、XMLの論理的な意味を変えずに、物理的な表現（バイト列）を
9 * 一意に定めるプロセスで、電子署名などで利用されます。
10 */
11function demonstrateEntityReferenceC14N(): void
12{
13    // 1. DTDとエンティティ参照を含むXML文字列を定義します。
14    // DTD内でエンティティ 'writer' を 'Sample Author' として定義し、
15    // <author> タグ内で '&writer;' として参照しています。
16    $xmlString = <<<XML
17<?xml version="1.0" encoding="UTF-8"?>
18<!DOCTYPE root [
19    <!ENTITY writer "Sample Author">
20]>
21<root>
22    <author>&writer;</author>
23</root>
24XML;
25
26    // 2. DOMDocumentオブジェクトを作成し、XMLを読み込みます。
27    $doc = new DOMDocument();
28    // 外部エンティティの読み込みを無効化しセキュリティを確保します（ベストプラクティス）。
29    if (!$doc->loadXML($xmlString, LIBXML_NONET)) {
30        echo "XMLの読み込みに失敗しました。\n";
31        return;
32    }
33
34    // 3. XPathを使用してエンティティ参照ノードを取得します。
35    // <author> タグの最初の子ノードがエンティティ参照ノードに該当します。
36    $xpath = new DOMXPath($doc);
37    $nodeList = $xpath->query('//author/node()');
38
39    if ($nodeList === false || $nodeList->length === 0) {
40        echo "ノードが見つかりませんでした。\n";
41        return;
42    }
43
44    $entityRefNode = $nodeList->item(0);
45
46    // 4. ノードが Dom\EntityReference のインスタンスであることを確認し、C14N() を実行します。
47    if ($entityRefNode instanceof Dom\EntityReference) {
48        // C14N() メソッドを呼び出し、ノードを正規化します。
49        // エンティティ参照ノードの場合、その中身（展開されたテキスト）が返されます。
50        $canonicalString = $entityRefNode->C14N();
51
52        // 5. 結果を出力します。
53        echo "エンティティ参照ノード '&" . $entityRefNode->nodeName . ";' の正規化結果:\n";
54        echo "--------------------------------------------------\n";
55        echo $canonicalString . "\n";
56    } else {
57        echo "エンティティ参照ノードが見つかりませんでした。\n";
58    }
59}
60
61// 関数を実行します。
62demonstrateEntityReferenceC14N();
63

PHPの Dom\EntityReference::C14N() メソッドは、XML文書内のエンティティ参照ノードを正規化し、その結果を文字列として取得します。正規化（C14N）とは、XMLの論理的な意味を保ったまま、その物理的なバイト表現を標準的な形式に統一する処理です。これにより、XMLデータがバイト単位で比較可能となり、電子署名の検証などで利用されます。

サンプルコードでは、まずDTD（文書型定義）で &writer; というエンティティ参照を定義したXML文字列を準備します。次に、このXMLを読み込んで &writer; にあたるエンティティ参照ノードを取得し、C14N() メソッドを呼び出しています。このメソッドが実行されると、エンティティ参照はその定義内容であるテキスト「Sample Author」に置き換えられ、正規化された文字列として返されます。

C14N() メソッドには、排他的正規化の指定やコメントを含めるかどうかの設定など、正規化のルールを制御するための引数がありますが、これらは省略可能です。メソッドの戻り値は、処理が成功した場合は正規化された文字列 (string)、失敗した場合は false となります。