【PHP8.x】Phar::getSignature()メソッドの使い方

Copy
1<?php
2
3// 注意: このスクリプトを実行するには、php.ini で 'phar.readonly = Off' に設定する必要があります。
4// 例: php -d phar.readonly=0 your_script.php
5// また、Phar::setSignatureAlgorithm() を使用するためには、PHPのopenssl拡張が有効になっている必要があります。
6
7// 一時的なPharファイル名を定義します。
8$pharFileName = 'example_archive.phar';
9$pharFilePath = __DIR__ . DIRECTORY_SEPARATOR . $pharFileName;
10
11try {
12    // 1. 新しいPharアーカイブを作成します。
13    // 第1引数: 作成するPharファイルのパス
14    // 第2引数: フラグ (ここでは 0 で特に指定なし)
15    // 第3引数: Pharアーカイブが使用される際に識別されるエイリアス
16    $phar = new Phar($pharFilePath, 0, $pharFileName);
17
18    // バッファリングを開始し、ファイルの追加処理を効率化します。
19    $phar->startBuffering();
20
21    // 2. アーカイブに簡単なテストファイルを追加します。
22    $fileContent = '<?php echo "Hello from inside the Phar archive!";';
23    $phar->addFromString('index.php', $fileContent);
24
25    // 3. 署名アルゴリズムを設定します。
26    // これにより、Pharアーカイブに署名が生成されます。
27    // 利用可能なアルゴリズム: Phar::MD5, Phar::SHA1, Phar::SHA256, Phar::SHA512
28    $phar->setSignatureAlgorithm(Phar::SHA256);
29
30    // 4. バッファリングを終了し、実際にファイルシステムにPharアーカイブを書き込みます。
31    $phar->stopBuffering();
32
33    // Pharオブジェクトを解放し、ファイルが完全に閉じられるようにします。
34    unset($phar);
35
36    echo "Pharアーカイブ '{$pharFileName}' が正常に作成されました。\n\n";
37
38    // 5. 作成されたPharアーカイブを読み込み、署名情報を取得します。
39    // 読み込み専用でPharアーカイブを開きます。
40    $phar = new Phar($pharFilePath);
41
42    echo "Phar::getSignature() メソッドの実行結果:\n";
43    $signature = $phar->getSignature();
44
45    if ($signature !== false) {
46        echo "署名情報が取得されました:\n";
47        // 取得された署名情報は連想配列として返されます。
48        // 主に 'hash_type' (署名アルゴリズム) と 'hash' (署名データ) を含みます。
49        print_r($signature);
50    } else {
51        echo "署名情報が取得できませんでした。Pharファイルに署名がないか、問題が発生しました。\n";
52    }
53
54} catch (PharException $e) {
55    // Phar固有のエラーをキャッチします。
56    echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
57    if (str_contains($e->getMessage(), 'phar.readonly')) {
58        echo "php.ini の 'phar.readonly' 設定を確認してください。\n";
59    }
60} catch (Exception $e) {
61    // その他の一般的なエラーをキャッチします。
62    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
63} finally {
64    // 6. 後処理: 作成したPharファイルとその署名ファイルを削除します。
65    if (file_exists($pharFilePath)) {
66        unlink($pharFilePath);
67        echo "\nPharアーカイブ '{$pharFileName}' が削除されました。\n";
68    }
69    // 署名ファイル (.sig) も存在する場合は削除します。
70    if (file_exists($pharFilePath . '.sig')) {
71        unlink($pharFilePath . '.sig');
72        echo "署名ファイル '{$pharFileName}.sig' が削除されました。\n";
73    }
74}

Phar::getSignature()は、PHPのPharクラスに属するメソッドで、Pharアーカイブに設定されている署名情報を取得するために使用されます。Pharアーカイブとは、複数のPHPファイルを一つの圧縮ファイルにまとめることで、アプリケーションの配布や利用を容易にする形式です。このアーカイブに署名を設定することで、内容が改ざんされていないか検証でき、セキュリティを高めることが可能になります。

