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

Copy
1<?php
2
3/**
4 * この関数は、PHPのSodium拡張にある
5 * SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING 定数を使用して、
6 * パディングなしのBase64文字列をバイナリデータにデコードする方法を示します。
7 *
8 * システムエンジニアを目指す方へ:
9 * Base64エンコーディングは、バイナリデータをテキスト形式に変換する一般的な方法です。
10 * ファイルの内容や暗号化されたデータなどを、データベースやURL、JSONなどで安全に扱うためによく使われます。
11 * Sodium拡張は、強力な暗号機能を提供するライブラリ「libsodium」のPHP実装です。
12 * この定数は、特定のBase64フォーマット（パディングなしのオリジナル版）を指定する際に利用されます。
13 */
14function decodeBase64WithoutPadding(): void
15{
16    // Sodium拡張がPHPにロードされているかを確認します。
17    // この拡張が利用できない場合、関連する関数や定数は動作しません。
18    if (!extension_loaded('sodium')) {
19        echo "エラー: Sodium拡張がロードされていません。\n";
20        echo "php.iniファイルで 'extension=sodium' を有効にしてください。\n";
21        return;
22    }
23
24    echo "--- SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING の使用例 ---\n\n";
25
26    // 1. デコードする元のバイナリデータを準備します。
27    // 通常、これは暗号化されたデータや特定のバイナリコンテンツなどになります。
28    $originalBinaryData = random_bytes(24); // 24バイトのランダムなバイナリデータを作成
29    echo "元のバイナリデータ (16進数): " . bin2hex($originalBinaryData) . "\n";
30    echo "元のバイナリデータの長さ: " . strlen($originalBinaryData) . "バイト\n\n";
31
32    // 2. 元のバイナリデータを、SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING形式でBase64エンコードします。
33    // sodium_bin2base64 関数は、バイナリデータを指定されたBase64バリアントでエンコードします。
34    // このバリアントは、末尾にパディング文字 '=' を含みません。
35    $encodedBase64String = sodium_bin2base64($originalBinaryData, SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING);
36    echo "エンコードされたBase64文字列: " . $encodedBase64String . "\n";
37    echo "（この文字列にはパディング文字 '=' が含まれていないことに注目してください。）\n\n";
38
39    // 3. エンコードされたBase64文字列をバイナリデータにデコードします。
40    // sodium_base642bin 関数は、Base64文字列をバイナリデータに変換します。
41    // 4番目の引数に SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING を指定することで、
42    // エンコード時に使用したのと同じパディングなしのオリジナルBase64フォーマットを期待していることを伝えます。
43    // 2番目と3番目の引数 (output_buffer_size, ignore) は、この例ではnullで十分です。
44    $decodedBinaryData = sodium_base642bin($encodedBase64String, null, null, SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING);
45
46    echo "デコードされたバイナリデータ (16進数): " . bin2hex($decodedBinaryData) . "\n";
47    echo "デコードされたバイナリデータの長さ: " . strlen($decodedBinaryData) . "バイト\n\n";
48
49    // 4. 元のデータとデコードされたデータが一致するか検証します。
50    if ($originalBinaryData === $decodedBinaryData) {
51        echo "結果: 成功！ 元のバイナリデータとデコードされたバイナリデータは完全に一致します。\n";
52    } else {
53        echo "結果: 失敗！ データが一致しませんでした。\n";
54    }
55}
56
57// 関数を実行して、Base64デコードのデモンストレーションを開始します。
58decodeBase64WithoutPadding();
59
60?>

PHPのSodium拡張が提供するSODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDINGは、Base64エンコードされたデータをバイナリデータに戻す際に、パディング文字（=）を含まない「オリジナル」形式のBase64を指定するための定数です。この定数自体は整数値（int）を返します。Base64エンコーディングは、画像や暗号化されたデータのようなバイナリ情報を、テキスト形式しか扱えないシステム（URL、JSON、データベースなど）で安全に送信・保存するために広く利用される変換手法です。

サンプルコードでは、まずランダムなバイナリデータをこの定数が示す形式でBase64エンコードします。次に、そのパディングなしのBase64文字列を、sodium_base642bin関数とこの定数を用いて元のバイナリデータにデコードする過程を示しています。sodium_base642bin関数は、デコードしたいBase64文字列、そしてデコード形式を指定するこの定数などを引数として受け取り、対応するバイナリデータを戻り値として返します。この定数を指定することで、関数はパディングのないオリジナル形式のBase64文字列を正確に解釈し、データ破損なく元のバイナリデータへ復元することが可能になります。システムにおいてBase64で表現されたデータを取り扱う際に、正しい形式を指定することは非常に重要です。

Copy
1<?php
2
3/**
4 * バイナリデータを、パディングなしのオリジナルBase64形式でエンコードします。
5 *
6 * SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING 定数は、
7 * sodium_bin2base64 関数で使用されるBase64のバリアント（種類）を指定します。
8 * この定数を指定すると、エンコードされた文字列の末尾にパディング文字（=）が追加されません。
9 *
10 * @param string $binaryData エンコードするバイナリデータ（例: 文字列、ハッシュ値など）
11 * @return string Base64（パディングなし）でエンコードされた文字列
12 * @throws Error libsodium 拡張が有効でない場合に発生する可能性があります。
13 */
14function encodeDataWithoutPadding(string $binaryData): string
15{
16    // sodium_bin2base64 関数を使用してバイナリデータをBase64にエンコードします。
17    // 第二引数に SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING を指定することで、
18    // パディングなしのBase64形式が選択されます。
19    $encodedString = sodium_bin2base64(
20        $binaryData,
21        SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING
22    );
23
24    return $encodedString;
25}
26
27// エンコードする元のデータを用意します。
28// 例として、シンプルな文字列を使用します。
29$originalData = 'This is a test string for Base64 encoding without padding.';
30
31echo "元のデータ: " . $originalData . PHP_EOL;
32
33// 関数を呼び出してデータをエンコードします。
34$encodedResult = encodeDataWithoutPadding($originalData);
35
36echo "Base64 (パディングなし): " . $encodedResult . PHP_EOL;
37
38// 比較のために、PHPの標準関数 base64_encode も使用して、
39// パディング（=）が含まれることを確認できます。
40// echo "標準のBase64 (パディングあり): " . base64_encode($originalData) . PHP_EOL;
41
42?>

PHPのSODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING定数は、バイナリデータをBase64形式にエンコードする際に、特定のエンコード方式を指定するために使用されます。この定数は、特にsodium_bin2base64関数と組み合わせて利用され、エンコードされた文字列の末尾に通常追加されるパディング文字「=」を含まないBase64形式を選択します。

サンプルコードでは、encodeDataWithoutPaddingという関数を通じてこの定数の利用方法を示しています。この関数は、引数として渡された$binaryDataというバイナリデータをBase64形式に変換します。$binaryDataはエンコードしたい任意の文字列やハッシュ値などです。変換の際にSODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING定数をsodium_bin2base64関数の第二引数に指定することで、パディングなしのBase64エンコードが実行されます。

これにより、戻り値として、元のデータがパディング「=」なしでエンコードされた文字列が得られます。このパディングなしのBase64形式は、URLセーフなデータ転送や、特定のAPI要件などで役立つことがあります。もしlibsodium拡張がPHP環境で有効でない場合、エラーが発生する可能性がありますので、利用時には拡張が有効になっていることをご確認ください。