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

Copy
1<?php
2
3/**
4 * PHPのオブジェクトが unserialize() される際に自動的に呼び出される
5 * マジックメソッド __wakeup() の動作を示すサンプルです。
6 *
7 * このメソッドは、デシリアライズによってオブジェクトが復元された後、
8 * そのオブジェクトの初期化状態を再確立するために使用されます。
9 * 例えば、デシリアライズ中に失われたデータベース接続を再確立したり、
10 * リソースハンドルを再オープンしたりするのに適しています。
11 *
12 * 【Dom\Attr::__wakeup についての注意】
13 * リファレンスに記載のある Dom\Attr クラスにも __wakeup メソッドが存在します。
14 * しかし、DOM オブジェクト（Dom\Attr も含む）は PHP の serialize() 関数で
15 * 直接シリアライズすることはできません。Dom\Attr の __wakeup メソッドは、
16 * DOM 拡張の内部的な処理で利用されるものであり、
17 * ユーザーコードで直接扱うことは通常ありません。
18 */
19class ExampleClassWithWakeup
20{
21    private string $internalMessage;
22    private bool $wasWakeupCalled;
23
24    /**
25     * コンストラクタ: オブジェクトが初めて作成されるときに呼び出されます。
26     */
27    public function __construct(string $initialMessage)
28    {
29        $this->internalMessage = $initialMessage;
30        $this->wasWakeupCalled = false; // 初期状態では __wakeup はまだ呼ばれていない
31        echo "[__construct] オブジェクトが初期化されました。メッセージ: '{$this->internalMessage}'\n";
32    }
33
34    /**
35     * __wakeup() マジックメソッド:
36     * オブジェクトが unserialize() される直前（プロパティが復元された直後）に
37     * 自動的に呼び出されます。引数はなく、戻り値は void です。
38     */
39    public function __wakeup(): void
40    {
41        // デシリアライズされたオブジェクトに対して、
42        // 追加のセットアップ処理や状態の調整を行います。
43        $this->wasWakeupCalled = true; // __wakeup が呼び出されたことを記録
44        $this->internalMessage .= " (デシリアライズ後に__wakeupで再設定済み)";
45        echo "[__wakeup] メソッドが呼び出され、オブジェクトの状態が再設定されました。\n";
46    }
47
48    /**
49     * オブジェクトの現在の状態を文字列で返します。
50     */
51    public function getStatus(): string
52    {
53        return "現在のメッセージ: '{$this->internalMessage}', __wakeup 呼び出し済み: " . ($this->wasWakeupCalled ? 'はい' : 'いいえ');
54    }
55}
56
57// --- サンプルコードの実行 ---
58
59echo "--- 1. オブジェクトの作成とシリアライズ ---\n";
60// 新しいオブジェクトを作成します。この際、ExampleClassWithWakeup::__construct() が呼び出されます。
61$originalObject = new ExampleClassWithWakeup("初期データ");
62echo "オリジナルオブジェクトの状態: " . $originalObject->getStatus() . "\n\n";
63
64// オブジェクトをシリアライズ（文字列に変換）します。
65// このとき、オブジェクトのプロパティが文字列として保存されます。
66$serializedData = serialize($originalObject);
67echo "シリアライズされたデータ:\n{$serializedData}\n\n";
68
69// 元のオブジェクトをメモリからクリアします。
70// これにより、後でデシリアライズによって完全に新しい独立したオブジェクトが作成されることを示します。
71unset($originalObject);
72echo "元のオブジェクトをメモリからクリアしました。\n\n";
73
74echo "--- 2. オブジェクトのデシリアライズ ---\n";
75// シリアライズされたデータからオブジェクトを復元します。
76// 復元処理では、まずプロパティが設定され、その後 ExampleClassWithWakeup::__wakeup() メソッドが
77// 自動的に呼び出され、追加の初期化が行われます。
78$restoredObject = unserialize($serializedData);
79
80echo "\n復元されたオブジェクトの状態: " . $restoredObject->getStatus() . "\n";
81
82?>

PHPの__wakeupメソッドは、unserialize()関数を使ってオブジェクトをデータから復元する際に、自動的に呼び出される特別なマジックメソッドです。このメソッドは、オブジェクトのプロパティがメモリ上に復元された直後、つまりデシリアライズ処理の最終段階で実行されます。

__wakeupの主な目的は、デシリアライズによって失われた可能性のあるリソース（例えばデータベース接続やファイルハンドル）を再確立したり、オブジェクトの内部状態を適切に再初期化したりすることです。引数はなく、戻り値もありません（void）。

