Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】openssl_cms_decrypt()関数の使い方

openssl_cms_decrypt関数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

openssl_cms_decrypt関数は、Cryptographic Message Syntax (CMS) 形式で暗号化されたデータを復号する関数です。CMSは、デジタル署名や暗号化されたメッセージ(デジタルエンベロープ)など、情報を安全にやり取りするための標準的な暗号メッセージ構文であり、特に機密性の高いデータの送受信で広く利用されています。

この関数は、外部から受け取ったCMS形式の暗号化メッセージを、指定された受信者の証明書とそれに紐づく秘密鍵を用いて、元の平文データに戻す役割を担います。具体的には、暗号化されたデータ本体、復号の対象となる受信者の証明書ファイルまたは文字列、そしてその証明書に対応する秘密鍵のパスまたは内容を引数として受け取ります。また、復号された平文データを保存するための出力ファイルパスも指定できます。

復号処理が成功すると、暗号化されていたデータが安全に元の形式で取り出され、指定された出力先に書き込まれます。もし、証明書や秘密鍵が一致しない場合、データが破損している場合、またはその他のセキュリティ上の問題がある場合には、復号に失敗し、falseが返されます。この関数は、例えばS/MIMEを用いたメールの暗号化解除や、セキュアなデータ交換プロトコルにおいて、受信した機密情報を安全に閲覧するために不可欠な機能を提供します。システム開発において、データの機密性を保ちつつ、信頼できる通信を実現する際に重要な役割を果たします。

構文(syntax)

1<?php
2openssl_cms_decrypt(
3    'path/to/input_encrypted_file.cms',
4    'path/to/output_decrypted_file.txt',
5    'path/to/certificate.pem',
6    'path/to/private_key.pem'
7);
8?>

引数(parameters)

string $inputFilename, string $outputFilename, OpenSSLCertificate|string $certificate, OpenSSLAsymmetricKey|string|array|null $privateKey = null, int $encoding = OPENSSL_CMS_BINARY

  • string $inputFilename: 複合化するCMSメッセージが格納されているファイルパス
  • string $outputFilename: 複合化されたメッセージの出力先ファイルパス
  • OpenSSLCertificate|string $certificate: 複合化に使用する署名証明書
  • OpenSSLAsymmetricKey|string|array|null $privateKey = null: 複合化に使用する秘密鍵(証明書が公開鍵のみの場合に必要)
  • int $encoding = OPENSSL_CMS_BINARY: 複合化に使用するエンコーディング(例: OPENSSL_CMS_BINARY、OPENSSL_CMS_TEXT)

戻り値(return)

bool

openssl_cms_decrypt 関数は、CMSメッセージの復号化に成功したかどうかを示す真偽値(bool)を返します。復号化が成功した場合は true を、失敗した場合は false を返します。

サンプルコード

PHPでCMSファイルを開封する

