locket 0.17.3

Helper tool for secret injection as a process dependency
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! Defines secret reference types and parsing logic for each supported provider.
use std::str::FromStr;
use thiserror::Error;

#[cfg(feature = "bws")]
mod bws;
#[cfg(feature = "infisical")]
mod infisical;
#[cfg(any(feature = "op", feature = "connect"))]
mod op;
#[cfg(feature = "bws")]
pub use bws::BwsReference;
#[cfg(feature = "infisical")]
pub use infisical::{
    InfisicalParseError, InfisicalPath, InfisicalProjectId, InfisicalReference,
    InfisicalSecretType, InfisicalSlug,
};
#[cfg(any(feature = "op", feature = "connect"))]
pub use op::{OpParseError, OpReference};

/// Errors that can occur when parsing a specific Secret Reference string.
#[derive(Debug, Error)]
pub enum ReferenceParseError {
    #[error("unknown or invalid secret format: {0}")]
    UnknownFormat(String),

    #[cfg(any(feature = "op", feature = "connect"))]
    #[error(transparent)]
    Op(#[from] OpParseError),

    #[cfg(feature = "bws")]
    #[error("invalid BWS UUID: {0}")]
    Bws(#[from] uuid::Error),

    #[cfg(feature = "infisical")]
    #[error(transparent)]
    Infisical(#[from] InfisicalParseError),
}

/// A parsed reference to a secret.
///
/// This enum represents a valid pointer to a secret. It guarantees that the
/// syntax matches the requirements of the specific provider.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum SecretReference {
    #[cfg(any(feature = "op", feature = "connect"))]
    /// A 1Password reference
    OnePassword(OpReference),

    #[cfg(feature = "bws")]
    /// A Bitwarden Secrets Manager reference (UUID)
    Bws(BwsReference),

    #[cfg(feature = "infisical")]
    /// An Infisical reference
    Infisical(InfisicalReference),

    #[cfg(any(test, doctest, feature = "testing"))]
    /// A mock reference for testing purposes
    Mock(String),
}

/// Defines the strict syntax rules for a specific reference type.
///
/// This trait is a static factory that attempts to construct a concrete type (Self)
/// from a raw string. It should contain the regex, prefix checking, or validation
/// logic specific to a single provider
pub trait ReferenceSyntax: Sized {
    fn try_parse(raw: &str) -> Option<Self>;
}

/// A runtime interface for providers or configurations that can detect secret references.
///
/// Unlike `ReferenceSyntax`, which is specific to a concrete type, this trait
/// returns the unified `SecretReference`.
pub trait ReferenceParser: Send + Sync {
    fn parse(&self, raw: &str) -> Option<SecretReference>;
}

/// Downcasting trait which defines how to safely extract a concrete reference type from the generic `SecretReference` enum.
pub trait Extract: Sized {
    fn extract(r: &SecretReference) -> Option<&Self>;
}

/// Links a provider to its specific reference implementation.
pub trait HasReference {
    type Reference: ReferenceSyntax + Into<SecretReference> + Extract;
}

/// Blanket implementation for `ReferenceParser` that implements the `HasReference` trait.
impl<T> ReferenceParser for T
where
    T: HasReference + Send + Sync,
{
    fn parse(&self, raw: &str) -> Option<SecretReference> {
        let parsed = T::Reference::try_parse(raw)?;
        Some(parsed.into())
    }
}

impl std::fmt::Display for SecretReference {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            #[cfg(any(feature = "op", feature = "connect"))]
            Self::OnePassword(reference) => write!(f, "{}", reference),

            #[cfg(feature = "bws")]
            Self::Bws(reference) => write!(f, "{}", reference),

            #[cfg(feature = "infisical")]
            Self::Infisical(reference) => write!(f, "{}", reference),

            #[cfg(any(test, doctest, feature = "testing"))]
            Self::Mock(reference) => write!(f, "{}", reference),
        }
    }
}

impl FromStr for SecretReference {
    type Err = ReferenceParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        // Check 1Password
        #[cfg(any(feature = "op", feature = "connect"))]
        if s.starts_with("op://") {
            let op_ref = OpReference::from_str(s)?;
            return Ok(Self::OnePassword(op_ref));
        }

        // Check Infisical
        #[cfg(feature = "infisical")]
        if s.starts_with("infisical://") {
            let infisical_ref = InfisicalReference::from_str(s)?;
            return Ok(Self::Infisical(infisical_ref));
        }

        // Check BWS
        #[cfg(feature = "bws")]
        if let Ok(bws_ref) = BwsReference::from_str(s) {
            return Ok(Self::Bws(bws_ref));
        }

        // Fallback
        Err(ReferenceParseError::UnknownFormat(s.to_string()))
    }
}

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

    #[test]
    fn test_parse_invalid() {
        assert!(SecretReference::from_str("not-a-secret").is_err());
    }
}