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

Copy
1<?php
2
3/**
4 * このサンプルコードは、PHPの組み込みクラス `Random\RandomException` を例に、
5 * オブジェクトのシリアライズデータが外部から改ざんされた場合に、
6 * デシリアライズ時に内部的に呼び出される `__wakeup` メソッドによるオブジェクトの復元が、
7 * 意図しない状態を招く可能性を示します。
8 * これは一般的なPHP Object Injectionにおける「__wakeup bypass」の概念と関連しています。
9 */
10function demonstrateRandomExceptionWakeupBypassAttempt(): void
11{
12    // 元のRandom\RandomExceptionインスタンスを作成
13    try {
14        throw new Random\RandomException("Original sensitive error message.", 100);
15    } catch (Random\RandomException $originalException) {
16        echo "Original Exception Message: " . $originalException->getMessage() . "\n";
17        echo "Original Exception Code: " . $originalException->getCode() . "\n\n";
18
19        // オブジェクトをシリアライズ
20        $serializedData = serialize($originalException);
21        echo "Serialized Data:\n" . $serializedData . "\n\n";
22
23        // シリアライズデータを意図的に改ざんする
24        // 例として、メッセージとコードを偽装し、ログやセキュリティチェックを「バイパス」する状況をシミュレート
25        $maliciousMessage = "Bypassed security: No error detected.";
26        $maliciousCode = 0; // コード0はしばしば「成功」または「エラーなし」を意味
27
28        $modifiedSerializedData = preg_replace(
29            '/s:\d+:"' . preg_quote($originalException->getMessage(), '/') . '"/',
30            's:' . strlen($maliciousMessage) . ':"' . $maliciousMessage . '"',
31            $serializedData,
32            1 // 最初の一致のみを置換
33        );
34        $modifiedSerializedData = preg_replace(
35            '/i:' . $originalException->getCode() . ';/',
36            'i:' . $maliciousCode . ';',
37            $modifiedSerializedData,
38            1 // 最初の一致のみを置換
39        );
40
41        echo "Modified Serialized Data (Attempted Bypass):\n" . $modifiedSerializedData . "\n\n";
42
43        // 改ざんされたデータをデシリアライズ
44        // Random\RandomException::__wakeup が内部的に呼び出されますが、
45        // オブジェクトのプロパティは改ざんされたデータから復元されます。
46        try {
47            $deserializedModifiedException = unserialize($modifiedSerializedData);
48
49            echo "Deserialized Exception (from Modified Data):\n";
50            if ($deserializedModifiedException instanceof Random\RandomException) {
51                echo "Modified Message: " . $deserializedModifiedException->getMessage() . "\n";
52                echo "Modified Code: " . $deserializedModifiedException->getCode() . "\n";
53                echo "Note: The object was successfully deserialized, but its state was tampered with.\n";
54            } else {
55                echo "Deserialization resulted in an unexpected type or failure.\n";
56                var_dump($deserializedModifiedException);
57            }
58        } catch (Throwable $e) {
59            echo "Error during deserialization of modified data: " . $e->getMessage() . "\n";
60        }
61    }
62}
63
64demonstrateRandomExceptionWakeupBypassAttempt();

PHP 8のRandom\RandomExceptionクラスの__wakeupメソッドは、オブジェクトがシリアライズされたデータから復元（デシリアライズ）される際に、内部的に自動で呼び出される特殊なメソッドです。このメソッドは引数を取らず、戻り値もありません。その主な役割は、デシリアライズ後のオブジェクトを再初期化したり、状態を復元したりすることにあります。

このサンプルコードは、Random\RandomExceptionオブジェクトのシリアライズされたデータが外部から不正に改ざんされた場合の影響を示しています。通常、__wakeupはオブジェクトの整合性を保つために働きますが、データ自体が改ざんされていると、unserialize()処理中に__wakeupが呼び出された際、改ざんされたデータに基づいてオブジェクトが復元されてしまいます。

具体的には、元の例外メッセージやコードが、外部から書き換えられた偽の情報で復元される様子を示しており、これはログやセキュリティチェックを「バイパス」する可能性を示唆します。これは、PHPのセキュリティ脆弱性である「PHP Object Injection」における「__wakeup bypass」の概念と関連しており、開発者はオブジェクトのシリアライズ・デシリアライズ処理におけるデータの信頼性に注意を払う必要があります。

