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

Copy
1<?php
2
3/**
4 * PHPのsodium_bin2base64関数を使用して、バイナリデータをBase64エンコードするサンプルです。
5 *
6 * この関数は、Libsodium拡張が提供するsodium_bin2base64を用いて、
7 * 入力されたバイナリデータを標準的なBase64形式（RFC 4648準拠）に変換します。
8 * 主に、テキスト形式で安全にバイナリデータを転送する必要がある場合に使用されます。
9 *
10 * @return string エンコードされたBase64文字列、またはエラーメッセージを返します。
11 */
12function demonstrateSodiumBinToBase64(): string
13{
14    // sodium拡張が有効になっているかを確認します。
15    // 有効でない場合、sodium_bin2base64関数は存在しません。
16    if (!function_exists('sodium_bin2base64')) {
17        return "エラー: PHP Sodium 拡張が有効になっていません。php.iniを確認してください。";
18    }
19
20    // エンコードするサンプルバイナリデータを用意します。
21    // ここでは単純な文字列を使用していますが、実際にはファイルの内容や暗号化されたデータ、
22    // または random_bytes() で生成されたランダムなバイナリデータなどが想定されます。
23    $originalBinaryData = "Hello, world! This is a test string for Base64 encoding.";
24
25    try {
26        // sodium_bin2base64関数を呼び出し、バイナリデータをBase64エンコードします。
27        // 第1引数: エンコードしたいバイナリデータ。
28        // 第2引数: Base64エンコーディングスキームを指定する定数。
29        //         SODIUM_BASE64_VARIANT_ORIGINAL は、RFC 4648で定義されている標準的なBase64です。
30        //         他にも SODIUM_BASE64_VARIANT_URLSAFE (URLセーフなBase64) などがあります。
31        $encodedBase64 = sodium_bin2base64($originalBinaryData, SODIUM_BASE64_VARIANT_ORIGINAL);
32
33        // エンコードされた結果を文字列として返します。
34        return "元のデータ:\n'" . $originalBinaryData . "'\n\n"
35             . "Base64エンコード結果:\n'" . $encodedBase64 . "'";
36
37    } catch (Throwable $e) {
38        // 何らかの予期せぬエラーが発生した場合、エラーメッセージを返します。
39        return "Base64エンコード中にエラーが発生しました: " . $e->getMessage();
40    }
41}
42
43// 上記の関数を呼び出し、結果を標準出力に表示します。
44echo demonstrateSodiumBinToBase64();
45

PHPのsodium_bin2base64関数は、バイナリデータをBase64形式の文字列にエンコードするために利用されます。この関数は、Libsodiumというセキュリティ拡張の一部であり、暗号化されたデータや画像などのバイナリ情報を、Webページやメールといったテキストベースの環境で安全に転送・表示する際に非常に役立ちます。

関数の第一引数$stringには、Base64エンコードしたい元のバイナリデータを指定します。このデータは、ファイルの内容や乱数生成器から得られたバイト列など、さまざまなバイナリ情報を想定しています。第二引数$idは、使用するBase64エンコーディングの種類を指定するための定数です。サンプルコードで使われているSODIUM_BASE64_VARIANT_ORIGINALは、インターネットで広く使われている標準的なBase64形式（RFC 4648準拠）を指します。他にも、URLに含める際に安全な形式など、特定の用途に合わせたバリアントが選択可能です。

