【PHP8.x】openssl_pkey_get_private関数の使い方

Copy
1<?php
2
3/**
4 * openssl_pkey_get_private関数の使用例。
5 * このスクリプトは、パスフレーズで保護されたPEM形式のプライベートキー文字列を読み込み、
6 * OpenSSLAsymmetricKeyオブジェクトを取得する方法を示します。
7 */
8
9// 1. サンプル用のプライベートキーを生成します。
10//    通常、プライベートキーはファイルから読み込むか、セキュアなストレージから取得します。
11//    ここでは、スクリプト実行時に一時的に生成します。
12$configArgs = [
13    "digest_alg"       => "sha256",          // ハッシュアルゴリズム
14    "private_key_bits" => 2048,              // キーのビット長
15    "private_key_type" => OPENSSL_KEYTYPE_RSA, // キータイプ（RSA）
16];
17
18// 新しいキーペアオブジェクトを生成します。
19// PHP 8.0以降ではOpenSSLAsymmetricKeyオブジェクトを返します。
20$newKeyPair = openssl_pkey_new($configArgs);
21
22if ($newKeyPair === false) {
23    die("エラー: プライベートキーの生成に失敗しました。" . PHP_EOL);
24}
25
26// プライベートキーを保護するためのパスフレーズ。
27// 実際の運用では、より複雑でセキュアなパスフレーズを使用してください。
28$passphrase = 'YourSecureAndComplexPassphraseHere';
29
30// 生成したプライベートキーをPEM形式の文字列としてエクスポートします。
31// エクスポート時にパスフレーズで保護されます。
32$privateKeyString = '';
33if (!openssl_pkey_export($newKeyPair, $privateKeyString, $passphrase)) {
34    die("エラー: プライベートキーのエクスポートに失敗しました。" . PHP_EOL);
35}
36
37echo "--- プライベートキーの読み込みを開始します ---" . PHP_EOL;
38
39// 2. openssl_pkey_get_private関数を使用して、PEM形式のプライベートキー文字列を読み込みます。
40//    第一引数にプライベートキーの文字列、第二引数にパスフレーズを渡します。
41//    成功するとOpenSSLAsymmetricKeyオブジェクトを、失敗するとfalseを返します。
42$privateKeyObject = openssl_pkey_get_private($privateKeyString, $passphrase);
43
44// 3. 処理結果を確認し、読み込みが成功した場合はキー情報を表示します。
45if ($privateKeyObject === false) {
46    echo "エラー: プライベートキーの読み込みに失敗しました。" . PHP_EOL;
47    // OpenSSLのエラーキューからエラーメッセージをすべて取得して表示します。
48    while ($msg = openssl_error_string()) {
49        echo "OpenSSLエラー: " . $msg . PHP_EOL;
50    }
51} else {
52    echo "プライベートキーが正常に読み込まれました (OpenSSLAsymmetricKeyオブジェクトとして)。" . PHP_EOL;
53
54    // 読み込んだキーの詳細情報を取得します。
55    $keyDetails = openssl_pkey_get_details($privateKeyObject);
56
57    if ($keyDetails !== false) {
58        echo "--- キー詳細 ---" . PHP_EOL;
59        echo "タイプ: ";
60        switch ($keyDetails['type']) {
61            case OPENSSL_KEYTYPE_RSA:
62                echo "RSA";
63                break;
64            case OPENSSL_KEYTYPE_DSA:
65                echo "DSA";
66                break;
67            case OPENSSL_KEYTYPE_DH:
68                echo "DH";
69                break;
70            case OPENSSL_KEYTYPE_EC:
71                echo "EC";
72                break;
73            default:
74                echo "不明";
75                break;
76        }
77        echo PHP_EOL;
78        echo "ビット数: " . $keyDetails['bits'] . PHP_EOL;
79        echo "--- ---" . PHP_EOL;
80    } else {
81        echo "エラー: キーの詳細情報の取得に失敗しました。" . PHP_EOL;
82        while ($msg = openssl_error_string()) {
83            echo "OpenSSLエラー: " . $msg . PHP_EOL;
84        }
85    }
86}
87
88echo "--- 処理を終了します ---" . PHP_EOL;
89
90?>

