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

Copy
1<?php
2
3/**
4 * PharData::setSignatureAlgorithm メソッドの使用例。
5 * この関数は、PHPアプリケーションを単一ファイルとしてパッケージングするPharアーカイブの
6 * 署名アルゴリズムを設定する方法を示します。
7 * (例: setasign のようなサードパーティ製ライブラリをPharアーカイブとして配布する際に、
8 * 配布物の整合性を保証するために利用できます。)
9 */
10function demonstratePharDataSignature(): void
11{
12    // 作成するPharアーカイブのファイル名とパスを定義
13    $pharFileName = 'my_secured_app.phar';
14    $pharPath = __DIR__ . '/' . $pharFileName;
15
16    // 既存のPharアーカイブと署名ファイルを削除し、クリーンな状態で開始
17    if (file_exists($pharPath)) {
18        unlink($pharPath);
19    }
20    if (file_exists($pharPath . '.sig')) { // 署名ファイルも削除
21        unlink($pharPath . '.sig');
22    }
23
24    try {
25        // 新しいPharDataアーカイブを作成
26        // PharData クラスは、読み書き可能なPharアーカイブを扱うために使用されます。
27        $phar = new PharData($pharPath);
28
29        // Pharアーカイブに署名アルゴリズムを設定
30        // ここでは、SHA256アルゴリズムを使用しています。
31        // この設定は、アーカイブの整合性を検証するために使用され、
32        // アーカイブが改ざんされていないことを確認するのに役立ちます。
33        //
34        // 利用可能なアルゴリズム定数:
35        // Phar::MD5, Phar::SHA1, Phar::SHA256, Phar::SHA512
36        // Phar::OPENSSL (この場合、第2引数 $privateKey にプライベートキーのパスが必要)
37        // 初心者向けに、キーの管理が不要な SHA256 を選択しています。
38        $phar->setSignatureAlgorithm(Phar::SHA256);
39
40        // アーカイブにファイルを追加
41        $phar->addFromString('index.php', '<?php echo "Hello, secured Phar!";');
42        $phar->addFromString('README.md', 'This is a sample application packaged in a Phar archive.');
43
44        // Pharアーカイブのエントリポイント (デフォルトの実行ファイル) を設定 (オプション)
45        $phar->setDefaultStub('index.php');
46
47        echo "PharDataアーカイブ '{$pharFileName}' が正常に作成されました。\n";
48        echo "署名アルゴリズムは SHA256 に設定されました。\n";
49        echo "アーカイブの場所: {$pharPath}\n";
50
51        // 作成されたPharアーカイブの署名情報を取得して表示
52        $signature = $phar->getSignature();
53        if ($signature) {
54            echo "署名タイプ: " . var_export($signature['hash_type'], true) . "\n";
55            echo "署名ハッシュ (先頭10文字): " . substr($signature['hash'], 0, 10) . "...\n";
56        }
57
58    } catch (Exception $e) {
59        echo "エラーが発生しました: " . $e->getMessage() . "\n";
60        // Pharの書き込み操作には、php.ini の 'phar.readonly' が 'Off' である必要があります。
61        if (str_contains($e->getMessage(), 'write operations are not allowed')) {
62            echo "ヒント: php.ini の 'phar.readonly' 設定が 'Off' になっているか確認してください。\n";
63        }
64    }
65}
66
67// 関数を実行して、サンプルコードの動作を確認します。
68demonstratePharDataSignature();
69
70?>

PHPのPharData::setSignatureAlgorithmメソッドは、PHPアプリケーションを単一ファイルにまとめるPharアーカイブの署名アルゴリズムを設定するために使用されます。この機能は、setasignのようなライブラリをPhar形式で配布する際に、アーカイブが改ざんされていないかを確認し、その整合性を保証するために重要です。

第一引数$algoには、Phar::MD5やPhar::SHA256といった定数を指定し、利用するハッシュアルゴリズムを選択します。サンプルコードではセキュリティ強度の高いPhar::SHA256が選ばれています。第二引数$privateKeyはオプションで、Phar::OPENSSLを使用する場合に秘密鍵ファイルのパスを指定します。SHA256のようにキーの管理が不要なアルゴリズムでは、この引数を設定する必要はありません。このメソッドは、処理が成功した場合に特に戻り値を返しません。

サンプルコードは、my_secured_app.pharという新しいPharアーカイブを作成し、setSignatureAlgorithm(Phar::SHA256)を呼び出して署名アルゴリズムを設定する一連の流れを示しています。これにより、アーカイブに保存されるファイルの整合性が担保され、不正な改変を検知できるようになります。Pharアーカイブの書き込み操作を実行するには、PHPの設定ファイルphp.iniでphar.readonlyがOffに設定されている必要がありますので、ご注意ください。

