【PHP8.x】Phar::OPENSSL定数の使い方

Copy
1<?php
2
3/**
4 * OpenSSLを利用して暗号化されたデータを復号化します。
5 *
6 * この関数は、指定されたキーと暗号化方式（cipher method）を用いて、
7 * Base64エンコードされたIVと暗号文の組み合わせを復号化します。
8 *
9 * @param string $encryptedDataBase64 IVと暗号文をコロンで区切り、それぞれBase64エンコードした文字列（例: "base64_iv:base64_ciphertext"）
10 * @param string $key 暗号化に使用された秘密鍵（例: 32バイトのランダムな文字列）
11 * @param string $cipherMethod 使用するOpenSSL暗号化方式（例: 'aes-256-cbc'）
12 * @return string|false 復号化された平文データ、または復号化に失敗した場合はfalse
13 */
14function decryptWithOpenssl(string $encryptedDataBase64, string $key, string $cipherMethod = 'aes-256-cbc'): string|false
15{
16    // 暗号文がIVと本体でコロンで区切られていることを想定
17    $parts = explode(':', $encryptedDataBase64);
18    if (count($parts) !== 2) {
19        return false; // 不正なデータ形式
20    }
21
22    // Base64エンコードされたIVと暗号文をデコード
23    $base64Iv = $parts[0];
24    $base64Ciphertext = $parts[1];
25
26    $iv = base64_decode($base64Iv);
27    $ciphertext = base64_decode($base64Ciphertext);
28
29    // IVの長さが正しいか検証
30    $ivLength = openssl_cipher_iv_length($cipherMethod);
31    if ($ivLength === false || strlen($iv) !== $ivLength) {
32        return false; // IVの長さが不正
33    }
34
35    // openssl_decrypt関数で復号化を実行
36    // OPENSSL_RAW_DATAフラグは、暗号文が生のバイナリデータであることを示します。
37    $decryptedData = openssl_decrypt(
38        $ciphertext,
39        $cipherMethod,
40        $key,
41        OPENSSL_RAW_DATA,
42        $iv
43    );
44
45    return $decryptedData;
46}
47
48// --- 使用例 ---
49
50// 暗号化に使用する秘密鍵
51// 本番環境では、このキーは安全な方法で生成・管理されるべきです。
52// AES-256-CBCの場合、256ビット（32バイト）のキーが推奨されます。
53$secretKey = 'a_secure_32_byte_key_for_encryption!';
54
55// 暗号化方式
56$cipherAlgo = 'aes-256-cbc';
57
58// 復号化したい元の平文データ
59$originalPlaintext = 'システムエンジニアの皆さん、PHPはセキュアな開発をサポートします！';
60
61// --- (参考) 復号化のためには、まず暗号化されたデータが必要なので、ここで作成します。 ---
62// 実際のアプリケーションでは、この暗号化されたデータは外部から取得されることが一般的です。
63
64// IV (Initialization Vector) を生成
65// IVは毎回異なるランダムな値を使用し、暗号文と一緒に保存または送信する必要があります。
66$ivLength = openssl_cipher_iv_length($cipherAlgo);
67$iv = openssl_random_pseudo_bytes($ivLength);
68
69// データを暗号化
70// OPENSSL_RAW_DATAフラグは、暗号文が生のバイナリ形式で返されることを意味します。
71$encryptedRawData = openssl_encrypt(
72    $originalPlaintext,
73    $cipherAlgo,
74    $secretKey,
75    OPENSSL_RAW_DATA,
76    $iv
77);
78
79// IVと暗号文をBase64エンコードし、コロンで連結して保存・転送可能な形式にする
80$encodedEncryptedData = base64_encode($iv) . ':' . base64_encode($encryptedRawData);
81
82echo "元の平文データ: " . $originalPlaintext . PHP_EOL;
83echo "暗号化されたデータ (Base64エンコード): " . $encodedEncryptedData . PHP_EOL . PHP_EOL;
84
85// --- 復号化の実行 ---
86echo "--- 復号化の実行 ---" . PHP_EOL;
87$decryptedPlaintext = decryptWithOpenssl($encodedEncryptedData, $secretKey, $cipherAlgo);
88
89if ($decryptedPlaintext !== false) {
90    echo "復号化されたデータ: " . $decryptedPlaintext . PHP_EOL;
91    if ($originalPlaintext === $decryptedPlaintext) {
92        echo "✅ 復号化されたデータは元のデータと一致します。" . PHP_EOL;
93    } else {
94        echo "❌ 復号化されたデータが元のデータと一致しません。" . PHP_EOL;
95    }
96} else {
97    echo "❌ 復号化に失敗しました。キー、IV、または暗号文が正しくない可能性があります。" . PHP_EOL;
98}

PHPのPhar::OPENSSL定数は、Phar形式のアーカイブがOpenSSLによって署名されているかどうかを示すための整数値の定数です。Pharアーカイブのセキュリティ関連情報を示す際に利用されます。

一方、提示されたサンプルコードは、PHPのOpenSSL拡張機能の中核であるopenssl_decrypt関数を利用して、暗号化されたデータを元の平文に戻す方法を示しています。このサンプルでは、decryptWithOpensslというカスタム関数が、暗号化されたデータ（Base64エンコードされたIVと暗号文をコロンで連結したもの）、秘密鍵、そして暗号化方式（例: 'aes-256-cbc'）を受け取り、復号処理を実行します。

関数内部では、openssl_decrypt関数が実際に使われます。この関数は、復号する暗号文、使用された暗号化方式、秘密鍵、OPENSSL_RAW_DATAなどのオプション、そして初期化ベクトル（IV）を引数に取ります。OPENSSL_RAW_DATAは、入力される暗号文が生のバイナリ形式であることを指示する整数値の定数です。処理が成功すると復号された平文データが文字列として返され、失敗した場合にはfalseが返されます。

