eggfetch-ffi 0.4.0

Stable C ABI bindings for the eggfetch-core HTTP engine
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
#![allow(
    missing_docs,
    dead_code,
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::too_many_lines
)]

//! Fail-closed behavior for FFI HTTP-version policies the linked build
//! cannot honor.
//!
//! `eggfetch_client_builder_http_version` exposes a user-facing protocol
//! control. A strict policy that needs a capability the linked library does
//! not have must be rejected before any connection is attempted, with an
//! error that names the missing capability. `Auto` is not strict: it
//! negotiates down to the protocols the build has and stays accepted.
//!
//! The published policy values are `0` (`Http1Only`), `1` (`Http2Only`),
//! `2` (`Auto` without HTTP/3), `3` (`Auto` with HTTP/3), and `4`
//! (`Http3Only`). Values `1` and `4` are strict, so each one names the
//! capability the build lacks and fails closed; `Auto` is not strict and
//! never fails closed.
//!
//! Neither `http2` nor `http3` is in the FFI crate's default feature set,
//! so a default build rejects both strict values. That is the fail-closed
//! contract: a consumer that needs HTTP/2 or HTTP/3 builds `eggfetch-ffi`
//! with the matching feature. The strict HTTP/2 rejection is observable at
//! the ABI boundary below; the strict HTTP/3 rejection is asserted against
//! the same ABI surface.

use std::ffi::CString;
use std::io::{Read, Write};
use std::net::{TcpListener, TcpStream};
use std::os::raw::c_char;
use std::ptr;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::sync::Arc;
use std::thread::{self, JoinHandle};
use std::time::Duration;

/// Wording the capability failure must not reuse.
const GENERIC_MARKER: &str = "HTTP client not available";

/// A local HTTP/1.1 server that counts accepted connections.
struct CountingServer {
    port: u16,
    accepted: Arc<AtomicUsize>,
    shutdown: Arc<AtomicBool>,
    handle: Option<JoinHandle<()>>,
}

impl CountingServer {
    fn start() -> Self {
        let listener = TcpListener::bind("127.0.0.1:0").expect("failed to bind");
        listener
            .set_nonblocking(true)
            .expect("failed to set nonblocking");
        let port = listener.local_addr().expect("local addr").port();
        let shutdown = Arc::new(AtomicBool::new(false));
        let accepted = Arc::new(AtomicUsize::new(0));

        let sd = shutdown.clone();
        let ac = accepted.clone();
        let handle = thread::spawn(move || {
            while !sd.load(Ordering::Relaxed) {
                match listener.accept() {
                    Ok((mut stream, _)) => {
                        ac.fetch_add(1, Ordering::SeqCst);
                        thread::spawn(move || {
                            // Read until the request head is complete. A single
                            // read() can return a partial head, and it can time
                            // out before the client has written anything at all;
                            // answering in either case fabricates a response for
                            // a request the server never received, which the
                            // caller then observes as a failed send rather than
                            // as the protocol decision under test.
                            // The listener is non-blocking, and macOS
                            // accepts sockets with O_NONBLOCK inherited, so a
                            // read here can fail with WouldBlock before the
                            // client has written anything. Block explicitly so
                            // the head read waits for the request instead of
                            // racing it. This is a no-op on platforms whose
                            // accept() returns blocking sockets.
                            let _ = stream.set_nonblocking(false);
                            let _ = stream.set_read_timeout(Some(Duration::from_secs(5)));
                            let mut head = Vec::new();
                            let mut buffer = [0_u8; 1024];
                            loop {
                                match stream.read(&mut buffer) {
                                    Ok(0) => break,
                                    Ok(read) => {
                                        head.extend_from_slice(&buffer[..read]);
                                        if head.windows(4).any(|window| window == b"\r\n\r\n") {
                                            break;
                                        }
                                    }
                                    // A retried read is the only error worth
                                    // continuing for; anything else (including
                                    // the timeout) means no usable head.
                                    Err(ref error)
                                        if error.kind() == std::io::ErrorKind::Interrupted => {}
                                    Err(_) => break,
                                }
                            }
                            if head.windows(4).any(|window| window == b"\r\n\r\n") {
                                let _ = stream
                                    .write_all(b"HTTP/1.1 200 OK\r\nContent-Length: 2\r\n\r\nok");
                            }
                        });
                    }
                    Err(ref error) if error.kind() == std::io::ErrorKind::WouldBlock => {
                        thread::sleep(Duration::from_millis(10));
                    }
                    Err(_) => break,
                }
            }
        });

        Self {
            port,
            accepted,
            shutdown,
            handle: Some(handle),
        }
    }

