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

use super::{MemSize, Secret, SecretError, SecretSource};
use crate::path::{AbsolutePath, CanonicalPath};
use std::borrow::Cow;
use std::path::Path;

/// Representation of a secret file, which contains secret references
/// and is intended to be materialized to a specific destination path.
#[derive(Debug, Clone)]
pub struct SecretFile {
    source: SecretSource,
    dest: AbsolutePath,
    max_size: MemSize,
}

impl SecretFile {
    pub fn from_file(
        src: CanonicalPath,
        dest: AbsolutePath,
        max_size: MemSize,
    ) -> Result<Self, SecretError> {
        Ok(Self {
            source: SecretSource::File(src),
            dest,
            max_size,
        })
    }
    pub fn from_template(label: String, template: String, root: &AbsolutePath) -> Self {
        let safe_name = sanitize_filename::sanitize(&label);
        let dest = root.join(safe_name);
        Self {
            source: SecretSource::literal(label, template),
            dest,
            max_size: MemSize::MAX,
        }
    }
    pub fn from_secret(
        secret: Secret,
        root: &AbsolutePath,
        max_size: MemSize,
    ) -> Result<Self, SecretError> {
        let (key, source) = match secret {
            Secret::Named { key, source } => (key, source),
            Secret::Anonymous(source) => {
                let path = source.path().ok_or_else(|| {
                    SecretError::Parse(
                        "Cannot derive SecretFile from anonymous literal secret".to_string(),
                    )
                })?;

                let filename = path.file_name().and_then(|s| s.to_str()).ok_or_else(|| {
                    SecretError::Parse(format!(
                        "Could not derive a valid filename from path: {:?}",
                        path
                    ))
                })?;

                (filename.to_string().try_into()?, source)
            }
        };

        let safe_name = sanitize_filename::sanitize(&key);
        let dest = root.join(safe_name);

        Ok(Self {
            source,
            dest,
            max_size,
        })
    }

    pub fn dest(&self) -> &AbsolutePath {
        &self.dest
    }

    pub fn source(&self) -> &SecretSource {
        &self.source
    }

    pub fn content(&self) -> Result<Cow<'_, str>, SecretError> {
        self.source
            .read()
            .limit(self.max_size)
            .fetch()?
            .ok_or_else(|| {
                let path = self
                    .source
                    .path()
                    .map(|p| p.as_ref())
                    .unwrap_or_else(|| Path::new("<unknown>"));
                SecretError::SourceMissing(path.to_path_buf())
            })
    }
}