誰として呼び出すか
Supabase へのすべての呼び出しは、二つのものを運びます。プロジェクトのキー (apikey) と、誰が呼び出しているかを示す Bearer トークンです。リポジトリ、Storage、Edge Functions、Realtime はすべて、それらを一つの Bean、SupabaseCredentials (Bean 名は supabaseCredentials) に尋ねます。そのため、常に同じユーザーとして動作します。
使う理由
呼び出し元が何を読み書きできるかはデータベースが決めます (行レベルセキュリティ)。つまり、呼び出しに付くトークンがデータを守っています。各部分が自分でトークンを選ぶと、いつかどれかが間違ったものを送ります。ユーザーの呼び出しをサービスロールで送ったり、あるユーザーの呼び出しを別のユーザーのトークンで送ったりします。一つのルールを持つ一つの Bean なら、確認は一度で済みます。
例
@Service()
class Cleanup {
Cleanup(this.credentials, this.todos);
final SupabaseCredentials credentials;
final Todos todos;
// On a server, a job that must see every row.
Future<int> removeDone() =>
credentials.asServiceRole(() => todos.deleteByDone(true));
}
asServiceRole の外では、同じリポジトリの呼び出しが、現在のユーザーとして、または誰でもない者として行われます。
ルール
最初に当てはまるものが使われます。
| # | 条件 | apikey |
Bearer トークン | caller |
|---|---|---|---|---|
| 1 | asServiceRole の中 |
サービスロールキー | サービスロールキー | service |
| 2 | サインインしたユーザーがいるクライアントアプリケーション (LoginSession の Bean、つまり SupabaseAuth) |
anon キー | ユーザーのアクセストークン。期限が切れる前に更新される | user:<id> |
| 3 | Bearer トークンがこのプロジェクトのユーザーのトークンであるリクエストを処理しているサーバー | anon キー | そのトークン | user:<id> |
| 4 | それ以外 | anon キー | anon キー | anon |
ルール 3 では、トークンの iss がプロジェクトの発行者 (spring.supabase.auth.issuer、なければ <url>/auth/v1) で、role が authenticated で、sub があるときに、トークンがそのまま渡されます。他の発行者のトークン (Keycloak、テストユーザー) が Supabase に送られることはありません。そのようなリクエストは anon として呼び出します。
SupabaseCredentials はトークンを検証しません。サーバーでは、コントローラーが実行される前に、リソースサーバーが無効なものをすべて拒否しています (サーバーのセキュリティ を参照)。ここで決めるのは、トークンを渡すかどうかだけです。
キーやトークンは spring.supabase.url にしか送られず、どの呼び出しもリダイレクトに従いません。
asServiceRole
await credentials.asServiceRole(() async {
await todos.deleteByDone(true); // as the service role
await storage.delete('avatars', path); // this too
});
- 本体と、本体が開始するすべてのものに効きます。
Zoneに保持されるためです。 spring.supabase.service-role-keyがなければ、本体が実行される前にStateErrorを投げます。- 本体のエラーはそのまま出てきます。
- サービスロールは行レベルセキュリティを通過します。ジョブや管理に使い、ユーザーのリクエスト全体には決して使わないでください。
StorageTemplate.asServiceRole() と SupabaseAuthAdmin は、これを自分で使います。
インターフェース
| メンバー | 意味 |
|---|---|
String get apiKey |
apikey として送られるキー。 |
Future<String> accessToken() |
次の呼び出しの Bearer トークン。 |
SupabaseCaller get caller |
次の呼び出しが誰として行われるか。role (SupabaseRole.anon、user、service)、id (ユーザーの ID)、key (anon、user:<id>、service)。key はキャッシュキーに含まれるものです。 |
Future<T> asServiceRole<T>(FutureOr<T> Function() body) |
body をサービスロールとして実行する。 |
デフォルトは DefaultSupabaseCredentials です。SupabaseCredentials 型の独自の Bean がそれを置き換えます。
クライアントアプリケーションの中のキー
Flutter アプリでは何も禁止されません。警告されるだけです。アプリに同梱されるキーやパスワードは、開発者の選択です (社内ツール、管理アプリ)。Flutter アプリでは、起動時に、次のうち設定されているものがそれぞれ一度だけ警告としてログに出ます。
| プロパティ | アプリを持つ人にできること |
|---|---|
spring.supabase.service-role-key |
行レベルセキュリティを越えて、すべてのテーブルを読み書きできる |
spring.supabase.db.url |
データベースのパスワードが手に入る |
spring.supabase.auth.jwt-secret |
任意のユーザーのトークンに署名できる (しかもクライアントアプリケーションはこれを使わない。トークンを検証するのはサーバーだけ) |
spring.supabase.service-role-key ships in this application: whoever has the app reads and writes every table past row-level security
ロガーは spring.supabase です。anon キーは公開してよいものです。警告は起動時だけで、ビルドのログには出ません。
Spring (Java) との対応
対応するものはありません。Spring には Supabase のサポートがないためです。最も近い考え方は、Spring Security の SecurityContextHolder と OAuth2AuthorizedClientManager の組み合わせで、呼び出しに現在のユーザーのトークンを与えます。