【PHP8.x】gzinflate()関数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Base64でエンコードされ、ZLIB DEFLATEで圧縮されたPHPコードをデコード、解凍し、実行します。
7 *
8 * この関数は、データ転送の際にコードを圧縮・エンコードし、後で復元して実行する
9 * 一つのパターンを示します。特に eval() の使用はセキュリティ上のリスクを伴うため、
10 * 信頼できないソースからのコードには決して使用しないでください。
11 *
12 * @param string $encodedCompressedCode Base64でエンコードされ、DEFLATEで圧縮されたPHPコード文字列。
13 * @return void
14 */
15function executeDeflatedAndEncodedCode(string $encodedCompressedCode): void
16{
17    // 1. Base64 デコード: エンコードされた文字列を元のバイナリデータに戻します。
18    //    これは、バイナリデータをテキスト形式で安全に扱うためによく使われます。
19    $decodedData = base64_decode($encodedCompressedCode);
20
21    if ($decodedData === false) {
22        echo "エラー: Base64デコードに失敗しました。入力データが不正である可能性があります。\n";
23        return;
24    }
25
26    // 2. DEFLATE 解凍 (gzinflate): 圧縮されたバイナリデータを元のPHPコード文字列に戻します。
27    //    gzinflate は DEFLATE 形式で圧縮されたデータを解凍するために使用されます。
28    $inflatedCode = gzinflate($decodedData);
29
30    if ($inflatedCode === false) {
31        echo "エラー: DEFLATE解凍 (gzinflate) に失敗しました。" .
32             "データが有効なDEFLATE圧縮データではない可能性があります。\n";
33        return;
34    }
35
36    // 3. Eval: 解凍されたPHPコードを実行します。
37    //    !! 警告 !! eval() は非常に強力な機能であり、セキュリティ上のリスクが高い関数です。
38    //    信頼できない、または検証されていないソースからのコードを実行するために
39    //    決して使用しないでください。このサンプルは、この機能の動作を示すことを目的としています。
40    eval($inflatedCode);
41}
42
43// --- サンプルコードの生成と実行 ---
44
45// 実行したい元のPHPコード文字列を準備します。
46$originalPhpCode = '<?php echo "デコードされ、解凍されたコードからこんにちは！";'
47                 . ' class Sample { public function greet() { echo "\nSampleクラスからの挨拶です！"; } }'
48                 . ' $obj = new Sample(); $obj->greet();';
49
50echo "--- 元のPHPコード ---\n";
51echo $originalPhpCode . "\n\n";
52
53// 1. 元のPHPコードをDEFLATE形式で圧縮します (gzdeflate)。
54//    これは gzinflate と対になる圧縮関数です。
55$compressedCode = gzdeflate($originalPhpCode);
56
57// 2. 圧縮されたバイナリデータをBase64でエンコードします。
58//    これにより、バイナリデータをテキストとして扱うことができます。
59$encodedCompressedCode = base64_encode($compressedCode);
60
61echo "--- Base64エンコードされ、DEFLATE圧縮されたコード ---\n";
62echo $encodedCompressedCode . "\n\n";
63
64echo "--- 関数による実行結果 ---\n";
65// エンコード・圧縮されたコードをデコード・解凍し、実行します。
66executeDeflatedAndEncodedCode($encodedCompressedCode);
67
68?>

このPHPサンプルコードは、Base64でエンコードされ、さらにZLIB DEFLATE形式で圧縮されたPHPコードを、デコード・解凍して実行する一連のプロセスを示しています。

核となるgzinflate関数は、DEFLATE形式で圧縮されたデータ文字列を解凍する役割を担います。第一引数$dataには解凍したい圧縮データ文字列を渡します。オプションの第二引数$max_lengthで解凍後の最大長を指定できますが、通常は省略されます。関数が成功すると解凍された元の文字列を返し、解凍に失敗した場合はfalseを返します。

サンプルコードではまず、base64_decodeでBase64エンコードを解除し、次にgzinflateでDEFLATE圧縮を解凍します。最終的に、解凍されたPHPコードをeval関数で実行しています。この処理は、コードを効率的に転送する目的などで利用されることがありますが、eval関数は実行されるコードを完全に信頼できる場合にのみ使用すべきです。信頼できないソースからのコードをevalで実行すると、セキュリティ上の重大なリスクを引き起こす可能性があるため、実運用では十分な注意が必要です。この例は、このようなデータ処理とコード実行のパターンを示すものです。

