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

Copy
1<?php
2
3/**
4 * AES-256-CBC方式でデータの暗号化と復号化を行うサンプル関数。
5 * システムエンジニアを目指す初心者向けに、OpenSSL拡張の基本的な使用方法を示します。
6 *
7 * 注: OPENSSL_ENCODING_PEM は、通常、証明書や鍵などのPEM形式エンコーディングに
8 *     使用される定数であり、openssl_encrypt() 関数の引数としては直接使用しません。
9 *     しかし、OpenSSL拡張の一部であるため、その存在と値を示します。
10 */
11function encryptAndDecryptData(): void
12{
13    // 1. 暗号化する平文データ
14    $plaintext = "Hello, System Engineer Beginner! This is a secret message for you.";
15    echo "--- 平文データ ---\n";
16    echo $plaintext . "\n\n";
17
18    // 2. 暗号化アルゴリズムと関連パラメータの設定
19    $cipherAlgo = "aes-256-cbc"; // AES 256ビット鍵、CBCモード
20    $ivLength = openssl_cipher_iv_length($cipherAlgo); // IVの推奨バイト数を取得
21
22    // 鍵 (Key): AES-256では32バイト (256ビット) の鍵が必要です。
23    // 実際には、安全な方法で鍵を生成し、厳重に管理してください（例: KMS、環境変数）。
24    $key = openssl_random_pseudo_bytes(32); // 32バイトのランダムな鍵を生成
25
26    // 初期化ベクトル (IV): CBCモードでは16バイト (128ビット) のIVが必要です。
27    // 各暗号化操作ごとに異なるユニークなIVを使用することがセキュリティ上非常に重要です。
28    $iv = openssl_random_pseudo_bytes($ivLength); // 適切な長さのランダムなIVを生成
29
30    // 3. データ暗号化
31    // openssl_encrypt のオプション:
32    // OPENSSL_RAW_DATA: 暗号化結果をBase64エンコードせずに生データで返します。
33    //                   AES-256-CBCではPKCS7パディングが自動的に適用されます。
34    $encryptedData = openssl_encrypt(
35        $plaintext,
36        $cipherAlgo,
37        $key,
38        OPENSSL_RAW_DATA,
39        $iv
40    );
41
42    if ($encryptedData === false) {
43        echo "エラー: 暗号化に失敗しました: " . openssl_error_string() . "\n";
44        return;
45    }
46
47    echo "--- 暗号化結果 ---\n";
48    // 生データは表示できないため、Base64エンコードして表示します。
49    echo "暗号化データ (Base64): " . base64_encode($encryptedData) . "\n";
50    echo "鍵 (Base64): " . base64_encode($key) . "\n";
51    echo "IV (Base64): " . base64_encode($iv) . "\n\n";
52
53    // 4. データ復号化
54    $decryptedData = openssl_decrypt(
55        $encryptedData,
56        $cipherAlgo,
57        $key,
58        OPENSSL_RAW_DATA, // 暗号化時と同じオプションを指定
59        $iv
60    );
61
62    if ($decryptedData === false) {
63        echo "エラー: 復号化に失敗しました: " . openssl_error_string() . "\n";
64        return;
65    }
66
67    echo "--- 復号化結果 ---\n";
68    echo "復号化データ: " . $decryptedData . "\n\n";
69
70    // 5. OPENSSL_ENCODING_PEM 定数の情報 (リファレンス情報に基づく)
71    // この定数 (値: " . OPENSSL_ENCODING_PEM . ", 型: int) はOpenSSL拡張に属します。
72    // 主に openssl_csr_export() や openssl_pkcs7_sign() のように、
73    // 証明書、鍵、CSR(証明書署名要求)などの出力をPEM形式でエンコードする際に使用されます。
74    // openssl_encrypt() 関数とは直接関係ありませんが、OpenSSL拡張関連の定数として示します。
75    echo "--- OPENSSL_ENCODING_PEM 定数 ---\n";
76    echo "OPENSSL_ENCODING_PEM の値: " . OPENSSL_ENCODING_PEM . " (int)\n";
77    echo "主な用途: 証明書や鍵をPEM形式でエンコードする際に指定します。\n";
78}
79
80// サンプル関数を実行
81encryptAndDecryptData();
82
83?>

