このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインは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
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
hmac-auth
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
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. If
true
, the plugin strips the credential from the request (i.e. theAuthorization
header) before proxying it.
-
clock_skew
number default:300
Clock Skew in seconds to prevent replay attacks.
-
anonymous
stringAn optional string (consumer UUID) value to use as an anonymous consumer if authentication fails. If empty (default), the request will fail with an authentication failure
4xx
. Note that this value must refer to the consumerid
attribute that is internal to Kong Gateway, and not itscustom_id
.
-
validate_request_body
boolean required default:false
A boolean value telling the plugin to enable body validation.
-
enforce_headers
array of typestring
A list of headers that the client should at least use for HTTP signature creation.
-
algorithms
array of typestring
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
, andhmac-sha512
-