1<?php
2
3/**
4 * CMS (Cryptographic Message Syntax) 形式で暗号化されたファイルを復号化します。
5 *
6 * この関数は、指定された入力ファイルを、提供された証明書と秘密鍵を使用して復号化し、
7 * その結果を新しい出力ファイルに保存します。
8 *
9 * @param string $inputFilename 入力ファイル (暗号化されたCMSデータ) のパス。
10 * @param string $outputFilename 出力ファイル (復号化されたデータ) のパス。
11 * @param string $certificateFilename 復号化に使用する証明書ファイルのパス。
12 * @param string $privateKeyFilename 復号化に使用する秘密鍵ファイルのパス。
13 * @return bool 復号化が成功した場合は true、失敗した場合は false。
14 */
15function decryptCmsFile(
16    string $inputFilename,
17    string $outputFilename,
18    string $certificateFilename,
19    string $privateKeyFilename
20): bool {
21    // 必要なファイルが存在するかを確認します。
22    if (!file_exists($inputFilename)) {
23        echo "エラー: 入力ファイル '{$inputFilename}' が見つかりません。\n";
24        return false;
25    }
26    if (!file_exists($certificateFilename)) {
27        echo "エラー: 証明書ファイル '{$certificateFilename}' が見つかりません。\n";
28        return false;
29    }
30    if (!file_exists($privateKeyFilename)) {
31        echo "エラー: 秘密鍵ファイル '{$privateKeyFilename}' が見つかりません。\n";
32        return false;
33    }
34
35    // openssl_cms_decrypt を使用してファイルを復号化します。
36    // 第3引数には復号化用の証明書、第4引数には対応する秘密鍵を指定します。
37    // 第5引数はオプションで、デフォルトのエンコーディング (OPENSSL_CMS_BINARY) を使用します。
38    $success = openssl_cms_decrypt(
39        $inputFilename,
40        $outputFilename,
41        $certificateFilename,
42        $privateKeyFilename
43    );
44
45    if ($success) {
46        echo "ファイル '{$inputFilename}' は正常に復号化され、'{$outputFilename}' に保存されました。\n";
47    } else {
48        echo "エラー: ファイルの復号化に失敗しました。\n";
49        // OpenSSL のエラーキューから詳細なエラー情報を取得し表示します。
50        while ($msg = openssl_error_string()) {
51            echo "OpenSSL エラー: " . $msg . "\n";
52        }
53    }
54
55    return $success;
56}
57
58// --- サンプルコードの実行 ---
59// このコードを実行する前に、以下のファイルがカレントディレクトリに存在する必要があります。
60// 1. `encrypted.cms`: openssl_cms_encrypt などで事前に暗号化されたCMS形式のファイル。
61// 2. `cert.pem`: 暗号化時に使用された証明書 (公開鍵を含む) のファイル。
62// 3. `key.pem`: `cert.pem` に対応する秘密鍵のファイル。
63
64// 復号化処理に使用する仮想的なファイルパスを設定します。
65$inputCmsFile = 'encrypted.cms';
66$outputDecryptedFile = 'decrypted.txt';
67$certificateFile = 'cert.pem';
68$privateKeyFile = 'key.pem';
69
70// 復号化処理を実行します。
71decryptCmsFile($inputCmsFile, $outputDecryptedFile, $certificateFile, $privateKeyFile);
72

PHPのopenssl_cms_decrypt関数は、CMS (Cryptographic Message Syntax) 形式で暗号化されたファイルを復号化するために使用されます。この関数は、特定の入力ファイルを、指定された証明書と秘密鍵のペアを用いて元のデータに戻し、その結果を新しい出力ファイルに保存します。

引数としては、まず$inputFilenameで暗号化されたCMSデータのファイルパスを指定します。次に$outputFilenameで復号化されたデータを書き出すファイルパスを指定します。復号化に必要となるのは$certificate(公開鍵を含む証明書ファイル)と、それに対応する$privateKey(秘密鍵ファイル)です。これらの鍵情報が正しく提供されることで復号化が可能になります。$encoding引数はオプションで、データのエンコーディング形式を指定しますが、通常はデフォルト値が使われます。

関数が正常に復号化を完了した場合はtrueを、何らかの理由で失敗した場合はfalseを戻り値として返します。サンプルコードでは、decryptCmsFile関数が定義されており、encrypted.cmsという暗号化ファイルを、cert.pemとkey.pemを用いて復号化し、decrypted.txtとして出力する一連の流れが示されています。ファイル存在チェックやエラー時のOpenSSLメッセージ表示など、堅牢な処理が考慮されています。

この関数は、CMS (Cryptographic Message Syntax) 形式で暗号化されたデータを復号化するために使用します。通常の暗号化・復号化関数であるopenssl_decryptとは用途が異なる点にご注意ください。復号化には、暗号化時に使用された証明書と、それに紐づく秘密鍵の両方が必須です。これらファイルが存在しない場合や、鍵ペアが正しくない場合は復号化に失敗します。特に秘密鍵は、情報漏洩を防ぐため厳重に管理し、アクセス制限をかけるなど、安全な取り扱いを徹底してください。復号化が失敗した際は、openssl_error_string()関数でOpenSSLのエラーキューから詳細な情報を取得し、原因を特定することが重要です。

