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

Copy
1<?php
2
3/**
4 * PHPのデシリアライゼーションにおけるマジックメソッド `__wakeup()` のバイパス方法を
5 * システムエンジニアを目指す初心者向けに簡潔に解説するサンプルコードです。
6 *
7 * このコードは、PHPの組み込みクラスである `\DOMException` を例に使用しています。
8 * `__wakeup()` メソッドは、オブジェクトがデシリアライズされる際に自動的に呼び出される
9 * PHPのマジックメソッドです。通常、オブジェクトの再初期化処理などに利用されます。
10 *
11 * PHP 7.0以降のバージョンでは、シリアライズされた文字列内にオブジェクトのプロパティ数を示す
12 * 数値が実際のプロパティ数よりも多く指定されている場合、`__wakeup()` メソッドは呼び出されずに
13 * デシリアライズが完了します。この挙動は、PHPオブジェクトインジェクション（POI）攻撃において、
14 * 意図しない `__wakeup()` の副作用を回避するために利用されることがあります。
15 *
16 * 注意:
17 * 標準のPHPにおける `\DOMException` クラスには、`__wakeup()` メソッドは定義されていません。
18 * このサンプルコードは、「もし `\DOMException` に `__wakeup()` が存在した場合、
19 * それをどのようにバイパスできるか」というデモンストレーションとして作成されています。
20 */
21function demonstrateWakeupBypass(): void
22{
23    // 1. `\DOMException` オブジェクトの作成
24    // `\DOMException` は通常、DOM操作中に発生するエラーを表す例外クラスです。
25    // ここでは、デモンストレーションのために手動でインスタンスを作成します。
26    $originalException = new \DOMException("A sample DOM error occurred.", 500);
27
28    echo "--- 元のオブジェクトの状態 ---" . PHP_EOL;
29    var_dump($originalException);
30    echo PHP_EOL;
31
32    // 2. オブジェクトをシリアライズ（文字列に変換）する
33    $serializedData = serialize($originalException);
34    echo "--- シリアライズされたデータ ---" . PHP_EOL;
35    echo $serializedData . PHP_EOL . PHP_EOL;
36    // シリアライズされたデータ形式の例:
37    // O:11:"DOMException":7:{s:7:"message";s:27:"A sample DOM error occurred.";s:8:"previous";N;s:4:"file";s:60:"/path/to/script.php";s:4:"line";i:26;s:5:"trace";a:0:{}s:4:"code";i:500;s:8:"severity";i:0;}
38    // `O:11:"DOMException":7:` の `7` の部分がオブジェクトのプロパティ数を示します。
39    // (プロパティ数はPHPのバージョンやExceptionクラスの実装によって変動する場合があります)。
40
41    // シリアライズされた文字列から、オブジェクトのクラス名とプロパティ数を正規表現で抽出します。
42    // これにより、PHPのバージョンによるプロパティ数の違いに対応できます。
43    if (preg_match('/^O:\d+:"(?P<className>[^"]+)":(?P<propCount>\d+):{/', $serializedData, $matches)) {
44        $className = $matches['className'];
45        $originalPropCount = (int)$matches['propCount'];
46        echo "元のクラス名: " . $className . PHP_EOL;
47        echo "元のプロパティ数: " . $originalPropCount . PHP_EOL;
48
49        // 3. `__wakeup()` をバイパスするために、シリアライズ文字列内のプロパティ数を意図的に増やす
50        // 実際のプロパティ数よりも大きい値を指定することで、`__wakeup()` がスキップされます。
51        $bypassedPropCount = $originalPropCount + 1;
52        echo "バイパス用のプロパティ数 (意図的に増やした数): " . $bypassedPropCount . PHP_EOL . PHP_EOL;
53
54        // シリアライズされた文字列を加工
55        // 例: `O:11:"DOMException":7:{...}` を `O:11:"DOMException":8:{...}` に変更します。
56        $bypassedSerializedData = preg_replace(
57            '/^O:\d+:"' . preg_quote($className) . '":\d+:{/',
58            'O:' . strlen($className) . ':"' . $className . '":' . $bypassedPropCount . ':{',
59            $serializedData
60        );
61
62        echo "--- `__wakeup()` がバイパスされるように加工されたシリアライズデータ ---" . PHP_EOL;
63        echo $bypassedSerializedData . PHP_EOL . PHP_EOL;
64
65        // 4. 加工された文字列をデシリアライズする
66        // PHP 7.0以降では、この `unserialize()` 呼び出し時に `__wakeup()` メソッドは呼び出されません。
67        $bypassedException = unserialize($bypassedSerializedData);
68
69        echo "--- `__wakeup()` がバイパスされたデシリアライズ結果 ---" . PHP_EOL;
70        var_dump($bypassedException);
71        echo "期待される結果: " . PHP_EOL;
72        echo "もし `\DOMException` に `__wakeup()` が定義されていたとしても、" .
73             "このデシリアライズではそのメソッドは呼び出されません。" . PHP_EOL;
74        echo "デシリアライズされたオブジェクトは有効ですが、`__wakeup()` 内の初期化ロジックはスキップされます。" . PHP_EOL . PHP_EOL;
75    } else {
76        echo "エラー: シリアライズされたデータからクラス名またはプロパティ数を抽出できませんでした。" . PHP_EOL;
77    }
78}
79
80// サンプル関数の実行
81demonstrateWakeupBypass();
82
83?>

