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

Copy
1<?php
2
3/**
4 * openssl_pkey_get_details 関数と openssl_pkey_get_public 関数を組み合わせたサンプルコードです。
5 *
6 * システムエンジニアを目指す初心者向けに、公開鍵の生成からその詳細情報取得までを
7 * 簡潔に示します。
8 *
9 * openssl_pkey_get_details は、OpenSSLAsymmetricKey オブジェクト（鍵リソース）から
10 * 鍵のタイプやビット長などの詳細情報を連想配列で取得します。
11 * openssl_pkey_get_public は、公開鍵のPEM形式文字列から OpenSSLAsymmetricKey オブジェクトを生成します。
12 */
13function displayPublicKeyDetailsUsingOpenSSL(): void
14{
15    // 1. 新しい秘密鍵と公開鍵のペアを生成するための設定
16    // これはテスト用の設定です。本番環境ではより安全な方法で鍵を管理してください。
17    $config = [
18        "digest_alg" => "sha256",           // 鍵生成に使用するハッシュアルゴリズム
19        "private_key_bits" => 2048,         // 鍵のビット長（推奨されるセキュリティレベル）
20        "private_key_type" => OPENSSL_KEYTYPE_RSA, // 鍵のタイプとしてRSAを指定
21    ];
22
23    // 2. 秘密鍵を生成
24    // openssl_pkey_new() は OpenSSLAsymmetricKey オブジェクトを返します。
25    $privateKeyObject = openssl_pkey_new($config);
26
27    if ($privateKeyObject === false) {
28        echo "エラー: 秘密鍵の生成に失敗しました。" . PHP_EOL;
29        return;
30    }
31
32    echo "秘密鍵のペアを生成しました。" . PHP_EOL;
33
34    // 3. 生成した秘密鍵オブジェクトから、公開鍵のPEM形式文字列を抽出
35    // openssl_pkey_get_details() を使用して、鍵オブジェクトから詳細な情報を取得します。
36    // 返される連想配列には 'key' というキーで公開鍵のPEM形式文字列が含まれます。
37    $privateKeyDetails = openssl_pkey_get_details($privateKeyObject);
38
39    if ($privateKeyDetails === false || !isset($privateKeyDetails['key'])) {
40        echo "エラー: 秘密鍵の詳細情報取得、または公開鍵PEM形式の抽出に失敗しました。" . PHP_EOL;
41        return;
42    }
43
44    $publicKeyPemString = $privateKeyDetails['key'];
45    echo "公開鍵のPEM形式文字列を抽出しました。" . PHP_EOL;
46
47    // 4. 抽出したPEM形式の公開鍵文字列から、OpenSSLAsymmetricKey オブジェクトを再構築
48    // openssl_pkey_get_public() は、PEM形式の公開鍵文字列を受け取り、
49    // OpenSSLAsymmetricKey オブジェクト（公開鍵リソース）を返します。
50    $publicKeyObject = openssl_pkey_get_public($publicKeyPemString);
51
52    if ($publicKeyObject === false) {
53        echo "エラー: PEM形式から公開鍵オブジェクトのロードに失敗しました。" . PHP_EOL;
54        return;
55    }
56
57    echo "PEM形式から公開鍵オブジェクトをロードしました。(openssl_pkey_get_public使用)" . PHP_EOL;
58
59    // 5. ロードした公開鍵オブジェクトの詳細情報を取得
60    // ここで再度 openssl_pkey_get_details() を使用し、
61    // openssl_pkey_get_public() で生成した OpenSSLAsymmetricKey オブジェクトから
62    // 公開鍵のタイプやビット長などの詳細情報を取得・表示します。
63    $publicKeyDetails = openssl_pkey_get_details($publicKeyObject);
64
65    if ($publicKeyDetails === false) {
66        echo "エラー: 公開鍵オブジェクトからの詳細情報取得に失敗しました。" . PHP_EOL;
67        return;
68    }
69
70    echo PHP_EOL . "--- 公開鍵の詳細情報 ---" . PHP_EOL;
71    // 取得した詳細情報を整形して表示
72    foreach ($publicKeyDetails as $key => $value) {
73        if (is_array($value)) {
74            echo "$key: " . json_encode($value, JSON_PRETTY_PRINT) . PHP_EOL;
75        } else {
76            // 'key' (PEM形式の公開鍵文字列) は非常に長くなるため、一部のみ表示して見やすくします。
77            if ($key === 'key') {
78                echo "$key: " . substr($value, 0, 100) . "... (省略)" . PHP_EOL;
79            } else {
80                echo "$key: $value" . PHP_EOL;
81            }
82        }
83    }
84}
85
86// サンプル関数の実行
87displayPublicKeyDetailsUsingOpenSSL();

