【PHP8.x】OPENSSL_CMS_TEXT定数の使い方

Copy
1<?php
2
3/**
4 * PHP OpenSSL CMS (Cryptographic Message Syntax) 署名のサンプルコード。
5 *
6 * この関数は、指定された入力ファイルの内容を秘密鍵と証明書で署名し、
7 * CMS形式の署名済みメッセージを出力ファイルに保存します。
8 * OPENSSL_CMS_TEXT フラグを使用することで、元のテキストコンテンツを
9 * 署名済みメッセージに含めるため、検証時に元のテキストを取り出すことができます。
10 *
11 * PHPの `openssl_sign` 関数は生のデータ署名を行いますが、`OPENSSL_CMS_TEXT` 定数は
12 * `openssl_cms_sign` 関数などのCMS関連関数でのみ使用され、より高度な形式の署名を提供します。
13 */
14function createAndVerifyCmsSignature(): void
15{
16    // 一時ファイルパスの定義
17    $tempDir = sys_get_temp_dir();
18    $privateKeyFile = tempnam($tempDir, 'pk_');
19    $certificateFile = tempnam($tempDir, 'cert_');
20    $inputFile = tempnam($tempDir, 'input_');
21    $signedOutputFile = tempnam($tempDir, 'signed_');
22    $verifiedOutputFile = tempnam($tempDir, 'verified_');
23
24    // 署名する元のデータ
25    $originalData = "Hello, world! This is a secure message signed with CMS.";
26    file_put_contents($inputFile, $originalData);
27
28    echo "--- CMS署名処理の開始 ---\n";
29    echo "署名元のデータ: " . $originalData . "\n\n";
30
31    // 1. 秘密鍵と自己署名証明書の生成
32    $privateKey = openssl_pkey_new([
33        "private_key_bits" => 2048,
34        "private_key_type" => OPENSSL_KEYTYPE_RSA,
35    ]);
36    if (!$privateKey) {
37        echo "エラー: 秘密鍵の生成に失敗しました。\n";
38        cleanupTempFiles([$privateKeyFile, $certificateFile, $inputFile, $signedOutputFile, $verifiedOutputFile]);
39        return;
40    }
41    openssl_pkey_export_to_file($privateKey, $privateKeyFile);
42
43    $csr = openssl_csr_new(["commonName" => "localhost"], $privateKey);
44    $certificate = openssl_csr_sign($csr, null, $privateKey, 365, ['digest_alg' => 'sha256']);
45    if (!$certificate) {
46        echo "エラー: 自己署名証明書の生成に失敗しました。\n";
47        cleanupTempFiles([$privateKeyFile, $certificateFile, $inputFile, $signedOutputFile, $verifiedOutputFile]);
48        return;
49    }
50    openssl_x509_export_to_file($certificate, $certificateFile);
51
52    echo "秘密鍵と証明書を一時的に生成しました。\n\n";
53
54    // 2. CMS署名の生成
55    // OPENSSL_CMS_TEXT フラグは、署名されたデータに元のコンテンツを含めることを指示します。
56    // これにより、検証時に元のコンテンツが署名の一部として取り出せるようになります。
57    $isSigned = openssl_cms_sign(
58        $inputFile,
59        $signedOutputFile,
60        $certificateFile,
61        $privateKeyFile,
62        [], // 追加ヘッダー (オプション)
63        OPENSSL_CMS_TEXT // 定数: 元のテキストコンテンツを署名データに含める
64    );
65
66    if ($isSigned) {
67        echo "CMS署名付きメッセージを生成しました: " . $signedOutputFile . "\n";
68        echo "署名データ長: " . strlen(file_get_contents($signedOutputFile)) . "バイト\n\n";
69
70        // 3. CMS署名の検証
71        // 検証時にも OPENSSL_CMS_TEXT フラグを指定することで、元のテキストコンテンツを
72        // 出力ファイル ($verifiedOutputFile) に抽出できます。
73        $isVerified = openssl_cms_verify(
74            $signedOutputFile,
75            null, // 信頼された証明書チェーン (オプション)
76            null, // CA証明書 (オプション)
77            null, // 検証対象データ (nullの場合、署名済みファイルから抽出)
78            $verifiedOutputFile,
79            OPENSSL_CMS_TEXT // 検証時に元のテキストを抽出するフラグ
80        );
81
82        if ($isVerified) {
83            echo "CMS署名の検証に成功しました。\n";
84            $extractedText = file_get_contents($verifiedOutputFile);
85            echo "検証により抽出されたテキスト: " . $extractedText . "\n";
86
87            if ($extractedText === $originalData) {
88                echo "抽出されたテキストは元のデータと一致します。\n";
89            } else {
90                echo "エラー: 抽出されたテキストが元のデータと一致しません。\n";
91            }
92        } else {
93            echo "エラー: CMS署名の検証に失敗しました。\n";
94            while (($error = openssl_error_string()) !== false) {
95                echo "OpenSSLエラー: " . $error . "\n";
96            }
97        }
98    } else {
99        echo "エラー: CMS署名の生成に失敗しました。\n";
100        while (($error = openssl_error_string()) !== false) {
101            echo "OpenSSLエラー: " . $error . "\n";
102        }
103    }
104
105    echo "\n--- CMS署名処理の終了 ---\n";
106
107    // 一時ファイルのクリーンアップ
108    cleanupTempFiles([$privateKeyFile, $certificateFile, $inputFile, $signedOutputFile, $verifiedOutputFile]);
109}
110
111/**
112 * 一時ファイルを削除するヘルパー関数。
113 * @param array<string> $files 削除するファイルパスの配列。
114 */
115function cleanupTempFiles(array $files): void
116{
117    foreach ($files as $file) {
118        if (file_exists($file)) {
119            unlink($file);
120        }
121    }
122    echo "一時ファイルをクリーンアップしました。\n";
123}
124
125// 関数の実行
126createAndVerifyCmsSignature();
127
128?>

