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

Copy
1<?php
2
3/**
4 * Demonstrates the __wakeup magic method and explains a historical deserialization bypass technique.
5 *
6 * In modern PHP (7.4 and later, including PHP 8), the __wakeup method is consistently called
7 * during unserialization, even if the serialized string incorrectly declares zero properties.
8 * This mitigates a specific type of deserialization bypass vulnerability found in older PHP versions.
9 */
10class MyClassWithWakeup
11{
12    public string $status;
13
14    public function __construct()
15    {
16        $this->status = 'Constructed';
17        echo "[DEBUG] __construct called. Current status: {$this->status}\n";
18    }
19
20    /**
21     * The __wakeup magic method is called when an object is unserialized.
22     * It is typically used to re-establish database connections, re-initialize resources,
23     * or perform security checks that might have been lost during serialization.
24     */
25    public function __wakeup(): void
26    {
27        $this->status .= ' (Woken up)';
28        echo "[DEBUG] __wakeup called. Current status: {$this->status}\n";
29    }
30
31    /**
32     * Returns the current status of the object.
33     */
34    public function getStatus(): string
35    {
36        return $this->status;
37    }
38}
39
40// --- Section 1: Standard Serialization and Deserialization ---
41echo "--- 1. Standard Serialization/Deserialization ---\n";
42// Create an object
43$originalObject = new MyClassWithWakeup();
44
45// Serialize the object into a string
46$serializedData = serialize($originalObject);
47echo "Serialized data (original): {$serializedData}\n";
48
49// Unserialize the string back into an object
50$deserializedObject = unserialize($serializedData);
51
52// Check the status of the deserialized object
53echo "Object status after standard unserialization: " . $deserializedObject->getStatus() . "\n";
54echo "Observation: Both __construct and __wakeup were called as expected.\n\n";
55
56// --- Section 2: Historical __wakeup Bypass Attempt (Demonstrated with PHP 8 Behavior) ---
57echo "--- 2. Historical __wakeup Bypass Attempt (PHP 8 Behavior) ---\n";
58echo "In older PHP versions (prior to 7.4), it was sometimes possible to bypass __wakeup execution\n";
59echo "by manipulating the property count within the serialized string. If the string claimed zero properties\n";
60echo "for an object that actually had them, __wakeup might be skipped. We will demonstrate this attempt\n";
61echo "and observe how PHP 8 handles it, showing the mitigation.\n\n";
62
63// Manually craft a serialized string for 'MyClassWithWakeup' that falsely declares zero properties.
64// The class name length (e.g., 17 for 'MyClassWithWakeup') must be accurate.
65$classNameLength = strlen('MyClassWithWakeup');
66$maliciousSerializedData = 'O:' . $classNameLength . ':"MyClassWithWakeup":0:{}';
67
68echo "Malicious serialized data (0 properties declared): {$maliciousSerializedData}\n";
69
70// Attempt to unserialize the maliciously crafted string
71$bypassedObject = unserialize($maliciousSerializedData);
72
73if ($bypassedObject instanceof MyClassWithWakeup) {
74    echo "Object status after 'bypassed' unserialization: " . $bypassedObject->getStatus() . "\n";
75    echo "Observation: Even with 0 properties declared in the serialized string,\n";
76    echo "             the __wakeup method was still called in PHP 8.\n";
77    echo "This confirms that modern PHP versions (7.4+) prevent this specific historical bypass.\n";
78    echo "The object's properties might not be initialized as intended by the malicious string,\n";
79    echo "but __wakeup's logic still executes.\n";
80} else {
81    echo "Failed to unserialize the malicious data. This should not happen with valid syntax.\n";
82}
83

PHPの__wakeupメソッドは、オブジェクトがシリアライズ解除（unserialize）される際に自動的に呼び出される特殊なマジックメソッドです。このメソッドは引数を取らず、戻り値もありません（void）。その主な役割は、オブジェクトがデータとして保存され復元される際に、データベース接続の再確立やリソースの再初期化など、シリアライズ中に失われた可能性のある状態を再設定することです。Dom\XMLDocumentのような、XMLドキュメントを扱うクラスのオブジェクトを復元する際にも、同様に利用されることがあります。

