Google Vulnerability Reward Program (VRP)¶
Envoy is a participant in Google’s Vulnerability Reward Program (VRP). This is open to all security researchers and will provide rewards for vulnerabilities discovered and reported according to the rules below.
The goal of the VRP is to provide a formal process to honor contributions from external security researchers to Envoy’s security. Vulnerabilities should meet the following conditions to be eligible for the program:
Vulnerabilities must not be previously known in a public forum, e.g. GitHub issues trackers, CVE databases (when previously associated with Envoy), etc. Existing CVEs that have not been previously associated with an Envoy vulnerability are fair game.
Vulnerabilities must not be also submitted to a parallel reward program run by Google or Lyft.
Rewards are at the discretion of the Envoy OSS security team and Google. They will be conditioned on the above criteria. If multiple instances of the same vulnerability are reported at the same time by independent researchers or the vulnerability is already tracked under embargo by the OSS Envoy security team, we will aim to fairly divide the reward amongst reporters.
The base threat model matches that of Envoy’s OSS security posture. We add a number of temporary restrictions to provide a constrained attack surface for the initial stages of this program. We exclude any threat from:
Untrusted control planes.
Runtime services such as access logging, external authorization, etc.
DoS attacks except as stipulated below.
Any filters apart from the HTTP connection manager network filter and HTTP router filter.
Admin console; this is disabled in the execution environment.
We also explicitly exclude any local attacks (e.g. via local processes, shells, etc.) against the Envoy process. All attacks must occur via the network data plane on port 10000. Similarly, kernel and Docker vulnerabilities are outside the threat model.
In the future we may relax some of these restrictions as we increase the sophistication of the program’s execution environment.
We supply Docker images that act as the reference environment for this program:
envoyproxy/envoy-google-vrp images are based on Envoy point releases. Only the latest point release at the time of vulnerability submission is eligible for the program. The first point release available for VRP will be the 1.15.0 Envoy release.
envoyproxy/envoy-google-vrp-dev images are based on Envoy master builds. Only builds within the last 5 days at the time of vulnerability submission are eligible for the program. They must not be subject to any publicly disclosed vulnerability at that point in time.
Two Envoy processes are available when these images are launched via docker run:
The edge Envoy is listening on ports 10000 (HTTPS). It has a static configuration that is configured according to Envoy’s edge hardening principles. It has sinkhole, direct response and request forwarding routing rules (in order):
/content/*: route to the origin Envoy server.
/*: return 403 (denied).
The origin Envoy is an upstream of the edge Envoy. It has a static configuration that features only direct responses, effectively acting as an HTTP origin server. There are two route rules (in order):
/blockedz: return 200 hidden treasure. It should never be possible to have traffic on the Envoy edge server’s 10000 port receive this response unless a qualifying vulnerability is present.
/*: return 200 normal.
When running the Docker images, the following command line options should be supplied:
-m 3g to ensure that memory is bounded to 3GB. At least this much memory should be available to the execution environment. Each Envoy process has an overload manager configured to limit at 1GB.
-e ENVOY_EDGE_EXTRA_ARGS=”<…>” supplies additional CLI args for the edge Envoy. This needs to be set but can be empty.
-e ENVOY_ORIGIN_EXTRA_ARGS=”<…>” supplies additional CLI args for the origin Envoy. This needs to be set but can be empty.
Vulnerabilities will be evidenced by requests on 10000 that trigger a failure mode that falls into one of these categories:
Query-of-death: requests that cause the Envoy process to segfault or abort in some immediate way.
OOM: requests that cause the edge Envoy process to OOM. There should be no more than 100 connections and streams in total involved to cause this to happen (i.e. brute force connection/stream DoS is excluded).
Routing rule bypass: requests that are able to access hidden treasure.
TLS certificate exfiltration: requests that are able to obtain the edge Envoy’s serverkey.pem.
Remote code exploits: any root shell obtained via the network data plane.
At the discretion of the OSS Envoy security team, sufficiently interesting vulnerabilities that don’t fit the above categories but are likely to fall into the category of high or critical vulnerabilities.
Working with the Docker images¶
A basic invocation of the execution environment that will bring up the edge Envoy on local port 10000 looks like:
docker run -m 3g -p 10000:10000 --name envoy-google-vrp \ -e ENVOY_EDGE_EXTRA_ARGS="" \ -e ENVOY_ORIGIN_EXTRA_ARGS="" \ envoyproxy/envoy-google-vrp-dev:latest
When debugging, additional args may prove useful, e.g. in order to obtain trace logs, make use of wireshark and gdb:
docker run -m 3g -p 10000:10000 --name envoy-google-vrp \ -e ENVOY_EDGE_EXTRA_ARGS="-l trace" \ -e ENVOY_ORIGIN_EXTRA_ARGS="-l trace" \ --cap-add SYS_PTRACE --cap-add NET_RAW --cap-add NET_ADMIN \ envoyproxy/envoy-google-vrp-dev:latest
You can obtain a shell in the Docker container with:
docker exec -it envoy-google-vrp /bin/bash
The Docker images include gdb, strace, tshark (feel free to contribute other suggestions via PRs updating the Docker build file).
Rebuilding the Docker image¶
It’s helpful to be able to regenerate your own Docker base image for research purposes. To do this without relying on CI, follow the instructions at the top of ci/docker_rebuild_google-vrp.sh. An example of this flow looks like:
bazel build //source/exe:envoy-static ./ci/docker_rebuild_google-vrp.sh bazel-bin/source/exe/envoy-static docker run -m 3g -p 10000:10000 --name envoy-google-vrp \ -e ENVOY_EDGE_EXTRA_ARGS="" \ -e ENVOY_ORIGIN_EXTRA_ARGS="" \ envoy-google-vrp:local