このサンプルコードは、PHPのOpenSSL拡張機能を用いて、鍵ペアを生成し、その詳細情報を取得する一連の流れをシステムエンジニアを目指す初心者向けに示しています。

まず、openssl_pkey_new()関数で秘密鍵と公開鍵のペアを生成し、OpenSSLAsymmetricKeyオブジェクト（鍵リソース）として取得します。次に、この鍵リソースをopenssl_pkey_get_details()関数の引数として渡します。この関数は、引数で受け取った鍵のタイプ、ビット長、そして公開鍵のPEM形式文字列など、鍵に関する詳細な情報を連想配列として返します。コードではこの戻り値から公開鍵のPEM形式文字列を抽出しています。

続いて、抽出した公開鍵のPEM形式文字列をopenssl_pkey_get_public()関数の引数に指定します。openssl_pkey_get_public()は、PEM形式の公開鍵文字列を受け取り、それをプログラムで扱えるOpenSSLAsymmetricKeyオブジェクト（公開鍵リソース）に変換して返します。

最後に、openssl_pkey_get_public()で生成された公開鍵オブジェクトを再度openssl_pkey_get_details()に渡し、その公開鍵の詳細情報を取得し表示することで、両関数の連携とそれぞれの役割を理解できます。openssl_pkey_get_details()は鍵オブジェクトから情報を取得し、openssl_pkey_get_public()は公開鍵の文字列形式をオブジェクト形式に変換する役割を担っています。

