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

Copy
1<?php
2
3/**
4 * __wakeup マジックメソッドのバイパスをデモンストレーションするクラス。
5 * 通常、__wakeup は unserialize() 時にオブジェクトの整合性チェックなどを行うために呼び出されます。
6 */
7class MyVulnerableClass
8{
9    public string $data;
10    private bool $wakeupCalled = false; // private プロパティ
11
12    public function __construct(string $data = 'default')
13    {
14        $this->data = $data;
15    }
16
17    /**
18     * オブジェクトがデシリアライズされる際に呼び出されるマジックメソッド。
19     * このメソッドが呼び出されたことを記録します。
20     * DateTimeZone::__wakeup と同様に引数も戻り値もありません。
21     */
22    public function __wakeup(): void
23    {
24        $this->wakeupCalled = true;
25    }
26
27    /**
28     * __wakeup が呼び出されたかどうかをチェックするメソッド。
29     */
30    public function isWakeupCalled(): bool
31    {
32        return $this->wakeupCalled;
33    }
34
35    /**
36     * オブジェクトのデータを取得する。
37     */
38    public function getData(): string
39    {
40        return $this->data;
41    }
42}
43
44// -----------------------------------------------------
45// 1. __wakeup が正常に呼び出されるケースのデモンストレーション
46// -----------------------------------------------------
47
48$originalObject = new MyVulnerableClass('Original Data');
49$serializedData = serialize($originalObject);
50
51echo "--- 正常なデシリアライズ ---" . PHP_EOL;
52// ヌルバイト文字を見えるように表示してシリアライズデータを示します。
53echo "元のシリアライズデータ: " . str_replace("\0", '\\0', $serializedData) . PHP_EOL;
54
55$unserializedObject = unserialize($serializedData);
56
57if ($unserializedObject instanceof MyVulnerableClass) {
58    echo "unserialize() 後、__wakeup は " . ($unserializedObject->isWakeupCalled() ? "呼び出されました。" : "呼び出されませんでした。") . PHP_EOL;
59    echo "デシリアライズされたデータ: " . $unserializedObject->getData() . PHP_EOL;
60} else {
61    echo "デシリアライズに失敗しました。" . PHP_EOL;
62}
63echo PHP_EOL;
64
65
66// -----------------------------------------------------
67// 2. __wakeup をバイパスするケースのデモンストレーション
68//    シリアライズ文字列内のプロパティ数を意図的に改ざんします。
69//    PHPは、シリアライズデータ内のプロパティ数が実際のプロパティ数より多いと判断した場合、
70//    __wakeup メソッドの呼び出しをスキップします (PHP 7.0以降の挙動)。
71//    例: O:17:"MyVulnerableClass":2:{...}  ->  O:17:"MyVulnerableClass":3:{...}
72// -----------------------------------------------------
73
74// シリアライズされた文字列を意図的に改ざんし、プロパティ数を増やす
75// 'O:[クラス名長]:"[クラス名]":2:' の ':2:' の部分を ':3:' に変更
76$bypassedSerializedData = str_replace(
77    'O:' . strlen('MyVulnerableClass') . ':"MyVulnerableClass":2:', // 元のクラス名とプロパティ数
78    'O:' . strlen('MyVulnerableClass') . ':"MyVulnerableClass":3:', // プロパティ数を実際より多い値に改ざん
79    $serializedData
80);
81
82echo "--- __wakeup バイパスのデシリアライズ ---" . PHP_EOL;
83echo "改ざんされたシリアライズデータ: " . str_replace("\0", '\\0', $bypassedSerializedData) . PHP_EOL;
84
85$bypassedObject = unserialize($bypassedSerializedData);
86
87if ($bypassedObject instanceof MyVulnerableClass) {
88    echo "unserialize() 後、__wakeup は " . ($bypassedObject->isWakeupCalled() ? "呼び出されました。" : "呼び出されませんでした。") . PHP_EOL;
89    echo "デシリアライズされたデータ: " . $bypassedObject->getData() . PHP_EOL;
90} else {
91    echo "デシリアライズに失敗しました。" . PHP_EOL;
92}
93echo PHP_EOL;

PHPの__wakeupメソッドは、unserialize()関数を使ってシリアライズされたオブジェクトがデシリアライズされる際に、自動的に呼び出される特別なマジックメソッドです。このメソッドは、オブジェクトの整合性チェックや、デシリアライズ後に再度必要となるリソースの初期化処理を行うために利用されます。DateTimeZone::__wakeupのように、引数はなく、戻り値も持ちません。

このサンプルコードでは、MyVulnerableClassというクラスを使用して__wakeupメソッドの挙動を示しています。最初の例では、通常のデシリアライズ処理を通じて__wakeupが正しく呼び出されることを確認できます。isWakeupCalled()メソッドが真を返すことで、その呼び出しを検証しています。

