mockforge-http 0.3.107

HTTP/REST protocol support for MockForge
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
//! TLS/HTTPS support for HTTP server
//!
//! This module provides TLS configuration and certificate loading for secure HTTP connections.

use mockforge_core::config::HttpTlsConfig;
use mockforge_core::Result;
use std::sync::Arc;
use std::sync::Once;
use tokio_rustls::TlsAcceptor;
use tracing::info;

static CRYPTO_INIT: Once = Once::new();

/// Initialize the rustls crypto provider.
///
/// This must be called before any TLS operations. It is safe to call multiple times
/// as it uses `Once` to ensure initialization happens exactly once.
///
/// Uses the `ring` crypto provider for rustls.
pub fn init_crypto_provider() {
    CRYPTO_INIT.call_once(|| {
        // Install the ring crypto provider as the default for rustls
        let _ = rustls::crypto::ring::default_provider().install_default();
    });
}

/// Create a rustls ServerConfig builder with the appropriate TLS protocol versions.
///
/// When `tls13_only` is true, restricts to TLS 1.3 only. Otherwise uses safe defaults (TLS 1.2+).
fn tls_config_builder(
    tls13_only: bool,
) -> rustls::ConfigBuilder<rustls::server::ServerConfig, rustls::WantsVerifier> {
    if tls13_only {
        rustls::server::ServerConfig::builder_with_protocol_versions(&[&rustls::version::TLS13])
    } else {
        rustls::server::ServerConfig::builder()
    }
}

/// Determine if TLS 1.3 only mode is requested from configuration.
fn is_tls13_only(min_version: &str) -> bool {
    match min_version {
        "1.3" => {
            info!("Enforcing TLS 1.3 only (min_version=1.3)");
            true
        }
        "1.2" | "" => false,
        other => {
            tracing::warn!("Unsupported TLS min_version '{}', using defaults (TLS 1.2+)", other);
            false
        }
    }
}

