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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
//! Native transport origin derived from `http::Uri`.
//!
//! The low-level native API receives a caller-owned `http::Request<B>` with
//! an `http::Uri`. It must not serialize that URI and reparse it as
//! `url::Url` merely to recover scheme, host and port. This module supplies
//! the small canonical transport facts the engine needs: scheme (HTTP/HTTPS
//! only), host, and effective port.
//!
//! The native caller owns construction of the `http::Uri`. If a Unicode
//! hostname cannot be represented by the `http` crate's URI type, the caller
//! must provide an appropriate ASCII/punycode URI. No IDNA transformation is
//! performed here.
//!
//! The module also owns the one effective-port rule: a caller-supplied
//! destination must use the effective port of the logical origin it belongs
//! to. Every place that checks that rule uses the helpers below, so the
//! comparison and the per-subject diagnostics cannot drift apart.

use std::net::SocketAddr;

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

/// Transport scheme for a native origin.
///
/// Only HTTP and HTTPS are accepted; anything else is rejected before I/O.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub(crate) enum HttpScheme {
    /// Cleartext HTTP (default port 80).
    Http,
    /// TLS HTTPS (default port 443).
    Https,
}

impl HttpScheme {
    /// Canonical lowercase scheme string.
    #[must_use]
    pub(crate) fn as_str(self) -> &'static str {
        match self {
            Self::Http => "http",
            Self::Https => "https",
        }
    }

    /// Effective default port for the scheme.
    #[must_use]
    pub(crate) fn default_port(self) -> u16 {
        match self {
            Self::Http => 80,
            Self::Https => 443,
        }
    }

    /// Whether this scheme requires TLS.
    #[must_use]
    pub(crate) fn is_https(self) -> bool {
        matches!(self, Self::Https)
    }
}

/// Canonical native origin: scheme + host + effective port.
///
/// Path, query and fragment never participate in origin identity. The host
/// is stored ASCII-lowercased so `EXAMPLE.COM` and `example.com` share a
/// pool slot, matching the high-level `url::Url` normalization for ASCII
/// DNS names. No IDNA/punycode conversion is performed: the caller-supplied
/// `http::Uri` authority is authoritative.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub(crate) struct HttpOrigin {
    scheme: HttpScheme,
    host: String,
    port: u16,
}

impl HttpOrigin {
    /// Derive a native origin from an `http::Uri`.
    ///
    /// # Errors
    ///
    /// Returns [`Error::InvalidUrl`] for a missing scheme or authority,
    /// [`Error::Unsupported`] for a non-HTTP(S) scheme or a missing
    /// authority, and [`Error::InvalidUrl`] for userinfo or an empty host.
    pub(crate) fn from_uri(uri: &http::Uri) -> Result<Self> {
        let scheme_str = uri.scheme_str().ok_or_else(|| {
            Error::InvalidUrl(
                "native request URI must be absolute with http or https scheme".into(),
            )
        })?;
        let scheme = if scheme_str.eq_ignore_ascii_case("http") {
            HttpScheme::Http
        } else if scheme_str.eq_ignore_ascii_case("https") {
            HttpScheme::Https
        } else {
            return Err(Error::Unsupported(
                "native request URI must use http or https and include an authority".into(),
            ));
        };

        let authority = uri.authority().ok_or_else(|| {
            Error::Unsupported(
                "native request URI must use http or https and include an authority".into(),
            )
        })?;
        let authority_str = authority.as_str();
        // `http::Uri` accepts userinfo (`user[:pass]@host`); the high-level
        // API rejects it and the native path must too.
        if authority_str.contains('@') {
            return Err(Error::InvalidUrl(
                "URL userinfo is not supported; configure authentication explicitly".into(),
            ));
        }

        let host = uri.host().ok_or_else(|| {
            Error::Unsupported(
                "native request URI must use http or https and include an authority".into(),
            )
        })?;
        if host.is_empty() {
            return Err(Error::Unsupported(
                "native request URI must use http or https and include an authority".into(),
            ));
        }
        // `Uri::host` for IPv6 authorities returns the bracketed form
        // (`[::1]`); strip one bracket pair for canonical storage.
        //
        // The high-level `url::Url` form keeps the brackets (`Url::host_str`
        // returns `[::1]`), so the native and high-level pool keys for the
        // same IPv6 endpoint differ by those brackets. That divergence is
        // recorded rather than papered over: changing it would alter pool
        // keying, which is out of scope for the origin normalization.
        //
        // DNS names are ASCII-lowercased for canonical identity; no IDNA
        // transformation is performed.
        let canonical_host = if host.starts_with('[') && host.ends_with(']') && host.len() >= 2 {
            host[1..host.len() - 1].to_ascii_lowercase()
        } else {
            host.to_ascii_lowercase()
        };
        if canonical_host.is_empty() {
            return Err(Error::Unsupported(
                "native request URI must use http or https and include an authority".into(),
            ));
        }

        // Reject a malformed explicit port (non-numeric or out of range).
        // `http::Uri` silently drops an invalid port (`port()` and
        // `port_u16()` both return `None` for `:notaport`/`:99999`), which
        // would weaken validation relative to `url::Url::parse`. Detect an
        // explicit port via the raw authority so such URIs fail closed
        // instead of falling back to the scheme default.
        let has_explicit_port = if authority_str.starts_with('[') {
            match authority_str.find(']') {
                Some(end) => authority_str[end + 1..].starts_with(':'),
                None => {
                    return Err(Error::InvalidUrl(
                        "native request URI has an invalid authority".into(),
                    ));
                }
            }
        } else {
            authority_str.contains(':')
        };
        let port = if let Some(port) = uri.port_u16() {
            port
        } else {
            if has_explicit_port || uri.port().is_some() {
                return Err(Error::InvalidUrl(
                    "native request URI has an invalid port".into(),
                ));
            }
            scheme.default_port()
        };
        Ok(Self {
            scheme,
            host: canonical_host,
            port,
        })
    }

