use std::env;
use std::error::Error;
use std::fmt;
pub enum EnvError {
VarError(env::VarError),
IoError(std::io::Error),
MissingSecureEnvSupport,
#[cfg(feature = "secure-env")]
DecryptionFailed(String),
#[cfg(feature = "secure-env")]
MissingKeyFile,
#[cfg(feature = "secure-env")]
KeyFileFormatError(String),
}
impl fmt::Debug for EnvError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
EnvError::VarError(e) => f.debug_tuple("VarError").field(e).finish(),
EnvError::IoError(e) => f.debug_tuple("IoError").field(e).finish(),
EnvError::MissingSecureEnvSupport => write!(f, "MissingSecureEnvSupport"),
#[cfg(feature = "secure-env")]
EnvError::DecryptionFailed(_) => write!(f, "DecryptionFailed([REDACTED])"),
#[cfg(feature = "secure-env")]
EnvError::MissingKeyFile => write!(f, "MissingKeyFile"),
#[cfg(feature = "secure-env")]
EnvError::KeyFileFormatError(_) => write!(f, "KeyFileFormatError([REDACTED])"),
}
}
}
impl From<env::VarError> for EnvError {
fn from(err: env::VarError) -> Self {
EnvError::VarError(err)
}
}
impl From<std::io::Error> for EnvError {
fn from(err: std::io::Error) -> Self {
EnvError::IoError(err)
}
}
impl fmt::Display for EnvError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
EnvError::VarError(e) => write!(f, "Environment variable error: {}", e),
EnvError::IoError(e) => write!(f, "IO error: {}", e),
EnvError::MissingSecureEnvSupport => {
write!(
f,
"Secure environment support is disabled (enable the 'secure-env' feature)"
)
}
#[cfg(feature = "secure-env")]
EnvError::DecryptionFailed(_) => write!(f, "decryption failed"),
#[cfg(feature = "secure-env")]
EnvError::MissingKeyFile => write!(f, "Missing key file for decryption"),
#[cfg(feature = "secure-env")]
EnvError::KeyFileFormatError(msg) => write!(f, "Key file format error: {}", msg),
}
}
}
impl Error for EnvError {
fn source(&self) -> Option<&(dyn Error + 'static)> {
match self {
EnvError::VarError(e) => Some(e),
EnvError::IoError(e) => Some(e),
_ => None,
}
}
}
pub fn get_var(name: &str) -> Result<String, EnvError> {
let val = env::var(name)?;
#[cfg(not(feature = "secure-env"))]
if is_encrypted(&val) {
return Err(EnvError::MissingSecureEnvSupport);
}
Ok(val)
}
pub fn get_var_or(name: &str, default: &str) -> Result<String, EnvError> {
match env::var(name) {
Ok(val) => {
#[cfg(not(feature = "secure-env"))]
if is_encrypted(&val) {
return Err(EnvError::MissingSecureEnvSupport);
}
Ok(val)
}
Err(env::VarError::NotPresent) => Ok(default.to_string()),
Err(e) => Err(EnvError::VarError(e)),
}
}
pub fn is_encrypted(value: &str) -> bool {
value.starts_with("+encs+")
}
#[cfg(test)]
mod tests {
use super::*;
use temp_env::with_var;
#[test]
fn test_get_env() {
with_var("TEST_VAR", Some("test_value"), || {
assert_eq!(get_var("TEST_VAR").unwrap(), "test_value");
assert_eq!(get_var_or("TEST_VAR", "default").unwrap(), "test_value");
});
with_var::<_, &str, _, _>("NON_EXISTENT_VAR", None, || {
assert!(get_var("NON_EXISTENT_VAR").is_err());
assert_eq!(
get_var_or("NON_EXISTENT_VAR", "default").unwrap(),
"default"
);
});
}
#[test]
fn test_is_encrypted() {
assert!(is_encrypted("+encs+1234567890ABCDEF"));
assert!(!is_encrypted("plain_text"));
assert!(!is_encrypted(""));
}
#[test]
fn test_is_encrypted_edge_cases() {
assert!(is_encrypted("+encs+"));
assert!(!is_encrypted("+encs"));
assert!(!is_encrypted("+enc+"));
assert!(!is_encrypted("+ENCS+1234"));
assert!(!is_encrypted("encs+1234"));
assert!(!is_encrypted(" +encs+1234"));
}
}