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

Copy
1<?php
2
3// このスクリプトは、PHPのSQLite3拡張機能が提供する `SQLite3::setAuthorizer` メソッドの利用例を示します。
4// `setAuthorizer` は、SQLiteデータベースの操作（例：データの読み取り、書き込み、削除）に対して、
5// カスタムの認可ロジック（アクセス制御）を設定するために使用されます。
6// 「php settoken」というキーワードは、ここで「ユーザーの権限レベル（トークン）」に基づいて
7// データベース操作を許可または拒否するシナリオに関連付けられます。
8
9function demonstrateSQLite3AuthorizerAuthorization(): void
10{
11    // 1. インメモリSQLiteデータベースを作成します。
12    // ':memory:' を指定すると、データベースはメモリ上に作成され、スクリプト終了時に自動的に削除されます。
13    $db = new SQLite3(':memory:');
14
15    // 2. テスト用の 'users' テーブルを作成します。
16    $db->exec('CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, role TEXT)');
17
18    // 3. サンプルデータを挿入します。
19    $db->exec("INSERT INTO users (name, role) VALUES ('Alice', 'admin')");
20    $db->exec("INSERT INTO users (name, role) VALUES ('Bob', 'guest')");
21
22    echo "--- 認可コールバック設定前の状態 ---\n";
23    echo "すべてのユーザー情報:\n";
24    $result = $db->query('SELECT * FROM users');
25    while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
26        echo "  ID: {$row['id']}, Name: {$row['name']}, Role: {$row['role']}\n";
27    }
28    echo "\n";
29
30    // 4. `setAuthorizer` を設定します。
31    // ここでは、現在のユーザーの権限レベルをシミュレートする変数 `$currentUserRole` を使用し、
32    // そのロールに基づいてデータベース操作を認可または拒否するロジックを定義します。
33    // まずは 'guest' ロールとしてテストします。
34    $currentUserRole = 'guest';
35
36    // クロージャで `$currentUserRole` をキャプチャします。
37    $db->setAuthorizer(function (int $action, ?string $database, ?string $table, ?string $column, ?string $arg) use ($currentUserRole): int {
38        // SQLiteの認可アクションコードの例:
39        // 9: SQLITE_DELETE (行の削除)
40        // 18: SQLITE_INSERT (行の挿入)
41        // 20: SQLITE_READ (データ読み取り)
42        // 23: SQLITE_UPDATE (行の更新)
43        // これらの値はSQLiteのC APIの定数に対応しており、
44        // PHPのSQLite3::クラスで定義される定数 (例: SQLite3::SQLITE_DELETE) と同じ数値です。
45        // コールバック関数内では簡潔さのため数値リテラルを使用しています。
46
47        if ($table === 'users' && $action === 9 /* SQLITE_DELETE */) {
48            // 'users' テーブルへのDELETE操作の場合
49            if ($currentUserRole !== 'admin') {
50                // 'admin' ロール以外のユーザーは削除を拒否します。
51                echo "認可エラー (ロール: {$currentUserRole}): '{$table}' テーブルからの削除操作は許可されていません。\n";
52                return SQLITE_DENY; // 操作を拒否
53            }
54        }
55        // それ以外のすべての操作は許可します。
56        return SQLITE_OK;
57    });
58
59    echo "--- 認可コールバック設定後 (現在のロール: {$currentUserRole}) ---\n";
60
61    // 5. 認可テスト (guestロール)
62    echo "guest ロールとして、'Bob' のレコード削除を試行します...\n";
63    // `SQLite3::exec` は、認可コールバックが `SQLITE_DENY` を返した場合、例外をスローしません。
64    // 代わりに、操作が単に実行されないという挙動になります。
65    $db->exec("DELETE FROM users WHERE name = 'Bob'");
66    echo "削除操作を試行しました。上記に認可エラーメッセージが出力されていれば、削除は拒否されています。\n";
67
68    echo "現在の 'users' テーブルの内容:\n";
69    $result = $db->query('SELECT * FROM users');
70    while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
71        echo "  ID: {$row['id']}, Name: {$row['name']}, Role: {$row['role']}\n";
72    }
73    echo "\n"; // 'Bob' のレコードは残っているはずです。
74
75    // 6. ロールを変更して再テスト (adminロール)
76    // クロージャは定義時の変数をキャプチャするため、`setAuthorizer` を再設定する必要があります。
77    // まず、既存の認可コールバックを無効化します。
78    $db->setAuthorizer(null);
79    echo "認可コールバックを一時的に無効化しました。\n";
80
81    $currentUserRole = 'admin'; // ロールを 'admin' に変更します。
82
83    // 新しい認可コールバックを 'admin' ロールで再設定します。
84    $db->setAuthorizer(function (int $action, ?string $database, ?string $table, ?string $column, ?string $arg) use ($currentUserRole): int {
85        if ($table === 'users' && $action === 9 /* SQLITE_DELETE */) {
86            if ($currentUserRole !== 'admin') {
87                // このパスには入らないはずですが、念のためログ出力
88                echo "認可エラー (ロール: {$currentUserRole}): '{$table}' テーブルからの削除操作は許可されていません。\n";
89                return SQLITE_DENY;
90            }
91        }
92        return SQLITE_OK;
93    });
94    echo "認可コールバックを再設定しました (現在のロール: {$currentUserRole}).\n";
95
96    echo "admin ロールとして、'Bob' のレコード削除を試行します...\n";
97    $db->exec("DELETE FROM users WHERE name = 'Bob'");
98    echo "削除操作が成功しました。\n";
99
100    echo "現在の 'users' テーブルの内容:\n";
101    $result = $db->query('SELECT * FROM users');
102    while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
103        echo "  ID: {$row['id']}, Name: {$row['name']}, Role: {$row['role']}\n";
104    }
105    echo "\n"; // 'Bob' のレコードは削除されているはずです。
106
107    // データベース接続を閉じます。
108    $db->close();
109}
110
111// サンプル関数を実行します。
112demonstrateSQLite3AuthorizerAuthorization();