Copy
1<?php
2
3/**
4 * OpenSSL秘密鍵の生成、PEM形式でのエクスポート、その文字列からの読み込み、
5 * そして鍵の詳細情報を取得するデモンストレーションを行います。
6 *
7 * システムエンジニアを目指す初心者向けに、各関数の役割と実行の流れを簡潔に示します。
8 */
9function demonstrateOpensslKeyOperations(): void
10{
11    // 1. 新しいRSA秘密鍵ペアを生成
12    // openssl_pkey_new() は、新しい秘密鍵と対応する公開鍵のペアを生成し、
13    // OpenSSLAsymmetricKey オブジェクト（PHP 8.0以降）を返します。
14    // ここでは、鍵長2048ビットのRSA鍵を指定しています。
15    $config = [
16        'private_key_bits' => 2048,         // 鍵長を2048ビットに設定
17        'private_key_type' => OPENSSL_KEYTYPE_RSA, // RSA鍵タイプを指定
18    ];
19    $generatedPrivateKey = openssl_pkey_new($config);
20
21    if (!$generatedPrivateKey) {
22        echo "エラー: 秘密鍵の生成に失敗しました。\n";
23        return;
24    }
25
26    echo "--- ステップ1: 新しい秘密鍵ペアを生成しました ---\n";
27
28    // 2. 生成した秘密鍵をPEM形式の文字列としてエクスポート
29    // openssl_pkey_export() は OpenSSLAsymmetricKey オブジェクトをPEM形式の文字列に変換します。
30    // 第2引数に出力先の変数を渡し、第3引数でパスフレーズを指定できますが、今回は省略します。
31    $privateKeyPemString = '';
32    if (!openssl_pkey_export($generatedPrivateKey, $privateKeyPemString)) {
33        echo "エラー: 秘密鍵のPEM形式へのエクスポートに失敗しました。\n";
34        return;
35    }
36
37    // セキュリティ上の理由から、通常は秘密鍵のPEM文字列を直接表示しません。
38    // デモンストレーションのため、一部のみ表示します。
39    // echo "生成された秘密鍵 (PEM形式、一部):\n" . substr($privateKeyPemString, 0, 100) . "...\n";
40
41    echo "--- ステップ2: 秘密鍵をPEM形式の文字列としてエクスポートしました ---\n";
42
43    // 3. PEM形式の文字列から秘密鍵リソースを読み込み
44    // openssl_pkey_get_private() は、PEM形式の秘密鍵文字列やファイルパスから
45    // OpenSSLAsymmetricKey オブジェクト（秘密鍵リソース）を生成します。
46    // これがキーワードに関連する部分です。
47    $loadedPrivateKey = openssl_pkey_get_private($privateKeyPemString);
48
49    if (!$loadedPrivateKey) {
50        echo "エラー: PEM文字列から秘密鍵の読み込みに失敗しました。\n";
51        return;
52    }
53
54    echo "--- ステップ3: PEM文字列から秘密鍵を読み込みました ---\n";
55
56    // 4. 読み込んだ秘密鍵の詳細情報を取得
57    // openssl_pkey_get_details() は、OpenSSLAsymmetricKey オブジェクトや
58    // 証明書などの詳細情報を連想配列として返します。
59    $keyDetails = openssl_pkey_get_details($loadedPrivateKey);
60
61    if ($keyDetails === false) {
62        echo "エラー: 秘密鍵の詳細情報の取得に失敗しました。\n";
63        return;
64    }
65
66    echo "\n--- ステップ4: 秘密鍵の詳細情報 ---\n";
67    // 'type' キーには鍵のタイプ（例: OPENSSL_KEYTYPE_RSA）が格納されます。
68    // openssl_pkey_type_name() で人間が読める形式に変換します。
69    echo "  鍵タイプ: " . (isset($keyDetails['type']) ? openssl_pkey_type_name($keyDetails['type']) : '不明') . "\n";
70    // 'bits' キーには鍵長（ビット数）が格納されます。
71    echo "  鍵長 (bits): " . ($keyDetails['bits'] ?? '不明') . "\n";
72    // 'key' キーにはPEM形式の公開鍵が含まれます。
73    echo "  公開鍵 (PEM形式、最初の数行):\n" . (isset($keyDetails['key']) ? substr($keyDetails['key'], 0, 100) . "..." : 'N/A') . "\n";
74
75    // PHP 8.0以降では、OpenSSLAsymmetricKeyオブジェクトはスクリプト終了時や不要になった際に
76    // ガベージコレクションによって自動的にクリーンアップされます。
77    // 明示的な解放 (openssl_free_key) は通常不要です。
78
79    echo "\nデモンストレーションが完了しました。\n";
80}
81
82// 関数を実行して、一連の操作を確認します。
83demonstrateOpensslKeyOperations();
84

このサンプルコードは、PHPのOpenSSL拡張機能を利用して、秘密鍵の生成からその詳細情報の取得までの一連のプロセスを解説しています。

まず、openssl_pkey_new関数は、指定された設定（ここでは鍵長2048ビットのRSA鍵）に基づいて新しい秘密鍵と公開鍵のペアを生成し、OpenSSLAsymmetricKeyオブジェクトを返します。次に、生成されたこのOpenSSLAsymmetricKeyオブジェクトは、openssl_pkey_export関数によってPEM形式の文字列としてエクスポートされます。

その後、openssl_pkey_get_private関数が登場します。この関数は、PEM形式の秘密鍵文字列を引数として受け取り、それを解析して再度OpenSSLAsymmetricKeyオブジェクト（秘密鍵リソース）として読み込みます。成功するとOpenSSLAsymmetricKeyオブジェクトを、失敗するとfalseを返します。これにより、外部から提供された鍵や保存された鍵をPHPで操作可能になります。

最後に、openssl_pkey_get_details関数が、読み込まれたOpenSSLAsymmetricKeyオブジェクトから鍵の具体的な情報を取り出します。引数には鍵のオブジェクトを渡し、成功すると鍵タイプ、鍵長、公開鍵のPEM形式文字列などを含む連想配列を、失敗するとfalseを返します。この情報を用いて、鍵の特性を確認できます。PHP 8.0以降では、鍵オブジェクトのメモリ管理はPHPによって自動的に行われます。