本サンプルコードは、PHPのOpenSSL拡張を利用してAES-256-CBC方式でデータを暗号化し、その後復号化する一連の流れをシステムエンジニアを目指す初心者向けに示しています。まず、暗号化したい平文データと、暗号化に必須となる鍵、そして各暗号化ごとにユニークであるべき初期化ベクトル（IV）を準備します。openssl_encrypt関数は、平文、暗号化アルゴリズム（aes-256-cbc）、鍵、IV、そしてOPENSSL_RAW_DATAオプションを引数として受け取り、暗号化された生データ（文字列）を戻り値として返します。次に、openssl_decrypt関数は、暗号化時と同じアルゴリズム、鍵、IV、オプションを用いることで、暗号化されたデータを元の平文に戻します。OPENSSL_ENCODING_PEMは、PHP 8のOpenSSL拡張に属する定数であり、その戻り値は整数型（int）です。この定数自体はopenssl_encryptやopenssl_decryptといったデータの暗号化・復号化関数とは直接関連せず、主に証明書や秘密鍵などの情報をPEM形式という特定のフォーマットでエンコードする際に指定されます。このコードは、OpenSSLの基本的な利用例と合わせて、この定数の存在と用途も紹介しています。

Copy
1<?php
2
3/**
4 * プレーンテキストを共通鍵で暗号化し、Base64エンコードされた文字列を返します。
5 *
6 * この関数は、openssl_encrypt を使用してデータの共通鍵暗号化を行います。
7 * OPENSSL_ENCODING_PEM 定数は、PEM形式のエンコーディングオプションを示す定数で、
8 * openssl_encrypt 関数では直接使用されません。通常は openssl_pkcs7_encrypt
9 * などの他のOpenSSL関数で、出力形式としてPEMを指定する際に利用されます。
10 *
11 * @param string $plainText 暗号化する平文
12 * @param string $key 暗号化に使用する鍵 (例: openssl_random_pseudo_bytes(32) で生成)
13 * @return string 暗号化され、Base64エンコードされたデータ（IVを含む）
14 * @throws Exception 暗号化に失敗した場合
15 */
16function encryptDataWithOpenSSLAndShowPemConstant(string $plainText, string $key): string
17{
18    // 暗号化アルゴリズムとIV（初期化ベクトル）の準備
19    $cipherAlgo = 'aes-256-cbc'; // 共通鍵暗号アルゴリズムの指定
20    $ivLength = openssl_cipher_iv_length($cipherAlgo);
21    if ($ivLength === false) {
22        throw new Exception("IV長の取得に失敗しました。");
23    }
24    // IVは毎回ランダムに生成し、暗号文と一緒に渡す必要があります。
25    $iv = openssl_random_pseudo_bytes($ivLength);
26    if ($iv === false) {
27        throw new Exception("IVの生成に失敗しました。");
28    }
29
30    // openssl_encrypt関数によるデータ暗号化
31    // OPENSSL_RAW_DATA フラグは、暗号文がバイナリ形式で返されることを示します。
32    $encrypted = openssl_encrypt($plainText, $cipherAlgo, $key, OPENSSL_RAW_DATA, $iv);
33
34    if ($encrypted === false) {
35        throw new Exception("データの暗号化に失敗しました。エラー: " . openssl_error_string());
36    }
37
38    // 暗号化されたバイナリデータとIVをBase64エンコードして結合し、テキスト形式で扱えるようにします。
39    // IVは復号時に必要なので、暗号文と共に保存・転送します。
40    $encodedEncryptedData = base64_encode($iv . $encrypted);
41
42    // OPENSSL_ENCODING_PEM 定数の値を出力（情報提供のため）
43    // この定数は openssl_encrypt 関数では直接使用されませんが、
44    // 他のOpenSSL関数でPEM形式を扱う際のフラグとして利用されます。
45    echo "--- OPENSSL_ENCODING_PEM 定数情報 ---\n";
46    echo "名前: OPENSSL_ENCODING_PEM\n";
47    echo "値: " . OPENSSL_ENCODING_PEM . " (int型)\n";
48    echo "--------------------------------------\n\n";
49
50    return $encodedEncryptedData;
51}
52
53// === 使用例 ===
54try {
55    $dataToEncrypt = "システムエンジニアを目指す初心者の皆さん、PHPのOpenSSL拡張機能を学びましょう！";
56    // AES-256-CBC には256ビット (32バイト) の鍵が必要です。
57    // 鍵は安全に管理されるべきです。ここでは例としてランダムに生成しています。
58    $encryptionKey = openssl_random_pseudo_bytes(32);
59
60    // データの暗号化を実行
61    $encryptedResult = encryptDataWithOpenSSLAndShowPemConstant($dataToEncrypt, $encryptionKey);
62    echo "暗号化されたデータ (Base64エンコード, IV含む): " . $encryptedResult . "\n\n";
63
64    // --- 復号化の例（参考として、暗号化とセットで動作を確認） ---
65    // 暗号化されたデータからIVと実際の暗号文を分離
66    $decodedData = base64_decode($encryptedResult);
67    $cipherAlgo = 'aes-256-cbc';
68    $ivLength = openssl_cipher_iv_length($cipherAlgo);
69    if ($ivLength === false) {
70        throw new Exception("復号時のIV長の取得に失敗しました。");
71    }
72    $iv = substr($decodedData, 0, $ivLength);
73    $encryptedPayload = substr($decodedData, $ivLength);
74
75    // openssl_decrypt関数によるデータ復号化
76    // 暗号化時と同じ鍵、IV、アルゴリズム、フラグを使用します。
77    $decryptedText = openssl_decrypt($encryptedPayload, $cipherAlgo, $encryptionKey, OPENSSL_RAW_DATA, $iv);
78
79    if ($decryptedText === false) {
80        throw new Exception("データの復号化に失敗しました。エラー: " . openssl_error_string());
81    }
82
83    echo "復号化されたデータ: " . $decryptedText . "\n";
84
85} catch (Exception $e) {
86    echo "エラーが発生しました: " . $e->getMessage() . "\n";
87}