Copy
1<?php
2
3/**
4 * オブジェクトがデシリアライズされた際に呼び出される `__wakeup` マジックメソッドの動作を示すサンプルクラスです。
5 * `Random\RandomException` クラス自体はPHPの内部クラスであり、ユーザーが直接 `__wakeup` を実装することはできませんが、
6 * ここではPHPにおける `__wakeup` の一般的な動作を理解するための例として、ユーザー定義のクラスで実装します。
7 */
8class ExampleWakeupObject
9{
10    private string $name;
11    private string $status;
12
13    /**
14     * コンストラクタ。オブジェクトが最初に作成されるときに呼び出されます。
15     *
16     * @param string $name オブジェクトの名前
17     */
18    public function __construct(string $name)
19    {
20        $this->name = $name;
21        $this->status = "初期化済み";
22        echo "コンストラクタが呼び出されました: オブジェクト '{$this->name}' が作成されました。\n";
23    }
24
25    /**
26     * オブジェクトが `serialize()` 関数によってシリアライズされる直前に呼び出されるマジックメソッドです。
27     * シリアライズするプロパティの名前を文字列の配列で返します。
28     * `__wakeup` と対で使用されることがよくあります。
29     *
30     * @return array<string> シリアライズするプロパティ名の配列
31     */
32    public function __sleep(): array
33    {
34        echo "__sleep が呼び出されました: '{$this->name}' がシリアライズされます。\n";
35        // 'name' プロパティのみをシリアライズ対象とする
36        return ['name'];
37    }
38
39    /**
40     * オブジェクトが `unserialize()` 関数によってデシリアライズされた直後に呼び出されるマジックメソッドです。
41     * このメソッドは、デシリアライズされたオブジェクトの内部状態を再構築したり、
42     * ファイルハンドルやデータベース接続などのリソースを再確立したりするのに利用されます。
43     * 引数は取らず、戻り値もありません。
44     * `Random\RandomException` のような内部クラスでも、同様の仕組みでデシリアライズ後の処理が行われます。
45     */
46    public function __wakeup(): void
47    {
48        echo "__wakeup が呼び出されました: オブジェクト '{$this->name}' がデシリアライズされました。\n";
49        // デシリアライズ後の状態を更新する例
50        $this->status = "デシリアライズ後に再初期化済み";
51    }
52
53    /**
54     * オブジェクトの名前を取得します。
55     *
56     * @return string
57     */
58    public function getName(): string
59    {
60        return $this->name;
61    }
62
63    /**
64     * オブジェクトの現在のステータスを取得します。
65     *
66     * @return string
67     */
68    public function getStatus(): string
69    {
70        return $this->status;
71    }
72}
73
74echo "--- シナリオ開始: オブジェクトの作成、シリアライズ、デシリアライズ --- \n\n";
75
76// 1. オブジェクトを新しく作成します。このときコンストラクタが呼び出されます。
77$originalObject = new ExampleWakeupObject("MyItem");
78echo "元のオブジェクトのステータス: " . $originalObject->getStatus() . "\n\n";
79
80// 2. オブジェクトをシリアライズします。このとき __sleep メソッドが呼び出されます。
81$serializedData = serialize($originalObject);
82echo "シリアライズされたデータ: " . $serializedData . "\n\n";
83
84// 3. シリアライズされたデータをデシリアライズします。
85// このとき、新しくオブジェクトのインスタンスが作成されず、
86// 代わりに __wakeup メソッドが呼び出されてオブジェクトの内部状態が再構築されます。
87$deserializedObject = unserialize($serializedData);
88echo "\n--- デシリアライズ後のオブジェクトの状態 --- \n";
89
90// 4. デシリアライズされたオブジェクトの状態を確認します。
91echo "デシリアライズされたオブジェクトの名前: " . $deserializedObject->getName() . "\n";
92echo "デシリアライズされたオブジェクトのステータス: " . $deserializedObject->getStatus() . "\n\n";
93
94echo "--- シナリオ終了 --- \n";
95
96?>

PHPの__wakeupは、オブジェクトがunserialize()関数によってデシリアライズされた直後に自動的に呼び出される特別なメソッドです。これは「マジックメソッド」と呼ばれ、シリアライズされたオブジェクトの内部状態を再構築したり、ファイルハンドルやデータベース接続といったリソースを再確立したりする目的で利用されます。このメソッドは引数を取らず、戻り値もありません。

このサンプルコードでは、ユーザー定義クラスExampleWakeupObjectを通して__wakeupの動作を示しています。Random\RandomExceptionのようなPHPの内部クラスの__wakeupは直接実装できませんが、デシリアライズ後の処理の仕組みは同様です。

コードの流れとしては、まずオブジェクトが作成され、コンストラクタ__constructが呼び出されます。次にserialize()でオブジェクトを文字列に変換する際に、__sleepメソッドが実行され、シリアライズするプロパティが指定されます。そして、unserialize()によって元のオブジェクトの状態を復元すると、直後に__wakeupが呼び出され、オブジェクトのstatusプロパティが「デシリアライズ後に再初期化済み」に更新される様子を確認できます。このように、__wakeupはデシリアライズされたオブジェクトの状態を適切に整えるための重要な役割を果たします。