Secret discovery service (SDS)

TLS certificates, the secrets, can be specified in the bootstrap.static_resource secrets. But they can also be fetched remotely by secret discovery service (SDS).

The most important benefit of SDS is to simplify the certificate management. Without this feature, in k8s deployment, certificates must be created as secrets and mounted into the proxy containers. If certificates are expired, the secrets need to be updated and the proxy containers need to be re-deployed. With SDS, a central SDS server will push certificates to all Envoy instances. If certificates are expired, the server just pushes new certificates to Envoy instances, Envoy will use the new ones right away without re-deployment.

If a listener server certificate needs to be fetched by SDS remotely, it will NOT be marked as active, its port will not be opened before the certificates are fetched. If Envoy fails to fetch the certificates due to connection failures, or bad response data, the listener will be marked as active, and the port will be open, but the connection to the port will be reset.

Upstream clusters are handled in a similar way, if a cluster client certificate needs to be fetched by SDS remotely, it will NOT be marked as active and it will not be used before the certificates are fetched. If Envoy fails to fetch the certificates due to connection failures, or bad response data, the cluster will be marked as active, it can be used to handle the requests, but the requests routed to that cluster will be rejected.

If a static cluster is using SDS, and it needs to define a SDS cluster (unless Google gRPC is used which doesn’t need a cluster), the SDS cluster has to be defined before the static clusters using it.

The connection between Envoy proxy and SDS server has to be secure. One option is to run the SDS server on the same host and use Unix Domain Socket for the connection. Otherwise the connection requires TLS with authentication between the proxy and SDS server. Credential types in use today for authentication are:

  • mTLS – In this case, the client certificates for the SDS connection must be statically configured.

  • AWS IAM SigV4

SDS server

A SDS server needs to implement the gRPC service SecretDiscoveryService. It follows the same protocol as other xDS.

SDS Configuration

SdsSecretConfig is used to specify the secret. Its field name is a required field. If its sds_config field is empty, the name field specifies the secret in the bootstrap static_resource secrets. Otherwise, it specifies the SDS server as ConfigSource. Only gRPC is supported for the SDS service so its api_config_source must specify a grpc_service.

SdsSecretConfig is used in two fields in CommonTlsContext. The first field is tls_certificate_sds_secret_configs to use SDS to get TlsCertificate. The second field is validation_context_sds_secret_config to use SDS to get CertificateValidationContext.

Examples one: static_resource

This example show how to configure secrets in the static_resource:

  1. static_resources:
  2.   secrets:
  3.     - name: server_cert
  4.       tls_certificate:
  5.         certificate_chain:
  6.           filename: certs/servercert.pem
  7.         private_key:
  8.           filename: certs/serverkey.pem
  9.     - name: client_cert
  10.       tls_certificate:
  11.         certificate_chain:
  12.           filename: certs/clientcert.pem
  13.         private_key:
  14.           filename: certs/clientkey.pem
  15.     - name: validation_context
  16.       validation_context:
  17.         trusted_ca:
  18.           filename: certs/cacert.pem
  19.         verify_certificate_hash:
  20.           E0:F3:C8:CE:5E:2E:A3:05:F0:70:1F:F5:12:E3:6E:2E:97:92:82:84:A2:28:BC:F7:73:32:D3:39:30:A1:B6:FD
  21.   clusters:
  22.     - connect_timeout: 0.25s
  23.       load_assignment:
  24.         cluster_name: local_service_tls
  25.         ...
  26.         transport_socket:
  27.           name: envoy.transport_sockets.tls
  28.           typed_config:
  29.             "@type": type.googleapis.com/envoy.api.v2.auth.UpstreamTlsContext
  30.             common_tls_context:
  31.               tls_certificate_sds_secret_configs:
  32.               - name: client_cert
  33.   listeners:
  34.     ....
  35.     filter_chains:
  36.       transport_socket:
  37.         name: envoy.transport_sockets.tls
  38.         typed_config:
  39.           "@type": type.googleapis.com/envoy.api.v2.auth.DownstreamTlsContext
  40.           common_tls_context:
  41.             tls_certificate_sds_secret_configs:
  42.             - name: server_cert
  43.             validation_context_sds_secret_config:
  44.               name: validation_context

