コンテンツにスキップ
|
Plugin Hub
report-issue問題を報告する
header icon

HMAC Auth設定

By Kong Inc.

このページは、まだ日本語ではご利用いただけません。翻訳中です。

構成

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

Consumers and Credentials can be created with declarative configuration.

Admin API endpoints that do POST, PUT, PATCH or DELETE on Credentials will not work on DB-less mode.

互換性のあるプロトコル

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

grpc, grpcs, http, https, ws, wss

パラメータ

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

  • name or plugin

    string required

    プラグイン名。この場合は hmac-auth 。

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

  • instance_name

    string

    プラグインのインスタンスを識別するための任意のカスタム名 (例: hmac-auth_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

    • hide_credentials

      boolean required default: false

      An optional boolean value telling the plugin to show or hide the credential from the upstream service.

    • clock_skew

      number default: 300

      Clock skew in seconds to prevent replay attacks.

    • anonymous

      string

      An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.

    • validate_request_body

      boolean required default: false

      A boolean value telling the plugin to enable body validation.

    • enforce_headers

      array of type string

      A list of headers that the client should at least use for HTTP signature creation.

    • algorithms

      array of type string default: hmac-sha1, hmac-sha256, hmac-sha384, hmac-sha512 Must be one of: hmac-sha1, hmac-sha256, hmac-sha384, hmac-sha512

      A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512

    • realm

      string

      When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.