/// Load TLS acceptor from certificate and key files
///
/// This function loads server certificates and private keys from PEM files
/// and creates a TLS acceptor for use with the HTTP server.
///
/// For mutual TLS (mTLS), provide a CA certificate file via `ca_file`.
pub fn load_tls_acceptor(config: &HttpTlsConfig) -> Result<TlsAcceptor> {
    use rustls_pemfile::{certs, pkcs8_private_keys};
    use std::fs::File;
    use std::io::BufReader;

    // Ensure crypto provider is initialized
    init_crypto_provider();

    info!(
        "Loading TLS certificate from {} and key from {}",
        config.cert_file, config.key_file
    );

    // Load certificate chain
    let cert_file = File::open(&config.cert_file).map_err(|e| {
        mockforge_core::Error::internal(format!(
            "Failed to open certificate file {}: {}",
            config.cert_file, e
        ))
    })?;
    let mut cert_reader = BufReader::new(cert_file);
    let server_certs: Vec<rustls::pki_types::CertificateDer<'static>> = certs(&mut cert_reader)
        .collect::<std::result::Result<Vec<_>, _>>()
        .map_err(|e| {
            mockforge_core::Error::internal(format!(
                "Failed to parse certificate file {}: {}",
                config.cert_file, e
            ))
        })?;

    if server_certs.is_empty() {
        return Err(mockforge_core::Error::internal(format!(
            "No certificates found in {}",
            config.cert_file
        )));
    }

    // Load private key
    let key_file = File::open(&config.key_file).map_err(|e| {
        mockforge_core::Error::internal(format!(
            "Failed to open private key file {}: {}",
            config.key_file, e
        ))
    })?;
    let mut key_reader = BufReader::new(key_file);
    let pkcs8_keys: Vec<rustls::pki_types::PrivatePkcs8KeyDer<'static>> =
        pkcs8_private_keys(&mut key_reader)
            .collect::<std::result::Result<Vec<_>, _>>()
            .map_err(|e| {
                mockforge_core::Error::internal(format!(
                    "Failed to parse private key file {}: {}",
                    config.key_file, e
                ))
            })?;
    let mut keys: Vec<rustls::pki_types::PrivateKeyDer<'static>> =
        pkcs8_keys.into_iter().map(rustls::pki_types::PrivateKeyDer::Pkcs8).collect();

    if keys.is_empty() {
        return Err(mockforge_core::Error::internal(format!(
            "No private keys found in {}",
            config.key_file
        )));
    }

    // Build TLS server configuration with version support
    // Note: rustls uses safe defaults, so we configure during builder creation
    // Determine mTLS mode: use mtls_mode if set, otherwise fall back to require_client_cert for backward compatibility
    let mtls_mode = if !config.mtls_mode.is_empty() && config.mtls_mode != "off" {
        config.mtls_mode.as_str()
    } else if config.require_client_cert {
        "required"
    } else {
        "off"
    };

    // Determine TLS protocol versions based on min_version config
    let tls13_only = is_tls13_only(&config.min_version);

    let server_config = match mtls_mode {
        "required" => {
            // Mutual TLS: require client certificates
            if let Some(ref ca_file_path) = config.ca_file {
                // Load CA certificate for client verification
                let ca_file = File::open(ca_file_path).map_err(|e| {
                    mockforge_core::Error::internal(format!(
                        "Failed to open CA certificate file {}: {}",
                        ca_file_path, e
                    ))
                })?;
                let mut ca_reader = BufReader::new(ca_file);
                let ca_certs: Vec<rustls::pki_types::CertificateDer<'static>> =
                    certs(&mut ca_reader).collect::<std::result::Result<Vec<_>, _>>().map_err(
                        |e| {
                            mockforge_core::Error::internal(format!(
                                "Failed to parse CA certificate file {}: {}",
                                ca_file_path, e
                            ))
                        },
                    )?;

                let mut root_store = rustls::RootCertStore::empty();
                for cert in &ca_certs {
                    root_store.add(cert.clone()).map_err(|e| {
                        mockforge_core::Error::internal(format!(
                            "Failed to add CA certificate to root store: {}",
                            e
                        ))
                    })?;
                }

                let client_verifier =
                    rustls::server::WebPkiClientVerifier::builder(Arc::new(root_store))
                        .build()
                        .map_err(|e| {
                            mockforge_core::Error::internal(format!(
                                "Failed to build client verifier: {}",
                                e
                            ))
                        })?;

                let key = keys.remove(0);

                // Build with mTLS support (required)
                tls_config_builder(tls13_only)
                    .with_client_cert_verifier(client_verifier)
                    .with_single_cert(server_certs, key)
                    .map_err(|e| {
                        mockforge_core::Error::internal(format!(
                            "TLS config error (mTLS required): {}",
                            e
                        ))
                    })?
            } else {
                return Err(mockforge_core::Error::internal(
                    "mTLS mode 'required' requires --tls-ca (CA certificate file)",
                ));
            }
        }
        "optional" => {
            // Mutual TLS: accept client certificates if provided, but don't require
            if let Some(ref ca_file_path) = config.ca_file {
                // Load CA certificate for client verification
                let ca_file = File::open(ca_file_path).map_err(|e| {
                    mockforge_core::Error::internal(format!(
                        "Failed to open CA certificate file {}: {}",
                        ca_file_path, e
                    ))
                })?;
                let mut ca_reader = BufReader::new(ca_file);
                let ca_certs: Vec<rustls::pki_types::CertificateDer<'static>> =
                    certs(&mut ca_reader).collect::<std::result::Result<Vec<_>, _>>().map_err(
                        |e| {
                            mockforge_core::Error::internal(format!(
                                "Failed to parse CA certificate file {}: {}",
                                ca_file_path, e
                            ))
                        },
                    )?;

                let mut root_store = rustls::RootCertStore::empty();
                for cert in &ca_certs {
                    root_store.add(cert.clone()).map_err(|e| {
                        mockforge_core::Error::internal(format!(
                            "Failed to add CA certificate to root store: {}",
                            e
                        ))
                    })?;
                }

                let client_verifier =
                    rustls::server::WebPkiClientVerifier::builder(Arc::new(root_store))
                        .build()
                        .map_err(|e| {
                            mockforge_core::Error::internal(format!(
                                "Failed to build client verifier: {}",
                                e
                            ))
                        })?;

                let key = keys.remove(0);

                // Build with optional mTLS support
                // Note: rustls doesn't have a built-in "optional" mode, so we use
                // WebPkiClientVerifier which accepts any client cert that validates,
                // but connections without certs will also work (we can't enforce optional-only)
                // For true optional mTLS, we'd need custom verifier logic
                tls_config_builder(tls13_only)
                    .with_client_cert_verifier(client_verifier)
                    .with_single_cert(server_certs, key)
                    .map_err(|e| {
                        mockforge_core::Error::internal(format!(
                            "TLS config error (mTLS optional): {}",
                            e
                        ))
                    })?
            } else {
                // Optional mTLS without CA: just standard TLS
                info!("mTLS optional mode specified but no CA file provided, using standard TLS");
                let key = keys.remove(0);
                tls_config_builder(tls13_only)
                    .with_no_client_auth()
                    .with_single_cert(server_certs, key)
                    .map_err(|e| {
                        mockforge_core::Error::internal(format!("TLS config error: {}", e))
                    })?
            }
        }
        _ => {
            // Standard TLS: no client certificate required
            let key = keys.remove(0);
            tls_config_builder(tls13_only)
                .with_no_client_auth()
                .with_single_cert(server_certs, key)
                .map_err(|e| mockforge_core::Error::internal(format!("TLS config error: {}", e)))?
        }
    };

    // Log cipher suite configuration (cipher suites are controlled by rustls's
    // safe defaults and not overridable without also selecting specific crypto providers)
    if !config.cipher_suites.is_empty() {
        info!(
            "Custom cipher suites specified: {:?}. Note: rustls enforces safe cipher suites; \
             for fine-grained control, configure the rustls CryptoProvider.",
            config.cipher_suites
        );
    }

    info!("TLS acceptor configured successfully");
    Ok(TlsAcceptor::from(Arc::new(server_config)))
}

