Skip to main content
Version: 2.12

tls

Hot Reloadable
On 2.11/2.12 the reload reports success; the new TLS material is used only after a restart.

TLS configuration for connecting/authenticating with the remote if mutual TLS is required.

Properties

NameDescriptionTypeDefaultReloadable
allow_insecure_cipher_suitesPermit cipher suites Go considers insecure to be named in cipher_suites. Without it those names are rejected.booleanfalseYes
cert_storeLoad the certificate from an OS certificate store rather than a file. Windows only.string-Yes
certsMultiple certificate/key pairs to serve, so one listener can present different certificates to different clients. Use this instead of cert_file and key_file.object-Yes
handshake_firstForce the leafnode connection to use a TLS-first handshake prior to the remote sending the INFO protocol message. Note, this option must be set to true on both the remote server accepting the leafnode connections as well as the leafnode itself.booleanfalseYes*
min_versionLowest TLS version the server will negotiate.string-Yes
ocsp_peerVerify the peer's certificate against its OCSP responder and reject revoked certificates. Set an object to tune the checks.(multiple)falseYes
cert_fileTLS certificate file.string-Yes*
key_fileTLS certificate key file.string-Yes*
ca_fileTLS certificate authority file. Defaults to system trust store.string-Yes*
cipher_suitesWhen set, only the specified TLS cipher suites will be allowed. Values must match the golang version used to build the server.string-Yes*
curve_preferencesList of TLS cipher curves to use in order.string-Yes*
insecureSkip certificate verification. This only applies to outgoing connections, NOT incoming client connections. not recommended.boolean-Yes*
timeoutTLS handshake timeout.duration500msNo
verifyIf true, require and verify client certificates. Does not apply to monitoring.booleanfalseYes*
verify_and_mapIf true, require and verify client certificates and map certificate values for authentication. Does not apply to monitoring.booleanfalseIgnored*
connection_rate_limitinteger-Ignored*
pinned_certsList of hex-encoded SHA256 of DER-encoded public key fingerprints. When present, during the TLS handshake, the provided certificate's fingerprint is required to be present in the list, otherwise the connection will be closed.string-Ignored*

* See the property page for reload caveats.