このメソッドには引数はなく、アーカイブに署名が正常に設定されている場合に、署名アルゴリズムの種類（例：Phar::SHA256）を示すhash_typeと、実際の署名データであるhashを含む連想配列を返します。サンプルコードでは、まずPhar::setSignatureAlgorithm()を使ってアーカイブにSHA256署名を設定し、その後にgetSignature()を呼び出すことで、設定した署名情報を確認しています。もしPharファイルに署名が設定されていない場合や、署名情報の取得に失敗した場合はfalseを返します。この機能により、配布されたPharアーカイブの完全性を検証し、安全なシステム運用の実現に貢献します。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Pharアーカイブを作成し、その署名情報を取得するサンプルコードです。
7 *
8 * システムエンジニアを目指す初心者向けに、Phar::getSignature メソッドの基本的な使い方を示します。
9 * Pharアーカイブの作成、署名アルゴリズムの設定、そして署名情報の取得といった一連の流れを体験できます。
10 *
11 * このコードを実行するには、PHP CLI環境が必要です。
12 * また、Pharアーカイブを作成するため、php.ini設定の `phar.readonly` が `Off` であるか、
13 * コード内で一時的に `Off` に変更できる環境が必要です。
14 */
15function runPharSignatureExample(): void
16{
17    // 一時的なPharアーカイブのファイル名を定義します。
18    $pharPath = __DIR__ . '/example.phar';
19
20    // Pharアーカイブに含めるための一時ディレクトリとファイルを準備します。
21    $tempDirPath = __DIR__ . '/temp_phar_contents';
22    $file1Path = $tempDirPath . '/file1.txt';
23    $file2Path = $tempDirPath . '/file2.txt';
24
25    // 現在の phar.readonly 設定を保存し、後で元に戻せるようにします。
26    $oldPharReadonlySetting = (string)ini_get('phar.readonly');
27
28    try {
29        // 1. Pharアーカイブを作成するための準備
30        // 一時ディレクトリが存在しない場合は作成します。
31        if (!is_dir($tempDirPath)) {
32            mkdir($tempDirPath);
33        }
34        // テスト用のファイルを一時ディレクトリに作成します。
35        file_put_contents($file1Path, 'This is the first file content inside the Phar archive.');
36        file_put_contents($file2Path, 'This is the second file content.');
37        echo "一時ファイルとディレクトリを準備しました。\n";
38
39        // 2. Pharアーカイブを作成
40        // Pharを作成するには、`phar.readonly` 設定を一時的に無効にする必要があります。
41        ini_set('phar.readonly', '0');
42
43        // 新しいPharオブジェクトのインスタンスを生成します。(キーワード: getinstance)
44        // ここで、指定したパスにPharアーカイブファイルが作成されます。
45        $phar = new Phar($pharPath);
46
47        // 署名アルゴリズムをSHA256に設定します。
48        // これにより、Pharアーカイブの整合性と信頼性が保証されます。(キーワード: signature)
49        $phar->setSignatureAlgorithm(Phar::SHA256);
50
51        // 作成したファイルをPharアーカイブに追加します。
52        $phar->addFile($file1Path, 'internal/file1.txt');
53        $phar->addFile($file2Path, 'internal/file2.txt');
54
55        // Pharアーカイブのスタブ（実行時に最初に実行されるコード）を設定します。
56        // これがないと、Pharアーカイブは実行可能な形式になりません。
57        $phar->setStub('<?php __HALT_COMPILER(); ?>');
58
59        echo "Pharアーカイブ '{$pharPath}' を正常に作成しました。\n";
60
61        // 3. Pharアーカイブの署名情報を取得
62        // `Phar::getSignature()` メソッドを呼び出し、アーカイブの署名情報を取得します。
63        // 戻り値は署名情報を含む配列、または取得に失敗した場合は `false` です。
64        $signature = $phar->getSignature(); // (キーワード: signature)
65
66        if ($signature !== false) {
67            echo "\nPharアーカイブの署名情報 (Phar::getSignature() の結果):\n";
68            print_r($signature); // 署名情報の詳細を表示します。
69            echo "\n署名アルゴリズム: " . ($signature['hash_type'] === Phar::SHA256 ? 'SHA256' : '不明') . "\n";
70            echo "署名ハッシュ: " . bin2hex($signature['hash']) . "\n";
71        } else {
72            echo "\nPharアーカイブの署名情報を取得できませんでした。\n";
73        }
74
75    } catch (PharException $e) {
76        // Phar操作中に発生した特定のエラーを捕捉します。
77        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
78    } catch (Exception $e) {
79        // その他の予期せぬエラーを捕捉します。
80        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
81    } finally {
82        // 4. クリーンアップ処理
83        // サンプル実行後、作成したファイルやディレクトリを削除して環境を元に戻します。
84        echo "\nクリーンアップを開始します...\n";
85
86        // 作成したPharアーカイブファイルが存在すれば削除します。
87        if (file_exists($pharPath)) {
88            unlink($pharPath);
89            echo "Pharアーカイブ '{$pharPath}' を削除しました。\n";
90        }
91
92        // 一時ディレクトリ内のファイルを削除します。
93        if (file_exists($file1Path)) {
94            unlink($file1Path);
95        }
96        if (file_exists($file2Path)) {
97            unlink($file2Path);
98        }
99        // 一時ディレクトリを削除します。
100        if (is_dir($tempDirPath)) {
101            rmdir($tempDirPath);
102            echo "一時ディレクトリ '{$tempDirPath}' を削除しました。\n";
103        }
104
105        // `phar.readonly` 設定を元の値に戻します。
106        ini_set('phar.readonly', $oldPharReadonlySetting);
107        echo "phar.readonly 設定を元の値に戻しました: {$oldPharReadonlySetting}\n";
108    }
109}
110
111// サンプルコードを実行します。
112runPharSignatureExample();

Phar::getSignature メソッドは、PHPのPharアーカイブファイルに設定された署名情報を取得するために使用されます。Pharアーカイブは、複数のPHPファイルや関連リソースを一つにまとめ、アプリケーションの配布や実行を容易にするパッケージ形式です。このメソッドは、アーカイブの信頼性と整合性を保証する重要な要素である「署名」の詳細を返します。

サンプルコードでは、まずnew Phar($pharPath)としてPharアーカイブの新しいインスタンスを生成し、アーカイブを作成する流れが示されています。この際、setSignatureAlgorithm(Phar::SHA256)を使ってアーカイブに署名アルゴリズムを設定することで、その内容が改ざんされていないことを検証できるようになります。

そして、$phar->getSignature()を呼び出すことで、このPharアーカイブに設定された署名情報を取得します。このメソッドには引数がなく、呼び出すだけで現在のアーカイブの署名データを調べることが可能です。戻り値は、署名に使用されたハッシュのタイプや実際のハッシュ値などが含まれる配列となります。もし署名情報が取得できなかった場合や、アーカイブに署名が設定されていない場合は、falseが返されます。システムエンジニアにとって、Pharアーカイブのセキュリティを確保するために、署名情報の取得と検証は重要なスキルとなります。