このサンプルコードは、PHPのOpenSSL拡張機能を使用してデータを共通鍵で暗号化する方法と、OPENSSL_ENCODING_PEM定数の役割について説明しています。encryptDataWithOpenSSLAndShowPemConstant関数は、入力された平文（$plainText）を秘密の共通鍵（$key）で暗号化し、その結果をBase64エンコードされた文字列として返します。この関数では、openssl_encrypt関数を使用し、共通鍵暗号アルゴリズム（例：aes-256-cbc）と、毎回ランダムに生成される初期化ベクトル（IV）を用いてデータを暗号化します。暗号化されたバイナリデータは、復号に必要なIVと共にBase64エンコードされ、関数の戻り値となります。

OPENSSL_ENCODING_PEM定数は、OpenSSL拡張機能が提供する整数型の定数です。本サンプルコードでは、この定数の値が情報として出力されていますが、openssl_encrypt関数自体では直接使用されません。この定数は、主にopenssl_pkcs7_encryptのような、OpenSSLに関連する他の関数で、暗号化されたデータの出力形式をPEM形式に指定する際に利用されるものです。引数$plainTextは暗号化したい元の文字列、$keyは暗号化と復号化の両方に用いる秘密鍵です。戻り値は、復号時に必要となるIVを含んだ、Base64エンコード済みの暗号化データです。