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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
use crate::config::Error;
use diem_secure_storage::{
GitHubStorage, InMemoryStorage, Namespaced, OnDiskStorage, Storage, VaultStorage,
};
use serde::{Deserialize, Serialize};
use std::{
fs::File,
io::Read,
path::{Path, PathBuf},
};
#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case", tag = "type")]
pub enum SecureBackend {
GitHub(GitHubConfig),
InMemoryStorage,
Vault(VaultConfig),
OnDiskStorage(OnDiskStorageConfig),
}
impl SecureBackend {
pub fn namespace(&self) -> Option<&str> {
match self {
SecureBackend::GitHub(GitHubConfig { namespace, .. })
| SecureBackend::Vault(VaultConfig { namespace, .. })
| SecureBackend::OnDiskStorage(OnDiskStorageConfig { namespace, .. }) => {
namespace.as_deref()
}
SecureBackend::InMemoryStorage => None,
}
}
pub fn clear_namespace(&mut self) {
match self {
SecureBackend::GitHub(GitHubConfig { namespace, .. })
| SecureBackend::Vault(VaultConfig { namespace, .. })
| SecureBackend::OnDiskStorage(OnDiskStorageConfig { namespace, .. }) => {
*namespace = None;
}
SecureBackend::InMemoryStorage => {}
}
}
}
#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct GitHubConfig {
pub repository_owner: String,
pub repository: String,
pub branch: Option<String>,
pub token: Token,
pub namespace: Option<String>,
}
#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct VaultConfig {
pub ca_certificate: Option<PathBuf>,
pub namespace: Option<String>,
pub renew_ttl_secs: Option<u32>,
pub server: String,
pub token: Token,
pub disable_cas: Option<bool>,
pub connection_timeout_ms: Option<u64>,
pub response_timeout_ms: Option<u64>,
}
impl VaultConfig {
pub fn ca_certificate(&self) -> Result<String, Error> {
let path = self
.ca_certificate
.as_ref()
.ok_or(Error::Missing("ca_certificate"))?;
read_file(path)
}
}
#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct OnDiskStorageConfig {
pub path: PathBuf,
pub namespace: Option<String>,
#[serde(skip)]
data_dir: PathBuf,
}
#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum Token {
FromConfig(String),
FromDisk(PathBuf),
}
impl Token {
pub fn read_token(&self) -> Result<String, Error> {
match self {
Token::FromDisk(path) => read_file(path),
Token::FromConfig(token) => Ok(token.clone()),
}
}
}
#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct TokenFromConfig {
token: String,
}
#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct TokenFromDisk {
path: PathBuf,
}
impl Default for OnDiskStorageConfig {
fn default() -> Self {
Self {
namespace: None,
path: PathBuf::from("secure_storage.json"),
data_dir: PathBuf::from("/opt/diem/data"),
}
}
}
impl OnDiskStorageConfig {
pub fn path(&self) -> PathBuf {
if self.path.is_relative() {
self.data_dir.join(&self.path)
} else {
self.path.clone()
}
}
pub fn set_data_dir(&mut self, data_dir: PathBuf) {
self.data_dir = data_dir;
}
}
fn read_file(path: &Path) -> Result<String, Error> {
let mut file =
File::open(path).map_err(|e| Error::IO(path.to_str().unwrap().to_string(), e))?;
let mut contents = String::new();
file.read_to_string(&mut contents)
.map_err(|e| Error::IO(path.to_str().unwrap().to_string(), e))?;
Ok(contents)
}
impl From<&SecureBackend> for Storage {
fn from(backend: &SecureBackend) -> Self {
match backend {
SecureBackend::GitHub(config) => {
let storage = Storage::from(GitHubStorage::new(
config.repository_owner.clone(),
config.repository.clone(),
config
.branch
.as_ref()
.cloned()
.unwrap_or_else(|| "master".to_string()),
config.token.read_token().expect("Unable to read token"),
));
if let Some(namespace) = &config.namespace {
Storage::from(Namespaced::new(namespace, Box::new(storage)))
} else {
storage
}
}
SecureBackend::InMemoryStorage => Storage::from(InMemoryStorage::new()),
SecureBackend::OnDiskStorage(config) => {
let storage = Storage::from(OnDiskStorage::new(config.path()));
if let Some(namespace) = &config.namespace {
Storage::from(Namespaced::new(namespace, Box::new(storage)))
} else {
storage
}
}
SecureBackend::Vault(config) => {
let storage = Storage::from(VaultStorage::new(
config.server.clone(),
config.token.read_token().expect("Unable to read token"),
config
.ca_certificate
.as_ref()
.map(|_| config.ca_certificate().unwrap()),
config.renew_ttl_secs,
config.disable_cas.map_or_else(|| true, |disable| !disable),
config.connection_timeout_ms,
config.response_timeout_ms,
));
if let Some(namespace) = &config.namespace {
Storage::from(Namespaced::new(namespace, Box::new(storage)))
} else {
storage
}
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::io::Write;
#[derive(Debug, Deserialize, PartialEq, Serialize)]
struct Config {
vault: VaultConfig,
}
#[test]
fn test_token_config_parsing() {
let from_config = Config {
vault: VaultConfig {
namespace: None,
server: "127.0.0.1:8200".to_string(),
ca_certificate: None,
token: Token::FromConfig("test".to_string()),
renew_ttl_secs: None,
disable_cas: None,
connection_timeout_ms: None,
response_timeout_ms: None,
},
};
let text_from_config = r#"
vault:
server: "127.0.0.1:8200"
token:
from_config: "test"
"#;
let de_from_config: Config = serde_yaml::from_str(text_from_config).unwrap();
assert_eq!(de_from_config, from_config);
serde_yaml::to_string(&from_config).unwrap();
}
#[test]
fn test_vault_timeout_parsing() {
let from_config = Config {
vault: VaultConfig {
namespace: None,
server: "127.0.0.1:8200".to_string(),
ca_certificate: None,
token: Token::FromConfig("test".to_string()),
renew_ttl_secs: None,
disable_cas: None,
connection_timeout_ms: Some(3000),
response_timeout_ms: Some(5000),
},
};
let text_from_config = r#"
vault:
server: "127.0.0.1:8200"
token:
from_config: "test"
connection_timeout_ms: 3000
response_timeout_ms: 5000
"#;
let de_from_config: Config = serde_yaml::from_str(text_from_config).unwrap();
assert_eq!(de_from_config, from_config);
serde_yaml::to_string(&from_config).unwrap();
}
#[test]
fn test_token_disk_parsing() {
let from_disk = Config {
vault: VaultConfig {
namespace: None,
server: "127.0.0.1:8200".to_string(),
ca_certificate: None,
token: Token::FromDisk(PathBuf::from("/token")),
renew_ttl_secs: None,
disable_cas: None,
connection_timeout_ms: None,
response_timeout_ms: None,
},
};
let text_from_disk = r#"
vault:
server: "127.0.0.1:8200"
token:
from_disk: "/token"
"#;
let de_from_disk: Config = serde_yaml::from_str(text_from_disk).unwrap();
assert_eq!(de_from_disk, from_disk);
serde_yaml::to_string(&from_disk).unwrap();
}
#[test]
fn test_token_reading() {
let temppath = diem_temppath::TempPath::new();
temppath.create_as_file().unwrap();
let mut file = File::create(temppath.path()).unwrap();
file.write_all(b"disk_token").unwrap();
let disk = Token::FromDisk(temppath.path().to_path_buf());
assert_eq!("disk_token", disk.read_token().unwrap());
let config = Token::FromConfig("config_token".to_string());
assert_eq!("config_token", config.read_token().unwrap());
}
}