Skip to content

Commit 7d17a98

Browse files
committed
refactor(server): extract shared TLS test utilities
Signed-off-by: Yuedong Wu <[email protected]>
1 parent e9a55c9 commit 7d17a98

3 files changed

Lines changed: 90 additions & 113 deletions

File tree

‎crates/openshell-server/src/lib.rs‎

Lines changed: 5 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ mod ssh_sessions;
4040
pub mod supervisor_session;
4141
mod telemetry;
4242
mod tls;
43+
#[cfg(test)]
44+
pub(crate) mod tls_test_utils;
4345
pub mod tracing_bus;
4446
mod ws_tunnel;
4547

@@ -919,8 +921,7 @@ mod tests {
919921
ComputeDriverKind, Config,
920922
proto::{HealthRequest, open_shell_client::OpenShellClient},
921923
};
922-
use rcgen::{CertificateParams, IsCa, KeyPair};
923-
use std::io::{Error, ErrorKind, Write};
924+
use std::io::{Error, ErrorKind};
924925
use std::net::SocketAddr;
925926
use std::sync::Arc;
926927
use std::time::Duration;
@@ -929,41 +930,13 @@ mod tests {
929930
use tokio::net::{TcpListener, TcpStream};
930931
use tokio::sync::watch;
931932

932-
fn install_rustls_provider() {
933-
let _ = rustls::crypto::ring::default_provider().install_default();
934-
}
933+
use crate::tls_test_utils::{generate_test_certs_with_ca, install_rustls_provider};
935934

936935
fn test_tls_acceptor() -> (TempDir, TlsAcceptor) {
937936
install_rustls_provider();
938937

939-
let mut ca_params =
940-
CertificateParams::new(Vec::<String>::new()).expect("failed to create CA params");
941-
ca_params.is_ca = IsCa::Ca(rcgen::BasicConstraints::Unconstrained);
942-
ca_params
943-
.distinguished_name
944-
.push(rcgen::DnType::CommonName, "test-ca");
945-
let ca_key = KeyPair::generate().expect("failed to generate CA key");
946-
let ca_cert = ca_params
947-
.self_signed(&ca_key)
948-
.expect("failed to sign CA cert");
949-
950-
let server_params = CertificateParams::new(vec!["localhost".to_string()])
951-
.expect("failed to create server params");
952-
let server_key = KeyPair::generate().expect("failed to generate server key");
953-
let server_cert = server_params
954-
.signed_by(&server_key, &ca_cert, &ca_key)
955-
.expect("failed to sign server cert");
956-
957938
let dir = tempdir().expect("failed to create tempdir");
958-
let write_file = |name: &str, data: &[u8]| {
959-
let path = dir.path().join(name);
960-
std::fs::File::create(&path)
961-
.and_then(|mut file| file.write_all(data))
962-
.expect("failed to write tls test file");
963-
};
964-
write_file("ca.pem", ca_cert.pem().as_bytes());
965-
write_file("server-cert.pem", server_cert.pem().as_bytes());
966-
write_file("server-key.pem", server_key.serialize_pem().as_bytes());
939+
generate_test_certs_with_ca(dir.path());
967940

968941
let acceptor = TlsAcceptor::from_files(
969942
&dir.path().join("server-cert.pem"),

‎crates/openshell-server/src/tls.rs‎

Lines changed: 23 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -349,48 +349,12 @@ fn tls_ocsf_ctx() -> SandboxContext {
349349
#[cfg(test)]
350350
mod tests {
351351
use super::*;
352+
use crate::tls_test_utils::{
353+
generate_test_certs_with_ca, install_rustls_provider, write_test_file,
354+
};
352355
use rcgen::{CertificateParams, IsCa, KeyPair, KeyUsagePurpose};
353-
use std::io::Write;
354356
use tokio::net::{TcpListener, TcpStream};
355357

356-
fn install_rustls_provider() {
357-
let _ = rustls::crypto::ring::default_provider().install_default();
358-
}
359-
360-
/// Generate test CA + server certs in `dir`, returning the CA cert and
361-
/// keypair so callers can sign additional server or client certificates.
362-
fn generate_test_certs_with_ca(dir: &Path) -> (rcgen::Certificate, KeyPair) {
363-
let mut ca_params =
364-
CertificateParams::new(Vec::<String>::new()).expect("failed to create CA params");
365-
ca_params.is_ca = IsCa::Ca(rcgen::BasicConstraints::Unconstrained);
366-
ca_params
367-
.distinguished_name
368-
.push(rcgen::DnType::CommonName, "test-ca");
369-
let ca_key = KeyPair::generate().expect("failed to generate CA key");
370-
let ca_cert = ca_params
371-
.self_signed(&ca_key)
372-
.expect("failed to sign CA cert");
373-
374-
let server_params = CertificateParams::new(vec!["localhost".to_string()])
375-
.expect("failed to create server params");
376-
let server_key = KeyPair::generate().expect("failed to generate server key");
377-
let server_cert = server_params
378-
.signed_by(&server_key, &ca_cert, &ca_key)
379-
.expect("failed to sign server cert");
380-
381-
let write_file = |name: &str, data: &[u8]| {
382-
let path = dir.join(name);
383-
File::create(&path)
384-
.and_then(|mut file| file.write_all(data))
385-
.expect("failed to write test file");
386-
};
387-
write_file("ca.pem", ca_cert.pem().as_bytes());
388-
write_file("server-cert.pem", server_cert.pem().as_bytes());
389-
write_file("server-key.pem", server_key.serialize_pem().as_bytes());
390-
391-
(ca_cert, ca_key)
392-
}
393-
394358
/// Generate a new server cert + key in `dir`, signed by the given CA.
395359
/// Overwrites `server-cert.pem` and `server-key.pem`.
396360
fn generate_server_cert(ca_cert: &rcgen::Certificate, ca_key: &KeyPair, dir: &Path) {
@@ -401,14 +365,8 @@ mod tests {
401365
.signed_by(&server_key, ca_cert, ca_key)
402366
.expect("failed to sign server cert");
403367

404-
let write_file = |name: &str, data: &[u8]| {
405-
let path = dir.join(name);
406-
File::create(&path)
407-
.and_then(|mut file| file.write_all(data))
408-
.expect("failed to write test file");
409-
};
410-
write_file("server-cert.pem", server_cert.pem().as_bytes());
411-
write_file("server-key.pem", server_key.serialize_pem().as_bytes());
368+
write_test_file(dir, "server-cert.pem", server_cert.pem().as_bytes());
369+
write_test_file(dir, "server-key.pem", server_key.serialize_pem().as_bytes());
412370
}
413371

414372
fn build_test_client_config(ca_path: &Path) -> Arc<rustls::ClientConfig> {
@@ -482,7 +440,10 @@ mod tests {
482440
std::fs::write(dir.path().join("server-cert.pem"), b"garbage")
483441
.expect("failed to write garbage");
484442

485-
assert!(acceptor.reload().is_err(), "reload with garbage cert should fail");
443+
assert!(
444+
acceptor.reload().is_err(),
445+
"reload with garbage cert should fail"
446+
);
486447

487448
// Old config must still be accessible after a failed reload.
488449
drop(acceptor_before);
@@ -559,7 +520,9 @@ mod tests {
559520
let reload_handle = tokio::spawn(async move {
560521
for _ in 0..20 {
561522
generate_server_cert(&ca_cert, &ca_key, dir.path());
562-
acceptor.reload().expect("reload with valid cert should succeed");
523+
acceptor
524+
.reload()
525+
.expect("reload with valid cert should succeed");
563526
tokio::time::sleep(Duration::from_millis(5)).await;
564527
}
565528
});
@@ -618,9 +581,7 @@ mod tests {
618581
.await
619582
.expect("TLS accept failed");
620583
});
621-
let tcp_1 = TcpStream::connect(addr1)
622-
.await
623-
.expect("connect failed");
584+
let tcp_1 = TcpStream::connect(addr1).await.expect("connect failed");
624585
let tls_1 = connector
625586
.connect(server_name.clone(), tcp_1)
626587
.await
@@ -646,9 +607,7 @@ mod tests {
646607
.await
647608
.expect("TLS accept failed");
648609
});
649-
let tcp_2 = TcpStream::connect(addr2)
650-
.await
651-
.expect("connect failed");
610+
let tcp_2 = TcpStream::connect(addr2).await.expect("connect failed");
652611
let tls_2 = connector
653612
.connect(server_name.clone(), tcp_2)
654613
.await
@@ -793,36 +752,19 @@ mod tests {
793752
let new_ca_cert = new_ca_params
794753
.self_signed(&new_ca_key)
795754
.expect("failed to sign new CA cert");
796-
std::fs::write(
797-
dir.path().join("ca.pem"),
798-
new_ca_cert.pem().as_bytes(),
799-
)
800-
.expect("failed to write new CA");
801-
802-
// Generate new server cert signed by new CA
803-
let server_params = CertificateParams::new(vec!["localhost".to_string()])
804-
.expect("failed to create server params");
805-
let server_key = KeyPair::generate().expect("failed to generate server key");
806-
let server_cert = server_params
807-
.signed_by(&server_key, &new_ca_cert, &new_ca_key)
808-
.expect("failed to sign server cert");
809-
std::fs::write(
810-
dir.path().join("server-cert.pem"),
811-
server_cert.pem().as_bytes(),
812-
)
813-
.expect("failed to write server cert");
814-
std::fs::write(
815-
dir.path().join("server-key.pem"),
816-
server_key.serialize_pem().as_bytes(),
817-
)
818-
.expect("failed to write server key");
755+
std::fs::write(dir.path().join("ca.pem"), new_ca_cert.pem().as_bytes())
756+
.expect("failed to write new CA");
819757

820-
acceptor.reload().expect("reload with new CA should succeed");
758+
// Generate new server cert signed by new CA and reload
759+
generate_server_cert(&new_ca_cert, &new_ca_key, dir.path());
760+
acceptor
761+
.reload()
762+
.expect("reload with new CA should succeed");
821763

822764
// Generate client cert signed by new CA, write to files
823765
let client_key = KeyPair::generate().expect("failed to generate client key");
824-
let mut client_params = CertificateParams::new(Vec::<String>::new())
825-
.expect("failed to create client params");
766+
let mut client_params =
767+
CertificateParams::new(Vec::<String>::new()).expect("failed to create client params");
826768
client_params
827769
.distinguished_name
828770
.push(rcgen::DnType::CommonName, "test-client");
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
//! Shared test helpers for TLS-related tests.
5+
6+
use std::fs::File;
7+
use std::io::Write;
8+
use std::path::Path;
9+
10+
use rcgen::{CertificateParams, IsCa, KeyPair};
11+
12+
/// Install the default rustls crypto provider.
13+
///
14+
/// Must be called once at the start of any test that exercises TLS handshakes.
15+
/// Multiple calls are harmless (subsequent calls return an error, ignored).
16+
pub fn install_rustls_provider() {
17+
let _ = rustls::crypto::ring::default_provider().install_default();
18+
}
19+
20+
/// Write bytes to a file inside `dir`, panicking on failure.
21+
pub fn write_test_file(dir: &Path, name: &str, data: &[u8]) {
22+
let path = dir.join(name);
23+
File::create(&path)
24+
.and_then(|mut file| file.write_all(data))
25+
.expect("failed to write test file");
26+
}
27+
28+
/// Generate a self-signed CA certificate and a `localhost` server certificate,
29+
/// writing them as PEM files into `dir`.
30+
///
31+
/// Returns the CA certificate and keypair so callers can sign additional
32+
/// server or client certificates.
33+
///
34+
/// Files written:
35+
/// - `ca.pem`
36+
/// - `server-cert.pem`
37+
/// - `server-key.pem`
38+
pub fn generate_test_certs_with_ca(dir: &Path) -> (rcgen::Certificate, KeyPair) {
39+
let mut ca_params =
40+
CertificateParams::new(Vec::<String>::new()).expect("failed to create CA params");
41+
ca_params.is_ca = IsCa::Ca(rcgen::BasicConstraints::Unconstrained);
42+
ca_params
43+
.distinguished_name
44+
.push(rcgen::DnType::CommonName, "test-ca");
45+
let ca_key = KeyPair::generate().expect("failed to generate CA key");
46+
let ca_cert = ca_params
47+
.self_signed(&ca_key)
48+
.expect("failed to sign CA cert");
49+
50+
let server_params = CertificateParams::new(vec!["localhost".to_string()])
51+
.expect("failed to create server params");
52+
let server_key = KeyPair::generate().expect("failed to generate server key");
53+
let server_cert = server_params
54+
.signed_by(&server_key, &ca_cert, &ca_key)
55+
.expect("failed to sign server cert");
56+
57+
write_test_file(dir, "ca.pem", ca_cert.pem().as_bytes());
58+
write_test_file(dir, "server-cert.pem", server_cert.pem().as_bytes());
59+
write_test_file(dir, "server-key.pem", server_key.serialize_pem().as_bytes());
60+
61+
(ca_cert, ca_key)
62+
}

0 commit comments

Comments
 (0)