keyring-core 1.0.0

Cross-platform library for managing passwords/secrets
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

/*!

Utility functions for attribute maps

 */
use std::collections::HashMap;

use crate::{Error::Invalid, Result};

/// Parse an optional key-value &str map for allowed keys, returning a map of owned strings.
///
/// If a key is prefixed with a `*`, it is required to have a boolean value,
/// and the `*` is stripped from the key name when parsing and returning the map.
///
/// If a key is prefixed with a `+`, it is required to have a non-empty value,
/// and the `+` is stripped from the key name when parsing and returning the map.
///
/// Returns an [Invalid] error if not all keys are allowed, or if one of the keys
/// marked as boolean has a value other than `true` or `false`.
pub fn parse_attributes(
    keys: &[&str],
    attrs: Option<&HashMap<&str, &str>>,
) -> Result<HashMap<String, String>> {
    let mut result: HashMap<String, String> = HashMap::new();
    if attrs.is_none() {
        return Ok(result);
    }
    let key_map: HashMap<String, char> = keys
        .iter()
        .map(|k| {
            if k.starts_with("*") {
                (k.split_at(1).1.to_string(), '*')
            } else if k.starts_with("+") {
                (k.split_at(1).1.to_string(), '+')
            } else {
                (k.to_string(), ' ')
            }
        })
        .collect();
    for (key, value) in attrs.unwrap() {
        if let Some(prefix) = key_map.get(*key) {
            match *prefix {
                '*' if *value != "true" && *value != "false" => {
                    let msg = "must be 'true' or 'false'";
                    return Err(Invalid(key.to_string(), msg.to_string()));
                }
                '+' if value.is_empty() => {
                    let msg = "must not be empty";
                    return Err(Invalid(key.to_string(), msg.to_string()));
                }
                _ => {}
            }
            result.insert(key.to_string(), value.to_string());
        } else {
            return Err(Invalid(key.to_string(), "unknown key".to_string()));
        }
    }
    Ok(result)
}

/// Convert a borrowed key-value map of borrowed strings to an owned map of owned strings.
pub fn externalize_attributes(attrs: &HashMap<&str, &str>) -> HashMap<String, String> {
    attrs
        .iter()
        .map(|(k, v)| (k.to_string(), v.to_string()))
        .collect()
}

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

    #[test]
    fn test_parse_attributes() {
        let attrs = HashMap::from([("key1", "value1"), ("key2", "true"), ("key3", "false")]);
        assert_eq!(parse_attributes(&["key1"], None).unwrap().len(), 0);
        assert_eq!(
            parse_attributes(&["key1", "key2", "key3"], Some(&attrs))
                .unwrap()
                .len(),
            3
        );
        let parsed = parse_attributes(&["+key1", "*key2", "*key3"], Some(&attrs)).unwrap();
        assert_eq!(parsed.len(), 3);
        assert_eq!(parsed.get("key1"), Some(&"value1".to_string()));
        assert_eq!(parsed.get("key2"), Some(&"true".to_string()));
        assert_eq!(parsed.get("key3"), Some(&"false".to_string()));
        let bad_attrs = HashMap::from([("key1", "t")]);
        match parse_attributes(&["*key1"], Some(&bad_attrs)) {
            Err(Invalid(key, msg)) => {
                assert_eq!(key, "key1");
                assert_eq!(msg, "must be 'true' or 'false'");
            }
            _ => panic!("Incorrect error for invalid boolean attribute"),
        }
        let bad_attrs = HashMap::from([("key1", "")]);
        match parse_attributes(&["+key1"], Some(&bad_attrs)) {
            Err(Invalid(key, msg)) => {
                assert_eq!(key, "key1");
                assert_eq!(msg, "must not be empty");
            }
            _ => panic!("Incorrect error for empty string attribute"),
        }
        match parse_attributes(&["other_key"], Some(&bad_attrs)) {
            Err(Invalid(key, msg)) => {
                assert_eq!(key, "key1");
                assert_eq!(msg, "unknown key");
            }
            _ => panic!("Incorrect error for unknown attribute"),
        }
    }

    #[test]
    fn test_externalize_attributes() {
        let attrs = HashMap::from([("key1", "value1"), ("key2", "true"), ("key3", "false")]);
        let externalized = externalize_attributes(&attrs);
        assert_eq!(externalized.len(), 3);
        assert_eq!(externalized.get("key1"), Some(&"value1".to_string()));
        assert_eq!(externalized.get("key2"), Some(&"true".to_string()));
        assert_eq!(externalized.get("key3"), Some(&"false".to_string()));
    }
}