leyline-http 0.1.5

HTTP client that impersonates Chrome, Firefox, and Safari on the wire: TLS (JA3/JA4), HTTP/2, and HTTP/3 fingerprints
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
#![expect(
    clippy::unwrap_used,
    reason = "test/example harness: unwrap doubles as the assertion - a failed helper panics with the test location"
)]
#[path = "it/tls_support/mod.rs"]
mod tls_support;

use std::net::SocketAddr;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::{Arc, Mutex};

use leyline::tls::{ResolveFuture, Resolver};
use leyline::{ProtocolPolicy, Session, TlsTrustConfig};
use leyline_bssl::hash::{MessageDigest, hash};
use leyline_bssl_tokio::SslStream;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpStream;

async fn reply_ok(mut stream: SslStream<TcpStream>) {
    let mut head = Vec::new();
    let mut buf = [0u8; 1024];
    while !head.windows(4).any(|window| window == b"\r\n\r\n") {
        match stream.read(&mut buf).await {
            Ok(0) | Err(_) => return,
            Ok(read) => head.extend_from_slice(&buf[..read]),
        }
    }
    drop(
        stream
            .write_all(b"HTTP/1.1 200 OK\r\ncontent-length: 2\r\nconnection: close\r\n\r\nok")
            .await,
    );
}

async fn self_signed_server() -> (u16, Vec<u8>) {
    let (cert, key) = tls_support::self_signed();
    let der = cert.to_der().unwrap();
    let port = tls_support::tls_server_per_connection(
        cert,
        key,
        Arc::new(AtomicUsize::new(0)),
        |_| tls_support::HTTP11,
        |_, stream| reply_ok(stream),
    )
    .await;
    (port, der)
}

fn bare_trust() -> TlsTrustConfig {
    TlsTrustConfig::new().env_roots(false).system_roots(false)
}

async fn fetch(trust: TlsTrustConfig, url: String) -> leyline::Result<String> {
    Session::builder()
        .protocol(ProtocolPolicy::Http1)
        .tls_trust(trust)
        .build()
        .unwrap()
        .get(url)
        .send()
        .await?
        .text()
        .await
}

#[tokio::test]
async fn a_self_signed_server_is_refused_without_trust_and_reached_with_danger_accept() {
    let (port, _) = self_signed_server().await;
    let url = format!("https://127.0.0.1:{port}/");

    fetch(bare_trust(), url.clone())
        .await
        .expect_err("expected Err");
    assert_eq!(
        fetch(bare_trust().danger_accept_invalid_certs(true), url)
            .await
            .unwrap(),
        "ok"
    );
}

#[tokio::test]
async fn a_pinned_leaf_connects_only_when_the_pin_matches() {
    let (port, der) = self_signed_server().await;
    let url = format!("https://127.0.0.1:{port}/");
    let digest = hash(MessageDigest::sha256(), &der).unwrap();
    let mut pin = [0u8; 32];
    pin.copy_from_slice(&digest);

    assert_eq!(
        fetch(
            bare_trust()
                .add_ca_der(der.clone())
                .add_pinned_leaf_sha256(pin),
            url.clone()
        )
        .await
        .unwrap(),
        "ok"
    );
    fetch(
        bare_trust().add_ca_der(der).add_pinned_leaf_sha256([7; 32]),
        url,
    )
    .await
    .expect_err("expected Err");
}

struct Recording {
    target: SocketAddr,
    asked: Mutex<Vec<(String, u16)>>,
}

impl Resolver for Recording {
    fn resolve<'a>(&'a self, host: &'a str, port: u16) -> ResolveFuture<'a> {
        self.asked.lock().unwrap().push((host.to_owned(), port));
        let target = self.target;
        Box::pin(async move { Ok(vec![target]) })
    }
}

#[tokio::test]
async fn a_custom_resolver_decides_where_a_hostname_connects() {
    let (port, der) = self_signed_server().await;
    let resolver = Arc::new(Recording {
        target: SocketAddr::from(([127, 0, 0, 1], port)),
        asked: Mutex::new(Vec::new()),
    });

    let body = Session::builder()
        .protocol(ProtocolPolicy::Http1)
        .tls_trust(
            bare_trust()
                .add_ca_der(der)
                .danger_accept_invalid_certs(true),
        )
        .dns(Arc::clone(&resolver) as Arc<dyn Resolver>)
        .build()
        .unwrap()
        .get(format!("https://shop.invalid:{port}/"))
        .send()
        .await
        .unwrap()
        .text()
        .await
        .unwrap();

    assert_eq!(body, "ok");
    assert_eq!(
        resolver.asked.lock().unwrap().as_slice(),
        &[("shop.invalid".to_owned(), port)]
    );
}

