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

Copy
1<?php
2
3/**
4 * putenv関数のセキュリティ上のリスクを示すデモンストレーション。
5 *
6 * putenv() 関数は環境変数を設定しますが、外部からの入力で PATH などの
7 * 環境変数を操作されると、意図しないコマンドが実行されるセキュリティ上の
8 * 脆弱性 (PATHインジェクションなど) につながる可能性があります。
9 * このコードは、その概念を教育目的で示します。
10 * (このデモンストレーションはUNIX系システムを想定しています。)
11 */
12function demonstratePutenvExploitRisk(): void
13{
14    echo "=== putenv() セキュリティリスクのデモンストレーション ===\n\n";
15
16    // オリジナルのPATH環境変数を保存
17    $originalPath = getenv('PATH');
18    echo "現在のPATH環境変数: " . ($originalPath !== false ? $originalPath : '[未設定]') . "\n\n";
19
20    // 一時的な「悪意のある」実行パスを作成
21    $maliciousPath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'malicious_bin';
22    if (!is_dir($maliciousPath) && !mkdir($maliciousPath, 0755, true)) {
23        echo "エラー: 悪意のあるパスを作成できませんでした。\n";
24        return;
25    }
26
27    // 偽の 'ls' スクリプトを作成
28    // UNIX系システムでは、このスクリプトが本来のlsよりも優先して実行される
29    $fakeLsScript = $maliciousPath . DIRECTORY_SEPARATOR . 'ls';
30    $scriptContent = "#!/bin/sh\necho '!!! WARNING: Fake ls executed from malicious path !!!'\n";
31    if (file_put_contents($fakeLsScript, $scriptContent) === false) {
32        echo "エラー: 偽の 'ls' スクリプトを作成できませんでした。\n";
33        rmdir($maliciousPath);
34        return;
35    }
36    chmod($fakeLsScript, 0755);
37
38    echo "一時的な悪意のあるパスを作成しました: " . $maliciousPath . "\n";
39    echo "偽の 'ls' スクリプトを作成しました: " . $fakeLsScript . "\n\n";
40
41    // PATH環境変数を変更し、悪意のあるパスを最優先にする
42    echo "PATH環境変数を変更中... (putenv('PATH=$maliciousPath" . ($originalPath !== false ? ":$originalPath" : '') . "'))\n";
43    if (putenv("PATH=$maliciousPath" . ($originalPath !== false ? ":$originalPath" : ''))) {
44        echo "PATH環境変数の設定に成功しました。\n";
45        echo "新しいPATH環境変数: " . getenv('PATH') . "\n\n";
46    } else {
47        echo "PATH環境変数の設定に失敗しました。\n";
48        // クリーンアップ
49        unlink($fakeLsScript);
50        rmdir($maliciousPath);
51        return;
52    }
53
54    // `ls`コマンドを実行してみる
55    // 通常であればシステム標準のlsが実行されるが、ここでは偽のlsが実行されるはず
56    echo "外部コマンド 'ls' を実行します (shell_exec('ls')):\n";
57    $output = shell_exec('ls');
58    echo "--- コマンド出力開始 ---\n";
59    echo $output;
60    echo "--- コマンド出力終了 ---\n\n";
61
62    // 元のPATH環境変数に戻す
63    echo "PATH環境変数を元に戻します... (putenv('PATH=" . ($originalPath !== false ? $originalPath : '') . "'))\n";
64    if (putenv("PATH=" . ($originalPath !== false ? $originalPath : ''))) {
65        echo "PATH環境変数を元に戻しました。\n";
66        echo "現在のPATH環境変数: " . getenv('PATH') . "\n\n";
67    } else {
68        echo "PATH環境変数を元に戻すのに失敗しました。\n";
69    }
70
71    // クリーンアップ
72    echo "一時ファイルをクリーンアップ中...\n";
73    unlink($fakeLsScript);
74    rmdir($maliciousPath);
75    echo "クリーンアップが完了しました。\n\n";
76
77    echo "警告: putenv() の引数がユーザー入力に基づいて生成される場合、\n";
78    echo "環境変数を操作され、意図しないコマンド実行などの重大なセキュリティリスクが生じます。\n";
79    echo "外部からの入力を使って putenv() を呼び出す場合は、厳重な検証とサニタイズが不可欠です。\n";
80}
81
82// デモンストレーションを実行
83demonstratePutenvExploitRisk();

PHPのputenv関数は、指定された文字列$assignment（例えば「PATH=/usr/local/bin」のような「変数名=値」の形式）を用いて環境変数を設定する機能を提供します。この関数は、設定が成功すればtrueを、失敗すればfalseを戻り値として返します。