Copy
1<?php
2
3/**
4 * Base64 でエンコードされた、gzip 圧縮されたデータを展開します。
5 *
6 * @param string $base64EncodedGzippedData Base64 エンコードされた gzip 圧縮データ
7 * @return string|false 展開されたデータ。失敗した場合は false
8 */
9function inflateBase64GzipData(string $base64EncodedGzippedData): string|false
10{
11    // Base64 デコード
12    $gzippedData = base64_decode($base64EncodedGzippedData);
13
14    if ($gzippedData === false) {
15        return false; // Base64 デコードに失敗
16    }
17
18    // gzinflate で展開
19    $inflatedData = gzinflate($gzippedData);
20
21    if ($inflatedData === false) {
22        return false; // gzinflate に失敗
23    }
24
25    return $inflatedData;
26}
27
28// 使用例
29$originalData = "This is a test string to be compressed and then inflated.";
30$gzippedData = gzdeflate($originalData);
31$base64EncodedGzippedData = base64_encode($gzippedData);
32
33$inflatedData = inflateBase64GzipData($base64EncodedGzippedData);
34
35if ($inflatedData !== false) {
36    // echo "Original Data: " . $originalData . "\n"; // オリジナルデータ
37    // echo "Inflated Data: " . $inflatedData . "\n"; // 展開されたデータ
38
39    if ($originalData === $inflatedData) {
40        // echo "Successfully inflated the data.\n"; // 成功
41    } else {
42        // echo "Failed to inflate the data.\n"; // 失敗
43    }
44} else {
45    // echo "Failed to inflate the data.\n"; // 失敗
46}

このサンプルコードは、Base64エンコードされたgzip圧縮データを展開するinflateBase64GzipData関数を定義しています。gzinflate関数とbase64_decode関数を組み合わせて使用することで、圧縮されたデータを元の状態に戻します。

まず、関数は引数としてBase64エンコードされたgzip圧縮された文字列 $base64EncodedGzippedData を受け取ります。この文字列は、base64_decode関数によってデコードされ、gzip圧縮されたデータ $gzippedData に変換されます。もしデコードに失敗した場合、関数は false を返します。

次に、gzinflate関数が $gzippedData を展開します。gzinflate関数は、圧縮されたデータを展開し、元の文字列を返します。もし展開に失敗した場合、gzinflate関数は false を返します。inflateBase64GzipData関数も同様に false を返します。

最後に、展開されたデータ $inflatedData が返されます。サンプルコードでは、gzdeflate関数で圧縮し、base64_encode関数でエンコードしたデータを用いて、展開処理のテストを行っています。展開されたデータと元のデータを比較することで、処理が正常に行われたかを確認できます。

gzinflate関数の引数 $data には、gzip圧縮された文字列を指定します。オプションの引数 $max_length は、展開するデータの最大長を指定します。省略した場合、最大長は制限されません。gzinflate関数は、展開された文字列を返すか、エラーが発生した場合は false を返します。

Copy
1<?php
2
3/**
4 * gzinflate 関数を使ったサンプルコード
5 *
6 * 圧縮されたデータを解凍します。
7 */
8
9$compressed_data = gzdeflate("This is a sample string to be compressed.");
10
11// 圧縮されたデータを解凍する
12$original_data = gzinflate($compressed_data);
13
14if ($original_data !== false) {
15    echo "解凍されたデータ: " . $original_data . PHP_EOL;
16} else {
17    echo "解凍に失敗しました。" . PHP_EOL;
18}
19
20
21// 最大長を指定して解凍する例
22$compressed_data_with_extra = gzdeflate("This is a longer sample string to be compressed.  This part exceeds the max_length.");
23$max_length = 50;
24$inflated_data_with_max_length = gzinflate($compressed_data_with_extra, $max_length);
25
26
27if ($inflated_data_with_max_length !== false) {
28    echo "最大長を指定して解凍されたデータ (" . $max_length . " バイト): " . substr($inflated_data_with_max_length, 0, $max_length) . PHP_EOL;
29} else {
30    echo "最大長を指定した解凍に失敗しました。" . PHP_EOL;
31}
32?>

PHPのgzinflate関数は、圧縮された文字列データを解凍するために使用します。この関数は、zlibライブラリを利用してデータを解凍します。

第1引数$dataには、解凍したい圧縮された文字列を指定します。第2引数$max_lengthはオプションで、解凍するデータの最大長をバイト単位で指定できます。$max_lengthを省略した場合、または0を指定した場合、データ全体が解凍されます。

関数は、解凍された文字列を返します。もし解凍に失敗した場合（例えば、データが有効な圧縮形式でない場合や、$max_lengthを超えた場合）、falseを返します。

サンプルコードでは、まずgzdeflate関数を使って文字列を圧縮しています。次に、gzinflate関数を使って圧縮されたデータを解凍し、元の文字列に戻します。解凍が成功した場合は、解凍されたデータを出力します。また、$max_lengthを指定して解凍する例も示しており、この場合、指定された最大長までのデータが解凍されます。解凍結果がfalseでないか確認することで、解凍が正常に行われたかどうかを判断できます。システムエンジニアを目指す方は、この関数を利用して、圧縮されたデータを効率的に扱うことができます。