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

Copy
1<?php
2
3/**
4 * OpenSSL 3DESアルゴリズムを使用して文字列を暗号化し、復号化するサンプル関数です。
5 * OPENSSL_CIPHER_3DES定数とopenssl_decrypt関数の使用例を示します。
6 *
7 * @param string $plaintext 暗号化・復号化する元の文字列
8 * @param string $password  暗号化・復号化に使用する秘密の鍵
9 * @return void
10 */
11function encryptAndDecryptWith3DES(string $plaintext, string $password): void
12{
13    // 使用する暗号アルゴリズム。OPENSSL_CIPHER_3DESは3DESアルゴリズムを指定します。
14    // その値は"des-ede3"のような文字列です。
15    $cipherAlgo = OPENSSL_CIPHER_3DES;
16
17    // IV (Initialization Vector) の長さを取得します。
18    // IVは暗号化のたびにユニークであるべきで、同じ平文と鍵でも異なる暗号文を生成するために使用されます。
19    $ivLength = openssl_cipher_iv_length($cipherAlgo);
20    if ($ivLength === false) {
21        echo "エラー: 暗号アルゴリズム {$cipherAlgo} のIV長を取得できませんでした。" . PHP_EOL;
22        return;
23    }
24
25    // ランダムなIVを生成します。これは暗号文と一緒に保存または送信する必要があります。
26    $iv = openssl_random_pseudo_bytes($ivLength);
27    if ($iv === false) {
28        echo "エラー: IVの生成に失敗しました。" . PHP_EOL;
29        return;
30    }
31
32    // -----------------------------------------------------------
33    // 暗号化 (openssl_encrypt)
34    // -----------------------------------------------------------
35    // openssl_encrypt関数を使用して平文を暗号化します。
36    // 第4引数に0を指定すると、デフォルトのオプション（OPENSSL_PKCS1_PADDING）が使用されます。
37    // 暗号化されたデータはバイナリデータなので、表示・保存のためにbase64エンコードします。
38    $encrypted = openssl_encrypt($plaintext, $cipherAlgo, $password, 0, $iv);
39
40    if ($encrypted === false) {
41        echo "エラー: 暗号化に失敗しました。詳細: " . openssl_error_string() . PHP_EOL;
42        return;
43    }
44    $encodedEncrypted = base64_encode($encrypted);
45    $encodedIv = base64_encode($iv);
46
47    echo "--- 暗号化 ---" . PHP_EOL;
48    echo "元の平文: " . $plaintext . PHP_EOL;
49    echo "使用アルゴリズム: " . $cipherAlgo . PHP_EOL;
50    echo "使用IV (Base64): " . $encodedIv . PHP_EOL;
51    echo "暗号文 (Base64): " . $encodedEncrypted . PHP_EOL;
52    echo PHP_EOL;
53
54    // -----------------------------------------------------------
55    // 復号化 (openssl_decrypt)
56    // -----------------------------------------------------------
57    // openssl_decrypt関数を使用して暗号文を復号化します。
58    // 暗号化時と同じアルゴリズム、パスワード、IVを使用する必要があります。
59    // 復号化する前に、base64エンコードされた暗号文とIVをデコードします。
60    $decodedEncrypted = base64_decode($encodedEncrypted);
61    $decodedIv = base64_decode($encodedIv);
62
63    $decrypted = openssl_decrypt($decodedEncrypted, $cipherAlgo, $password, 0, $decodedIv);
64
65    if ($decrypted === false) {
66        echo "エラー: 復号化に失敗しました。詳細: " . openssl_error_string() . PHP_EOL;
67        return;
68    }
69
70    echo "--- 復号化 ---" . PHP_EOL;
71    echo "復号化されたテキスト: " . $decrypted . PHP_EOL;
72
73    // 元の平文と復号化されたテキストが一致するか確認します。
74    if ($plaintext === $decrypted) {
75        echo "結果: 暗号化と復号化は成功しました！" . PHP_EOL;
76    } else {
77        echo "結果: エラーが発生しました。復号化されたテキストが元の平文と一致しません。" . PHP_EOL;
78    }
79}
80
81// サンプルコードの実行
82$originalText = "システムエンジニアを目指す皆さん、PHPのOpenSSL拡張は強力です！";
83$secretPassword = "ThisIsAStrongSecretPasswordFor3DES"; // 本番環境ではより安全な方法で鍵を管理してください。
84
85encryptAndDecryptWith3DES($originalText, $secretPassword);
86
87?>

PHPのOpenSSL拡張機能は、データを安全に処理するための重要な機能群を提供します。このサンプルコードは、OPENSSL_CIPHER_3DES定数とopenssl_decrypt関数を利用して、文字列を暗号化し、その後に復号化する一連のプロセスを初心者の方にも分かりやすく示しています。

