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

Copy
1<?php
2
3/**
4 * PHP openssl_get_privatekey 関数の使用例です。
5 * この関数は、PEM形式の秘密鍵文字列や秘密鍵ファイルパスから
6 * OpenSSLAsymmetricKey オブジェクトを生成します。
7 * システムエンジニアを目指す初心者向けに、鍵の生成から読み込みまでの一連の流れを示します。
8 */
9function exampleOpensslGetPrivateKey(): void
10{
11    echo "--- PHP openssl_get_privatekey の使用例 ---" . PHP_EOL;
12
13    // 1. 新しい秘密鍵と公開鍵のペアを生成します。
14    // openssl_pkey_new() は、OpenSSL 拡張機能が扱う鍵リソースを返します。
15    // ここではRSA 2048ビットの鍵を生成する設定を使用します。
16    $config = [
17        "digest_alg" => "sha512",
18        "private_key_bits" => 2048,
19        "private_key_type" => OPENSSL_KEYTYPE_RSA,
20    ];
21
22    $privateKeyResource = openssl_pkey_new($config);
23
24    if ($privateKeyResource === false) {
25        echo "エラー: 秘密鍵の生成に失敗しました。" . PHP_EOL;
26        // openssl_error_string() は、OpenSSLライブラリのエラーメッセージを返します。
27        echo "詳細: " . openssl_error_string() . PHP_EOL;
28        return;
29    }
30
31    echo "ステップ1: 新しい秘密鍵が生成されました。" . PHP_EOL;
32
33    // 2. 生成した秘密鍵をPEM形式の文字列として取得します。
34    // openssl_pkey_export() は、鍵リソースから秘密鍵を標準的なPEM形式の文字列としてエクスポートします。
35    // 第2引数 ($privateKeyPem) には、エクスポートされた秘密鍵の内容が格納されます。
36    // 第3引数 ($passphrase) はオプションで、秘密鍵を暗号化するためのパスフレーズを指定できます。
37    // 今回はパスフレーズなしでエクスポートします。
38    $privateKeyPem = '';
39    if (!openssl_pkey_export($privateKeyResource, $privateKeyPem)) {
40        echo "エラー: 秘密鍵のPEM形式へのエクスポートに失敗しました。" . PHP_EOL;
41        echo "詳細: " . openssl_error_string() . PHP_EOL;
42        // 生成した鍵リソースを解放します。
43        openssl_pkey_free($privateKeyResource);
44        return;
45    }
46
47    echo "ステップ2: 秘密鍵がPEM形式の文字列として取得されました。" . PHP_EOL;
48    // セキュリティ上の理由から、通常は秘密鍵の内容を直接表示しません。
49    // echo "--- 秘密鍵 (PEM形式の一部) ---" . PHP_EOL;
50    // echo substr($privateKeyPem, 0, 100) . "..." . PHP_EOL; // 例として先頭の一部のみ表示
51    // echo "-----------------------------" . PHP_EOL;
52
53    // 3. openssl_get_privatekey() を使用して、PEM形式の秘密鍵文字列から
54    // OpenSSLAsymmetricKey オブジェクトを読み込みます。
55    // このオブジェクトは、暗号化、復号、署名の生成・検証などのOpenSSL操作に使用できます。
56    // 最初の引数にはPEM形式の鍵文字列または鍵ファイルパスを渡します。
57    // 第2引数 ($passphrase) は、秘密鍵がパスフレーズで保護されている場合にそのパスフレーズを指定します。
58    $loadedPrivateKey = openssl_get_privatekey($privateKeyPem);
59
60    if ($loadedPrivateKey instanceof OpenSSLAsymmetricKey) {
61        echo "ステップ3: openssl_get_privatekey() で秘密鍵が正常に読み込まれました。" . PHP_EOL;
62
63        // 読み込んだ秘密鍵の情報を取得して表示する (オプション)
64        // openssl_pkey_get_details() は、鍵の詳細情報を含む配列を返します。
65        $details = openssl_pkey_get_details($loadedPrivateKey);
66        if ($details !== false) {
67            echo "  - 鍵のタイプ: " . ($details['type'] === OPENSSL_KEYTYPE_RSA ? 'RSA' : '不明') . PHP_EOL;
68            echo "  - ビット数: " . $details['bits'] . PHP_EOL;
69            // RSA鍵の場合は、公開鍵のPEM形式の内容なども含まれます。
70            // echo "  - 公開鍵 (PEM形式の一部): " . substr($details['key'], 0, 100) . "..." . PHP_EOL;
71        } else {
72            echo "  注意: 読み込んだ秘密鍵の詳細を取得できませんでした。" . PHP_EOL;
73        }
74
75        // 読み込んだOpenSSLAsymmetricKeyオブジェクトは、スクリプト終了時に自動的に解放されますが、
76        // 必要に応じてopenssl_pkey_free()で明示的に解放することも可能です。
77        // openssl_pkey_free($loadedPrivateKey);
78
79    } else {
80        echo "ステップ3: エラー: openssl_get_privatekey() で秘密鍵の読み込みに失敗しました。" . PHP_EOL;
81        echo "詳細: " . openssl_error_string() . PHP_EOL;
82    }
83
84    // 最初に生成した鍵リソースも解放します。
85    openssl_pkey_free($privateKeyResource);
86    echo "--- 使用例終了 ---" . PHP_EOL;
87}
88
89// 関数を実行して、openssl_get_privatekey の動作を確認します。
90exampleOpensslGetPrivateKey();
91
92?>

