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

Copy
1<?php
2
3/**
4 * umask 関数の使用例：現在の umask 値を取得し、新しい umask 値を設定し、元の値に戻す。
5 */
6
7// 現在の umask 値を取得
8$old_umask = umask();
9
10echo "現在の umask: " . decoct($old_umask) . "\n";
11
12// 新しい umask 値を設定 (例: 0022)
13$new_umask = 0022;
14umask($new_umask);
15
16echo "新しい umask を設定: " . decoct($new_umask) . "\n";
17
18// ファイル作成時のパーミッションを確認 (umask の影響を確認)
19touch("test_file.txt");
20$perms = fileperms("test_file.txt");
21$file_perms = substr(sprintf('%o', $perms), -4);
22
23echo "作成されたファイルのパーミッション: " . $file_perms . "\n";
24
25// umask を元の値に戻す
26umask($old_umask);
27
28echo "umask を元の値に戻しました: " . decoct($old_umask) . "\n";
29
30// 後始末: 作成したファイルを削除
31unlink("test_file.txt");
32
33?>

このPHPサンプルコードは、umask関数を使ったファイル作成時のパーミッション制御について解説しています。umask関数は、新規ファイルやディレクトリが作成される際のデフォルトパーミッションを設定するために使用します。

umask()のように引数なしで関数を呼び出すと、現在のumask値が整数で返されます。引数 $mask に整数値を指定すると、umask値を設定し、設定前のumask値を返します。$maskにnullを指定すると、umask値は変更されずに現在のumask値が返されます(PHP 8以降)。

サンプルコードでは、まず現在のumask値をumask()で取得し、decoct()関数を使って8進数表記に変換して表示しています。次に、umask(0022)で新しいumask値を設定します。この例では、0022という一般的な値を設定しています。

touch("test_file.txt")で新しいファイルを作成し、fileperms()関数でそのファイルのパーミッションを取得しています。取得したパーミッションを8進数で表示することで、umaskがファイル作成時のパーミッションにどのように影響するかを確認できます。

最後に、umask($old_umask)でumask値を元の値に戻しています。これは、スクリプトの実行後にシステムのデフォルト設定を変更しないための重要なステップです。unlink("test_file.txt")でテストファイルを削除して、後始末をしています。

この例を通して、umask関数がファイル作成時のセキュリティ設定にどのように影響するかを理解することができます。システムエンジニアを目指す上で、ファイルパーミッションの制御は重要な知識となります。

Copy
1<?php
2
3// 現在の umask 値を取得して表示します。
4$current_umask = umask();
5echo "現在の umask: " . decoct($current_umask) . "\n";
6
7// umask を 0 に設定します。これにより、新規ファイル作成時のパーミッションが最大になります。
8umask(0);
9
10// 設定後の umask 値を確認します。
11$new_umask = umask();
12echo "umask を 0 に設定しました。\n";
13
14// 新規ファイルを作成し、パーミッションを確認します。
15touch("test_file.txt");
16$perms = fileperms("test_file.txt");
17$permissions = substr(sprintf('%o', $perms), -4);
18
19echo "新規ファイルのパーミッション: " . $permissions . "\n";
20
21// umask を元の値に戻します。
22umask($current_umask);
23echo "umask を元の値に戻しました。\n";
24
25// スクリプト終了時の umask 値を表示します。
26$final_umask = umask();
27echo "スクリプト終了時の umask: " . decoct($final_umask) . "\n";
28?>

このPHPのサンプルコードは、umask()関数を使って、新規ファイル作成時のデフォルトのパーミッションを制御する方法を示しています。

umask()関数は、引数 $mask に指定された値を現在のumask値として設定します。$mask にnullが指定された場合は、現在のumask値を返します。この関数はint型の値を返します。

最初に、現在のumask値をumask()関数で取得し、decoct()関数を使って8進数表記に変換して表示しています。

次に、umask(0) を実行することで、umask値を0に設定しています。これにより、新しく作成されるファイルやディレクトリは、最大限のパーミッション（通常は0666または0777からumask値が引かれたもの）を持つようになります。設定後、再度umask()関数でumask値を確認しています。

touch("test_file.txt") で新規ファイルを作成し、fileperms()関数でファイルのパーミッションを取得しています。取得したパーミッションをsprintf('%o', $perms)で8進数表記に変換し、substr()関数で必要な部分を取り出して表示しています。

最後に、umask($current_umask) でumask値を最初に取得した値に戻し、スクリプト終了時のumask値を確認しています。これは、他のスクリプトやシステムに影響を与えないようにするための配慮です。

このサンプルコードを実行することで、umask()関数の挙動と、ファイルパーミッションに与える影響を理解することができます。