OPENSSL_CIPHER_3DESは、暗号化に使用するアルゴリズムとして「Triple DES (3DES)」を指定するための定数です。この定数は、内部的には「des-ede3」のような文字列値を持ち、openssl_encryptやopenssl_decrypt関数に渡すことで、データ処理にどの暗号方式を適用するかを指示します。

サンプルコードでは、まず元の文字列と秘密の鍵（パスワード）を準備し、OPENSSL_CIPHER_3DESで指定されたアルゴリズムに対応する初期化ベクトル（IV）を生成します。IVは暗号化ごとにユニークであるべきランダムなデータであり、同じ平文と鍵を使用しても異なる暗号文が生成されるようにするために不可欠です。

次に、openssl_encrypt関数を使って元の文字列を暗号化します。暗号化されたデータはバイナリ形式であるため、表示したり保存したりする際にはbase64_encode関数でテキスト形式に変換しています。

最後に、openssl_decrypt関数が登場します。この関数は、暗号化されたデータを元の平文に戻す役割を担います。引数として、デコードされた暗号文、OPENSSL_CIPHER_3DESで指定したのと同じ暗号アルゴリズム、秘密の鍵、そして暗号化時に使用したIVを受け取ります。復号化が成功した場合、openssl_decryptは元の文字列を返しますが、失敗した場合はfalseを返します。暗号化と復号化には、全く同じアルゴリズム、鍵、IVを使うことが非常に重要です。このコードは、これらの要素が連携してデータの機密性を保つ仕組みを理解する上で役立ちます。

Copy
1<?php
2
3/**
4 * PHPのOpenSSL拡張機能における3DES暗号方式の
5 * IV（初期化ベクトル）長を取得するサンプルコードです。
6 *
7 * このコードは、openssl_cipher_iv_length関数を使用して、
8 * 特定の暗号方式に必要なIV（Initialization Vector）の長さを取得する方法を示します。
9 * IVは、暗号化のセキュリティを向上させるために使用されるランダムなデータです。
10 *
11 * リファレンス情報にはOPENSSL_CIPHER_3DES定数とありますが、
12 * この定数はPHP 8では削除されています。
13 * そのため、PHP 8で実際に利用可能な3DESのアルゴリズム名（例: 'DES-EDE3-CBC'）を
14 * 直接指定して動作例を示します。
15 */
16function showCipherIvLengthFor3DES(): void
17{
18    // リファレンス情報に記載のOPENSSL_CIPHER_3DES定数はPHP 8で削除されているため、
19    // PHP 8で利用可能な3DES（Triple DES）暗号方式を示す文字列リテラルを使用します。
20    // 'DES-EDE3-CBC' は、一般的な3DESのCipher Block Chainingモードを指します。
21    $cipherMethod = 'DES-EDE3-CBC';
22
23    // openssl_cipher_iv_length関数は、指定された暗号方式のIVの長さをバイト単位で返します。
24    $ivLength = openssl_cipher_iv_length($cipherMethod);
25
26    // openssl_cipher_iv_lengthがfalseを返す場合、エラーが発生したことを意味します。
27    if ($ivLength === false) {
28        echo "エラー: 暗号方式 '{$cipherMethod}' のIV長を取得できませんでした。\n";
29        echo "指定された暗号方式が無効であるか、OpenSSL拡張が正しく設定されていない可能性があります。\n";
30    } else {
31        // 取得したIV長を表示します。
32        echo "暗号方式 '{$cipherMethod}' のIV長は {$ivLength} バイトです。\n";
33    }
34}
35
36// 上で定義した関数を実行し、結果を表示します。
37showCipherIvLengthFor3DES();

このサンプルコードは、PHPのOpenSSL拡張機能を使って、特定の暗号方式で使用するIV（Initialization Vector：初期化ベクトル）の長さを取得する方法を、システムエンジニアを目指す初心者の方向けに説明しています。

IVは、暗号化のセキュリティを向上させるために利用されるランダムなデータで、同じ平文（暗号化されていないデータ）を複数回暗号化しても、毎回異なる暗号文を生成する役割があります。

リファレンス情報に示されているOPENSSL_CIPHER_3DES定数はPHP 8では削除されており、このコードではPHP 8で実際に利用可能な3DES（Triple DES）暗号方式の名前である'DES-EDE3-CBC'を文字列として直接指定しています。

openssl_cipher_iv_length関数は、引数に渡された暗号方式のIV長をバイト単位で返します。引数には、利用したい暗号方式の名称を文字列で指定します。戻り値は、成功した場合はIV長を示す整数値となりますが、指定された暗号方式が無効であるなど何らかのエラーが発生した場合はfalseを返します。このコードは、'DES-EDE3-CBC'という3DES暗号方式のIV長を取得し、その結果を画面に表示する動作を示しています。