【PHP8.x】openssl_csr_export_to_file()関数の使い方
openssl_csr_export_to_file関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
openssl_csr_export_to_file関数は、OpenSSL拡張機能の一つで、生成された証明書署名要求(CSR: Certificate Signing Request)を、指定されたファイルに保存する(エクスポートする)機能を実行する関数です。
CSRとは、Webサイトなどで利用されるSSL/TLS証明書を取得する際に、認証局へ提出するための重要なデータです。これには、公開鍵の情報や、組織名、ドメイン名などの識別情報が含まれており、証明書発行の基盤となります。
この関数は、PHPスクリプト内で作成または取得したCSRデータを、外部のファイルとして永続化したい場合に非常に有用です。例えば、openssl_csr_new関数でCSRを生成した後、その内容を.csrファイルとして保存し、その後、このファイルを認証局に送信して正式なSSL/TLS証明書を発行してもらうといった一連の流れの中で利用されます。
関数を使用する際には、エクスポートしたいCSRのデータ(リソースまたはPEM形式の文字列)を第一引数に、CSRを保存するファイルへのパスと名前を第二引数に指定します。オプションとして、第三引数にtrueを設定することで、通常ファイルに含まれる詳細なテキスト情報を省略し、純粋なPEM形式のCSRデータのみを保存することも可能です。
処理が正常に完了し、CSRがファイルに保存された場合はtrueを返します。何らかの問題が発生し、保存に失敗した場合はfalseを返し、関連する警告メッセージがPHPのエラーログに出力されることがあります。これにより、Webサーバーのセキュリティを確保するためのSSL/TLS証明書発行プロセスを、プログラムから効率的かつ自動的に管理することが可能になります。
構文(syntax)
1<?php 2openssl_csr_export_to_file($csr, $output_filename); 3?>
引数(parameters)
OpenSSLCertificateSigningRequest|string $csr, string $output_filename, bool $no_text = true
- OpenSSLCertificateSigningRequest|string $csr: エクスポートするCSR (Certificate Signing Request) オブジェクト、またはPEM形式のCSR文字列
- string $output_filename: CSRを保存するファイルパス
- bool $no_text = true: falseに設定すると、CSRのテキスト表現(人間が読める形式)もファイルに出力します
戻り値(return)
bool
openssl_csr_export_to_file 関数は、証明書署名要求 (CSR) を指定されたファイルにエクスポートする操作の成功または失敗を示す真偽値 (boolean) を返します。成功した場合は true、失敗した場合は false を返します。
サンプルコード
PHPでCSRをファイルにエクスポートする
1<?php 2 3// このスクリプトは、CSR(Certificate Signing Request: 証明書署名リクエスト)を生成し、 4// ファイルにエクスポートするサンプルです。 5// 生成されたCSRは、認証局(CA)に提出され、SSL/TLS証明書が発行されます。 6 7// 一時的な秘密鍵ファイルとCSR出力ファイルのパスを設定します。 8$privateKeyFile = 'private_key.pem'; 9$csrFile = 'certificate_request.csr'; 10 11// 秘密鍵の生成オプションを設定します。 12$privateKeyOptions = [ 13 "private_key_bits" => 2048, // 鍵のビット数(強度の目安) 14 "private_key_type" => OPENSSL_KEYTYPE_RSA, // 鍵の種類をRSAに指定 15]; 16 17// CSRに含める情報を設定します。 18// これらの情報は、発行される証明書に記載されます。 19$dn = [ 20 "countryName" => "JP", // 国名 (例: JP) 21 "stateOrProvinceName" => "Tokyo", // 都道府県名 (例: Tokyo) 22 "localityName" => "Shinjuku-ku", // 市区町村名 (例: Shinjuku-ku) 23 "organizationName" => "Example Corp", // 組織名 (例: Example Corp) 24 "organizationalUnitName" => "IT Department",// 部署名 (例: IT Department) 25 "commonName" => "www.example.com", // コモンネーム(FQDN: 完全修飾ドメイン名) 26 "emailAddress" => "webmaster@example.com" // メールアドレス 27]; 28 29// 1. 新しい秘密鍵を生成します。 30$privateKey = openssl_pkey_new($privateKeyOptions); 31if ($privateKey === false) { 32 error_log("エラー: 秘密鍵の生成に失敗しました。OpenSSLのエラー: " . openssl_error_string()); 33 exit(1); 34} 35 36// 秘密鍵をファイルに保存します。 37// 通常、秘密鍵は厳重に管理されるべき情報です。 38openssl_pkey_export_to_file($privateKey, $privateKeyFile); 39echo "秘密鍵を '{$privateKeyFile}' に生成しました。\n"; 40 41// 2. 秘密鍵と設定情報をもとにCSRを生成します。 42$csr = openssl_csr_new($dn, $privateKey, $privateKeyOptions); 43if ($csr === false) { 44 error_log("エラー: CSRの生成に失敗しました。OpenSSLのエラー: " . openssl_error_string()); 45 // 処理中に生成した秘密鍵ファイルを削除します。 46 if (file_exists($privateKeyFile)) { 47 unlink($privateKeyFile); 48 } 49 exit(1); 50} 51 52// 3. 生成したCSRをPEM形式で指定されたファイルにエクスポートします。 53// 第3引数 `$no_text = true` (デフォルト値) は、テキスト形式の詳細情報を含まず、 54// PEMエンコードされたデータのみを出力することを意味します。 55$exported = openssl_csr_export_to_file($csr, $csrFile, true); 56 57if ($exported) { 58 echo "CSRを '{$csrFile}' にエクスポートしました。\n"; 59 echo "--- {$csrFile} の内容 (PEM形式) ---\n"; 60 echo file_get_contents($csrFile); 61 echo "--------------------------\n"; 62 63 // 【キーワード 'php openssl.cafile' に関する補足】 64 // このエクスポートされたCSRは、認証局 (CA) によって署名されることで 65 // 最終的なSSL/TLS証明書になります。 66 // PHP環境でSSL/TLS通信を行う際、`php.ini` の `openssl.cafile` 設定や 67 // cURLなどのライブラリ設定で、CA証明書バンドルファイルへのパスを指定することがあります。 68 // これは、通信相手から提示された証明書が信頼できるCAによって発行されたものであるか検証するために使用され、 69 // セキュリティ上非常に重要な設定です。 70 // `openssl_csr_export_to_file` 関数自体はこのCAファイルを直接使用しませんが、 71 // 生成された証明書が実際に利用される場面で重要な役割を果たします。 72 73} else { 74 error_log("エラー: CSRのエクスポートに失敗しました。OpenSSLのエラー: " . openssl_error_string()); 75} 76 77// 後処理: 生成した一時ファイルを削除します。 78// 実際の運用では、秘密鍵は安全な場所に保管し、CSRはCAに送信後に削除または保管します。 79if (file_exists($privateKeyFile)) { 80 unlink($privateKeyFile); 81 echo "一時的な秘密鍵ファイル '{$privateKeyFile}' を削除しました。\n"; 82} 83if (file_exists($csrFile)) { 84 unlink($csrFile); 85 echo "一時的なCSRファイル '{$csrFile}' を削除しました。\n"; 86} 87 88// 秘密鍵リソースを解放します。 89openssl_pkey_free($privateKey); 90// CSRリソースを解放します。 91openssl_csr_free($csr); 92 93?>
PHPのopenssl_csr_export_to_file関数は、作成したCSR(Certificate Signing Request: 証明書署名リクエスト)を、認証局(CA)へ提出できるファイル形式(PEM形式)で保存するために利用します。ウェブサイトのSSL/TLS証明書を申請する際に必要となるCSRファイルを生成するプロセスにおいて重要な役割を果たします。
このサンプルコードでは、はじめに秘密鍵を生成し、証明書に含める情報を設定してCSRを作成しています。その後、openssl_csr_export_to_file関数を呼び出し、生成されたCSRデータを指定されたファイル(certificate_request.csr)として出力しています。
関数の第一引数$csrには、作成済みのCSRリソースまたはPEM形式のCSR文字列を指定します。第二引数$output_filenameで出力するファイル名とパスを設定し、第三引数$no_text(デフォルトはtrue)は、ファイルに詳細なテキスト情報を含めるかどうかを決定します(trueの場合、データ本体のみを保存します)。関数は処理が成功するとtrueを、失敗するとfalseを返します。
キーワードとして挙げられているphp openssl.cafileは、この関数が直接使うものではありません。しかし、この関数で生成されたCSRから発行されるSSL/TLS証明書をPHPアプリケーションが利用する際、通信の安全性を確保するために、php.iniのopenssl.cafile設定で信頼できるCA証明書のファイルを指定することがあります。これは、通信相手の証明書が信頼できるものか検証するための重要な設定です。
秘密鍵は非常に機密性の高い情報であり、厳重な管理が必要です。本番運用では、生成後に安全な場所に保管し、アクセスを厳しく制限してください。openssl_csr_export_to_file関数の戻り値は出力の成否を示しますので、必ずエラーチェックを行い、失敗時にはログ出力や関連ファイルの削除など適切なエラー処理を行ってください。また、php openssl.cafileは、本関数で生成したCSRから発行されるSSL/TLS証明書をPHPで利用する際に、通信相手の証明書が信頼できる認証局によるものか検証するために重要な設定となります。
PHPでCSRをファイルにエクスポートする
1<?php 2 3/** 4 * openssl_csr_export_to_file 関数のサンプルコード 5 * 6 * このコードは、OpenSSLのCertificate Signing Request (CSR) を生成し、 7 * そのCSRをファイルにエクスポートする方法を示します。 8 * openssl.cnf ファイルを使用してCSR生成設定を制御する方法も含まれています。 9 * 10 * システムエンジニアを目指す初心者向けに、各ステップをコメントで説明しています。 11 */ 12 13// 1. 一時的なOpenSSL設定ファイル (openssl.cnf) の内容を定義します。 14// このファイルはCSRの生成に必要なデフォルト情報を提供します。 15// プロダクション環境では、通常、既存のopenssl.cnfファイルを指定します。 16$opensslConfigContent = <<<EOT 17[ req ] 18distinguished_name = req_distinguished_name 19prompt = no 20[ req_distinguished_name ] 21C = JP 22ST = Tokyo 23L = Shibuya-ku 24O = Sample Company 25OU = Web Services 26CN = www.example.com 27emailAddress = admin@example.com 28EOT; 29 30// 一時的なopenssl.cnfファイルを生成します。 31$opensslConfigPath = __DIR__ . '/temp_openssl.cnf'; 32if (file_put_contents($opensslConfigPath, $opensslConfigContent) === false) { 33 echo "エラー: openssl.cnfファイルの作成に失敗しました。\n"; 34 exit(1); 35} 36echo "一時的なOpenSSL設定ファイルを生成しました: {$opensslConfigPath}\n"; 37 38// 2. CSR生成に必要な識別名 (Distinguished Name - DN) の最小限の配列を定義します。 39// openssl.cnfの 'distinguished_name' セクションに定義されている値が優先されるため、 40// ここでは共通名のみを設定し、他の情報は openssl.cnf から取得されることを示します。 41$dn = [ 42 "commonName" => "www.example.com", 43]; 44 45// 3. 秘密鍵を生成します。CSRは公開鍵とこの秘密鍵のペアで作成されます。 46// 秘密鍵は厳重に管理し、本番環境では安全な場所に保管してください。 47$privateKey = openssl_pkey_new([ 48 "private_key_bits" => 2048, 49 "private_key_type" => OPENSSL_KEYTYPE_RSA, 50]); 51 52if ($privateKey === false) { 53 echo "エラー: 秘密鍵の生成に失敗しました。\n"; 54 unlink($opensslConfigPath); 55 exit(1); 56} 57echo "秘密鍵を生成しました。\n"; 58 59// 秘密鍵を一時ファイルに保存します。(通常、安全な場所に保管します) 60$privateKeyPath = __DIR__ . '/private.key'; 61if (openssl_pkey_export_to_file($privateKey, $privateKeyPath) === false) { 62 echo "エラー: 秘密鍵のファイルへのエクスポートに失敗しました。\n"; 63 unlink($opensslConfigPath); 64 exit(1); 65} 66echo "秘密鍵をファイルに保存しました: {$privateKeyPath}\n"; 67 68// 4. 新しいCSR (Certificate Signing Request) を生成します。 69// 'config' オプションでopenssl.cnfファイルを指定することで、その設定がCSR生成に反映されます。 70$csr = openssl_csr_new($dn, $privateKey, [ 71 'config' => $opensslConfigPath, 72 'digest_alg' => 'sha256', // 使用するハッシュアルゴリズム 73]); 74 75if ($csr === false) { 76 echo "エラー: CSRの生成に失敗しました。\n"; 77 // openssl_error_string() で詳細なエラーを取得可能 78 while ($msg = openssl_error_string()) { 79 echo "OpenSSLエラー: " . $msg . "\n"; 80 } 81 unlink($opensslConfigPath); 82 unlink($privateKeyPath); 83 exit(1); 84} 85echo "CSRを生成しました。\n"; 86 87// 5. 生成したCSRをファイルにエクスポートします。 88// $outputFilename: CSRを保存するファイルのパス。 89// $no_text: trueの場合、PEM形式のCSRブロックのみが出力され、人間が読めるテキスト情報は含まれません。 90$outputFilename = __DIR__ . '/server.csr'; 91$noText = true; // PEM形式のみを出力するために true を指定 92 93echo "CSRファイルをエクスポート中...\n"; 94if (openssl_csr_export_to_file($csr, $outputFilename, $noText)) { 95 echo "成功: CSRが '{$outputFilename}' にエクスポートされました。\n"; 96 echo "\n--- 生成されたCSRの内容 (一部) ---\n"; 97 // 生成されたCSRファイルの内容を一部表示して確認 98 echo substr(file_get_contents($outputFilename), 0, 500) . "\n"; 99 echo "---------------------------------\n"; 100} else { 101 echo "エラー: CSRのエクスポートに失敗しました。\n"; 102 while ($msg = openssl_error_string()) { 103 echo "OpenSSLエラー: " . $msg . "\n"; 104 } 105} 106 107// 6. 後処理: 生成した一時ファイルを削除します。 108// 本番環境では、秘密鍵とCSRファイルは必要に応じて保持・管理してください。 109if (file_exists($opensslConfigPath)) { 110 unlink($opensslConfigPath); 111} 112if (file_exists($privateKeyPath)) { 113 unlink($privateKeyPath); 114} 115// エクスポートされたCSRファイルは確認のため残しておきます。 116// 必要なければ以下のコメントを解除して削除できます。 117// if (file_exists($outputFilename)) { 118// unlink($outputFilename); 119// } 120echo "一時ファイル (temp_openssl.cnf, private.key) を削除しました。\n"; 121 122?>
openssl_csr_export_to_file関数は、PHPで生成されたCertificate Signing Request (CSR) を指定されたファイルにエクスポートするために使用されます。CSRは、ウェブサイトなどでSSL/TLS証明書を取得する際に認証局へ提出する申請書のようなもので、公開鍵情報や組織情報などが含まれています。
このサンプルコードは、まず一時的なOpenSSL設定ファイル(openssl.cnf)を作成し、CSRに含める情報を定義する方法を示しています。その後、openssl_pkey_new関数で秘密鍵を生成し、この秘密鍵と設定ファイル、および識別名(DN)の最小限の情報を使用してopenssl_csr_new関数でCSRオブジェクトを生成する一連の流れを解説しています。
そして本関数であるopenssl_csr_export_to_fileを使って、生成されたCSRオブジェクトをファイルに保存します。この関数の第一引数$csrには、エクスポートしたいCSRオブジェクトまたはPEM形式の文字列を渡します。第二引数$output_filenameには、CSRを保存するファイルのパスを指定します。第三引数$no_textをtrueにすると、人間が読める付加情報なしのPEM形式のCSRデータのみがファイルに出力されます。関数は処理が成功するとtrueを、失敗するとfalseを返します。
システムエンジニアを目指す初心者の方にとって、このコードはSSL/TLS証明書発行プロセスにおけるCSR生成とファイル保存の基本的な流れを理解するのに役立ちます。特に、openssl.cnfを活用してCSRの内容を柔軟に設定できる点が重要です。秘密鍵の取り扱いには十分な注意が必要であることを覚えておいてください。
秘密鍵は極めて重要であり、厳重な管理と安全な場所への保管が必須です。本番環境で一時ファイルに保存することは避けてください。openssl.cnfファイルはCSR生成の設定を制御するため、本番環境では既存の安全な設定ファイルを指定し、内容を適切に管理しましょう。各処理の失敗時には、openssl_error_string()で詳細なエラー原因を確認し、必ず一時ファイルをクリーンアップする堅牢なエラーハンドリングを心がけてください。openssl_csr_export_to_file関数の$no_text引数をtrueにすると、人間が読める情報を含まないPEM形式のCSRが生成され、認証局への提出に適しています。生成されたCSRは、認証局に提出しSSL証明書を取得するために利用されます。