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

Copy
1<?php
2
3// XMLドキュメントを正規化するサンプルコード
4function canonicalize_xml(string $xml_string, bool $exclusive = false, bool $withComments = false): ?string
5{
6    $dom = new DOMDocument();
7    $dom->loadXML($xml_string);
8
9    // C14N を実行
10    $canonical_xml = $dom->documentElement->C14N($exclusive, $withComments);
11
12    return $canonical_xml ?: null;
13}
14
15// サンプルXML
16$xml = <<<XML
17<root>
18  <child attribute="value">
19    <!-- コメント -->
20    Text Content
21  </child>
22</root>
23XML;
24
25// 正規化を実行
26$canonicalized_xml = canonicalize_xml($xml, false, false);
27
28// 結果を出力
29if ($canonicalized_xml) {
30    echo $canonicalized_xml . PHP_EOL;
31} else {
32    echo "正規化に失敗しました。" . PHP_EOL;
33}
34?>

このサンプルコードは、PHPのDOM拡張を用いてXMLドキュメントをC14N（Canonical XML）によって正規化する方法を示しています。C14Nは、XMLドキュメントを構文的に等価な一意の形式に変換する処理です。

canonicalize_xml関数は、XML文字列を受け取り、正規化されたXML文字列を返します。この関数は、DOMDocumentクラスを使用してXMLを解析し、ルート要素に対してC14Nメソッドを呼び出します。

C14Nメソッドは、以下の引数を受け取ります。

• $exclusive: 排他的な正規化を行うかどうかを指定するboolean値です。デフォルトはfalseです。
• $withComments: コメントを含めるかどうかを指定するboolean値です。デフォルトはfalseです。
• $xpath: 正規化の対象とするノードをXPath式で指定する配列です。nullの場合は、ドキュメント全体が対象となります。
• $nsPrefixes: 正規化する名前空間プレフィックスを配列で指定します。nullの場合は、すべての名前空間が対象となります。

C14Nメソッドは、正規化されたXML文字列を返します。エラーが発生した場合はfalseを返します。canonicalize_xml関数では、falseが返された場合にnullを返すようにしています。

サンプルでは、簡単なXML文字列を正規化し、結果を出力しています。$exclusiveと$withCommentsをfalseに設定しているため、排他的な正規化は行われず、コメントは出力から除外されます。

このコードは、XMLデータを扱う際に、データの整合性を保つために役立ちます。例えば、XML署名を作成する前にドキュメントを正規化することで、署名の検証が確実に行われるようにすることができます。

Copy
1<?php
2
3// XMLドキュメントをC14N 1.1形式で正規化する例
4function canonicalizeXml(string $xmlString): string|false
5{
6    $dom = new DOMDocument();
7    $dom->loadXML($xmlString);
8
9    // ルートノードを取得
10    $rootNode = $dom->documentElement;
11
12    // C14N 1.1形式で正規化
13    return $rootNode->C14N(true, true);
14}
15
16// XML文字列のサンプル
17$xmlString = <<<XML
18<root>
19  <child attribute="value">
20    <!-- コメント -->
21    Text content
22  </child>
23</root>
24XML;
25
26// 正規化されたXMLを出力
27$canonicalizedXml = canonicalizeXml($xmlString);
28
29if ($canonicalizedXml !== false) {
30    echo $canonicalizedXml . "\n";
31} else {
32    echo "C14N failed.\n";
33}
34
35?>

このPHPのサンプルコードは、XMLドキュメントをC14N (Canonical XML) 1.1形式で正規化する方法を示しています。C14Nは、XMLドキュメントを標準化された形式に変換するための仕様です。異なるシステム間でXMLデータを交換する際に、形式の差異による問題を回避できます。

canonicalizeXml関数は、XML文字列を受け取り、正規化されたXML文字列を返します。まず、DOMDocumentクラスを使用してXML文字列を読み込み、DOMオブジェクトを生成します。次に、ルートノードを取得し、C14Nメソッドを呼び出してXMLを正規化します。

C14Nメソッドは、Dom\Nodeクラスのメソッドで、XMLノードをC14N形式でシリアライズします。このメソッドには、以下の引数を指定できます。

• $exclusive: 排他的C14Nを使用するかどうかを指定します。trueの場合、排他的C14Nが適用されます。
• $withComments: コメントを含めるかどうかを指定します。trueの場合、コメントも出力されます。
• $xpath: 正規化対象のノードをXPathで指定します。nullの場合は、すべてのノードが対象となります。
• $nsPrefixes: 名前空間プレフィックスの配列を指定します。nullの場合は、すべての名前空間プレフィックスが対象となります。

サンプルコードでは、$exclusiveと$withCommentsをtrueに設定しています。これは、排他的C14Nを使用し、コメントも出力することを意味します。

C14Nメソッドは、正規化されたXML文字列を返すか、エラーが発生した場合はfalseを返します。サンプルコードでは、返り値がfalseでないことを確認し、正規化されたXMLを出力します。