提供されたサンプルコードは、putenv関数が持つセキュリティ上のリスク、特に「PATHインジェクション」と呼ばれる脆弱性の概念を教育目的で示しています。通常、システム上でコマンド（例: ls）が実行される際、PATH環境変数に設定されたディレクトリの順序で実行ファイルが検索されます。このデモンストレーションでは、一時的に「悪意のある」ディレクトリを作成し、その中に本来のコマンドと同じ名前（ls）の偽のスクリプトを配置します。

その後、putenv関数を使ってPATH環境変数を意図的に変更し、この悪意のあるディレクトリがシステム標準のパスよりも優先して検索されるように設定します。その結果、shell_exec('ls')のようなコマンドを実行すると、システム本来のlsコマンドではなく、作成した偽のスクリプトが誤って実行されてしまう様子が示されます。これは、もし外部からの入力によってPATHなどの環境変数が操作されると、攻撃者が意図しないプログラムを実行させることが可能になる重大なセキュリティリスクであることを意味します。putenv関数を外部からの入力値と組み合わせて使用する際は、厳重な検証とサニタイズが不可欠です。

Copy
1<?php
2
3/**
4 * Demonstrates the use of putenv() to set, modify, and unset environment variables
5 * and getenv() to retrieve their values.
6 *
7 * putenv() affects the environment variables for the current PHP process
8 * and any child processes it spawns. It does not affect the parent process
9 * or other unrelated processes.
10 */
11function demonstrateEnvironmentVariables(): void
12{
13    echo "--- Demonstrating putenv() and getenv() ---\n\n";
14
15    // Define a unique name for our test environment variable
16    $variableName = 'PHP_DEMO_ENV_VAR';
17
18    // --- 1. Set a new environment variable ---
19    $initialValue = 'HelloFromPHP';
20    // The argument format for putenv() is "VAR_NAME=VALUE"
21    $assignment = "$variableName=$initialValue";
22
23    echo "1. Attempting to set environment variable: '$assignment'\n";
24    if (putenv($assignment)) {
25        echo "   Successfully set '$variableName'.\n";
26    } else {
27        echo "   Failed to set '$variableName'.\n";
28    }
29
30    // Retrieve and display the value using getenv()
31    $retrievedValue = getenv($variableName);
32    echo "   Value of '$variableName' using getenv(): " .
33         ($retrievedValue !== false ? "'$retrievedValue'" : "Not set (false)") . "\n\n";
34
35
36    // --- 2. Update the environment variable ---
37    $updatedValue = 'UpdatedValueByPHP';
38    $newAssignment = "$variableName=$updatedValue";
39
40    echo "2. Attempting to update environment variable: '$newAssignment'\n";
41    if (putenv($newAssignment)) {
42        echo "   Successfully updated '$variableName'.\n";
43    } else {
44        echo "   Failed to update '$variableName'.\n";
45    }
46
47    // Retrieve and display the updated value
48    $retrievedValue = getenv($variableName);
49    echo "   New value of '$variableName' using getenv(): " .
50         ($retrievedValue !== false ? "'$retrievedValue'" : "Not set (false)") . "\n\n";
51
52
53    // --- 3. Unset (remove) the environment variable ---
54    // According to PHP documentation, passing an empty string as the assignment
55    // parameter (e.g., "VAR_NAME=") will unset the environment variable.
56    $unsetAssignment = "$variableName=";
57
58    echo "3. Attempting to unset environment variable: '$unsetAssignment'\n";
59    if (putenv($unsetAssignment)) {
60        echo "   Successfully unset '$variableName'.\n";
61    } else {
62        echo "   Failed to unset '$variableName'.\n";
63    }
64
65    // Attempt to retrieve the value after unsetting.
66    // getenv() returns false if the variable is not set in the environment.
67    $retrievedValue = getenv($variableName);
68    echo "   Value of '$variableName' after unsetting using getenv(): " .
69         ($retrievedValue !== false ? "'$retrievedValue'" : "Not set (false)") . "\n";
70    echo "   (Note: 'Not set (false)' indicates the variable has been successfully removed from the environment.)\n\n";
71
72    echo "--- End of demonstration ---\n";
73}
74
75// Execute the demonstration function
76demonstrateEnvironmentVariables();
77

このPHPサンプルコードは、環境変数を操作するための putenv 関数と getenv 関数の使い方を解説しています。

putenv 関数は、PHPスクリプトが実行されている環境に新しい環境変数を追加したり、既存の値を変更したりするために使用します。引数には "変数名=値" という形式の文字列を渡します。処理が成功すると true を、失敗すると false を返します。

一方、getenv 関数は、指定した名前の環境変数の値を取得します。引数に環境変数名を文字列で渡すと、その値が文字列として返されます。もし指定した環境変数が存在しない場合は false が返されます。

