eggfetch-core 0.3.0

Async-first Rust HTTP client engine (tokio + hyper) with connection pooling, phase-aware timeouts, TLS, proxies, and compression
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
//! Header container.

use std::fmt;

use http::header::{HeaderMap, HeaderName, HeaderValue};

use crate::error::{Error, Result};

/// Maximum serialized size of an outbound request's headers.
pub(crate) const MAX_REQUEST_HEADER_BYTES: usize = 64 * 1024;

/// Case-insensitive HTTP header container.
///
/// `Debug` formatting redacts values for header names recognised as
/// sensitive (see [`crate::redact::SENSITIVE_HEADERS`]) so that
/// logging, error formatting, and panic messages do not leak
/// credentials.  Ordinary iteration (`iter`, `get`, `get_all`,
/// `keys`) is intentionally **not** redacted — diagnostics are the
/// only output channel that needs to be safe by default.
#[derive(Default, Clone)]
pub struct Headers {
    inner: HeaderMap,
}

impl Headers {
    /// Create an empty header container.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Insert a header, replacing any existing value with the same name.
    ///
    /// # Errors
    ///
    /// Returns an error if the name or value is not valid.
    pub fn insert(&mut self, name: &str, value: &str) -> Result<()> {
        validate_header_name(name)?;
        validate_header_value(value)?;
        let name =
            HeaderName::try_from(name).map_err(|e| Error::InvalidHeaderName(e.to_string()))?;
        let value =
            HeaderValue::try_from(value).map_err(|e| Error::InvalidHeaderValue(e.to_string()))?;
        self.inner.insert(name, value);
        Ok(())
    }

