【PHP8.x】Phar::SHA1定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたファイルのSHA-1ハッシュを計算して表示します。
5 * システムエンジニアを目指す初心者が、ファイルの整合性チェックなどの用途で
6 * ハッシュ値を利用する基本的な方法を理解するのに役立ちます。
7 *
8 * @param string $filePath ハッシュを計算するファイルのパス
9 * @return void
10 */
11function displayFileSha1Hash(string $filePath): void
12{
13    // ファイルが存在するか確認します。
14    // ファイルがない場合はエラーメッセージを表示して処理を終了します。
15    if (!file_exists($filePath)) {
16        echo "エラー: ファイル '{$filePath}' が見つかりません。\n";
17        return;
18    }
19
20    // sha1_file関数を使用してファイルのSHA-1ハッシュを計算します。
21    // この関数は、指定されたファイルの内容全体からSHA-1ハッシュ値を計算し、
22    // 成功した場合は32文字の16進数文字列を返します。失敗した場合は false を返します。
23    $sha1Hash = sha1_file($filePath);
24
25    // ハッシュ計算が失敗した場合の処理です。
26    if ($sha1Hash === false) {
27        echo "エラー: ファイル '{$filePath}' のSHA-1ハッシュを計算できませんでした。\n";
28        return;
29    }
30
31    // 計算されたファイルのパスとSHA-1ハッシュ値を表示します。
32    echo "ファイル: {$filePath}\n";
33    echo "SHA-1ハッシュ: {$sha1Hash}\n";
34}
35
36// -----------------------------------------------------------------
37// サンプル使用例:
38// このコードブロックは、displayFileSha1Hash関数の動作を示すためのものです。
39// -----------------------------------------------------------------
40
41// 一時的なファイルを作成します。
42// このファイルの内容のハッシュを計算します。
43$tempFileName = 'sample_file_for_sha1.txt';
44$fileContent = "これはSHA-1ハッシュ計算のサンプルファイルです。\n";
45$fileContent .= "ファイルの内容が少しでも変わると、ハッシュ値も変わります。\n";
46file_put_contents($tempFileName, $fileContent);
47
48// 作成したファイルのSHA-1ハッシュを表示します。
49displayFileSha1Hash($tempFileName);
50
51// サンプルファイルを削除してクリーンアップします。
52if (file_exists($tempFileName)) {
53    unlink($tempFileName);
54}
55
56?>

このPHPのサンプルコードは、sha1_file関数を使用して、指定されたファイルのSHA-1ハッシュ値を計算し表示する基本的な方法を示しています。SHA-1ハッシュは、ファイルの改ざん検出や整合性チェックなど、システムエンジニアにとって重要な用途で利用される値です。

コードの中心であるdisplayFileSha1Hash関数は、引数としてハッシュを計算したいファイルのパス（$filePath）を受け取ります。この関数は、まずfile_exists関数で指定されたファイルが存在するかを確認し、存在しない場合はエラーメッセージを表示して処理を終了します。

次に、sha1_file関数が呼び出され、ファイルの内容全体からSHA-1ハッシュ値が計算されます。この関数は、計算に成功すると32文字の16進数文字列を戻り値として返し、失敗した場合はfalseを返します。関数は、戻り値がfalseの場合もエラーメッセージを表示し、初心者にも分かりやすいエラーハンドリングの実践例を提供しています。

最終的に、計算されたファイルのパスとSHA-1ハッシュ値が表示されます。この一連の処理を通じて、ファイルの内容が少しでも変更されるとハッシュ値も変化するという特性を理解し、ファイルの信頼性を確認する際の基礎知識を習得できます。

