http: support appending to predefined inline headers. by htuch · Pull Request #4211 · envoyproxy/envoy

htuch · 2018-08-21T16:24:53Z

Previously we just ASSERTed when performing an addReferenceKey() with a
predefined header. This PR adds support for comma concatenation and
adjusts docs to make clear the contract for value lifetime across the
API surface.

Fixes #3919. Also resolves ClusterFuzz issue
https://oss-fuzz.com/v2/testcase-detail/5107723602493440?noredirect=1.

Risk level: High. This affects header processing and wire representation
of predefined headers when appending.
Testing: Unit/integration tests, corpus entry added.

Signed-off-by: Harvey Tuch htuch@google.com

Previously we just ASSERTed when performing an addReferenceKey() with a predefined header. This PR adds support for comma concatenation and adjusts docs to make clear the contract for value lifetime across the API surface. Fixes envoyproxy#3919. Also resolves ClusterFuzz issue https://oss-fuzz.com/v2/testcase-detail/5107723602493440?noredirect=1. Risk level: High. This affects header processing and wire representation of predefined headers when appending. Testing: Unit/integration tests, corpus entry added. Signed-off-by: Harvey Tuch <htuch@google.com>

alyssawilk

So glad to see this getting fixed! Thank you!

After the recent XFF bug I'd be inclined to give Lyft the option of doing a pre-merge canary, but I think it's up to you and Lyft folks
@ccaraman @junr03 for comment

alyssawilk · 2018-08-21T16:53:48Z

docs/root/intro/version_history.rst

+* http: fixed missing support for appending to predefined inline headers, e.g.
+  *authorization*, in features that interact with request and response headers,
+  e.g. :ref:`request_headers_to_add
+  <envoy_api_field_route.Route.request_headers_to_add>`.


Do you think it's worth calling out that this will change headers that Envoy proxies if it got incoming requests of the form [sample request]?

alyssawilk · 2018-08-21T17:00:20Z

test/common/http/header_map_impl_test.cc

  headers.addReferenceKey(Headers::get().ContentLength, 5);
-  EXPECT_DEBUG_DEATH(headers.addReferenceKey(Headers::get().ContentLength, 6), "");
-  EXPECT_STREQ("5", headers.ContentLength()->value().c_str());
+  headers.addReferenceKey(Headers::get().ContentLength, 6);


Mind adding unit tests for addReference and the other addReferenceKey?

Signed-off-by: Harvey Tuch <htuch@google.com>

htuch · 2018-08-21T18:17:27Z

@alyssawilk good idea on the addition unit tests; they revealed the need to make some terrifying changes to HeaderString::append.

alyssawilk

Oh good, because this PR wasn't scary enough as-is :-P

junr03 · 2018-08-21T18:58:43Z

Thanks for the heads up! @ccaraman and I are going to smoke test this at Lyft tomorrow. Lets wait until we do so to merge.

Signed-off-by: Harvey Tuch <htuch@google.com>

htuch · 2018-08-23T14:02:19Z

@junr03 @ccaraman did you have any luck with the smoke test?

junr03 · 2018-08-23T15:11:56Z

We put on a canary yesterday and left over night. Yesterday metrics looked healthy and no pages over night. I think we can merge, and we'll report back Monday when it rolls out more widely. Anything else to add @ccaraman?

ccaraman · 2018-08-23T21:53:36Z

@htuch nothing out of the ordinary reported! Good to merge in my opinion.

htuch · 2018-08-23T21:59:01Z

Thanks @junr03 @ccaraman

There were some non-local invariants that header_map_impl_fuzz_test surfaced around minimum dynamic buffer size. This PR improves comments and documentation of invariants and fixes the allocation issue to maintain them. Fixes oss-fuzz issue https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=10038. Risk level: Low. It's recommended to bump to this for potential security reasons if you are already post envoyproxy#4211. Testing: Unit test and corpus entry added. Signed-off-by: Harvey Tuch <htuch@google.com>

There were some non-local invariants that header_map_impl_fuzz_test surfaced around minimum dynamic buffer size. This PR improves comments and documentation of invariants and fixes the allocation issue to maintain them. Fixes oss-fuzz issue https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=10038. Risk level: Low. It's recommended to bump to this for potential security reasons if you are already post #4211. Testing: Unit test and corpus entry added. Signed-off-by: Harvey Tuch <htuch@google.com>

