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

Copy
1<?php
2
3/**
4 * openssl_pkcs7_encrypt を使用してデータを暗号化するサンプル
5 *
6 * この関数は、PKCS7 (S/MIME) 形式でデータを暗号化する一連の流れを示します。
7 * 暗号化には公開鍵証明書が必要なため、このサンプル内では
8 * テスト目的で自己署名証明書を動的に生成しています。
9 */
10function encryptDataWithPkcs7(): void
11{
12    // --- 1. 準備 ---
13
14    // 暗号化する平文データ
15    $plainData = 'これは暗号化される秘密のメッセージです。';
16
17    // S/MIMEメッセージに含めるヘッダ情報
18    $headers = [
19        'To' => 'recipient@example.com',
20        'From' => 'sender@example.com',
21        'Subject' => '秘密のメッセージ (暗号化済)',
22    ];
23
24    // 一時的に使用するファイルパスを準備
25    $inputFile = tempnam(sys_get_temp_dir(), 'p7_in_');
26    $outputFile = tempnam(sys_get_temp_dir(), 'p7_out_');
27
28    // 平文データを入力ファイルに書き込む
29    file_put_contents($inputFile, $plainData);
30
31
32    // --- 2. 暗号化に使用する証明書の生成 (テスト用) ---
33    // 通常、証明書は認証局(CA)から取得するか、事前に準備しておきます。
34    // このサンプルでは、テストのために自己署名証明書を動的に生成します。
35
36    // 秘密鍵を生成
37    $privateKey = openssl_pkey_new([
38        'private_key_bits' => 2048,
39        'private_key_type' => OPENSSL_KEYTYPE_RSA,
40    ]);
41    if ($privateKey === false) {
42        echo 'エラー: 秘密鍵の生成に失敗しました。' . PHP_EOL;
43        return;
44    }
45
46    // 証明書署名要求(CSR)を生成
47    $csr = openssl_csr_new(['commonName' => 'example.com'], $privateKey);
48    if ($csr === false) {
49        echo 'エラー: CSRの生成に失敗しました。' . PHP_EOL;
50        return;
51    }
52
53    // CSRに自己署名して証明書(x509)を生成
54    $certificate = openssl_csr_sign($csr, null, $privateKey, 365);
55    if ($certificate === false) {
56        echo 'エラー: 自己署名証明書の生成に失敗しました。' . PHP_EOL;
57        return;
58    }
59
60
61    // --- 3. openssl_pkcs7_encrypt を使用して暗号化を実行 ---
62
63    echo '暗号化処理を実行します...' . PHP_EOL;
64    $isSuccess = openssl_pkcs7_encrypt(
65        $inputFile,             // (string) 暗号化するデータを含むファイル
66        $outputFile,            // (string) 暗号化されたデータの出力先ファイル
67        $certificate,           // (OpenSSLCertificate) 暗号化に使用する公開鍵証明書
68        $headers,               // (array) S/MIMEヘッダ
69        0,                      // (int) フラグ (オプション)
70        OPENSSL_CIPHER_AES256_CBC // (int) 暗号化アルゴリズム (オプション)
71    );
72
73
74    // --- 4. 結果の確認と後処理 ---
75
76    if ($isSuccess) {
77        echo '暗号化に成功しました。' . PHP_EOL . PHP_EOL;
78        echo '--- 暗号化されたデータ (S/MIME形式) ---' . PHP_EOL;
79        echo file_get_contents($outputFile);
80        echo PHP_EOL;
81        echo '----------------------------------------' . PHP_EOL;
82    } else {
83        echo '暗号化に失敗しました。' . PHP_EOL;
84        // OpenSSLのエラーキューから詳細なエラーメッセージを取得
85        while ($msg = openssl_error_string()) {
86            echo $msg . PHP_EOL;
87        }
88    }
89
90    // 作成した一時ファイルを削除
91    unlink($inputFile);
92    unlink($outputFile);
93}
94
95// サンプル関数を実行
96encryptDataWithPkcs7();

openssl_pkcs7_encrypt関数は、公開鍵証明書を使って、指定されたファイルをPKCS7（S/MIME）形式で暗号化するためのものです。この形式は主に安全な電子メールの送受信などで利用されます。

サンプルコードでは、まず暗号化したい平文データとメッセージヘッダを準備し、平文を一時ファイルに書き込みます。暗号化には受信者の公開鍵証明書が不可欠ですが、この例ではテスト目的で自己署名証明書をその場で生成して使用しています。

関数の呼び出し部分が実際の暗号化処理です。第1引数に平文データが入った入力ファイルパス、第2引数に暗号化データを出力するファイルパスを指定します。第3引数には暗号化に用いる公開鍵証明書を、第4引数にはS/MIMEメッセージに含めるヘッダ情報を配列で渡します。オプションの第6引数で、OPENSSL_CIPHER_AES256_CBCのような具体的な暗号化アルゴリズムを指定することも可能です。

この関数の戻り値はbool型で、処理が成功すればtrueを、失敗すればfalseを返します。成功した場合、第2引数で指定した出力ファイルには、ヘッダ情報と共に暗号化されたデータがS/MIME形式で書き込まれます。