soth-mitm 0.3.0

Rust intercepting proxy crate with deterministic handler/event contracts for SOTH.
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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
use std::collections::HashMap;
use std::time::Duration;

use soth_mitm::test_engine::{ConnectParseMode, MitmConfig, MitmEngine};
use soth_mitm::test_observe::{EventType, VecEventConsumer};
use soth_mitm::test_policy::DefaultPolicyEngine;
use soth_mitm::test_server::{SidecarConfig, SidecarServer};
use soth_mitm::FlowId;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::{TcpListener, TcpStream};

fn build_engine(
    config: MitmConfig,
    sink: VecEventConsumer,
) -> MitmEngine<DefaultPolicyEngine, VecEventConsumer> {
    let policy =
        DefaultPolicyEngine::new(config.ignore_hosts.clone(), config.blocked_hosts.clone());
    MitmEngine::new_checked(config, policy, sink).expect("valid test config")
}

async fn start_sidecar_with_sink(
    sink: VecEventConsumer,
    config: MitmConfig,
) -> (
    std::net::SocketAddr,
    tokio::task::JoinHandle<std::io::Result<()>>,
    VecEventConsumer,
) {
    let sidecar_config = SidecarConfig {
        listen_addr: "127.0.0.1".to_string(),
        listen_port: 0,
        max_connect_head_bytes: 64 * 1024,
        max_http_head_bytes: 64 * 1024,
        accept_retry_backoff_ms: 100,
        idle_watchdog_timeout: std::time::Duration::from_secs(30),
        websocket_idle_watchdog_timeout: std::time::Duration::from_secs(120),
        upstream_connect_timeout: std::time::Duration::from_secs(10),
        stream_stage_timeout: std::time::Duration::from_secs(5),
        h2_body_idle_timeout: std::time::Duration::from_secs(5),
        h2_response_overflow_mode: soth_mitm::test_server::H2ResponseOverflowMode::TruncateContinue,
        unix_socket_path: None,
    };
    let engine = build_engine(config, sink.clone());
    let server = SidecarServer::new(sidecar_config, engine).expect("build sidecar");
    let listener = server.bind_listener().await.expect("bind sidecar");
    let addr = listener.local_addr().expect("listener local addr");
    let handle = tokio::spawn(server.run_with_listener(listener));
    (addr, handle, sink)
}

async fn read_response_head(stream: &mut TcpStream) -> String {
    let mut data = Vec::new();
    let mut buffer = [0_u8; 1024];
    while !data.windows(4).any(|window| window == b"\r\n\r\n") {
        let read = stream.read(&mut buffer).await.expect("read response");
        if read == 0 {
            break;
        }
        data.extend_from_slice(&buffer[..read]);
    }
    String::from_utf8_lossy(&data).to_string()
}

fn assert_event_ordering_metadata(events: &[soth_mitm::test_observe::Event]) {
    assert!(!events.is_empty(), "expected at least one event");

    let mut last_sequence_id = 0_u64;
    let mut last_monotonic_ns = 0_u128;
    let mut per_flow_last = HashMap::<FlowId, u64>::new();

    for event in events {
        assert!(event.sequence_id > 0, "missing global sequence id");
        assert!(
            event.sequence_id > last_sequence_id,
            "global sequence id must be strictly increasing"
        );
        last_sequence_id = event.sequence_id;

        assert!(event.flow_sequence_id > 0, "missing flow sequence id");
        let flow_last = per_flow_last
            .entry(event.context.flow_id)
            .or_insert(event.flow_sequence_id.saturating_sub(1));
        assert!(
            event.flow_sequence_id > *flow_last,
            "flow sequence id must be strictly increasing per flow"
        );
        *flow_last = event.flow_sequence_id;

        assert!(
            event.occurred_at_monotonic_ns > 0,
            "missing monotonic timestamp"
        );
        assert!(
            event.occurred_at_monotonic_ns > last_monotonic_ns,
            "monotonic timestamp must be strictly increasing"
        );
        last_monotonic_ns = event.occurred_at_monotonic_ns;
    }
}

