hyperdb-api-core 0.1.1

Internal implementation details for hyperdb-api. Not a stable API; use hyperdb-api instead.
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
// Copyright (c) 2026, Salesforce, Inc. All rights reserved.
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Integration tests for TLS support.
//!
//! These tests verify the rustls backend by:
//! 1. Generating self-signed certificates at test time using `rcgen`
//! 2. Starting a local TLS echo server
//! 3. Connecting through `hyperdb_api_core::client::tls` module functions
//! 4. Verifying data can be exchanged over the encrypted connection
//!
//! Run with:
//!   cargo test --test `tls_tests`

use std::io::Write;
use tempfile::NamedTempFile;

use hyperdb_api_core::client::tls::TlsConfig;

/// A CA: its params (needed as issuer reference), key pair, and self-signed cert PEM.
struct TestCa {
    params: rcgen::CertificateParams,
    key_pair: rcgen::KeyPair,
    cert_pem: String,
}

/// A leaf cert: its key pair and cert PEM.
struct TestCert {
    key_pair: rcgen::KeyPair,
    cert_pem: String,
}

/// Generate a self-signed CA.
fn generate_ca() -> TestCa {
    let mut params = rcgen::CertificateParams::new(Vec::<String>::new()).unwrap();
    params.is_ca = rcgen::IsCa::Ca(rcgen::BasicConstraints::Unconstrained);
    params
        .distinguished_name
        .push(rcgen::DnType::CommonName, "Test CA");
    let key_pair = rcgen::KeyPair::generate().unwrap();
    let cert = params.self_signed(&key_pair).unwrap();
    let cert_pem = cert.pem();
    TestCa {
        params,
        key_pair,
        cert_pem,
    }
}

/// Generate a server certificate signed by the CA.
fn generate_server_cert(ca: &TestCa, san: &str) -> TestCert {
    let params = rcgen::CertificateParams::new(vec![san.to_string()]).unwrap();
    let key_pair = rcgen::KeyPair::generate().unwrap();
    let issuer = rcgen::Issuer::from_params(&ca.params, &ca.key_pair);
    let cert = params.signed_by(&key_pair, &issuer).unwrap();
    TestCert {
        key_pair,
        cert_pem: cert.pem(),
    }
}

/// Generate a client certificate signed by the CA.
fn generate_client_cert(ca: &TestCa) -> TestCert {
    let mut params = rcgen::CertificateParams::new(Vec::<String>::new()).unwrap();
    params
        .distinguished_name
        .push(rcgen::DnType::CommonName, "Test Client");
    let key_pair = rcgen::KeyPair::generate().unwrap();
    let issuer = rcgen::Issuer::from_params(&ca.params, &ca.key_pair);
    let cert = params.signed_by(&key_pair, &issuer).unwrap();
    TestCert {
        key_pair,
        cert_pem: cert.pem(),
    }
}

/// Write PEM data to a temp file. The returned handle keeps the file alive.
fn write_pem_file(pem: &str) -> NamedTempFile {
    let mut f = NamedTempFile::new().unwrap();
    f.write_all(pem.as_bytes()).unwrap();
    f.flush().unwrap();
    f
}

// =============================================================================
// rustls tests
// =============================================================================

mod rustls_tests {
    use super::*;
    use hyperdb_api_core::client::tls::rustls_impl;
    use std::sync::Arc;
    use tokio::io::{AsyncReadExt, AsyncWriteExt};
    use tokio::net::{TcpListener, TcpStream};
    use tokio_rustls::TlsAcceptor;

    /// Start a TLS echo server using rustls. Returns (addr, `join_handle`).
    /// The server accepts one connection, reads data, and echoes it back prefixed with "echo:".
    async fn start_echo_server(
        server_cert_pem: &str,
        server_key_pem: &str,
        require_client_cert_ca_pem: Option<&str>,
    ) -> (std::net::SocketAddr, tokio::task::JoinHandle<()>) {
        let provider = Arc::new(rustls::crypto::ring::default_provider());

        let certs: Vec<rustls::pki_types::CertificateDer<'static>> =
            rustls_pemfile::certs(&mut server_cert_pem.as_bytes())
                .map(|r| r.unwrap())
                .collect();
        let key = rustls_pemfile::private_key(&mut server_key_pem.as_bytes())
            .unwrap()
            .unwrap();

        let server_config = if let Some(ca_pem) = require_client_cert_ca_pem {
            let mut root_store = rustls::RootCertStore::empty();
            let ca_certs: Vec<rustls::pki_types::CertificateDer<'static>> =
                rustls_pemfile::certs(&mut ca_pem.as_bytes())
                    .map(|r| r.unwrap())
                    .collect();
            for cert in ca_certs {
                root_store.add(cert).unwrap();
            }
            let verifier = rustls::server::WebPkiClientVerifier::builder_with_provider(
                Arc::new(root_store),
                Arc::clone(&provider),
            )
            .build()
            .unwrap();
            rustls::ServerConfig::builder_with_provider(Arc::clone(&provider))
                .with_safe_default_protocol_versions()
                .unwrap()
                .with_client_cert_verifier(verifier)
                .with_single_cert(certs, key)
                .unwrap()
        } else {
            rustls::ServerConfig::builder_with_provider(Arc::clone(&provider))
                .with_safe_default_protocol_versions()
                .unwrap()
                .with_no_client_auth()
                .with_single_cert(certs, key)
                .unwrap()
        };

        let acceptor = TlsAcceptor::from(Arc::new(server_config));
        let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
        let addr = listener.local_addr().unwrap();

        let handle = tokio::spawn(async move {
            if let Ok((stream, _)) = listener.accept().await {
                if let Ok(mut tls_stream) = acceptor.accept(stream).await {
                    let mut buf = [0u8; 1024];
                    if let Ok(n) = tls_stream.read(&mut buf).await {
                        let msg = std::str::from_utf8(&buf[..n]).unwrap_or("?");
                        let response = format!("echo:{msg}");
                        let _ = tls_stream.write_all(response.as_bytes()).await;
                        let _ = tls_stream.shutdown().await;
                    }
                }
            }
        });

        (addr, handle)
    }

