Configuration

configobject
Hide Child Parameters
allow_dtdboolean

Indicates whether an XML Document Type Definition (DTD) section is allowed.

Default:false

allowed_content_typesarray[string]

A list of Content-Type values with payloads that are allowed, but aren’t validated.

Match pattern:^[^\t\n\v\f\r ]+\/[^ ;]+$

Default:[]

attributeinteger

Maximum size of the attribute value.

Default:1048576

>= 0

bla_max_amplificationnumber

Sets the maximum allowed amplification. This protects against the Billion Laughs Attack.

Default:100

>= 1

bla_thresholdinteger

Sets the threshold after which the protection starts. This protects against the Billion Laughs Attack.

Default:8388608

>= 1024

bufferinteger

Maximum size of the unparsed buffer (see below).

Default:1048576

>= 0

checked_content_typesarray[string]

A list of Content-Type values with payloads that must be validated.

Match pattern:^[^\t\n\v\f\r ]+\/[^ ;]+$

Default:application/xml

commentinteger

Maximum size of comments.

Default:1024

>= 0

documentinteger

Maximum size of the entire document.

Default:10485760

>= 0

entityinteger

Maximum size of entity values in EntityDecl.

Default:1024

>= 0

entitynameinteger

Maximum size of entity names in EntityDecl.

Default:1024

>= 0

entitypropertyinteger

Maximum size of systemId, publicId, or notationName in EntityDecl.

Default:1024

>= 0

localnameinteger

Maximum size of the localname. This applies to tags and attributes.

Default:1024

>= 0

max_attributesinteger

Maximum number of attributes allowed on a tag, including default ones. Note: If namespace-aware parsing is disabled, then the namespaces definitions are counted as attributes.

Default:100

>= 0

max_childreninteger

Maximum number of children allowed (Element, Text, Comment, ProcessingInstruction, CDATASection). Note: Adjacent text and CDATA sections are counted as one. For example, text-cdata-text-cdata is one child.

Default:100

>= 0

max_depthinteger

Maximum depth of tags. Child elements such as Text or Comments are not counted as another level.

Default:50

>= 0

max_namespacesinteger

Maximum number of namespaces defined on a tag. This value is required if parsing is namespace-aware.

Default:20

>= 0

namespace_awareboolean

If not parsing namespace aware, all prefixes and namespace attributes will be counted as regular attributes and element names, and validated as such.

Default:true

namespaceuriinteger

Maximum size of the namespace URI. This value is required if parsing is namespace-aware.

Default:1024

>= 0

pidatainteger

Maximum size of processing instruction data.

Default:1024

>= 0

pitargetinteger

Maximum size of processing instruction targets.

Default:1024

>= 0

prefixinteger

Maximum size of the prefix. This applies to tags and attributes. This value is required if parsing is namespace-aware.

Default:1024

>= 0

textinteger

Maximum text inside tags (counted over all adjacent text/CDATA elements combined).

Default:1048576

>= 0

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!