    /// Insert a header without validation (wire-decoded path).
    ///
    /// This bypasses [`validate_header_value`] intentionally: proxy and
    /// transport decoders use `HeaderValue::from_bytes` which preserves
    /// HTTP `obs-text` (0x80..=0xFF) and may carry wire bytes that user-
    /// supplied validation rejects (e.g., `NUL`). User-facing `insert` /
    /// `append` always validate; `insert_raw` is only for trusted wire
    /// data already parsed by hyper or the proxy response reader.
    #[allow(
        dead_code,
        reason = "the raw-insert path is only reached from the multipart and redirect features, so it is dead code when neither is enabled"
    )]
    pub(crate) fn insert_raw(&mut self, name: HeaderName, value: HeaderValue) {
        self.inner.insert(name, value);
    }

    /// Append a header value, allowing multiple values for the same name.
    ///
    /// # Errors
    ///
    /// Returns an error if the name or value is not valid.
    pub fn append(&mut self, name: &str, value: &str) -> Result<()> {
        validate_header_name(name)?;
        validate_header_value(value)?;
        let name =
            HeaderName::try_from(name).map_err(|e| Error::InvalidHeaderName(e.to_string()))?;
        let value =
            HeaderValue::try_from(value).map_err(|e| Error::InvalidHeaderValue(e.to_string()))?;
        self.inner.append(name, value);
        Ok(())
    }

    /// Get a header value by name.
    #[must_use]
    pub fn get(&self, name: &str) -> Option<&HeaderValue> {
        self.inner.get(name)
    }

    /// Get all values for a header by name.
    #[must_use]
    pub fn get_all(&self, name: &str) -> Vec<&HeaderValue> {
        self.inner.get_all(name).iter().collect()
    }

    /// Get a header value as a string by name.
    #[must_use]
    pub fn get_str(
        &self,
        name: &str,
    ) -> Option<std::result::Result<&str, http::header::ToStrError>> {
        self.inner.get(name).map(|v| v.to_str())
    }

    /// Returns `true` if the headers contain a value for the given name.
    #[must_use]
    pub fn contains(&self, name: &str) -> bool {
        self.inner.contains_key(name)
    }

    /// Returns the number of headers.
    #[must_use]
    pub fn len(&self) -> usize {
        self.inner.len()
    }

    /// Returns `true` if there are no headers.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.inner.is_empty()
    }

    /// Iterate over all header name-value pairs.
    pub fn iter(&self) -> impl Iterator<Item = (&HeaderName, &HeaderValue)> {
        self.inner.iter()
    }

    /// Iterate over all header names.
    pub fn keys(&self) -> impl Iterator<Item = &HeaderName> {
        self.inner.keys()
    }

    /// Extend these headers by appending all values from another set.
    ///
    /// This is **append-only**: existing values for a name are preserved and
    /// values from `other` are appended, potentially creating duplicates
    /// (e.g. two `Content-Type` values). This preserves multi-value headers
    /// like `Set-Cookie`. Callers that need replacement semantics should
    /// remove the header name first, as the request pipeline does when
    /// applying request headers over client defaults, or use
    /// [`Self::extend_replacing`].
    pub fn extend(&mut self, other: &Self) {
        for name in other.inner.keys() {
            for value in other.inner.get_all(name) {
                self.inner.append(name.clone(), value.clone());
            }
        }
    }

    /// Extend by replacing values for names present in `other`.
    ///
    /// For each header name in `other`, any existing values in `self` are
    /// removed before appending the values from `other`. Multi-value headers
    /// from `other` (e.g. `Set-Cookie`) are preserved.
    pub fn extend_replacing(&mut self, other: &Self) {
        for name in other.inner.keys() {
            self.inner.remove(name);
            for value in other.inner.get_all(name) {
                self.inner.append(name.clone(), value.clone());
            }
        }
    }

    /// Remove a header by name (case-insensitive).
    pub fn remove(&mut self, name: &str) -> Option<HeaderValue> {
        self.inner.remove(name)
    }

    /// Consume and return the inner `HeaderMap`.
    #[must_use]
    pub fn into_inner(self) -> HeaderMap {
        self.inner
    }

    /// Reject an outbound header set that would exceed the request limit.
    pub(crate) fn validate_request_size(
        &self,
        method: &http::Method,
        request_target: &[u8],
    ) -> Result<()> {
        // Include `METHOD request-target HTTP/1.1\r\n` because it is part of
        // the serialized HTTP/1 request and is subject to the same bound.
        let request_line_size = method
            .as_str()
            .len()
            .checked_add(1)
            .and_then(|size| size.checked_add(request_target.len()))
            .and_then(|size| size.checked_add(1 + "HTTP/1.1".len() + 2));
        // `MAX_REQUEST_HEADER_BYTES` also includes the trailing CRLF that
        // separates headers from the body.
        let size = request_line_size.and_then(|size| {
            self.inner.iter().try_fold(size, |size, (name, value)| {
                size.checked_add(name.as_str().len() + value.as_bytes().len() + 4)
            })
        });
        if size.is_none_or(|size| {
            size.checked_add(2)
                .is_none_or(|size| size > MAX_REQUEST_HEADER_BYTES)
        }) {
            return Err(Error::RequestBuild(format!(
                "request headers exceed maximum size of {MAX_REQUEST_HEADER_BYTES} bytes"
            )));
        }
        Ok(())
    }

    /// Validate a request target without allocating its display string.
    pub(crate) fn validate_request_size_uri(
        &self,
        method: &http::Method,
        request_target: &http::Uri,
    ) -> Result<()> {
        struct CountWriter(usize);
        impl fmt::Write for CountWriter {
            fn write_str(&mut self, value: &str) -> fmt::Result {
                self.0 = self.0.checked_add(value.len()).ok_or(fmt::Error)?;
                Ok(())
            }
        }

        let mut writer = CountWriter(0);
        fmt::write(&mut writer, format_args!("{request_target}"))
            .map_err(|_| Error::RequestBuild("request target serialization overflowed".into()))?;
        self.validate_request_size_len(method, writer.0)
    }

    fn validate_request_size_len(&self, method: &http::Method, target_len: usize) -> Result<()> {
        let request_line_size = method
            .as_str()
            .len()
            .checked_add(1)
            .and_then(|size| size.checked_add(target_len))
            .and_then(|size| size.checked_add(1 + "HTTP/1.1".len() + 2));
        let size = request_line_size.and_then(|size| {
            self.inner.iter().try_fold(size, |size, (name, value)| {
                size.checked_add(name.as_str().len() + value.as_bytes().len() + 4)
            })
        });
        if size.is_none_or(|size| {
            size.checked_add(2)
                .is_none_or(|size| size > MAX_REQUEST_HEADER_BYTES)
        }) {
            return Err(Error::RequestBuild(format!(
                "request headers exceed maximum size of {MAX_REQUEST_HEADER_BYTES} bytes"
            )));
        }
        Ok(())
    }
}