PHPの OPENSSL_CMS_TEXT 定数は、OpenSSL拡張機能が提供する整数値を持つ定数です。この定数は、主にCMS（Cryptographic Message Syntax）形式の署名に関連する関数で使用されます。

具体的には、openssl_cms_sign 関数でこの定数を使用すると、署名対象となる元のテキストコンテンツが、生成されるCMS形式の署名済みメッセージの中に含められます。これにより、署名されたメッセージ自体が元のデータと署名情報を一体として保持し、受信者が別途元のデータを用意することなく検証できるようになります。

また、openssl_cms_verify 関数でこの定数を使用すると、署名済みメッセージから埋め込まれた元のテキストコンテンツが抽出され、指定された出力ファイルに保存されます。

この定数を活用することで、署名の正当性を検証するだけでなく、署名済みのメッセージから元のテキストデータを安全かつ容易に取り出すことが可能となり、セキュリティと利便性を両立させたデータ交換のシナリオで役立ちます。生のデータ署名を行う openssl_sign 関数とは異なり、CMSというより構造化されたメッセージ形式の署名・検証に利用される点が特徴です。

Copy
1<?php
2
3/**
4 * データをOpenSSLで暗号化・復号化するデモンストレーション関数。
5 *
6 * この関数は openssl_cipher_iv_length を使用して、指定された暗号方式に必要なIVの長さを取得し、
7 * 安全な初期化ベクトル (IV) を生成します。その後、データを暗号化し、復号化する一連の流れを示します。
8 * システムエンジニアを目指す初心者の方にもOpenSSLの基本的な使い方、特にIVの重要性を理解してもらえるように設計されています。
9 *
10 * @param string $dataToEncrypt 暗号化する平文データ。
11 * @return void 結果を出力します。
12 */
13function encryptAndDecryptData(string $dataToEncrypt): void
14{
15    // 使用する暗号方式を定義します。
16    // 'aes-256-cbc' は、現在広く使われている安全な暗号方式の一つです。
17    // 256ビットの鍵長とCBC（Cipher Block Chaining）モードを使用します。
18    $cipherMethod = 'aes-256-cbc';
19
20    // 秘密鍵を生成します。
21    // 実際のアプリケーションでは、この鍵は安全な方法で生成、保存、管理される必要があります。
22    // random_bytes(32) は、256ビット（32バイト）の暗号学的に安全な乱数を鍵として生成します。
23    $key = random_bytes(32); 
24
25    echo "--- 暗号化・復号化処理の開始 ---\n";
26    echo "暗号方式: " . $cipherMethod . "\n";
27    echo "平文データ: '" . $dataToEncrypt . "'\n\n";
28
29    // openssl_cipher_iv_length 関数を使用して、指定された暗号方式に必要な初期化ベクトル (IV) の長さを取得します。
30    // IVは、同じ平文と鍵でも異なる暗号文を生成するために使用されるランダムなデータです。
31    // 暗号化ごとに異なるIVを使用することがセキュリティ上非常に重要です。
32    $ivLength = openssl_cipher_iv_length($cipherMethod);
33
34    if ($ivLength === false) {
35        echo "エラー: 指定された暗号方式 ('" . $cipherMethod . "') はサポートされていません。\n";
36        return;
37    }
38
39    echo "取得したIVの長さ: " . $ivLength . "バイト\n";
40
41    // IVの長さに基づいて、暗号学的に安全なランダムなIVを生成します。
42    // random_bytes() はPHP 7以降で推奨される安全な乱数生成関数です。
43    $iv = random_bytes($ivLength);
44
45    echo "生成されたIV (Base64エンコード): " . base64_encode($iv) . "\n\n";
46
47    // データを暗号化します。
48    // OPENSSL_RAW_DATA フラグは、暗号文をBase64エンコードせずに生バイナリデータとして取得します。
49    // 暗号化の際は、IVを公開しても問題ありません。通常、暗号文と一緒に保存・送信されます。
50    $encryptedData = openssl_encrypt(
51        $dataToEncrypt,
52        $cipherMethod,
53        $key,
54        OPENSSL_RAW_DATA, // 生データ出力
55        $iv
56    );
57
58    if ($encryptedData === false) {
59        echo "エラー: データの暗号化に失敗しました。\n";
60        return;
61    }
62
63    echo "暗号化されたデータ (Base64エンコード): " . base64_encode($encryptedData) . "\n\n";
64
65    // データを復号化します。
66    // 復号化には、暗号化時と同じ暗号方式、秘密鍵、そして同じIVが必要です。
67    $decryptedData = openssl_decrypt(
68        $encryptedData,
69        $cipherMethod,
70        $key,
71        OPENSSL_RAW_DATA, // 生データ入力
72        $iv
73    );
74
75    if ($decryptedData === false) {
76        echo "エラー: データの復号化に失敗しました。\n";
77        return;
78    }
79
80    echo "復号化されたデータ: '" . $decryptedData . "'\n\n";
81
82    // 暗号化前の元のデータと復号化されたデータを比較し、処理が成功したか検証します。
83    if ($dataToEncrypt === $decryptedData) {
84        echo "検証結果: 暗号化前と復号化後のデータは一致します。\n";
85    } else {
86        echo "検証結果: エラー！データが一致しません。\n";
87    }
88
89    echo "\n--- 処理の終了 ---\n";
90}
91
92// サンプルデータを使用して関数を実行します。
93// このコードを実行することで、OpenSSLを使用した暗号化と復号化のプロセス、
94// および openssl_cipher_iv_length の役割を実際に確認できます。
95encryptAndDecryptData("これはPHPのOpenSSL拡張機能を使った秘密のメッセージです。システムエンジニアの学習に役立つことを願っています。");
96