PHPのSQLite3::setAuthorizerメソッドは、SQLiteデータベースに対する各種操作（データの読み取り、書き込み、削除など）を監視し、その実行を許可または拒否するためのカスタムな認可ロジックを設定する際に使用します。この機能により、特定のユーザー権限（キーワード「php settoken」で示されるような、ユーザーに紐づくロールやトークン情報）に基づいて、データベースへのアクセス制御を細かく定義することが可能となります。

引数には?callable $callbackを指定します。これは、データベース操作が行われるたびに呼び出される関数（コールバック）を設定するものです。このコールバック関数は、どのような操作が、どのデータベース、テーブル、カラムに対して行われようとしているかといった詳細な情報を受け取ります。そして、受け取った情報と定義された認可ロジック（例: 現在のユーザーが管理者ロールか否か）に基づいて、その操作を許可するならSQLITE_OK、拒否するならSQLITE_DENYなどの整数値を返します。nullを引数に渡すと、以前に設定された認可コールバックは解除されます。メソッド自体の戻り値はなしであり、設定が成功したかどうかを直接示す値は返しません。

サンプルコードでは、ユーザーのロール（guestまたはadmin）をシミュレートし、guestロールのユーザーがレコードを削除しようとした場合に操作を拒否し、adminロールの場合には許可するという、具体的な認可プロセスを示しています。これにより、アプリケーションレベルでデータベースへの操作権限を効率的に管理できることがわかります。