サンプルコードのExampleClassWithWakeupクラスでは、__wakeupメソッドが定義されており、unserialize()によってオブジェクトが復元されると、このメソッドが自動的に呼び出されます。その結果、オブジェクトのメッセージが追加修正され、__wakeupが実行されたことが記録されます。これにより、復元されたオブジェクトが必要な初期設定を終え、利用可能な状態になることを示しています。

リファレンスにあるDom\Attr::__wakeupメソッドは、DOM拡張の内部処理で使われるものです。DOMオブジェクトはPHPのserialize()で直接シリアライズできないため、このメソッドをユーザーコードで直接利用する機会は通常ありません。

Copy
1<?php
2
3/**
4 * ネイティブな Dom\Attr クラスは通常シリアライズ可能ではなく、
5 * デシリアライズ時に __wakeup メソッドが呼び出されることはありません。
6 * このサンプルコードは、ユーザーから提供されたリファレンス情報に基づき、
7 * Dom\Attr という名前のクラスに __wakeup メソッドが存在し、
8 * それがPHPのオブジェクトデシリアライズの仕組みでバイパス可能である、
9 * というシナリオを示すために、概念的なクラス MyDomAttr を使用しています。
10 *
11 * 実際のPHP環境では、組み込みクラス Dom\Attr と同名のクラスを
12 * ユーザーランドで宣言することはできません。
13 * このコードは、PHPの __wakeup バイパスの原理を理解するためのデモンストレーションです。
14 */
15class MyDomAttr
16{
17    public string $name;
18    public string $value;
19    private bool $is_validated_in_wakeup = false; // __wakeup で検証されたかを示すフラグ
20
21    /**
22     * コンストラクタ
23     * @param string $name 属性名
24     * @param string $value 属性値
25     */
26    public function __construct(string $name, string $value)
27    {
28        $this->name = $name;
29        $this->value = $value;
30        echo "[__construct] MyDomAttr オブジェクトが構築されました。\n";
31    }
32
33    /**
34     * オブジェクトのデシリアライズ時に自動的に呼び出されるマジックメソッド。
35     * 通常、オブジェクトの状態検証、リソースの再初期化、セキュリティチェックなどに使用されます。
36     * 攻撃者は、このメソッド内の重要な処理を回避（バイパス）しようとすることがあります。
37     *
38     * @return void
39     */
40    public function __wakeup(): void
41    {
42        echo "[__wakeup] __wakeup メソッドが呼び出されました。\n";
43        // ここで重要なセキュリティチェックやデータのクリーンアップ処理が行われると仮定します。
44        // 例: 属性値が安全なものであるか検証する。
45        if (strpos($this->value, '<script') !== false) {
46            error_log("潜在的なクロスサイトスクリプティング (XSS) 試行を検出しました。");
47            $this->value = htmlspecialchars($this->value, ENT_QUOTES, 'UTF-8');
48        }
49        $this->is_validated_in_wakeup = true; // __wakeup が実行されたことを記録
50        echo "[__wakeup] オブジェクトが __wakeup で検証されました。検証フラグ: " . ($this->is_validated_in_wakeup ? 'true' : 'false') . "\n";
51    }
52
53    /**
54     * オブジェクトの現在の情報を取得します。
55     *
56     * @return string
57     */
58    public function getInfo(): string
59    {
60        return "Name: {$this->name}, Value: {$this->value}, Validated in __wakeup: " . ($this->is_validated_in_wakeup ? 'true' : 'false');
61    }
62}
63
64echo "--- 通常のデシリアライズの例 --- \n";
65
66// 1. 健全なオブジェクトを作成します。
67$originalAttr = new MyDomAttr('data-id', '<script>alert("XSS")</script>');
68echo "元のオブジェクト情報: " . $originalAttr->getInfo() . "\n";
69
70// 2. オブジェクトをシリアライズします。
71$serializedAttr = serialize($originalAttr);
72echo "シリアライズされたデータ: " . $serializedAttr . "\n";
73// 出力例: O:10:"MyDomAttr":3:{s:4:"name";s:7:"data-id";s:5:"value";s:27:"<script>alert("XSS")</script>";s:22:" MyDomAttr is_validated_in_wakeup";b:0;}
74// ここで、オブジェクトのプロパティ数が「3」と示されています。
75
76// 3. 通常通りオブジェクトをデシリアライズします。
77//    この場合、__wakeup メソッドが呼び出され、値が検証・サニタイズされます。
78$deserializedAttr = unserialize($serializedAttr);
79echo "デシリアライズ後 (通常): " . $deserializedAttr->getInfo() . "\n";
80
81echo "\n--- __wakeup バイパスの例 --- \n";
82
83// 4. __wakeup メソッドをバイパスするための細工されたシリアライズデータを作成します。
84//    PHPのデシリアライズ機構の特性を利用し、オブジェクトのプロパティ数を
85//    意図的に実際よりも少ない値（例: 0）に偽装します。
86//    これにより、PHPはデータが破損していると判断し、__wakeup の呼び出しをスキップします。
87$bypassedSerializedAttr = str_replace(
88    'O:' . strlen('MyDomAttr') . ':"MyDomAttr":' . count((array)$originalAttr) . ':',
89    'O:' . strlen('MyDomAttr') . ':"MyDomAttr":0:', // プロパティ数を「0」に偽装
90    $serializedAttr
91);
92
93echo "細工されたシリアライズデータ: " . $bypassedSerializedAttr . "\n";
94
95// 5. 細工されたデータをデシリアライズします。
96//    __wakeup メソッドは呼び出されず、元の危険な値がそのままオブジェクトに復元されます。
97$bypassedAttr = unserialize($bypassedSerializedAttr);
98echo "デシリアライズ後 (バイパス): " . $bypassedAttr->getInfo() . "\n";
99
100// __wakeup がスキップされたことの確認
101if ($bypassedAttr->is_validated_in_wakeup === false) {
102    echo "\n成功: __wakeup メソッドがバイパスされ、検証処理がスキップされました。\n";
103    echo "注意: 危険な値がサニタイズされずに復元されました。\n";
104} else {
105    echo "\n失敗: __wakeup メソッドが呼び出されました。\n";
106}
107
108?>