PHPでIV付きデータ暗号化・復号する

1<?php
2
3/**
4 * データを暗号化し、その暗号化されたデータをIVと共に復号するプロセスを示す関数。
5 * 主にopenssl_encrypt、openssl_decrypt、およびIV(Initialization Vector)の使用方法を実演します。
6 *
7 * @param string $data         暗号化する元の文字列データ。
8 * @param string $key          暗号化/復号に使用する秘密鍵。
9 *                             使用する暗号メソッドに応じて適切な長さである必要があります(例: AES-256-CBCでは32バイト)。
10 * @param string $cipherMethod 使用する暗号化メソッド(例: 'aes-256-cbc')。
11 * @return array|false         成功した場合は、元のデータ、IVを含むBase64エンコードされた暗号文、
12 *                             および検証のための復号済みデータを含む配列を返します。
13 *                             失敗した場合は false を返します。
14 */
15function encryptAndDecryptWithIvExample(string $data, string $key, string $cipherMethod = 'aes-256-cbc'): array|false
16{
17    // 1. IV (Initialization Vector) を生成する
18    // IVの長さは使用する暗号メソッドに依存します。
19    $ivLength = openssl_cipher_iv_length($cipherMethod);
20    if ($ivLength === false) {
21        // サポートされていない暗号メソッドの場合
22        error_log("Cipher method '{$cipherMethod}' is not supported or IV length cannot be determined.");
23        return false;
24    }
25
26    // 暗号学的に安全なランダムバイトでIVを生成します。
27    // IVは暗号化ごとにユニークである必要があり、秘密である必要はありません。
28    $iv = openssl_random_pseudo_bytes($ivLength);
29    if ($iv === false) {
30        error_log("Failed to generate IV.");
31        return false;
32    }
33
34    // 2. データを暗号化する (openssl_encrypt)
35    // OPENSSL_RAW_DATA オプションは、パディングを適用せず、生データとして暗号化結果を返します。
36    // IVは暗号化プロセスに不可欠です。
37    $encryptedData = openssl_encrypt($data, $cipherMethod, $key, OPENSSL_RAW_DATA, $iv);
38    if ($encryptedData === false) {
39        error_log("Failed to encrypt data. OpenSSL error: " . openssl_error_string());
40        return false;
41    }
42
43    // 実際のアプリケーションでは、IVは暗号化されたデータと共に保存または転送される必要があります。
44    // 一般的な方法として、IVを暗号化データに連結し、全体をBase64エンコードします。
45    $encodedDataWithIv = base64_encode($iv . $encryptedData);
46
47    // 3. 暗号化されたデータを復号する (openssl_decrypt)
48    // 復号のためには、暗号化時と同じ秘密鍵、暗号メソッド、そして同じIVが必要です。
49
50    // まず、Base64デコードし、IVと暗号化されたデータを分離します。
51    $decodedDataWithIv = base64_decode($encodedDataWithIv);
52    if ($decodedDataWithIv === false) {
53        error_log("Failed to base64 decode data for decryption.");
54        return false;
55    }
56
57    $retrievedIv = substr($decodedDataWithIv, 0, $ivLength);
58    $retrievedEncryptedData = substr($decodedDataWithIv, $ivLength);
59
60    // openssl_decrypt を使ってデータを復号します。
61    // 暗号化時と同じ引数を指定することが重要です。
62    $decryptedData = openssl_decrypt($retrievedEncryptedData, $cipherMethod, $key, OPENSSL_RAW_DATA, $retrievedIv);
63    if ($decryptedData === false) {
64        error_log("Failed to decrypt data. OpenSSL error: " . openssl_error_string());
65        return false;
66    }
67
68    // 復号されたデータが元のデータと一致するか検証します。
69    if ($decryptedData !== $data) {
70        error_log("Decrypted data does not match original data. Data integrity compromised or wrong key/IV used.");
71        return false;
72    }
73
74    return [
75        'original_data' => $data,
76        'encrypted_data_with_iv_base64' => $encodedDataWithIv,
77        'decrypted_data_for_verification' => $decryptedData,
78        'used_iv_base64' => base64_encode($iv), // 参考として使用されたIVも返します
79    ];
80}
81
82// ----------------------------------------------------
83// 関数使用例
84// ----------------------------------------------------
85
86// 秘密鍵を生成します。AES-256の場合、32バイト(256ビット)の鍵が必要です。
87$secretKey = openssl_random_pseudo_bytes(32);
88if ($secretKey === false) {
89    die("Error: Failed to generate secret key." . PHP_EOL);
90}
91
92$originalMessage = "こんにちは、これは秘密のメッセージです。";
93$cipherMethod = 'aes-256-cbc';
94
95echo "■ 元のメッセージ:\n" . $originalMessage . PHP_EOL . PHP_EOL;
96
97// 暗号化と復号のプロセスを実行します。
98$result = encryptAndDecryptWithIvExample($originalMessage, $secretKey, $cipherMethod);
99
100if ($result !== false) {
101    echo "■ 暗号化されたデータ (Base64エンコード済み、IV含む):\n" . $result['encrypted_data_with_iv_base64'] . PHP_EOL . PHP_EOL;
102    echo "■ 復号されたデータ (検証用):\n" . $result['decrypted_data_for_verification'] . PHP_EOL . PHP_EOL;
103    echo "■ 使用されたIV (Base64エンコード済み):\n" . $result['used_iv_base64'] . PHP_EOL . PHP_EOL;
104
105    // 検証結果の表示
106    if ($result['original_data'] === $result['decrypted_data_for_verification']) {
107        echo "■ 検証結果: 成功。復号されたデータは元のデータと一致します。" . PHP_EOL;
108    } else {
109        echo "■ 検証結果: 失敗。復号されたデータが元のデータと一致しません。" . PHP_EOL;
110    }
111} else {
112    echo "エラー: 暗号化または復号に失敗しました。ログを確認してください。" . PHP_EOL;
113}
114

