【PHP8.x】OPENSSL_KEYTYPE_EC定数の使い方

Copy
1<?php
2
3/**
4 * OpenSSL拡張機能を使用して楕円曲線 (EC) 鍵ペアを生成し、
5 * 秘密鍵から公開鍵を抽出し、その詳細情報を確認するサンプル関数。
6 *
7 * この関数は、OPENSSL_KEYTYPE_EC 定数を使用してEC鍵を生成し、
8 * openssl_pkey_get_public 関数で公開鍵を抽出するプロセスを示します。
9 *
10 * @return void
11 */
12function demonstrateEcKeyHandling(): void
13{
14    echo "OpenSSL EC Key Handling Demonstration\n\n";
15
16    // OpenSSL拡張機能が利用可能か確認
17    if (!extension_loaded('openssl')) {
18        echo "Error: OpenSSL extension is not loaded. Please enable it in your php.ini.\n";
19        return;
20    }
21
22    // 1. 楕円曲線 (EC) 鍵ペア生成のための設定
23    // "private_key_type" に OPENSSL_KEYTYPE_EC を指定することで、EC鍵を生成するよう指示します。
24    // "curve_name" は使用する楕円曲線の種類を指定します (例: prime256v1, secp384r1)。
25    $config = [
26        "private_key_type" => OPENSSL_KEYTYPE_EC,
27        "curve_name" => "prime256v1",
28    ];
29
30    echo "Attempting to generate an EC private key...\n";
31
32    // 2. 新しい秘密鍵リソースを生成
33    // openssl_pkey_new() は、指定された設定に基づいて新しい鍵ペアを生成し、
34    // その秘密鍵を指すリソースを返します。
35    $privateKeyResource = openssl_pkey_new($config);
36
37    if (!$privateKeyResource) {
38        echo "Error: Failed to generate private key. Check OpenSSL configuration or curve_name.\n";
39        // openssl_error_string() でOpenSSLのエラーメッセージを取得できます。
40        echo "OpenSSL Error: " . openssl_error_string() . "\n";
41        return;
42    }
43
44    echo "EC private key generated successfully.\n";
45
46    // 3. 秘密鍵リソースから公開鍵リソースを抽出
47    // openssl_pkey_get_public() は、鍵リソース（ここでは秘密鍵リソース）から
48    // その公開鍵情報を抽出し、新しい鍵リソースとして返します。
49    $publicKeyResource = openssl_pkey_get_public($privateKeyResource);
50
51    if (!$publicKeyResource) {
52        echo "Error: Failed to extract public key from private key.\n";
53        echo "OpenSSL Error: " . openssl_error_string() . "\n";
54        // 失敗した場合でも、生成済みの秘密鍵リソースは解放します。
55        openssl_free_key($privateKeyResource);
56        return;
57    }
58
59    echo "Public key extracted successfully.\n";
60
61    // 4. 抽出した公開鍵の詳細情報を取得
62    // openssl_pkey_get_details() は、鍵リソースの内部詳細情報（タイプ、ビット数、公開鍵データなど）を
63    // 連想配列として返します。
64    $publicKeyDetails = openssl_pkey_get_details($publicKeyResource);
65
66    if (!$publicKeyDetails) {
67        echo "Error: Failed to get public key details.\n";
68        echo "OpenSSL Error: " . openssl_error_string() . "\n";
69        // 失敗した場合でも、生成済みのリソースは解放します。
70        openssl_free_key($privateKeyResource);
71        openssl_free_key($publicKeyResource);
72        return;
73    }
74
75    echo "\n--- Public Key Details ---\n";
76    echo "Key Type (integer value): " . $publicKeyDetails['type'] . "\n";
77    echo "Expected EC Key Type (OPENSSL_KEYTYPE_EC): " . OPENSSL_KEYTYPE_EC . "\n";
78
79    // 5. 鍵タイプが OPENSSL_KEYTYPE_EC と一致するか確認
80    if ($publicKeyDetails['type'] === OPENSSL_KEYTYPE_EC) {
81        echo "Verification: The extracted key type matches OPENSSL_KEYTYPE_EC. (Success!)\n";
82    } else {
83        echo "Verification: The extracted key type does NOT match OPENSSL_KEYTYPE_EC. (Actual: {$publicKeyDetails['type']})\n";
84    }
85
86    // 公開鍵の内容 (PEM形式) を表示
87    if (isset($publicKeyDetails['key'])) {
88        echo "\nPublic Key (PEM format):\n";
89        echo $publicKeyDetails['key'];
90    } else {
91        echo "\nPublic Key (PEM format) not available in details.\n";
92    }
93
94    echo "\n--- End Public Key Details ---\n";
95
96    // 6. 生成した鍵リソースを解放
97    // openssl_free_key() は、使用済みの鍵リソースを解放し、メモリリークを防ぎます。
98    openssl_free_key($privateKeyResource);
99    openssl_free_key($publicKeyResource);
100
101    echo "\nKey resources freed.\n";
102}
103
104// 関数を実行してデモンストレーションを開始
105demonstrateEcKeyHandling();

このPHPサンプルコードは、OpenSSL拡張機能を用いて楕円曲線（EC）鍵ペアを生成し、その秘密鍵から公開鍵を安全に抽出し、詳細情報を確認する一連のプロセスを初心者にも分かりやすく示しています。

まず、鍵生成の際にOPENSSL_KEYTYPE_EC定数を使用して、生成する鍵のタイプを楕円曲線暗号方式に指定します。この定数はPHPのOpenSSL拡張機能の一部であり、EC鍵を示す整数値として定義されています。openssl_pkey_new()関数は、この設定に基づいて新しいEC秘密鍵リソースを生成します。

