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

Copy
1<?php
2
3/**
4 * OpenSSL CSRからサブジェクト情報を取得するサンプルコードです。
5 *
6 * この関数は、証明書署名要求 (CSR) を生成し、
7 * そのCSRからサブジェクト（所有者）の情報を取得して表示します。
8 * システムエンジニアを目指す初心者の方にも理解しやすいように、
9 * 各ステップで何が行われているかをコメントで説明します。
10 *
11 * @return void
12 */
13function demonstrateOpensslCsrGetSubject(): void
14{
15    // 1. 秘密鍵を生成するための設定を定義します。
16    // ここで鍵のアルゴリズム、ビット数などを指定します。
17    $configArgs = [
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 は、SSL証明書で使用する新しい秘密鍵を作成します。
25    // 成功すると OpenSSLAsymmetricKey オブジェクトを、失敗すると false を返します。
26    $privateKey = openssl_pkey_new($configArgs);
27
28    if ($privateKey === false) {
29        echo "エラー: 秘密鍵の生成に失敗しました。\n";
30        // OpenSSLのエラー情報を取得して表示
31        while ($msg = openssl_error_string()) {
32            echo "OpenSSLエラー: " . $msg . "\n";
33        }
34        return;
35    }
36
37    echo "秘密鍵が正常に生成されました。\n";
38
39    // 3. CSR（証明書署名要求）のサブジェクト情報を定義します。
40    // この情報は、最終的に発行される証明書に記載されます。
41    // 各キーはX.509証明書のフィールドに対応します。
42    $dn = [
43        "countryName" => "JP",              // 国名 (C)
44        "stateOrProvinceName" => "Tokyo",   // 都道府県名 (ST)
45        "localityName" => "Shibuya-ku",     // 市町村区名 (L)
46        "organizationName" => "Example Corp", // 組織名 (O)
47        "organizationalUnitName" => "IT Dept", // 部署名 (OU)
48        "commonName" => "www.example.com",  // コモンネーム (CN) - 主にWebサイトのドメイン名
49        "emailAddress" => "webmaster@example.com", // 管理者のメールアドレス
50    ];
51
52    // 4. 新しいCSRを生成します。
53    // openssl_csr_new は、定義したサブジェクト情報と生成した秘密鍵を使ってCSRを作成します。
54    // 成功すると OpenSSLCertificateSigningRequest オブジェクトを、失敗すると false を返します。
55    $csr = openssl_csr_new($dn, $privateKey, $configArgs);
56
57    if ($csr === false) {
58        echo "エラー: CSRの生成に失敗しました。\n";
59        while ($msg = openssl_error_string()) {
60            echo "OpenSSLエラー: " . $msg . "\n";
61        }
62        // 秘密鍵オブジェクトはもう不要なので解放
63        $privateKey = null;
64        return;
65    }
66
67    echo "CSRが正常に生成されました。\n";
68
69    // 5. 生成されたCSRオブジェクトからサブジェクト情報を取得します。
70    // openssl_csr_get_subject は、CSRオブジェクトからサブジェクトの情報を連想配列で取得します。
71    // 第二引数 `$short_names` が `true` の場合 (デフォルト)、"CN", "C" のような短縮名でキーが返されます。
72    // `false` の場合、"commonName", "countryName" のような長い名前でキーが返されます。
73    $subjectInfo = openssl_csr_get_subject($csr);
74
75    if ($subjectInfo === false) {
76        echo "エラー: CSRからサブジェクト情報の取得に失敗しました。\n";
77        while ($msg = openssl_error_string()) {
78            echo "OpenSSLエラー: " . $msg . "\n";
79        }
80        // CSRオブジェクトと秘密鍵オブジェクトはもう不要なので解放
81        $csr = null;
82        $privateKey = null;
83        return;
84    }
85
86    echo "\n--- CSR サブジェクト情報 ---\n";
87    // 取得したサブジェクト情報をループで表示します。
88    foreach ($subjectInfo as $key => $value) {
89        // 見やすくするためにフォーマットして出力
90        echo sprintf("%-20s: %s\n", $key, $value);
91    }
92    echo "----------------------------\n";
93
94    // 6. 生成したオブジェクトを解放します。
95    // PHP 8以降ではガベージコレクションによって自動的に解放されますが、
96    // 明示的に `null` を代入することで、メモリの早期解放を促すことができます。
97    $privateKey = null; // 秘密鍵オブジェクトを解放
98    $csr = null;        // CSRオブジェクトを解放
99}
100
101// 関数を実行して、CSRからのサブジェクト情報取得プロセスを開始します。
102demonstrateOpensslCsrGetSubject();
103
104?>

openssl_csr_get_subject関数は、PHPのOpenSSL拡張機能の一つで、証明書署名要求（CSR: Certificate Signing Request）に記載されているサブジェクト（所有者）の情報を取得するために使われます。CSRは、SSL/TLS証明書を認証局に申請する際に提出するファイルで、Webサイトのドメイン名や組織名などが含まれます。

サンプルコードでは、まずWebサイトの身元情報となるサブジェクト情報を定義し、秘密鍵とともにCSRを作成しています。この関数は、作成されたOpenSSLCertificateSigningRequestオブジェクト、またはCSRの内容を文字列として最初の引数$csrに渡すことで利用します。

第二引数$short_namesはオプションで、デフォルトはtrueです。trueの場合、国名にはC、コモンネームにはCNといったX.509証明書の短いキー名でサブジェクト情報が連想配列として返されます。falseに設定するとcountryNameやcommonNameのような長いキー名で情報が得られます。関数が成功すると、このサブジェクト情報を含む連想配列が返され、失敗した場合はfalseを返します。

この機能は、システムエンジニアがSSL/TLS証明書を扱う際、生成したCSRが意図した通りの情報を含んでいるかをプログラムで確認するのに非常に役立ちます。サンプルコードを実行すると、作成したCSRから取得されたサブジェクト情報が、見やすく整形された形でコンソールに表示されます。