courierust 1.0.0

no_std HTTP and gRPC engine with work-stealing, RFC 9218, and JA3/JA4 fingerprinting.
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
//! HTTP/2 connection serving (prior knowledge / h2c).
//!
//! Requests are decoded from HEADERS+DATA and handed to the handler;
//! responses stream back with flow-control-aware backpressure: channel
//! bodies are only drained when the connection accepts more data.

use crate::courierust_body::Body;
use crate::courierust_bytes::Bytes;
use crate::courierust_error::{Error, Result};
use crate::courierust_h2::connection::{Config as H2Config, Connection, Event};
use crate::courierust_h2::error::ErrorCode;
use crate::courierust_hpack::HeaderField;
use crate::courierust_http::header::{HeaderMap, HeaderName, HeaderValue};
use crate::courierust_http::request::Request;
use crate::courierust_http::response::Response;
use crate::courierust_http::version::Version;
use crate::courierust_net::ConnStream;
use crate::courierust_server::{Handler, ServerConfig};
use std::collections::HashMap;
use std::sync::mpsc::{Receiver, TryRecvError};

/// A response body waiting for flow-control room.
struct Deferred {
    rx: Receiver<Result<Bytes>>,
    ending: bool,
    /// Trailing header block to send once the body ends (HTTP/2).
    trailers: Option<Vec<HeaderField>>,
}

/// Consume and verify the 24-byte HTTP/2 client connection preface.
fn read_preface(stream: &ConnStream) -> Result<()> {
    let mut br = crate::courierust_io::BufReader::new(stream, 24);
    let mut preface = [0u8; 24];
    br.read_exact_into(&mut preface)?;
    if !crate::courierust_h2::connection::is_preface(&preface) {
        return Err(Error::protocol("invalid h2 client preface"));
    }
    Ok(())
}

/// A short read timeout lets the serve loop wake to flush deferred
/// (channel) response bodies even while the peer is silent
fn configure_read_timeout(stream: &ConnStream) {
    let _ = stream.configure(Some(std::time::Duration::from_millis(250)));
}

const STREAMING_READ_TIMEOUT: std::time::Duration = std::time::Duration::from_millis(5);
const QUIET_READ_TIMEOUT: std::time::Duration = std::time::Duration::from_millis(250);

/// Serve HTTP/2 requests on `stream` (client preface already verified via
/// peek or ALPN; consumed here).
pub(crate) fn serve(
    stream: &ConnStream,
    handler: &dyn Handler,
    config: &ServerConfig,
) -> Result<()> {
    read_preface(stream)?;
    configure_read_timeout(stream);
    let mut conn = Connection::new(stream, stream, server_config(config));
    let mut req_bodies: HashMap<u32, RequestBuilder> = HashMap::new();
    let mut deferred: HashMap<u32, Deferred> = HashMap::new();
    serve_loop(
        &mut conn,
        stream,
        handler,
        config,
        &mut req_bodies,
        &mut deferred,
    )
}

/// Serve the HTTP/2 side of an RFC 7540 §3.2 `h2c` Upgrade.
pub(crate) fn serve_upgraded(
    stream: &ConnStream,
    handler: &dyn Handler,
    config: &ServerConfig,
    resp: Response<Body>,
) -> Result<()> {
    read_preface(stream)?;
    configure_read_timeout(stream);
    let mut conn = Connection::new(stream, stream, server_config(config));
    conn.register_upgrade_stream()?;
    let mut req_bodies: HashMap<u32, RequestBuilder> = HashMap::new();
    let mut deferred: HashMap<u32, Deferred> = HashMap::new();
    send_response(&mut conn, 1, resp, &mut deferred)?;
    serve_loop(
        &mut conn,
        stream,
        handler,
        config,
        &mut req_bodies,
        &mut deferred,
    )
}