In this example, certificates are specified in the bootstrap static_resource, they are not fetched remotely. In the config, secrets static resource has 3 secrets: client_cert, server_cert and validation_context. In the cluster config, one of hosts uses client_cert in its tls_certificate_sds_secret_configs. In the listeners section, one of them uses server_cert in its tls_certificate_sds_secret_configs and validation_context for its validation_context_sds_secret_config.

Examples two: SDS server

This example shows how to configure secrets fetched from remote SDS servers:

  1. clusters:
  2.   - name: sds_server_mtls
  3.     http2_protocol_options: {}
  4.     load_assignment:
  5.       cluster_name: sds_server_mtls
  6.       endpoints:
  7.       - lb_endpoints:
  8.         - endpoint:
  9.             address:
  10.               socket_address:
  11.                 address: 127.0.0.1
  12.                 port_value: 8234
  13.     transport_socket:
  14.       name: envoy.transport_sockets.tls
  15.       typed_config:
  16.         "@type": type.googleapis.com/envoy.api.v2.auth.UpstreamTlsContext
  17.         common_tls_context:
  18.         - tls_certificate:
  19.           certificate_chain:
  20.             filename: certs/sds_cert.pem
  21.           private_key:
  22.             filename: certs/sds_key.pem
  23.   - name: sds_server_uds
  24.     http2_protocol_options: {}
  25.     load_assignment:
  26.       cluster_name: sds_server_uds
  27.       endpoints:
  28.       - lb_endpoints:
  29.         - endpoint:
  30.             address:
  31.               pipe:
  32.                 path: /tmp/uds_path
  33.   - name: example_cluster
  34.     connect_timeout: 0.25s
  35.     load_assignment:
  36.       cluster_name: local_service_tls
  37.       ...
  38.       transport_socket:
  39.       name: envoy.transport_sockets.tls
  40.       typed_config:
  41.         "@type": type.googleapis.com/envoy.api.v2.auth.UpstreamTlsContext
  42.           common_tls_context:
  43.             tls_certificate_sds_secret_configs:
  44.             - name: client_cert
  45.               sds_config:
  46.                 api_config_source:
  47.                   api_type: GRPC
  48.                   grpc_services:
  49.                     google_grpc:
  50.                       target_uri: unix:/tmp/uds_path
  51. listeners:
  52.   ....
  53.   filter_chains:
  54.   - transport_socket:
  55.       name: envoy.transport_sockets.tls
  56.       typed_config:
  57.         "@type": type.googleapis.com/envoy.api.v2.auth.DownstreamTlsContext
  58.         common_tls_context:
  59.           tls_certificate_sds_secret_configs:
  60.           - name: server_cert
  61.             sds_config:
  62.               api_config_source:
  63.                 api_type: GRPC
  64.                 grpc_services:
  65.                   envoy_grpc:
  66.                     cluster_name: sds_server_mtls
  67.           validation_context_sds_secret_config:
  68.             name: validation_context
  69.             sds_config:
  70.               api_config_source:
  71.                 api_type: GRPC
  72.                 grpc_services:
  73.                   envoy_grpc:
  74.                     cluster_name: sds_server_uds

For illustration, above example uses three methods to access the SDS server. A gRPC SDS server can be reached by Unix Domain Socket path /tmp/uds_path and 127.0.0.1:8234 by mTLS. It provides three secrets, client_cert, server_cert and validation_context. In the config, cluster example_cluster certificate client_cert is configured to use Google gRPC with UDS to talk to the SDS server. The Listener needs to fetch server_cert and validation_context from the SDS server. The server_cert is using Envoy gRPC with cluster sds_server_mtls configured with client certificate to use mTLS to talk to SDS server. The validate_context is using Envoy gRPC with cluster sds_server_uds configured with UDS path to talk to the SDS server.

Statistics

SSL socket factory outputs following SDS related statistics. They are all counter type.

For downstream listeners, they are in the listener..server_ssl_socket_factory. namespace.

Name

Description

ssl_context_update_by_sds

Total number of ssl context has been updated.

downstream_context_secrets_not_ready

Total number of downstream connections reset due to empty ssl certificate.

For upstream clusters, they are in the cluster..client_ssl_socket_factory. namespace.

Name

Description

ssl_context_update_by_sds

Total number of ssl context has been updated.

upstream_context_secrets_not_ready

Total number of upstream connections reset due to empty ssl certificate.