Skip to main content

eggfetch_core/
headers.rs

1//! Header container.
2
3use std::fmt;
4
5use http::header::{HeaderMap, HeaderName, HeaderValue};
6
7use crate::error::{Error, Result};
8
9/// Maximum serialized size of an outbound request's headers.
10pub(crate) const MAX_REQUEST_HEADER_BYTES: usize = 64 * 1024;
11
12/// Case-insensitive HTTP header container.
13///
14/// `Debug` formatting redacts values for header names recognised as
15/// sensitive (see [`crate::redact::SENSITIVE_HEADERS`]) so that
16/// logging, error formatting, and panic messages do not leak
17/// credentials.  Ordinary iteration (`iter`, `get`, `get_all`,
18/// `keys`) is intentionally **not** redacted — diagnostics are the
19/// only output channel that needs to be safe by default.
20#[derive(Default, Clone)]
21pub struct Headers {
22    inner: HeaderMap,
23}
24
25impl Headers {
26    /// Create an empty header container.
27    #[must_use]
28    pub fn new() -> Self {
29        Self::default()
30    }
31
32    /// Insert a header, replacing any existing value with the same name.
33    ///
34    /// # Errors
35    ///
36    /// Returns an error if the name or value is not valid.
37    pub fn insert(&mut self, name: &str, value: &str) -> Result<()> {
38        validate_header_name(name)?;
39        validate_header_value(value)?;
40        let name =
41            HeaderName::try_from(name).map_err(|e| Error::InvalidHeaderName(e.to_string()))?;
42        let value =
43            HeaderValue::try_from(value).map_err(|e| Error::InvalidHeaderValue(e.to_string()))?;
44        self.inner.insert(name, value);
45        Ok(())
46    }
47
48    /// Insert a header without validation (wire-decoded path).
49    ///
50    /// This bypasses [`validate_header_value`] intentionally: proxy and
51    /// transport decoders use `HeaderValue::from_bytes` which preserves
52    /// HTTP `obs-text` (0x80..=0xFF) and may carry wire bytes that user-
53    /// supplied validation rejects (e.g., `NUL`). User-facing `insert` /
54    /// `append` always validate; `insert_raw` is only for trusted wire
55    /// data already parsed by hyper or the proxy response reader.
56    #[allow(dead_code)]
57    pub(crate) fn insert_raw(&mut self, name: HeaderName, value: HeaderValue) {
58        self.inner.insert(name, value);
59    }
60
61    /// Append a header value, allowing multiple values for the same name.
62    ///
63    /// # Errors
64    ///
65    /// Returns an error if the name or value is not valid.
66    pub fn append(&mut self, name: &str, value: &str) -> Result<()> {
67        validate_header_name(name)?;
68        validate_header_value(value)?;
69        let name =
70            HeaderName::try_from(name).map_err(|e| Error::InvalidHeaderName(e.to_string()))?;
71        let value =
72            HeaderValue::try_from(value).map_err(|e| Error::InvalidHeaderValue(e.to_string()))?;
73        self.inner.append(name, value);
74        Ok(())
75    }
76
77    /// Get a header value by name.
78    #[must_use]
79    pub fn get(&self, name: &str) -> Option<&HeaderValue> {
80        self.inner.get(name)
81    }
82
83    /// Get all values for a header by name.
84    #[must_use]
85    pub fn get_all(&self, name: &str) -> Vec<&HeaderValue> {
86        self.inner.get_all(name).iter().collect()
87    }
88
89    /// Get a header value as a string by name.
90    #[must_use]
91    pub fn get_str(
92        &self,
93        name: &str,
94    ) -> Option<std::result::Result<&str, http::header::ToStrError>> {
95        self.inner.get(name).map(|v| v.to_str())
96    }
97
98    /// Returns `true` if the headers contain a value for the given name.
99    #[must_use]
100    pub fn contains(&self, name: &str) -> bool {
101        self.inner.contains_key(name)
102    }
103
104    /// Returns the number of headers.
105    #[must_use]
106    pub fn len(&self) -> usize {
107        self.inner.len()
108    }
109
110    /// Returns `true` if there are no headers.
111    #[must_use]
112    pub fn is_empty(&self) -> bool {
113        self.inner.is_empty()
114    }
115
116    /// Iterate over all header name-value pairs.
117    pub fn iter(&self) -> impl Iterator<Item = (&HeaderName, &HeaderValue)> {
118        self.inner.iter()
119    }
120
121    /// Iterate over all header names.
122    pub fn keys(&self) -> impl Iterator<Item = &HeaderName> {
123        self.inner.keys()
124    }
125
126    /// Extend these headers by appending all values from another set.
127    ///
128    /// This is **append-only**: existing values for a name are preserved and
129    /// values from `other` are appended, potentially creating duplicates
130    /// (e.g. two `Content-Type` values). This preserves multi-value headers
131    /// like `Set-Cookie`. Callers that need replacement semantics should
132    /// remove the header name first, as the request pipeline does when
133    /// applying request headers over client defaults, or use
134    /// [`Self::extend_replacing`].
135    pub fn extend(&mut self, other: &Self) {
136        for name in other.inner.keys() {
137            for value in other.inner.get_all(name) {
138                self.inner.append(name.clone(), value.clone());
139            }
140        }
141    }
142
143    /// Extend by replacing values for names present in `other`.
144    ///
145    /// For each header name in `other`, any existing values in `self` are
146    /// removed before appending the values from `other`. Multi-value headers
147    /// from `other` (e.g. `Set-Cookie`) are preserved.
148    pub fn extend_replacing(&mut self, other: &Self) {
149        for name in other.inner.keys() {
150            self.inner.remove(name);
151            for value in other.inner.get_all(name) {
152                self.inner.append(name.clone(), value.clone());
153            }
154        }
155    }
156
157    /// Remove a header by name (case-insensitive).
158    pub fn remove(&mut self, name: &str) -> Option<HeaderValue> {
159        self.inner.remove(name)
160    }
161
162    /// Consume and return the inner `HeaderMap`.
163    #[must_use]
164    pub fn into_inner(self) -> HeaderMap {
165        self.inner
166    }
167
168    /// Reject an outbound header set that would exceed the request limit.
169    pub(crate) fn validate_request_size(
170        &self,
171        method: &http::Method,
172        request_target: &[u8],
173    ) -> Result<()> {
174        // Include `METHOD request-target HTTP/1.1\r\n` because it is part of
175        // the serialized HTTP/1 request and is subject to the same bound.
176        let request_line_size = method
177            .as_str()
178            .len()
179            .checked_add(1)
180            .and_then(|size| size.checked_add(request_target.len()))
181            .and_then(|size| size.checked_add(1 + "HTTP/1.1".len() + 2));
182        // `MAX_REQUEST_HEADER_BYTES` also includes the trailing CRLF that
183        // separates headers from the body.
184        let size = request_line_size.and_then(|size| {
185            self.inner.iter().try_fold(size, |size, (name, value)| {
186                size.checked_add(name.as_str().len() + value.as_bytes().len() + 4)
187            })
188        });
189        if size.map_or(true, |size| {
190            size.checked_add(2)
191                .map_or(true, |size| size > MAX_REQUEST_HEADER_BYTES)
192        }) {
193            return Err(Error::RequestBuild(format!(
194                "request headers exceed maximum size of {MAX_REQUEST_HEADER_BYTES} bytes"
195            )));
196        }
197        Ok(())
198    }
199}
200
201impl From<HeaderMap> for Headers {
202    fn from(inner: HeaderMap) -> Self {
203        Self { inner }
204    }
205}
206
207impl fmt::Debug for Headers {
208    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
209        let mut debug = f.debug_map();
210        for (name, value) in &self.inner {
211            if crate::redact::is_sensitive_header(name.as_str()) {
212                debug.entry(&name, &"<redacted>");
213            } else {
214                debug.entry(&name, &value);
215            }
216        }
217        debug.finish()
218    }
219}
220
221fn validate_header_name(name: &str) -> Result<()> {
222    if name.is_empty() {
223        return Err(Error::InvalidHeaderName(
224            "header name must not be empty".into(),
225        ));
226    }
227    if name.contains('\n') || name.contains('\r') {
228        return Err(Error::InvalidHeaderName(
229            "header name must not contain newlines".into(),
230        ));
231    }
232    Ok(())
233}
234
235/// Validate a header value for user-supplied headers.
236///
237/// Rejects `NUL` (`\0`) and other C0 controls except `\t`, matching the
238/// safe subset for outbound requests. Wire-decoded headers arriving via
239/// `insert_raw` bypass this check intentionally so `obs-text` (0x80..=0xFF)
240/// and proxy-decoded `HeaderValue::from_bytes` bytes are preserved
241/// (see `insert_raw` docs). The split is intentional: user input is
242/// strictly validated, trusted wire data is preserved verbatim.
243fn validate_header_value(value: &str) -> Result<()> {
244    if value
245        .bytes()
246        .any(|byte| (byte < 0x20 && byte != b'\t') || byte == 0x7f)
247    {
248        return Err(Error::InvalidHeaderValue(
249            "header value must not contain control characters".into(),
250        ));
251    }
252    Ok(())
253}
254
255#[cfg(test)]
256mod tests {
257    use super::*;
258    use proptest::prelude::*;
259
260    #[test]
261    fn insert_and_get() {
262        let mut h = Headers::new();
263        h.insert("X-Custom", "value1").unwrap();
264        assert_eq!(h.get("x-custom").unwrap().to_str().unwrap(), "value1");
265    }
266
267    #[test]
268    fn append_duplicates() {
269        let mut h = Headers::new();
270        h.append("Set-Cookie", "a=1").unwrap();
271        h.append("Set-Cookie", "b=2").unwrap();
272        let values: Vec<_> = h.inner.get_all("set-cookie").iter().collect();
273        assert_eq!(values.len(), 2);
274    }
275
276    #[test]
277    fn extend_preserves_duplicate_values() {
278        let mut first = Headers::new();
279        first.append("Set-Cookie", "a=1").unwrap();
280        let mut second = Headers::new();
281        second.append("Set-Cookie", "b=2").unwrap();
282
283        first.extend(&second);
284
285        let values: Vec<_> = first.inner.get_all("set-cookie").iter().collect();
286        assert_eq!(values.len(), 2);
287    }
288
289    #[test]
290    fn contains() {
291        let mut h = Headers::new();
292        h.insert("Content-Type", "text/plain").unwrap();
293        assert!(h.contains("content-type"));
294        assert!(!h.contains("x-missing"));
295    }
296
297    #[test]
298    fn empty_name_rejected() {
299        let mut h = Headers::new();
300        assert!(h.insert("", "value").is_err());
301    }
302
303    #[test]
304    fn newline_in_name_rejected() {
305        let mut h = Headers::new();
306        assert!(h.insert("X-Bad\n", "value").is_err());
307    }
308
309    #[test]
310    fn newline_in_value_rejected() {
311        let mut h = Headers::new();
312        assert!(h.insert("X-Bad", "value\r\ninjection").is_err());
313    }
314
315    #[test]
316    fn control_characters_in_value_rejected() {
317        for value in ["value\0", "value\x1f", "value\x7f"] {
318            let mut h = Headers::new();
319            assert!(h.insert("X-Bad", value).is_err());
320        }
321    }
322
323    #[test]
324    fn horizontal_tab_in_value_allowed() {
325        let mut h = Headers::new();
326        assert!(h.insert("X-Test", "value\twith-tab").is_ok());
327    }
328
329    #[test]
330    fn from_headermap() {
331        let mut hm = HeaderMap::new();
332        hm.insert("X-Test", HeaderValue::from_static("hello"));
333        let h = Headers::from(hm);
334        assert_eq!(h.get("x-test").unwrap().to_str().unwrap(), "hello");
335    }
336
337    #[test]
338    fn request_header_size_is_bounded() {
339        let mut headers = Headers::new();
340        headers
341            .insert("x-large", &"x".repeat(MAX_REQUEST_HEADER_BYTES))
342            .unwrap();
343        assert!(headers
344            .validate_request_size(&http::Method::GET, b"/")
345            .is_err());
346
347        let headers = Headers::new();
348        let target = vec![b'/'; MAX_REQUEST_HEADER_BYTES];
349        assert!(headers
350            .validate_request_size(&http::Method::GET, &target)
351            .is_err());
352    }
353
354    proptest::proptest! {
355        #[test]
356        fn round_trip_insert_get(name in "[a-zA-Z][a-zA-Z0-9_-]{0,20}", value in "[a-zA-Z0-9 ]{1,30}") {
357            let mut h = Headers::new();
358            h.insert(&name, &value).unwrap();
359            let got = h.get_str(&name).unwrap().unwrap();
360            prop_assert_eq!(got, value.as_str());
361        }
362
363        #[test]
364        fn insert_replaces_previous(name in "[a-zA-Z][a-zA-Z0-9_-]{0,20}", v1 in "[a-z]{1,10}", v2 in "[a-z]{1,10}") {
365            let mut h = Headers::new();
366            h.insert(&name, &v1).unwrap();
367            h.insert(&name, &v2).unwrap();
368            let got = h.get_str(&name).unwrap().unwrap();
369            prop_assert_eq!(got, v2.as_str());
370        }
371
372        #[test]
373        fn append_preserves_all(name in "[a-zA-Z][a-zA-Z0-9_-]{0,20}", values in proptest::collection::vec("[a-z]{1,10}", 1..5)) {
374            let mut h = Headers::new();
375            for v in &values {
376                h.append(&name, v).unwrap();
377            }
378            let all = h.get_all(&name);
379            prop_assert_eq!(all.len(), values.len());
380        }
381
382        #[test]
383        fn contains_after_insert(name in "[a-zA-Z][a-zA-Z0-9_-]{0,20}", value in "[a-z]{1,10}") {
384            let mut h = Headers::new();
385            prop_assert!(!h.contains(&name));
386            h.insert(&name, &value).unwrap();
387            prop_assert!(h.contains(&name));
388        }
389
390        #[test]
391        fn prop_empty_name_rejected(value in "[a-z]{1,10}") {
392            let mut h = Headers::new();
393            prop_assert!(h.insert("", &value).is_err());
394        }
395
396        #[test]
397        fn prop_newline_in_name_rejected(name in "[a-zA-Z][a-zA-Z0-9_-]{0,10}", value in "[a-z]{1,10}") {
398            let mut h = Headers::new();
399            let bad_name = format!("{name}\n");
400            prop_assert!(h.insert(&bad_name, &value).is_err());
401        }
402
403        #[test]
404        fn prop_newline_in_value_rejected(name in "[a-zA-Z][a-zA-Z0-9_-]{0,10}", value in "[a-z]{1,10}") {
405            let mut h = Headers::new();
406            let bad_value = format!("{value}\r\ninjection");
407            prop_assert!(h.insert(&name, &bad_value).is_err());
408        }
409    }
410}