【PHP8.x】C14Nメソッドの使い方

Copy
1<?php
2
3/**
4 * DOMAttr::C14N メソッドの基本的な使用方法を示すサンプルコード。
5 * XMLドキュメント内の属性を正規化し、その文字列表現を出力します。
6 *
7 * PHP 8で導入された DOMAttr::C14N メソッドを利用します。
8 */
9function demonstrateDomAttrC14N(): void
10{
11    // サンプルXML文字列を定義します。
12    // ここでは、<element>要素に 'attribute_name' という属性を持つシンプルなXMLを使用します。
13    $xmlString = '<root><element attribute_name="attribute value"/></root>';
14
15    // DOMDocument オブジェクトを作成します。
16    // これにより、XMLドキュメントをPHPで操作できるようになります。
17    $dom = new DOMDocument();
18
19    // XML文字列をDOMDocumentにロードします。
20    // ロードに失敗した場合はエラーメッセージを表示し、処理を終了します。
21    if (!$dom->loadXML($xmlString)) {
22        echo "XMLのロードに失敗しました。\n";
23        return;
24    }
25
26    // ドキュメントから 'element' というタグ名の最初の要素を取得します。
27    // getElementsByTagName() はDOMNodeListを返すため、item(0)で最初の要素を取得します。
28    $element = $dom->getElementsByTagName('element')->item(0);
29
30    // 取得した要素がDOMElementのインスタンスでない場合（つまり、'element'要素が見つからなかった場合）は、
31    // エラーメッセージを表示して処理を終了します。
32    if (!$element instanceof DOMElement) {
33        echo "要素 'element' が見つかりませんでした。\n";
34        return;
35    }
36
37    // 取得した要素から 'attribute_name' という名前の属性ノードを取得します。
38    $attribute = $element->getAttributeNode('attribute_name');
39
40    // 取得した属性ノードがDOMAttrのインスタンスでない場合（つまり、'attribute_name'属性が見つからなかった場合）は、
41    // エラーメッセージを表示して処理を終了します。
42    if (!$attribute instanceof DOMAttr) {
43        echo "属性 'attribute_name' が見つかりませんでした。\n";
44        return;
45    }
46
47    // DOMAttr::C14N() メソッドを呼び出し、属性の正規化された文字列表現を取得します。
48    // 引数を指定しない場合、デフォルトで非排他的正規化が行われ、コメントは含めません。
49    // このメソッドは成功すると文字列を、失敗すると false を返します。
50    $c14nString = $attribute->C14N();
51
52    // 正規化の結果を出力します。
53    echo "元の属性名: " . $attribute->name . "\n";
54    echo "元の属性値: " . $attribute->value . "\n";
55    // C14Nの結果が false でないことを確認し、成功時はその文字列を、失敗時は「失敗」と表示します。
56    echo "正規化された属性文字列 (C14N): " . ($c14nString !== false ? $c14nString : "失敗") . "\n";
57}
58
59// 上記の関数を実行して、DOMAttr::C14N メソッドの動作を確認します。
60demonstrateDomAttrC14N();

このサンプルコードは、PHPのDOMAttr::C14Nメソッドを使ってXMLドキュメント内の属性を正規化する方法を示しています。まず、DOMDocumentクラスを利用してXML文字列を読み込み、PHPで操作可能なXMLドキュメントを作成します。次に、そのドキュメントから特定の要素（element）と、その要素に紐づく属性ノード（attribute_name）をそれぞれ取得します。

DOMAttr::C14N()メソッドは、取得したDOMAttrインスタンスに対して呼び出され、その属性ノードをCanonical XML（C14N）のルールに従って正規化された文字列として返します。C14Nは、XMLの構文上の違いを吸収し、内容が同じXMLを常に同じ文字列表現にするための標準化手法で、XMLの比較や電子署名などに不可欠です。

このメソッドは、$exclusiveや$withCommentsなどの引数を受け取りますが、サンプルでは引数なしで呼び出すことで、デフォルトの基本的な正規化を適用しています。処理が成功すると正規化された属性の文字列が返され、失敗した場合はブール値のfalseが返されます。最終的に、元の属性名と値、そして正規化された属性の文字列表現が出力され、DOMAttr::C14Nの動作が確認できます。

