TLS Metadata Headers

Overview Examples Configuration reference Changelog

Configuration

configobject

Hide Child Parameters

client_cert_fingerprint_header_namestring

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

Default:X-Client-Cert-Fingerprint

client_cert_header_namestring

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

Default:X-Client-Cert

client_cert_issuer_dn_header_namestring

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

Default:X-Client-Cert-Issuer-DN

client_cert_subject_dn_header_namestring

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

Default:X-Client-Cert-Subject-DN

client_serial_header_namestring

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

Default:X-Client-Cert-Serial

inject_client_cert_detailsboolean

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

Default:false

protocolsarray[string]

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.

Allowed values:grpcshttpstls

Default:grpcs, 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

TLS Metadata Headers

Configuration

Did this doc help?

Help us make these docs great!

Still need help