soth-mitm 0.3.2

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
use super::event_emitters_protocol::{
    emit_grpc_request_headers_event, emit_grpc_response_headers_event,
    emit_grpc_response_trailers_event,
};
use super::flow_hook_http_helpers::{
    build_handler_header_map_from_h2, ensure_handler_host_header_from_uri, mark_body_truncated,
    normalize_grpc_request_body_for_handler, normalize_h2_path_for_handler,
    normalize_request_body_for_handler, sanitize_block_status,
};
use super::flow_hooks::{FlowHooks, RawRequest};
use super::http2_relay_support::{
    detect_grpc_request, enforce_h2_request_header_limit, enforce_h2_response_header_limit,
    h2_error_to_io, is_h2_nonfatal_stream_error,
};
use super::http2_stream_hook_dispatch::{
    capture_h2_body, dispatch_h2_response_hooks, H2CapturedBody,
};
use super::http2_stream_relay::{h2_relay_debug, H2ByteCounters};
use super::http2_stream_relay_http1::{
    acquire_h2_h1_upstream_stream, build_http1_request_head_from_h2, H2ToH1UpstreamFactory,
};
use super::http2_stream_relay_http1_body::{
    build_h2_response_parts_from_http1, respond_h2_error_and_end, send_h2_text_response,
    write_http1_request_body_from_h2_capture,
};
use super::http2_stream_relay_http1_response_relay::relay_http1_response_body_with_incremental_forwarding;
use super::http2_stream_response_relay::h2_response_stream_hook_dispatcher;
use super::http_head_parser::{
    parse_http_response_head_with_mode, read_until_pattern_no_stage_timeout,
};
use super::io_timeouts::{
    flush_with_idle_timeout, with_stream_stage_timeout, write_all_with_idle_timeout,
};
use super::runtime_governor;
use super::{BufferedConn, HttpBodyMode};
use crate::actions::HandlerDecision;
use crate::config::InterceptMode;
use crate::engine::MitmEngine;
use crate::observe::{EventConsumer, FlowContext};
use crate::policy::PolicyEngine;
use std::io;
use std::sync::Arc;