Fixing the validation #4211 to do a better job of fast-failing in case of header overflow. Risk Level: Medium: Envoy should crash instead of OOM Testing: new unit test Docs Changes: n/a Release Notes: n/a Includes a unit test for why I filed #4268 Signed-off-by: Alyssa Wilk <alyssar@chromium.org>

Pulling the following changes from github.com/envoyproxy/envoy: f936fc6 ssl: serialize accesses to SSL socket factory contexts (envoyproxy#4345) e34dcd6 Fix crash in tcp_proxy (envoyproxy#4323) ae6a252 router: fix matching when all domains have wildcards (envoyproxy#4326) aa06142 test: Stop fake_upstream methods from accidentally succeeding (envoyproxy#4232) 5d73187 rbac: update the authenticated.user to a StringMatcher. (envoyproxy#4250) c6bfc7d time: Event::TimeSystem abstraction to make it feasible to inject time with simulated timers (envoyproxy#4257) 752483e Fixing the fix (envoyproxy#4333) 83487f6 tls: update BoringSSL to ab36a84b (3497). (envoyproxy#4338) 7bc210e test: fixing interactions between waitFor and ignore_spurious_events (envoyproxy#4309) 69474b3 admin: order stats in clusters json admin (envoyproxy#4306) 2d155f9 ppc64le build (envoyproxy#4183) 07efc6d fix static initialization fiasco problem (envoyproxy#4314) 0b7e3b5 test: Remove declared but undefined class methods (envoyproxy#4297) 1485a13 lua: make sure resetting dynamic metadata wrapper when request info is marked dead d243cd6 test: set to zero when start_time exceeds limit (envoyproxy#4328) 0a1e92a test: fix heap use-after-free in ~IntegrationTestServer. (envoyproxy#4319) cddc732 CONTRIBUTING: Document 'kick-ci' trick. (envoyproxy#4335) f13ef24 docs: remove reference to deprecated value field (envoyproxy#4322) e947a27 router: minor doc fixes in stream idle timeout (envoyproxy#4329) 0c2e998 tcp-proxy: fixing a TCP proxy bug where we attempted to readDisable a closed connection (envoyproxy#4296) 00ffe44 utility: fix strftime overflow handling. (envoyproxy#4321) af1183c Re-enable TcpProxySslIntegrationTest and make the tests pass again. (envoyproxy#4318) 3553461 fuzz: fix H2 codec fuzzer post envoyproxy#4262. (envoyproxy#4311) 42f6048 Proto string issue fix (envoyproxy#4320) 9c492a0 Support Envoy to fetch secrets using SDS service. (envoyproxy#4256) a857219 ratelimit: revert `revert rate limit failure mode config` and add tests (envoyproxy#4303) 1d34172 dns: fix exception unsafe behavior in c-ares callbacks. (envoyproxy#4307) 1212423 alts: add gRPC TSI socket (envoyproxy#4153) f0363ae fuzz: detect client-side resets in H2 codec fuzzer. (envoyproxy#4300) 01aa3f8 test: hopefully deflaking echo integration test (envoyproxy#4304) 1fc0f4b ratelimit: link legacy proto when message is being used (envoyproxy#4308) aa4481e fix rare List::remove(&target) segfault (envoyproxy#4244) 89e0f23 headers: fixing fast fail of size-validation (envoyproxy#4269) 97eba59 build: bump googletest version. (envoyproxy#4293) 0057e22 fuzz: avoid false positives in HCM fuzzer. (envoyproxy#4262) 9d094e5 Revert ac0bd74 (envoyproxy#4295) ddb28a4 Add validation context provider (envoyproxy#4264) 3b47cba added histogram latency information to Hystrix dashboard stream (envoyproxy#3986) cf87d50 docs: update SNI FAQ. (envoyproxy#4285) f952033 config: fix update empty stat for eds (envoyproxy#4276) 329e591 router: Add ability of custom headers to rely on per-request data (envoyproxy#4219) 68d20b4 thrift: refactor build files and imports (envoyproxy#4271) 5fa8192 access_log: log requested_server_name in tcp proxy (envoyproxy#4144) fa45bb4 fuzz: libc++ clocks don't like nanos. (envoyproxy#4282) 53f8944 stats: add symbol table for future stat name encoding (envoyproxy#3927) c987b42 test infra: Remove timeSource() from the ClusterManager api (envoyproxy#4247) cd171d9 websocket: tunneling websockets (and upgrades in general) over H2 (envoyproxy#4188) b9dc5d9 router: disallow :path/host rewriting in request_headers_to_add. (envoyproxy#4220) 0c91011 network: skip socket options and source address for UDS client connections (envoyproxy#4252) da1857d build: fixing a downstream compile error by noting explicit fallthrough (envoyproxy#4265) 9857cfe fuzz: cleanup per-test environment after each fuzz case. (envoyproxy#4253) 52beb06 test: Wrap proto string in std::string before comparison (envoyproxy#4238) f5e219e extensions/thrift_proxy: Add header matching to thrift router (envoyproxy#4239) c9ce5d2 fuzz: track read_disable_count bidirectionally in codec_impl_fuzz_test. (envoyproxy#4260) 35103b3 fuzz: use nanoseconds for SystemTime in RequestInfo. (envoyproxy#4255) ba6ba98 fuzz: make runtime root hermetic in server_fuzz_test. (envoyproxy#4258) b0a9014 time: Add 'format' test to ensure no one directly instantiates Prod*Time from source. (envoyproxy#4248) 8567460 access_log: support beginning of epoch in START_TIME. (envoyproxy#4254) 28d5f41 proto: unify envoy_proto_library/api_proto_library. (envoyproxy#4233) f7d3cb6 http: fix allocation bug introduced in envoyproxy#4211. (envoyproxy#4245) Fixes istio/istio#8310 (once pulled into istio/istio). Signed-off-by: Piotr Sikora <piotrsikora@google.com>

htuch requested a review from alyssawilk August 21, 2018 16:24

htuch assigned alyssawilk Aug 21, 2018

htuch changed the title ~~http: support appending to prefined inline headers.~~ http: support appending to predefined inline headers. Aug 21, 2018

alyssawilk suggested changes Aug 21, 2018

View reviewed changes

Review feedback.

243ceac

Signed-off-by: Harvey Tuch <htuch@google.com>

alyssawilk previously approved these changes Aug 21, 2018

View reviewed changes

htuch added 2 commits August 21, 2018 17:52

Merge remote-tracking branch 'upstream/master' into fix-headers-to-add

36fd07a

Fix ASAN.

3956490

Signed-off-by: Harvey Tuch <htuch@google.com>

htuch dismissed alyssawilk’s stale review via 3956490 August 21, 2018 21:57

alyssawilk approved these changes Aug 22, 2018

View reviewed changes

htuch merged commit f4ac32b into envoyproxy:master Aug 23, 2018

htuch deleted the fix-headers-to-add branch August 23, 2018 21:59

htuch mentioned this pull request Aug 24, 2018

http: fix allocation bug introduced in #4211. #4245

Merged

alyssawilk mentioned this pull request Aug 27, 2018

headers: fixing fast fail of size-validation #4269

Merged

snowp mentioned this pull request Oct 26, 2018

http: inline Accept header #4868

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

http: support appending to predefined inline headers.#4211

http: support appending to predefined inline headers.#4211
htuch merged 4 commits intoenvoyproxy:masterfrom
htuch:fix-headers-to-add

htuch commented Aug 21, 2018

Uh oh!

alyssawilk left a comment

Uh oh!

alyssawilk Aug 21, 2018

Uh oh!

alyssawilk Aug 21, 2018

Uh oh!

htuch commented Aug 21, 2018

Uh oh!

alyssawilk left a comment

Uh oh!

junr03 commented Aug 21, 2018

Uh oh!

htuch commented Aug 23, 2018

Uh oh!

junr03 commented Aug 23, 2018

Uh oh!

ccaraman commented Aug 23, 2018

Uh oh!

htuch commented Aug 23, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

htuch commented Aug 21, 2018

Uh oh!

alyssawilk left a comment

Choose a reason for hiding this comment

Uh oh!

alyssawilk Aug 21, 2018

Choose a reason for hiding this comment

Uh oh!

alyssawilk Aug 21, 2018

Choose a reason for hiding this comment

Uh oh!

htuch commented Aug 21, 2018

Uh oh!

alyssawilk left a comment

Choose a reason for hiding this comment

Uh oh!

junr03 commented Aug 21, 2018

Uh oh!

htuch commented Aug 23, 2018

Uh oh!

junr03 commented Aug 23, 2018

Uh oh!

ccaraman commented Aug 23, 2018

Uh oh!

htuch commented Aug 23, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants