Use TEST_PKCS11_MODULE environment variable to specify test token

Signed-off-by: Jakub Jelen <[email protected]>

Author: Jakuje

.github/actions/ci_script/action.yml

@@ -30,7 +30,7 @@ runs:
 
     - name: Test script
       env:
-        PKCS11_SOFTHSM2_MODULE: /usr/lib/softhsm/libsofthsm2.so
+        TEST_PKCS11_MODULE: /usr/lib/softhsm/libsofthsm2.so
         SOFTHSM2_CONF: /tmp/softhsm2.conf
       run: ./ci.sh
       shell: bash

.github/workflows/nightly.yml

@@ -62,7 +62,7 @@ jobs:
 
       - name: Test script
         env:
-          PKCS11_SOFTHSM2_MODULE: /usr/lib/softhsm/libsofthsm2.so
+          TEST_PKCS11_MODULE: /usr/lib/softhsm/libsofthsm2.so
           SOFTHSM2_CONF: /tmp/softhsm2.conf
         run: |
           rm Cargo.lock

cryptoki/README.md

@@ -22,7 +22,7 @@ You can follow the installation steps directly in the repository's README but he
 sudo apt install libsofthsm2
 mkdir /tmp/tokens
 echo "directories.tokendir = /tmp/tokens" > /tmp/softhsm2.conf
-export PKCS11_SOFTHSM2_MODULE="/usr/lib/softhsm/libsofthsm2.so"
+export TEST_PKCS11_MODULE="/usr/lib/softhsm/libsofthsm2.so"
 export SOFTHSM2_CONF="/tmp/softhsm2.conf"
 cargo run --example generate_key_pair
 ```
@@ -43,7 +43,7 @@ use std::env;
 
 // initialize a new Pkcs11 object using the module from the env variable
 let pkcs11 = Pkcs11::new(
-    env::var("PKCS11_SOFTHSM2_MODULE")
+    env::var("TEST_PKCS11_MODULE")
         .unwrap_or_else(|_| "/usr/local/lib/softhsm/libsofthsm2.so".to_string()),
 )?;
 

cryptoki/examples/generate_key_pair.rs

@@ -15,7 +15,7 @@ pub static SO_PIN: &str = "abcdef";
 fn main() -> testresult::TestResult {
     // initialize a new Pkcs11 object using the module from the env variable
     let pkcs11 = Pkcs11::new(
-        env::var("PKCS11_SOFTHSM2_MODULE")
+        env::var("TEST_PKCS11_MODULE")
             .unwrap_or_else(|_| "/usr/local/lib/softhsm/libsofthsm2.so".to_string()),
     )?;
 

cryptoki/src/context/session_management.rs

@@ -50,7 +50,7 @@ impl Pkcs11 {
     /// use cryptoki::context::Pkcs11;
     ///
     /// let mut client = Pkcs11::new(
-    ///     std::env::var("PKCS11_SOFTHSM2_MODULE")
+    ///     std::env::var("TEST_PKCS11_MODULE")
     ///        .unwrap_or_else(|_| "/usr/local/lib/softhsm/libsofthsm2.so".to_string()),
     /// )?;
     /// client.initialize(cryptoki::context::CInitializeArgs::OsThreads)?;

cryptoki/src/session/object_management.rs

@@ -39,7 +39,7 @@ const MAX_OBJECT_COUNT: NonZeroUsize = unsafe { NonZeroUsize::new_unchecked(10)
 ///
 /// # fn main() -> testresult::TestResult {
 /// # let pkcs11 = Pkcs11::new(
-/// #    env::var("PKCS11_SOFTHSM2_MODULE")
+/// #    env::var("TEST_PKCS11_MODULE")
 /// #        .unwrap_or_else(|_| "/usr/local/lib/libsofthsm2.so".to_string()),
 /// # )?;
 /// #
@@ -282,7 +282,7 @@ impl Session {
     /// # use cryptoki::object::{Attribute, AttributeType, CertificateType, ObjectClass, ObjectHandle};
     /// #
     /// # let mut client = Pkcs11::new(
-    /// #    std::env::var("PKCS11_SOFTHSM2_MODULE")
+    /// #    std::env::var("TEST_PKCS11_MODULE")
     /// #       .unwrap_or_else(|_| "/usr/local/lib/softhsm/libsofthsm2.so".to_string()),
     /// # )?;
     /// # client.initialize(cryptoki::context::CInitializeArgs::OsThreads)?;
@@ -401,7 +401,7 @@ impl Session {
     /// use std::env;
     ///
     /// let mut pkcs11 = Pkcs11::new(
-    ///         env::var("PKCS11_SOFTHSM2_MODULE")
+    ///         env::var("TEST_PKCS11_MODULE")
     ///             .unwrap_or_else(|_| "/usr/local/lib/softhsm/libsofthsm2.so".to_string()),
     ///     )
     ///     .unwrap();

cryptoki/tests/common.rs

@@ -13,7 +13,7 @@ pub static SO_PIN: &str = "abcdef";
 
 pub fn get_pkcs11() -> Pkcs11 {
     Pkcs11::new(
-        env::var("PKCS11_SOFTHSM2_MODULE")
+        env::var("TEST_PKCS11_MODULE")
             .unwrap_or_else(|_| "/usr/local/lib/softhsm/libsofthsm2.so".to_string()),
     )
     .unwrap()