PHPのDom\Attr::__wakeupメソッドは、XMLやHTMLの属性を扱う組み込みクラスDom\Attrのオブジェクトが、シリアライズデータから復元（デシリアライズ）される際に自動的に呼び出される特別な「マジックメソッド」です。このメソッドは引数を受け取らず、戻り値もありません（void）。通常、デシリアライズ後のオブジェクトの状態検証、リソースの再初期化、またはセキュリティチェックなどに利用されます。

本サンプルコードは、組み込みのDom\Attrクラスが通常シリアライズできないため、概念的なMyDomAttrクラスを用いて__wakeupメソッドの仕組みと、そのセキュリティ上の脆弱性である「__wakeupバイパス」の原理をシステムエンジニアを目指す初心者向けに示しています。

このバイパス手法は、PHPのデシリアライズ機構の特性を悪用し、シリアライズデータ内のオブジェクトのプロパティ数を意図的に誤った値に偽装することで発生します。PHPはプロパティ数が不正であると判断すると、データ破損とみなし、本来実行されるべき__wakeupメソッドの呼び出しをスキップします。これにより、__wakeupメソッド内で想定されていた重要な検証やセキュリティ処理が実行されず、攻撃者が仕込んだ悪意のあるデータがそのままオブジェクトに復元されるリスクが生じます。この危険性を理解し、デシリアライズ処理の実装には十分な注意が必要です。

