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

Copy
1<?php
2
3class MyClass
4{
5    private $obj;
6
7    public function __construct()
8    {
9        $this->obj = new stdClass();
10        $this->obj->value = "Initial Value";
11    }
12
13    public function __sleep()
14    {
15        // シリアライズされるプロパティのリストを返す
16        return array('obj');
17    }
18
19    public function __wakeup()
20    {
21        // __wakeup メソッドをバイパスする例
22        // $this->obj が null の場合、新しいオブジェクトを作成して初期化する
23
24        // PHP 8 より前のバージョンでは、__wakeup メソッドが呼び出されない脆弱性が存在した。
25        // この脆弱性を悪用すると、オブジェクトの状態が初期化されずに、意図しない動作を引き起こす可能性がある。
26        // このサンプルコードは、そのような脆弱性を説明するためのものであり、推奨される実装ではない。
27        if (!isset($this->obj)) {
28            $this->obj = new stdClass();
29            $this->obj->value = "Wakeup Value";
30        } else {
31            $this->obj->value = "Wakeup Called";
32        }
33
34    }
35
36    public function getValue()
37    {
38        return $this->obj->value;
39    }
40}
41
42// オブジェクトのシリアライズ
43$obj = new MyClass();
44$serialized = serialize($obj);
45
46// シリアライズされたオブジェクトをアンシリアライズ
47$unserialized = unserialize($serialized);
48
49// 値の確認
50echo $unserialized->getValue() . PHP_EOL; // 出力: Wakeup Called
51
52// 脆弱性の例: __wakeup が呼ばれないように細工されたシリアライズデータ
53$serialized_bypass = 'O:7:"MyClass":1:{s:3:"obj";O:8:"stdClass":1:{s:5:"value";s:13:"Hacked Value!";}}';
54$unserialized_bypass = unserialize($serialized_bypass);
55
56echo $unserialized_bypass->getValue() . PHP_EOL; // 出力: Hacked Value!
57
58?>

このサンプルコードは、PHPのErrorクラスに属する__wakeupメソッドの挙動と、そのバイパスに関する脆弱性について解説するものです。__wakeupは、unserialize関数によってオブジェクトが復元される際に自動的に呼ばれる特別なメソッドです。

MyClassクラスでは、__sleepメソッドでシリアライズ対象のプロパティをobjのみに限定しています。__wakeupメソッドでは、$this->objがisset関数で存在しないと判断された場合に、新しいstdClassオブジェクトを生成し、valueプロパティを初期化します。

通常のunserialize処理では、__wakeupが呼ばれ$this->objは初期化されWakeup Calledと出力されます。しかし、特定の条件下で__wakeupが呼ばれないケースが存在し、Hacked Value!と出力される例を示しています。これは、シリアライズされた文字列を改ざんすることで__wakeupの実行をバイパスし、オブジェクトの状態を不正に操作できる脆弱性の例です。

__wakeupメソッドは引数を受け取らず、戻り値もありません。オブジェクトが復元されるタイミングで、自動的に実行される一連の処理を記述します。PHP 8 より前のバージョンでは、シリアライズされたデータ構造によっては__wakeupが呼び出されない脆弱性がありましたが、現在のバージョンでは対策されています。このサンプルコードは、過去の脆弱性を理解するためのものであり、注意して利用する必要があります。

Copy
1<?php
2
3class MyClass
4{
5    private $data;
6
7    public function __construct($data)
8    {
9        $this->data = $data;
10    }
11
12    public function getData()
13    {
14        return $this->data;
15    }
16
17    public function __sleep()
18    {
19        // シリアライズするプロパティのリストを返す
20        return ['data'];
21    }
22
23    public function __wakeup()
24    {
25        // シリアライズされたオブジェクトがunserializeされる際に実行される
26        echo "オブジェクトがunserializeされました。\n";
27        // 必要に応じて、オブジェクトの状態を復元する処理を記述
28        // 例：データベース接続の再確立など
29    }
30}
31
32// オブジェクトを作成
33$obj = new MyClass("初期データ");
34
35// オブジェクトをシリアライズ
36$serializedObj = serialize($obj);
37
38// シリアライズされたオブジェクトを出力 (デバッグ用)
39echo "シリアライズされたオブジェクト: " . $serializedObj . "\n";
40
41// オブジェクトをアンシリアライズ
42$unserializedObj = unserialize($serializedObj);
43
44// アンシリアライズされたオブジェクトのデータを表示
45echo "アンシリアライズされたオブジェクトのデータ: " . $unserializedObj->getData() . "\n";
46
47?>

このPHPのサンプルコードは、Errorクラスではなく、カスタムクラスMyClassにおけるマジックメソッド__wakeupの動作を説明しています。PHP 8において、__wakeupメソッドはオブジェクトがunserialize()関数によって復元される際に自動的に実行される特別なメソッドです。引数はなく、戻り値もありません。

MyClassは、初期データを持つ単純なクラスです。__sleep()メソッドは、オブジェクトがシリアライズされる際にどのプロパティを保存するかを定義します。この例では、dataプロパティのみが保存されます。

__wakeup()メソッドは、シリアライズされたオブジェクトがunserialize()された直後に実行されます。このサンプルコードでは、echo文によって「オブジェクトがunserializeされました。」というメッセージを出力します。__wakeup()は、データベース接続の再確立や、オブジェクトの状態を初期化するなどの処理を行うのに適しています。

サンプルコードでは、まずMyClassのインスタンスを作成し、serialize()関数を使ってオブジェクトをシリアライズします。次に、unserialize()関数を使ってシリアライズされた文字列からオブジェクトを復元します。unserialize()の実行時に__wakeup()メソッドが自動的に呼び出され、指定されたメッセージが出力されます。最後に、復元されたオブジェクトのデータを出力して、オブジェクトが正常に復元されたことを確認します。

システムエンジニアを目指す初心者の方は、この例を通して、オブジェクトのシリアライズとアンシリアライズ、そして__wakeup()メソッドの役割を理解することができます。オブジェクトの状態を永続化し、復元する際に必要な処理を__wakeup()に記述することで、より複雑なアプリケーションでも安全にオブジェクトを扱うことができます。