サンプルコードでは、まず putenv を使って PHP_DEMO_ENV_VAR という名前の環境変数を設定し、getenv でその値が正しく取得できることを確認しています。次に、同じ変数名に対して再度 putenv を実行し、値が更新されることを示しています。最後に、"変数名=" という形式で putenv を呼び出すことで、環境変数が削除（設定解除）されることを実演しています。削除後、getenv は false を返すようになります。このように、二つの関数を組み合わせることで、スクリプトの実行中に環境変数を動的に設定、取得、削除することが可能です。

Copy
1<?php
2
3/**
4 * PHP putenv 関数の動作確認サンプルコード
5 *
6 * このスクリプトは、環境変数を設定し、その後すぐに取得して期待通りに動作するかを確認します。
7 * 'putenv not working' と感じた際に、問題の切り分けに役立ちます。
8 */
9
10// 設定する環境変数の名前と値
11$envName = 'MY_APP_MODE';
12$envValue = 'development';
13
14echo "--- PHP 'putenv' 関数の動作確認サンプル ---\n";
15echo "環境変数 '{$envName}' を '{$envValue}' に設定し、動作を確認します。\n\n";
16
17// putenv() を使って環境変数を設定します。
18// 成功すると true、失敗すると false を返します。
19echo "1. 環境変数 '{$envName}' を '{$envValue}' に設定しようとしています...\n";
20$isSetSuccessfully = putenv("{$envName}={$envValue}");
21
22if ($isSetSuccessfully) {
23    echo "   -> putenv() 関数は設定に成功しました (true を返しました)。\n";
24
25    // getenv() を使って設定した環境変数の値を取得します。
26    // 環境変数が見つからない場合、false を返します。
27    echo "2. 設定後に '{$envName}' の値を取得しようとしています...\n";
28    $retrievedValue = getenv($envName);
29
30    echo "   取得した '{$envName}' の値: ";
31    if ($retrievedValue === false) {
32        // putenv が true を返したのに getenv が false を返す場合
33        echo "取得できませんでした (false)。\n";
34        echo "   -> **警告**: putenv() は成功を返しましたが、getenv() で値が取得できませんでした。\n";
35        echo "      これは 'putenv not working' と感じられる一般的なケースです。\n";
36        echo "      - 現在のPHP実行環境で環境変数の設定が許可されているか確認してください。\n";
37        echo "      - Webサーバー環境 (Apache/Nginx + PHP-FPMなど) の場合、環境変数の可視性が\n";
38        echo "        実行コンテキストによって異なることがあります。CLI (コマンドライン) で試してみてください。\n";
39    } elseif ($retrievedValue === $envValue) {
40        // 設定値と取得値が一致する場合
41        echo "'{$retrievedValue}' (設定値と一致)\n";
42        echo "   -> putenv() は期待通りに動作しています。\n";
43    } else {
44        // 設定値と取得値が異なる場合
45        echo "'{$retrievedValue}' (設定値 '{$envValue}' と一致しません)\n";
46        echo "   -> **警告**: putenv() は成功を返しましたが、取得した値が設定した値と異なります。\n";
47        echo "      これは環境変数が既に存在し、上書きできなかったか、別のプロセスによって変更された可能性があります。\n";
48    }
49
50    // (オプション) 設定した環境変数をクリアする例
51    // putenv("VAR_NAME=") とすることで、環境変数を空にするか、事実上削除します。
52    echo "\n3. 設定した環境変数 '{$envName}' をクリアしようとしています...\n";
53    if (putenv("{$envName}=")) {
54        echo "   -> 環境変数のクリアに成功しました。\n";
55        $retrievedValueAfterClear = getenv($envName);
56        echo "   クリア後に取得した '{$envName}' の値: " . ($retrievedValueAfterClear === false ? '取得できませんでした' : "'{$retrievedValueAfterClear}'") . "\n";
57    } else {
58        echo "   -> 環境変数のクリアに失敗しました。\n";
59    }
60
61} else {
62    // putenv が false を返す場合
63    echo "   -> **エラー**: putenv() 関数が false を返しました。\n";
64    echo "      これは 'putenv not working' の直接的な原因です。\n";
65    echo "      - このスクリプトを実行する環境で環境変数の設定が許可されていない可能性があります。\n";
66    echo "      - オペレーティングシステムやPHPの設定 (例: disable_functions) を確認してください。\n";
67}
68
69echo "\n--------------------------------------------------------\n";
70
71?>

PHPのputenv関数は、現在実行中のPHPプロセスに対して環境変数を設定するために利用されます。引数には"変数名=値"形式の文字列を指定し、環境変数の設定が成功すればtrue、失敗すればfalseを戻り値として返します。このサンプルコードは、putenv関数が期待通りに動作しない（'putenv not working'）と感じた際に、問題の原因を切り分けるための確認手順を示しています。