使用例では、安全に管理すべき秘密鍵と暗号化方式を定義し、暗号化されたデータ（デモのために生成されたIVと暗号文を連結しBase64エンコードしたもの）をdecryptWithOpenssl関数で復号し、元の平文と一致するかどうかを確認することで、復号処理が正しく行われたことを示しています。このように、PHPのOpenSSL拡張機能は、機密性の高いデータを安全に扱うための強力な手段を提供します。

Copy
1<?php
2
3/**
4 * データをOpenSSLで暗号化または復号化します。
5 *
6 * @param string $data       処理するオリジナルまたは暗号化されたデータ。
7 * @param string $cipherAlgo 使用する暗号化アルゴリズム（例: 'aes-256-cbc'）。
8 * @param string $key        暗号化/復号化に使用する秘密鍵。
9 * @param string $iv         初期化ベクトル。
10 * @param bool   $encrypt    trueの場合データを暗号化し、falseの場合復号化します。
11 * @return string|false      成功した場合は処理されたデータ、失敗した場合はfalse。
12 */
13function handleOpenSslEncryption(
14    string $data,
15    string $cipherAlgo,
16    string $key,
17    string $iv,
18    bool $encrypt = true
19): string|false {
20    if ($encrypt) {
21        // openssl_encrypt 関数を使用してデータを暗号化します。
22        // 第4引数の0はOPENSSL_RAW_DATAフラグ（生データとして返す）を指定しています。
23        return openssl_encrypt($data, $cipherAlgo, $key, 0, $iv);
24    } else {
25        // openssl_decrypt 関数を使用してデータを復号化します。
26        // 第4引数の0はOPENSSL_RAW_DATAフラグ（生データを期待する）を指定しています。
27        return openssl_decrypt($data, $cipherAlgo, $key, 0, $iv);
28    }
29}
30
31// --- 暗号化と復号化の例 ---
32
33// 使用する暗号化アルゴリズム
34$cipherAlgo = 'aes-256-cbc';
35
36// ランダムな秘密鍵を生成（セキュリティ上、毎回ユニークなものを使用することが推奨されます）
37$secretKey = openssl_random_pseudo_bytes(32); // AES-256 の場合32バイト (256ビット)
38
39// 初期化ベクトル (IV) を生成（セキュリティ上、毎回ユニークなものを使用することが推奨されます）
40$iv = openssl_random_pseudo_bytes(openssl_cipher_iv_length($cipherAlgo));
41
42// 暗号化したい元のデータ
43$originalData = "システムエンジニアを目指す皆様へ、PHPの学習は楽しいです！";
44echo "元のデータ: " . $originalData . PHP_EOL;
45
46// データを暗号化
47$encryptedData = handleOpenSslEncryption($originalData, $cipherAlgo, $secretKey, $iv, true);
48
49if ($encryptedData === false) {
50    echo "エラー: データの暗号化に失敗しました。" . PHP_EOL;
51} else {
52    // 暗号化されたデータはバイナリデータなので、表示のためにBase64エンコードします
53    echo "暗号化されたデータ (Base64エンコード): " . base64_encode($encryptedData) . PHP_EOL;
54
55    // 暗号化されたデータを復号化
56    $decryptedData = handleOpenSslEncryption($encryptedData, $cipherAlgo, $secretKey, $iv, false);
57
58    if ($decryptedData === false) {
59        echo "エラー: データの復号化に失敗しました。" . PHP_EOL;
60    } else {
61        echo "復号化されたデータ: " . $decryptedData . PHP_EOL;
62    }
63}
64
65// --- Phar::OPENSSL 定数について ---
66// Phar::OPENSSL は、Pharアーカイブの署名タイプがOpenSSLであることを示す定数です。
67// これはopenssl_encrypt関数とは直接的な関連はありませんが、
68// どちらもPHPのOpenSSL拡張機能（およびPhar拡張機能がOpenSSLを利用する機能）の一部として提供されます。
69// この定数は整数値を持ちます。
70echo PHP_EOL;
71echo "Phar::OPENSSL の値: " . Phar::OPENSSL . PHP_EOL;
72
73?>

このPHPサンプルコードは、OpenSSL拡張機能を用いてデータを安全に暗号化し、また元の状態に復号化する方法を示しています。handleOpenSslEncryption関数は、openssl_encrypt関数を使用してデータを暗号化し、openssl_decrypt関数を使用して復号化を行います。これらの関数は、処理するデータ、使用する暗号化アルゴリズム、秘密鍵、そして初期化ベクトル（IV）を引数として受け取ります。成功時には加工されたデータを文字列として返し、失敗した場合はfalseを返します。セキュリティを確保するため、秘密鍵とIVは毎回ユニークでランダムなものを生成して使用することが推奨されます。暗号化されたデータはバイナリ形式であるため、表示や転送の際にはbase64_encode関数などでBase64エンコードされることが一般的です。

コードの後半では、実際のデータ「システムエンジニアを目指す皆様へ、PHPの学習は楽しいです！」を暗号化し、その後正しく復号化する一連の流れが確認できます。

また、Phar::OPENSSLは、PHPのPhar拡張機能に定義されている定数の一つです。これは、Pharアーカイブの署名タイプがOpenSSLであることを示す整数値を持ちます。この定数はデータ暗号化に用いるopenssl_encrypt関数とは直接的な関連はありませんが、どちらもPHPのOpenSSL関連機能や、Phar拡張機能がOpenSSLを利用する機能の一部として提供されます。Phar::OPENSSLは引数を取らず、整数型を戻り値として持っています。