#[allow(clippy::too_many_arguments)]
pub(crate) async fn relay_http2_stream_to_http1_upstream<P, S>(
    engine: Arc<MitmEngine<P, S>>,
    runtime_governor: Arc<runtime_governor::RuntimeGovernor>,
    flow_hooks: Arc<dyn FlowHooks>,
    stream_context: FlowContext,
    upstream_factory: H2ToH1UpstreamFactory,
    downstream_request: http::Request<h2::RecvStream>,
    mut downstream_respond: h2::server::SendResponse<bytes::Bytes>,
    max_http_head_bytes: usize,
    max_header_list_size: u32,
    strict_header_mode: bool,
    byte_counters: H2ByteCounters,
) -> io::Result<()>
where
    P: PolicyEngine + Send + Sync + 'static,
    S: EventConsumer + Send + Sync + 'static,
{
    let (request_parts, mut downstream_request_body) = downstream_request.into_parts();
    if let Err(error) = enforce_h2_request_header_limit(&request_parts, max_header_list_size) {
        h2_relay_debug(format!(
            "[h2-h1:request] request header limit exceeded; resetting stream: {error}"
        ));
        downstream_respond.send_reset(h2::Reason::PROTOCOL_ERROR);
        flow_hooks.on_stream_end(stream_context).await;
        return Ok(());
    }

    if request_parts.method == http::Method::CONNECT {
        respond_h2_error_and_end(
            &flow_hooks,
            stream_context,
            &mut downstream_respond,
            &runtime_governor,
            501,
            "HTTP/2 CONNECT translation is not supported",
        )
        .await?;
        return Ok(());
    }

    let grpc_observation = detect_grpc_request(&request_parts);
    if let Some(observation) = grpc_observation.as_ref() {
        emit_grpc_request_headers_event(
            &engine,
            stream_context.clone(),
            observation,
            &request_parts.headers,
        );
    }

    let max_flow_body_bytes = engine.config.max_flow_body_buffer_bytes.max(1);
    let request_captured = if downstream_request_body.is_end_stream() {
        H2CapturedBody {
            bytes: bytes::Bytes::new(),
            bytes_forwarded: 0,
            trailers: None,
            body_truncated: false,
        }
    } else {
        capture_h2_body(&mut downstream_request_body, max_flow_body_bytes).await?
    };
    byte_counters.request_bytes.fetch_add(
        request_captured.bytes_forwarded,
        std::sync::atomic::Ordering::Relaxed,
    );
    if request_captured.bytes_forwarded > max_flow_body_bytes as u64 {
        respond_h2_error_and_end(
            &flow_hooks,
            stream_context,
            &mut downstream_respond,
            &runtime_governor,
            413,
            "request body exceeded flow body budget",
        )
        .await?;
        return Ok(());
    }

    let mut handler_request_headers = build_handler_header_map_from_h2(&request_parts.headers);
    ensure_handler_host_header_from_uri(
        &mut handler_request_headers,
        &stream_context,
        &request_parts.uri,
    );
    if request_captured.body_truncated {
        mark_body_truncated(&mut handler_request_headers);
    }
    let mut handler_request_body = request_captured.bytes.clone();
    handler_request_body =
        normalize_request_body_for_handler(&mut handler_request_headers, handler_request_body);
    if grpc_observation.is_some() {
        handler_request_body = normalize_grpc_request_body_for_handler(
            &mut handler_request_headers,
            handler_request_body,
        );
    }
    if engine.config.intercept_mode == InterceptMode::Monitor {
        flow_hooks
            .on_request_observe(
                stream_context.clone(),
                RawRequest {
                    method: request_parts.method.to_string(),
                    path: normalize_h2_path_for_handler(&request_parts.uri),
                    headers: handler_request_headers,
                    body: handler_request_body,
                },
            )
            .await;
    } else {
        let request_decision = flow_hooks
            .on_request(
                stream_context.clone(),
                RawRequest {
                    method: request_parts.method.to_string(),
                    path: normalize_h2_path_for_handler(&request_parts.uri),
                    headers: handler_request_headers,
                    body: handler_request_body,
                },
            )
            .await;
        if let HandlerDecision::Block { status, body } = request_decision {
            let _ = send_h2_text_response(
                &mut downstream_respond,
                &runtime_governor,
                sanitize_block_status(status),
                body,
            )
            .await;
            flow_hooks.on_stream_end(stream_context).await;
            return Ok(());
        }
    }

    let upstream_stream = match acquire_h2_h1_upstream_stream(&upstream_factory).await {
        Ok(stream) => stream,
        Err(error) => {
            h2_relay_debug(format!("[h2-h1:upstream] connect failed: {error}"));
            respond_h2_error_and_end(
                &flow_hooks,
                stream_context,
                &mut downstream_respond,
                &runtime_governor,
                502,
                "upstream connect failed",
            )
            .await?;
            return Ok(());
        }
    };
    let mut upstream_conn = BufferedConn::new(upstream_stream);

    let upstream_request_head = match build_http1_request_head_from_h2(
        &request_parts,
        &stream_context,
        &request_captured,
    ) {
        Ok(value) => value,
        Err(error) => {
            h2_relay_debug(format!(
                "[h2-h1:request] request head build failed: {error}"
            ));
            respond_h2_error_and_end(
                &flow_hooks,
                stream_context,
                &mut downstream_respond,
                &runtime_governor,
                400,
                "downstream request could not be translated",
            )
            .await?;
            return Ok(());
        }
    };
    if let Err(error) = write_all_with_idle_timeout(
        &mut upstream_conn.stream,
        &upstream_request_head,
        "http2_to_http1_request_head_write",
    )
    .await
    {
        h2_relay_debug(format!(
            "[h2-h1:upstream] request head write failed: {error}"
        ));
        respond_h2_error_and_end(
            &flow_hooks,
            stream_context,
            &mut downstream_respond,
            &runtime_governor,
            502,
            "upstream request write failed",
        )
        .await?;
        return Ok(());
    }
    if let Err(error) = with_stream_stage_timeout("http2_to_http1_request_body_forward", async {
        write_http1_request_body_from_h2_capture(
            &mut upstream_conn.stream,
            &runtime_governor,
            &request_captured,
        )
        .await?;
        flush_with_idle_timeout(&mut upstream_conn.stream, "http2_to_http1_request_flush").await
    })
    .await
    {
        h2_relay_debug(format!(
            "[h2-h1:upstream] request body forward failed: {error}"
        ));
        respond_h2_error_and_end(
            &flow_hooks,
            stream_context,
            &mut downstream_respond,
            &runtime_governor,
            502,
            "upstream request forwarding failed",
        )
        .await?;
        return Ok(());
    }

    let response_raw = match read_until_pattern_no_stage_timeout(
        &mut upstream_conn,
        b"\r\n\r\n",
        max_http_head_bytes,
        &runtime_governor,
    )
    .await
    {
        Err(error) => {
            h2_relay_debug(format!(
                "[h2-h1:response] response head read failed: {error}"
            ));
            respond_h2_error_and_end(
                &flow_hooks,
                stream_context,
                &mut downstream_respond,
                &runtime_governor,
                502,
                "upstream response header read failed",
            )
            .await?;
            return Ok(());
        }
        Ok(Some(value)) => value,
        Ok(None) => {
            respond_h2_error_and_end(
                &flow_hooks,
                stream_context,
                &mut downstream_respond,
                &runtime_governor,
                502,
                "upstream closed before response headers",
            )
            .await?;
            return Ok(());
        }
    };
    let upstream_response = match parse_http_response_head_with_mode(
        &response_raw,
        request_parts.method.as_str(),
        strict_header_mode,
    ) {
        Ok(parsed) => parsed,
        Err(error) => {
            let detail =
                format!("response parse error (strict_header_mode={strict_header_mode}): {error}");
            h2_relay_debug(format!("[h2-h1:response] {detail}"));
            respond_h2_error_and_end(
                &flow_hooks,
                stream_context,
                &mut downstream_respond,
                &runtime_governor,
                502,
                "upstream response parse failed",
            )
            .await?;
            return Ok(());
        }
    };
    if upstream_response.status_code == 101 {
        respond_h2_error_and_end(
            &flow_hooks,
            stream_context,
            &mut downstream_respond,
            &runtime_governor,
            502,
            "HTTP/1.1 upgrade response is not translatable to HTTP/2",
        )
        .await?;
        return Ok(());
    }

    let response_parts = match build_h2_response_parts_from_http1(&upstream_response) {
        Ok(parts) => parts,
        Err(error) => {
            h2_relay_debug(format!(
                "[h2-h1:response] response head translate failed: {error}"
            ));
            respond_h2_error_and_end(
                &flow_hooks,
                stream_context,
                &mut downstream_respond,
                &runtime_governor,
                502,
                "upstream response headers were invalid",
            )
            .await?;
            return Ok(());
        }
    };
    if let Err(error) = enforce_h2_response_header_limit(&response_parts, max_header_list_size) {
        h2_relay_debug(format!(
            "[h2-h1:response] response header limit exceeded; resetting stream: {error}"
        ));
        downstream_respond.send_reset(h2::Reason::PROTOCOL_ERROR);
        flow_hooks.on_stream_end(stream_context).await;
        return Ok(());
    }
    if let Some(observation) = grpc_observation.as_ref() {
        emit_grpc_response_headers_event(
            &engine,
            stream_context.clone(),
            observation,
            &response_parts,
        );
    }

    let response_end_stream = matches!(
        upstream_response.body_mode,
        HttpBodyMode::None | HttpBodyMode::ContentLength(0)
    );
    let mut stream_dispatcher = h2_response_stream_hook_dispatcher(&response_parts);
    let downstream_response = http::Response::from_parts(response_parts.clone(), ());
    let mut downstream_response_stream =
        match downstream_respond.send_response(downstream_response, response_end_stream) {
            Ok(stream) => stream,
            Err(error) => {
                if is_h2_nonfatal_stream_error(&error) {
                    flow_hooks.on_stream_end(stream_context).await;
                    return Ok(());
                }
                return Err(h2_error_to_io(
                    "sending downstream HTTP/2 response headers failed",
                    error,
                ));
            }
        };
    if response_end_stream {
        let response_captured = H2CapturedBody {
            bytes: bytes::Bytes::new(),
            bytes_forwarded: 0,
            trailers: None,
            body_truncated: false,
        };
        if let Some(dispatcher) = stream_dispatcher.as_mut() {
            dispatcher.finish(&flow_hooks, &stream_context).await;
        } else {
            dispatch_h2_response_hooks(
                &flow_hooks,
                stream_context,
                &response_parts,
                &response_captured,
                max_flow_body_bytes,
            )
            .await;
        }
        return Ok(());
    }

    let relay_outcome = relay_http1_response_body_with_incremental_forwarding(
        &mut upstream_conn,
        upstream_response.body_mode,
        max_http_head_bytes,
        &runtime_governor,
        &mut downstream_response_stream,
        &flow_hooks,
        &stream_context,
        &mut stream_dispatcher,
        max_flow_body_bytes,
        engine.config.h2_response_overflow_strict,
    )
    .await?;
    byte_counters.response_bytes.fetch_add(
        relay_outcome.captured.bytes_forwarded,
        std::sync::atomic::Ordering::Relaxed,
    );

    if let (Some(observation), Some(trailers)) = (
        grpc_observation.as_ref(),
        relay_outcome.observed_trailers.as_ref(),
    ) {
        emit_grpc_response_trailers_event(&engine, stream_context.clone(), observation, trailers);
    }

    if stream_dispatcher.is_none() {
        dispatch_h2_response_hooks(
            &flow_hooks,
            stream_context,
            &response_parts,
            &relay_outcome.captured,
            max_flow_body_bytes,
        )
        .await;
    }
    Ok(())
}