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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * __wakeup() メソッドの動作を検証するためのサンプルクラス。
7 *
8 * このクラスは、オブジェクトがデシリアライズされる際に __wakeup() が
9 * どのように呼び出されるか、また、過去に存在した脆弱性（__wakeup bypass）が
10 * 現在のPHPでどのように対策されているかを示します。
11 */
12class WakeupDemo
13{
14    /** @var string オブジェクトの状態を示すデータ */
15    public string $state = 'serialized';
16
17    /**
18     * unserialize() 時に自動的に呼び出されるマジックメソッド。
19     * オブジェクトの再初期化処理を行います。
20     */
21    public function __wakeup(): void
22    {
23        echo "__wakeup() メソッドが呼び出されました。\n";
24        $this->state = 're-initialized';
25    }
26}
27
28// 1. 通常のインスタンスを作成し、シリアライズする
29$instance = new WakeupDemo();
30echo "シリアライズ前の状態: " . $instance->state . "\n";
31$serialized = serialize($instance);
32echo "シリアライズされたデータ: " . $serialized . "\n\n";
33
34// 2. 意図的に不正なシリアライズデータを作成する
35// O:10:"WakeupDemo":1:{s:5:"state";s:10:"serialized";}
36// 上記のプロパティ数 '1' を '2' に書き換えることで、古いPHPバージョンでは
37// __wakeup() の呼び出しを回避する脆弱性 (CVE-2016-7124) が存在しました。
38$maliciousSerialized = 'O:10:"WakeupDemo":2:{s:5:"state";s:9:"bypassed";}';
39echo "不正なシリアライズデータ（プロパティ数を偽装）: " . $maliciousSerialized . "\n";
40
41// 3. 不正なデータをデシリアライズしようと試みる
42echo "不正なデータのデシリアライズを試みます...\n";
43
44// PHP 8 では、プロパティ数と実際のデータが一致しないため、
45// デシリアライズは失敗し、__wakeup() は呼び出されません。
46// unserialize() は false を返し、E_NOTICE レベルのエラーが発生します。
47// これにより、__wakeup bypass 脆弱性は対策されています。
48$bypassedInstance = unserialize($maliciousSerialized);
49
50echo "デシリアライズの結果: ";
51var_dump($bypassedInstance);
52
53if ($bypassedInstance === false) {
54    echo "\nデシリアライズに失敗し、__wakeup() は呼び出されませんでした。\n";
55    echo "これは、PHPが不正なオブジェクトデータから保護していることを示します。\n";
56}
57
58?>

__wakeupは、unserialize()関数によってシリアライズ（文字列化）されたオブジェクトが復元される際に、自動的に呼び出されるマジックメソッドです。データベース接続の再確立など、オブジェクトが復元された後に行うべき初期化処理を定義するために使用されます。このメソッドは引数を受け取らず、戻り値もありません（void）。

このサンプルコードは、過去に存在したセキュリティ脆弱性「__wakeup bypass」が、現在のPHPでは対策済みであることを示しています。この脆弱性は、シリアライズされたデータ内のプロパティ数を意図的に不正な値に書き換えることで、__wakeupメソッドの実行を回避し、オブジェクトを不完全な状態で復元させる攻撃手法でした。

しかし、サンプルコードで示されているように、現在のPHP 8では、宣言されたプロパティ数と実際のデータが一致しない不正なデータをunserialize()で復元しようとすると、処理は失敗しfalseが返されます。これにより、__wakeupメソッドが意図せずスキップされることはなくなり、この脆弱性に対する安全性が確保されていることが確認できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * __wakeupマジックメソッドの動作を示すサンプルクラスです。
7 *
8 * __wakeupメソッドは、unserialize()関数によってオブジェクトが
9 * デシリアライズ（復元）される際に自動的に呼び出されます。
10 * データベース接続の再確立など、復元時に必要な初期化処理を実装するのに役立ちます。
11 */
12class ResourceHandler
13{
14    /** @var string リソース名 */
15    public string $name;
16
17    /** @var string|null オブジェクトの状態 */
18    public ?string $status = null;
19
20    public function __construct(string $name)
21    {
22        $this->name = $name;
23        $this->status = 'connected';
24        echo "オブジェクト '{$this->name}' が生成され、状態は '{$this->status}' です。" . PHP_EOL;
25    }
26
27    /**
28     * オブジェクトがシリアライズされる際に呼び出されます。
29     * シリアライズしたいプロパティ名の配列を返します。
30     *
31     * @return string[]
32     */
33    public function __sleep(): array
34    {
35        echo "オブジェクト '{$this->name}' がシリアライズされます。" . PHP_EOL;
36        // 'status' プロパティはシリアライズ対象から除外します。
37        return ['name'];
38    }
39
40    /**
41     * オブジェクトがデシリアライズされる際に呼び出されます。
42     * ここでリソースの再接続などの初期化処理を行います。
43     */
44    public function __wakeup(): void
45    {
46        echo "オブジェクト '{$this->name}' がデシリアライズされ、__wakeup が呼び出されました。" . PHP_EOL;
47        // オブジェクト復元時に状態を再設定します。
48        $this->status = 're-connected';
49    }
50}
51
52// 1. オブジェクトをインスタンス化します。
53$handler = new ResourceHandler('DatabaseConnection');
54echo PHP_EOL;
55
56// 2. オブジェクトをシリアライズ（文字列に変換）します。
57// このとき、__sleep()が呼び出され、'status'プロパティは保存されません。
58$serializedHandler = serialize($handler);
59print_r("シリアライズされたデータ: " . $serializedHandler . PHP_EOL);
60echo PHP_EOL;
61
62// 3. シリアライズされた文字列からオブジェクトを復元します。
63// このとき、__wakeup()が自動的に呼び出され、'status'プロパティが再設定されます。
64$unserializedHandler = unserialize($serializedHandler);
65
66// 復元されたオブジェクトの状態を確認します。
67echo "復元後のオブジェクトの状態は '{$unserializedHandler->status}' です。" . PHP_EOL;

__wakeupは、PHPの「マジックメソッド」と呼ばれる特別なメソッドの一つです。このメソッドの主な役割は、unserialize()関数によってオブジェクトが復元される際に、必要な初期化処理を自動的に実行することです。

サンプルコードでは、まずserialize()関数でオブジェクトを文字列データに変換します。この時、対となる__sleepメソッドが呼び出され、statusプロパティは保存対象から除外されます。次に、この文字列データをunserialize()関数でオブジェクトに復元します。この復元のタイミングで__wakeupメソッドが自動的に呼び出され、statusプロパティに're-connected'という値を再設定しています。このように、__wakeupは、一度保存されたオブジェクトを再び利用可能な状態に戻すため、データベース接続を再確立したり、一時的な設定を復元したりする処理を記述するのに非常に便利です。

このメソッドは引数を必要としません。また、戻り値はvoidと定義されているため、処理の結果として何かを返す（returnする）必要はなく、オブジェクト自身の状態を整える処理に専念します。