かつてPHP 7.4未満のバージョンでは、シリアライズされた文字列のプロパティ数を不正に操作することで、この__wakeupメソッドの実行をスキップさせるセキュリティ上の脆弱性がありました。これにより、オブジェクトの復元時に実行されるべき重要な処理がバイパスされるリスクが存在しました。しかし、PHP 7.4以降、そしてPHP 8を含む現代のバージョンでは、この挙動は修正されています。現在では、たとえシリアライズ文字列でプロパティ数が誤って宣言されていても、__wakeupメソッドは常に実行されるようになっています。サンプルコードは、この修正により過去のバイパス手法が現代のPHPでは機能せず、オブジェクトの安全な復元が保証されていることを示しています。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument オブジェクトは、内部リソースへのポインタを含むため、
5 * PHPの組み込みのシリアライゼーションメカニズムでは直接シリアライズできないことが一般的です。
6 *
7 * このクラスは、Dom\XMLDocumentを直接シリアライズするのではなく、
8 * そのXML文字列データをシリアライズし、デシリアライズ（unserialize）時に
9 * Dom\XMLDocumentオブジェクトを再構築する方法を示します。
10 * これにより、マジックメソッド __wakeup の一般的な役割と、Dom\XMLDocumentのような
11 * リソースをラップするオブジェクトの取り扱い方を理解できます。
12 *
13 * Dom\XMLDocument::__wakeup メソッドはPHPの内部実装であり、ユーザーが直接
14 * オーバーライドしたり呼び出したりすることはありません。しかし、オブジェクトの
15 * 復元時に呼び出されるマジックメソッドの概念は同じです。
16 */
17class XmlDataHandler
18{
19    private ?Dom\XMLDocument $document = null;
20    private string $xmlString = '';
21
22    /**
23     * コンストラクタ
24     * XML文字列を受け取り、Dom\XMLDocumentオブジェクトを初期化します。
25     */
26    public function __construct(string $xmlContent)
27    {
28        $this->xmlString = $xmlContent;
29        $this->loadDocument();
30    }
31
32    /**
33     * XML文字列からDom\XMLDocumentオブジェクトをロードします。
34     */
35    private function loadDocument(): void
36    {
37        $this->document = new Dom\XMLDocument();
38        // loadXML() が失敗した場合のより堅牢なエラーハンドリングが望ましいですが、
39        // サンプルコードでは簡潔のため省略しています。
40        $this->document->loadXML($this->xmlString);
41    }
42
43    /**
44     * オブジェクトがserialize()される前に呼び出されます。
45     * シリアライズするプロパティ名を配列で返します。
46     * Dom\XMLDocumentオブジェクト自体はシリアライズできないため、
47     * XML文字列を格納する $xmlString プロパティのみを対象とします。
48     *
49     * @return array<string> シリアライズするプロパティ名の配列
50     */
51    public function __sleep(): array
52    {
53        return ['xmlString'];
54    }
55
56    /**
57     * オブジェクトがunserialize()された後に呼び出されます。
58     * この時点で $document プロパティは (シリアライズされなかったため) null なので、
59     * シリアライズ時に保存された $xmlString から Dom\XMLDocument オブジェクトを再構築します。
60     * __wakeup の目的は、オブジェクトの状態を復元・再初期化することです。
61     */
62    public function __wakeup(): void
63    {
64        $this->loadDocument();
65    }
66
67    /**
68     * 内部の Dom\XMLDocument オブジェクトを返します。
69     */
70    public function getDocument(): ?Dom\XMLDocument
71    {
72        return $this->document;
73    }
74
75    /**
76     * 指定されたタグ名を持つ最初のノードのテキストコンテンツを返します。
77     */
78    public function getFirstNodeValue(string $tagName): ?string
79    {
80        if ($this->document === null) {
81            return null;
82        }
83        $nodes = $this->document->getElementsByTagName($tagName);
84        // PHP 8のnullsafe operator を使用
85        return $nodes->item(0)?->textContent;
86    }
87}
88
89// サンプルXMLデータ
90$xmlContent = <<<XML
91<?xml version="1.0" encoding="UTF-8"?>
92<root>
93    <item id="1">Value A</item>
94    <item id="2">Value B</item>
95</root>
96XML;
97
98// --- 元のオブジェクトの作成と使用 ---
99echo "--- 元のオブジェクトの作成と使用 ---\n";
100$originalHandler = new XmlDataHandler($xmlContent);
101echo "元のオブジェクトのXMLルートノード名: " . $originalHandler->getDocument()?->documentElement?->nodeName . "\n";
102echo "元のオブジェクトの最初のitemの値: " . $originalHandler->getFirstNodeValue('item') . "\n\n";
103
104// --- オブジェクトのシリアライズ ---
105// serialize() 関数が呼び出されると、XmlDataHandler::__sleep() メソッドが自動的に実行されます。
106// ここでは、$xmlString プロパティのみがシリアライズ対象となります。
107echo "--- オブジェクトのシリアライズ ---\n";
108$serializedHandler = serialize($originalHandler);
109echo "シリアライズされたデータ (表示用に一部エスケープ):\n";
110echo htmlspecialchars($serializedHandler) . "\n\n";
111
112// --- オブジェクトのデシリアライズ ---
113// unserialize() 関数が呼び出されると、XmlDataHandler::__wakeup() メソッドが自動的に実行されます。
114// __wakeup() 内で Dom\XMLDocument オブジェクトが $xmlString から再構築されます。
115echo "--- オブジェクトのデシリアライズ ---\n";
116$restoredHandler = unserialize($serializedHandler);
117echo "デシリアライズ後のオブジェクトのXMLルートノード名: " . $restoredHandler->getDocument()?->documentElement?->nodeName . "\n";
118echo "デシリアライズ後の最初のitemの値: " . $restoredHandler->getFirstNodeValue('item') . "\n";
119echo "デシリアライズ後、Dom\XMLDocumentオブジェクトが正しく再構築されたことを確認できます。\n";
120

PHP 8のDom\XMLDocument::__wakeupは、PHPのunserialize()関数によってオブジェクトがデシリアライズ（復元）された直後に自動的に呼び出される「マジックメソッド」の一つです。このメソッドは引数を取らず、戻り値もありません（void）。

通常、Dom\XMLDocumentのようなオブジェクトは、内部にファイルポインタなどのリソースへの参照を保持しており、そのままPHPのserialize()関数で永続化することができません。このようなケースにおいて、__wakeupメソッドが重要な役割を果たします。

ユーザーがクラスに__wakeupメソッドを実装する場合、このメソッドは、unserialize()によってオブジェクトの基本的なプロパティが復元された後に実行され、オブジェクトの内部状態を適切に再初期化するために利用されます。例えば、サンプルコードでは、シリアライズ時に保存しておいたXML文字列データから、Dom\XMLDocumentオブジェクトを再構築し、デシリアライズ後もオブジェクトが完全に機能する状態を保証しています。

Dom\XMLDocument拡張機能に直接定義されている__wakeupメソッドはPHPの内部実装であり、通常、開発者がこれを直接オーバーライドしたり呼び出したりすることはありませんが、その役割はユーザー定義の__wakeupと同様に、オブジェクトの復元処理を担っています。この仕組みは、内部リソースを持つオブジェクトを安全にシリアライズ・デシリアライズするために不可欠な技術です。