secretspec-ipc 0.21.1

Independent Rust implementation of the SecretSpec IPC protocols
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

//! Opaque, non-secret revision metadata (0.21+).

use crate::error::{Error, Result};
use serde::{Deserialize, Deserializer, Serialize};

/// A provider-defined identity and generation token, or a resolver-derived
/// token for the logical value. Equality is meaningful; ordering is not.
///
/// Providers must derive this only from non-secret identity/version metadata
/// associated with the returned value, never from secret bytes or lease handles.
/// Syntax validation cannot establish that an endpoint honored this contract.
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(transparent)]
pub struct Revision(String);

impl Revision {
    /// Accept a bounded ASCII token without echoing rejected input.
    pub fn new(value: String) -> Result<Self> {
        if value.is_empty()
            || value.len() > 256
            || !value
                .bytes()
                .all(|b| b.is_ascii_alphanumeric() || b"._:-".contains(&b))
        {
            return Err(Error::Protocol("invalid revision token"));
        }
        Ok(Self(value))
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl<'de> Deserialize<'de> for Revision {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> std::result::Result<Self, D::Error> {
        // Avoid Serde's string visitor diagnostics, which can echo a wrong-type
        // input. Even malformed metadata must not appear in error messages.
        let value = serde_json::Value::deserialize(deserializer)?;
        match value {
            serde_json::Value::String(value) => {
                Self::new(value).map_err(|_| serde::de::Error::custom("invalid revision token"))
            }
            _ => Err(serde::de::Error::custom("invalid revision token")),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::protocol::{provider, resolver};
    use serde_json::json;

    #[test]
    fn revisions_are_optional_on_old_single_batch_and_resolver_results() {
        for revision in [None, Some(json!(null)), Some(json!("provider:version-1"))] {
            let expected = revision.as_ref().and_then(|v| v.as_str());
            let mut found = json!({"status":"found", "value":"value", "expires_at_unix_ms":null});
            if let Some(revision) = &revision {
                found["revision"] = revision.clone();
            }
            let single: provider::GetResult = serde_json::from_value(found.clone()).unwrap();
            let provider::GetResult::Found {
                revision: ref actual,
                ..
            } = single
            else {
                panic!()
            };
            assert_eq!(actual.as_ref().map(Revision::as_str), expected);
            found["name"] = json!("TOKEN");
            let batch: provider::NamedGetResult = serde_json::from_value(found).unwrap();
            assert_eq!(batch.outcome, single);
            for representation in ["value", "path"] {
                let mut resolved = json!({"status":"resolved", "representation":representation,
                    "value":"value", "path":"/tmp/value", "path_lease_id":"lease",
                    "source":"provider", "expires_at_unix_ms":null, "refresh_at_unix_ms":null});
                if let Some(revision) = &revision {
                    resolved["revision"] = revision.clone();
                }
                let result: resolver::GetResult = serde_json::from_value(resolved).unwrap();
                let actual = match result {
                    resolver::GetResult::Value(v) => v.revision,
                    resolver::GetResult::Path(v) => v.revision,
                    _ => panic!(),
                };
                assert_eq!(actual.as_ref().map(Revision::as_str), expected);
            }
        }
    }

    #[test]
    fn malformed_revision_diagnostics_do_not_echo_input() {
        for bad in [
            json!("CANARY/secret"),
            json!({"CANARY":"secret"}),
            json!(""),
            json!("x".repeat(257)),
            json!("é"),
        ] {
            let error = serde_json::from_value::<Revision>(bad)
                .unwrap_err()
                .to_string();
            assert_eq!(error, "invalid revision token");
        }
    }
}