openssl_get_privatekey関数は、PEM形式で記述された秘密鍵の文字列、または秘密鍵が保存されているファイルパスから、OpenSSLAsymmetricKeyオブジェクトを生成するPHPの機能です。このオブジェクトは、暗号化、復号、デジタル署名の作成や検証など、OpenSSL関連のセキュリティ操作に利用できます。

最初の引数$private_keyには、読み込みたい秘密鍵のPEM形式文字列またはそのファイルパスを指定します。秘密鍵がパスフレーズで保護されている場合は、2番目の引数$passphraseにそのパスフレーズを渡します。保護されていない場合はこの引数を省略できます。関数が成功すると、読み込まれた秘密鍵を表すOpenSSLAsymmetricKeyオブジェクトが返されます。失敗した場合はfalseが返され、その際にはopenssl_error_string()で詳細なエラー情報を確認できます。

サンプルコードでは、まずopenssl_pkey_new()で新しい秘密鍵を生成し、次にopenssl_pkey_export()でその鍵をPEM形式の文字列として取得しています。そして、取得したPEM文字列を本関数openssl_get_privatekey()に渡すことで、秘密鍵をOpenSSLAsymmetricKeyオブジェクトとして安全に読み込む一連の流れを示しています。これにより、生成または取得した秘密鍵をPHPプログラム内で利用可能な形式に変換する方法を理解できます。

