Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

__wakeupメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

__wakeupメソッドは、PHPにおいてオブジェクトがデシリアライズ(非直列化)された直後に自動的に呼び出される特殊なマジックメソッドです。このメソッドは、serialize()関数で直列化されたオブジェクトが、unserialize()関数によってメモリ上に復元された際に、そのオブジェクトの内部状態を再初期化したり、データベース接続やファイルハンドルといった外部リソースを再確立したりする目的で利用されます。

オブジェクトがデシリアライズされると、まずオブジェクトのプロパティが復元され、その後に__wakeupメソッドが定義されていれば、それが自動的に実行されます。これにより、復元されたオブジェクトが正しく機能するための最終的な準備や、一貫性のある状態を確立することが可能になります。

このリファレンス情報では、__wakeupメソッドがCompileErrorクラスに所属するとされています。CompileErrorは、PHPのコンパイル時に発生するエラーを表す内部的なクラスです。一般的に、CompileErrorオブジェクトがシリアライズされてデシリアライズされることは稀ですが、もしそのような状況が発生した場合、この__wakeupメソッドは、復元されたCompileErrorオブジェクトが必要とする特定の初期化処理や、関連する内部状態の再確立を行うために利用されるでしょう。これは、デシリアライズされたオブジェクトが、その後も期待通りに動作するための重要な役割を担います。

構文(syntax)

1<?php
2
3class CompileError
4{
5    public function __wakeup(): void
6    {
7    }
8}

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP __wakeup マジックメソッドの挙動

1<?php
2
3/**
4 * __wakeup マジックメソッドの一般的な動作を示すクラス。
5 * オブジェクトがデシリアライズされた直後に呼び出されるメソッドの例です。
6 */
7class MySerializableClass
8{
9    public string $data;
10
11    /**
12     * コンストラクタ。
13     *
14     * @param string $data 初期データ。
15     */
16    public function __construct(string $data)
17    {
18        $this->data = $data;
19        echo "MySerializableClass::" . __FUNCTION__ . "() called with data: '{$this->data}'\n";
20    }
21
22    /**
23     * オブジェクトがデシリアライズされる直前に呼び出されるマジックメソッド。
24     * シリアライズされたデータに基づいて、オブジェクトの初期化や
25     * リソース(例: データベース接続)の再接続を行うのに適しています。
26     */
27    public function __wakeup(): void
28    {
29        echo "MySerializableClass::" . __FUNCTION__ . "() called. Object is being re-initialized after deserialization.\n";
30        // 例: デシリアライズ後に特定の状態をリセットしたり、
31        // 外部リソースを再確立したりする処理をここに記述します。
32        $this->data .= " (reinitialized during wakeup)";
33    }
34
35    /**
36     * 現在のデータを取得します。
37     *
38     * @return string オブジェクトのデータ。
39     */
40    public function getData(): string
41    {
42        return $this->data;
43    }
44}
45
46// --------------------------------------------------------------------------------
47// 注意: プログラミング言語リファレンスにあった CompileError クラスの __wakeup メソッドは、
48// PHP エンジン内部でコンパイルエラーが発生した際に利用されるものであり、
49// 通常のPHPスクリプトから直接インスタンス化したり、その __wakeup メソッドを
50// オーバーライドしたりすることはできません。
51// 以下のサンプルコードは、__wakeup マジックメソッドがPHPでどのように機能するかを
52// 示すための一般的な例です。
53// --------------------------------------------------------------------------------
54
55echo "--- オリジナルオブジェクトの作成 ---\n";
56$originalObject = new MySerializableClass("Hello PHP World");
57echo "オリジナルオブジェクトのデータ: " . $originalObject->getData() . "\n\n";
58
59echo "--- オブジェクトのシリアライズ (文字列への変換) ---\n";
60$serializedObject = serialize($originalObject);
61echo "シリアライズされた文字列: " . $serializedObject . "\n\n";
62
63echo "--- オブジェクトのデシリアライズ (文字列からオブジェクトへ戻す) ---\n";
64// この時点で __wakeup() メソッドが呼び出されます。
65$deserializedObject = unserialize($serializedObject);
66
67if ($deserializedObject instanceof MySerializableClass) {
68    echo "デシリアライズされたオブジェクトのデータ: " . $deserializedObject->getData() . "\n";
69} else {
70    echo "オブジェクトのデシリアライズに失敗しました。\n";
71}
72