    /// Derive a native origin from high-level `url::Url` components.
    ///
    /// This adapter lives behind the high-level URL feature and reduces
    /// immediately to the same canonical component representation so the
    /// high-level and native paths share pool and route identity.
    #[cfg(feature = "high-level-url")]
    pub(crate) fn from_url(url: &url::Url) -> Option<Self> {
        let scheme = if url.scheme().eq_ignore_ascii_case("http") {
            HttpScheme::Http
        } else if url.scheme().eq_ignore_ascii_case("https") {
            HttpScheme::Https
        } else {
            return None;
        };
        let host = url.host_str()?;
        if host.is_empty() {
            return None;
        }
        let port = url.port_or_known_default()?;
        // `url::Url::host_str` keeps the IPv6 brackets (`[::1]`), unlike
        // `Uri::host` handling in `from_uri`; lowercase for canonical
        // identity. The two constructors therefore disagree on the IPv6 host
        // form; see the note in `from_uri`.
        Some(Self {
            scheme,
            host: host.to_ascii_lowercase(),
            port,
        })
    }

    /// Canonical scheme string (`http` or `https`).
    #[must_use]
    pub(crate) fn scheme_str(&self) -> &'static str {
        self.scheme.as_str()
    }

    /// Canonical (lowercased, bracket-stripped) host.
    #[must_use]
    pub(crate) fn host(&self) -> &str {
        &self.host
    }

    /// Effective port (explicit or default-for-scheme).
    #[must_use]
    pub(crate) fn port_ref(&self) -> u16 {
        self.port
    }

    /// Whether this origin requires TLS.
    #[must_use]
    pub(crate) fn is_https(&self) -> bool {
        self.scheme.is_https()
    }

    /// Canonical origin string (`scheme://host:port`) for route-cache
    /// identity. The port is always explicit so default and explicit-default
    /// forms share one key.
    #[must_use]
    pub(crate) fn origin_string(&self) -> String {
        format!("{}://{}:{}", self.scheme.as_str(), self.host, self.port)
    }
}

impl std::fmt::Display for HttpOrigin {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}://{}:{}", self.scheme.as_str(), self.host, self.port)
    }
}