この関数は、指定されたバイナリデータをBase64形式の文字列としてエンコードし、その結果の文字列を戻り値として返します。ただし、sodium_bin2base64関数を利用するには、PHP環境にLibsodium拡張が正しくインストールされ、有効になっている必要があります。サンプルコードでは、関数が利用可能か事前に確認する処理も含まれており、これにより拡張が有効でない場合に適切なエラーメッセージが表示されるよう配慮されています。これにより、バイナリデータを標準的なテキスト形式に変換し、安全なデータ交換をサポートします。

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのSodium拡張機能を使用して、
5 * バイナリデータをBase64形式にエンコードし、
6 * そのBase64データを元のバイナリデータにデコードする例を示します。
7 *
8 * sodium_bin2base64: バイナリデータをBase64文字列に変換します。
9 * sodium_base642bin: Base64文字列をバイナリデータに変換します。
10 *
11 * 注: Sodium拡張機能は、通常、暗号化処理に関連して使用されますが、
12 *     この例ではデータの形式変換に焦点を当てています。
13 */
14
15// 1. エンコードする元のバイナリデータを準備します。
16//    ここでは、ランダムな32バイトのバイナリデータを生成しています。
17$originalBinaryData = random_bytes(32);
18
19echo "--- エンコード前 ---" . PHP_EOL;
20echo "元のバイナリデータ (Hex): " . bin2hex($originalBinaryData) . PHP_EOL;
21echo "元のバイナリデータ長: " . strlen($originalBinaryData) . " バイト" . PHP_EOL . PHP_EOL;
22
23// 2. sodium_bin2base64 を使用して、バイナリデータをBase64文字列にエンコードします。
24//    第2引数には、Base64のバリアント（種類）を指定します。
25//    SODIUM_BASE64_VARIANT_ORIGINAL は、RFC 4648で定義される標準的なBase64エンコード方式です。
26$encodedBase64String = sodium_bin2base64($originalBinaryData, SODIUM_BASE64_VARIANT_ORIGINAL);
27
28echo "--- エンコード後 ---" . PHP_EOL;
29echo "Base64エンコードされた文字列: " . $encodedBase64String . PHP_EOL;
30echo "Base64文字列長: " . strlen($encodedBase64String) . " 文字" . PHP_EOL . PHP_EOL;
31
32// 3. sodium_base642bin を使用して、Base64文字列を元のバイナリデータにデコードします。
33//    エンコード時と同じBase64バリアントを指定する必要があります。
34$decodedBinaryData = sodium_base642bin($encodedBase64String, SODIUM_BASE64_VARIANT_ORIGINAL);
35
36echo "--- デコード後 ---" . PHP_EOL;
37echo "デコードされたバイナリデータ (Hex): " . bin2hex($decodedBinaryData) . PHP_EOL;
38echo "デコードされたバイナリデータ長: " . strlen($decodedBinaryData) . " バイト" . PHP_EOL . PHP_EOL;
39
40// 4. 元のデータとデコードされたデータが一致するか検証します。
41if ($originalBinaryData === $decodedBinaryData) {
42    echo "検証結果: 元のバイナリデータとデコードされたデータは完全に一致します。" . PHP_EOL;
43    echo "Base64エンコード/デコード処理は成功しました。" . PHP_EOL;
44} else {
45    echo "検証結果: エラー - 元のバイナリデータとデコードされたデータが一致しません。" . PHP_EOL;
46    echo "Base64エンコード/デコード処理中に問題が発生した可能性があります。" . PHP_EOL;
47}
48

このPHPスクリプトは、PHPのSodium拡張機能が提供するsodium_bin2base64関数を使用して、バイナリデータをBase64形式の文字列に変換する方法を示しています。sodium_bin2base64関数は、第一引数にエンコードしたいバイナリデータ（文字列）を、第二引数にはBase64のエンコード方式を指定する整数値（例: SODIUM_BASE64_VARIANT_ORIGINAL）を受け取ります。そして、戻り値としてBase64エンコードされた文字列を返します。

サンプルコードでは、まずrandom_bytes関数でランダムなバイナリデータを生成し、それをsodium_bin2base64でBase64文字列に変換しています。このBase64文字列はテキストデータとして扱えるため、バイナリデータを直接扱えない通信経路やファイル形式でデータを安全にやり取りする際に役立ちます。

続けて、関連するsodium_base642bin関数を使って、エンコードされたBase64文字列を元のバイナリデータに戻すデコード処理も行っています。最後に、変換前の元のデータとデコードされたデータが完全に一致するかを検証することで、エンコードおよびデコードが正しく行われたことを確認しています。この一連の処理を通じて、バイナリデータの形式変換の基本的な流れと、その目的を理解することができます。Sodium拡張機能は主に暗号化に用いられますが、この例ではデータの形式変換に焦点を当てています。