PHPのopenssl_pkey_get_private関数は、OpenSSLのプライベートキー情報をPHPが扱えるOpenSSLAsymmetricKeyオブジェクトとして読み込むために使用されます。これにより、暗号化やデジタル署名など、セキュリティ関連の様々な操作でプライベートキーを活用できるようになります。

第一引数には、読み込みたいプライベートキーの情報を指定します。これはPEM形式の文字列、OpenSSLAsymmetricKeyオブジェクト、OpenSSLCertificateオブジェクト、またはキー設定を含む配列のいずれかで渡すことができます。サンプルコードでは、パスフレーズで保護されたPEM形式のプライベートキー文字列を渡しています。

第二引数には、プライベートキーがパスフレーズで保護されている場合に、そのパスフレーズを文字列で指定します。プライベートキーがパスフレーズで保護されていない場合は、この引数は省略可能です。

関数が正常にプライベートキーを読み込めた場合、そのプライベートキーを表すOpenSSLAsymmetricKeyオブジェクトを返します。読み込みに失敗した場合はfalseを返しますので、戻り値の確認は重要です。

サンプルコードでは、まず一時的にプライベートキーを生成し、それをパスフレーズ付きのPEM形式文字列としてエクスポートします。その後、openssl_pkey_get_private関数にこの文字列とパスフレーズを渡して、OpenSSLAsymmetricKeyオブジェクトとして再読み込みし、その詳細情報を表示する流れを示しています。これにより、外部から取得したプライベートキーをPHPのプログラム内で安全に利用する基本的な方法を理解できます。

