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

Copy
1<?php
2
3/**
4 * __wakeup マジックメソッドの動作と、特定の不正なシリアライズデータによる
5 * __wakeup の「バイパス」の可能性を示すクラス。
6 *
7 * RequestParseBodyException は PHP の内部クラスであり、ユーザーランドで直接
8 * シリアライズ・デシリアライズすることは想定されていません。
9 * このコードは、一般的なユーザー定義クラスにおける __wakeup の動作と
10 * 不正なシリアライズデータがどのように __wakeup の呼び出しを「バイパス」
11 * する（つまり、呼び出されないようにする）かを説明するためのものです。
12 */
13class MyWakableClass
14{
15    public string $data;
16    public bool $wakeupCalled = false;
17
18    public function __construct(string $data)
19    {
20        $this->data = $data;
21        echo "コンストラクタが呼び出されました: " . $this->data . PHP_EOL;
22    }
23
24    /**
25     * オブジェクトが unserialize() によって再構築された後に呼び出されるマジックメソッドです。
26     * オブジェクトの初期化処理などを行うために使用されます。
27     */
28    public function __wakeup(): void
29    {
30        $this->wakeupCalled = true;
31        echo "__wakeup が呼び出されました。データ: " . $this->data . PHP_EOL;
32    }
33}
34
35// --- 通常のシリアライズとデシリアライズの例 ---
36echo "--- 通常のシリアライズとデシリアライズ ---" . PHP_EOL;
37$originalObject = new MyWakableClass("正常なデータ");
38
39// オブジェクトをシリアライズ（文字列に変換）
40$serializedString = serialize($originalObject);
41echo "シリアライズされた文字列: " . $serializedString . PHP_EOL;
42
43// シリアライズされた文字列からオブジェクトをデシリアライズ（再構築）
44// このとき、MyWakableClass の __wakeup メソッドが呼び出されます。
45$unserializedNormal = unserialize($serializedString);
46
47if ($unserializedNormal instanceof MyWakableClass) {
48    echo "デシリアライズされたオブジェクトのデータ: " . $unserializedNormal->data . PHP_EOL;
49    echo "__wakeup は呼び出されましたか？ " . ($unserializedNormal->wakeupCalled ? "はい" : "いいえ") . PHP_EOL;
50} else {
51    echo "正常なデシリアライズに失敗しました。" . PHP_EOL;
52}
53echo PHP_EOL;
54
55// --- __wakeup を「バイパス」する可能性のある不正なシリアライズデータの例 ---
56echo "--- 不正なシリアライズデータによる __wakeup の「バイパス」 ---" . PHP_EOL;
57// ここでは、シリアライズされたオブジェクトのプロパティ数を意図的に偽装します。
58// 元の MyWakableClass は $data と $wakeupCalled の2つのプロパティを持ちますが、
59// シリアライズ文字列ではプロパティ数を「1」と偽装しています。
60// PHP 7.1 以降では、このようにプロパティ数が一致しない場合、unserialize() は
61// __wakeup を呼び出さず、__PHP_Incomplete_Class のインスタンスを返します。
62$maliciousSerializedString = 'O:14:"MyWakableClass":1:{s:4:"data";s:19:"不正なペイロードデータ";}';
63echo "不正なシリアライズされた文字列: " . $maliciousSerializedString . PHP_EOL;
64
65// 不正なシリアライズ文字列からオブジェクトをデシリアライズ
66// このとき、MyWakableClass の __wakeup メソッドは呼び出されません。
67$unserializedMalicious = unserialize($maliciousSerializedString);
68
69if ($unserializedMalicious instanceof MyWakableClass) {
70    echo "MyWakableClass としてデシリアライズされました。" . PHP_EOL;
71    echo "__wakeup は呼び出されましたか？ " . ($unserializedMalicious->wakeupCalled ? "はい" : "いいえ") . PHP_EOL;
72    echo "データ: " . $unserializedMalicious->data . PHP_EOL;
73} elseif ($unserializedMalicious instanceof __PHP_Incomplete_Class) {
74    echo "__PHP_Incomplete_Class としてデシリアライズされました。これは __wakeup が呼び出されなかったことを意味します。" . PHP_EOL;
75    // __PHP_Incomplete_Class のプロパティには直接アクセスできませんが、
76    // var_dump などで内部構造を確認できます。
77    // var_dump($unserializedMalicious);
78} else {
79    echo "不正なデシリアライズに失敗しました。" . PHP_EOL;
80}
81echo PHP_EOL;
82
83// 補足:
84// RequestParseBodyException::__wakeup は PHP 内部で利用されるメソッドであり、
85// 通常のアプリケーション開発者が直接このメソッドを呼び出したり、
86// 上記のような方法で「バイパス」したりするシナリオは存在しません。
87// このコード例は、__wakeup マジックメソッドの一般的な挙動と、
88// シリアライズデータの改ざんによる挙動の変化を理解するために提供されています。

PHPの__wakeupメソッドは、unserialize()関数によってオブジェクトが再構築された直後に自動的に呼び出される特別なマジックメソッドです。このメソッドは引数も戻り値も持ちません。主に、デシリアライズされたオブジェクトの状態を初期化したり、必要なリソースを再接続したりするために使用されます。

