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

Copy
1<?php
2
3/**
4 * PHPのSodium拡張機能の利用可能性とLibsodiumライブラリのメジャーバージョンを表示します。
5 * システムエンジニアを目指す初心者向けに、暗号化ライブラリのバージョン情報を
6 * 取得する方法の基本的な「使い方」を示します。
7 */
8function displaySodiumLibraryVersion(): void
9{
10    // Sodium拡張機能がPHP環境にロードされているかを確認します。
11    // 暗号化機能を使用する前に、このチェックを行うことが推奨されます。
12    if (extension_loaded('sodium')) {
13        echo "Sodium拡張機能は有効です。\n";
14
15        // SODIUM_LIBRARY_MAJOR_VERSION 定数からLibsodiumライブラリの
16        // メジャーバージョン番号を取得し、表示します。
17        // この定数は整数値を返します。
18        echo "Libsodiumライブラリのメジャーバージョン: " . SODIUM_LIBRARY_MAJOR_VERSION . "\n";
19    } else {
20        echo "Sodium拡張機能は有効ではありません。\n";
21        echo "Libsodiumライブラリのバージョン情報は取得できません。";
22        echo "PHPの設定を確認し、Sodium拡張機能を有効にしてください。\n";
23    }
24}
25
26// 定義した関数を実行し、結果を表示します。
27displaySodiumLibraryVersion();

このPHPサンプルコードは、暗号化処理を行うLibsodiumライブラリのメジャーバージョン情報を取得し、表示する方法を紹介しています。まず、extension_loaded関数を使って、PHPに暗号化機能を追加するSodium拡張機能が現在の環境で有効になっているかを確認します。暗号化機能を利用する際には、このチェックを行うことが推奨されます。

Sodium拡張機能が有効な場合、SODIUM_LIBRARY_MAJOR_VERSIONという定数が使用されます。この定数はLibsodiumライブラリのメジャーバージョン番号を整数値（int）として返します。定数であるため、引数を指定する必要はありません。コードでは、この取得したバージョン番号が画面に出力されます。もしSodium拡張機能が有効でない場合は、その旨と、拡張機能を有効にするための案内が表示されます。

このように、このコードは、システムエンジニアを目指す初心者がPHPで暗号化関連の機能を利用する際に、基盤となる拡張機能の有効性を確認し、そのバージョン情報を取得する基本的な「使い方」を理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * PHPのSodium拡張ライブラリのメジャーバージョンを取得します。
5 *
6 * Sodiumは、暗号化、ハッシュ、署名などのセキュアな暗号処理を提供する
7 * PHPの標準ライブラリ（libnacl / libsodium）のラッパーです。
8 * この関数は、現在利用可能なSodiumライブラリの主要バージョンを返します。
9 *
10 * @return string Sodiumライブラリのメジャーバージョン、または拡張機能が利用できない旨のメッセージ。
11 */
12function getSodiumLibraryMajorVersion(): string
13{
14    // Sodium拡張がロードされているか確認します。
15    // extension_loaded() はPHPの拡張機能が有効になっているかチェックする関数です。
16    if (extension_loaded('sodium')) {
17        // SODIUM_LIBRARY_MAJOR_VERSION定数にアクセスします。
18        // これはlibresodiumライブラリのメジャーバージョンを示す整数値です。
19        $version = SODIUM_LIBRARY_MAJOR_VERSION;
20
21        return "Sodiumライブラリのメジャーバージョン: " . $version;
22    } else {
23        return "Sodium拡張がロードされていません。PHPの設定を確認してください。";
24    }
25}
26
27// 関数の実行と結果の表示
28echo getSodiumLibraryMajorVersion();
29echo PHP_EOL; // 改行コードを追加
30
31?>

PHPのSodium拡張は、暗号化、ハッシュ、デジタル署名といったセキュリティ関連の処理を安全に行うためのライブラリです。このサンプルコードは、そのSodium拡張が内部で利用しているC言語のライブラリ（libsodium）のメジャーバージョン番号を取得する方法を示しています。

SODIUM_LIBRARY_MAJOR_VERSIONは、Sodium拡張が使用しているライブラリの主要なバージョンを示す定数です。この定数は何の引数も取らず、現在のメジャーバージョンを整数値（int）として返します。

コードではまず、extension_loaded('sodium')関数を使って、PHPにSodium拡張が正しくロードされているかを確認しています。拡張機能が有効な場合、SODIUM_LIBRARY_MAJOR_VERSION定数にアクセスし、その整数値を取得します。その後、そのバージョン番号を含むメッセージを文字列として返します。もしSodium拡張がロードされていない場合は、その旨のメッセージが返されます。

このように、バージョン情報を取得することで、現在利用している環境でどのバージョンのSodiumライブラリが使われているかを確認できます。セキュリティ関連の処理を行う上で、互換性や既知の脆弱性対策のためにバージョン情報は重要な情報となります。