Copy
1<?php
2
3/**
4 * PHPのumask関数とmkdir関数を使用して、
5 * ディレクトリ作成時のパーミッション制御をデモンストレーションします。
6 * umaskは、新しいファイルやディレクトリが作成される際に適用されるパーミッションマスクを定義します。
7 */
8function demonstrateUmaskAndMkdir(): void
9{
10    echo "umask関数とmkdir関数のデモンストレーション\n\n";
11
12    // 1. 現在のumask値を取得し、後で元の値に戻すために保存します。
13    // umask()を引数なしで呼び出すと、現在のumask値が返されます。
14    // 値は8進数で表示するためにsprintfを使用しています。
15    $originalUmask = umask();
16    echo "現在のumask値: " . sprintf('%04o', $originalUmask) . " (8進数)\n\n";
17
18    // テスト用のベースディレクトリをシステムの一時ディレクトリ内に作成します。
19    $baseDir = sys_get_temp_dir() . '/php_umask_test_' . uniqid();
20    if (!mkdir($baseDir, 0777, true)) {
21        echo "エラー: ベースディレクトリ '$baseDir' の作成に失敗しました。\n";
22        return;
23    }
24    echo "テスト用ベースディレクトリ '$baseDir' を作成しました。\n\n";
25
26    $dir1 = $baseDir . '/dir_default_umask';
27    $dir2 = $baseDir . '/dir_custom_umask';
28    $requestedMode = 0777; // mkdirに要求するパーミッション (例: 全ての権限)
29
30    // 2. デフォルトのumask値でディレクトリを作成します。
31    // mkdirで指定したパーミッションからumask値でマスクされたビットが除外され、実際のパーミッションが決定されます。
32    echo "--- デフォルトumask (" . sprintf('%04o', $originalUmask) . ") でディレクトリを作成 ---\n";
33    if (mkdir($dir1, $requestedMode)) {
34        // fileperms()はファイルタイプ情報も含むため、& 0777 でパーミッション部分のみを抽出します。
35        $actualMode = fileperms($dir1) & 0777;
36        echo "ディレクトリ '$dir1' を要求パーミッション " . sprintf('%04o', $requestedMode) . " で作成。\n";
37        echo "実際のパーミッション: " . sprintf('%04o', $actualMode) . "\n\n";
38    } else {
39        echo "エラー: ディレクトリ '$dir1' の作成に失敗しました。\n\n";
40    }
41
42    // 3. umask値を変更し、新しいumask値でディレクトリを作成します。
43    // umask(0022) は、グループとその他のユーザーの書き込み権限を許可しない一般的な設定です。
44    // この設定で0777を要求すると、通常0755のパーミッションが適用されます。
45    $newUmask = 0022;
46    umask($newUmask); // 新しいumaskを設定
47    echo "--- umaskを " . sprintf('%04o', $newUmask) . " に設定してディレクトリを作成 ---\n";
48    if (mkdir($dir2, $requestedMode)) {
49        $actualMode = fileperms($dir2) & 0777;
50        echo "ディレクトリ '$dir2' を要求パーミッション " . sprintf('%04o', $requestedMode) . " で作成。\n";
51        echo "実際のパーミッション: " . sprintf('%04o', $actualMode) . "\n\n";
52    } else {
53        echo "エラー: ディレクトリ '$dir2' の作成に失敗しました。\n\n";
54    }
55
56    // 4. 後処理: umaskを元の値に戻し、作成した一時ディレクトリを削除します。
57    umask($originalUmask);
58    echo "umaskを元の値 " . sprintf('%04o', $originalUmask) . " に戻しました。\n";
59
60    // 作成したディレクトリを削除 (rmdirは空のディレクトリのみ削除可能です)
61    if (file_exists($dir1)) {
62        rmdir($dir1);
63    }
64    if (file_exists($dir2)) {
65        rmdir($dir2);
66    }
67    if (file_exists($baseDir)) {
68        rmdir($baseDir);
69    }
70    echo "作成した一時ディレクトリを削除しました。\n";
71}
72
73// デモンストレーションを実行します。
74demonstrateUmaskAndMkdir();

PHPのumask関数は、新しく作成されるファイルやディレクトリのデフォルトのパーミッション（アクセス権）を制御するために使用されます。この関数は、引数に整数値（通常は8進数）を指定することでumask値を変更し、その変更前のumask値を整数として返します。引数を省略してumask()を呼び出した場合は、現在のumask値を取得できます。

サンプルコードでは、このumask関数と、ディレクトリを作成するmkdir関数を組み合わせて、パーミッション制御の挙動を示しています。まず、umask()を引数なしで呼び出して現在のumask値を取得し、この値がディレクトリ作成にどう影響するかを確認します。mkdir関数でディレクトリを作成する際、指定したパーミッションからumask値で「許可しない」と設定されたビットが除外され、実際のパーミッションが決定されます。

次に、umask(0022)のように新しいumask値を設定し、同じようにディレクトリを作成することで、umask値の違いが実際のパーミッションにどのように影響するかを比較しています。例えば、umaskが0022の場合、要求するパーミッションが0777であっても、作成されるディレクトリは通常0755となります。これは、グループとその他のユーザーの書き込み権限がumaskによってマスクされるためです。プログラムの終了時には、umask値を元の状態に戻すことで、他のプロセスへの影響を避けるように配慮しています。このようにumask関数を利用することで、システムエンジニアはファイルやディレクトリのセキュリティ設定をプログラムから細かく制御できます。