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

Copy
1<?php
2
3/**
4 * Pharアーカイブを生成し、署名アルゴリズムを設定するサンプル関数。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * Phar::setSignatureAlgorithm メソッドの基本的な使い方を示します。
8 * Pharアーカイブは、複数のPHPファイルを単一のアーカイブにまとめ、
9 * 署名によってその完全性を保証できます。
10 */
11function createSignedPharExample(): void
12{
13    // 生成するPharアーカイブのファイル名
14    $pharFileName = 'my_signed_app.phar';
15    // Pharアーカイブに含めるための一時的なPHPファイル
16    $tempFileName = 'hello.php';
17    $tempFileContent = '<?php echo "Hello from signed Phar application!";';
18
19    /**
20     * 後処理（クリーンアップ）を行う無名関数。
21     * 関数終了時に作成したファイルやアーカイブを削除します。
22     */
23    $cleanup = function () use ($pharFileName, $tempFileName) {
24        if (file_exists($pharFileName)) {
25            // Phar::unlinkArchive() は、Pharアーカイブとその関連ファイル（署名ファイルなど）を削除します。
26            Phar::unlinkArchive($pharFileName);
27        }
28        if (file_exists($tempFileName)) {
29            unlink($tempFileName);
30        }
31        echo "クリーンアップが完了しました。\n";
32    };
33
34    try {
35        // 既存のPharアーカイブが残っている場合は削除します。
36        // これにより、新しいPharアーカイブを確実に作成できます。
37        if (file_exists($pharFileName)) {
38            Phar::unlinkArchive($pharFileName);
39        }
40
41        // Pharアーカイブに含めるための一時的なPHPファイルを作成します。
42        file_put_contents($tempFileName, $tempFileContent);
43
44        // 新しいPharアーカイブを作成します。
45        // 第一引数: アーカイブのファイルパス
46        $phar = new Phar($pharFileName);
47
48        // Pharアーカイブへの複数の変更を効率的に行うためにバッファリングを開始します。
49        // これにより、変更が一度にファイルに書き込まれます。
50        $phar->startBuffering();
51
52        // 一時ファイルをPharアーカイブに追加します。
53        // 第一引数: ローカルファイルへのパス
54        // 第二引数: Pharアーカイブ内部でのファイルのパス (例: 'app/main.php')
55        $phar->addFile($tempFileName, 'app/main.php');
56
57        // Pharアーカイブのスタブを設定します。
58        // スタブは、PharファイルをPHPスクリプトとして実行可能にするためのコードです。
59        // ここでは、Phar内部の 'app/main.php' を実行するデフォルトスタブを作成します。
60        $phar->setStub($phar->createDefaultStub('app/main.php'));
61
62        // 署名アルゴリズムをSHA256に設定します。
63        // Phar::setSignatureAlgorithm() は、Pharアーカイブの完全性を検証するための
64        // 署名に使用するハッシュアルゴリズムを指定します。
65        // SHA256は広く使われているセキュアなハッシュアルゴリズムの一つです。
66        // Phar::MD5, Phar::SHA1, Phar::SHA256, Phar::SHA512 など、
67        // 秘密鍵を必要としないハッシュベースのアルゴリズムがあります。
68        // Phar::OPENSSL を使用する場合は、RSAなどの秘密鍵が必要となりますが、
69        // この初心者向けのシンプルな例ではハッシュアルゴリズムを使用します。
70        $phar->setSignatureAlgorithm(Phar::SHA256);
71
72        // バッファリングを終了し、Pharアーカイブへのすべての変更を書き込みます。
73        $phar->stopBuffering();
74
75        echo "Pharアーカイブ '{$pharFileName}' がSHA256署名アルゴリズムで作成されました。\n";
76        echo "このPharアーカイブは、コマンドラインで 'php {$pharFileName}' と実行できます。\n";
77
78    } catch (Exception $e) {
79        // エラーが発生した場合は、そのメッセージを表示します。
80        echo "エラーが発生しました: " . $e->getMessage() . "\n";
81    } finally {
82        // 例外が発生したかどうかにかかわらず、必ずクリーンアップ処理を実行します。
83        $cleanup();
84    }
85}
86
87// サンプル関数を実行します。
88createSignedPharExample();