    fn url(&self) -> String {
        format!("http://127.0.0.1:{}/", self.port)
    }

    fn accepted_connections(&self) -> usize {
        self.accepted.load(Ordering::SeqCst)
    }
}

impl Drop for CountingServer {
    fn drop(&mut self) {
        self.shutdown.store(true, Ordering::Relaxed);
        let _ = TcpStream::connect(("127.0.0.1", self.port));
        if let Some(handle) = self.handle.take() {
            let _ = handle.join();
        }
    }
}

/// Copy a C string out of the FFI and release it.
fn take_string(pointer: *mut c_char) -> String {
    assert!(!pointer.is_null(), "the FFI returned a null string");
    unsafe {
        let value = std::ffi::CStr::from_ptr(pointer)
            .to_string_lossy()
            .into_owned();
        eggfetch_ffi::eggfetch_string_free(pointer);
        value
    }
}

/// Send a request built from `url` and return the error message, if any.
fn send_and_read_error(client: *mut eggfetch_ffi::ClientHandle, url: &str) -> String {
    let url = CString::new(url).expect("url");
    unsafe {
        let request = eggfetch_ffi::eggfetch_client_get(client, url.as_ptr());
        assert!(!request.is_null(), "the request handle must be created");
        let mut err: *mut eggfetch_ffi::ErrorHandle = ptr::null_mut();
        let response = eggfetch_ffi::eggfetch_client_send(client, request, &raw mut err);
        assert!(response.is_null(), "the request must be rejected");
        assert!(!err.is_null(), "the rejection must report an error");
        let kind = take_string(eggfetch_ffi::eggfetch_error_kind(err));
        assert_eq!(kind, "unsupported", "the rejection must be unsupported");
        let message = take_string(eggfetch_ffi::eggfetch_error_message(err));
        eggfetch_ffi::eggfetch_error_free(err);
        message
    }
}

#[test]
#[cfg(not(feature = "http2"))]
fn strict_http2_policy_is_rejected_and_names_http2() {
    let server = CountingServer::start();
    unsafe {
        let builder = eggfetch_ffi::eggfetch_client_builder_new();
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 1),
            0
        );
        let client = eggfetch_ffi::eggfetch_client_builder_build(builder);
        assert!(!client.is_null());
        eggfetch_ffi::eggfetch_client_builder_free(builder);

        let message = send_and_read_error(client, &server.url());
        assert!(message.contains("HTTP/2"), "{message}");
        assert!(!message.contains(GENERIC_MARKER), "{message}");
        eggfetch_ffi::eggfetch_client_free(client);
    }
    assert_eq!(
        server.accepted_connections(),
        0,
        "a rejected protocol request must not open a connection"
    );
}

#[test]
#[cfg(not(feature = "http3"))]
fn auto_with_http3_is_accepted_without_the_http3_capability() {
    // `Auto` is not a strict request: value 3 is `Auto { allow_http3: true }`
    // and must keep negotiating down to the protocols this build has.
    let server = CountingServer::start();
    unsafe {
        let builder = eggfetch_ffi::eggfetch_client_builder_new();
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 3),
            0
        );
        let client = eggfetch_ffi::eggfetch_client_builder_build(builder);
        assert!(!client.is_null());
        eggfetch_ffi::eggfetch_client_builder_free(builder);

        let url = CString::new(server.url()).expect("url");
        let request = eggfetch_ffi::eggfetch_client_get(client, url.as_ptr());
        assert!(!request.is_null());
        let mut err: *mut eggfetch_ffi::ErrorHandle = ptr::null_mut();
        let response = eggfetch_ffi::eggfetch_client_send(client, request, &raw mut err);
        assert!(!response.is_null(), "auto negotiation must not fail");
        assert_eq!(eggfetch_ffi::eggfetch_response_status(response), 200);
        eggfetch_ffi::eggfetch_response_free(response);
        eggfetch_ffi::eggfetch_client_free(client);
    }
}