Copy
1<?php
2
3/**
4 * OpenSSLキーペアを生成し、秘密鍵をロードして公開鍵情報を表示するサンプル関数。
5 * システムエンジニアを目指す初心者向けに、簡潔さと正確さを重視しています。
6 *
7 * この関数は、Openssl拡張機能を使ってRSAキーペアを生成し、
8 * openssl_get_privatekey() で秘密鍵を読み込み、そこから関連する公開鍵の情報を抽出します。
9 * キーワードの openssl_pkey_get_public (openssl_get_publickey のエイリアス) に関連して、
10 * 秘密鍵から抽出した公開鍵が正常にロードできることも示します。
11 */
12function exampleOpensslPrivateKeyAndPublicKey(): void
13{
14    echo "--- OpenSSL キーペア生成とロードの例 ---\n";
15
16    // 1. 一時的な秘密鍵ファイルパスを設定
17    // この例では、システムの一時ディレクトリにファイルを保存します。
18    $privateKeyPath = sys_get_temp_dir() . '/temp_private_key.pem';
19
20    // 2. RSAキーペアを生成するための設定
21    // 2048ビットのRSAキーを生成し、SHA512ダイジェストアルゴリズムを使用します。
22    $config = [
23        "digest_alg"       => "sha512",
24        "private_key_bits" => 2048,
25        "private_key_type" => OPENSSL_KEYTYPE_RSA,
26    ];
27
28    // openssl_pkey_new() で新しいキーペアリソースを生成します。
29    $privateKeyResource = openssl_pkey_new($config);
30
31    if ($privateKeyResource === false) {
32        echo "エラー: キーペアの生成に失敗しました。\n";
33        // エラー詳細を取得する場合
34        while ($msg = openssl_error_string()) {
35            echo "OpenSSL エラー: " . $msg . "\n";
36        }
37        return;
38    }
39    echo "新しいキーペアを生成しました。\n";
40
41    // 3. 生成した秘密鍵をPEM形式の文字列としてエクスポートし、ファイルに保存
42    // 第3引数に null を渡すことで、パスフレーズなしの秘密鍵が生成されます。
43    if (!openssl_pkey_export($privateKeyResource, $privateKeyString, null, $config)) {
44        echo "エラー: 秘密鍵のエクスポートに失敗しました。\n";
45        openssl_free_key($privateKeyResource); // リソースを解放
46        return;
47    }
48
49    // 秘密鍵文字列を一時ファイルに保存します。
50    if (file_put_contents($privateKeyPath, $privateKeyString) === false) {
51        echo "エラー: 秘密鍵ファイルの保存に失敗しました: {$privateKeyPath}\n";
52        openssl_free_key($privateKeyResource);
53        return;
54    }
55    echo "秘密鍵をファイルに保存しました: {$privateKeyPath}\n";
56
57    // 4. openssl_get_privatekey() を使って秘密鍵ファイルをロード
58    // この関数は、秘密鍵のファイルパスまたは鍵文字列を引数に取ります。
59    // 成功すると OpenSSLAsymmetricKey オブジェクトを返します。
60    $loadedPrivateKey = openssl_get_privatekey($privateKeyPath);
61
62    if ($loadedPrivateKey === false) {
63        echo "エラー: 秘密鍵のロードに失敗しました (ファイル: {$privateKeyPath})\n";
64        // エラー詳細を取得する場合
65        while ($msg = openssl_error_string()) {
66            echo "OpenSSL エラー: " . $msg . "\n";
67        }
68        // 生成した一時ファイルをクリーンアップ
69        @unlink($privateKeyPath);
70        return;
71    }
72    echo "秘密鍵を正常にロードしました。\n";
73
74    // 5. ロードした秘密鍵リソースから公開鍵情報を抽出
75    // openssl_pkey_get_details() は、鍵の詳細（公開鍵部分を含む）を配列で返します。
76    $details = openssl_pkey_get_details($loadedPrivateKey);
77
78    if ($details === false || !isset($details['key'])) {
79        echo "エラー: 秘密鍵から公開鍵情報を取得できませんでした。\n";
80        openssl_free_key($loadedPrivateKey); // リソースを解放
81        @unlink($privateKeyPath);
82        return;
83    }
84
85    $publicKeyString = $details['key']; // これが公開鍵のPEM形式文字列です。
86
87    echo "\n--- 抽出された公開鍵 ---\n";
88    echo $publicKeyString;
89    echo "------------------------\n";
90
91    // 6. キーワードに関連する openssl_get_publickey() を使って公開鍵をロードしてみる
92    // openssl_get_publickey() は、公開鍵文字列またはファイルパスから公開鍵リソースを取得します。
93    $loadedPublicKey = openssl_get_publickey($publicKeyString);
94
95    if ($loadedPublicKey === false) {
96        echo "エラー: 公開鍵のロードに失敗しました (openssl_get_publickey)。\n";
97    } else {
98        echo "公開鍵も 'openssl_get_publickey' でロードできました。\n";
99        openssl_free_key($loadedPublicKey); // 公開鍵リソースを解放
100    }
101
102    // 7. 使用したOpenSSLリソースを解放
103    openssl_free_key($privateKeyResource); // 最初生成したリソースを解放
104    openssl_free_key($loadedPrivateKey);   // ロードしたリソースを解放
105
106    // 8. 生成した一時ファイルをクリーンアップ
107    @unlink($privateKeyPath);
108    echo "一時ファイルをクリーンアップしました: {$privateKeyPath}\n";
109
110    echo "\n--- サンプル実行が完了しました ---\n";
111}
112
113// 関数の実行
114exampleOpensslPrivateKeyAndPublicKey();

このサンプルコードは、PHPのOpenSSL拡張機能を使用し、秘密鍵と公開鍵の生成、保存、ロードの一連の流れをシステムエンジニアを目指す初心者向けに解説しています。特に、openssl_get_privatekey関数による秘密鍵の読み込みに焦点を当てています。

まず、openssl_pkey_newで新しいRSAキーペアを生成し、その秘密鍵をPEM形式で一時ファイルに保存します。その後、openssl_get_privatekeyを呼び出し、このファイルのパスまたは秘密鍵の文字列を引数として渡すことで、秘密鍵をメモリにロードします。この関数は、秘密鍵のロードに成功するとOpenSSLAsymmetricKeyオブジェクトを返し、失敗した場合はfalseを返します。

ロードされた秘密鍵からはopenssl_pkey_get_detailsを用いて公開鍵情報を抽出でき、さらにキーワードのopenssl_pkey_get_public（openssl_get_publickeyのエイリアス）でその公開鍵も問題なくロードできることを確認しています。この一連のプロセスを通じて、秘密鍵と公開鍵の連携や、OpenSSLAsymmetricKeyオブジェクトの利用方法を理解できます。使用されたOpenSSLリソースは適切に解放され、生成された一時ファイルも安全に削除されるため、リソース管理の基本的な考え方も示されています。