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

Copy
1<?php
2
3/**
4 * URLセーフかつパディングなしのBase64文字列をバイナリデータにデコードします。
5 *
6 * sodium_base642bin 関数と SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING 定数の使用例。
7 *
8 * @param string $encodedString デコードするBase64文字列（URLセーフ、パディングなし）。
9 * @return string デコードされたバイナリデータ。
10 * @throws RuntimeException Sodium拡張機能がロードされていない場合。
11 */
12function decodeUrlSafeBase64NoPaddingExample(string $encodedString): string
13{
14    // Sodium拡張機能がPHPにロードされているか確認します。
15    // この拡張機能がなければ、sodium_base642bin 関数は利用できません。
16    if (!extension_loaded('sodium')) {
17        throw new \RuntimeException('Sodium extension is not loaded. Please enable it in php.ini.');
18    }
19
20    // SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING 定数を使用し、
21    // 指定されたBase64文字列をバイナリデータにデコードします。
22    // この定数は、RFC 4648 Section 5 で定義されているURLおよびファイル名セーフなBase64エンコーディングを
23    // 使用し、さらにパディング文字（=）を省略することを指定します。
24    return sodium_base642bin(
25        $encodedString,
26        SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING
27    );
28}
29
30// --- サンプル使用例 ---
31
32// URLセーフでパディングなしのBase64エンコードされた文字列の例。
33// "Hello, world!" をURLセーフBase64(no padding)でエンコードしたもの。
34$sampleEncoded1 = 'SGVsbG8sIHdvcmxkIQ'; 
35
36// "PHP is great!" をURLセーフBase64(no padding)でエンコードしたもの。
37$sampleEncoded2 = 'UEhQIGlzIGdyZWF0IQ'; 
38
39// 例1: デコード処理を実行
40try {
41    $decodedData1 = decodeUrlSafeBase64NoPaddingExample($sampleEncoded1);
42    echo "エンコードされた文字列: '" . $sampleEncoded1 . "'" . PHP_EOL;
43    echo "デコードされた文字列:  '" . $decodedData1 . "'" . PHP_EOL;
44} catch (\RuntimeException $e) {
45    echo "エラー: " . $e->getMessage() . PHP_EOL;
46}
47
48// 例2: 別の文字列でデコード処理を実行
49try {
50    $decodedData2 = decodeUrlSafeBase64NoPaddingExample($sampleEncoded2);
51    echo "エンコードされた文字列: '" . $sampleEncoded2 . "'" . PHP_EOL;
52    echo "デコードされた文字列:  '" . $decodedData2 . "'" . PHP_EOL;
53} catch (\RuntimeException $e) {
54    echo "エラー: " . $e->getMessage() . PHP_EOL;
55}

このPHPコードは、Sodium拡張機能が提供するsodium_base642bin関数とSODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING定数を用いて、URLセーフかつパディングなしのBase64文字列を元のバイナリデータにデコードする方法を示しています。

SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING定数は、sodium_base642bin関数に対し、デコード対象のBase64文字列が「URLやファイル名で安全に扱えるよう一部の記号が置き換えられ、さらに末尾のパディング文字『=』が省略された形式である」ことを指定するための整数値です。

decodeUrlSafeBase64NoPaddingExample関数は、デコードするBase64文字列を引数として受け取ります。この関数は、まずPHPにSodium拡張機能がロードされているかを確認し、拡張機能がない場合は実行時エラーを発生させます。

その後、sodium_base642bin関数を呼び出し、引数として渡されたBase64文字列とSODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING定数を渡してデコード処理を実行します。sodium_base642bin関数は、この指定された形式に基づいてBase64文字列をバイナリデータに変換し、その結果の文字列を戻り値として返します。この戻り値は、元の平文データとなります。サンプルコードでは、エンコードされた文字列が正しく元の文字列に復元される様子が確認できます。

Copy
1<?php
2
3/**
4 * SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING 定数と
5 * sodium_bin2base64 関数を使用して、バイナリデータを
6 * URLセーフでパディングなしのBase64形式にエンコードする例です。
7 *
8 * このエンコード方式は、URLやファイル名など、特殊文字やパディングが
9 * 問題となる場所で安全に文字列を使用するために設計されています。
10 */
11function demonstrateUrlsafeNoPaddingBase64Encoding(): void
12{
13    // エンコード対象となるバイナリデータを用意します。
14    // 例として、16バイトのランダムなデータを生成します。
15    $binaryData = random_bytes(16);
16
17    echo "元のバイナリデータ (16進数): " . bin2hex($binaryData) . PHP_EOL;
18
19    // sodium_bin2base64 関数を使って、バイナリデータをBase64文字列に変換します。
20    // 第二引数に SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING 定数を指定することで、
21    // URLセーフかつ末尾のパディング記号（=）を含まない形式でエンコードされます。
22    $encodedString = sodium_bin2base64($binaryData, SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING);
23
24    echo "URLセーフBase64エンコード結果 (パディングなし): " . $encodedString . PHP_EOL;
25
26    // SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING 定数はint型です。
27    // その値を確認することもできます。
28    echo "定数 SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING の値: " . SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING . PHP_EOL;
29}
30
31// 関数を実行して、エンコードの動作を確認します。
32demonstrateUrlsafeNoPaddingBase64Encoding();
33

このPHPコードは、バイナリデータをURLで安全に扱えるBase64形式に変換する方法を示しています。SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDINGは、PHP 8のSodium拡張機能が提供する定数で、Base64エンコードの際に「URLで安全な文字セットを使用し、かつ末尾のパディング記号（=）を付けない」方式を指定するための整数値（int）です。

この定数をsodium_bin2base64関数の第二引数に渡すことで、エンコードしたいバイナリデータ（第一引数）がこの特定のルールに基づいてBase64文字列に変換されます。sodium_bin2base64関数は、指定されたバイナリデータをBase64形式の文字列に変換し、その結果の文字列を戻り値として返します。

通常、Base64エンコードされた文字列には、URLやファイル名で使用すると問題を引き起こす可能性がある特殊文字（スラッシュ/やプラス+など）やパディングのイコール=が含まれることがあります。このSODIUM_BASE64_VARIANT_URLSAFE_NO_PADDINGを用いたエンコード方式は、これらの特殊文字を避けて、URLの一部やファイル名などで安全にデータを表現できるように設計されています。サンプルコードでは、ランダムなバイナリデータをこの方式でエンコードし、その結果を表示しています。