XML Threat Protection Configuration

このページは、まだ日本語ではご利用いただけません。翻訳中です。

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDBレスモードに対応しています。

互換性のあるプロトコル

XML Threat Protectionプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

• name or plugin

  string required

  プラグイン名。この場合は xml-threat-protection 。

  • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
  • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: xml-threat-protection_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 を使用する場合は必要ありません。

• consumer.name or consumer.id

  string

  プラグインがターゲットとするコンシューマーの名前または ID。 最上位の /plugins エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください /consumers/{consumerName|Id}/pluginsを使用する場合は必要ありません。

• enabled

  boolean default: true

  このプラグインが適用されるかどうか。

• config

  record required
  • checked_content_types

    set of type string required default: application/xml

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

  • allowed_content_types

    set of type string required

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

  • allow_dtd

    boolean required default: false

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

  • namespace_aware

    boolean required default: true

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

  • max_depth

    integer required default: 50

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

  • max_children

    integer required default: 100

    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.

  • max_attributes

    integer required default: 100

    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.

  • max_namespaces

    integer default: 20

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

  • document

    integer required default: 10485760

    Maximum size of the entire document.

  • buffer

    integer required default: 1048576

    Maximum size of the unparsed buffer (see below).

  • comment

    integer required default: 1024

    Maximum size of comments.

  • localname

    integer required default: 1024

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

  • prefix

    integer default: 1024

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

  • namespaceuri

    integer default: 1024

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

  • attribute

    integer required default: 1048576

    Maximum size of the attribute value.

  • text

    integer required default: 1048576

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

  • pitarget

    integer required default: 1024

    Maximum size of processing instruction targets.

  • pidata

    integer required default: 1024

    Maximum size of processing instruction data.

  • entityname

    integer required default: 1024

    Maximum size of entity names in EntityDecl.

  • entity

    integer required default: 1024

    Maximum size of entity values in EntityDecl.

  • entityproperty

    integer required default: 1024

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

  • bla_max_amplification

    number required default: 100

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

  • bla_threshold

    integer required default: 8388608

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