encrypt_config 2.0.1

A Rust crate to manage, persist and encrypt your configurations.
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

//! Source module for the encrypt-config crate.

#[cfg(feature = "secret")]
use crate::encrypt_utils::Encrypter;
#[cfg(feature = "persist")]
use serde::{de::DeserializeOwned, Serialize};
#[cfg(feature = "persist")]
use std::path::PathBuf;

pub use rom_cache::Cacheable;

/// Normal source trait.
pub trait NormalSource: rom_cache::Cacheable {}

/// Persist source trait.
#[cfg(feature = "persist")]
pub trait PersistSource: rom_cache::Cacheable + Serialize + DeserializeOwned {
    /// Path for the persist source.
    #[cfg(not(feature = "default_config_dir"))]
    const PATH: &'static str;
    /// Name for the persist source.
    #[cfg(feature = "default_config_dir")]
    const NAME: &'static str;

    /// Path for the persist source.
    fn path() -> PathBuf {
        #[cfg(not(feature = "default_config_dir"))]
        {
            PathBuf::from(Self::PATH)
        }
        #[cfg(feature = "default_config_dir")]
        {
            dirs::config_dir()
                .expect("Default config dir unknown in your OS.")
                .join(Self::NAME)
        }
    }
    /// Load the persist source.
    fn load() -> std::io::Result<Self> {
        let path = Self::path();
        let file = std::fs::File::open(path)?;
        Ok(serde_json::from_reader(file)?)
    }
    /// Save the persist source.
    fn store(&self) -> std::io::Result<()> {
        let path = Self::path();
        let parent = path.parent().unwrap();
        std::fs::create_dir_all(parent)?;
        let file = std::fs::File::create(path)?;
        serde_json::to_writer(file, self)?;
        Ok(())
    }
}

/// Secret source trait.
#[cfg(feature = "secret")]
pub trait SecretSource: rom_cache::Cacheable + Serialize + DeserializeOwned {
    /// Path for the persist source.
    #[cfg(not(feature = "default_config_dir"))]
    const PATH: &'static str;
    /// Name for the persist source.
    #[cfg(feature = "default_config_dir")]
    const NAME: &'static str;
    /// Keyring entry for the secret source.
    const KEYRING_ENTRY: &'static str;

    /// Path for the persist source.
    fn path() -> PathBuf {
        #[cfg(not(feature = "default_config_dir"))]
        {
            PathBuf::from(Self::PATH)
        }
        #[cfg(feature = "default_config_dir")]
        {
            dirs::config_dir()
                .expect("Default config dir unknown in your OS.")
                .join(Self::NAME)
        }
    }
    /// Load the secret source.
    fn load() -> ::std::io::Result<Self> {
        let path = Self::path();
        let encrypter =
            Encrypter::new(Self::KEYRING_ENTRY).map_err(|_| std::io::ErrorKind::InvalidData)?;
        let file = std::fs::File::open(path)?;
        let encrypted: Vec<u8> = std::io::Read::bytes(file).collect::<Result<_, _>>()?;
        encrypter
            .decrypt(&encrypted)
            .map_err(|_| std::io::ErrorKind::InvalidData.into())
    }
    /// Save the secret source.
    fn store(&self) -> ::std::io::Result<()> {
        use std::io::Write as _;

        let path = Self::path();
        let parent = path.parent().unwrap();
        std::fs::create_dir_all(parent)?;
        let encrypter =
            Encrypter::new(Self::KEYRING_ENTRY).map_err(|_| std::io::ErrorKind::InvalidData)?;
        let encrypted = encrypter
            .encrypt(self)
            .map_err(|_| std::io::ErrorKind::InvalidData)?;
        let mut file = std::fs::File::create(path)?;
        file.write_all(&encrypted)?;
        file.flush()?;
        Ok(())
    }
}