impl From<HeaderMap> for Headers {
    fn from(inner: HeaderMap) -> Self {
        Self { inner }
    }
}

impl fmt::Debug for Headers {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let mut debug = f.debug_map();
        for (name, value) in &self.inner {
            if crate::redact::is_sensitive_header(name.as_str()) {
                debug.entry(&name, &"<redacted>");
            } else {
                debug.entry(&name, &value);
            }
        }
        debug.finish()
    }
}

fn validate_header_name(name: &str) -> Result<()> {
    if name.is_empty() {
        return Err(Error::InvalidHeaderName(
            "header name must not be empty".into(),
        ));
    }
    if name.contains('\n') || name.contains('\r') {
        return Err(Error::InvalidHeaderName(
            "header name must not contain newlines".into(),
        ));
    }
    Ok(())
}

/// Validate a header value for user-supplied headers.
///
/// Rejects `NUL` (`\0`) and other C0 controls except `\t`, matching the
/// safe subset for outbound requests. Wire-decoded headers arriving via
/// `insert_raw` bypass this check intentionally so `obs-text` (0x80..=0xFF)
/// and proxy-decoded `HeaderValue::from_bytes` bytes are preserved
/// (see `insert_raw` docs). The split is intentional: user input is
/// strictly validated, trusted wire data is preserved verbatim.
fn validate_header_value(value: &str) -> Result<()> {
    if value
        .bytes()
        .any(|byte| (byte < 0x20 && byte != b'\t') || byte == 0x7f)
    {
        return Err(Error::InvalidHeaderValue(
            "header value must not contain control characters".into(),
        ));
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use proptest::prelude::*;

    #[test]
    fn insert_and_get() {
        let mut h = Headers::new();
        h.insert("X-Custom", "value1").unwrap();
        assert_eq!(h.get("x-custom").unwrap().to_str().unwrap(), "value1");
    }

    #[test]
    fn append_duplicates() {
        let mut h = Headers::new();
        h.append("Set-Cookie", "a=1").unwrap();
        h.append("Set-Cookie", "b=2").unwrap();
        let values: Vec<_> = h.inner.get_all("set-cookie").iter().collect();
        assert_eq!(values.len(), 2);
    }

    #[test]
    fn extend_preserves_duplicate_values() {
        let mut first = Headers::new();
        first.append("Set-Cookie", "a=1").unwrap();
        let mut second = Headers::new();
        second.append("Set-Cookie", "b=2").unwrap();

        first.extend(&second);

        let values: Vec<_> = first.inner.get_all("set-cookie").iter().collect();
        assert_eq!(values.len(), 2);
    }

    #[test]
    fn contains() {
        let mut h = Headers::new();
        h.insert("Content-Type", "text/plain").unwrap();
        assert!(h.contains("content-type"));
        assert!(!h.contains("x-missing"));
    }

    #[test]
    fn empty_name_rejected() {
        let mut h = Headers::new();
        assert!(h.insert("", "value").is_err());
    }

    #[test]
    fn newline_in_name_rejected() {
        let mut h = Headers::new();
        assert!(h.insert("X-Bad\n", "value").is_err());
    }

    #[test]
    fn newline_in_value_rejected() {
        let mut h = Headers::new();
        assert!(h.insert("X-Bad", "value\r\ninjection").is_err());
    }

    #[test]
    fn control_characters_in_value_rejected() {
        for value in ["value\0", "value\x1f", "value\x7f"] {
            let mut h = Headers::new();
            assert!(h.insert("X-Bad", value).is_err());
        }
    }

    #[test]
    fn horizontal_tab_in_value_allowed() {
        let mut h = Headers::new();
        assert!(h.insert("X-Test", "value\twith-tab").is_ok());
    }

    #[test]
    fn from_headermap() {
        let mut hm = HeaderMap::new();
        hm.insert("X-Test", HeaderValue::from_static("hello"));
        let h = Headers::from(hm);
        assert_eq!(h.get("x-test").unwrap().to_str().unwrap(), "hello");
    }

    #[test]
    fn uri_size_validation_matches_display_length() {
        let headers = Headers::new();
        for target in [
            "http://example.com/path?q=1",
            "/origin-form?q=1",
            "*",
            "https://example.com:8443/absolute",
        ] {
            let uri: http::Uri = target.parse().unwrap();
            assert_eq!(uri.to_string().len(), target.len());
            headers
                .validate_request_size_uri(&http::Method::GET, &uri)
                .unwrap();
        }
    }

    #[test]
    fn request_header_size_is_bounded() {
        let mut headers = Headers::new();
        headers
            .insert("x-large", &"x".repeat(MAX_REQUEST_HEADER_BYTES))
            .unwrap();
        assert!(headers
            .validate_request_size(&http::Method::GET, b"/")
            .is_err());

        let headers = Headers::new();
        let target = vec![b'/'; MAX_REQUEST_HEADER_BYTES];
        assert!(headers
            .validate_request_size(&http::Method::GET, &target)
            .is_err());
    }

    proptest::proptest! {
        #[test]
        fn round_trip_insert_get(name in "[a-zA-Z][a-zA-Z0-9_-]{0,20}", value in "[a-zA-Z0-9 ]{1,30}") {
            let mut h = Headers::new();
            h.insert(&name, &value).unwrap();
            let got = h.get_str(&name).unwrap().unwrap();
            prop_assert_eq!(got, value.as_str());
        }

        #[test]
        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}") {
            let mut h = Headers::new();
            h.insert(&name, &v1).unwrap();
            h.insert(&name, &v2).unwrap();
            let got = h.get_str(&name).unwrap().unwrap();
            prop_assert_eq!(got, v2.as_str());
        }

        #[test]
        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)) {
            let mut h = Headers::new();
            for v in &values {
                h.append(&name, v).unwrap();
            }
            let all = h.get_all(&name);
            prop_assert_eq!(all.len(), values.len());
        }

        #[test]
        fn contains_after_insert(name in "[a-zA-Z][a-zA-Z0-9_-]{0,20}", value in "[a-z]{1,10}") {
            let mut h = Headers::new();
            prop_assert!(!h.contains(&name));
            h.insert(&name, &value).unwrap();
            prop_assert!(h.contains(&name));
        }

        #[test]
        fn prop_empty_name_rejected(value in "[a-z]{1,10}") {
            let mut h = Headers::new();
            prop_assert!(h.insert("", &value).is_err());
        }

        #[test]
        fn prop_newline_in_name_rejected(name in "[a-zA-Z][a-zA-Z0-9_-]{0,10}", value in "[a-z]{1,10}") {
            let mut h = Headers::new();
            let bad_name = format!("{name}\n");
            prop_assert!(h.insert(&bad_name, &value).is_err());
        }

        #[test]
        fn prop_newline_in_value_rejected(name in "[a-zA-Z][a-zA-Z0-9_-]{0,10}", value in "[a-z]{1,10}") {
            let mut h = Headers::new();
            let bad_value = format!("{value}\r\ninjection");
            prop_assert!(h.insert(&name, &bad_value).is_err());
        }
    }
}