Below we articulate the Envoy threat model, which is of relevance to Envoy operators, developers and security researchers. We detail our security release process at https://github.com/envoyproxy/envoy/security/policy.
Confidentiality, integrity and availability
We consider vulnerabilities leading to the compromise of data confidentiality or integrity to be our highest priority concerns. Availability, in particular in areas relating to DoS and resource exhaustion, is also a serious security concern for Envoy operators, in particular those utilizing Envoy in edge deployments.
We will activate the security release process for disclosures that meet the following criteria:
All issues that lead to loss of data confidentiality or integrity trigger the security release process.
An availability issue, such as Query-of-Death (QoD) or resource exhaustion needs to meet all of the following criteria to trigger the security release process:
A component tagged as hardened is affected (see Core and extensions for the list of hardened components).
The type of traffic (upstream or downstream) that exhibits the issue matches the component’s hardening tag. I.e. component tagged as “hardened to untrusted downstream” is affected by downstream request.
A resource exhaustion issue needs to meet these additional criteria:
Not covered by an existing timeout or where applying short timeout values is impractical and either
Memory exhaustion, including out of memory conditions, where per-request memory use 100x or more above the configured header or high watermark limit. I.e. 10 KiB client request leading to 1 MiB bytes of memory consumed by Envoy;
Highly asymmetric CPU utilization where Envoy uses 100x or more CPU compared to client.
The Envoy availability stance around CPU and memory DoS is still evolving, especially for brute force attacks. We acknowledge that brute force (i.e. these with amplification factor less than 100) attacks are likely for Envoy deployments as part of cloud infrastructure or with the use of botnets. We will continue to iterate and fix well known resource issues in the open, e.g. overload manager and watermark improvements. We will activate the security process for brute force disclosures that appear to present a risk to existing Envoy deployments.
Note that we do not currently consider the default settings for Envoy to be safe from an availability perspective. It is necessary for operators to explicitly configure watermarks, the overload manager, circuit breakers and other resource related features in Envoy to provide a robust availability story. We will not act on any security disclosure that relates to a lack of safe defaults. Over time, we will work towards improved safe-by-default configuration, but due to backwards compatibility and performance concerns, this will require following the breaking change deprecation policy.
Data and control plane
We divide our threat model into data and control plane, reflecting the internal division in Envoy of these concepts from an architectural perspective. Envoy’s core components are considered to be hardened against both untrusted downstream and upstream peers. As such our highest priority in risk assessment is the threat posed by untrusted downstream client or untrusted upstream server traffic on the data plane. This reflects the use of Envoy in an edge serving capacity and also the use of Envoy as a networking component in a service mesh deployment with unstrusted services.
The control plane management server is generally trusted. We do not consider wire-level exploits
against the xDS transport protocol to be a concern as a result. However, the configuration delivered
to Envoy over xDS may originate from untrusted sources and may not be fully sanitized. An example of
this might be a service operator that hosts multiple tenants on an Envoy, where tenants may specify
a regular expression on a header match in
RouteConfiguration. In this case, we expect that Envoy
is resilient against the risks posed by malicious configuration from a confidentiality, integrity
and availability perspective, as described above.
We generally assume that services utilized for side calls during the request processing, e.g. external authorization, credential suppliers, rate limit services, are trusted. When this is not the case, an extension will explicitly state this in its documentation.
Core and extensions
Anything in the Envoy core may be used in both untrusted and trusted deployments, with the exception of features explicitly marked as alpha; alpha features are only supported in trusted deployments and do not qualify for treatment under the threat model below. As a consequence, the stable core should be hardened with this model in mind. Security issues related to core code will usually trigger the security release process as described in this document.
contrib extensions are noted below and are not officially covered by the threat model or the Envoy security team. All indications below are best effort.
The following extensions are intended to be hardened against untrusted downstream and upstreams:
The following extensions should not be exposed to data plane attack vectors and hence are intended to be robust to untrusted downstreams and upstreams:
The following extensions are intended to be hardened against untrusted downstreams but assume trusted upstreams:
envoy.filters.http.sxg (alpha) (contrib builds only)
envoy.tls.key_providers.cryptomb (alpha) (contrib builds only)
envoy.tls.key_providers.qat (alpha) (contrib builds only)
The following extensions should only be used when both the downstream and upstream are trusted:
envoy.bootstrap.vcl (alpha) (contrib builds only)
envoy.filters.http.golang (alpha) (contrib builds only)
envoy.filters.http.language (alpha) (contrib builds only)
envoy.filters.network.mysql_proxy (alpha) (contrib builds only)
envoy.filters.network.rocketmq_proxy (alpha) (contrib builds only)
envoy.filters.network.sip_proxy (alpha) (contrib builds only)
envoy.filters.sip.router (alpha) (contrib builds only)
envoy.matching.input_matchers.hyperscan (alpha) (contrib builds only)
envoy.network.connection_balance.dlb (alpha) (contrib builds only)
envoy.regex_engines.hyperscan (alpha) (contrib builds only)
envoy.router.cluster_specifier_plugin.golang (alpha) (contrib builds only)
The following extensions have an unknown security posture:
Envoy currently has two dynamic filter extensions that support loadable code; WASM and Lua. In both cases, we assume that the dynamically loaded code is trusted. We expect the runtime for Lua to be robust to untrusted data plane traffic with the assumption of a trusted script. WASM is still in development, but will eventually have a similar security stance.