Injection Protection Configuration

You are browsing unreleased documentation.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Injection Protection plugin is compatible with the following protocols:

grpc, grpcs, http, https

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case injection-protection.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example injection-protection_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • injection_types

    set of type string required default: sql Must be one of: sql, js, ssi, xpath_abbreviated, xpath_extended, java_exception

    The type of injections to check for.

  • locations

    set of type string required default: path_and_query Must be one of: headers, path_and_query, body

    The locations to check for injection.

  • custom_injections

    array of type record

    Custom regexes to check for.

    • name

      string required

      A unique name for this injection.

    • regex

      string required

      The regex to match against.

  • enforcement_mode

    string required default: block Must be one of: block, log_only

    Enforcement mode of the security policy.

  • error_status_code

    integer required default: 400 between: 400 499

    The response status code when validation fails.

  • error_message

    string required default: Bad Request

    The response message when validation fails