Common TLS configuration

auth.TlsParameters

[auth.TlsParameters proto]

  1. {
  2.   "tls_minimum_protocol_version": "...",
  3.   "tls_maximum_protocol_version": "...",
  4.   "cipher_suites": [],
  5.   "ecdh_curves": []
  6. }

tls_minimum_protocol_version

(auth.TlsParameters.TlsProtocol) Minimum TLS protocol version.

tls_maximum_protocol_version

(auth.TlsParameters.TlsProtocol) Maximum TLS protocol version.

cipher_suites

(string) If specified, the TLS listener will only support the specified cipher list. If not specified, the default list:

  1. [ECDHE-ECDSA-AES128-GCM-SHA256|ECDHE-ECDSA-CHACHA20-POLY1305]
  2. [ECDHE-RSA-AES128-GCM-SHA256|ECDHE-RSA-CHACHA20-POLY1305]
  3. ECDHE-ECDSA-AES128-SHA
  4. ECDHE-RSA-AES128-SHA
  5. AES128-GCM-SHA256
  6. AES128-SHA
  7. ECDHE-ECDSA-AES256-GCM-SHA384
  8. ECDHE-RSA-AES256-GCM-SHA384
  9. ECDHE-ECDSA-AES256-SHA
  10. ECDHE-RSA-AES256-SHA
  11. AES256-GCM-SHA384
  12. AES256-SHA

will be used.

ecdh_curves

(string) If specified, the TLS connection will only support the specified ECDH curves. If not specified, the default curves (X25519, P-256) will be used.

Enum auth.TlsParameters.TlsProtocol

[auth.TlsParameters.TlsProtocol proto]

TLS_AUTO

(DEFAULT) ⁣Envoy will choose the optimal TLS version.

TLSv1_0

⁣TLS 1.0

TLSv1_1

⁣TLS 1.1

TLSv1_2

⁣TLS 1.2

TLSv1_3

⁣TLS 1.3

auth.TlsCertificate

[auth.TlsCertificate proto]

  1. {
  2.   "certificate_chain": "{...}",
  3.   "private_key": "{...}"
  4. }

certificate_chain

(core.DataSource) The TLS certificate chain.

private_key

(core.DataSource) The TLS private key.

auth.TlsSessionTicketKeys

[auth.TlsSessionTicketKeys proto]

  1. {
  2.   "keys": []
  3. }

keys

(core.DataSource, REQUIRED) Keys for encrypting and decrypting TLS session tickets. The first key in the array contains the key to encrypt all new sessions created by this context. All keys are candidates for decrypting received tickets. This allows for easy rotation of keys by, for example, putting the new key first, and the previous key second.

If session_ticket_keys is not specified, the TLS library will still support resuming sessions via tickets, but it will use an internally-generated and managed key, so sessions cannot be resumed across hot restarts or on different hosts.

Each key must contain exactly 80 bytes of cryptographically-secure random data. For example, the output of openssl rand 80.

Attention

Using this feature has serious security considerations and risks. Improper handling of keys may result in loss of secrecy in connections, even if ciphers supporting perfect forward secrecy are used. See https://www.imperialviolet.org/2013/06/27/botchingpfs.html for some discussion. To minimize the risk, you must:

  • Keep the session ticket keys at least as secure as your TLS certificate private keys
  • Rotate session ticket keys at least daily, and preferably hourly
  • Always generate keys using a cryptographically-secure random data source

auth.CertificateValidationContext

[auth.CertificateValidationContext proto]

  1. {
  2.   "trusted_ca": "{...}",
  3.   "verify_certificate_spki": [],
  4.   "verify_certificate_hash": [],
  5.   "verify_subject_alt_name": [],
  6.   "crl": "{...}",
  7.   "allow_expired_certificate": "..."
  8. }

trusted_ca

(core.DataSource) TLS certificate data containing certificate authority certificates to use in verifying a presented peer certificate (e.g. server certificate for clusters or client certificate for listeners). If not specified and a peer certificate is presented it will not be verified. By default, a client certificate is optional, unless one of the additional options (require_client_certificate, verify_certificate_spki, verify_certificate_hash, or verify_subject_alt_name) is also specified.

See the TLS overview for a list of common system CA locations.

verify_certificate_spki

(string) An optional list of base64-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded Subject Public Key Information (SPKI) of the presented certificate matches one of the specified values.