/// The shared h2 event loop
fn serve_loop(
    conn: &mut Connection<&ConnStream, &ConnStream>,
    stream: &ConnStream,
    handler: &dyn Handler,
    config: &ServerConfig,
    req_bodies: &mut HashMap<u32, RequestBuilder>,
    deferred: &mut HashMap<u32, Deferred>,
) -> Result<()> {
    let mut peer_goaway = false;

    let started = std::time::Instant::now();
    let mut last_rx = started;
    let mut last_ping: Option<std::time::Instant> = None;
    let mut streaming = false;

    loop {
        let want_streaming = !deferred.is_empty();
        if want_streaming != streaming {
            let _ = stream.configure(Some(if want_streaming {
                STREAMING_READ_TIMEOUT
            } else {
                QUIET_READ_TIMEOUT
            }));
            streaming = want_streaming;
        }
        if want_streaming {
            let _ = conn.flush();
            flush_deferred(conn, deferred)?;
        }

        match conn.poll_available(64) {
            Ok(true) => last_rx = std::time::Instant::now(),
            Ok(false) => {}
            Err(e) => return Err(e),
        }

        while let Some(ev) = conn.next_event() {
            match ev {
                Event::Headers {
                    stream_id,
                    headers,
                    end_stream,
                    ..
                } => {
                    if end_stream {
                        let resp = handler.handle(build_request(&headers, Body::Empty)?);
                        send_response(conn, stream_id, resp, deferred)?;
                    } else {
                        req_bodies.insert(
                            stream_id,
                            RequestBuilder {
                                headers,
                                body: Vec::new(),
                            },
                        );
                    }
                }
                Event::Data {
                    stream_id,
                    data,
                    end_stream,
                } => {
                    if let Some(rb) = req_bodies.get_mut(&stream_id) {
                        rb.body.extend_from_slice(&data);
                        if rb.body.len() > config.max_body {
                            conn.send_rst(stream_id, ErrorCode::EnhanceYourCalm);
                            req_bodies.remove(&stream_id);
                            continue;
                        }
                        if end_stream {
                            if let Some(rb) = req_bodies.remove(&stream_id) {
                                let body = if rb.body.is_empty() {
                                    Body::Empty
                                } else {
                                    Body::Bytes(Bytes::from(rb.body))
                                };
                                let resp = handler.handle(build_request(&rb.headers, body)?);
                                send_response(conn, stream_id, resp, deferred)?;
                            }
                        }
                    }
                }
                Event::Rst { stream_id, .. } => {
                    req_bodies.remove(&stream_id);
                    deferred.remove(&stream_id);
                }
                Event::StreamError { stream_id, .. } => {
                    req_bodies.remove(&stream_id);
                    deferred.remove(&stream_id);
                }
                Event::GoAway { .. } => {
                    peer_goaway = true;
                }
                _ => {}
            }
        }

        if conn.is_closed() {
            break;
        }
        if !apply_liveness(
            conn,
            config,
            started,
            &mut last_rx,
            &mut last_ping,
            !req_bodies.is_empty() || !deferred.is_empty(),
        ) {
            break;
        }
        if peer_goaway && req_bodies.is_empty() && deferred.is_empty() {
            break;
        }
    }
    Ok(())
}

/// Apply connection liveness policies between polls (server side):
///
/// 1. **SETTINGS_TIMEOUT** — if the peer never ACKs our SETTINGS within
///    [`ServerConfig::h2_settings_timeout`], drop the connection.
/// 2. **Idle reaping** — a connection with no in-flight requests that has
///    seen no inbound traffic for [`ServerConfig::h2_idle_timeout`] is
///    closed, releasing the worker thread it occupied (so a pile of idle
///    h2 keep-alive connections cannot exhaust the pool).
/// 3. **Keepalive PING** — after [`ServerConfig::h2_ping_interval`] of
///    inbound silence a PING is sent; if no frame at all arrives within
///    [`ServerConfig::h2_ping_timeout`] the peer is presumed dead.
///
/// Returns `false` when the serve loop should exit.
fn apply_liveness(
    conn: &mut Connection<&ConnStream, &ConnStream>,
    config: &ServerConfig,
    started: std::time::Instant,
    last_rx: &mut std::time::Instant,
    last_ping: &mut Option<std::time::Instant>,
    has_work: bool,
) -> bool {
    let now = std::time::Instant::now();

    if let Some(t) = config.h2_settings_timeout {
        if conn.settings_ack_pending() && now.duration_since(started) >= t {
            conn.send_goaway(ErrorCode::SettingsTimeout, b"peer did not ACK SETTINGS");
            return false;
        }
    }

    if !has_work {
        if let Some(t) = config.h2_idle_timeout {
            if now.duration_since(*last_rx) >= t {
                conn.send_goaway(ErrorCode::NoError, b"idle timeout");
                return false;
            }
        }
    }

    if let Some(interval) = config.h2_ping_interval {
        if now.duration_since(*last_rx) >= interval {
            match *last_ping {
                None => {
                    let nanos = now.duration_since(started).as_nanos() as u64;
                    conn.send_ping(nanos.to_be_bytes());
                    *last_ping = Some(now);
                }
                Some(sent) => {
                    if *last_rx < sent {
                        if let Some(pt) = config.h2_ping_timeout {
                            if now.duration_since(sent) >= pt {
                                return false;
                            }
                        }
                    } else {
                        *last_ping = None;
                    }
                }
            }
        } else {
            *last_ping = None;
        }
    }
    true
}

fn server_config(config: &ServerConfig) -> H2Config {
    let mut c = H2Config {
        client: false,
        auto_release_credit: config.auto_release_credit,
        ..Default::default()
    };
    c.local_settings.max_header_list_size = config.max_header_list as u32;
    c.local_settings.max_concurrent_streams = config.h2_max_concurrent_streams;
    if c.local_settings.initial_window_size < 256 * 1024 {
        c.local_settings.initial_window_size = 256 * 1024;
    }
    c
}

/// A request head waiting for its body.
struct RequestBuilder {
    headers: Vec<HeaderField>,
    body: Vec<u8>,
}