#[test]
fn auto_policy_is_accepted_and_the_request_succeeds() {
    let server = CountingServer::start();
    unsafe {
        let builder = eggfetch_ffi::eggfetch_client_builder_new();
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 2),
            0
        );
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 3),
            0
        );
        let client = eggfetch_ffi::eggfetch_client_builder_build(builder);
        assert!(!client.is_null());
        eggfetch_ffi::eggfetch_client_builder_free(builder);

        let url = CString::new(server.url()).expect("url");
        let request = eggfetch_ffi::eggfetch_client_get(client, url.as_ptr());
        assert!(!request.is_null());
        let mut err: *mut eggfetch_ffi::ErrorHandle = ptr::null_mut();
        let response = eggfetch_ffi::eggfetch_client_send(client, request, &raw mut err);
        assert!(!response.is_null(), "auto negotiation must not fail");
        assert_eq!(eggfetch_ffi::eggfetch_response_status(response), 200);
        eggfetch_ffi::eggfetch_response_free(response);
        eggfetch_ffi::eggfetch_client_free(client);
    }
}

#[test]
fn http1_policy_is_accepted_and_the_request_succeeds() {
    let server = CountingServer::start();
    unsafe {
        let builder = eggfetch_ffi::eggfetch_client_builder_new();
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 0),
            0
        );
        let client = eggfetch_ffi::eggfetch_client_builder_build(builder);
        assert!(!client.is_null());
        eggfetch_ffi::eggfetch_client_builder_free(builder);

        let url = CString::new(server.url()).expect("url");
        let request = eggfetch_ffi::eggfetch_client_get(client, url.as_ptr());
        assert!(!request.is_null());
        let mut err: *mut eggfetch_ffi::ErrorHandle = ptr::null_mut();
        let response = eggfetch_ffi::eggfetch_client_send(client, request, &raw mut err);
        assert!(!response.is_null(), "HTTP/1.1 must not fail");
        eggfetch_ffi::eggfetch_response_free(response);
        eggfetch_ffi::eggfetch_client_free(client);
    }
}

#[test]
#[cfg(not(feature = "http3"))]
fn strict_http3_policy_is_rejected_and_names_http3() {
    // Value `4` is `Http3Only`: a strict request that needs the `http3`
    // capability this build does not have. The ABI accepts the value; the
    // request fails closed and names the missing capability.
    let server = CountingServer::start();
    unsafe {
        let builder = eggfetch_ffi::eggfetch_client_builder_new();
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 4),
            0
        );
        let client = eggfetch_ffi::eggfetch_client_builder_build(builder);
        assert!(!client.is_null());
        eggfetch_ffi::eggfetch_client_builder_free(builder);

        let message = send_and_read_error(client, &server.url());
        assert!(message.contains("HTTP/3"), "{message}");
        assert!(!message.contains(GENERIC_MARKER), "{message}");
        eggfetch_ffi::eggfetch_client_free(client);
    }
    assert_eq!(
        server.accepted_connections(),
        0,
        "a rejected protocol request must not open a connection"
    );
}

#[test]
#[cfg(feature = "http3")]
fn strict_http3_policy_is_not_rejected_with_the_capability() {
    // With the `http3` feature compiled in, the same ABI value must not be
    // rejected by the capability guard.
    let server = CountingServer::start();
    unsafe {
        let builder = eggfetch_ffi::eggfetch_client_builder_new();
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 4),
            0
        );
        let client = eggfetch_ffi::eggfetch_client_builder_build(builder);
        assert!(!client.is_null());
        eggfetch_ffi::eggfetch_client_builder_free(builder);

        let url = CString::new(server.url()).expect("url");
        let request = eggfetch_ffi::eggfetch_client_get(client, url.as_ptr());
        assert!(!request.is_null());
        let mut err: *mut eggfetch_ffi::ErrorHandle = ptr::null_mut();
        let response = eggfetch_ffi::eggfetch_client_send(client, request, &raw mut err);
        if response.is_null() {
            let message = take_string(eggfetch_ffi::eggfetch_error_message(err));
            eggfetch_ffi::eggfetch_error_free(err);
            assert!(
                !message.contains("is not supported by this build"),
                "the capability guard must not reject HTTP/3: {message}"
            );
            assert!(!message.contains(GENERIC_MARKER), "{message}");
        } else {
            eggfetch_ffi::eggfetch_response_free(response);
        }
        eggfetch_ffi::eggfetch_client_free(client);
    }
}

