Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

http: add functionality to configure kill header in KillRequest proto #14288

Merged
merged 2 commits into from
Dec 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;
message KillRequest {
// The probability that a Kill request will be triggered.
type.v3.FractionalPercent probability = 1;

// The name of the kill request header. If this field is not empty, it will override the :ref:`default header <config_http_filters_kill_request_http_header>` name. Otherwise the default header name will be used.
string kill_request_header = 2;
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Configuration
Enable Kill Request via HTTP header
--------------------------------------------

The KillRequest filter requires the following header in the request:
The KillRequest filter requires a kill header in the request. If *kill_request_header* is not empty in *KillRequest* proto, the name of the kill header must match *KillRequest.kill_request_header*, otherwise it must match the default kill header below:

x-envoy-kill-request
whether the request is a Kill request.
Expand Down
1 change: 1 addition & 0 deletions docs/root/version_history/current.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Minor Behavior Changes
* grpc_web filter: if a `grpc-accept-encoding` header is present it's passed as-is to the upstream and if it isn't `grpc-accept-encoding:identity` is sent instead. The header was always overwriten with `grpc-accept-encoding:identity,deflate,gzip` before.
* http: upstream protocol will now only be logged if an upstream stream was established.
* jwt_authn filter: added support of Jwt time constraint verification with a clock skew (default to 60 seconds) and added a filter config field :ref:`clock_skew_seconds <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.clock_skew_seconds>` to configure it.
* kill_request: enable a way to configure kill header name in KillRequest proto.
* memory: enable new tcmalloc with restartable sequences for aarch64 builds.
* mongo proxy metrics: swapped network connection remote and local closed counters previously set reversed (`cx_destroy_local_with_active_rq` and `cx_destroy_remote_with_active_rq`).
* tls: removed RSA key transport and SHA-1 cipher suites from the client-side defaults.
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,12 @@ bool KillRequestFilter::isKillRequestEnabled() {
}

Http::FilterHeadersStatus KillRequestFilter::decodeHeaders(Http::RequestHeaderMap& headers, bool) {
const auto kill_request_header = headers.get(KillRequestHeaders::get().KillRequest);
// If not empty, configured kill header name will override the default header name.
const Http::LowerCaseString kill_request_header_name =
kill_request_.kill_request_header().empty()
? KillRequestHeaders::get().KillRequest
: Http::LowerCaseString(kill_request_.kill_request_header());
const auto kill_request_header = headers.get(kill_request_header_name);
bool is_kill_request = false;
// This is an implicitly untrusted header, so per the API documentation only
// the first value is used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ INSTANTIATE_TEST_SUITE_P(Protocols, KillRequestFilterIntegrationTestAllProtocols
testing::ValuesIn(HttpProtocolIntegrationTest::getProtocolTestParams()),
HttpProtocolIntegrationTest::protocolTestParamsToString);

// Request abort controlled via header configuration.
// Request crash Envoy controlled via header configuration.
TEST_P(KillRequestFilterIntegrationTestAllProtocols, KillRequestCrashEnvoy) {
initializeFilter(filter_config_);
codec_client_ = makeHttpConnection(makeClientConnection(lookupPort("http")));
Expand All @@ -46,6 +46,29 @@ TEST_P(KillRequestFilterIntegrationTestAllProtocols, KillRequestCrashEnvoy) {
"");
}

TEST_P(KillRequestFilterIntegrationTestAllProtocols, KillRequestCrashEnvoyWithCustomKillHeader) {
const std::string filter_config_with_custom_kill_header =
R"EOF(
name: envoy.filters.http.kill_request
typed_config:
"@type": type.googleapis.com/envoy.extensions.filters.http.kill_request.v3.KillRequest
probability:
numerator: 100
kill_request_header: "x-custom-kill-request"
)EOF";

initializeFilter(filter_config_with_custom_kill_header);
codec_client_ = makeHttpConnection(makeClientConnection(lookupPort("http")));
Http::TestRequestHeaderMapImpl request_headers{{":method", "GET"},
{":path", "/test/long/url"},
{":scheme", "http"},
{":authority", "host"},
{"x-custom-kill-request", "true"}};

EXPECT_DEATH(sendRequestAndWaitForResponse(request_headers, 0, default_response_headers_, 1024),
"");
}

TEST_P(KillRequestFilterIntegrationTestAllProtocols, KillRequestDisabledWhenHeaderIsMissing) {
initializeFilter(filter_config_);
codec_client_ = makeHttpConnection(makeClientConnection(lookupPort("http")));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,17 @@ TEST_F(KillRequestFilterTest, KillRequestCrashEnvoy) {
EXPECT_DEATH(filter_->decodeHeaders(request_headers_, false), "");
}

TEST_F(KillRequestFilterTest, KillRequestCrashEnvoyWithCustomKillHeader) {
envoy::extensions::filters::http::kill_request::v3::KillRequest kill_request;
kill_request.mutable_probability()->set_numerator(1);
kill_request.set_kill_request_header("x-custom-kill-request");
setUpTest(kill_request);
request_headers_.addCopy("x-custom-kill-request", "true");

ON_CALL(random_generator_, random()).WillByDefault(Return(0));
EXPECT_DEATH(filter_->decodeHeaders(request_headers_, false), "");
}

TEST_F(KillRequestFilterTest, KillRequestWithMillionDenominatorCrashEnvoy) {
envoy::extensions::filters::http::kill_request::v3::KillRequest kill_request;
kill_request.mutable_probability()->set_numerator(1);
Expand Down