/// Convert an h2 header block into a request.
pub fn build_request(headers: &[HeaderField], body: Body) -> Result<Request<Body>> {
    let mut method: Option<crate::courierust_bytes::Bytes> = None;
    let mut uri: Option<crate::courierust_bytes::Bytes> = None;
    let mut authority: Option<crate::courierust_bytes::Bytes> = None;
    let mut map = HeaderMap::new();
    for f in headers {
        match f.name.as_str() {
            ":method" => method = Some(Bytes::from(f.value.as_bytes())),
            ":path" => uri = Some(Bytes::from(f.value.as_bytes())),
            ":authority" => authority = Some(Bytes::from(f.value.as_bytes())),
            _ => {
                if !f.name.is_pseudo() {
                    map.append(f.name.clone(), f.value.clone());
                }
            }
        }
    }
    let method = method.ok_or_else(|| Error::protocol("request missing :method"))?;
    let method = crate::courierust_http::method::Method::from_bytes(method.as_slice())?;
    let uri = uri.ok_or_else(|| Error::protocol("request missing :path"))?;
    let uri = crate::courierust_http::uri::PathAndQuery::from_bytes(uri.as_slice())?;
    if let Some(a) = authority {
        if !map.contains_key("host") {
            map.insert(
                HeaderName::from_lowercase("host"),
                HeaderValue::from_bytes(a.as_slice())?,
            );
        }
    }
    Ok(Request {
        method,
        uri,
        version: Version::HTTP_2,
        headers: map,
        body,
    })
}

/// Convert a response into HPACK fields and send it.
fn send_response(
    conn: &mut Connection<&ConnStream, &ConnStream>,
    sid: u32,
    resp: Response<Body>,
    deferred: &mut HashMap<u32, Deferred>,
) -> Result<()> {
    let fields = response_fields(&resp);
    let trailers = resp.trailers.as_ref().map(trailer_fields);
    enum K {
        Empty,
        Bytes(Bytes),
        Channel(Receiver<Result<Bytes>>),
    }
    let kind = match resp.body {
        Body::Empty => K::Empty,
        Body::Bytes(b) if b.is_empty() => K::Empty,
        Body::Bytes(b) => K::Bytes(b),
        Body::Channel(rx) => K::Channel(rx),
    };
    let has_trailers = trailers.is_some();
    match kind {
        K::Empty => {
            conn.send_headers(sid, &fields, !has_trailers)?;
            if let Some(t) = trailers {
                conn.send_trailers(sid, &t)?;
            }
        }
        K::Bytes(b) => {
            conn.send_headers(sid, &fields, false)?;
            conn.send_data(sid, b, !has_trailers)?;
            if let Some(t) = trailers {
                conn.send_trailers(sid, &t)?;
            }
        }
        K::Channel(rx) => {
            conn.send_headers(sid, &fields, false)?;
            deferred.insert(
                sid,
                Deferred {
                    rx,
                    ending: false,
                    trailers,
                },
            );
        }
    }
    Ok(())
}

/// Convert a trailer header map into HPACK fields (pseudo-headers are
/// never legal in trailers and are dropped defensively).
fn trailer_fields(t: &crate::courierust_http::header::HeaderMap) -> Vec<HeaderField> {
    let mut fields = Vec::with_capacity(t.len());
    for (n, v) in t.iter() {
        if !n.is_pseudo() {
            fields.push(HeaderField::new(n.clone(), v.clone()));
        }
    }
    fields
}

/// Build the HPACK response block.
pub fn response_fields(resp: &Response<Body>) -> Vec<HeaderField> {
    let mut fields = Vec::with_capacity(resp.headers.len() + 2);
    fields.push(HeaderField::new(
        HeaderName::from_lowercase(":status"),
        HeaderValue::from_bytes(resp.status.as_u16().to_string().as_bytes())
            .unwrap_or_else(|_| HeaderValue::from_static("200")),
    ));
    for (n, v) in resp.headers.iter() {
        if !n.is_pseudo() {
            fields.push(HeaderField::new(n.clone(), v.clone()));
        }
    }
    fields
}

/// Drain deferred (channel) bodies into the connection as room allows.
fn flush_deferred(
    conn: &mut Connection<&ConnStream, &ConnStream>,
    deferred: &mut HashMap<u32, Deferred>,
) -> Result<()> {
    let mut done: Vec<u32> = Vec::new();
    for (sid, d) in deferred.iter_mut() {
        loop {
            if d.ending {
                let res = match &d.trailers {
                    Some(t) => conn.send_trailers(*sid, t),
                    None => conn.send_data(*sid, Bytes::new(), true).map(|_| ()),
                };
                match res {
                    Ok(_) => {
                        done.push(*sid);
                        break;
                    }
                    Err(_) => break, // buffer full; retry later
                }
            }
            match d.rx.try_recv() {
                Ok(Ok(b)) if !b.is_empty() => match conn.send_data(*sid, b, false) {
                    Ok(_) => continue,
                    Err(_) => break,
                },
                Ok(Err(_e)) => {
                    conn.send_rst(*sid, ErrorCode::InternalError);
                    done.push(*sid);
                    break;
                }
                Ok(Ok(_)) => continue,
                Err(TryRecvError::Empty) => break,
                Err(TryRecvError::Disconnected) => {
                    d.ending = true;
                    continue;
                }
            }
        }
    }
    for sid in done {
        deferred.remove(&sid);
    }
    Ok(())
}