TLS Metadata Headers設定

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

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

構成

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

互換性のあるプロトコル

TLS Metadata Headersプラグインは以下のプロトコルに対応しています：

https, grpcs, tls

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は tls-metadata-headers 。

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

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: tls-metadata-headers_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
  • inject_client_cert_details

    boolean default: false

    Enables TLS client certificate metadata values to be injected into HTTP headers.

  • client_cert_header_name

    string required default: X-Client-Cert

    Define the HTTP header name used for the PEM format URL encoded client certificate.

  • client_serial_header_name

    string required default: X-Client-Cert-Serial

    Define the HTTP header name used for the serial number of the client certificate.

  • client_cert_issuer_dn_header_name

    string required default: X-Client-Cert-Issuer-DN

    Define the HTTP header name used for the issuer DN of the client certificate.

  • client_cert_subject_dn_header_name

    string required default: X-Client-Cert-Subject-DN

    Define the HTTP header name used for the subject DN of the client certificate.

  • client_cert_fingerprint_header_name

    string required default: X-Client-Cert-Fingerprint

    Define the HTTP header name used for the SHA1 fingerprint of the client certificate.