/// Load TLS server configuration for use with axum-server
///
/// This function is similar to load_tls_acceptor but returns the ServerConfig
/// directly for use with axum-server's RustlsConfig.
pub fn load_tls_server_config(
    config: &HttpTlsConfig,
) -> std::result::Result<Arc<rustls::server::ServerConfig>, Box<dyn std::error::Error + Send + Sync>>
{
    use rustls_pemfile::{certs, pkcs8_private_keys};
    use std::fs::File;
    use std::io::BufReader;
    use std::sync::Arc;

    // Ensure crypto provider is initialized
    init_crypto_provider();

    info!(
        "Loading TLS certificate from {} and key from {}",
        config.cert_file, config.key_file
    );

    // Load certificate chain
    let cert_file = File::open(&config.cert_file)
        .map_err(|e| format!("Failed to open certificate file {}: {}", config.cert_file, e))?;
    let mut cert_reader = BufReader::new(cert_file);
    let server_certs: Vec<rustls::pki_types::CertificateDer<'static>> = certs(&mut cert_reader)
        .collect::<std::result::Result<Vec<_>, _>>()
        .map_err(|e| format!("Failed to parse certificate file {}: {}", config.cert_file, e))?;

    if server_certs.is_empty() {
        return Err(format!("No certificates found in {}", config.cert_file).into());
    }

    // Load private key
    let key_file = File::open(&config.key_file)
        .map_err(|e| format!("Failed to open private key file {}: {}", config.key_file, e))?;
    let mut key_reader = BufReader::new(key_file);
    let pkcs8_keys: Vec<rustls::pki_types::PrivatePkcs8KeyDer<'static>> =
        pkcs8_private_keys(&mut key_reader)
            .collect::<std::result::Result<Vec<_>, _>>()
            .map_err(|e| format!("Failed to parse private key file {}: {}", config.key_file, e))?;
    let mut keys: Vec<rustls::pki_types::PrivateKeyDer<'static>> =
        pkcs8_keys.into_iter().map(rustls::pki_types::PrivateKeyDer::Pkcs8).collect();

    if keys.is_empty() {
        return Err(format!("No private keys found in {}", config.key_file).into());
    }

    // Determine TLS protocol versions based on min_version config
    let tls13_only = is_tls13_only(&config.min_version);

    // Determine mTLS mode
    let mtls_mode = if !config.mtls_mode.is_empty() && config.mtls_mode != "off" {
        config.mtls_mode.as_str()
    } else if config.require_client_cert {
        "required"
    } else {
        "off"
    };

    let server_config = match mtls_mode {
        "required" => {
            if let Some(ref ca_file_path) = config.ca_file {
                let ca_file = File::open(ca_file_path).map_err(|e| {
                    format!("Failed to open CA certificate file {}: {}", ca_file_path, e)
                })?;
                let mut ca_reader = BufReader::new(ca_file);
                let ca_certs: Vec<rustls::pki_types::CertificateDer<'static>> =
                    certs(&mut ca_reader).collect::<std::result::Result<Vec<_>, _>>().map_err(
                        |e| format!("Failed to parse CA certificate file {}: {}", ca_file_path, e),
                    )?;

                let mut root_store = rustls::RootCertStore::empty();
                for cert in &ca_certs {
                    root_store.add(cert.clone()).map_err(|e| {
                        format!("Failed to add CA certificate to root store: {}", e)
                    })?;
                }

                let client_verifier =
                    rustls::server::WebPkiClientVerifier::builder(Arc::new(root_store))
                        .build()
                        .map_err(|e| format!("Failed to build client verifier: {}", e))?;

                let key = keys.remove(0);

                tls_config_builder(tls13_only)
                    .with_client_cert_verifier(client_verifier)
                    .with_single_cert(server_certs, key)
                    .map_err(|e| format!("TLS config error (mTLS required): {}", e))?
            } else {
                return Err("mTLS mode 'required' requires CA certificate file".to_string().into());
            }
        }
        "optional" => {
            if let Some(ref ca_file_path) = config.ca_file {
                let ca_file = File::open(ca_file_path).map_err(|e| {
                    format!("Failed to open CA certificate file {}: {}", ca_file_path, e)
                })?;
                let mut ca_reader = BufReader::new(ca_file);
                let ca_certs: Vec<rustls::pki_types::CertificateDer<'static>> =
                    certs(&mut ca_reader).collect::<std::result::Result<Vec<_>, _>>().map_err(
                        |e| format!("Failed to parse CA certificate file {}: {}", ca_file_path, e),
                    )?;

                let mut root_store = rustls::RootCertStore::empty();
                for cert in &ca_certs {
                    root_store.add(cert.clone()).map_err(|e| {
                        format!("Failed to add CA certificate to root store: {}", e)
                    })?;
                }

                let client_verifier =
                    rustls::server::WebPkiClientVerifier::builder(Arc::new(root_store))
                        .build()
                        .map_err(|e| format!("Failed to build client verifier: {}", e))?;

                let key = keys.remove(0);

                tls_config_builder(tls13_only)
                    .with_client_cert_verifier(client_verifier)
                    .with_single_cert(server_certs, key)
                    .map_err(|e| format!("TLS config error (mTLS optional): {}", e))?
            } else {
                let key = keys.remove(0);
                tls_config_builder(tls13_only)
                    .with_no_client_auth()
                    .with_single_cert(server_certs, key)
                    .map_err(|e| format!("TLS config error: {}", e))?
            }
        }
        _ => {
            let key = keys.remove(0);
            tls_config_builder(tls13_only)
                .with_no_client_auth()
                .with_single_cert(server_certs, key)
                .map_err(|e| format!("TLS config error: {}", e))?
        }
    };

    Ok(Arc::new(server_config))
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Write;
    use tempfile::NamedTempFile;

    // Tests use the module-level init_crypto_provider() from super::*

    fn create_test_cert() -> (NamedTempFile, NamedTempFile) {
        // Create minimal test certificates (these won't actually work for real TLS,
        // but allow us to test the parsing logic)
        let cert = NamedTempFile::new().unwrap();
        let key = NamedTempFile::new().unwrap();

        // Write minimal PEM structure (not valid, but tests file reading)
        writeln!(cert.as_file(), "-----BEGIN CERTIFICATE-----").unwrap();
        writeln!(cert.as_file(), "TEST").unwrap();
        writeln!(cert.as_file(), "-----END CERTIFICATE-----").unwrap();

        writeln!(key.as_file(), "-----BEGIN PRIVATE KEY-----").unwrap();
        writeln!(key.as_file(), "TEST").unwrap();
        writeln!(key.as_file(), "-----END PRIVATE KEY-----").unwrap();

        (cert, key)
    }

    #[test]
    fn test_tls_config_validation() {
        init_crypto_provider();
        let (cert, key) = create_test_cert();

        let config = HttpTlsConfig {
            enabled: true,
            cert_file: cert.path().to_string_lossy().to_string(),
            key_file: key.path().to_string_lossy().to_string(),
            ca_file: None,
            min_version: "1.2".to_string(),
            cipher_suites: Vec::new(),
            require_client_cert: false,
            mtls_mode: "off".to_string(),
        };

        // This will fail because the certificates are not valid,
        // but it tests that the function attempts to load them
        let result = load_tls_acceptor(&config);
        assert!(result.is_err()); // Should fail on invalid cert
    }

    #[test]
    fn test_mtls_requires_ca() {
        init_crypto_provider();
        let (cert, key) = create_test_cert();

        let config = HttpTlsConfig {
            enabled: true,
            cert_file: cert.path().to_string_lossy().to_string(),
            key_file: key.path().to_string_lossy().to_string(),
            ca_file: None,
            min_version: "1.2".to_string(),
            cipher_suites: Vec::new(),
            require_client_cert: true, // Requires client cert but no CA file
            mtls_mode: "required".to_string(),
        };

        let result = load_tls_acceptor(&config);
        assert!(result.is_err());
        let err_msg = format!("{}", result.err().unwrap());
        assert!(
            err_msg.contains("CA") || err_msg.contains("--tls-ca"),
            "Expected error message about CA certificate, got: {}",
            err_msg
        );
    }
}