コードでは、まずMY_APP_MODEという環境変数をdevelopmentという値で設定を試みます。putenvがtrueを返した場合は設定自体は成功ですが、その後すぐにgetenv関数を使って設定した値が正しく取得できるかを確認します。putenvが成功を返したにもかかわらずgetenvで値が取得できなかったり、設定した値と異なる値が取得されたりする場合があります。これは、Webサーバー環境とCLI環境での環境変数の可視性の違いや、PHP実行環境の制約が原因である可能性があります。

もしputenv自体がfalseを返した場合は、PHPの設定（例えばdisable_functions）や、オペレーティングシステムによって環境変数の設定が許可されていないことが直接的な原因と考えられます。また、設定した環境変数はputenv("変数名=")のようにすることでクリアできることも示しています。このサンプルを通じて、putenv関数の正確な挙動とトラブルシューティングのポイントを理解することができます。

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのputenv関数を使ってPATH環境変数を一時的に変更する方法を示します。
5 * システムエンジニアにとって、環境変数の操作はよくあるタスクです。
6 * putenv関数は、現在のスクリプト実行環境の環境変数を設定します。
7 */
8
9// 1. 現在のPATH環境変数を取得し、表示します。
10//    これにより、変更前の状態を確認できます。
11$originalPath = getenv('PATH');
12echo "変更前のPATH: " . ($originalPath !== false ? $originalPath : "PATHが設定されていません") . PHP_EOL;
13
14// 2. PATHに追加したい新しいディレクトリを定義します。
15//    これは一例であり、実際にはシステムに存在するパスを指定します。
16$newPathEntry = '/usr/local/my_custom_tools';
17
18// 3. 新しいPATH環境変数の文字列を構築します。
19//    既存のPATHに新しいエントリを追加する形式が一般的です。
20//    'PATH=' のプレフィックスはputenv関数で環境変数を設定する際に必須です。
21//    Windows環境ではパスの区切り文字にセミコロン(;)を使用しますが、
22//    Unix系システムではコロン(:)を使用します。ここではコロンを想定します。
23$newFullPathAssignment = 'PATH=' . $originalPath . ':' . $newPathEntry;
24
25// 4. putenv関数を使ってPATH環境変数を設定します。
26//    この関数は成功した場合にtrue、失敗した場合にfalseを返します。
27echo "新しいPATHエントリを追加中: " . $newPathEntry . PHP_EOL;
28$success = putenv($newFullPathAssignment);
29
30// 5. putenvの実行結果を確認し、ユーザーに通知します。
31if ($success) {
32    echo "PATH環境変数の設定に成功しました。" . PHP_EOL;
33
34    // 6. 変更後のPATH環境変数を再度取得し、表示します。
35    //    これにより、変更が正しく適用されたことを確認できます。
36    $updatedPath = getenv('PATH');
37    echo "変更後のPATH: " . ($updatedPath !== false ? $updatedPath : "PATHが設定されていません") . PHP_EOL;
38
39    // 注意: putenvによる変更は、現在のPHPプロセスとその子プロセスにのみ影響します。
40    //       システム全体や、他のPHPスクリプトには影響しません。
41    //       永続的な変更には、システムの環境変数設定ファイルを編集する必要があります。
42
43} else {
44    echo "PATH環境変数の設定に失敗しました。" . PHP_EOL;
45}
46
47// （オプション）元のPATHに戻すことも可能ですが、このスクリプトの目的は変更を示すことなので割愛します。
48// putenv('PATH=' . $originalPath);
49
50?>

PHPのputenv関数は、現在のスクリプト実行環境の環境変数を一時的に設定するために使用されます。システムエンジニアにとって、プログラムの動作に影響を与える環境変数の操作は重要なタスクの一つです。

この関数の引数$assignmentには、「変数名=値」という形式の文字列を渡します。例えば、'PATH=/usr/bin:/bin'のように記述します。設定が成功した場合はtrue、失敗した場合はfalseが戻り値として返されます。

サンプルコードでは、putenv関数を使ってPATH環境変数を一時的に変更する手順を示しています。まず、getenv('PATH')で現在のPATH環境変数の値を取得し、その値に新しいディレクトリパスを追加した文字列を作成します。この文字列をputenv関数に渡すことで、現在のPHPプロセスにおけるPATH環境変数を更新しています。関数実行後、再度getenv('PATH')で確認することで、変更が正しく適用されたことを確認できます。

ただし、putenvによる環境変数の変更は、このPHPスクリプトとその子プロセスにのみ適用される点に注意が必要です。システム全体や他のPHPプロセスには影響せず、永続的な変更はシステムの環境変数設定ファイルを編集して行う必要があります。