fetch_hyper 0.1.1

Hyper-based HTTP transport utilities for fetch.
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

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

//! `TLS` backend selection and internal connector wiring.
//!
//! The only public symbol is [`TlsBackend`]; everything else is internal.

mod connector;
pub(crate) use connector::TlsConnector;

/// Selects and supplies the `TLS` backend used by the transport.
///
/// When neither the `rustls` nor `native-tls` feature is enabled this enum
/// has no variants and is therefore uninhabited: the crate still compiles,
/// but a [`TlsBackend`] value cannot be constructed and the transport
/// cannot be used. Enable at least one `TLS` feature to make outbound
/// connections.
#[derive(Clone, Debug)]
#[allow(
    clippy::allow_attributes,
    clippy::large_enum_variant,
    reason = "backend is not on hot path, we want to keep API clean so no Box<..>"
)]
pub enum TlsBackend {
    /// Use the `rustls` backend with the given pre-built configuration.
    #[cfg(any(feature = "rustls", test))]
    Rustls(rustls::ClientConfig),

    /// Use the platform `native-tls` backend with the given connector.
    #[cfg(any(feature = "native-tls", test))]
    NativeTls(native_tls::TlsConnector),
}

#[cfg(any(feature = "rustls", test))]
impl From<rustls::ClientConfig> for TlsBackend {
    fn from(config: rustls::ClientConfig) -> Self {
        Self::Rustls(config)
    }
}

#[cfg(any(feature = "rustls", test))]
impl From<std::sync::Arc<rustls::ClientConfig>> for TlsBackend {
    fn from(config: std::sync::Arc<rustls::ClientConfig>) -> Self {
        Self::Rustls(std::sync::Arc::unwrap_or_clone(config))
    }
}

#[cfg(any(feature = "native-tls", test))]
impl From<native_tls::TlsConnector> for TlsBackend {
    fn from(connector: native_tls::TlsConnector) -> Self {
        Self::NativeTls(connector)
    }
}

#[cfg(test)]
#[cfg_attr(coverage_nightly, coverage(off))]
mod tests {
    use super::*;

    #[test]
    #[cfg_attr(miri, ignore)]
    fn from_client_config_makes_rustls_variant() {
        let provider = rustls::crypto::CryptoProvider::get_default()
            .cloned()
            .unwrap_or_else(|| std::sync::Arc::new(rustls::crypto::aws_lc_rs::default_provider()));
        let config = rustls::ClientConfig::builder_with_provider(provider)
            .with_safe_default_protocol_versions()
            .unwrap()
            .with_root_certificates(rustls::RootCertStore::empty())
            .with_no_client_auth();
        let backend: TlsBackend = config.into();
        assert!(matches!(backend, TlsBackend::Rustls(_)));
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn from_arc_client_config_makes_rustls_variant() {
        let provider = rustls::crypto::CryptoProvider::get_default()
            .cloned()
            .unwrap_or_else(|| std::sync::Arc::new(rustls::crypto::aws_lc_rs::default_provider()));
        let config = std::sync::Arc::new(
            rustls::ClientConfig::builder_with_provider(provider)
                .with_safe_default_protocol_versions()
                .unwrap()
                .with_root_certificates(rustls::RootCertStore::empty())
                .with_no_client_auth(),
        );
        let backend: TlsBackend = config.into();
        assert!(matches!(backend, TlsBackend::Rustls(_)));
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn from_native_tls_connector_makes_native_variant() {
        let nc = native_tls::TlsConnector::new().unwrap();
        let backend: TlsBackend = nc.into();
        assert!(matches!(backend, TlsBackend::NativeTls(_)));
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn clone_preserves_variant() {
        let nc = native_tls::TlsConnector::new().unwrap();
        let backend = TlsBackend::NativeTls(nc);
        let cloned = backend.clone();
        assert!(matches!(backend, TlsBackend::NativeTls(_)));
        assert!(matches!(cloned, TlsBackend::NativeTls(_)));

        let provider = rustls::crypto::CryptoProvider::get_default()
            .cloned()
            .unwrap_or_else(|| std::sync::Arc::new(rustls::crypto::aws_lc_rs::default_provider()));
        let config = rustls::ClientConfig::builder_with_provider(provider)
            .with_safe_default_protocol_versions()
            .unwrap()
            .with_root_certificates(rustls::RootCertStore::empty())
            .with_no_client_auth();
        let rustls_backend: TlsBackend = config.into();
        let rustls_cloned = rustls_backend.clone();
        assert!(matches!(rustls_backend, TlsBackend::Rustls(_)));
        assert!(matches!(rustls_cloned, TlsBackend::Rustls(_)));
    }
}