    #[tokio::test]
    async fn test_rustls_connector_creation_with_ca() {
        let ca = generate_ca();
        let ca_pem_file = write_pem_file(&ca.cert_pem);

        let config = TlsConfig::new().ca_cert(ca_pem_file.path());
        let connector = rustls_impl::create_connector(&config, "localhost");
        assert!(
            connector.is_ok(),
            "Failed to create rustls connector: {:?}",
            connector.err()
        );
    }

    #[tokio::test]
    async fn test_rustls_connector_creation_system_roots() {
        let config = TlsConfig::new();
        let connector = rustls_impl::create_connector(&config, "localhost");
        assert!(
            connector.is_ok(),
            "Failed to create connector with system roots: {:?}",
            connector.err()
        );
    }

    #[tokio::test]
    async fn test_rustls_tls_handshake_and_data_exchange() {
        let ca = generate_ca();
        let server = generate_server_cert(&ca, "localhost");

        let (addr, server_handle) =
            start_echo_server(&server.cert_pem, &server.key_pair.serialize_pem(), None).await;

        let ca_pem_file = write_pem_file(&ca.cert_pem);
        let config = TlsConfig::new().ca_cert(ca_pem_file.path());
        let connector = rustls_impl::create_connector(&config, "localhost").unwrap();

        let tcp_stream = TcpStream::connect(addr).await.unwrap();
        let mut tls_stream = rustls_impl::wrap_stream(tcp_stream, &connector, "localhost")
            .await
            .expect("TLS handshake should succeed");

        tls_stream.write_all(b"hello TLS").await.unwrap();
        tls_stream.shutdown().await.unwrap();

        let mut response = String::new();
        tls_stream.read_to_string(&mut response).await.unwrap();
        assert_eq!(response, "echo:hello TLS");

        server_handle.await.unwrap();
    }

    #[tokio::test]
    async fn test_rustls_rejects_unknown_ca() {
        let ca = generate_ca();
        let server = generate_server_cert(&ca, "localhost");

        let (addr, _server_handle) =
            start_echo_server(&server.cert_pem, &server.key_pair.serialize_pem(), None).await;

        // Use a different CA that didn't sign the server cert
        let wrong_ca = generate_ca();
        let wrong_ca_file = write_pem_file(&wrong_ca.cert_pem);
        let config = TlsConfig::new().ca_cert(wrong_ca_file.path());
        let connector = rustls_impl::create_connector(&config, "localhost").unwrap();

        let tcp_stream = TcpStream::connect(addr).await.unwrap();
        let result = rustls_impl::wrap_stream(tcp_stream, &connector, "localhost").await;
        assert!(
            result.is_err(),
            "Should reject connection signed by unknown CA"
        );
    }

    #[tokio::test]
    async fn test_rustls_rejects_wrong_hostname() {
        let ca = generate_ca();
        let server = generate_server_cert(&ca, "localhost");

        let (addr, _server_handle) =
            start_echo_server(&server.cert_pem, &server.key_pair.serialize_pem(), None).await;

        let ca_pem_file = write_pem_file(&ca.cert_pem);
        let config = TlsConfig::new().ca_cert(ca_pem_file.path());
        let connector = rustls_impl::create_connector(&config, "wrong.host.name").unwrap();

        let tcp_stream = TcpStream::connect(addr).await.unwrap();
        let result = rustls_impl::wrap_stream(tcp_stream, &connector, "wrong.host.name").await;
        assert!(
            result.is_err(),
            "Should reject connection when server name doesn't match cert SAN"
        );
    }

