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

openssl_pkcs12_export_to_file関数は、秘密鍵と証明書をPKCS#12形式のファイルとしてエクスポートする関数です。PKCS#12は、秘密鍵、公開鍵証明書、中間証明書などを一つのファイルにまとめて格納するための標準的な形式であり、セキュリティ関連で広く利用されています。これにより、複数の要素を個別に管理する手間が省け、証明書と鍵のペアをより安全かつ簡単に配布・利用できます。

この関数は、例えばWebサーバーのSSL/TLS証明書やクライアント認証用の証明書を、異なるシステムやアプリケーションに移行する際に特に有用です。元の証明書と秘密鍵のデータに加え、出力先のファイルパス、そして生成されるPKCS#12ファイルを保護するためのパスワードを指定して呼び出します。関数が成功すれば、指定されたパスワードで暗号化されたPKCS#12形式の証明書バンドルファイルが作成されます。失敗した場合はfalseが返されます。

利用に際しては、秘密鍵やパスワードは非常に機密性の高い情報であるため、厳重な管理が不可欠です。ファイルの権限設定を適切に行い、パスワードの漏洩には最大限の注意を払う必要があります。この関数を活用することで、PHPアプリケーションから証明書関連の処理をセキュアに実行することが可能になります。

Copy
1<?php
2// エクスポートする証明書（OpenSSLAsymmetricKeyオブジェクトまたはPEM形式の文字列）
3$certificate = /* ... 証明書データ ... */;
4
5// PKCS#12ファイルの出力先ファイル名
6$outputFilename = 'path/to/your_certificate.p12';
7
8// 証明書に関連付けられた秘密鍵（OpenSSLAsymmetricKeyオブジェクトまたはPEM形式の文字列）
9$privateKey = /* ... 秘密鍵データ ... */;
10
11// PKCS#12ファイルを保護するためのパスフレーズ
12$passphrase = 'your_secure_password';
13
14// openssl_pkcs12_export_to_file 関数の呼び出し構文
15$success = openssl_pkcs12_export_to_file(
16    $certificate,
17    $outputFilename,
18    $privateKey,
19    $passphrase
20);
21
22// オプション引数を含める場合の例（必要であれば追加）
23/*
24$options = [
25    'pkcs12_key_alg' => OPENSSL_ALGO_SHA256,
26    // その他のオプション
27];
28$successWithOptions = openssl_pkcs12_export_to_file(
29    $certificate,
30    $outputFilename,
31    $privateKey,
32    $passphrase,
33    $options
34);
35*/
36?>

OpenSSLCertificate|string $certificate, string $output_filename, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, string $passphrase, array $options = []

• OpenSSLCertificate|string $certificate: エクスポートする証明書オブジェクトまたは証明書ファイルパスを指定します。
• string $output_filename: PKCS#12 ファイルの出力先ファイルパスを指定します。
• OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key: 証明書に対応する秘密鍵オブジェクト、秘密鍵ファイルパス、または秘密鍵の配列を指定します。
• string $passphrase: PKCS#12 ファイルを保護するためのパスフレーズを指定します。
• array $options = []: エクスポートオプションを指定する連想配列（オプション）。

bool

この関数は、PKCS#12形式の証明書および秘密鍵をファイルにエクスポートする処理が成功したかどうかを真偽値（trueまたはfalse）で返します。