feat!: rename TPM2TOOLS_TCTI to RUST_TPM2_CLI_TCTI

To prevent unintended conflicts between rust-tpm2-cli and tpm2-tools,
rename the TCTI environment variable across the project.

Signed-off-by: Takuma IMAMURA <209989118+hyperfinitism@users.noreply.github.com>

Author: hyperfinitism

README.md

@@ -60,7 +60,7 @@ newgrp tss
 ls -l /dev/tpm*
 
 # Set TPM device path used by rust-tpm2-cli
-export TPM2TOOLS_TCTI="device:/dev/tpm0"
+export RUST_TPM2_CLI_TCTI="device:/dev/tpm0"
 ```
 
 ### Set up swtpm (software TPM simulator)
@@ -85,7 +85,7 @@ swtpm socket \
     --flags startup-clear
 
 # In another terminal:
-export TPM2TOOLS_TCTI="swtpm:host=localhost,port=2321"
+export RUST_TPM2_CLI_TCTI="swtpm:host=localhost,port=2321"
 ```
 
 ### Run integration tests

src/cli.rs

@@ -18,8 +18,8 @@ pub struct Cli {
 
 #[derive(Parser)]
 pub struct GlobalOpts {
-    /// TCTI configuration (e.g. device:/dev/tpm0, mssim:host=localhost,port=2321)
-    #[arg(short = 'T', long = "tcti", env = "TPM2TOOLS_TCTI")]
+    /// TCTI configuration (e.g. device:/dev/tpm0, swtpm:host=localhost,port=2321)
+    #[arg(short = 'T', long = "tcti", env = "RUST_TPM2_CLI_TCTI")]
     pub tcti: Option<String>,
 
     /// Enable errata fixups

src/raw_esys.rs

@@ -13,6 +13,8 @@ use std::ptr::{null, null_mut};
 use anyhow::{Context, bail};
 use tss_esapi::tss2_esys::*;
 
+use crate::tcti::DEFAULT_TCTI;
+
 // -----------------------------------------------------------------------
 // Raw context helpers
 // -----------------------------------------------------------------------
@@ -27,9 +29,7 @@ impl RawEsysContext {
     pub(crate) fn new(tcti: Option<&str>) -> anyhow::Result<Self> {
         let tcti_str = match tcti {
             Some(s) => s.to_owned(),
-            None => {
-                std::env::var("TPM2TOOLS_TCTI").unwrap_or_else(|_| "device:/dev/tpm0".to_owned())
-            }
+            None => std::env::var("RUST_TPM2_CLI_TCTI").unwrap_or_else(|_| DEFAULT_TCTI.to_owned()),
         };
         let c_str = CString::new(tcti_str.as_str()).context("TCTI string contains NUL")?;
 

src/tcti.rs

@@ -14,12 +14,12 @@ pub(crate) const DEFAULT_DEVICE_PATH: &str = "/dev/tpm0";
 
 /// Parse a TCTI configuration string into a [`TctiNameConf`].
 ///
-/// If `tcti` is `None`, falls back to the `TPM2TOOLS_TCTI` environment
+/// If `tcti` is `None`, falls back to the `RUST_TPM2_CLI_TCTI` environment
 /// variable, then to `device:/dev/tpm0`.
 pub fn parse_tcti(tcti: Option<&str>) -> Result<TctiNameConf, Tpm2Error> {
     let tcti_str = match tcti {
         Some(s) => s.to_owned(),
-        None => std::env::var("TPM2TOOLS_TCTI").unwrap_or_else(|_| DEFAULT_TCTI.to_owned()),
+        None => std::env::var("RUST_TPM2_CLI_TCTI").unwrap_or_else(|_| DEFAULT_TCTI.to_owned()),
     };
     TctiNameConf::from_str(&tcti_str).map_err(|e| Tpm2Error::InvalidTcti(e.to_string()))
 }
@@ -30,7 +30,7 @@ pub fn parse_tcti(tcti: Option<&str>) -> Result<TctiNameConf, Tpm2Error> {
 pub(crate) fn extract_device_path(tcti: Option<&str>) -> String {
     let tcti_str = match tcti {
         Some(s) => s.to_owned(),
-        None => std::env::var("TPM2TOOLS_TCTI").unwrap_or_else(|_| DEFAULT_TCTI.to_owned()),
+        None => std::env::var("RUST_TPM2_CLI_TCTI").unwrap_or_else(|_| DEFAULT_TCTI.to_owned()),
     };
     if let Some(rest) = tcti_str.strip_prefix("device:") {
         rest.to_owned()

tests/helpers.sh

@@ -59,7 +59,7 @@ summary() {
     return 0
 }
 
-# Start an swtpm simulator and set TPM2TOOLS_TCTI.
+# Start an swtpm simulator and set RUST_TPM2_CLI_TCTI.
 start_swtpm() {
     TEST_TMPDIR="$(mktemp -d)"
     export TEST_TMPDIR
@@ -84,7 +84,7 @@ start_swtpm() {
         sleep 0.1
     done
 
-    export TPM2TOOLS_TCTI="swtpm:host=localhost,port=${SWTPM_PORT}"
+    export RUST_TPM2_CLI_TCTI="swtpm:host=localhost,port=${SWTPM_PORT}"
 }
 
 # Stop swtpm and clean up.