fn http1_session(trust: TlsTrustConfig) -> Session {
    Session::builder()
        .protocol(ProtocolPolicy::Http1)
        .tls_trust(trust)
        .build()
        .unwrap()
}

struct ResumingServer {
    url: String,
    der: Vec<u8>,
    pem: Vec<u8>,
    resumed: Arc<AtomicUsize>,
}

async fn resuming_server() -> ResumingServer {
    let (cert, key) = tls_support::self_signed();
    let der = cert.to_der().unwrap();
    let pem = cert.to_pem().unwrap();
    let resumed = Arc::new(AtomicUsize::new(0));
    let counter = Arc::clone(&resumed);
    let port = tls_support::tls_server_per_connection(
        cert,
        key,
        Arc::new(AtomicUsize::new(0)),
        |_| tls_support::HTTP11,
        move |_, stream: SslStream<TcpStream>| {
            let counter = Arc::clone(&counter);
            async move {
                if stream.ssl().session_reused() {
                    counter.fetch_add(1, Ordering::SeqCst);
                }
                reply_ok(stream).await;
            }
        },
    )
    .await;
    ResumingServer {
        url: format!("https://127.0.0.1:{port}/"),
        der,
        pem,
        resumed,
    }
}

fn scratch_file(name: &str, contents: &[u8]) -> std::path::PathBuf {
    let dir = std::env::temp_dir().join(format!("leyline-trust-{}", std::process::id()));
    std::fs::create_dir_all(&dir).unwrap();
    let path = dir.join(name);
    std::fs::write(&path, contents).unwrap();
    path
}

fn unrelated_pem() -> Vec<u8> {
    tls_support::self_signed().0.to_pem().unwrap()
}

