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

Copy
1<?php
2
3/**
4 * openssl_pkey_get_public 関数の使用例です。
5 * PEM形式の公開鍵文字列から OpenSSLAsymmetricKey オブジェクトをロードする方法を示します。
6 *
7 * @see https://www.php.net/manual/ja/function.openssl-pkey-get-public.php
8 */
9function exampleOpensslPkeyGetPublic(): void
10{
11    echo "openssl_pkey_get_public の使用例を開始します。\n";
12
13    // 1. 新しいキーペア（秘密鍵と公開鍵）を生成します。
14    //    このステップは、openssl_pkey_get_public に渡す公開鍵のPEM文字列を準備するために行います。
15    //    通常は、既存の公開鍵ファイルや文字列を直接使用します。
16    $config = [
17        "digest_alg"       => "sha512",
18        "private_key_bits" => 2048,
19        "private_key_type" => OPENSSL_KEYTYPE_RSA,
20    ];
21    $privateKey = openssl_pkey_new($config);
22
23    if ($privateKey === false) {
24        echo "エラー: 秘密鍵の生成に失敗しました。\n";
25        return;
26    }
27    echo "秘密鍵ペアを生成しました。\n";
28
29    // 2. 生成したキーペアから公開鍵のPEM形式文字列を抽出します。
30    //    openssl_pkey_get_details() はキーに関する詳細な情報を提供します。
31    $details = openssl_pkey_get_details($privateKey);
32
33    if ($details === false || !isset($details['key'])) {
34        echo "エラー: 公開鍵の詳細の取得に失敗しました。\n";
35        return;
36    }
37    $publicKeyPem = $details['key'];
38    echo "PEM形式の公開鍵を抽出しました。\n";
39    // echo "抽出された公開鍵 (PEM):\n" . $publicKeyPem . "\n"; // デバッグ用
40
41    // 3. openssl_pkey_get_public を使用して、PEM形式の公開鍵文字列から
42    //    OpenSSLAsymmetricKey オブジェクトをロードします。
43    echo "openssl_pkey_get_public を使用して公開鍵をロード中...\n";
44    $loadedPublicKey = openssl_pkey_get_public($publicKeyPem);
45
46    if ($loadedPublicKey === false) {
47        echo "エラー: openssl_pkey_get_public が公開鍵のロードに失敗しました。\n";
48        // OpenSSLのエラーメッセージがあれば表示
49        while ($msg = openssl_error_string()) {
50            echo "OpenSSL エラー: " . $msg . "\n";
51        }
52        return;
53    }
54
55    echo "公開鍵が OpenSSLAsymmetricKey オブジェクトとして正常にロードされました。\n";
56
57    // ロードされたオブジェクトが OpenSSLAsymmetricKey のインスタンスであることを確認します。
58    if ($loadedPublicKey instanceof OpenSSLAsymmetricKey) {
59        echo "ロードされたオブジェクトは OpenSSLAsymmetricKey のインスタンスです。\n";
60
61        // ロードされた公開鍵オブジェクトから詳細情報を再取得して確認する例
62        $loadedDetails = openssl_pkey_get_details($loadedPublicKey);
63        if ($loadedDetails !== false && isset($loadedDetails['bits'])) {
64            echo "ロードされたキーのビット数: " . $loadedDetails['bits'] . "\n";
65            echo "ロードされたキーのタイプ: " . (
66                $loadedDetails['type'] === OPENSSL_KEYTYPE_RSA ? 'RSA' : '不明なタイプ'
67            ) . "\n";
68        }
69    } else {
70        echo "エラー: ロードされたオブジェクトは OpenSSLAsymmetricKey のインスタンスではありません。\n";
71    }
72
73    echo "\nopenssl_pkey_get_public の使用例を終了します。\n";
74    // PHP 8.0 以降では OpenSSLAsymmetricKey オブジェクトはGCによって自動的に解放されます。
75}
76
77// 関数の実行
78exampleOpensslPkeyGetPublic();

openssl_pkey_get_public関数は、公開鍵の情報をPHPで扱えるOpenSSLAsymmetricKeyオブジェクトに変換するために利用されます。引数$public_keyには、PEM形式の文字列や既存の公開鍵リソースなど、読み込みたい公開鍵のデータを指定します。この関数が成功すると、変換された公開鍵を表すOpenSSLAsymmetricKeyオブジェクトが返され、そのオブジェクトを通じて公開鍵を用いたセキュリティ関連の操作が可能になります。失敗した場合はfalseが返されるため、戻り値の確認は非常に重要です。

サンプルコードでは、まず一時的にキーペアを生成し、そこから抽出したPEM形式の公開鍵文字列をopenssl_pkey_get_publicに渡すことで、公開鍵オブジェクトが正常にロードされる様子を示しています。これにより、外部から受け取った公開鍵のデータをPHPプログラムで安全かつ効率的に利用するための基盤が構築されます。デジタル署名の検証や、公開鍵暗号化の準備などでこのオブジェクトが活用されます。