Kong · Schema

TlsMetadataHeadersPluginConfig

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
config	object
name	object
protocols	array	A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins th
route	object	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.
service	object	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.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TlsMetadataHeadersPluginConfig",
  "title": "TlsMetadataHeadersPluginConfig",
  "x-speakeasy-entity": "PluginTlsMetadataHeaders",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "client_cert_fingerprint_header_name": {
          "description": "Define the HTTP header name used for the SHA1 fingerprint of the client certificate.",
          "type": "string",
          "default": "X-Client-Cert-Fingerprint"
        },
        "client_cert_header_name": {
          "description": "Define the HTTP header name used for the PEM format URL encoded client certificate.",
          "type": "string",
          "default": "X-Client-Cert"
        },
        "client_cert_issuer_dn_header_name": {
          "description": "Define the HTTP header name used for the issuer DN of the client certificate.",
          "type": "string",
          "default": "X-Client-Cert-Issuer-DN"
        },
        "client_cert_subject_dn_header_name": {
          "description": "Define the HTTP header name used for the subject DN of the client certificate.",
          "type": "string",
          "default": "X-Client-Cert-Subject-DN"
        },
        "client_serial_header_name": {
          "description": "Define the HTTP header name used for the serial number of the client certificate.",
          "type": "string",
          "default": "X-Client-Cert-Serial"
        },
        "inject_client_cert_details": {
          "description": "Enables TLS client certificate metadata values to be injected into HTTP headers.",
          "type": "boolean",
          "default": false
        }
      }
    },
    "name": {
      "const": "tls-metadata-headers"
    },
    "protocols": {
      "description": "A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.",
      "type": "array",
      "items": {
        "enum": [
          "grpcs",
          "https",
          "tls"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpcs",
        "https"
      ]
    },
    "route": {
      "description": "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.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "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.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}