【PHP8.x】SodiumException::getLine()メソッドの使い方

Copy
1<?php
2
3// このファイルの名前を例えば 'sodium_example.php' として保存してください。
4// PHP 8以降がインストールされ、Sodium拡張機能が有効な環境で実行可能です。
5
6/**
7 * SodiumException::getLine() メソッドの動作を示すサンプル関数。
8 *
9 * Sodium拡張機能の操作中に発生する SodiumException を捕捉し、
10 * その例外が発生したソースコードの行番号を取得して表示します。
11 */
12function demonstrateSodiumExceptionGetLine(): void
13{
14    echo "SodiumException::getLine() メソッドのデモンストレーションを開始します。\n\n";
15
16    try {
17        // Sodiumの暗号化操作で、意図的にエラーを発生させます。
18        // まず、正しいキー、ノンス、メッセージで暗号化を行います。
19        $key = random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
20        $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
21        $originalMessage = "これは秘密のメッセージです。";
22
23        $encryptedMessage = sodium_crypto_secretbox($originalMessage, $nonce, $key);
24
25        // 次に、暗号文の一部を意図的に改ざんします。
26        // これにより、複合化時にMAC (Message Authentication Code) の検証が失敗し、
27        // SodiumException がスローされるはずです。
28        $tamperedCiphertext = $encryptedMessage;
29        // 最後のバイトを反転させることで、MACを無効化します。
30        $tamperedCiphertext[strlen($tamperedCiphertext) - 1] = chr(ord($tamperedCiphertext[strlen($tamperedCiphertext) - 1]) ^ 0xFF);
31
32        echo "不正に改ざんされた暗号文を使って復号を試みます...\n";
33
34        // この行で SodiumException がスローされることを期待します。
35        // 復号が失敗すると "mac failed" というメッセージの SodiumException が発生します。
36        sodium_crypto_secretbox_open($tamperedCiphertext, $nonce, $key);
37
38        echo "想定外: SodiumException がスローされませんでした。\n";
39
40    } catch (SodiumException $e) {
41        // SodiumException を捕捉した場合の処理
42        echo "SodiumException を捕捉しました！\n";
43        echo "  エラーメッセージ: " . $e->getMessage() . "\n";
44        echo "  エラーが発生したファイル: " . $e->getFile() . "\n";
45        // getLine() メソッドで例外が発生した行番号を取得
46        echo "  エラーが発生した行番号: " . $e->getLine() . "\n";
47    } catch (Throwable $e) {
48        // SodiumException 以外の予期せぬエラーが発生した場合の処理
49        echo "予期せぬエラー (種類: " . get_class($e) . ") を捕捉しました。\n";
50        echo "  エラーメッセージ: " . $e->getMessage() . "\n";
51        echo "  エラーが発生したファイル: " . $e->getFile() . "\n";
52        echo "  エラーが発生した行番号: " . $e->getLine() . "\n";
53    }
54
55    echo "\nデモンストレーションを終了します。\n";
56}
57
58// 関数を実行してデモンストレーションを開始
59demonstrateSodiumExceptionGetLine();
60
61?>

PHPのSodiumException::getLine()メソッドは、PHP 8以降のSodium拡張機能を利用中に発生するエラー、特にSodiumExceptionが発生した際に、その例外がソースコードのどの行で発生したかを特定するために使用されます。このメソッドは引数を必要とせず、例外が発生した行番号を整数（int）として返します。

サンプルコードでは、まずSodiumの機能を使ってメッセージを暗号化します。次に、その暗号文を故意に改ざんし、不正なデータで復号を試みることでSodiumExceptionを意図的に発生させています。try...catchブロックによってこのSodiumExceptionを捕捉し、捕捉した例外オブジェクト$eに対して$e->getLine()メソッドを呼び出しています。これにより、エラーが発生した正確なPHPコードの行番号が取得され、画面に表示されます。システム開発において、エラーの原因を迅速に特定し、効率的にデバッグ作業を進める上で、getLine()が提供する行番号の情報は非常に役立ちます。