fn assert_exactly_one_stream_closed_per_flow(events: &[soth_mitm::test_observe::Event]) {
    let mut by_flow = HashMap::<FlowId, usize>::new();
    for event in events {
        if event.kind == EventType::StreamClosed {
            *by_flow.entry(event.context.flow_id).or_insert(0) += 1;
        }
    }
    assert!(!by_flow.is_empty(), "expected at least one stream_closed");
    for (flow_id, count) in by_flow {
        assert_eq!(
            count, 1,
            "flow_id={flow_id} emitted {count} stream_closed events"
        );
    }
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn block_action_returns_403_and_emits_reason_code() {
    let sink = VecEventConsumer::default();
    let config = MitmConfig {
        blocked_hosts: vec!["blocked.example".to_string()],
        ..MitmConfig::default()
    };

    let (proxy_addr, proxy_task, sink) = start_sidecar_with_sink(sink, config).await;

    let mut client = TcpStream::connect(proxy_addr).await.expect("connect proxy");
    client
        .write_all(b"CONNECT blocked.example:443 HTTP/1.1\r\nHost: blocked.example:443\r\n\r\n")
        .await
        .expect("write CONNECT");

    let response = read_response_head(&mut client).await;
    assert!(response.starts_with("HTTP/1.1 403"), "response: {response}");

    tokio::time::sleep(Duration::from_millis(25)).await;
    proxy_task.abort();

    let events = sink.snapshot();
    assert_event_ordering_metadata(&events);
    assert_exactly_one_stream_closed_per_flow(&events);
    assert!(events.iter().any(|e| e.kind == EventType::ConnectReceived));
    assert!(events.iter().any(|e| e.kind == EventType::ConnectDecision));

    let stream_closed = events
        .iter()
        .find(|e| e.kind == EventType::StreamClosed)
        .expect("stream_closed emitted");
    assert_eq!(
        stream_closed
            .attributes
            .get("reason_code")
            .map(String::as_str),
        Some("blocked")
    );
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn malformed_connect_emits_parse_failure_events() {
    let sink = VecEventConsumer::default();
    let config = MitmConfig {
        ignore_hosts: vec!["127.0.0.1".to_string()],
        ..MitmConfig::default()
    };
    let (proxy_addr, proxy_task, sink) = start_sidecar_with_sink(sink, config).await;

    let mut client = TcpStream::connect(proxy_addr).await.expect("connect proxy");
    client
        .write_all(b"GET / HTTP/1.2\r\nHost: example.com\r\n\r\n")
        .await
        .expect("write malformed request");

    let response = read_response_head(&mut client).await;
    assert!(response.starts_with("HTTP/1.1 400"), "response: {response}");

    tokio::time::sleep(Duration::from_millis(25)).await;
    proxy_task.abort();

    let events = sink.snapshot();
    assert_event_ordering_metadata(&events);
    assert_exactly_one_stream_closed_per_flow(&events);
    let parse_failed = events
        .iter()
        .find(|e| e.kind == EventType::ConnectParseFailed)
        .expect("connect_parse_failed emitted");
    assert_eq!(
        parse_failed
            .attributes
            .get("parse_error_code")
            .map(String::as_str),
        Some("method_not_connect")
    );

    let stream_closed = events
        .iter()
        .find(|e| e.kind == EventType::StreamClosed)
        .expect("stream_closed emitted");
    assert_eq!(
        stream_closed
            .attributes
            .get("reason_code")
            .map(String::as_str),
        Some("connect_parse_failed")
    );
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn strict_connect_parser_rejects_lowercase_method() {
    let sink = VecEventConsumer::default();
    let config = MitmConfig::default();
    let (proxy_addr, proxy_task, sink) = start_sidecar_with_sink(sink, config).await;

    let mut client = TcpStream::connect(proxy_addr).await.expect("connect proxy");
    client
        .write_all(b"connect example.com:443 HTTP/1.1\r\nHost: example.com:443\r\n\r\n")
        .await
        .expect("write malformed connect line");

    let response = read_response_head(&mut client).await;
    assert!(response.starts_with("HTTP/1.1 400"), "response: {response}");

    tokio::time::sleep(Duration::from_millis(25)).await;
    proxy_task.abort();

    let events = sink.snapshot();
    let parse_failed = events
        .iter()
        .find(|e| e.kind == EventType::ConnectParseFailed)
        .expect("connect_parse_failed emitted");
    assert_eq!(
        parse_failed
            .attributes
            .get("parse_error_code")
            .map(String::as_str),
        Some("method_not_connect")
    );
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn lenient_connect_parser_accepts_lowercase_absolute_form() {
    let upstream = TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind upstream");
    let upstream_addr = upstream.local_addr().expect("upstream addr");
    let upstream_task = tokio::spawn(async move {
        let (mut conn, _) = upstream.accept().await.expect("accept upstream");
        let mut buffer = [0_u8; 4];
        conn.read_exact(&mut buffer).await.expect("read upstream");
        assert_eq!(&buffer, b"ping");
        conn.write_all(b"pong").await.expect("write upstream");
    });

    let sink = VecEventConsumer::default();
    let config = MitmConfig {
        connect_parse_mode: ConnectParseMode::Lenient,
        ignore_hosts: vec!["127.0.0.1".to_string()],
        ..MitmConfig::default()
    };
    let (proxy_addr, proxy_task, sink) = start_sidecar_with_sink(sink, config).await;

    let mut client = TcpStream::connect(proxy_addr).await.expect("connect proxy");
    let connect = format!(
        "connect https://{}:{}/mitm HTTP/1.1\r\nHost: {}:{}\r\n\r\n",
        upstream_addr.ip(),
        upstream_addr.port(),
        upstream_addr.ip(),
        upstream_addr.port()
    );
    client
        .write_all(connect.as_bytes())
        .await
        .expect("write CONNECT");

    let response = read_response_head(&mut client).await;
    assert!(
        response.starts_with("HTTP/1.1 200 Connection Established"),
        "response: {response}"
    );

    client
        .write_all(b"ping")
        .await
        .expect("write tunnel payload");
    let mut pong = [0_u8; 4];
    client
        .read_exact(&mut pong)
        .await
        .expect("read tunnel payload");
    assert_eq!(&pong, b"pong");

    client.shutdown().await.expect("shutdown client");
    upstream_task.await.expect("upstream task");
    tokio::time::sleep(Duration::from_millis(25)).await;
    proxy_task.abort();

    let events = sink.snapshot();
    assert!(events.iter().any(|e| e.kind == EventType::ConnectDecision));
    assert!(events.iter().any(|e| {
        e.kind == EventType::StreamClosed
            && e.attributes.get("reason_code").map(String::as_str) == Some("relay_eof")
    }));
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn tunnel_action_relays_data_end_to_end() {
    let upstream = TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind upstream");
    let upstream_addr = upstream.local_addr().expect("upstream addr");
    let upstream_task = tokio::spawn(async move {
        let (mut conn, _) = upstream.accept().await.expect("accept upstream");
        let mut buffer = [0_u8; 4];
        conn.read_exact(&mut buffer).await.expect("read upstream");
        assert_eq!(&buffer, b"ping");
        conn.write_all(b"pong").await.expect("write upstream");
    });

    let sink = VecEventConsumer::default();
    let config = MitmConfig {
        ignore_hosts: vec!["127.0.0.1".to_string()],
        ..MitmConfig::default()
    };
    let (proxy_addr, proxy_task, sink) = start_sidecar_with_sink(sink, config).await;

    let mut client = TcpStream::connect(proxy_addr).await.expect("connect proxy");
    let connect = format!(
        "CONNECT {}:{} HTTP/1.1\r\nHost: {}:{}\r\n\r\n",
        upstream_addr.ip(),
        upstream_addr.port(),
        upstream_addr.ip(),
        upstream_addr.port()
    );
    client
        .write_all(connect.as_bytes())
        .await
        .expect("write CONNECT");

    let response = read_response_head(&mut client).await;
    assert!(
        response.starts_with("HTTP/1.1 200 Connection Established"),
        "response: {response}"
    );

    client
        .write_all(b"ping")
        .await
        .expect("write tunnel payload");
    let mut pong = [0_u8; 4];
    client
        .read_exact(&mut pong)
        .await
        .expect("read tunnel payload");
    assert_eq!(&pong, b"pong");

    client.shutdown().await.expect("shutdown client");
    upstream_task.await.expect("upstream task");
    tokio::time::sleep(Duration::from_millis(25)).await;
    proxy_task.abort();

    let events = sink.snapshot();
    assert_event_ordering_metadata(&events);
    assert_exactly_one_stream_closed_per_flow(&events);
    assert!(events.iter().any(|e| e.kind == EventType::ConnectDecision));
    let stream_closed = events
        .iter()
        .find(|e| e.kind == EventType::StreamClosed)
        .expect("stream_closed emitted");
    assert_eq!(
        stream_closed
            .attributes
            .get("reason_code")
            .map(String::as_str),
        Some("relay_eof")
    );
}

#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
async fn concurrent_short_lived_tunnels_500() {
    const N: usize = 500;
    let upstream = TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind upstream");
    let upstream_addr = upstream.local_addr().expect("upstream addr");
    let upstream_task = tokio::spawn(async move {
        for _ in 0..N {
            let (mut conn, _) = upstream.accept().await.expect("accept upstream");
            tokio::spawn(async move {
                let mut scratch = [0_u8; 16];
                let _ = conn.read(&mut scratch).await;
            });
        }
    });

    let sink = VecEventConsumer::default();
    let config = MitmConfig {
        ignore_hosts: vec!["127.0.0.1".to_string()],
        ..MitmConfig::default()
    };
    let (proxy_addr, proxy_task, _sink) = start_sidecar_with_sink(sink, config).await;

    let mut tasks = Vec::with_capacity(N);
    for _ in 0..N {
        let connect_addr = proxy_addr;
        let target_ip = upstream_addr.ip();
        let target_port = upstream_addr.port();
        tasks.push(tokio::spawn(async move {
            let mut client = TcpStream::connect(connect_addr)
                .await
                .expect("connect proxy");
            let connect = format!(
                "CONNECT {target_ip}:{target_port} HTTP/1.1\r\nHost: {target_ip}:{target_port}\r\n\r\n"
            );
            client
                .write_all(connect.as_bytes())
                .await
                .expect("write CONNECT");
            let response = read_response_head(&mut client).await;
            assert!(
                response.starts_with("HTTP/1.1 200 Connection Established"),
                "response: {response}"
            );
        }));
    }

    for task in tasks {
        task.await.expect("client task");
    }

    upstream_task.await.expect("upstream accept loop");
    tokio::time::sleep(Duration::from_millis(50)).await;
    proxy_task.abort();
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn blocked_host_never_opens_upstream_socket() {
    let upstream = TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind upstream");
    let upstream_addr = upstream.local_addr().expect("upstream addr");

    let sink = VecEventConsumer::default();
    let config = MitmConfig {
        blocked_hosts: vec!["127.0.0.1".to_string()],
        ..MitmConfig::default()
    };
    let (proxy_addr, proxy_task, _sink) = start_sidecar_with_sink(sink, config).await;

    let mut client = TcpStream::connect(proxy_addr).await.expect("connect proxy");
    let connect = format!(
        "CONNECT {}:{} HTTP/1.1\r\nHost: {}:{}\r\n\r\n",
        upstream_addr.ip(),
        upstream_addr.port(),
        upstream_addr.ip(),
        upstream_addr.port()
    );
    client
        .write_all(connect.as_bytes())
        .await
        .expect("write CONNECT");

    let response = read_response_head(&mut client).await;
    assert!(response.starts_with("HTTP/1.1 403"), "response: {response}");

    let accept_result = tokio::time::timeout(Duration::from_millis(200), upstream.accept()).await;
    assert!(
        accept_result.is_err(),
        "blocked flow unexpectedly opened an upstream TCP socket"
    );
    proxy_task.abort();
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn tunnel_action_does_not_emit_tls_handshake_events() {
    let upstream = TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind upstream");
    let upstream_addr = upstream.local_addr().expect("upstream addr");
    let upstream_task = tokio::spawn(async move {
        let (mut conn, _) = upstream.accept().await.expect("accept upstream");
        let mut buffer = [0_u8; 4];
        conn.read_exact(&mut buffer).await.expect("read upstream");
        assert_eq!(&buffer, b"ping");
        conn.write_all(b"pong").await.expect("write upstream");
    });

    let sink = VecEventConsumer::default();
    let config = MitmConfig {
        ignore_hosts: vec!["127.0.0.1".to_string()],
        ..MitmConfig::default()
    };
    let (proxy_addr, proxy_task, sink) = start_sidecar_with_sink(sink, config).await;

    let mut client = TcpStream::connect(proxy_addr).await.expect("connect proxy");
    let connect = format!(
        "CONNECT {}:{} HTTP/1.1\r\nHost: {}:{}\r\n\r\n",
        upstream_addr.ip(),
        upstream_addr.port(),
        upstream_addr.ip(),
        upstream_addr.port()
    );
    client
        .write_all(connect.as_bytes())
        .await
        .expect("write CONNECT");
    let response = read_response_head(&mut client).await;
    assert!(
        response.starts_with("HTTP/1.1 200 Connection Established"),
        "response: {response}"
    );

    client
        .write_all(b"ping")
        .await
        .expect("write tunnel payload");
    let mut pong = [0_u8; 4];
    client
        .read_exact(&mut pong)
        .await
        .expect("read tunnel payload");
    assert_eq!(&pong, b"pong");

    client.shutdown().await.expect("shutdown client");
    upstream_task.await.expect("upstream task");
    tokio::time::sleep(Duration::from_millis(30)).await;
    proxy_task.abort();

    let events = sink.snapshot();
    assert!(
        events.iter().all(|event| {
            event.kind != EventType::TlsHandshakeStarted
                && event.kind != EventType::TlsHandshakeSucceeded
                && event.kind != EventType::TlsHandshakeFailed
        }),
        "tunnel-only flows must not emit TLS handshake MITM events"
    );
}