提供されたサンプルコードでは、MyWakableClassというクラスを使って__wakeupの挙動を示しています。オブジェクトを正常にシリアライズ（文字列に変換）し、その後デシリアライズ（オブジェクトに再構築）すると、__wakeupメソッドが期待通りに呼び出され、オブジェクトの状態が適切に設定されることがわかります。

次に、シリアライズデータ内のプロパティ数を意図的に偽装した不正なデータの場合が示されています。PHP 7.1以降では、シリアライズデータのプロパティ数がオブジェクトの実際のプロパティ数と一致しない場合、unserialize()は__wakeupメソッドを呼び出しません。代わりに、オブジェクトは不完全な状態を示す__PHP_Incomplete_Classのインスタンスとしてデシリアライズされ、結果として__wakeupの実行が「バイパス」されます。これは、意図しない動作やセキュリティ上のリスクを引き起こす可能性があるため、シリアライズデータを扱う際には注意が必要です。

なお、RequestParseBodyException::__wakeupはPHP内部で利用される例外クラスのメソッドであり、通常のアプリケーション開発者が直接操作することは想定されていません。このサンプルコードは、一般的な__wakeupの仕組みと、シリアライズデータの改ざんによるセキュリティ上の注意点を理解するために提供されています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * __wakeup マジックメソッドの動作を示すサンプルクラス。
7 *
8 * このクラスは、シリアライズ（オブジェクトを文字列に変換）され、
9 * その後アンシリアライズ（文字列からオブジェクトに復元）されることを想定しています。
10 */
11class Connection
12{
13    /** @var string 接続先情報 */
14    private string $dsn;
15
16    /** @var ?string 接続状態を示すプロパティ */
17    private ?string $status = null;
18
19    public function __construct(string $dsn)
20    {
21        $this->dsn = $dsn;
22        $this->connect();
23    }
24
25    /**
26     * オブジェクトが unserialize() によって復元される際に自動的に呼び出されるマジックメソッド。
27     *
28     * データベース接続の再確立など、オブジェクトが復元された際の
29     * 初期化処理をここで行います。
30     */
31    public function __wakeup(): void
32    {
33        echo "__wakeup() メソッドが呼び出されました。\n";
34        // シリアライズされたオブジェクトが復元された後、再度接続処理を実行します。
35        $this->connect();
36    }
37
38    /**
39     * 接続を模倣するメソッド
40     */
41    public function connect(): void
42    {
43        $this->status = "Connected to {$this->dsn}";
44        echo "接続処理が実行されました。\n";
45    }
46
47    /**
48     * 現在の接続状態を返すメソッド
49     */
50    public function getStatus(): ?string
51    {
52        return $this->status;
53    }
54}
55
56// 1. オブジェクトをインスタンス化します。__construct() が呼ばれます。
57echo "--- 1. オブジェクトの生成 ---\n";
58$connection = new Connection('mysql:host=localhost');
59echo "生成後の状態: " . $connection->getStatus() . "\n\n";
60
61// 2. オブジェクトをシリアライズ（文字列に変換）します。
62// これにより、オブジェクトの状態をファイルやセッションに保存できます。
63echo "--- 2. オブジェクトのシリアライズ ---\n";
64$serializedData = serialize($connection);
65echo "シリアライズされたデータ: {$serializedData}\n\n";
66
67// 元のオブジェクトを破棄したと仮定します。
68unset($connection);
69
70// 3. シリアライズされた文字列からオブジェクトを復元します。
71// この unserialize() の過程で、__wakeup() メソッドが自動的に実行されます。
72echo "--- 3. オブジェクトのアンシリアライズ ---\n";
73$restoredConnection = unserialize($serializedData);
74
75// 4. __wakeup() によって再初期化されたオブジェクトの状態を確認します。
76echo "\n--- 4. 復元後のオブジェクトの状態確認 ---\n";
77echo "復元後の状態: " . $restoredConnection->getStatus() . "\n";
78
79?>

PHPの__wakeupメソッドは、オブジェクトがシリアライズ（オブジェクトの状態を文字列などに変換して保存）され、その後unserialize()関数によって復元される際に自動的に呼び出されるマジックメソッドです。このメソッドは、引数を受け取らず、戻り値もありません。主な目的は、オブジェクトが復元された直後に必要な初期化処理を実行することです。例えば、シリアライズ中に切断されたデータベース接続やファイルハンドルなどの外部リソースを再確立する際に利用されます。

サンプルコードでは、Connectionクラスが__wakeupメソッドを実装しています。まず、Connectionオブジェクトが生成され、接続処理が実行されます。次に、このオブジェクトがシリアライズされ、一度破棄されます。その後、シリアライズされたデータからオブジェクトをunserialize()で復元すると、自動的に__wakeup()メソッドが呼び出され、再度接続処理が実行される様子が確認できます。これにより、復元されたオブジェクトは、外部リソースへの接続が確立された状態で利用可能になります。