Copy
1<?php
2
3/**
4 * Dom\Attr::__wakeup メソッドの概念を理解するためのサンプルコードです。
5 *
6 * Dom\Attr クラスは DOMNode を継承しており、DOMNode オブジェクトは直接シリアライズできません。
7 * そのため、Dom\Attr::__wakeup を直接実行して動作を確認するサンプルは作成できませんが、
8 * PHP の __wakeup マジックメソッドの一般的な動作を示すことで、その役割を理解できます。
9 * Dom\Attr::__wakeup も、DOM 拡張の内部で、オブジェクトがデシリアライズされる際に
10 * オブジェクトの内部的な整合性を保つために利用されます。
11 */
12
13// __wakeup マジックメソッドの一般的な動作を示すカスタムクラス
14class MySerializableObject
15{
16    public string $data;
17    public ?string $restoredInfo = null;
18
19    public function __construct(string $data)
20    {
21        $this->data = $data;
22        echo "MySerializableObject: コンストラクタが呼び出されました。初期データ: '{$this->data}'\n";
23    }
24
25    /**
26     * オブジェクトがシリアライズされる直前に呼び出されます。
27     * ここで、シリアライズするプロパティの配列を返します。
28     * Dom\Attr (および DOMNode) はこのシリアライズプロセスが内部的に制限されています。
29     *
30     * @return array<string> シリアライズするプロパティ名の配列
31     */
32    public function __sleep(): array
33    {
34        echo "MySerializableObject: __sleep() が呼び出されました。'data' プロパティをシリアライズします。\n";
35        return ['data']; // 'data' プロパティのみをシリアライズ対象とする
36    }
37
38    /**
39     * オブジェクトがデシリアライズされる直前に呼び出されるマジックメソッドです。
40     * このメソッドは、デシリアライズされたオブジェクトが使用可能になる前に、
41     * 必要な初期化処理（例: データベース接続の再確立、リソースの復元）を行うのに適しています。
42     * Dom\Attr::__wakeup も同様に、DOM オブジェクトの内部的な状態を再構築するために利用されます。
43     *
44     * @return void
45     */
46    public function __wakeup(): void
47    {
48        echo "MySerializableObject: __wakeup() が呼び出されました。オブジェクトの再初期化処理を行います。\n";
49        $this->restoredInfo = "デシリアライズ後に __wakeup で復元された情報。元のデータ: '{$this->data}'";
50    }
51
52    /**
53     * オブジェクトの状態を表示するメソッド。
54     *
55     * @return void
56     */
57    public function displayState(): void
58    {
59        echo "MySerializableObject: 現在のデータ: '{$this->data}'\n";
60        if ($this->restoredInfo !== null) {
61            echo "MySerializableObject: 復元情報: '{$this->restoredInfo}'\n";
62        } else {
63            echo "MySerializableObject: 復元情報はまだ設定されていません。\n";
64        }
65    }
66}
67
68echo "--- シリアライズ処理の開始 ---\n";
69
70// 1. オブジェクトを生成
71$originalObject = new MySerializableObject("オリジナルのデータ値");
72$originalObject->displayState();
73echo "\n";
74
75// 2. オブジェクトをシリアライズ
76// __sleep() メソッドが呼び出され、オブジェクトが文字列に変換されます。
77echo "serialize() を実行中...\n";
78$serializedString = serialize($originalObject);
79echo "シリアライズされた文字列:\n" . $serializedString . "\n\n";
80
81echo "--- デシリアライズ処理の開始 ---\n";
82
83// 3. シリアライズされた文字列からオブジェクトをデシリアライズ
84// 新しいオブジェクトが作成され、その直後に __wakeup() メソッドが呼び出されます。
85echo "unserialize() を実行中...\n";
86$restoredObject = unserialize($serializedString);
87echo "unserialize() 完了。\n";
88echo "\n";
89
90// 4. デシリアライズされたオブジェクトの状態を表示
91$restoredObject->displayState();
92
93echo "\n--- Dom\Attr オブジェクトのシリアライズに関する補足 ---\n";
94echo "Dom\Attr オブジェクトは DOMNode を継承しており、PHP の仕様上、DOMNode オブジェクトは直接シリアライズできません。\n";
95echo "そのため、Dom\Attr::__wakeup を直接トリガーするコードは書けませんが、\n";
96echo "上記で示した MySerializableObject の例のように、オブジェクトがデシリアライズされる際に\n";
97echo "__wakeup が呼び出され、内部的な初期化処理が行われるという点は共通しています。\n";
98
99// 参考：Dom\Attr のシリアライズを試みると例外が発生します
100/*
101$dom = new DOMDocument();
102$element = $dom->createElement('example');
103$attr = $dom->createAttribute('id');
104$attr->value = 'test-id';
105$element->setAttributeNode($attr);
106try {
107    // Dom\Attr オブジェクトを直接シリアライズしようとすると例外が発生
108    $serializedAttr = serialize($attr);
109    echo "Dom\Attr をシリアライズできました (これは通常起こりません): " . $serializedAttr . "\n";
110} catch (Exception $e) {
111    echo "Dom\Attr オブジェクトのシリアライズは許可されていません: " . $e->getMessage() . "\n";
112}
113*/
114?>

PHPのDom\Attr::__wakeupメソッドは、オブジェクトがデシリアライズ（文字列からオブジェクトへ復元）される直前に自動的に呼び出されるマジックメソッドの一つです。このメソッドは引数を受け取らず、値を返しません（void）。

一般的に__wakeupは、デシリアライズ後にオブジェクトの内部的な状態を再構築したり、データベース接続やファイルハンドルなどのリソースを再確立するなど、オブジェクトが使用可能になるための初期化処理に利用されます。

ただし、Dom\AttrクラスはDOMNodeを継承しており、PHPの仕様上、DOMNodeオブジェクトを直接シリアライズすることはできません。そのため、Dom\Attr::__wakeupメソッドをユーザーコードで直接トリガーして動作を確認するサンプルは作成できません。

提供されたサンプルコードでは、MySerializableObjectクラスを使って一般的な__wakeupメソッドの挙動を示しています。serialize()関数でオブジェクトが文字列化され、unserialize()関数で復元されると、MySerializableObject::__wakeupが自動的に実行され、オブジェクトの追加初期化が行われる様子が確認できます。Dom\Attr::__wakeupも同様に、DOM拡張の内部で、オブジェクトがデシリアライズされる際に、その内部的な整合性を保つために利用されています。