JWT設定

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDB-lessモードと部分的に互換性があります。

Consumers and JWT secrets can be created with declarative configuration.

Admin API endpoints that do POST, PUT, PATCH, or DELETE on secrets are not available on DB-less mode.

互換性のあるプロトコル

JWTプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

• name or plugin

  string required

  プラグイン名。この場合は jwt 。

  • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
  • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: jwt_my-service 。

  インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。

  インスタンス名は、次のコンテキスト内で一意である必要があります。

  • Kong Gateway Enterpriseのワークスペース内
  • Konnectのコントロールプレーン（CP）またはコントロールプレーン（CP）グループ内
  • Kong Gateway (OSS)の全世界

• service.name or service.id

  string

  プラグインが対象とするサービス名または ID。最上位の /plugins エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください /services/{serviceName|Id}/plugins を使用する場合は必要ありません。

• route.name or route.id

  string

  プラグインがターゲットとするルート名または ID。最上位の /plugins エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください /routes/{routeName|Id}/plugins を使用する場合は必要ありません。

• enabled

  boolean default: true

  このプラグインが適用されるかどうか。

• config

  record required
  • uri_param_names

    set of type string default: jwt

    KongがJWTを取得するために検査するクエリ文字列パラメータのリスト。

  • cookie_names

    set of type string

    KongがJWTを取得するために検査するCookie名のリスト。

  • key_claim_name

    string default: iss

    シークレットを特定する鍵を渡さなければならないクレームの名前。プラグインは、このクレームをJWTペイロードとヘッダーの順序で読み取ろうとします。

  • secret_is_base64

    boolean required default: false

    true の場合、プラグインは認証情報のシークレットがbase64でエンコードされていると想定します。コンシューマ用にbase64でエンコードされたシークレットを作成し、元のシークレットでJWTに署名する必要があります。

  • claims_to_verify

    set of type string Must be one of: exp, nbf

    Kongが検証できる登録済みクレームのリスト（RFC 7519に準拠）。使用可能な値: expまたはnbfのいずれか。

  • anonymous

    string

    認証に失敗した場合に「匿名」コンシューマとして使用するオプションの文字列（消費者のUUIDまたはユーザー名）の値。

  • run_on_preflight

    boolean required default: true

    OPTIONSプリフライトリクエストでプラグインを実行する（そして認証を試みる）かどうかを示すブール値。falseに設定すると、OPTIONSリクエストは常に許可されます。

  • maximum_expiration

    number default: 0 between: 0 31536000

    0から31536000（365日）までの値で、JWTの有効期間を将来の maximum_expiration秒に制限します。

  • header_names

    set of type string default: authorization

    KongがJWTを取得するために検査するHTTPヘッダー名のリスト。