Phar::setSignatureAlgorithmメソッドは、Pharアーカイブの完全性を保証するための署名アルゴリズムを設定し、アーカイブの改ざん検知を可能にします。

引数$algoには、署名に用いるアルゴリズムをPhar::SHA256のような整数定数で指定します。サンプルコードではセキュアなハッシュアルゴリズムであるPhar::SHA256を使用しています。SHA256のようなハッシュベースの署名では秘密鍵が不要なため、第二引数$privateKeyはnullとします。

このメソッドに特定の戻り値はありませんが、Pharオブジェクトの署名設定が直接変更されます。サンプルコードでは、PHPファイルを含んだPharアーカイブを作成し、本メソッドでPhar::SHA256署名を適用することで、アーカイブの信頼性を高め、安全な配布に役立てています。

Copy
1<?php
2// このサンプルコードは、PHPのphar拡張モジュールが有効で、
3// php.ini設定で 'phar.readonly = Off' であることを想定しています。
4
5// Pharアーカイブのファイル名と、アーカイブに含めるソースファイルを一時的に格納するディレクトリを定義します。
6$pharFileName = 'my_application.phar';
7$tempSourceDir = __DIR__ . '/temp_app_source';
8
9/**
10 * サンプルコード実行前後のクリーンアップを行います。
11 * 既存のPharファイルや一時ディレクトリがあれば削除し、クリーンな状態を保ちます。
12 *
13 * @param string $pharPath 生成されたPharファイルのパス。
14 * @param string $dirPath 一時ソースファイルのディレクトリパス。
15 */
16function cleanup(string $pharPath, string $dirPath): void
17{
18    // 既存のPharファイルを削除
19    if (file_exists($pharPath)) {
20        unlink($pharPath);
21        echo "Cleaned up existing Phar file: {$pharPath}\n";
22    }
23    // 一時ディレクトリを削除
24    if (is_dir($dirPath)) {
25        $files = new RecursiveIteratorIterator(
26            new RecursiveDirectoryIterator($dirPath, RecursiveDirectoryIterator::SKIP_DOTS),
27            RecursiveIteratorIterator::CHILD_FIRST
28        );
29        foreach ($files as $fileInfo) {
30            if ($fileInfo->isDir()) {
31                rmdir($fileInfo->getRealPath());
32            } else {
33                unlink($fileInfo->getRealPath());
34            }
35        }
36        rmdir($dirPath);
37        echo "Cleaned up temporary directory: {$dirPath}\n";
38    }
39}
40
41// スクリプト開始時に以前の実行で残ったファイルをクリーンアップします。
42cleanup($pharFileName, $tempSourceDir);
43
44try {
45    // 1. Pharアーカイブに含めるための一時ファイル群を作成します。
46    // これらのファイルが最終的に'.phar'ファイルにパッケージ化されます。
47    mkdir($tempSourceDir, 0777, true);
48    file_put_contents("{$tempSourceDir}/index.php", "<?php echo 'Hello from the Phar application!';");
49    file_put_contents("{$tempSourceDir}/config.php", "<?php define('APP_VERSION', '1.0.0');");
50    echo "Created temporary source files in '{$tempSourceDir}'.\n";
51
52    // 2. 新しいPharアーカイブを作成します。
53    // 'w' モードでオープンすることで、指定した名前で新しいPharファイルを作成または上書きします。
54    $phar = new Phar($pharFileName, 0, $pharFileName);
55
56    // 3. Pharアーカイブの署名アルゴリズムを設定します。
57    // Phar::setSignatureAlgorithm() メソッドは、アーカイブの整合性を検証するための
58    // ハッシュアルゴリズムを指定します。これはPharアーカイブの「オプション」の一つと考えることができます。
59    // ここではSHA256を使用していますが、Phar::MD5, Phar::SHA1, Phar::SHA512なども選択可能です。
60    // セキュリティ上の理由から、Phar::SHA256またはPhar::SHA512の使用が推奨されます。
61    // PGP署名を使用する場合は、第2引数に秘密鍵のパスを指定します。
62    $phar->setSignatureAlgorithm(Phar::SHA256);
63    echo "Phar signature algorithm set to SHA256.\n";
64
65    // 4. 一時ディレクトリ内の全てのファイルをPharアーカイブに追加します。
66    $phar->buildFromDirectory($tempSourceDir);
67    echo "Added files from '{$tempSourceDir}' to the Phar archive.\n";
68
69    // 5. Pharアーカイブのスタブ（起動スクリプト）を設定します。
70    // これにより、Pharファイルを直接PHPインタープリタで実行したときに、
71    // 指定したファイル（ここではindex.php）が最初に実行されるようになります。
72    $phar->setStub($phar->createDefaultStub('index.php'));
73    echo "Set default stub for '{$pharFileName}'.\n";
74
75    echo "Phar archive '{$pharFileName}' created successfully with a SHA256 signature.\n";
76
77    // 作成したPharアーカイブの署名情報を確認します。
78    $createdPhar = new Phar($pharFileName);
79    $signature = $createdPhar->getSignature();
80    if ($signature && isset($signature['hash_type'])) {
81        echo "Verifying signature type of '{$pharFileName}': " . Phar::getSignatureName($signature['hash_type']) . "\n";
82    } else {
83        echo "Could not verify signature type for '{$pharFileName}'.\n";
84    }
85
86} catch (PharException $e) {
87    // Phar関連の例外（例: phar.readonlyがOnの場合など）を捕捉し、エラーメッセージを表示します。
88    echo "Phar Error: " . $e->getMessage() . "\n";
89} catch (Exception $e) {
90    // その他の一般的な例外を捕捉し、エラーメッセージを表示します。
91    echo "General Error: " . $e->getMessage() . "\n";
92} finally {
93    // 最終的に、一時的に作成したファイルとディレクトリを削除してクリーンアップします。
94    cleanup($pharFileName, $tempSourceDir);
95    echo "Cleanup complete.\n";
96}