Copy
1<?php
2
3/**
4 * SQLite3::setAuthorizer の使用例を示す関数。
5 *
6 * この関数は、SQLiteデータベースへの操作が許可されるか拒否されるかを制御する
7 * 認証器（Authorizer）の基本的な概念と使い方を実演します。
8 * システムエンジニアを目指す初心者向けに、データベースのアクセス制御の仕組みを
9 * 理解できるように設計されています。
10 */
11function demonstrateSqliteAuthorizer(): void
12{
13    /**
14     * SQLiteアクションコードをわかりやすい名前に変換するユーティリティ関数。
15     * この関数は、認証器のログ出力を読みやすくするために使用します。
16     *
17     * @param int $actionCode SQLite3::SQLITE_* 定数の一つ。
18     * @return string アクションのわかりやすい名前。
19     */
20    function getSqliteActionName(int $actionCode): string
21    {
22        return match ($actionCode) {
23            SQLite3::SQLITE_CREATE_TABLE => 'SQLITE_CREATE_TABLE (テーブル作成)',
24            SQLite3::SQLITE_INSERT => 'SQLITE_INSERT (データ挿入)',
25            SQLite3::SQLITE_DELETE => 'SQLITE_DELETE (データ削除)',
26            SQLite3::SQLITE_UPDATE => 'SQLITE_UPDATE (データ更新)',
27            SQLite3::SQLITE_SELECT => 'SQLITE_SELECT (データ選択/読み取り)',
28            SQLite3::SQLITE_CREATE_INDEX => 'SQLITE_CREATE_INDEX (インデックス作成)',
29            SQLite3::SQLITE_DROP_TABLE => 'SQLITE_DROP_TABLE (テーブル削除)',
30            SQLite3::SQLITE_PRAGMA => 'SQLITE_PRAGMA (PRAGMA文)',
31            // その他の多くのアクションコードがありますが、ここでは主要なもののみを記載
32            default => 'UNKNOWN_ACTION (不明な操作)',
33        };
34    }
35
36    // メモリ上に一時的なSQLiteデータベースを開きます。
37    // ファイルに保存する場合は、ファイルパスを指定します（例: 'my_database.db'）。
38    $db = new SQLite3(':memory:');
39
40    // データベース操作の認証器（Authorizer）を設定します。
41    // このコールバック関数は、データベースへのあらゆる操作（テーブル作成、データ挿入、削除など）が
42    // 実際に実行される前に呼び出されます。
43    // コールバック関数が返す値によって、その操作を許可するか拒否するかが決まります。
44    $db->setAuthorizer(function (
45        int $action,     // 実行しようとしている操作の種類 (例: SQLite3::SQLITE_INSERT)
46        string $arg1,    // 操作に関連する第一引数 (例: テーブル名、カラム名)
47        string $arg2,    // 操作に関連する第二引数 (例: カラム名、インデックス名)
48        string $dbName,  // データベースの名前 (通常は 'main')
49        string $triggerName // トリガーの名前 (トリガー操作の場合)
50    ): int {
51        echo "\n--- 認証器（Authorizer）が呼び出されました ---\n";
52        echo "  要求された操作: " . getSqliteActionName($action) . "\n";
53        echo "  第一引数 (テーブル/カラムなど): '{$arg1}'\n";
54        echo "  第二引数 (カラム/インデックスなど): '{$arg2}'\n";
55        
56        switch ($action) {
57            case SQLite3::SQLITE_CREATE_TABLE:
58                // テーブル作成操作を許可します。
59                echo "  -> テーブル作成は許可します (SQLITE_OK)。\n";
60                return SQLite3::SQLITE_OK;
61            case SQLite3::SQLITE_INSERT:
62                // データ挿入操作を許可します。
63                echo "  -> データ挿入は許可します (SQLITE_OK)。\n";
64                return SQLite3::SQLITE_OK;
65            case SQLite3::SQLITE_DELETE:
66                // データ削除操作は拒否します。
67                echo "  -> データ削除は拒否します (SQLITE_DENY)。\n";
68                return SQLite3::SQLITE_DENY;
69            case SQLite3::SQLITE_UPDATE:
70                // データ更新操作は拒否します。
71                echo "  -> データ更新は拒否します (SQLITE_DENY)。\n";
72                return SQLite3::SQLITE_DENY;
73            case SQLite3::SQLITE_SELECT:
74                // データ選択（読み取り）操作は許可します。
75                // SELECT操作は頻繁に発生するため、ここでの出力は省略します。
76                return SQLite3::SQLITE_OK;
77            default:
78                // ここで明示的に制御されていないその他のすべての操作は、デフォルトで許可します。
79                // echo "  -> その他の操作はデフォルトで許可します (SQLITE_OK)。\n";
80                return SQLite3::SQLITE_OK;
81        }
82    });
83
84    echo "\n--- 1. テーブル作成を試行 (許可されるはず) ---\n";
85    if ($db->exec('CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)')) {
86        echo "✅ テーブル 'users' が正常に作成されました。\n";
87    } else {
88        echo "❌ エラー: テーブル作成に失敗しました。\n";
89        echo "  SQLiteエラーコード: " . $db->lastErrorCode() . ", メッセージ: " . $db->lastErrorMsg() . "\n";
90    }
91
92    echo "\n--- 2. データ挿入を試行 (許可されるはず) ---\n";
93    if ($db->exec("INSERT INTO users (name) VALUES ('Alice')")) {
94        echo "✅ データ ('Alice') が正常に挿入されました。\n";
95    } else {
96        echo "❌ エラー: データ挿入に失敗しました。\n";
97        echo "  SQLiteエラーコード: " . $db->lastErrorCode() . ", メッセージ: " . $db->lastErrorMsg() . "\n";
98    }
99
100    if ($db->exec("INSERT INTO users (name) VALUES ('Bob')")) {
101        echo "✅ データ ('Bob') が正常に挿入されました。\n";
102    } else {
103        echo "❌ エラー: データ挿入に失敗しました。\n";
104        echo "  SQLiteエラーコード: " . $db->lastErrorCode() . ", メッセージ: " . $db->lastErrorMsg() . "\n";
105    }
106
107    echo "\n--- 3. データ選択を試行 (許可されるはず) ---\n";
108    $result = $db->query('SELECT id, name FROM users');
109    if ($result) {
110        echo "usersテーブルの内容:\n";
111        while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
112            echo "  ID: " . $row['id'] . ", Name: " . $row['name'] . "\n";
113        }
114        $result->finalize(); // 結果セットを解放します
115    } else {
116        echo "❌ エラー: データ選択に失敗しました。\n";
117        echo "  SQLiteエラーコード: " . $db->lastErrorCode() . ", メッセージ: " . $db->lastErrorMsg() . "\n";
118    }
119
120    echo "\n--- 4. データ更新を試行 (認証器により拒否されるはず) ---\n";
121    // UPDATE文はSQLITE_UPDATEアクションを引き起こします。
122    // 認証器がこれを拒否するため、exec()はfalseを返します。
123    if ($db->exec("UPDATE users SET name = 'Alicia' WHERE name = 'Alice'")) {
124        echo "✅ データ更新が正常に実行されました。（これは予期しない結果です！）\n";
125    } else {
126        echo "❌ データ更新は拒否されました。想定通りに動作しました。\n";
127        echo "  SQLiteエラーコード: " . $db->lastErrorCode() . ", メッセージ: " . $db->lastErrorMsg() . "\n";
128        // 認証器によって拒否された場合、エラーコードは SQLITE_AUTH (23) になるはずです。
129    }
130
131    echo "\n--- 5. データ削除を試行 (認証器により拒否されるはず) ---\n";
132    // DELETE文はSQLITE_DELETEアクションを引き起こします。
133    // 認証器がこれを拒否するため、exec()はfalseを返します。
134    if ($db->exec("DELETE FROM users WHERE name = 'Bob'")) {
135        echo "✅ データ削除が正常に実行されました。（これは予期しない結果です！）\n";
136    } else {
137        echo "❌ データ削除は拒否されました。想定通りに動作しました。\n";
138        echo "  SQLiteエラーコード: " . $db->lastErrorCode() . ", メッセージ: " . $db->lastErrorMsg() . "\n";
139        // 認証器によって拒否された場合、エラーコードは SQLITE_AUTH (23) になるはずです。
140    }
141
142    // 最終的にデータベースに残っているデータを確認します。
143    // 更新と削除が拒否されているため、初期のデータが残っているはずです。
144    echo "\n--- 最終的な usersテーブルの内容 ---\n";
145    $result = $db->query('SELECT id, name FROM users');
146    if ($result) {
147        echo "usersテーブルの内容:\n";
148        while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
149            echo "  ID: " . $row['id'] . ", Name: " . $row['name'] . "\n";
150        }
151        $result->finalize();
152    } else {
153        echo "❌ エラー: 最終データ確認に失敗しました。\n";
154        echo "  SQLiteエラーコード: " . $db->lastErrorCode() . ", メッセージ: " . $db->lastErrorMsg() . "\n";
155    }
156
157    // データベース接続を閉じます。
158    $db->close();
159}
160
161// 上記のデモンストレーション関数を実行します。
162demonstrateSqliteAuthorizer();

SQLite3::setAuthorizerメソッドは、PHPのSQLiteデータベースへの操作を細かく制御するためのものです。このメソッドは、データベースへの各種操作（テーブル作成、データ挿入、更新、削除など）が実行される直前に、その操作を許可するかどうかを判断する独自のルールを設定できます。

引数?callable $callbackには、この判断ルールを記述した関数を指定します。この関数は、実行される操作の種類や対象に関する詳細情報を受け取ります。コールバック関数は整数値を返します。具体的には、SQLite3::SQLITE_OKを返せば操作を許可し、SQLite3::SQLITE_DENYを返せばその操作は拒否されます。このメソッド自体は値を返さず、認証器の設定のみを行います。

サンプルコードでは、テーブル作成とデータ挿入を許可し、データ更新とデータ削除を拒否する認証器を設定しています。これにより、指定されたデータベース操作がブロックされ、どのようにアクセス制御が機能するかを具体的に理解できます。