A base64-encoded SHA-256 of the Subject Public Key Information (SPKI) of the certificate can be generated with the following command:

  1. $ openssl x509 -in path/to/client.crt -noout -pubkey \
  2.   | openssl pkey -pubin -outform DER \
  3.   | openssl dgst -sha256 -binary \
  4.   | openssl enc -base64
  5. NvqYIYSbgK2vCJpQhObf77vv+bQWtc5ek5RIOwPiC9A=

This is the format used in HTTP Public Key Pinning.

When both: verify_certificate_hash and verify_certificate_spki are specified, a hash matching value from either of the lists will result in the certificate being accepted.

Attention

This option is preferred over verify_certificate_hash, because SPKI is tied to a private key, so it doesn’t change when the certificate is renewed using the same private key.

verify_certificate_hash

(string) An optional list of hex-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded presented certificate matches one of the specified values.

A hex-encoded SHA-256 of the certificate can be generated with the following command:

  1. $ openssl x509 -in path/to/client.crt -outform DER | openssl dgst -sha256 | cut -d" " -f2
  2. df6ff72fe9116521268f6f2dd4966f51df479883fe7037b39f75916ac3049d1a

A long hex-encoded and colon-separated SHA-256 (a.k.a. “fingerprint”) of the certificate can be generated with the following command:

  1. $ openssl x509 -in path/to/client.crt -noout -fingerprint -sha256 | cut -d"=" -f2
  2. DF:6F:F7:2F:E9:11:65:21:26:8F:6F:2D:D4:96:6F:51:DF:47:98:83:FE:70:37:B3:9F:75:91:6A:C3:04:9D:1A

Both of those formats are acceptable.

When both: verify_certificate_hash and verify_certificate_spki are specified, a hash matching value from either of the lists will result in the certificate being accepted.

verify_subject_alt_name

(string) An optional list of Subject Alternative Names. If specified, Envoy will verify that the Subject Alternative Name of the presented certificate matches one of the specified values.

Attention

Subject Alternative Names are easily spoofable and verifying only them is insecure, therefore this option must be used together with trusted_ca.

crl

(core.DataSource) An optional certificate revocation list (in PEM format). If specified, Envoy will verify that the presented peer certificate has not been revoked by this CRL. If this DataSource contains multiple CRLs, all of them will be used.

allow_expired_certificate

(bool) If specified, Envoy will not reject expired certificates.

auth.CommonTlsContext

[auth.CommonTlsContext proto]

TLS context shared by both client and server TLS contexts.

  1. {
  2.   "tls_params": "{...}",
  3.   "tls_certificates": [],
  4.   "validation_context": "{...}",
  5.   "alpn_protocols": []
  6. }

tls_params

(auth.TlsParameters) TLS protocol versions, cipher suites etc.

tls_certificates

(auth.TlsCertificate) Multiple TLS certificates can be associated with the same context. E.g. to allow both RSA and ECDSA certificates, two TLS certificates can be configured.

Attention

Although this is a list, currently only a single certificate is supported. This will be relaxed in the future.

validation_context

(auth.CertificateValidationContext) How to validate peer certificates.

Only one of validation_context may be set.

alpn_protocols

(string) Supplies the list of ALPN protocols that the listener should expose. In practice this is likely to be set to one of two values (see the codec_type parameter in the HTTP connection manager for more information):

  • “h2,http/1.1” If the listener is going to support both HTTP/2 and HTTP/1.1.
  • “http/1.1” If the listener is only going to support HTTP/1.1.

There is no default for this parameter. If empty, Envoy will not expose ALPN.

auth.UpstreamTlsContext

[auth.UpstreamTlsContext proto]

  1. {
  2.   "common_tls_context": "{...}",
  3.   "sni": "...",
  4.   "allow_renegotiation": "..."
  5. }

common_tls_context

(auth.CommonTlsContext) Common TLS context settings.

sni

(string) SNI string to use when creating TLS backend connections.

allow_renegotiation

(bool) If true, server-initiated TLS renegotiation will be allowed.

Attention

TLS renegotiation is considered insecure and shouldn’t be used unless absolutely necessary.

auth.DownstreamTlsContext

[auth.DownstreamTlsContext proto]

  1. {
  2.   "common_tls_context": "{...}",
  3.   "require_client_certificate": "{...}",
  4.   "session_ticket_keys": "{...}"
  5. }

common_tls_context

(auth.CommonTlsContext) Common TLS context settings.

require_client_certificate

(BoolValue) If specified, Envoy will reject connections without a valid client certificate.

session_ticket_keys

(auth.TlsSessionTicketKeys) TLS session ticket key settings.

Only one of session_ticket_keys may be set.