__wakeupメソッドは、PHPでオブジェクトを「デシリアライズ」(文字列などのデータから元のオブジェクトに復元する)する直後に自動的に呼び出される、特別な「マジックメソッド」の一つです。このメソッドは引数を取らず、戻り値もありません(void)と定義されます。

主な役割は、デシリアライズされたオブジェクトの状態を適切に初期化したり、シリアライズ中に切断されたデータベース接続などの外部リソースを再確立したりすることです。これにより、オブジェクトが復元された際に、アプリケーションが安定して動作するために必要な初期設定を自動的に行うことができます。

提供されたリファレンスにあるCompileErrorクラスの__wakeupメソッドは、PHPエンジン内部でコンパイルエラー処理のために利用される特殊なものであり、通常のアプリケーション開発で直接操作する機会はありません。

サンプルコードは、一般的なPHPクラスにおいて__wakeupがどのように機能するかを示す例です。MySerializableClassオブジェクトをserialize()関数で文字列に変換し、その後unserialize()関数で元のオブジェクトに復元しています。このunserialize()の過程で、MySerializableClass内に定義された__wakeup()メソッドが自動的に実行され、オブジェクトのデータに特定の変更が加えられていることが出力から確認できます。

__wakeupunserialize()でオブジェクトがデシリアライズされた直後に自動実行されるメソッドです。シリアライズ時に失われた外部リソースの再確立や、オブジェクトの状態の再初期化に利用します。リファレンス情報のCompileError::__wakeupはPHPエンジン内部の特殊なもので、通常の開発で直接利用するものではありません。このサンプルは、一般的なクラスでの__wakeupの動作例です。

PHP __wakeup バイパス:オブジェクトインジェクションのデモ

1<?php
2
3class UserDataProcessor
4{
5    public string $logFile;
6    public string $data;
7
8    /**
9     * コンストラクタ。プロパティを初期化します。
10     *
11     * @param string $logFile ログファイルのパス
12     * @param string $data 処理するデータ
13     */
14    public function __construct(string $logFile = 'default.log', string $data = '')
15    {
16        $this->logFile = $logFile;
17        $this->data = $data;
18    }
19
20    /**
21     * オブジェクトがデシリアライズされた際に呼び出されるマジックメソッド。
22     * リソースの再確立や状態の検証などに使用されます。
23     *
24     * PHPの内部クラス(例: CompileError)にも__wakeupメソッドは存在しますが、
25     * ユーザーランドコードからCompileErrorオブジェクトを生成したりデシリアライズしたりすることはできません。
26     * そのため、CompileError::__wakeupを直接「バイパス」するユーザーランドのシナリオはありません。
27     * ここでは、一般的なユーザー定義クラスにおける__wakeupとその「バイパス」(オブジェクトインジェクション)の概念を示します。
28     */
29    public function __wakeup(): void
30    {
31        echo "UserDataProcessorオブジェクトがデシリアライズされました。ログファイル: {$this->logFile}\n";
32
33        // __wakeup内でプロパティの検証や安全性の確保を行うのが一般的です。
34        // ここでの「バイパス」とは、__wakeupが呼び出される前に、
35        // 意図しないプロパティ値をデシリアライズによって注入(オブジェクトインジェクション)することで、
36        // __wakeup内の処理を不正に制御しようとすることを指します。
37        if (str_contains($this->logFile, 'malicious')) {
38            echo "警告: 不正なログファイルパスが検出されました。\n";
39            // 実際にはここでエラーをスローするか、安全な値にリセットするなどの対策を講じます。
40        }
41    }
42}
43
44// --- __wakeupの動作と「バイパス」の概念デモンストレーション ---
45
46// 1. 正常なオブジェクトのデシリアライズ
47$safeProcessor = new UserDataProcessor('application.log', 'アプリケーション開始');
48$serializedSafe = serialize($safeProcessor);
49echo "【正常なオブジェクト】シリアライズデータ: {$serializedSafe}\n";
50echo "--- 正常なオブジェクトのデシリアライズ中 ---\n";
51$unserializedSafe = unserialize($serializedSafe);
52echo "デシリアライズ後のログファイル: {$unserializedSafe->logFile}\n\n";
53
54// 2. 攻撃者によるオブジェクトインジェクションの試み(概念的な「バイパス」)
55// 攻撃者が不正なログファイルパスを含むシリアライズデータを生成し、
56// アプリケーションがそれをデシリアライズするように誘導することを想定します。
57// これにより、__wakeupが呼び出された際に、攻撃者が意図したデータで処理が行われる可能性があります。
58$maliciousSerializedData = 'O:17:"UserDataProcessor":2:{s:7:"logFile";s:19:"/tmp/malicious.log";s:4:"data";s:21:"攻撃者が注入したデータ。";}';
59echo "【攻撃者が作成したオブジェクト】シリアライズデータ: {$maliciousSerializedData}\n";
60echo "--- 攻撃された可能性のあるオブジェクトのデシリアライズ中 ---\n";
61$unserializedMalicious = unserialize($maliciousSerializedData);
62echo "デシリアライズ後のログファイル: {$unserializedMalicious->logFile}\n";