    #[tokio::test]
    async fn test_rustls_mutual_tls() {
        let ca = generate_ca();
        let server = generate_server_cert(&ca, "localhost");
        let client = generate_client_cert(&ca);

        // Server requires client certificates (mTLS)
        let (addr, server_handle) = start_echo_server(
            &server.cert_pem,
            &server.key_pair.serialize_pem(),
            Some(&ca.cert_pem),
        )
        .await;

        let ca_pem_file = write_pem_file(&ca.cert_pem);
        let client_cert_file = write_pem_file(&client.cert_pem);
        let client_key_file = write_pem_file(&client.key_pair.serialize_pem());

        let config = TlsConfig::new()
            .ca_cert(ca_pem_file.path())
            .client_cert(client_cert_file.path(), client_key_file.path());
        let connector = rustls_impl::create_connector(&config, "localhost").unwrap();

        let tcp_stream = TcpStream::connect(addr).await.unwrap();
        let mut tls_stream = rustls_impl::wrap_stream(tcp_stream, &connector, "localhost")
            .await
            .expect("mTLS handshake should succeed");

        tls_stream.write_all(b"mtls works").await.unwrap();
        tls_stream.shutdown().await.unwrap();

        let mut response = String::new();
        tls_stream.read_to_string(&mut response).await.unwrap();
        assert_eq!(response, "echo:mtls works");

        server_handle.await.unwrap();
    }

    #[tokio::test]
    async fn test_rustls_mtls_rejected_without_client_cert() {
        let ca = generate_ca();
        let server = generate_server_cert(&ca, "localhost");

        // Server requires client certs (mTLS)
        let (addr, _server_handle) = start_echo_server(
            &server.cert_pem,
            &server.key_pair.serialize_pem(),
            Some(&ca.cert_pem),
        )
        .await;

        // Client omits client certificate
        let ca_pem_file = write_pem_file(&ca.cert_pem);
        let config = TlsConfig::new().ca_cert(ca_pem_file.path());
        let connector = rustls_impl::create_connector(&config, "localhost").unwrap();

        let tcp_stream = TcpStream::connect(addr).await.unwrap();
        let result = rustls_impl::wrap_stream(tcp_stream, &connector, "localhost").await;

        // The handshake may fail outright, or succeed but the server drops the connection
        if let Ok(mut stream) = result {
            let write_result = stream.write_all(b"test").await;
            let mut buf = [0u8; 1024];
            let read_result = stream.read(&mut buf).await;
            assert!(
                write_result.is_err() || read_result.is_err() || read_result.unwrap_or(0) == 0,
                "Server should reject connection without client cert"
            );
        }
    }
}

// =============================================================================
// TlsConfig unit tests (no feature gates needed)
// =============================================================================

mod config_tests {
    use super::*;
    use hyperdb_api_core::client::tls::TlsMode;

    #[test]
    fn test_tls_config_default_values() {
        let config = TlsConfig::default();
        assert!(config.verify_server);
        assert!(config.ca_cert_path.is_none());
        assert!(config.client_cert_path.is_none());
        assert!(config.client_key_path.is_none());
        assert!(config.server_name.is_none());
        assert!(!config.has_client_cert());
    }

    #[test]
    fn test_tls_config_builder_pattern() {
        let ca = generate_ca();
        let client = generate_client_cert(&ca);

        let ca_file = write_pem_file(&ca.cert_pem);
        let cert_file = write_pem_file(&client.cert_pem);
        let key_file = write_pem_file(&client.key_pair.serialize_pem());

        let config = TlsConfig::new()
            .ca_cert(ca_file.path())
            .client_cert(cert_file.path(), key_file.path())
            .server_name("example.com");

        assert!(config.verify_server);
        assert!(config.ca_cert_path.is_some());
        assert!(config.has_client_cert());
        assert_eq!(config.server_name, Some("example.com".to_string()));
    }

    #[test]
    fn test_tls_config_danger_accept_invalid_certs() {
        let config = TlsConfig::new().danger_accept_invalid_certs();
        assert!(!config.verify_server);
    }

    #[test]
    fn test_tls_mode_disable() {
        assert!(!TlsMode::Disable.is_enabled());
        assert!(!TlsMode::Disable.is_required());
        assert!(!TlsMode::Disable.verify_server());
        assert!(!TlsMode::Disable.verify_hostname());
    }

    #[test]
    fn test_tls_mode_prefer() {
        assert!(TlsMode::Prefer.is_enabled());
        assert!(!TlsMode::Prefer.is_required());
    }

    #[test]
    fn test_tls_mode_require() {
        assert!(TlsMode::Require.is_enabled());
        assert!(TlsMode::Require.is_required());
        assert!(!TlsMode::Require.verify_server());
    }

    #[test]
    fn test_tls_mode_verify_ca() {
        assert!(TlsMode::VerifyCA.is_enabled());
        assert!(TlsMode::VerifyCA.is_required());
        assert!(TlsMode::VerifyCA.verify_server());
        assert!(!TlsMode::VerifyCA.verify_hostname());
    }

    #[test]
    fn test_tls_mode_verify_full() {
        assert!(TlsMode::VerifyFull.is_enabled());
        assert!(TlsMode::VerifyFull.is_required());
        assert!(TlsMode::VerifyFull.verify_server());
        assert!(TlsMode::VerifyFull.verify_hostname());
    }
}