Log invalid requests without blockingv3.8+
Run the JSON Threat Protection plugin in tap mode.
In tap mode, you define a JSON threat protection policy and the plugin logs any invalid requests as warnings. It still allows Kong Gateway to proxy non-conforming requests to the upstream service.
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: json-threat-protection
config:
max_body_size: 1024
max_container_depth: 2
max_object_entry_count: 4
max_object_entry_name_length: 7
max_array_element_count: 2
max_string_value_length: 6
enforcement_mode: log_only
error_status_code: 400
error_message: Incorrect request format
Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "json-threat-protection",
"config": {
"max_body_size": 1024,
"max_container_depth": 2,
"max_object_entry_count": 4,
"max_object_entry_name_length": 7,
"max_array_element_count": 2,
"max_string_value_length": 6,
"enforcement_mode": "log_only",
"error_status_code": 400,
"error_message": "Incorrect request format"
}
}
'
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "json-threat-protection",
"config": {
"max_body_size": 1024,
"max_container_depth": 2,
"max_object_entry_count": 4,
"max_object_entry_name_length": 7,
"max_array_element_count": 2,
"max_string_value_length": 6,
"enforcement_mode": "log_only",
"error_status_code": 400,
"error_message": "Incorrect request format"
}
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: json-threat-protection
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
labels:
global: 'true'
config:
max_body_size: 1024
max_container_depth: 2
max_object_entry_count: 4
max_object_entry_name_length: 7
max_array_element_count: 2
max_string_value_length: 6
enforcement_mode: log_only
error_status_code: 400
error_message: Incorrect request format
plugin: json-threat-protection
" | kubectl apply -f -
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_json_threat_protection" "my_json_threat_protection" {
enabled = true
config = {
max_body_size = 1024
max_container_depth = 2
max_object_entry_count = 4
max_object_entry_name_length = 7
max_array_element_count = 2
max_string_value_length = 6
enforcement_mode = "log_only"
error_status_code = 400
error_message = "Incorrect request format"
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: json-threat-protection
service: serviceName|Id
config:
max_body_size: 1024
max_container_depth: 2
max_object_entry_count: 4
max_object_entry_name_length: 7
max_array_element_count: 2
max_string_value_length: 6
enforcement_mode: log_only
error_status_code: 400
error_message: Incorrect request format
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "json-threat-protection",
"config": {
"max_body_size": 1024,
"max_container_depth": 2,
"max_object_entry_count": 4,
"max_object_entry_name_length": 7,
"max_array_element_count": 2,
"max_string_value_length": 6,
"enforcement_mode": "log_only",
"error_status_code": 400,
"error_message": "Incorrect request format"
}
}
'
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "json-threat-protection",
"config": {
"max_body_size": 1024,
"max_container_depth": 2,
"max_object_entry_count": 4,
"max_object_entry_name_length": 7,
"max_array_element_count": 2,
"max_string_value_length": 6,
"enforcement_mode": "log_only",
"error_status_code": 400,
"error_message": "Incorrect request format"
}
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
serviceId: Theidof the service the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: json-threat-protection
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
max_body_size: 1024
max_container_depth: 2
max_object_entry_count: 4
max_object_entry_name_length: 7
max_array_element_count: 2
max_string_value_length: 6
enforcement_mode: log_only
error_status_code: 400
error_message: Incorrect request format
plugin: json-threat-protection
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=json-threat-protection
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_json_threat_protection" "my_json_threat_protection" {
enabled = true
config = {
max_body_size = 1024
max_container_depth = 2
max_object_entry_count = 4
max_object_entry_name_length = 7
max_array_element_count = 2
max_string_value_length = 6
enforcement_mode = "log_only"
error_status_code = 400
error_message = "Incorrect request format"
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: json-threat-protection
route: routeName|Id
config:
max_body_size: 1024
max_container_depth: 2
max_object_entry_count: 4
max_object_entry_name_length: 7
max_array_element_count: 2
max_string_value_length: 6
enforcement_mode: log_only
error_status_code: 400
error_message: Incorrect request format
Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "json-threat-protection",
"config": {
"max_body_size": 1024,
"max_container_depth": 2,
"max_object_entry_count": 4,
"max_object_entry_name_length": 7,
"max_array_element_count": 2,
"max_string_value_length": 6,
"enforcement_mode": "log_only",
"error_status_code": 400,
"error_message": "Incorrect request format"
}
}
'
Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "json-threat-protection",
"config": {
"max_body_size": 1024,
"max_container_depth": 2,
"max_object_entry_count": 4,
"max_object_entry_name_length": 7,
"max_array_element_count": 2,
"max_string_value_length": 6,
"enforcement_mode": "log_only",
"error_status_code": 400,
"error_message": "Incorrect request format"
}
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
routeId: Theidof the route the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: json-threat-protection
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
max_body_size: 1024
max_container_depth: 2
max_object_entry_count: 4
max_object_entry_name_length: 7
max_array_element_count: 2
max_string_value_length: 6
enforcement_mode: log_only
error_status_code: 400
error_message: Incorrect request format
plugin: json-threat-protection
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=json-threat-protection
kubectl annotate -n kong ingress konghq.com/plugins=json-threat-protection
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_json_threat_protection" "my_json_threat_protection" {
enabled = true
config = {
max_body_size = 1024
max_container_depth = 2
max_object_entry_count = 4
max_object_entry_name_length = 7
max_array_element_count = 2
max_string_value_length = 6
enforcement_mode = "log_only"
error_status_code = 400
error_message = "Incorrect request format"
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}