このPHPサンプルコードは、openssl_encryptとopenssl_decrypt関数を用いて、データの暗号化と復号を行うプロセスを実演しています。特に、暗号化に不可欠なInitialization Vector (IV) の生成と利用方法に焦点を当てています。

encryptAndDecryptWithIvExample関数は、暗号化する元の文字列データ、秘密鍵、そして使用する暗号メソッド(デフォルトは'aes-256-cbc')を引数として受け取ります。まず、openssl_cipher_iv_lengthで適切なIVの長さを取得し、openssl_random_pseudo_bytesを用いて暗号学的に安全なIVを生成します。このIVは暗号化ごとにユニークである必要があり、暗号化されたデータとともに保存・転送されますが、秘密にする必要はありません。

次に、openssl_encrypt関数で元のデータを暗号化し、その結果と生成したIVを連結してBase64エンコードします。これにより、暗号文とIVがひとつの文字列として安全に扱われます。

復号の際は、Base64デコードされた文字列からIVと暗号化されたデータを分離します。その後、openssl_decrypt関数に暗号化されたデータ、秘密鍵、暗号メソッド、そして分離したIVを渡してデータを復号します。

最後に、復号されたデータが元のデータと一致するかを検証し、プロセスが正しく実行されたことを確認します。関数は成功した場合、元のデータ、Base64エンコードされた暗号文、および復号済みデータを含む配列を返します。失敗した場合はfalseを返します。

このサンプルコードは、データを安全に暗号化・復号するための基本的な手順とIV(初期化ベクトル)の適切な扱い方を示しています。IVは毎回異なるものを生成することが非常に重要で、暗号化されたデータと一緒に安全に保存または転送してください。秘密鍵は決して漏洩しないよう厳重に管理し、使用する暗号メソッド(例:AES-256-CBC)に合わせた適切な長さの鍵を使用する必要があります。また、openssl_encryptやopenssl_decryptなどの関数は、処理に失敗した場合にfalseを返すため、必ず戻り値をチェックし、エラーハンドリングを丁寧に行うことが、安全なシステム構築には不可欠です。

関連コンテンツ

関連IT用語

関連プログラミング言語