fix: runtime NSS_DB_PATH and Once-guarded fixture_init

Replace compile-time `option_env!` with `std::env::var` at runtime,
wrap `fixture_init` in `std::sync::Once`, move the env-var override
out of `init_db` and into `fixture_init`, and add `fixture_init()`
to `pbkdf2` tests to prevent a no-DB init race causing SIGSEGV.

Fixes #28.

Author: larseggert

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "nss-rs"
-version = "0.10.0"
+version = "0.10.1"
 authors = ["Martin Thomson <mt@lowentropy.net>", "Andy Leiserson <aleiserson@mozilla.com>", "John M. Schanck <jschanck@mozilla.com>", "Benjamin Beurdouche <beurdouche@mozilla.com>", "Anna Weine <anna.weine@mozilla.com>"]
 categories = ["network-programming", "web-programming"]
 keywords = ["nss", "crypto", "mozilla", "firefox"]

Cargo.toml

@@ -38,7 +38,6 @@ mod ssl;
 pub mod time;
 
 use std::{
-    env,
     ffi::CString,
     path::{Path, PathBuf},
     ptr::null,
@@ -189,15 +188,15 @@ pub fn init() -> Res<()> {
     res.as_ref().map(|_| ()).map_err(Clone::clone)
 }
 
+/// The path to the default NSS database used for testing.
+pub const TEST_FIXTURE_DB: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/test-fixture/db");
+
 /// Initialize with a database.
 ///
 /// # Errors
 ///
 /// If NSS cannot be initialized.
 pub fn init_db<P: Into<PathBuf>>(dir: P) -> Res<()> {
-    // Allow overriding the NSS database path with an environment variable.
-    let dir =
-        env::var("NSS_DB_PATH").unwrap_or(dir.into().to_str().ok_or(Error::Internal)?.to_string());
     let res = INITIALIZED.get_or_init(|| init_once(Some(dir.into())));
     res.as_ref().map(|_| ()).map_err(Clone::clone)
 }

src/lib.rs

@@ -73,10 +73,13 @@ pub fn pbkdf2(
 
 #[cfg(test)]
 mod tests {
+    use test_fixture::fixture_init;
+
     use super::*;
 
     #[test]
     fn rfc_7914_vector_1() {
+        fixture_init();
         // RFC 7914 §11 provides PBKDF2-HMAC-SHA256 vectors. Using a common one:
         // password="password", salt="salt", iter=1, dkLen=32.
         let dk = pbkdf2(&HmacAlgorithm::HMAC_SHA2_256, b"password", b"salt", 1, 32).unwrap();
@@ -90,6 +93,7 @@ mod tests {
 
     #[test]
     fn rfc_7914_vector_iter_2() {
+        fixture_init();
         let dk = pbkdf2(&HmacAlgorithm::HMAC_SHA2_256, b"password", b"salt", 2, 32).unwrap();
         let expected = [
             0xae, 0x4d, 0x0c, 0x95, 0xaf, 0x6b, 0x46, 0xd3, 0x2d, 0x0a, 0xdf, 0xf9, 0x28, 0xf0,
@@ -101,6 +105,7 @@ mod tests {
 
     #[test]
     fn pbkdf2_sha384_vector() {
+        fixture_init();
         let dk = pbkdf2(&HmacAlgorithm::HMAC_SHA2_384, b"password", b"salt", 1, 20).unwrap();
         let expected = [
             0xc0, 0xe1, 0x4f, 0x06, 0xe4, 0x9e, 0x32, 0xd7, 0x3f, 0x9f, 0x52, 0xdd, 0xf1, 0xd0,
@@ -111,6 +116,7 @@ mod tests {
 
     #[test]
     fn pbkdf2_sha512_vector() {
+        fixture_init();
         let dk = pbkdf2(&HmacAlgorithm::HMAC_SHA2_512, b"password", b"salt", 1, 20).unwrap();
         let expected = [
             0x86, 0x7f, 0x70, 0xcf, 0x1a, 0xde, 0x02, 0xcf, 0xf3, 0x75, 0x25, 0x99, 0xa3, 0xa5,
@@ -121,6 +127,7 @@ mod tests {
 
     #[test]
     fn deterministic_across_calls() {
+        fixture_init();
         let a = pbkdf2(
             &HmacAlgorithm::HMAC_SHA2_256,
             b"hello",
@@ -142,6 +149,7 @@ mod tests {
 
     #[test]
     fn different_salt_different_key() {
+        fixture_init();
         let a = pbkdf2(
             &HmacAlgorithm::HMAC_SHA2_256,
             b"hello",

src/pbkdf2.rs

@@ -8,40 +8,43 @@
 
 use std::{
     cell::OnceCell,
+    sync::Once,
     time::{Duration, Instant},
 };
 
 use nss_rs::{init_db, AntiReplay};
 
-/// The path for the database used in tests.
+/// The default path for the NSS database used in tests.
 ///
-/// Initialized via the `NSS_DB_PATH` environment variable. If that is not set,
-/// it defaults to the `db` directory in the current crate. If the environment
-/// variable is set to `$ARGV0`, it will be initialized to the directory of the
-/// current executable.
-pub const NSS_DB_PATH: &str = if let Some(dir) = option_env!("NSS_DB_PATH") {
-    dir
-} else {
-    concat!(env!("CARGO_MANIFEST_DIR"), "/db")
-};
+/// `fixture_init` uses this as a fallback when the `NSS_DB_PATH` environment
+/// variable is not set at runtime.
+pub const NSS_DB_PATH: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/db");
+
+static FIXTURE_INIT: Once = Once::new();
 
 /// Initialize the test fixture.  Only call this if you aren't also calling a
 /// fixture function that depends on setup.  Other functions in the fixture
 /// that depend on this setup call the function for you.
 ///
+/// The `NSS_DB_PATH` environment variable overrides the database path at
+/// runtime.  Set it to `$ARGV0` to use the directory of the current
+/// executable.
+///
 /// # Panics
 ///
 /// When the NSS initialization fails.
 #[allow(dead_code)]
 pub fn fixture_init() {
-    if NSS_DB_PATH == "$ARGV0" {
-        let mut current_exe = std::env::current_exe().unwrap();
-        current_exe.pop();
-        let nss_db_path = current_exe.to_str().unwrap();
-        init_db(nss_db_path).unwrap();
-    } else {
-        init_db(NSS_DB_PATH).unwrap();
-    }
+    FIXTURE_INIT.call_once(|| {
+        let db_path = std::env::var("NSS_DB_PATH").unwrap_or_else(|_| NSS_DB_PATH.to_string());
+        if db_path == "$ARGV0" {
+            let mut current_exe = std::env::current_exe().unwrap();
+            current_exe.pop();
+            init_db(current_exe).unwrap();
+        } else {
+            init_db(db_path).unwrap();
+        }
+    });
 }
 
 // This needs to be > 2ms to avoid it being rounded to zero.

test-fixture/src/lib.rs

@@ -42,7 +42,9 @@ fn init_nodb() {
 #[cfg(not(nss_nodb))]
 #[test]
 fn init_withdb() {
-    init_db(::test_fixture::NSS_DB_PATH).unwrap();
+    let path =
+        std::env::var("NSS_DB_PATH").unwrap_or_else(|_| ::test_fixture::NSS_DB_PATH.to_string());
+    init_db(path).unwrap();
     assert_initialized();
     unsafe {
         assert_ne!(nss_init::NSS_IsInitialized(), 0);