PHPの__wakeupメソッドは、オブジェクトがデシリアライズ(文字列から元のオブジェクトに復元される)された直後に自動的に呼び出される特別な「マジックメソッド」です。このメソッドは引数を受け取らず、戻り値もありません。主に、デシリアライズされたオブジェクトの状態を検証したり、リソースを再確立したりする目的で利用されます。

PHPの内部クラスであるCompileErrorにも__wakeupメソッドが存在しますが、このクラスのオブジェクトをユーザーのコードから直接生成したり、デシリアライズしたりすることはできません。そのため、CompileError::__wakeupを直接「バイパス」するようなユーザーランドのシナリオは通常発生しません。

サンプルコードは、ユーザーが定義するクラスにおける__wakeupの一般的な動作と、セキュリティ上の「バイパス」の概念を説明しています。「バイパス」とは、悪意のある攻撃者が改ざんしたシリアライズデータをアプリケーションに読み込ませることで、__wakeupメソッドが呼び出される前にオブジェクトのプロパティに不正な値を注入し(オブジェクトインジェクション)、__wakeup内の検証や安全対策の処理を意図的に迂回しようとすることを指します。これにより、__wakeupが期待通りの安全な処理を実行できなくなる可能性があります。

PHPのCompileError::__wakeupは内部クラスのメソッドであり、ユーザーが直接利用・操作するものではありません。サンプルコードの__wakeupは、ユーザー定義クラスにおける一般的な使い方と、デシリアライズ時のセキュリティ上の注意点を示しています。

__wakeupメソッドは、オブジェクトがデシリアライズされる際に自動的に呼び出され、プロパティの検証やリソースの再確立を行うことで、オブジェクトの状態を安全に保つ役割があります。

「バイパス」とは、外部から不正なシリアライズデータ(オブジェクトインジェクション)が与えられた際に、__wakeupの検証処理を意図的にすり抜けさせようとする攻撃を指します。そのため、アプリケーションが外部から受け取ったシリアライズデータを安易にunserialize()することは非常に危険です。デシリアライズする前にデータの信頼性を必ず確認し、__wakeupメソッド内でプロパティの値を厳格に検証し、不正なデータが設定されないようセキュリティ対策を講じることが重要です。

PHP unserialize(__wakeup)でオブジェクトを復元する