#[test]
fn unknown_policy_value_is_rejected() {
    // The published value set is `0..=4`. Anything above it is unknown and
    // must still fail at the ABI boundary rather than silently defaulting.
    unsafe {
        let builder = eggfetch_ffi::eggfetch_client_builder_new();
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 5),
            -1
        );
        eggfetch_ffi::eggfetch_client_builder_free(builder);
    }
}

#[test]
fn default_policy_is_unchanged() {
    let server = CountingServer::start();
    unsafe {
        let client = eggfetch_ffi::eggfetch_client_new();
        assert!(!client.is_null());
        let url = CString::new(server.url()).expect("url");
        let request = eggfetch_ffi::eggfetch_client_get(client, url.as_ptr());
        assert!(!request.is_null());
        let mut err: *mut eggfetch_ffi::ErrorHandle = ptr::null_mut();
        let response = eggfetch_ffi::eggfetch_client_send(client, request, &raw mut err);
        assert!(!response.is_null(), "the default policy must keep working");
        eggfetch_ffi::eggfetch_response_free(response);
        eggfetch_ffi::eggfetch_client_free(client);
    }
}

#[test]
#[cfg(feature = "http2")]
fn strict_http2_policy_is_honored_with_the_capability() {
    let server = CountingServer::start();
    unsafe {
        let builder = eggfetch_ffi::eggfetch_client_builder_new();
        assert_eq!(eggfetch_ffi::eggfetch_client_builder_timeout(builder, 5), 0);
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 1),
            0
        );
        let client = eggfetch_ffi::eggfetch_client_builder_build(builder);
        assert!(!client.is_null());
        eggfetch_ffi::eggfetch_client_builder_free(builder);

        let url = CString::new(server.url()).expect("url");
        let request = eggfetch_ffi::eggfetch_client_get(client, url.as_ptr());
        assert!(!request.is_null());
        let mut err: *mut eggfetch_ffi::ErrorHandle = ptr::null_mut();
        let response = eggfetch_ffi::eggfetch_client_send(client, request, &raw mut err);
        if response.is_null() {
            // The fixture speaks HTTP/1.1, so an HTTP/2-only request still
            // fails — but never with the capability rejection.
            let message = take_string(eggfetch_ffi::eggfetch_error_message(err));
            eggfetch_ffi::eggfetch_error_free(err);
            assert!(
                !message.contains("is not supported by this build"),
                "the capability guard must not reject HTTP/2: {message}"
            );
            assert!(!message.contains(GENERIC_MARKER), "{message}");
        } else {
            eggfetch_ffi::eggfetch_response_free(response);
        }
        eggfetch_ffi::eggfetch_client_free(client);
    }
    assert_eq!(
        server.accepted_connections(),
        1,
        "the request must be attempted when the capability is compiled in"
    );
}

#[test]
#[cfg(feature = "http3")]
fn auto_with_http3_is_accepted_with_the_capability() {
    let server = CountingServer::start();
    unsafe {
        let builder = eggfetch_ffi::eggfetch_client_builder_new();
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_connect_timeout(builder, 2),
            0
        );
        assert_eq!(
            eggfetch_ffi::eggfetch_client_builder_http_version(builder, 3),
            0
        );
        let client = eggfetch_ffi::eggfetch_client_builder_build(builder);
        assert!(!client.is_null());
        eggfetch_ffi::eggfetch_client_builder_free(builder);

        let url = CString::new(server.url()).expect("url");
        let request = eggfetch_ffi::eggfetch_client_get(client, url.as_ptr());
        assert!(!request.is_null());
        let mut err: *mut eggfetch_ffi::ErrorHandle = ptr::null_mut();
        let response = eggfetch_ffi::eggfetch_client_send(client, request, &raw mut err);
        if response.is_null() {
            let message = take_string(eggfetch_ffi::eggfetch_error_message(err));
            eggfetch_ffi::eggfetch_error_free(err);
            assert!(
                !message.contains("is not supported by this build"),
                "the capability guard must not reject an accepted policy: {message}"
            );
        } else {
            eggfetch_ffi::eggfetch_response_free(response);
        }
        eggfetch_ffi::eggfetch_client_free(client);
    }
}