dugout 0.1.0

A local secrets manager for development teams, written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//! Secret type.
//!
//! Represents a single encrypted secret with its key and ciphertext.

use crate::core::types::{EncryptedValue, SecretKey};

/// An encrypted secret with its key name
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Secret {
    key: SecretKey,
    value: EncryptedValue,
}

impl Secret {
    /// Create a new secret from a key and encrypted value
    pub fn new(key: SecretKey, value: EncryptedValue) -> Self {
        Self { key, value }
    }

    /// Secret's key name
    pub fn key(&self) -> &str {
        &self.key
    }

    /// Encrypted ciphertext
    pub fn encrypted(&self) -> &str {
        &self.value
    }
}

impl std::fmt::Display for Secret {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.key)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_secret_new() {
        let secret = Secret::new("API_KEY".to_string(), "age-encryption-v1...".to_string());

        assert_eq!(secret.key(), "API_KEY");
        assert_eq!(secret.encrypted(), "age-encryption-v1...");
    }

    #[test]
    fn test_secret_display() {
        let secret = Secret::new("DATABASE_URL".to_string(), "encrypted_value".to_string());

        assert_eq!(format!("{}", secret), "DATABASE_URL");
    }
}