次に「__wakeupバイパス」と呼ばれる、特殊な状況下での挙動をデモンストレーションしています。これは、オブジェクトのシリアライズ文字列に含まれるプロパティの数を意図的に実際の数よりも多く改ざんすることで発生します。PHP 7.0以降のバージョンでは、シリアライズデータ内のプロパティ数が実際のプロパティ数より多いとPHPが判断した場合、セキュリティ上の理由から__wakeupメソッドの呼び出しをスキップします。サンプルコードでは、シリアライズ文字列のプロパティ数を示す部分を書き換えることで、このバイパスを再現し、__wakeupが呼び出されなかったことをisWakeupCalled()メソッドで確認しています。この挙動は、特定の条件下でセキュリティ上の脆弱性につながる可能性があるため、注意が必要です。

Copy
1<?php
2
3/**
4 * DateTimeZoneオブジェクトのシリアライズとアンシリアライズの例。
5 *
6 * DateTimeZone::__wakeupメソッドは、unserialize()関数によってDateTimeZoneオブジェクトが
7 * シリアライズされたデータから復元される際に、PHPによって自動的に呼び出される内部メソッドです。
8 * このメソッドは、オブジェクトの内部状態を正しく再構築するために使用されます。
9 * ユーザーがこのメソッドを直接呼び出したり、ユーザー定義のクラスでオーバーライドしたりすることはありません。
10 */
11function demonstrateDateTimeZoneWakeupProcess(): void
12{
13    // 1. オリジナルのDateTimeZoneオブジェクトを作成します。
14    $originalTimeZone = new DateTimeZone('Asia/Tokyo');
15    echo "オリジナルタイムゾーン: " . $originalTimeZone->getName() . PHP_EOL;
16
17    // 2. オブジェクトをシリアライズ（文字列に変換）します。
18    // これにより、オブジェクトのクラス名とプロパティが保存可能な形式になります。
19    $serializedTimeZone = serialize($originalTimeZone);
20    echo "シリアライズされたデータ: " . $serializedTimeZone . PHP_EOL;
21
22    // 3. シリアライズされたデータからオブジェクトをアンシリアライズ（復元）します。
23    // unserialize()が呼び出されると、PHPはまず新しいDateTimeZoneオブジェクトを作成し、
24    // 次にそのオブジェクトに対してDateTimeZone::__wakeupメソッドを内部的に呼び出します。
25    // これにより、オブジェクトの内部状態が正しく再構築され、利用可能な状態になります。
26    $restoredTimeZone = unserialize($serializedTimeZone);
27
28    // 復元されたオブジェクトがDateTimeZoneのインスタンスであることを確認し、その情報を表示します。
29    if ($restoredTimeZone instanceof DateTimeZone) {
30        echo "復元されたオブジェクトの型: " . get_class($restoredTimeZone) . PHP_EOL;
31        echo "復元されたタイムゾーン: " . $restoredTimeZone->getName() . PHP_EOL;
32
33        // オリジナルと復元されたオブジェクトの状態が同じであることを確認します。
34        if ($originalTimeZone->getName() === $restoredTimeZone->getName()) {
35            echo "結果: DateTimeZoneオブジェクトは正しくシリアライズ・アンシリアライズされ、\n";
36            echo "      その過程で内部的にDateTimeZone::__wakeupが動作して状態が復元されました。" . PHP_EOL;
37        } else {
38            echo "結果: タイムゾーン名の不一致が発生しました。復元に問題がある可能性があります。" . PHP_EOL;
39        }
40    } else {
41        echo "結果: オブジェクトの復元に失敗しました。" . PHP_EOL;
42    }
43}
44
45// 関数を実行してデモンストレーションを開始します。
46demonstrateDateTimeZoneWakeupProcess();

PHPのDateTimeZoneクラスには、オブジェクトがシリアライズされたデータから復元される際に、PHPによって自動的に呼び出される特殊な内部メソッド__wakeupが存在します。このメソッドは、serialize()関数で文字列化されたDateTimeZoneオブジェクトを、unserialize()関数を使って元のオブジェクトとして再構築する過程で重要な役割を果たします。

DateTimeZone::__wakeupメソッドの主な目的は、復元されたオブジェクトの内部状態を正しく初期化し、利用可能な状態にすることです。引数はなく、戻り値もありません。開発者がこのメソッドを直接呼び出すことは通常なく、unserialize()処理の一部として裏側で機能しています。

提示されたサンプルコードでは、まずAsia/Tokyoというタイムゾーンを持つDateTimeZoneオブジェクトを作成し、それを文字列にシリアライズしています。次に、このシリアライズされた文字列から元のオブジェクトをアンシリアライズ（復元）する際に、PHPが内部的にDateTimeZone::__wakeupを呼び出します。これにより、復元されたオブジェクトが元のオブジェクトと同じタイムゾーン情報を保持し、正しく動作することが確認できます。このプロセスを通じて、オブジェクトの状態が適切に再構築される様子が示されています。