MastraAuthAuth0 クラス

MastraAuthAuth0 クラスは、Auth0 を用いて Mastra の認証を提供します。Auth0 が発行する JWT トークンで受信リクエストを検証し、experimental_auth オプションを通じて Mastra サーバーと統合します。

使い方の例

import { Mastra } from "@mastra/core/mastra";
import { MastraAuthAuth0 } from '@mastra/auth-auth0';
 
export const mastra = new Mastra({
  // ..
  server: {
    experimental_auth: new MastraAuthAuth0({
      domain: process.env.AUTH0_DOMAIN,
      audience: process.env.AUTH0_AUDIENCE
    }),
  },
});

注意: AUTH0_DOMAIN と AUTH0_AUDIENCE という名前の環境変数が設定されていれば、コンストラクターのパラメーターは省略できます。その場合は、引数なしで new MastraAuthAuth0() を使用してください。

コンストラクターのパラメーター

環境変数

コンストラクターのオプションが指定されていない場合、次の環境変数が自動的に使用されます。

デフォルトの認可動作

デフォルトでは、MastraAuthAuth0 は Auth0 の JWT トークンを検証し、認証済みのユーザー全員にアクセスを許可します:

1. トークンの検証: JWT トークンを Auth0 の公開鍵（JWKS）で検証します
2. 署名の検証: トークンが自分の Auth0 テナントによって署名されていることを確認します
3. 有効期限の確認: トークンが期限切れでないことを確認します
4. オーディエンスの検証: トークンが対象の API（audience）向けに発行されていることを確認します
5. 発行者の検証: トークンが自分の Auth0 ドメインによって発行されていることを確認します

すべての検証を通過した場合、ユーザーは認可済みと見なされます。カスタムの認可ロジック（例: ロールベースアクセス制御）を実装するには、カスタムの authorizeUser 関数を提供してください。

Auth0 のユーザー型

authorizeUser 関数で使用される Auth0User 型は、デコードされた JWT のペイロードに対応し、通常は次を含みます:

• sub: ユーザーの一意の識別子（subject）
• email: ユーザーのメールアドレス（トークンに含まれている場合）
• email_verified: メールアドレスが認証済みかどうか
• name: ユーザーの表示名（存在する場合）
• picture: ユーザーのプロフィール画像の URL（存在する場合）
• iss: トークン発行者（あなたの Auth0 ドメイン）
• aud: トークンのオーディエンス（あなたの API 識別子）
• iat: トークンの発行時刻（UNIX タイムスタンプ）
• exp: トークンの有効期限（UNIX タイムスタンプ）
• scope: トークンに付与されたスコープ
• Auth0 テナントで設定したカスタムクレームやアプリメタデータ

利用可能なプロパティの内容は、Auth0 の設定、要求するスコープ、および設定したカスタムクレームによって異なります。

関連項目

MastraAuthAuth0 クラス