/// Subject of an effective-port validation.
///
/// A caller-supplied destination must use the effective port of the logical
/// origin it belongs to. The three subjects differ in the diagnostic they
/// produce and in the error kind they use, but they share one comparison.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum EffectivePortSubject {
    /// A caller-supplied resolved destination for the request's own origin.
    ResolvedDestination,
    /// A caller-supplied proxied destination for the request's own origin.
    ProxiedDestination,
    /// A caller-supplied resolved peer for the proxy endpoint.
    #[cfg_attr(
        not(feature = "proxy"),
        allow(
            dead_code,
            reason = "the proxy-peer subject only exists in the proxy profile"
        )
    )]
    ResolvedProxyPeer,
}

impl EffectivePortSubject {
    /// The error produced when the logical URL is not a usable HTTP(S) URL.
    ///
    /// Two rules reach this diagnostic: the effective-port check, which
    /// needs the URL's known port, and the route-key construction, which
    /// needs a canonical HTTP(S) origin. The proxy-peer subject never
    /// reaches this path: it resolves its expected port from the proxy URL,
    /// which reports its own diagnostic (`proxy scheme ... has no known
    /// default port`) before the comparison runs. The arm is kept so the
    /// subject set stays exhaustive.
    pub(crate) fn requires_http_url(self) -> Error {
        match self {
            Self::ResolvedDestination => Error::InvalidResolvedTarget(
                "resolved destinations require an HTTP or HTTPS URL".into(),
            ),
            Self::ProxiedDestination => Error::InvalidResolvedTarget(
                "proxied destinations require an HTTP or HTTPS URL".into(),
            ),
            Self::ResolvedProxyPeer => Error::InvalidProxyUrl(
                "resolved proxy peers require the proxy URL's effective port".into(),
            ),
        }
    }

    /// The error produced when a supplied address uses a different port.
    pub(crate) fn port_mismatch(self, expected_port: u16) -> Error {
        match self {
            Self::ResolvedDestination => Error::InvalidResolvedTarget(format!(
                "all resolved destinations must use the URL's effective port {expected_port}"
            )),
            Self::ProxiedDestination => Error::InvalidResolvedTarget(format!(
                "all proxied destinations must use the URL's effective port {expected_port}"
            )),
            Self::ResolvedProxyPeer => Error::InvalidProxyUrl(format!(
                "all resolved proxy peers must use the proxy URL's effective port {expected_port}"
            )),
        }
    }
}

/// Validate that every supplied address uses the origin's effective port.
///
/// # Errors
///
/// Returns the subject's port-mismatch error when any supplied address uses a
/// port other than `expected_port`.
pub(crate) fn validate_effective_port(
    subject: EffectivePortSubject,
    addresses: &[SocketAddr],
    expected_port: u16,
) -> Result<()> {
    if addresses
        .iter()
        .any(|address| address.port() != expected_port)
    {
        return Err(subject.port_mismatch(expected_port));
    }
    Ok(())
}