1<?php
2
3/**
4 * __wakeup マジックメソッドの動作を示すサンプルクラスです。
5 * オブジェクトが unserialize() 関数によって復元される直前に、
6 * __wakeup() メソッドが自動的に呼び出されます。
7 *
8 * このメソッドは、デシリアライズ後のオブジェクトの状態を初期化したり、
9 * 失われたリソース(データベース接続など)を再確立したりするのに利用されます。
10 */
11class ExampleClassForWakeup
12{
13    /**
14     * @var string データ保持用プロパティ
15     */
16    private string $message;
17
18    /**
19     * コンストラクタ
20     *
21     * @param string $initialMessage 初期メッセージ
22     */
23    public function __construct(string $initialMessage)
24    {
25        $this->message = $initialMessage;
26        echo "コンストラクタが呼び出されました: '{$this->message}'\n";
27    }
28
29    /**
30     * オブジェクトのデシリアライズ直前に呼び出されるマジックメソッドです。
31     * このメソッドは引数を取らず、戻り値もありません。
32     *
33     * unserialize() を使ってオブジェクトを復元しようとすると、
34     * オブジェクトのプロパティがセットされた直後に自動的に呼び出されます。
35     */
36    public function __wakeup(): void
37    {
38        echo "__wakeup() メソッドが呼び出されました。オブジェクトが復元中です。\n";
39        // ここで、デシリアライズされたオブジェクトに対して追加の初期化処理を行います。
40        // 例えば、データベース接続の再確立、ファイルのハンドルを再度開く、
41        // あるいはプロパティの値を更新するなど。
42        $this->message .= " (復元後に更新)"; // 復元されたことを示すためにメッセージを更新
43    }
44
45    /**
46     * 現在のメッセージを取得します。
47     *
48     * @return string
49     */
50    public function getMessage(): string
51    {
52        return $this->message;
53    }
54}
55
56// 1. オブジェクトを生成し、初期状態を確認します。
57echo "--- オブジェクトの生成 ---\n";
58$originalObject = new ExampleClassForWakeup("PHPの学習は楽しい!");
59echo "元のオブジェクトのメッセージ: '{$originalObject->getMessage()}'\n\n";
60
61// 2. オブジェクトをシリアライズ(文字列に変換)します。
62echo "--- オブジェクトのシリアライズ ---\n";
63echo "オブジェクトをシリアライズしています...\n";
64$serializedObject = serialize($originalObject);
65echo "シリアライズされたデータ: {$serializedObject}\n\n";
66
67// 3. シリアライズされた文字列をデシリアライズ(オブジェクトに復元)します。
68//    この unserialize() の処理中に ExampleClassForWakeup::__wakeup() メソッドが自動的に呼び出されます。
69echo "--- オブジェクトのデシリアライズ ---\n";
70echo "オブジェクトをデシリアライズしています...\n";
71$restoredObject = unserialize($serializedObject);
72echo "復元されたオブジェクトのメッセージ: '{$restoredObject->getMessage()}'\n";
73echo "__wakeup() メソッドによってメッセージが更新されたことを確認してください。\n";
74

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

提供されたサンプルコードでは、ExampleClassForWakeupクラスに__wakeupメソッドが定義されています。まず、オブジェクトを生成し、serialize()関数で文字列に変換します。その後、unserialize()関数でこの文字列からオブジェクトを復元する際に、__wakeupメソッドが自動的に実行されます。これにより、オブジェクトのプロパティがセットされた直後に、デシリアライズ後の追加処理が行われ、メッセージプロパティが更新される様子が確認できます。この挙動は、オブジェクトの整合性を保ちながら、永続化されたデータを安全に利用するための重要なメカニズムです。

PHPの__wakeupマジックメソッドは、unserialize()関数でオブジェクトが復元される直前に自動的に呼び出されます。引数なし、戻り値なしで実装し、デシリアライズ後に失われたデータベース接続やファイルハンドルなどの外部リソースを再確立する際に利用します。信頼できないシリアライズデータのデシリアライズは、意図しない__wakeupの実行によるセキュリティリスク(オブジェクトインジェクションなど)に繋がるため、データの出所には細心の注意が必要です。PHP 8以降では、より安全で柔軟なデシリアライズ処理のため、__wakeupよりも__unserializeマジックメソッドの利用が推奨されています。新規プロジェクトでは__unserializeの採用をご検討ください。

PHP __wakeup バイパス実験