Copy
1<?php
2
3/**
4 * Demonstrates the usage of openssl_pkey_get_private to load a private key from a string,
5 * including how to handle success and failure scenarios (e.g., "not working").
6 *
7 * This example generates a test private key internally to be self-contained and
8 * guarantee a valid input for demonstration purposes.
9 */
10function demonstratePrivateKeyLoading(): void
11{
12    echo "--- Demonstration of openssl_pkey_get_private ---\n\n";
13
14    // --- Step 1: Generate a test private key for demonstration ---
15    // In a real-world application, you would typically load a private key
16    // from a file or configuration. For this self-contained example,
17    // we generate a temporary RSA key.
18    $config = [
19        "digest_alg" => "sha512",
20        "private_key_bits" => 2048,
21        "private_key_type" => OPENSSL_KEYTYPE_RSA,
22    ];
23
24    // Generate a new private key resource.
25    $keyResource = openssl_pkey_new($config);
26    if ($keyResource === false) {
27        echo "Error: Failed to generate a new private key for the demo.\n";
28        while ($msg = openssl_error_string()) {
29            echo "OpenSSL error: " . $msg . "\n";
30        }
31        return;
32    }
33
34    $passphrase = 'a_strong_demo_passphrase'; // A passphrase for the generated key
35    $privateKeyString = '';
36
37    // Export the generated private key into a string (PEM format) with the passphrase.
38    if (!openssl_pkey_export($keyResource, $privateKeyString, $passphrase)) {
39        echo "Error: Failed to export the generated private key string.\n";
40        while ($msg = openssl_error_string()) {
41            echo "OpenSSL error: " . $msg . "\n";
42        }
43        openssl_pkey_free($keyResource); // Free the key resource
44        return;
45    }
46    openssl_pkey_free($keyResource); // Free the initial key resource after export
47
48    // --- Step 2: Attempt to load the private key successfully with the correct passphrase ---
49    echo "Scenario 1: Loading private key with the CORRECT passphrase.\n";
50    echo "--------------------------------------------------------\n";
51    $loadedKey = openssl_pkey_get_private($privateKeyString, $passphrase);
52
53    if ($loadedKey === false) {
54        // If openssl_pkey_get_private returns false, an error occurred.
55        // This indicates a "not working" situation.
56        echo "Failure: Failed to load private key with the correct passphrase.\n";
57        echo "Error details (important for debugging 'not working' issues):\n";
58        // Loop through and display all OpenSSL error messages for debugging.
59        while ($msg = openssl_error_string()) {
60            echo "- " . $msg . "\n";
61        }
62    } else {
63        echo "Success: Private key loaded successfully!\n";
64        // The $loadedKey is now an OpenSSLAsymmetricKey object, which can be used
65        // for operations like signing, decryption, or getting key details.
66        $details = openssl_pkey_get_details($loadedKey);
67        if ($details) {
68            echo "Key type: " . ($details['type'] === OPENSSL_KEYTYPE_RSA ? 'RSA' : 'Other') . "\n";
69            echo "Key bits: " . $details['bits'] . "\n";
70        }
71        openssl_pkey_free($loadedKey); // It's good practice to free the key resource when done.
72    }
73
74    echo "\n";
75
76    // --- Step 3: Demonstrate "not working" with an INCORRECT passphrase ---
77    echo "Scenario 2: Loading private key with an INCORRECT passphrase (expected failure).\n";
78    echo "----------------------------------------------------------------------\n";
79    $incorrectPassphrase = 'this_is_the_wrong_passphrase';
80    $failedLoadedKey = openssl_pkey_get_private($privateKeyString, $incorrectPassphrase);
81
82    if ($failedLoadedKey === false) {
83        // This is the expected outcome when the passphrase is wrong.
84        echo "Success (expected failure): Private key failed to load with the incorrect passphrase.\n";
85        echo "Error details (identifying the 'not working' cause):\n";
86        // Displaying error messages helps diagnose why it "not working".
87        while ($msg = openssl_error_string()) {
88            echo "- " . $msg . "\n";
89        }
90    } else {
91        // This scenario would be an unexpected security issue if it happened.
92        echo "Failure (unexpected success): Private key loaded even with an incorrect passphrase!\n";
93        openssl_pkey_free($failedLoadedKey);
94    }
95
96    echo "\n--- End of demonstration ---\n";
97}
98
99// Execute the demonstration function.
100demonstratePrivateKeyLoading();
101
102?>

PHPのopenssl_pkey_get_private関数は、秘密鍵の文字列やファイルなどから秘密鍵リソース（OpenSSLAsymmetricKeyオブジェクト）を読み込むために使用されます。引数として、読み込みたい秘密鍵データ（$private_key）を渡し、鍵がパスフレーズで暗号化されている場合は、そのパスフレーズ（$passphrase）を指定します。

この関数は、秘密鍵が正しく読み込めた場合にOpenSSLAsymmetricKeyオブジェクトを返しますが、読み込みに失敗した場合はfalseを返します。特にパスフレーズが間違っている場合など、「not working」と感じるような失敗時にはfalseが返されます。このような状況では、openssl_error_string()関数を繰り返し呼び出すことで、OpenSSLライブラリから具体的なエラーメッセージを取得し、原因を特定することが重要です。

提示されたサンプルコードでは、まずデモンストレーション用に一時的な秘密鍵を生成し、パスフレーズ付きで文字列としてエクスポートしています。その後、シナリオ1として、その秘密鍵を正しいパスフレーズで読み込むことに成功する例を示し、正しく鍵がロードされた際に鍵の詳細情報が取得できることを確認しています。

次にシナリオ2として、同じ秘密鍵を「間違ったパスフレーズ」で読み込もうとする失敗例（「not working」の状況）を示しています。この場合、openssl_pkey_get_privateはfalseを返し、openssl_error_string()によって「bad decrypt」などのエラーメッセージが出力されることを確認でき、これが問題解決の手がかりとなります。この関数は、主に署名や複合化といった暗号処理を行う前に、秘密鍵を安全にプログラム内にロードする際に利用されます。