Copy
1<?php
2
3/**
4 * DOMAttr::C14N() メソッドの使用例。
5 *
6 * この関数は、XML属性の正規化された文字列を生成する方法を示します。
7 * C14N (Canonical XML) は、XMLドキュメントの一意なテキスト表現を生成するプロセスで、
8 * 特にデジタル署名などのセキュリティ関連の用途でXMLの同一性を保証するために重要です。
9 * キーワード「c14n11」はCanonical XML 1.1に言及していますが、PHPのDOM拡張における
10 * DOMAttr::C14Nメソッドは主にCanonical XML 1.0の仕様に基づいています。
11 * exclusiveパラメータをtrueに設定することで、排他的正規化（Exclusive Canonicalization）の挙動を
12 * 簡易的に確認できます。これは、名前空間宣言の扱いにおいてC14N 1.1との関連が深い考え方です。
13 */
14function demonstrateDomAttrC14N(): void
15{
16    // サンプルXML文字列を定義
17    // 名前空間と属性を含むシンプルなXML構造を使用します。
18    $xmlString = <<<XML
19<root xmlns="http://example.com/default-ns" xmlns:my="http://example.com/my-ns">
20    <element my:attr="value with &quot;quotes&quot;">
21        <child />
22    </element>
23</root>
24XML;
25
26    // DOMDocumentオブジェクトを初期化し、XMLをロード
27    $dom = new DOMDocument();
28    $dom->loadXML($xmlString);
29
30    // XPathを使用して目的の属性ノードを取得します。
31    // 今回は <element my:attr="..." /> の 'my:attr' 属性を対象とします。
32    $xpath = new DOMXPath($dom);
33    $attr = $xpath->query('//element/@my:attr')->item(0);
34
35    if ($attr instanceof DOMAttr) {
36        echo "--- 属性 'my:attr' の正規化結果 ---\n";
37        echo "元の属性値: " . $attr->nodeValue . "\n\n";
38
39        // 1. 基本的な正規化 (デフォルト引数: exclusive = false)
40        // 属性名、値、およびその属性が使用する名前空間の宣言が
41        // 正規化された文字列に含まれることがあります。
42        $c14nDefault = $attr->C14N(false);
43        if ($c14nDefault !== false) {
44            echo "C14N (デフォルト): \n" . $c14nDefault . "\n\n";
45        } else {
46            echo "エラー: デフォルトのC14N処理が失敗しました。\n\n";
47        }
48
49        // 2. 排他的正規化 (exclusive = true)
50        // このモードでは、属性が所属する要素の親要素から継承される名前空間宣言が
51        // 結果に含まれません。属性が自身の名前空間プレフィックスの宣言を持つ場合、
52        // それらの宣言のみが考慮されます。これにより、XMLドキュメントの特定部分を
53        // 切り出して正規化する際に、ドキュメント全体のコンテキストに依存しない
54        // 一貫した表現を得ることができます。
55        $c14nExclusive = $attr->C14N(true);
56        if ($c14nExclusive !== false) {
57            echo "C14N (排他的): \n" . $c14nExclusive . "\n\n";
58        } else {
59            echo "エラー: 排他的C14N処理が失敗しました。\n\n";
60        }
61    } else {
62        echo "エラー: 指定された属性ノードが見つかりませんでした。\n";
63    }
64}
65
66// サンプル関数を実行
67demonstrateDomAttrC14N();

PHPのDOMAttr::C14N()メソッドは、XMLの属性ノードをCanonical XML（正規化されたXML）形式の文字列に変換します。これは、XMLドキュメント内の属性のテキスト表現を一意に確定させるために利用され、特にデジタル署名などでXMLの同一性を保証する際に重要な機能です。

このサンプルコードでは、まずXML文字列をDOMDocumentオブジェクトにロードし、XPathを使って<element my:attr="..." />のmy:attr属性ノードを取得しています。

C14N()メソッドは、デフォルトでexclusive引数がfalseとなっており、属性名やその値、および関連する名前空間宣言を含めて正規化された文字列を生成します。これは主にCanonical XML 1.0の原則に従います。

一方、exclusive引数をtrueに設定すると、排他的正規化が行われます。このモードでは、属性が所属する要素の親要素から継承される名前空間宣言は正規化結果に含まれません。これにより、XMLドキュメントの一部を切り出して正規化する際にも、ドキュメント全体の文脈に依存しない一貫した表現を得ることができます。キーワードの「c14n11」が示すCanonical XML 1.1では、この排他的正規化の考え方がより重要視されています。

メソッドは、正規化に成功すると結果の文字列を返し、失敗した場合はブール値のfalseを返します。引数$withCommentsは正規化結果にXMLコメントを含めるかを指定し、$xpathや$nsPrefixesはより詳細な正規化範囲や名前空間の制御に利用されます。