サーバーのセキュリティ
ユーザーが Supabase Auth でサインインするサーバーは、ユーザーのアクセストークンを Authorization: Bearer で受け取ります。スターターは Spring Security の JWT リソースサーバー のプロパティを設定するので、spring_boot_starter_security は他に何も設定しなくてもそのトークンを受け入れます。
使う理由
Supabase のトークンの検証には、独自の落とし穴があります。anon キーとサービスロールキーも署名されたトークンで、発行者も鍵も同じです。署名だけを検証するサーバーは、anon キーをユーザーとして受け入れてしまいます。user_metadata に書かれたロールは、ユーザーが変更できます。デフォルトはこれらを塞ぎます。受け入れるのはユーザーのトークンだけで、ロールはユーザーが書けない場所から読みます。
スターター自身にトークンの検証はありません。フィルターチェーンは変更されず、スターターはセキュリティスターター自身のプロパティに値を与えるだけです。
例
# pubspec.yaml
dependencies:
spring_boot_starter_security: ^0.9.0
spring_boot_starter_supabase: ^0.9.0
# lib/resources/application.yml
spring:
supabase:
url: https://abcd.supabase.co
anon-key: ${SUPABASE_ANON_KEY}
@RestController()
class PostController {
PostController(this.posts);
final Posts posts;
@PreAuthorize("hasRole('editor')")
@PostMapping('/api/posts')
Future<Post> publish(@RequestBody() Post post) => posts.save(post);
}
これで、デフォルトのチェーンはすべてのリクエストに有効な Bearer トークンを要求します。REST API では posts.save も同じトークンで行われるので (誰として呼び出すか を参照)、データベースもユーザーの行レベルセキュリティを適用します。
デフォルト
spring.supabase.url が設定されていて、spring.supabase.auth.enabled が false でないときに適用されます。サーバーだけです。モジュールは server プラットフォーム (Dart VM または AOT 実行ファイル) のものなので、ブラウザーのビルドにも Flutter アプリにも含まれません。
spring.security.oauth2.resourceserver.jwt. |
このスターターでの値 |
|---|---|
jwk-set-uri |
<spring.supabase.url>/auth/v1/.well-known/jwks.json |
jws-algorithms |
ES256,RS256 |
issuer-uri |
spring.supabase.auth.issuer、なければ <spring.supabase.url>/auth/v1 |
audiences |
authenticated |
required-claims.role |
authenticated |
require-expiry |
true |
authorities-claim-name |
app_metadata.roles |
authority-prefix |
ROLE_ |
トークンに必要なもの
| 検査 | 拒否するもの |
|---|---|
| プロジェクトの鍵セットの鍵で、ES256 または RS256 で署名されている | 他の誰かが署名したトークン、alg: none、公開鍵から作った HMAC のトークン |
iss がプロジェクトの発行者と完全に一致する |
別のプロジェクトやプロバイダーのトークン |
aud に authenticated がある |
別のオーディエンス向けのトークン |
role が authenticated と完全に一致する |
Bearer トークンとして使われた anon キー (role: anon) とサービスロールキー (role: service_role) |
exp がある |
有効期限のないトークン (require-expiry) |
exp、nbf、タイプ |
期限切れのトークン、そしてリソースサーバーが検査するその他すべて |
拒否されたトークンは、WWW-Authenticate: Bearer error="invalid_token" の付いた 401 になります。
ロール
権限は、app_metadata.roles の各文字列についての ROLE_<role> です。そのため、ルールは hasRole('editor') と書きます。app_metadata を書くのはプロジェクトだけです (サービスロールが管理 API を通して書きます)。user_metadata は決して読まれません。ユーザーが書けるためです。
- 匿名サインイン (
is_anonymous) は、ロールauthenticatedでロールを持たないユーザーです。トークンの検査は通りますがROLE_…は付かないので、hasRole('editor')のようなルールは拒否します。締め出したいルールは、そう書く必要があります。 app_metadata.rolesという名前そのもののトップレベルのクレームは、入れ子のapp_metadata.rolesより先に読まれます。トップレベルのクレームを書けるのはプロジェクト自身のアクセストークンフックだけで、ユーザーには書けません。user_metadataは決して読まれません。
await admin.updateUser(user.id, appMetadata: {'roles': ['editor']});
アクセストークンのロールは、次の更新のときに変わります。クライアントアプリケーションも同じクレームを読むので、両側が同じロールを見ます。
レガシーのシークレット
まだ HS256 でトークンに署名しているプロジェクトには、署名鍵の代わりに JWT シークレットがあります。それを設定すると、デフォルトが変わります。
spring:
supabase:
auth:
jwt-secret: ${SUPABASE_JWT_SECRET}
spring.security.oauth2.resourceserver.jwt. |
jwt-secret があるときの値 |
|---|---|
secret-key |
そのシークレット |
jws-algorithms |
HS256 |
jwk-set-uri |
設定されない |
クレームの検査は同じです。シークレットを持つ人は、任意のユーザーのトークンに署名できます。サーバーだけに置き、環境変数から取ってください。Flutter アプリでは、起動時に警告されます。
上書き
デフォルトは、優先順位が最も低いプロパティソースです。アプリケーションのファイルより下で、その defaultProperties より上です。アプリケーションが spring.security.oauth2.resourceserver.jwt.* の下に自分で設定したものが、キーごとに優先されます。
# Roles from another claim of the project's tokens.
spring.security.oauth2.resourceserver.jwt.authorities-claim-name=app_metadata.permissions
spring.security.oauth2.resourceserver.jwt.authority-prefix=
spring.supabase.auth.enabled=falseにすると、どれも設定されません。- 独自の
SecurityFilterChainやJwtDecoderの Bean は、他のリソースサーバーと同じように動きます。 - 独自の設定で受け入れたトークンは、このプロジェクトのユーザーのトークンである場合にだけ、Supabase に渡されます。
データを守るのはデータベース
サーバーのルール (@PreAuthorize、リクエストのルール) は、誰がエンドポイントを呼び出せるかを決めます。ユーザーが何を読み書きできるかは、データベースが決めます。行レベルセキュリティ、列の権限、制約です。スターターは、誰が呼び出しているかをデータベースが確実に知るようにします。ポリシーはデータベースに書いてください。
Spring (Java) との対応
プロパティは Spring Boot のもの (spring.security.oauth2.resourceserver.jwt.*) で、そのうちスターターが使う四つはこのプロジェクト独自のものです。required-claims、require-expiry、secret-key、そして authorities-claim-name のパスです。Spring ではスターターが JwtDecoder の Bean を宣言するところですが、ここではプロパティを設定するので、アプリケーションは一つずつ上書きできます。