1<?php
2
3/**
4 * システムエンジニアを目指す初心者向けの __wakeup メソッドのバイパス(绕过)例
5 *
6 * キーワード「php wakeup 绕 过」は、PHPのオブジェクトのデシリアライズ時に
7 * __wakeup() マジックメソッドの実行を意図的にスキップする手法を指します。
8 *
9 * プログラミング言語リファレンス情報に「internal method CompileError::__wakeup」とありますが、
10 * CompileError はPHPの内部クラスであり、通常、ユーザーが直接インスタンス化したり
11 * シリアライズ・デシリアライズしたりするものではありません。
12 * また、PHPの標準的なPHP 8の定義には CompileError クラスに __wakeup メソッドは存在しません。
13 *
14 * このサンプルコードは、一般的なユーザー定義クラスにおける __wakeup のバイパス手法を、
15 * PHP 8の動作に基づいて示します。
16 *
17 * PHP 7.0.12 (および PHP 5.6.28) 以降、unserialize() 関数は、
18 * シリアライズされた文字列中のプロパティ数が、実際のクラスのプロパティ数よりも
19 * 少ない場合に、E_NOTICE を発生させ、__wakeup() の呼び出しをスキップします。
20 * この挙動は、かつてセキュリティ上の脆弱性「PHP Object Injection」の一部で利用されたことがあります。
21 *
22 * __wakeup() メソッドは引数なし、戻り値なしのシグネチャを持ちます。
23 */
24class MyObjectWithWakeup
25{
26    /**
27     * オブジェクトのデータ。
28     * このクラスは1つのパブリックプロパティを持ちます。
29     */
30    public string $data;
31
32    /**
33     * コンストラクタ。オブジェクトが作成されるときに呼び出されます。
34     *
35     * @param string $initialData 初期データ
36     */
37    public function __construct(string $initialData)
38    {
39        $this->data = $initialData;
40        echo "[+] MyObjectWithWakeup::__construct called. Data: " . $this->data . PHP_EOL;
41    }
42
43    /**
44     * マジックメソッド __wakeup()。
45     * オブジェクトがデシリアライズされた直後に呼び出されます。
46     *
47     * このメソッドに記述されたロジックは、オブジェクトが正しくデシリアライズされた際に
48     * 実行されるべき初期化処理などを含みます。
49     * バイパスされると、このロジックが実行されなくなります。
50     */
51    public function __wakeup(): void
52    {
53        echo "[!] MyObjectWithWakeup::__wakeup called." . PHP_EOL;
54        $this->data = "Woke up: " . $this->data;
55    }
56
57    /**
58     * マジックメソッド __destruct()。
59     * オブジェクトが破棄されるときに呼び出されます。
60     */
61    public function __destruct(): void
62    {
63        echo "[-] MyObjectWithWakeup::__destruct called. Final Data: " . $this->data . PHP_EOL;
64    }
65}
66
67echo "=== 通常のデシリアライズ(__wakeup が呼び出される) ===" . PHP_EOL;
68// 1. オブジェクトをインスタンス化し、シリアライズする
69$originalObject = new MyObjectWithWakeup("Hello World");
70$serializedString = serialize($originalObject);
71echo "元のシリアライズ文字列: " . $serializedString . PHP_EOL;
72// 期待される形式例: O:18:"MyObjectWithWakeup":1:{s:4:"data";s:11:"Hello World";}
73// ここで ":1:" はオブジェクトが持つプロパティの数を表します。
74
75// 2. 通常のデシリアライズを行う
76//    __wakeup() メソッドが呼び出され、データが変更されることを確認します。
77$deserializedObjectNormal = unserialize($serializedString);
78echo "デシリアライズされたオブジェクト (通常):" . PHP_EOL;
79var_dump($deserializedObjectNormal);
80unset($deserializedObjectNormal); // __destruct を明示的に呼び出すため
81
82echo PHP_EOL . "=== __wakeup をバイパスするデシリアライズ ===" . PHP_EOL;
83// 3. シリアライズ文字列を改ざんし、__wakeup() の呼び出しをバイパスする
84//    オブジェクトのプロパティ数を示す部分 (例: ":1:") を実際の数よりも少なく変更します。
85//    このクラスには public $data; という1つのプロパティがあるため、プロパティ数を "1" から "0" に変更します。
86//    これにより、PHPはプロパティ数が少ないと判断し、E_NOTICE を発生させながら
87//    __wakeup() の呼び出しをスキップします。
88$bypassedSerializedString = str_replace(
89    // クラス名とプロパティ数を動的に取得して置換パターンを構築します
90    ':' . strlen(MyObjectWithWakeup::class) . ':"' . MyObjectWithWakeup::class . '":1:',
91    ':' . strlen(MyObjectWithWakeup::class) . ':"' . MyObjectWithWakeup::class . '":0:',
92    $serializedString
93);
94echo "バイパス用のシリアライズ文字列 (プロパティ数を0に変更): " . $bypassedSerializedString . PHP_EOL;
95
96// 4. 改ざんされた文字列でデシリアライズを行う
97//    __wakeup() メソッドが呼び出されないことを確認します。
98//    この操作は通常、E_NOTICE を発生させます。
99$deserializedObjectBypassed = unserialize($bypassedSerializedString);
100echo "デシリアライズされたオブジェクト (__wakeupバイパス):" . PHP_EOL;
101var_dump($deserializedObjectBypassed);
102unset($deserializedObjectBypassed); // __destruct を明示的に呼び出すため

