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
use alloc::vec::Vec;
use core::marker::PhantomData;
use pki_types::{CertificateDer, PrivateKeyDer};
use super::client_conn::Resumption;
use crate::builder::{ConfigBuilder, WantsVerifier};
use crate::client::{ClientConfig, EchMode, ResolvesClientCert, handy};
use crate::error::Error;
use crate::key_log::NoKeyLog;
use crate::sign::{CertifiedKey, SingleCertAndKey};
use crate::sync::Arc;
use crate::versions::TLS13;
use crate::webpki::{self, WebPkiServerVerifier};
use crate::{WantsVersions, compress, verify, versions};
impl ConfigBuilder<ClientConfig, WantsVersions> {
/// Enable Encrypted Client Hello (ECH) in the given mode.
///
/// This implicitly selects TLS 1.3 as the only supported protocol version to meet the
/// requirement to support ECH.
///
/// The `ClientConfig` that will be produced by this builder will be specific to the provided
/// [`crate::client::EchConfig`] and may not be appropriate for all connections made by the program.
/// In this case the configuration should only be shared by connections intended for domains
/// that offer the provided [`crate::client::EchConfig`] in their DNS zone.
pub fn with_ech(
self,
mode: EchMode,
) -> Result<ConfigBuilder<ClientConfig, WantsVerifier>, Error> {
let mut res = self.with_protocol_versions(&[&TLS13][..])?;
res.state.client_ech_mode = Some(mode);
Ok(res)
}
}
impl ConfigBuilder<ClientConfig, WantsVerifier> {
/// Choose how to verify server certificates.
///
/// Using this function does not configure revocation. If you wish to
/// configure revocation, instead use:
///
/// ```diff
/// - .with_root_certificates(root_store)
/// + .with_webpki_verifier(
/// + WebPkiServerVerifier::builder_with_provider(root_store, crypto_provider)
/// + .with_crls(...)
/// + .build()?
/// + )
/// ```
pub fn with_root_certificates(
self,
root_store: impl Into<Arc<webpki::RootCertStore>>,
) -> ConfigBuilder<ClientConfig, WantsClientCert> {
let algorithms = self
.provider
.signature_verification_algorithms;
self.with_webpki_verifier(
WebPkiServerVerifier::new_without_revocation(root_store, algorithms).into(),
)
}
/// Choose how to verify server certificates using a webpki verifier.
///
/// See [`webpki::WebPkiServerVerifier::builder`] and
/// [`webpki::WebPkiServerVerifier::builder_with_provider`] for more information.
pub fn with_webpki_verifier(
self,
verifier: Arc<WebPkiServerVerifier>,
) -> ConfigBuilder<ClientConfig, WantsClientCert> {
ConfigBuilder {
state: WantsClientCert {
versions: self.state.versions,
verifier,
client_ech_mode: self.state.client_ech_mode,
},
provider: self.provider,
time_provider: self.time_provider,
side: PhantomData,
}
}
/// Access configuration options whose use is dangerous and requires
/// extra care.
pub fn dangerous(self) -> danger::DangerousClientConfigBuilder {
danger::DangerousClientConfigBuilder { cfg: self }
}
}
/// Container for unsafe APIs
pub(super) mod danger {
use core::marker::PhantomData;
use crate::client::WantsClientCert;
use crate::sync::Arc;
use crate::{ClientConfig, ConfigBuilder, WantsVerifier, verify};
/// Accessor for dangerous configuration options.
#[derive(Debug)]
pub struct DangerousClientConfigBuilder {
/// The underlying ClientConfigBuilder
pub cfg: ConfigBuilder<ClientConfig, WantsVerifier>,
}
impl DangerousClientConfigBuilder {
/// Set a custom certificate verifier.
pub fn with_custom_certificate_verifier(
self,
verifier: Arc<dyn verify::ServerCertVerifier>,
) -> ConfigBuilder<ClientConfig, WantsClientCert> {
ConfigBuilder {
state: WantsClientCert {
versions: self.cfg.state.versions,
verifier,
client_ech_mode: self.cfg.state.client_ech_mode,
},
provider: self.cfg.provider,
time_provider: self.cfg.time_provider,
side: PhantomData,
}
}
}
}
/// A config builder state where the caller needs to supply whether and how to provide a client
/// certificate.
///
/// For more information, see the [`ConfigBuilder`] documentation.
#[derive(Clone)]
pub struct WantsClientCert {
versions: versions::EnabledVersions,
verifier: Arc<dyn verify::ServerCertVerifier>,
client_ech_mode: Option<EchMode>,
}
impl ConfigBuilder<ClientConfig, WantsClientCert> {
/// Sets a single certificate chain and matching private key for use
/// in client authentication.
///
/// `cert_chain` is a vector of DER-encoded certificates.
/// `key_der` is a DER-encoded private key as PKCS#1, PKCS#8, or SEC1. The
/// `aws-lc-rs` and `ring` [`CryptoProvider`][crate::CryptoProvider]s support
/// all three encodings, but other `CryptoProviders` may not.
///
/// This function fails if `key_der` is invalid.
pub fn with_client_auth_cert(
self,
cert_chain: Vec<CertificateDer<'static>>,
key_der: PrivateKeyDer<'static>,
) -> Result<ClientConfig, Error> {
let certified_key = CertifiedKey::from_der(cert_chain, key_der, &self.provider)?;
Ok(self.with_client_cert_resolver(Arc::new(SingleCertAndKey::from(certified_key))))
}
/// Do not support client auth.
pub fn with_no_client_auth(self) -> ClientConfig {
self.with_client_cert_resolver(Arc::new(handy::FailResolveClientCert {}))
}
/// Sets a custom [`ResolvesClientCert`].
pub fn with_client_cert_resolver(
self,
client_auth_cert_resolver: Arc<dyn ResolvesClientCert>,
) -> ClientConfig {
ClientConfig {
provider: self.provider,
alpn_protocols: Vec::new(),
check_selected_alpn: true,
resumption: Resumption::default(),
max_fragment_size: None,
client_auth_cert_resolver,
versions: self.state.versions,
enable_sni: true,
verifier: self.state.verifier,
key_log: Arc::new(NoKeyLog {}),
enable_secret_extraction: false,
enable_early_data: false,
#[cfg(feature = "tls12")]
require_ems: cfg!(feature = "fips"),
time_provider: self.time_provider,
cert_compressors: compress::default_cert_compressors().to_vec(),
cert_compression_cache: Arc::new(compress::CompressionCache::default()),
cert_decompressors: compress::default_cert_decompressors().to_vec(),
ech_mode: self.state.client_ech_mode,
}
}
}