Copy
1<?php
2
3// このスクリプトはPharアーカイブを作成・変更するため、
4// php.iniで 'phar.readonly = 0' が設定されている必要があります。
5// セキュリティ上の理由から、本番環境では 'phar.readonly = 1' を推奨します。
6// サンプル実行のため一時的に設定を上書きします。
7ini_set('phar.readonly', '0');
8
9/**
10 * PharDataアーカイブの署名アルゴリズムを設定するサンプルコードです。
11 *
12 * この関数は、新規にPharDataアーカイブを作成し、
13 * そのアーカイブの署名アルゴリズムをMD5に設定する手順を示します。
14 * システムエンジニアを目指す初心者の方に、Pharアーカイブの整合性を保証する
15 * 署名オプションの設定方法を簡潔に紹介します。
16 *
17 * @param string $archivePath 作成するPharDataアーカイブのファイルパス (例: 'my_data.tar')
18 */
19function demonstratePharDataSignatureSetting(string $archivePath): void
20{
21    // アーカイブのクリーンアップ関数を定義
22    $cleanup = function () use ($archivePath) {
23        if (file_exists($archivePath)) {
24            unlink($archivePath);
25            echo "クリーンアップ: {$archivePath} を削除しました。\n";
26        }
27    };
28
29    try {
30        // 新しいPharDataアーカイブを作成します。
31        // 第1引数: アーカイブのパス
32        // 第2引数: フラグ（ここでは0でデフォルト挙動）
33        // 第3引数: エイリアス（ここではnull）
34        // 第4引数: アーカイブ形式 (Phar::TAR は tar形式を示します)
35        $phar = new PharData($archivePath, 0, null, Phar::TAR);
36        echo "新しいPharDataアーカイブ '{$archivePath}' を作成しました。\n";
37
38        // アーカイブにサンプルファイルを追加します。
39        // これは setSignatureAlgorithm の機能とは直接関係ありませんが、
40        // アーカイブに内容があることを示します。
41        $phar->addFromString('message.txt', 'Hello, this is a sample message inside the archive!');
42        echo "ファイル 'message.txt' をアーカイブに追加しました。\n";
43
44        // ここが 'setSignatureAlgorithm' の使用例です。
45        // 署名アルゴリズムをMD5に設定します。
46        // Phar::MD5 はMD5ハッシュアルゴリズムを指す定数です。
47        // この設定により、アーカイブの整合性がMD5によって保証されます。
48        // MD5のような内部署名アルゴリズムは、署名情報をアーカイブファイル自体に埋め込みます。
49        // このメソッドは、Pharアーカイブの署名に関する重要な「オプション」を設定します。
50        $phar->setSignatureAlgorithm(Phar::MD5);
51        echo "アーカイブの署名アルゴリズムを MD5 に設定しました。\n";
52
53        // RSAなどの外部秘密鍵を使用する場合は、第二引数に鍵ファイルのパスを指定します。
54        // 例: $phar->setSignatureAlgorithm(Phar::SHA256, '/path/to/private.key');
55        // 今回は初心者向けにシンプルに内部アルゴリズムのみを示します。
56
57        // Pharオブジェクトは、スクリプトの終了時、またはオブジェクトが参照されなくなったときに
58        // 自動的にディスクに書き込まれます。
59        echo "アーカイブ操作が完了しました。\n";
60
61    } catch (PharException $e) {
62        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
63    } catch (Exception $e) {
64        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
65    } finally {
66        // 処理が完了したら、作成したファイルをクリーンアップします。
67        $cleanup();
68    }
69}
70
71// サンプル関数の実行
72$archiveFilename = 'my_data_archive.tar';
73demonstratePharDataSignatureSetting($archiveFilename);
74
75// 一時的に変更したphar.readonlyの設定を元に戻します。
76ini_set('phar.readonly', '1');
77

このコードは、PHPでPharアーカイブ（複数のファイルを一つにまとめる形式）を操作する際に使用するPharDataクラスのsetSignatureAlgorithmメソッドの利用方法を示しています。このメソッドは、アーカイブの整合性を保証するための「署名アルゴリズム」を設定する役割を持ちます。

第一引数$algoには、Phar::MD5のような整数値を指定し、アーカイブのハッシュ計算に使用するアルゴリズム（MD5、SHAなど）を選択します。これにより、アーカイブが作成された後に内容が改ざんされていないかを後から検証できるようになります。第二引数$privateKeyは省略可能で、RSAのような外部署名を使用する場合に、秘密鍵ファイルのパスを指定します。今回のサンプルでは内部署名を利用するため、この引数は指定していません。このメソッド自体は戻り値を持ちませんが、PharDataオブジェクトの内部設定を変更します。

サンプルコードでは、まずini_setを使ってphar.readonlyを一時的に0に設定し、Pharアーカイブの作成・変更を許可しています。その後、新しいPharDataアーカイブを作成し、setSignatureAlgorithm(Phar::MD5)を呼び出すことで、アーカイブの署名アルゴリズムをMD5に設定しています。この設定は、アーカイブの信頼性を高め、配布されるソフトウェアの整合性を保証するための重要な「オプション」となります。エラー処理と作成したアーカイブのクリーンアップも含まれています。