PHPの__wakeupメソッドは、オブジェクトがデシリアライズ(シリアライズされた文字列から元のオブジェクトに復元される)された直後に自動的に呼び出されるマジックメソッドです。このメソッドは引数を受け取らず、戻り値もありません。通常、オブジェクトが復元された後の初期化処理などを記述するために利用されます。

ご提示のリファレンス情報にあるCompileError::__wakeupはPHPの内部メソッドであり、通常ユーザーが直接扱うことはありません。しかし、このサンプルコードは、一般的なユーザー定義クラスにおける__wakeupメソッドの挙動と、それを意図的にスキップする「バイパス(绕过)」手法をPHP 8の動作に基づいて示しています。

php wakeup 绕 过」とは、シリアライズされたオブジェクトをデシリアライズする際に、__wakeupメソッドの実行を回避する手法を指します。サンプルコードでは、オブジェクトをシリアライズした文字列の内部にある、オブジェクトが持つプロパティの数を表す数値(例: :1:)を実際の数よりも少なく改ざんすることで、このバイパスを実現しています。

具体的には、通常のデシリアライズでは__wakeupメソッドが呼び出され、オブジェクトのdataプロパティが変更される様子が確認できます。一方、プロパティ数を改ざんしたシリアライズ文字列でデシリアライズを行うと、PHPはプロパティ数が一致しないと判断し、E_NOTICEを発生させながら__wakeupの呼び出しをスキップします。これにより、__wakeup内部のロジックが実行されず、オブジェクトは__wakeupが呼び出されなかった状態のまま復元されます。この挙動は、かつてPHPのオブジェクトインジェクションに関連するセキュリティ上の脆弱性で利用されたことがあります。

このサンプルコードは、PHPの特殊メソッド__wakeupの呼び出しを意図的にスキップする手法を示しています。提供されたリファレンスのCompileError::__wakeupはPHPの内部クラスであり、通常扱うものではなく、PHP 8の標準定義にもこのメソッドは存在しません。サンプルは一般的なユーザー定義クラスでの__wakeupバイパスの挙動を説明しています。

unserialize()関数がシリアライズデータ中のプロパティ数を実際のクラスのプロパティ数よりも少ないと判断した場合、__wakeupの呼び出しをスキップし、E_NOTICEを発生させます。これはPHP 7.0.12以降の動作を利用したものです。この手法はかつてセキュリティ脆弱性として悪用された経緯があるため、意図しない挙動やセキュリティリスクにつながる可能性があります。特にunserialize()は、信頼できない外部からの入力に対して絶対に使用しないでください。安易な利用は避け、セキュリティ上の影響を十分に理解した上で慎重に扱う必要があります。

関連コンテンツ

関連IT用語