このサンプルコードは、PHPのOpenSSL拡張機能を用いてデータを安全に暗号化し、復号化する一連のプロセスをシステムエンジニアの初心者向けに分かりやすくデモンストレーションしています。

主要な役割を果たすのがopenssl_cipher_iv_length関数です。この関数は引数として指定された暗号方式（例: 'aes-256-cbc'）に対し、セキュリティ上不可欠な初期化ベクトル（IV）の適切な長さを整数値で返します。IVは暗号化ごとに異なる値を使用することで、同じデータと鍵から常に異なる暗号文を生成し、ブルートフォース攻撃などに対する耐性を高める重要な役割を担っています。

コードではまず、openssl_cipher_iv_lengthで取得したIVの長さに合わせて、random_bytes関数で安全なIVを生成します。その後、生成した鍵とIV、そして平文データを用いてopenssl_encrypt関数でデータを暗号化します。openssl_encryptは、暗号文をバイナリデータとして生成するため、OPENSSL_RAW_DATA定数を指定しています。暗号化されたデータは、同じ暗号方式、鍵、そしてIVを使ってopenssl_decrypt関数で元の平文に復号化されます。最終的に、復号化されたデータが元のデータと一致するかを検証し、処理の成功を確認しています。このコードを通じて、OpenSSLを使ったデータ保護の基本とIVの重要性を実践的に理解できます。