PHPのPhar::setSignatureAlgorithmメソッドは、Pharアーカイブファイルの「署名アルゴリズム」を設定するために使用されます。Pharファイルは複数のPHPファイルを一つにまとめ、配布や実行を容易にするアーカイブ形式ですが、この署名機能はファイルの改ざん検知や信頼性の確保に非常に役立ちます。

このメソッドは2つの引数を取ります。最初の引数$algoは、使用する署名アルゴリズムを整数値で指定します。例えば、Phar::SHA256のような定数を使用し、これによりPharファイルの整合性を検証する際のハッシュ計算方法が決定されます。セキュリティ上の理由から、SHA256やSHA512の使用が推奨されます。2番目の引数$privateKeyはオプションで、PGP署名のような高度な署名を利用する場合に秘密鍵のファイルパスを指定しますが、通常は省略可能です。このメソッドは、処理が成功した場合に戻り値を返しません。

サンプルコードでは、$phar->setSignatureAlgorithm(Phar::SHA256);という行で、作成するmy_application.pharファイルにSHA256アルゴリズムで署名を付与する設定を行っています。これはPharアーカイブ作成時における重要なオプション設定の一つであり、作成されたPharファイルが意図せず変更されていないかを確認するために利用されます。Pharアーカイブは単一ファイルとして配布・実行されることが多いため、その信頼性を保証する上で署名アルゴリズムの設定は非常に重要です。