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
use std::any::Any;
use crate::error::{ResultExt, message};
use crate::{Result, bstr::BStr};
impl crate::Repository {
/// Produce configuration suitable for `url`, as differentiated by its protocol/scheme, to be passed to a transport instance via
/// [configure()][gix_transport::client::TransportWithoutIO::configure()] (via `&**config` to pass the contained `Any` and not the `Box`).
/// `None` is returned if there is no known configuration. If `remote_name` is not `None`, the remote's name may contribute to
/// configuration overrides, typically for the HTTP transport.
///
/// Note that the caller may cast the instance themselves to modify it before passing it on.
///
/// For transports that support proxy authentication, the
/// [default authentication method](crate::config::Snapshot::credential_helpers()) will be used with the url of the proxy
/// if it contains a user name.
#[cfg_attr(
not(any(
feature = "blocking-http-transport-reqwest",
feature = "blocking-http-transport-curl"
)),
allow(unused_variables)
)]
pub fn transport_options<'a>(
&self,
url: impl Into<&'a BStr>,
remote_name: Option<&BStr>,
) -> Result<Option<Box<dyn Any>>> {
let url = gix_url::parse(url.into()).or_raise(|| message("Invalid URL passed for configuration"))?;
use gix_url::Scheme::*;
match &url.scheme {
Http | Https => {
let options: Result<Option<Box<dyn Any>>> = {
#[cfg(not(any(
feature = "blocking-http-transport-reqwest",
feature = "blocking-http-transport-curl"
)))]
{
Ok(None)
}
#[cfg(any(
feature = "blocking-http-transport-reqwest",
feature = "blocking-http-transport-curl"
))]
{
use std::sync::{Arc, Mutex};
use gix_transport::client::blocking_io::http::{
self,
options::{ProxyAuthMethod, SslVersion, SslVersionRangeInclusive},
};
use crate::{
bstr::BString,
config,
config::{
cache::util::ApplyLeniency,
tree::{Key, Remote, gitoxide},
},
};
fn try_to_string(
v: BString,
lenient: bool,
remote_name: Option<&BStr>,
key: &'static config::tree::keys::String,
) -> Result<Option<String>> {
let value = key.try_into_string(v);
let value = match remote_name {
Some(name) => value.or_raise(|| message!("Invalid configuration for remote {name:?}")),
None => value,
};
value.map(Some).with_leniency(lenient)
}
fn proxy_auth_method(
value_and_key: Option<(
BString,
Option<&BStr>,
&'static config::tree::http::ProxyAuthMethod,
)>,
) -> Result<ProxyAuthMethod> {
let value = value_and_key
.map(|(method, remote_name, key)| {
let method = key.try_into_proxy_auth_method(method);
match remote_name {
Some(name) => {
method.or_raise(|| message!("Invalid configuration for remote {name:?}"))
}
None => method,
}
})
.transpose()?
.unwrap_or_default();
Ok(value)
}
fn ssl_version(
config: &gix_config::File,
key_str: &'static str,
key: &'static config::tree::http::SslVersion,
mut filter: fn(&gix_config::file::Metadata) -> bool,
lenient: bool,
) -> Result<Option<SslVersion>> {
debug_assert_eq!(
key_str,
key.logical_name(),
"BUG: hardcoded and generated key names must match"
);
config
.string_filter(key_str, &mut filter)
.filter(|v| !v.is_empty())
.map(|v| key.try_into_ssl_version(v))
.transpose()
.with_leniency(lenient)
}
fn proxy(
value: Option<(BString, Option<&BStr>, &'static config::tree::keys::String)>,
lenient: bool,
) -> Result<Option<String>> {
Ok(value
.and_then(|(v, remote_name, key)| {
try_to_string(v, lenient, remote_name, key).transpose()
})
.transpose()?
.map(|mut proxy| {
if !proxy.trim().is_empty() && !proxy.contains("://") {
proxy.insert_str(0, "http://");
proxy
} else {
proxy
}
}))
}
let mut opts = http::Options::default();
let config = &self.config.resolved;
let mut trusted_only = self.filter_config_section();
let lenient = self.config.lenient_config;
opts.extra_headers = {
let key = "http.extraHeader";
debug_assert_eq!(key, &config::tree::Http::EXTRA_HEADER.logical_name());
config
.strings_filter(key, &mut trusted_only)
.map(|values| config::tree::Http::EXTRA_HEADER.try_into_extra_header(values))
.transpose()?
.unwrap_or_default()
};
opts.follow_redirects = {
let key = "http.followRedirects";
config::tree::Http::FOLLOW_REDIRECTS.try_into_follow_redirects(
config.string_filter(key, &mut trusted_only).unwrap_or_default(),
|| config.boolean_filter(key, &mut trusted_only).with_leniency(lenient),
)?
};
opts.low_speed_time_seconds = config::tree::Http::LOW_SPEED_TIME
.try_into_u64(config.integer_filter("http.lowSpeedTime", &mut trusted_only))
.with_leniency(lenient)?
.unwrap_or_default();
opts.low_speed_limit_bytes_per_second = config::tree::Http::LOW_SPEED_LIMIT
.try_into_u32(config.integer_filter("http.lowSpeedLimit", &mut trusted_only))
.with_leniency(lenient)?
.unwrap_or_default();
opts.proxy = proxy(
remote_name
.and_then(|name| {
config
.string_filter(
&format!("remote.{}.{}", name, Remote::PROXY.name),
&mut trusted_only,
)
.map(|v| (v, Some(name), &Remote::PROXY))
})
.or_else(|| {
let key = "http.proxy";
debug_assert_eq!(key, config::tree::Http::PROXY.logical_name());
let http_proxy = config
.string_filter(key, &mut trusted_only)
.map(|v| (v, None, &config::tree::Http::PROXY))
.or_else(|| {
let key = "gitoxide.http.proxy";
debug_assert_eq!(key, gitoxide::Http::PROXY.logical_name());
config
.string_filter(key, &mut trusted_only)
.map(|v| (v, None, &gitoxide::Http::PROXY))
});
if url.scheme == Https {
http_proxy.or_else(|| {
let key = "gitoxide.https.proxy";
debug_assert_eq!(key, gitoxide::Https::PROXY.logical_name());
config
.string_filter(key, &mut trusted_only)
.map(|v| (v, None, &gitoxide::Https::PROXY))
})
} else {
http_proxy
}
})
.or_else(|| {
let key = "gitoxide.http.allProxy";
debug_assert_eq!(key, gitoxide::Http::ALL_PROXY.logical_name());
config
.string_filter(key, &mut trusted_only)
.map(|v| (v, None, &gitoxide::Http::ALL_PROXY))
}),
lenient,
)?;
{
let key = "gitoxide.http.noProxy";
debug_assert_eq!(key, gitoxide::Http::NO_PROXY.logical_name());
opts.no_proxy = config
.string_filter(key, &mut trusted_only)
.and_then(|v| try_to_string(v, lenient, None, &gitoxide::Http::NO_PROXY).transpose())
.transpose()?;
}
opts.proxy_auth_method = proxy_auth_method({
let key = "gitoxide.http.proxyAuthMethod";
debug_assert_eq!(key, gitoxide::Http::PROXY_AUTH_METHOD.logical_name());
config
.string_filter(key, &mut trusted_only)
.map(|v| (v, None, &gitoxide::Http::PROXY_AUTH_METHOD))
.or_else(|| {
remote_name
.and_then(|name| {
config
.string_filter(
&format!("remote.{name}.proxyAuthMethod"),
&mut trusted_only,
)
.map(|v| (v, Some(name), &Remote::PROXY_AUTH_METHOD))
})
.or_else(|| {
let key = "http.proxyAuthMethod";
debug_assert_eq!(key, config::tree::Http::PROXY_AUTH_METHOD.logical_name());
config
.string_filter(key, &mut trusted_only)
.map(|v| (v, None, &config::tree::Http::PROXY_AUTH_METHOD))
})
})
})?;
opts.proxy_authenticate = opts
.proxy
.as_deref()
.filter(|url| !url.is_empty())
.map(gix_url::parse)
.transpose()
.or_raise(|| message("Invalid URL passed for configuration"))?
.filter(|url| url.user().is_some())
.map(|url| -> Result<_> {
let (mut cascade, action_with_normalized_url, prompt_opts) =
self.config_snapshot().credential_helpers(url).or_raise(|| {
message(
"Could not configure the credential helpers for the authenticated proxy url",
)
})?;
Ok((
action_with_normalized_url,
Arc::new(Mutex::new(move |action| cascade.invoke(action, prompt_opts.clone())))
as Arc<Mutex<http::options::AuthenticateFn>>,
))
})
.transpose()?;
opts.connect_timeout = {
let key = "gitoxide.http.connectTimeout";
debug_assert_eq!(key, gitoxide::Http::CONNECT_TIMEOUT.logical_name());
gitoxide::Http::CONNECT_TIMEOUT
.try_into_duration(config.integer_filter(key, &mut trusted_only))
.with_leniency(lenient)?
};
{
let key = "http.userAgent";
opts.user_agent = config
.string_filter(key, &mut trusted_only)
.and_then(|v| {
try_to_string(v, lenient, None, &config::tree::Http::USER_AGENT).transpose()
})
.transpose()?
.or_else(|| Some(crate::env::agent().into()));
}
{
let key = "http.version";
opts.http_version = config
.string_filter(key, &mut trusted_only)
.map(|v| config::tree::Http::VERSION.try_into_http_version(v))
.transpose()?;
}
{
opts.verbose = config
.boolean_filter(gitoxide::Http::VERBOSE, &mut trusted_only)
.ok()
.flatten()
.unwrap_or_default();
}
let may_use_cainfo = {
let key = "http.schannelUseSSLCAInfo";
config::tree::Http::SCHANNEL_USE_SSL_CA_INFO
.enrich_error(config.boolean_filter(key, &mut trusted_only))
.with_leniency(lenient)?
.unwrap_or(true)
};
if may_use_cainfo {
let key = "http.sslCAInfo";
debug_assert_eq!(key, config::tree::Http::SSL_CA_INFO.logical_name());
opts.ssl_ca_info = config
.path_filter(key, &mut trusted_only)
.map(|p| {
use crate::config::cache::interpolate_context;
p.interpolate(interpolate_context(
self.install_dir().ok().as_deref(),
self.config.home_dir().as_deref(),
))
})
.transpose()
.with_leniency(lenient)
.or_raise(|| message!("Could not interpolate path at key {key:?}"))?;
}
{
opts.ssl_version = ssl_version(
config,
"http.sslVersion",
&config::tree::Http::SSL_VERSION,
trusted_only,
lenient,
)?
.map(|v| SslVersionRangeInclusive { min: v, max: v });
let min_max = ssl_version(
config,
"gitoxide.http.sslVersionMin",
&gitoxide::Http::SSL_VERSION_MIN,
trusted_only,
lenient,
)
.and_then(|min| {
ssl_version(
config,
"gitoxide.http.sslVersionMax",
&gitoxide::Http::SSL_VERSION_MAX,
trusted_only,
lenient,
)
.map(|max| min.zip(max))
})?;
if let Some((min, max)) = min_max {
let v = opts.ssl_version.get_or_insert(SslVersionRangeInclusive {
min: SslVersion::TlsV1_3,
max: SslVersion::TlsV1_3,
});
v.min = min;
v.max = max;
}
}
{
let key = "gitoxide.http.sslNoVerify";
let ssl_no_verify = config::tree::gitoxide::Http::SSL_NO_VERIFY
.enrich_error(config.boolean_filter(key, &mut trusted_only))
.with_leniency(lenient)?
.unwrap_or_default();
if ssl_no_verify {
opts.ssl_verify = false;
} else {
let key = "http.sslVerify";
opts.ssl_verify = config::tree::Http::SSL_VERIFY
.enrich_error(config.boolean_filter(key, &mut trusted_only))
.with_leniency(lenient)?
.unwrap_or(true);
}
}
#[cfg(feature = "blocking-http-transport-curl")]
{
let key = "http.schannelCheckRevoke";
let schannel_check_revoke = config::tree::Http::SCHANNEL_CHECK_REVOKE
.enrich_error(config.boolean_filter(key, &mut trusted_only))
.with_leniency(lenient)?;
let backend = gix_protocol::transport::client::blocking_io::http::curl::Options {
schannel_check_revoke,
};
opts.backend =
Some(Arc::new(Mutex::new(backend)) as Arc<Mutex<dyn Any + Send + Sync + 'static>>);
}
Ok(Some(Box::new(opts) as Box<dyn Any>))
}
};
options.or_raise(|| message("Could obtain configuration for an HTTP url"))
}
File | Git | Ssh | Ext | Helper(_) | HelperUrl(_) => Ok(None),
}
}
}