このページは、まだ日本語ではご利用いただけません。翻訳中です。
構成
互換性のあるプロトコル
Imperva API Securityプラグインは以下のプロトコルに対応しています:
http
, https
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
imp-appsec-connector
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
instance_name
stringプラグインのインスタンスを識別するための任意のカスタム名 (例:
imp-appsec-connector_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-
destination_addr
string required encryptedDestination address of the API security receiver. This can be an IP address or domain name, for example
logconsumer.myapisec.mydomain
.
-
destination_port
number default:8080
Must be one of:8080
,80
,8443
,443
Destination port of the API security receiver.
-
connection_type
string default:tcp
Must be one of:tcp
,http
The connection protocol to use.
-
method
string default:POST
Must be one of:POST
,PUT
,PATCH
The request method to use.
-
max_body_size
number default:1048576
Maximum payload body size to capture, in bytes.
-
ssl
boolean default:false
Whether or not to use an TLS/SSL tunnel to send API traffic capture to the destination.
-
request_body_flag
boolean default:true
Determines whether to send the request body payload to the destination.
Set to
false
to disable. Use only for debugging purposes. API security will not fully function without inspection of the request body payload.
-
response_body_flag
boolean default:true
Determines whether to send the response body payload to the destination.
Set to
false
to disable. Use only for debugging purposes. API security will not fully function without inspection of the response body payload.
-
retry_count
number default:0
Number of retries if sending the API call capture fails. No retry by default.
-
queue_size
number default:1
Number of API logs to keep in the queue for retries. Default is 1, meaning no retries. Set to a number larger than 1 to enable retries.
-
flush_timeout
number default:2
Number of seconds to wait before flushing the queue.
-
timeout
number default:6000000
Number of milliseconds to keep a single connection open to the destination.
-