/// Validate that every supplied address uses the request URL's effective port.
///
/// The effective port is the URL's explicit port, or the scheme's default
/// when the URL carries none.
///
/// # Errors
///
/// Returns the subject's known-port error when the URL has no effective port,
/// or the subject's port-mismatch error when a supplied address uses a
/// different port.
#[cfg(feature = "high-level-url")]
pub(crate) fn validate_url_effective_port(
    subject: EffectivePortSubject,
    url: &url::Url,
    addresses: &[SocketAddr],
) -> Result<()> {
    let expected_port = url
        .port_or_known_default()
        .ok_or_else(|| subject.requires_http_url())?;
    validate_effective_port(subject, addresses, expected_port)
}

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

    fn origin(uri: &str) -> HttpOrigin {
        let parsed: http::Uri = uri.parse().expect("valid test URI");
        HttpOrigin::from_uri(&parsed).expect("origin parses")
    }

    #[test]
    fn http_default_port() {
        let o = origin("http://example.com/");
        assert_eq!(o.scheme_str(), "http");
        assert_eq!(o.host(), "example.com");
        assert_eq!(o.port_ref(), 80);
    }

    #[test]
    fn https_default_port() {
        let o = origin("https://example.com/");
        assert_eq!(o.scheme_str(), "https");
        assert_eq!(o.host(), "example.com");
        assert_eq!(o.port_ref(), 443);
    }

    #[test]
    fn explicit_non_default_port_preserved() {
        let o = origin("http://example.com:8080/path?q=1");
        assert_eq!(o.port_ref(), 8080);
        assert_eq!(o.host(), "example.com");
    }

    #[test]
    fn explicit_default_port_preserved() {
        let o = origin("http://example.com:80/");
        assert_eq!(o.port_ref(), 80);
        let implicit = origin("http://example.com/");
        assert_eq!(o, implicit);
    }

    #[test]
    fn ipv4_authority() {
        let o = origin("http://127.0.0.1:8080/");
        assert_eq!(o.host(), "127.0.0.1");
        assert_eq!(o.port_ref(), 8080);
    }

    #[test]
    fn ipv6_without_port() {
        let o = origin("http://[::1]/");
        assert_eq!(o.host(), "::1");
        assert_eq!(o.port_ref(), 80);
    }

    #[test]
    fn ipv6_with_port() {
        let o = origin("https://[2001:db8::1]:8443/path");
        assert_eq!(o.host(), "2001:db8::1");
        assert_eq!(o.port_ref(), 8443);
    }

    #[test]
    fn missing_scheme_rejected() {
        let uri: http::Uri = "/just/a/path".parse().expect("path-only URI");
        let err = HttpOrigin::from_uri(&uri).unwrap_err();
        assert!(matches!(err, Error::InvalidUrl(_)), "got {err:?}");
    }

    #[test]
    fn missing_authority_rejected() {
        // `http:/only-path` either fails URI parsing or carries no
        // authority; both are rejections.
        match "http:/only-path".parse::<http::Uri>() {
            Err(_) => {}
            Ok(uri) => {
                assert!(uri.authority().is_none());
                let err = HttpOrigin::from_uri(&uri).unwrap_err();
                assert!(
                    matches!(err, Error::Unsupported(_)),
                    "expected unsupported, got {err:?}"
                );
            }
        }
    }

    #[test]
    fn unsupported_scheme_rejected() {
        let uri: http::Uri = "ftp://example.com/file".parse().expect("ftp URI");
        let err = HttpOrigin::from_uri(&uri).unwrap_err();
        assert!(matches!(err, Error::Unsupported(_)), "got {err:?}");
    }

    #[test]
    fn userinfo_rejected() {
        let uri: http::Uri = "http://user:pass@example.com/"
            .parse()
            .expect("userinfo URI parses in http crate");
        let err = HttpOrigin::from_uri(&uri).unwrap_err();
        assert!(
            matches!(err, Error::InvalidUrl(_)),
            "expected userinfo rejection, got {err:?}"
        );
    }

    #[test]
    fn user_without_password_rejected() {
        let uri: http::Uri = "http://user@example.com/"
            .parse()
            .expect("userinfo URI parses in http crate");
        let err = HttpOrigin::from_uri(&uri).unwrap_err();
        assert!(matches!(err, Error::InvalidUrl(_)), "got {err:?}");
    }

    #[test]
    fn empty_host_rejected() {
        // `http:///path` either fails URI parsing or yields no usable host;
        // both are rejections and must never become a pool origin.
        match "http:///path".parse::<http::Uri>() {
            Err(_) => {}
            Ok(uri) => {
                let err = HttpOrigin::from_uri(&uri).unwrap_err();
                assert!(
                    matches!(err, Error::Unsupported(_) | Error::InvalidUrl(_)),
                    "got {err:?}"
                );
            }
        }
    }

    #[test]
    fn malformed_port_rejected() {
        // Malformed ports either fail URI parsing or parse but are rejected
        // by `from_uri` (no silent fallback to the scheme default).
        for candidate in ["http://example.com:notaport/", "http://example.com:99999/"] {
            match candidate.parse::<http::Uri>() {
                Err(_) => {}
                Ok(uri) => {
                    let err = HttpOrigin::from_uri(&uri).unwrap_err();
                    assert!(
                        matches!(err, Error::InvalidUrl(_)),
                        "expected invalid port for {candidate}, got {err:?}"
                    );
                }
            }
        }
    }

    #[test]
    fn path_query_ignored_for_identity() {
        let a = origin("https://example.com/a?b=1");
        let b = origin("https://example.com/other");
        assert_eq!(a, b);
    }

    #[test]
    fn host_lowercased_for_identity() {
        let lower = origin("http://example.com/");
        let upper = origin("http://EXAMPLE.COM/");
        assert_eq!(lower, upper);
    }
}