このサンプルコードは、PHPのマジックメソッド__wakeup()がデシリアライズ時に呼び出される挙動を、システムエンジニアを目指す初心者にもわかるように、意図的にスキップ（バイパス）する方法を解説します。__wakeup()は、オブジェクトがデシリアライズされた直後に自動的に呼び出される特殊なメソッドで、引数はなく、戻り値もありません。通常、オブジェクトの状態を再初期化する目的などに利用されます。

コードでは、PHPの組み込みクラスである\DOMExceptionを例にしていますが、このクラスには通常__wakeup()メソッドは定義されていません。本コードは、「もし\DOMExceptionに__wakeup()が存在した場合、それをどうバイパスできるか」というデモンストレーションとして作成されています。

PHP 7.0以降では、オブジェクトがシリアライズされた文字列内に記述されているプロパティ数が、実際のオブジェクトのプロパティ数よりも多い場合、unserialize()関数は__wakeup()を呼び出しません。この仕組みを利用し、サンプルコードではシリアライズデータ中のプロパティ数を意図的に増やして加工し、その文字列をデシリアライズすることで、__wakeup()の呼び出しがスキップされることを示しています。この挙動は、PHPオブジェクトインジェクション（POI）攻撃において、意図しない__wakeup()の副作用を回避するために利用されることがあります。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * __wakeup マジックメソッドの動作を説明するためのサンプルクラス
7 *
8 * データベース接続など、シリアライズできないリソースを持つオブジェクトを想定しています。
9 */
10class ConnectionManager
11{
12    /**
13     * @var string 接続情報 (このプロパティはシリアライズされる)
14     */
15    private string $dataSourceName;
16
17    /**
18     * @var ?object 接続リソースの代わり (このプロパティはシリアライズされない)
19     */
20    private ?object $connection = null;
21
22    public function __construct(string $dsn)
23    {
24        $this->dataSourceName = $dsn;
25        $this->connect();
26    }
27
28    /**
29     * 接続処理を模倣する
30     */
31    private function connect(): void
32    {
33        echo "接続を確立しました: {$this->dataSourceName}" . PHP_EOL;
34        // 実際にはデータベース接続リソースなどをここに格納する
35        $this->connection = new stdClass();
36    }
37
38    /**
39     * serialize() 実行時に呼び出されるマジックメソッド
40     *
41     * シリアライズするプロパティのリストを返す。
42     * 接続リソース($connection)はシリアライズできないため、リストから除外する。
43     */
44    public function __sleep(): array
45    {
46        echo '__sleep() が呼び出されました。接続リソースを破棄します。' . PHP_EOL;
47        $this->connection = null;
48        return ['dataSourceName'];
49    }
50
51    /**
52     * unserialize() 実行時に呼び出されるマジックメソッド
53     *
54     * オブジェクトが復元された後に、失われたリソースを再初期化する処理を記述する。
55     * ここでは、データベース接続を再確立している。
56     * DOMException::__wakeup も、デシリアライズを制御する目的で定義されています。
57     */
58    public function __wakeup(): void
59    {
60        echo '__wakeup() が呼び出されました。' . PHP_EOL;
61        $this->connect();
62    }
63
64    /**
65     * 接続状態を返す
66     */
67    public function isConnected(): bool
68    {
69        return $this->connection !== null;
70    }
71}
72
73// 1. オブジェクトをインスタンス化する
74$manager = new ConnectionManager('mysql:host=localhost;dbname=test');
75echo 'インスタンス化後の接続状態: ' . ($manager->isConnected() ? '接続中' : '切断') . PHP_EOL;
76echo PHP_EOL;
77
78// 2. オブジェクトをシリアライズする
79// このとき __sleep() が呼ばれ、接続リソースが失われる
80$serializedManager = serialize($manager);
81echo 'シリアライズされたデータ: ' . $serializedManager . PHP_EOL;
82echo PHP_EOL;
83
84// 3. シリアライズされたデータからオブジェクトを復元する
85// このとき __wakeup() が呼ばれ、接続が再確立される
86$unserializedManager = unserialize($serializedManager);
87echo '復元後の接続状態: ' . ($unserializedManager->isConnected() ? '接続中' : '切断') . PHP_EOL;
88

PHPの__wakeupメソッドは、unserialize()関数によってオブジェクトが復元される際に自動的に呼び出される特別なマジックメソッドです。このメソッドは引数を取らず、戻り値もありません。主な役割は、デシリアライズ後にオブジェクトの内部状態を整えたり、失われたりシリアライズされなかったりしたリソース（例えばデータベース接続やファイルハンドルなど）を再初期化したりすることです。

このサンプルコードでは、ConnectionManagerクラスがデータベース接続のような外部リソースを持つオブジェクトを模倣しています。オブジェクトをserialize()する際、__sleep()メソッドが呼び出され、一時的に接続リソースが破棄されます。その後、unserialize()によってオブジェクトが復元されると、この__wakeup()メソッドが自動的に実行され、新たな接続リソースが再確立されます。これにより、デシリアライズ後もオブジェクトが正常に機能する状態を保つことができます。dom\domexceptionクラスも、デシリアライズ時に特別な初期化処理が必要な場合に__wakeupを定義しています。