envoyproxy/envoy

Avoid using HeaderMapImpl for gRPC metadata

Open

#7,921 opened on Aug 14, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/securitybughelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Today, we use HeaderMapImpl for gRPC metadata, e.g. https://github.com/envoyproxy/envoy/blob/3dd84d3b41b6be378ccb71e81c0063a84bb956e3/include/envoy/grpc/async_client.h#L70. This is not safe, since in general, this metadata may contain binary and HeaderMapImpl can't contain NUL.

We should switch to using a simple map or the like to model these values, treating them as metadata rather than headers.

Contributor guide

Research direction
Identify all locations where HeaderMapImpl is used for gRPC metadata and replace with a container that supports binary keys and values, such as std::map or absl::flat hash map.
Tech stack
cpp
Domain
networking
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++gRPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30