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

Copy
1<?php
2
3/**
4 * AES-256-CBC でデータを暗号化するサンプルコード
5 *
6 * @param string $data 暗号化するデータ
7 * @param string $passphrase 暗号化に使用するパスフレーズ
8 * @return string|false 暗号化されたデータ、またはエラー時に false
9 */
10function encryptData(string $data, string $passphrase): string|false
11{
12    $cipher_algo = 'aes-256-cbc'; // 暗号化アルゴリズム
13    $ivlen = openssl_cipher_iv_length($cipher_algo); // IV の長さを取得
14    $iv = openssl_random_pseudo_bytes($ivlen); // IV を生成
15
16    $encrypted = openssl_encrypt(
17        $data,
18        $cipher_algo,
19        $passphrase,
20        OPENSSL_RAW_DATA,
21        $iv
22    );
23
24    if ($encrypted === false) {
25        return false; // 暗号化に失敗した場合
26    }
27
28    // IV を先頭に追加して、復号時に利用できるようにする
29    $ciphertext_raw = $iv . $encrypted;
30    $hmac = hash_hmac('sha256', $ciphertext_raw, $passphrase, true);
31
32    // HMAC を付加
33    $ciphertext = base64_encode($ciphertext_raw . $hmac);
34
35    return $ciphertext;
36}
37
38// 利用例
39$data = "This is a secret message.";
40$passphrase = "my_secret_passphrase";
41
42$encrypted_data = encryptData($data, $passphrase);
43
44if ($encrypted_data !== false) {
45    echo "Encrypted data: " . $encrypted_data . PHP_EOL;
46} else {
47    echo "Encryption failed." . PHP_EOL;
48}

このサンプルコードは、PHPのopenssl_encrypt関数を使用して、AES-256-CBCアルゴリズムでデータを暗号化する方法を示しています。openssl_encrypt関数は、指定された暗号化アルゴリズム、パスフレーズ、および初期化ベクトル（IV）を使用して、データ文字列を暗号化します。

encryptData関数は、暗号化するデータ $data とパスフレーズ $passphrase を引数として受け取ります。まず、使用する暗号化アルゴリズム $cipher_algo を aes-256-cbc に設定し、openssl_cipher_iv_length関数でIVの長さを取得します。次に、openssl_random_pseudo_bytes関数を使用してランダムなIVを生成します。

openssl_encrypt関数を呼び出す際、OPENSSL_RAW_DATAオプションを指定することで、暗号化されたデータをバイナリ形式で取得します。暗号化に失敗した場合は false を返します。成功した場合、生成したIVを暗号化されたデータの先頭に追加し、復号時に利用できるようにします。さらに、HMAC（Hash-based Message Authentication Code）を計算し、暗号化されたデータに付加することで、データの改ざんを検知できるようにしています。最後に、base64_encode関数でエンコードして、暗号化されたデータを返します。

サンプルコードでは、"This is a secret message."という文字列を、"my_secret_passphrase"というパスフレーズで暗号化する例を示しています。暗号化が成功した場合、暗号化されたデータが出力されます。失敗した場合は、"Encryption failed."と表示されます。戻り値は、暗号化された文字列または false です。

Copy
1<?php
2
3/**
4 * 指定されたデータをBlowfish CBCモードで暗号化します。
5 * 暗号化されたデータと初期化ベクトル (IV) はBase64エンコードされ、
6 * IVが暗号化データに連結された形式で返されます。
7 *
8 * @param string $data 暗号化する平文データ。
9 * @param string $passphrase 暗号化に使用する秘密鍵（パスフレーズ）。
10 * @return string|false 暗号化されたBase64エンコード文字列、または失敗した場合は false。
11 */
12function encryptDataBlowfish(string $data, string $passphrase): string|false
13{
14    $cipher_algo = 'bf-cbc'; // Blowfish CBCモードを指定
15
16    // IV (Initialization Vector) の長さを取得
17    $iv_length = openssl_cipher_iv_length($cipher_algo);
18    if ($iv_length === false) {
19        return false; // IV長取得に失敗した場合
20    }
21
22    // セキュアなランダムなIVを生成
23    // IVは毎回異なる値を使用し、復号化のために暗号化データと一緒に保存される必要があります。
24    $iv = openssl_random_pseudo_bytes($iv_length);
25    if ($iv === false) {
26        return false; // IV生成に失敗した場合
27    }
28
29    // openssl_encrypt を使用してデータを暗号化
30    // OPENSSL_RAW_DATA オプションを指定することで、生のバイナリデータが返されます。
31    // IVは引数として渡します。
32    $encrypted_raw = openssl_encrypt($data, $cipher_algo, $passphrase, OPENSSL_RAW_DATA, $iv);
33
34    if ($encrypted_raw === false) {
35        return false; // 暗号化に失敗した場合
36    }
37
38    // 復号化のためにIVと暗号化された生データを結合し、全体をBase64エンコードして返します。
39    // IVを先頭に結合することで、復号化時に容易に取り出せます。
40    return base64_encode($iv . $encrypted_raw);
41}
42
43// --- 使用例 ---
44$original_data = "これは秘密にしたいデータです。パスワードや個人情報などを想定しています。";
45// 実際のアプリケーションでは、より強力でセキュアな鍵生成方法を使用してください。
46$secret_key = "your_very_strong_and_secret_key_here";
47
48// データを暗号化
49$encrypted_output = encryptDataBlowfish($original_data, $secret_key);
50
51if ($encrypted_output !== false) {
52    echo "元のデータ: " . $original_data . "\n";
53    echo "暗号化されたデータ (Base64エンコード): " . $encrypted_output . "\n";
54} else {
55    echo "データの暗号化に失敗しました。\n";
56}

PHPのopenssl_encrypt関数は、指定されたデータを安全に暗号化するための重要な機能を提供します。バージョン8.4.12のextensionの一部として利用でき、データの機密性を保護する際に活用されます。

この関数は、暗号化したい元のデータ $data、使用する暗号アルゴリズム $cipher_algo（例えばBlowfishのbf-cbcなど）、そして暗号化に用いる秘密鍵 $passphrase を主な引数として受け取ります。セキュリティを確保するためには、初期化ベクトル（IV）である $iv を毎回ランダムに生成し、異なる値を使用することが非常に重要です。また、OPENSSL_RAW_DATAのような $options を指定することで、戻り値の形式を制御できます。

暗号化が成功した場合、この関数は暗号化されたデータを含む文字列を返しますが、処理に失敗した場合は false が返されます。

提供されたサンプルコードでは、bf-cbcアルゴリズムを用いてデータを暗号化するencryptDataBlowfish関数を定義しています。まずopenssl_cipher_iv_lengthでIVの適切な長さを取得し、openssl_random_pseudo_bytesでセキュアなIVを生成します。そして、このIVと秘密鍵、そしてOPENSSL_RAW_DATAオプションを指定してopenssl_encryptを実行します。最終的に、復号化に必要なIVと暗号化された生データを連結し、全体をBase64エンコードして返しています。これにより、暗号化されたデータを安全に転送・保存できるようになります。

Copy
1<?php
2
3/**
4 * データの暗号化と復号化を行うサンプル関数です。
5 * openssl_encrypt 関数を使用してデータを暗号化し、openssl_decrypt 関数で復号化します。
6 * OPENSSL_RAW_DATA オプションを使用し、初期化ベクトル (IV) の生成と管理も示します。
7 *
8 * @param string $plaintext 暗号化したい元のテキストデータ。
9 * @param string $password 暗号化と復号化に使用する秘密のパスワード (鍵)。
10 * @return void 結果を標準出力に表示します。
11 */
12function encryptAndDecryptExample(string $plaintext, string $password): void
13{
14    // 使用する暗号アルゴリズムを選択します。AES-256-CBCは広く使われている堅牢な選択肢です。
15    $cipherAlgo = 'aes-256-cbc';
16
17    // 選択したアルゴリズムに必要な初期化ベクトル (IV) の長さを取得します。
18    // IVは暗号化ごとにユニークである必要がありますが、秘密にする必要はありません。
19    // 暗号文と一緒に保存または送信する必要があります。
20    $ivLength = openssl_cipher_iv_length($cipherAlgo);
21    if ($ivLength === false) {
22        echo "エラー: IVの長さを取得できませんでした。\n";
23        return;
24    }
25
26    // 暗号学的に安全なランダムなIVを生成します。
27    $iv = openssl_random_pseudo_bytes($ivLength);
28    if ($iv === false) {
29        echo "エラー: IVの生成に失敗しました。\n";
30        return;
31    }
32
33    echo "--- 暗号化処理 ---\n";
34    echo "元のプレーンテキスト: " . $plaintext . "\n";
35    echo "使用するアルゴリズム: " . $cipherAlgo . "\n";
36    echo "生成されたIV (Hex): " . bin2hex($iv) . "\n";
37
38    // openssl_encrypt 関数でデータを暗号化します。
39    // OPENSSL_RAW_DATA オプションは、出力がBase64エンコードされていない生データであることを指定します。
40    // そのため、保存や送信のために別途Base64エンコードする必要があります。
41    $encryptedRaw = openssl_encrypt(
42        $plaintext,
43        $cipherAlgo,
44        $password,
45        OPENSSL_RAW_DATA, // ここで OPENSSL_RAW_DATA オプションを使用します。
46        $iv
47    );
48
49    if ($encryptedRaw === false) {
50        echo "エラー: 暗号化に失敗しました。詳細: " . openssl_error_string() . "\n";
51        return;
52    }
53
54    // 生の暗号化データはバイナリなので、表示や保存のためにBase64エンコードします。
55    $encodedEncryptedData = base64_encode($encryptedRaw);
56    echo "暗号化されたデータ (Base64): " . $encodedEncryptedData . "\n\n";
57
58    echo "--- 復号化処理 ---\n";
59
60    // Base64エンコードされた暗号文を元のバイナリ形式に戻します。
61    $decodedEncryptedData = base64_decode($encodedEncryptedData);
62
63    // openssl_decrypt 関数でデータを復号化します。
64    // 暗号化時と同じアルゴリズム、パスワード、IV、そして OPENSSL_RAW_DATA オプションを使用する必要があります。
65    $decryptedData = openssl_decrypt(
66        $decodedEncryptedData,
67        $cipherAlgo,
68        $password,
69        OPENSSL_RAW_DATA, // 暗号化時と一致させる必要があります。
70        $iv
71    );
72
73    if ($decryptedData === false) {
74        echo "エラー: 復号化に失敗しました。詳細: " . openssl_error_string() . "\n";
75        return;
76    }
77
78    echo "復号化されたデータ: " . $decryptedData . "\n";
79
80    // 復号化されたデータが元のプレーンテキストと一致するか確認します。
81    if ($plaintext === $decryptedData) {
82        echo "結果: 暗号化と復号化が成功しました！\n";
83    } else {
84        echo "結果: 暗号化または復号化に失敗しました！データが一致しません。\n";
85    }
86}
87
88// --- サンプルコードの実行 ---
89$myPlaintext = "この秘密のメッセージはシステムエンジニア初心者向けのPHP暗号化例です。";
90$myPassword = "あなたの非常に強力で秘密のパスワード！これを安全に保管してください！"; // 実際のアプリケーションでは、より安全な方法で鍵を管理してください。
91
92encryptAndDecryptExample($myPlaintext, $myPassword);
93
94?>

PHPのopenssl_encrypt関数は、指定されたデータを強力な暗号化アルゴリズムとパスワード（鍵）を用いて安全に暗号化するために使用されます。この関数は、暗号化したいデータ本体 $data、使用する暗号化アルゴリズム $cipher_algo（例えば 'aes-256-cbc'）、そして秘密のパスワード $passphrase を必須の引数として受け取ります。

特に重要なのは、暗号化のたびにユニークな初期化ベクトル（IV） $iv を提供することです。これはセキュリティを確保するために不可欠で、通常は openssl_cipher_iv_length で長さを取得し、openssl_random_pseudo_bytes で安全に生成します。IV自体は秘密にする必要はありませんが、暗号文と一緒に保存または転送する必要があります。

$options 引数には OPENSSL_RAW_DATA を指定することが一般的です。これにより、関数は生のバイナリデータとして暗号文を返します。この生データは、画面表示やテキストファイルへの保存には適さないため、base64_encode 関数などでBase64エンコードして扱う必要があります。

関数の戻り値は、暗号化に成功した場合に生のバイナリ形式の暗号化された文字列を返し、失敗した場合は false を返します。暗号化されたデータは、openssl_decrypt 関数を使用し、暗号化時と同じ $cipher_algo、$passphrase、$iv、そして OPENSSL_RAW_DATA オプションを用いて正確に復号化されます。これにより、元のデータが安全に復元されます。