#[tokio::test]
async fn a_saved_tls_session_resumes_only_under_the_trust_that_made_it() {
    let server = resuming_server().await;
    let unpinned = http1_session(bare_trust().add_ca_der(server.der.clone()));
    let first = unpinned.get(server.url.clone()).send().await.unwrap();
    assert_eq!(first.text().await.unwrap(), "ok");
    let state = unpinned.state();

    let pinned = http1_session(
        bare_trust()
            .add_ca_der(server.der.clone())
            .add_pinned_leaf_sha256([7; 32]),
    );
    state.restore_into(&pinned);
    let refused = pinned.get(server.url.clone()).send().await.unwrap_err();
    assert!(refused.tls().is_some(), "{refused:?}");
    assert_eq!(server.resumed.load(Ordering::SeqCst), 0);

    let same = http1_session(bare_trust().add_ca_der(server.der));
    state.restore_into(&same);
    let again = same.get(server.url).send().await.unwrap();
    assert_eq!(again.text().await.unwrap(), "ok");
    assert_eq!(server.resumed.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn a_fresh_pool_labels_its_tickets_with_the_roots_it_loaded() {
    let server = resuming_server().await;
    let ca_file = scratch_file("fresh-pool-ca.pem", &server.pem);
    let original = http1_session(bare_trust().add_ca_file(&ca_file));
    std::fs::write(&ca_file, unrelated_pem()).unwrap();
    let copy = original.fresh_pool();
    let first = copy.get(server.url.clone()).send().await.unwrap();
    assert_eq!(first.text().await.unwrap(), "ok");
    let state = copy.state();

    let rotated = http1_session(bare_trust().add_ca_file(&ca_file));
    state.restore_into(&rotated);
    let refused = rotated.get(server.url).send().await.unwrap_err();
    assert!(refused.tls().is_some(), "{refused:?}");
    assert_eq!(server.resumed.load(Ordering::SeqCst), 0);
}

#[tokio::test]
async fn a_saved_tls_session_does_not_resume_after_environment_roots_change() {
    let server = resuming_server().await;
    let trusted = scratch_file("env-trusted.pem", &server.pem);
    let other = scratch_file("env-other.pem", &unrelated_pem());
    let env_trust = || TlsTrustConfig::new().system_roots(false).env_roots(true);
    // SAFETY: no other test in this binary builds a session with environment roots, so no thread reads SSL_CERT_FILE while it changes.
    unsafe { std::env::set_var("SSL_CERT_FILE", &trusted) };
    let before = http1_session(env_trust());
    let first = before.get(server.url.clone()).send().await.unwrap();
    assert_eq!(first.text().await.unwrap(), "ok");
    let state = before.state();

    // SAFETY: see above.
    unsafe { std::env::set_var("SSL_CERT_FILE", &other) };
    let after = http1_session(env_trust());
    // SAFETY: see above.
    unsafe { std::env::remove_var("SSL_CERT_FILE") };
    state.restore_into(&after);
    let refused = after.get(server.url).send().await.unwrap_err();
    assert!(refused.tls().is_some(), "{refused:?}");
    assert_eq!(server.resumed.load(Ordering::SeqCst), 0);
}

#[tokio::test]
async fn a_saved_tls_session_does_not_resume_after_the_client_certificate_rotates() {
    let server = resuming_server().await;
    let (cert, key) = tls_support::self_signed();
    let chain = scratch_file("client-chain.pem", &cert.to_pem().unwrap());
    let private = scratch_file("client-key.pem", &key.private_key_to_pem_pkcs8().unwrap());
    let with_identity = || {
        http1_session(
            bare_trust()
                .add_ca_der(server.der.clone())
                .client_identity(&chain, &private),
        )
    };
    let before = with_identity();
    let first = before.get(server.url.clone()).send().await.unwrap();
    assert_eq!(first.text().await.unwrap(), "ok");
    let state = before.state();

    let (next_cert, next_key) = tls_support::self_signed();
    std::fs::write(&chain, next_cert.to_pem().unwrap()).unwrap();
    std::fs::write(&private, next_key.private_key_to_pem_pkcs8().unwrap()).unwrap();
    let after = with_identity();
    state.restore_into(&after);
    let again = after.get(server.url.clone()).send().await.unwrap();
    assert_eq!(again.text().await.unwrap(), "ok");
    assert_eq!(server.resumed.load(Ordering::SeqCst), 0);
}

#[tokio::test]
async fn a_client_certificate_in_a_trusted_certificate_block_loads() {
    let server = resuming_server().await;
    let (cert, key) = tls_support::self_signed();
    let pem = String::from_utf8(cert.to_pem().unwrap())
        .unwrap()
        .replace("CERTIFICATE-----", "TRUSTED CERTIFICATE-----");
    let chain = scratch_file("trusted-client-chain.pem", pem.as_bytes());
    let private = scratch_file(
        "trusted-client-key.pem",
        &key.private_key_to_pem_pkcs8().unwrap(),
    );
    let session = Session::builder()
        .protocol(ProtocolPolicy::Http1)
        .tls_trust(
            bare_trust()
                .add_ca_der(server.der.clone())
                .client_identity(&chain, &private),
        )
        .build()
        .unwrap();
    let response = session.get(server.url).send().await.unwrap();
    assert_eq!(response.text().await.unwrap(), "ok");
}

#[tokio::test]
async fn the_server_receives_the_client_leaf_and_its_chain_in_order() {
    use leyline_bssl::ssl::{SslContextBuilder, SslMethod, SslVerifyMode};
    let (server_cert, server_key) = tls_support::self_signed();
    let server_der = server_cert.to_der().unwrap();
    let mut context = SslContextBuilder::new(SslMethod::tls()).unwrap();
    context.set_certificate(&server_cert).unwrap();
    context.set_private_key(&server_key).unwrap();
    context.set_verify_callback(SslVerifyMode::PEER, |_, _| true);
    let context = context.build();
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let port = listener.local_addr().unwrap().port();
    let (seen_tx, seen_rx) = tokio::sync::oneshot::channel();
    tokio::spawn(async move {
        let (tcp, _) = listener.accept().await.unwrap();
        let ssl = leyline_bssl::ssl::Ssl::new(&context).unwrap();
        let stream = leyline_bssl_tokio::SslStreamBuilder::new(ssl, tcp)
            .accept()
            .await
            .unwrap();
        let leaf = stream.ssl().peer_certificate().map(|c| c.to_der().unwrap());
        let chain: Vec<Vec<u8>> = stream
            .ssl()
            .peer_cert_chain()
            .map(|chain| chain.iter().map(|c| c.to_der().unwrap()).collect())
            .unwrap_or_default();
        seen_tx.send((leaf, chain)).unwrap();
        reply_ok(stream).await;
    });

    let (leaf, leaf_key) = tls_support::self_signed();
    let (intermediate, _) = tls_support::self_signed();
    let mut pem = String::from_utf8(leaf.to_pem().unwrap())
        .unwrap()
        .replace("CERTIFICATE-----", "TRUSTED CERTIFICATE-----");
    pem.push_str(&String::from_utf8(intermediate.to_pem().unwrap()).unwrap());
    let chain = scratch_file("ordered-client-chain.pem", pem.as_bytes());
    let private = scratch_file(
        "ordered-client-key.pem",
        &leaf_key.private_key_to_pem_pkcs8().unwrap(),
    );
    let session = http1_session(
        bare_trust()
            .add_ca_der(server_der)
            .client_identity(&chain, &private),
    );
    let response = session
        .get(format!("https://127.0.0.1:{port}/"))
        .send()
        .await
        .unwrap();
    assert_eq!(response.text().await.unwrap(), "ok");
    let (seen_leaf, seen_chain) = seen_rx.await.unwrap();
    assert_eq!(seen_leaf, Some(leaf.to_der().unwrap()));
    let intermediate = intermediate.to_der().unwrap();
    let after_leaf: Vec<&Vec<u8>> = seen_chain
        .iter()
        .filter(|der| **der != leaf.to_der().unwrap())
        .collect();
    assert_eq!(after_leaf, [&intermediate]);
}

#[tokio::test]
async fn restored_tickets_for_other_trust_are_not_kept() {
    let server = resuming_server().await;
    let unpinned = http1_session(bare_trust().add_ca_der(server.der.clone()));
    let first = unpinned.get(server.url.clone()).send().await.unwrap();
    assert_eq!(first.text().await.unwrap(), "ok");
    let state = unpinned.state();
    let saved = serde_json::to_value(&state).unwrap();
    assert!(!saved["tls_sessions"].as_array().unwrap().is_empty());

    let pinned = http1_session(
        bare_trust()
            .add_ca_der(server.der)
            .add_pinned_leaf_sha256([7; 32]),
    );
    state.restore_into(&pinned);
    let kept = serde_json::to_value(pinned.state()).unwrap();
    assert_eq!(kept["tls_sessions"].as_array().map(Vec::len), Some(0));
}

async fn tunnel_proxy() -> u16 {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let port = listener.local_addr().unwrap().port();
    tokio::spawn(async move {
        while let Ok((mut client, _)) = listener.accept().await {
            tokio::spawn(async move {
                let mut head = Vec::new();
                let mut buf = [0u8; 1024];
                while !head.windows(4).any(|w| w == b"\r\n\r\n") {
                    match client.read(&mut buf).await {
                        Ok(0) | Err(_) => return,
                        Ok(read) => head.extend_from_slice(&buf[..read]),
                    }
                }
                let line = String::from_utf8_lossy(&head)
                    .lines()
                    .next()
                    .unwrap_or_default()
                    .to_owned();
                let Some(target) = line.split_whitespace().nth(1) else {
                    return;
                };
                let Ok(mut upstream) = TcpStream::connect(target).await else {
                    return;
                };
                if client
                    .write_all(b"HTTP/1.1 200 Connection established\r\n\r\n")
                    .await
                    .is_err()
                {
                    return;
                }
                drop(tokio::io::copy_bidirectional(&mut client, &mut upstream).await);
            });
        }
    });
    port
}

#[tokio::test]
async fn saved_tickets_through_a_proxy_hold_no_proxy_credentials() {
    let server = resuming_server().await;
    let proxy = tunnel_proxy().await;
    let session = Session::builder()
        .protocol(ProtocolPolicy::Http1)
        .tls_trust(bare_trust().add_ca_der(server.der))
        .proxy(
            leyline::ProxyConfig::new()
                .env(false)
                .rule(leyline::ProxyRule::all(format!(
                    "http://tunneluser:tunnelsecret@127.0.0.1:{proxy}"
                ))),
        )
        .build()
        .unwrap();
    let response = session.get(server.url).send().await.unwrap();
    assert_eq!(response.text().await.unwrap(), "ok");
    let saved = serde_json::to_string(&session.state()).unwrap();
    assert!(saved.contains("tls_sessions"), "{saved}");
    assert!(
        !saved.contains("tunneluser"),
        "the proxy user name was saved"
    );
    assert!(
        !saved.contains("tunnelsecret"),
        "the proxy password was saved"
    );
}