次に、生成された秘密鍵リソースから対応する公開鍵を抽出するためにopenssl_pkey_get_public()関数が使われます。この関数は引数として鍵リソース（ここでは秘密鍵リソース）を受け取り、成功した場合はその公開鍵情報を表す新しいリソースを、失敗した場合はfalseを返します。

抽出された公開鍵リソースはopenssl_pkey_get_details()関数によって、鍵のタイプや実際の公開鍵データなど、詳細な情報を含む連想配列として取得されます。これにより、抽出された鍵のタイプがOPENSSL_KEYTYPE_ECと一致するかを確認できます。最後に、使用した全ての鍵リソースはopenssl_free_key()関数で適切に解放され、メモリリークを防ぎます。このコードは、OpenSSLを使った鍵操作の基本的な流れを学ぶ上で役立ちます。

Copy
1<?php
2
3/**
4 * OpenSSLを使用して、指定されたキータイプで新しいキーペア（秘密鍵と公開鍵）を生成します。
5 * 主にopenssl_pkey_new関数とOPENSSL_KEYTYPE_EC定数の使用方法を示します。
6 *
7 * @param int $keyType 生成するキーのタイプ（例: OPENSSL_KEYTYPE_EC）。
8 * @return array|false 成功した場合は秘密鍵と公開鍵のPEM形式文字列を含む連想配列、
9 *                     失敗した場合はfalseを返します。
10 */
11function generateEcKeyPair(int $keyType): array|false
12{
13    // キーペア生成のための設定オプションを定義します。
14    // OPENSSL_KEYTYPE_ECの場合、'curve_name'で特定の楕円曲線を指定することが一般的です。
15    // 'prime256v1'は、広く使われている楕円曲線の一つです。
16    $config = [
17        'private_key_type' => $keyType,
18        'curve_name' => 'prime256v1', // ECキー生成に推奨される曲線の指定
19    ];
20
21    // openssl_pkey_new関数を使って新しいキーペアを生成します。
22    // 成功するとOpenSSLAsymmetricKeyオブジェクトが返されます。
23    $privateKeyResource = openssl_pkey_new($config);
24
25    if ($privateKeyResource === false) {
26        echo "エラー: キーペアの生成に失敗しました。\n";
27        // エラー詳細を取得して表示します。
28        while (($msg = openssl_error_string()) !== false) {
29            echo $msg . "\n";
30        }
31        return false;
32    }
33
34    // 生成された秘密鍵をPEM形式の文字列としてエクスポートします。
35    $privateKeyPem = '';
36    if (!openssl_pkey_export($privateKeyResource, $privateKeyPem)) {
37        echo "エラー: 秘密鍵のエクスポートに失敗しました。\n";
38        while (($msg = openssl_error_string()) !== false) {
39            echo $msg . "\n";
40        }
41        return false;
42    }
43
44    // 公開鍵の詳細を取得し、そこから公開鍵のPEM形式文字列を抽出します。
45    $publicKeyDetails = openssl_pkey_get_details($privateKeyResource);
46    if ($publicKeyDetails === false || !isset($publicKeyDetails['key'])) {
47        echo "エラー: 公開鍵の取得に失敗しました。\n";
48        while (($msg = openssl_error_string()) !== false) {
49            echo $msg . "\n";
50        }
51        return false;
52    }
53    $publicKeyPem = $publicKeyDetails['key'];
54
55    // 秘密鍵と公開鍵を配列として返します。
56    return [
57        'private_key' => $privateKeyPem,
58        'public_key' => $publicKeyPem,
59    ];
60}
61
62// OPENSSL_KEYTYPE_EC定数を使用して、楕円曲線(EC)キーペアを生成します。
63echo "ECキーペアの生成を開始します...\n";
64$keys = generateEcKeyPair(OPENSSL_KEYTYPE_EC);
65
66if ($keys !== false) {
67    echo "\n--- 秘密鍵 (PEM形式) ---\n";
68    echo $keys['private_key'];
69    echo "\n--- 公開鍵 (PEM形式) ---\n";
70    echo $keys['public_key'];
71    echo "\nECキーペアの生成と表示が成功しました。\n";
72} else {
73    echo "\nECキーペアの生成に失敗しました。OpenSSLの設定を確認してください。\n";
74}
75
76?>

このPHPコードは、OpenSSL拡張機能を利用して、楕円曲線（EC）方式の新しい鍵ペア（秘密鍵と公開鍵）を生成する方法を示しています。OPENSSL_KEYTYPE_ECは、生成する鍵のタイプを楕円曲線暗号に指定するためのPHPの定数であり、その値は整数です。

generateEcKeyPair関数は、引数として生成する鍵のタイプを示す整数値（OPENSSL_KEYTYPE_ECなど）を受け取り、鍵ペアを生成します。この関数は、openssl_pkey_new関数を呼び出して新しい鍵ペアを作成します。その際、設定オプションのprivate_key_typeにOPENSSL_KEYTYPE_ECを指定することで、楕円曲線鍵の生成を指示し、さらにcurve_nameオプションで具体的な楕円曲線としてprime256v1を設定しています。これはEC鍵生成に特有の設定です。

鍵ペアが正常に生成されると、秘密鍵はopenssl_pkey_export関数で、公開鍵はopenssl_pkey_get_details関数を通じて、それぞれPEM形式の文字列として取得されます。この関数は成功した場合、取得した秘密鍵と公開鍵を含む連想配列を戻り値として返し、鍵生成やエクスポートに失敗した場合はfalseを返します。このコードは、OPENSSL_KEYTYPE_EC定数を用いてOpenSSLによる鍵生成の基本的な流れを具体的に示しています。