Copy
1<?php
2
3/**
4 * Pharアーカイブを作成し、Phar::SHA1を使用して署名アルゴリズムを設定するサンプル。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * プログラミング言語リファレンス情報で指定された定数 (Phar::SHA1) が
8 * どのように使われるかを示します。
9 *
10 * Pharアーカイブは、複数のPHPファイルを単一の圧縮されたアーカイブにまとめ、
11 * プロジェクトの配布やデプロイを容易にするための仕組みです。
12 * アーカイブの整合性（データが改ざんされていないこと）を保証するために、
13 * 署名（シグネチャ）が使用されます。
14 *
15 * 注意: Pharアーカイブを作成するには、PHPの設定 'phar.readonly' が 'Off' である必要があります。
16 *       開発環境ではこの設定が 'Off' になっていることが多いですが、
17 *       セキュリティ上の理由から、本番環境では 'On' になっていることがあります。
18 *       必要に応じて php.ini ファイルを編集するか、
19 *       スクリプトの先頭で 'ini_set('phar.readonly', '0');' を試すことができますが、
20 *       この設定はサーバーのポリシーによっては許可されない場合があります。
21 */
22function createPharWithSha1Signature(): void
23{
24    // 1. Pharアーカイブのファイルパスと、アーカイブに含めるソースファイルのディレクトリを定義
25    $pharFilePath = __DIR__ . '/my_application.phar';
26    $sourceDir = __DIR__ . '/temp_source_files';
27
28    // 2. 以前の実行で作成されたファイルがあれば削除し、クリーンな状態にする
29    if (file_exists($pharFilePath)) {
30        unlink($pharFilePath);
31    }
32    if (is_dir($sourceDir)) {
33        // ディレクトリ内のファイルを削除してからディレクトリを削除
34        array_map('unlink', glob("$sourceDir/*.*"));
35        rmdir($sourceDir);
36    }
37    // ソースファイル用の一時ディレクトリを作成
38    mkdir($sourceDir);
39
40    // 3. アーカイブに含めるダミーのPHPファイルとテキストファイルを作成
41    file_put_contents($sourceDir . '/index.php', '<?php echo "Hello from inside the Phar archive (SHA1 signed)!";');
42    file_put_contents($sourceDir . '/config.txt', 'application_version=1.0');
43
44    echo "Pharアーカイブの作成を開始します...\n";
45
46    try {
47        // 4. 新しいPharアーカイブオブジェクトを作成
48        //    引数: 作成するPharファイルのパス
49        $phar = new Phar($pharFilePath);
50
51        // 5. Pharアーカイブを書き込み可能モードにする (ファイルの追加や設定変更のため)
52        $phar->startBuffering();
53
54        // 6. 指定されたディレクトリから、特定のパターンにマッチするファイルをPharアーカイブに追加
55        //    第1引数: ソースディレクトリのパス
56        //    第2引数: 含めるファイル名の正規表現パターン (ここでは .php と .txt ファイル)
57        $phar->buildFromDirectory($sourceDir, '/\.(php|txt)$/');
58
59        // 7. リファレンス情報で指定された Phar::SHA1 定数を使用し、
60        //    Pharアーカイブの署名アルゴリズムをSHA1に設定します。
61        //    SHA1は、アーカイブが作成されてから変更されていないことを確認するためのハッシュアルゴリズムです。
62        $phar->setSignatureAlgorithm(Phar::SHA1);
63        echo "Pharアーカイブの署名アルゴリズムを Phar::SHA1 に設定しました。\n";
64
65        // 8. Pharファイルが実行されたときに最初に実行されるスタブを設定
66        //    ここでは、index.php をエントリポイントとするデフォルトのスタブを使用します。
67        $phar->setStub($phar->createDefaultStub('index.php'));
68
69        // 9. Pharアーカイブの作成を完了し、書き込みモードを終了
70        //    これにより、アーカイブが物理ファイルとしてディスクに書き込まれます。
71        $phar->stopBuffering();
72
73        echo "Pharアーカイブが成功裏に作成されました: {$pharFilePath}\n";
74        echo "このアーカイブは、コマンドラインで 'php {$pharFilePath}' と入力して実行できます。\n";
75
76    } catch (PharException $e) {
77        // Phar関連のエラー（例: phar.readonlyがOnの場合など）が発生した場合
78        echo "Pharアーカイブの作成中にエラーが発生しました: " . $e->getMessage() . "\n";
79        echo "ヒント: PHP設定 'phar.readonly = Off' が有効になっているか確認してください。\n";
80    } catch (Exception $e) {
81        // その他の予期せぬエラーが発生した場合
82        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
83    } finally {
84        // 10. 使用した一時ファイルとディレクトリをクリーンアップ
85        if (file_exists($sourceDir . '/index.php')) {
86            unlink($sourceDir . '/index.php');
87        }
88        if (file_exists($sourceDir . '/config.txt')) {
89            unlink($sourceDir . '/config.txt');
90        }
91        if (is_dir($sourceDir)) {
92            rmdir($sourceDir);
93        }
94        echo "一時ファイルをクリーンアップしました。\n";
95    }
96}
97
98// 関数を実行してPharアーカイブを作成します
99createPharWithSha1Signature();

このサンプルコードは、PHPのPhar拡張機能で使用される定数「Phar::SHA1」の使い方を、システムエンジニアを目指す初心者の方にもわかりやすく解説します。Pharアーカイブとは、複数のPHPファイルを一つの自己完結型パッケージにまとめ、アプリケーションの配布やデプロイを効率化するための仕組みです。

Phar::SHA1は、Pharアーカイブのデータが改ざんされていないかを確認するための「署名アルゴリズム」として、SHA1ハッシュ関数を指定する定数です。署名を設定することで、アーカイブの整合性が保証されます。この定数自体は引数を取らず、特定の戻り値も持ちません。

サンプルコードでは、まず一時的なPHPファイルやテキストファイルを用意し、これらをまとめた「my_application.phar」というPharアーカイブを作成します。そして、$phar->setSignatureAlgorithm(Phar::SHA1); の部分で、Phar::SHA1定数を使用してアーカイブの署名アルゴリズムをSHA1に設定しています。これにより、作成されたPharアーカイブはSHA1アルゴリズムで署名され、その内容が保護されます。Pharアーカイブの作成には、PHPの設定「phar.readonly」が「Off」になっている必要がありますのでご注意ください。