secretspec 0.9.1

Declarative secrets, every environment, any provider
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
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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
//! Secret value generation
//!
//! This module provides generation of secret values based on type and configuration.
//! Supported types: password, hex, base64, uuid, command, rsa_private_key.

use crate::SecretSpecError;
use crate::config::GenerateConfig;
use data_encoding::{BASE64, HEXLOWER};
use rand::Rng;
use rsa::RsaPrivateKey;
use rsa::pkcs1::EncodeRsaPrivateKey;
use secrecy::SecretString;

/// Generate a secret value based on the secret type and generation config.
pub fn generate(secret_type: &str, config: &GenerateConfig) -> crate::Result<SecretString> {
    match secret_type {
        "password" => generate_password(config),
        "hex" => generate_hex(config),
        "base64" => generate_base64(config),
        "uuid" => generate_uuid(),
        "command" => generate_from_command(config),
        "rsa_private_key" => generate_rsa(config),
        unknown => Err(SecretSpecError::GenerationFailed(format!(
            "unknown secret type '{}'",
            unknown
        ))),
    }
}

fn generate_password(config: &GenerateConfig) -> crate::Result<SecretString> {
    let (length, charset_name) = match config {
        GenerateConfig::Bool(_) => (32, "alphanumeric"),
        GenerateConfig::Options(opts) => (
            opts.length.unwrap_or(32),
            opts.charset.as_deref().unwrap_or("alphanumeric"),
        ),
    };

    let charset: Vec<u8> = match charset_name {
        "alphanumeric" => {
            let mut chars = Vec::new();
            chars.extend(b'a'..=b'z');
            chars.extend(b'A'..=b'Z');
            chars.extend(b'0'..=b'9');
            chars
        }
        "ascii" => (33u8..=126).collect(),
        unknown => {
            return Err(SecretSpecError::GenerationFailed(format!(
                "unknown charset '{}', expected 'alphanumeric' or 'ascii'",
                unknown
            )));
        }
    };

    if charset.is_empty() {
        return Err(SecretSpecError::GenerationFailed(
            "charset is empty".to_string(),
        ));
    }

    let mut rng = rand::rng();
    let password: String = (0..length)
        .map(|_| {
            let idx = rng.random_range(0..charset.len());
            charset[idx] as char
        })
        .collect();

    Ok(SecretString::new(password.into()))
}

fn generate_hex(config: &GenerateConfig) -> crate::Result<SecretString> {
    let bytes = match config {
        GenerateConfig::Bool(_) => 32,
        GenerateConfig::Options(opts) => opts.bytes.unwrap_or(32),
    };

    let mut rng = rand::rng();
    let random_bytes: Vec<u8> = (0..bytes).map(|_| rng.random::<u8>()).collect();
    let hex = HEXLOWER.encode(&random_bytes);

    Ok(SecretString::new(hex.into()))
}

fn generate_base64(config: &GenerateConfig) -> crate::Result<SecretString> {
    let bytes = match config {
        GenerateConfig::Bool(_) => 32,
        GenerateConfig::Options(opts) => opts.bytes.unwrap_or(32),
    };

    let mut rng = rand::rng();
    let random_bytes: Vec<u8> = (0..bytes).map(|_| rng.random::<u8>()).collect();
    let encoded = BASE64.encode(&random_bytes);

    Ok(SecretString::new(encoded.into()))
}

fn generate_uuid() -> crate::Result<SecretString> {
    let id = uuid::Uuid::new_v4().to_string();
    Ok(SecretString::new(id.into()))
}

fn generate_rsa(config: &GenerateConfig) -> crate::Result<SecretString> {
    let bits = match config {
        GenerateConfig::Bool(_) => 2048,
        GenerateConfig::Options(opts) => opts.bits.unwrap_or(2048),
    };

    let private_key = RsaPrivateKey::new(&mut rsa::rand_core::OsRng, bits).map_err(|e| {
        SecretSpecError::GenerationFailed(format!("failed to generate RSA key: {}", e))
    })?;

    let pem = private_key
        .to_pkcs1_pem(rsa::pkcs1::LineEnding::LF)
        .map_err(|e| {
            SecretSpecError::GenerationFailed(format!("failed to encode RSA key as PEM: {}", e))
        })?;

    Ok(SecretString::new(pem.to_string().into()))
}

fn generate_from_command(config: &GenerateConfig) -> crate::Result<SecretString> {
    let command = match config {
        GenerateConfig::Bool(_) => {
            return Err(SecretSpecError::GenerationFailed(
                "type = \"command\" requires generate = { command = \"...\" }".to_string(),
            ));
        }
        GenerateConfig::Options(opts) => opts.command.as_deref().ok_or_else(|| {
            SecretSpecError::GenerationFailed(
                "type = \"command\" requires generate = { command = \"...\" }".to_string(),
            )
        })?,
    };

    let output = std::process::Command::new("sh")
        .arg("-c")
        .arg(command)
        .output()
        .map_err(|e| {
            SecretSpecError::GenerationFailed(format!(
                "failed to execute command '{}': {}",
                command, e
            ))
        })?;

    if !output.status.success() {
        let stderr = String::from_utf8_lossy(&output.stderr);
        return Err(SecretSpecError::GenerationFailed(format!(
            "command '{}' failed with exit code {}: {}",
            command,
            output.status.code().unwrap_or(-1),
            stderr.trim()
        )));
    }

    let stdout = String::from_utf8(output.stdout).map_err(|_| {
        SecretSpecError::GenerationFailed(format!(
            "command '{}' produced non-UTF-8 output",
            command
        ))
    })?;

    let trimmed = stdout.trim();
    if trimmed.is_empty() {
        return Err(SecretSpecError::GenerationFailed(format!(
            "command '{}' produced empty output",
            command
        )));
    }

    Ok(SecretString::new(trimmed.to_string().into()))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::GenerateOptions;
    use secrecy::ExposeSecret;

    #[test]
    fn test_generate_password_default() {
        let value = generate("password", &GenerateConfig::Bool(true)).unwrap();
        let s = value.expose_secret();
        assert_eq!(s.len(), 32);
        assert!(s.chars().all(|c| c.is_alphanumeric()));
    }

    #[test]
    fn test_generate_password_custom_length() {
        let config = GenerateConfig::Options(GenerateOptions {
            length: Some(64),
            ..Default::default()
        });
        let value = generate("password", &config).unwrap();
        assert_eq!(value.expose_secret().len(), 64);
    }

    #[test]
    fn test_generate_password_ascii_charset() {
        let config = GenerateConfig::Options(GenerateOptions {
            length: Some(100),
            charset: Some("ascii".to_string()),
            ..Default::default()
        });
        let value = generate("password", &config).unwrap();
        let s = value.expose_secret();
        assert_eq!(s.len(), 100);
        assert!(s.bytes().all(|b| (33..=126).contains(&b)));
    }

    #[test]
    fn test_generate_password_unknown_charset() {
        let config = GenerateConfig::Options(GenerateOptions {
            charset: Some("emoji".to_string()),
            ..Default::default()
        });
        let result = generate("password", &config);
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("unknown charset"));
    }

    #[test]
    fn test_generate_password_zero_length() {
        let config = GenerateConfig::Options(GenerateOptions {
            length: Some(0),
            ..Default::default()
        });
        let value = generate("password", &config).unwrap();
        assert_eq!(value.expose_secret().len(), 0);
    }

    #[test]
    fn test_generate_password_large_length() {
        let config = GenerateConfig::Options(GenerateOptions {
            length: Some(10000),
            ..Default::default()
        });
        let value = generate("password", &config).unwrap();
        assert_eq!(value.expose_secret().len(), 10000);
    }

    #[test]
    fn test_generate_hex_default() {
        let value = generate("hex", &GenerateConfig::Bool(true)).unwrap();
        let s = value.expose_secret();
        // 32 bytes = 64 hex chars
        assert_eq!(s.len(), 64);
        assert!(s.chars().all(|c| c.is_ascii_hexdigit()));
    }

    #[test]
    fn test_generate_hex_custom_bytes() {
        let config = GenerateConfig::Options(GenerateOptions {
            bytes: Some(16),
            ..Default::default()
        });
        let value = generate("hex", &config).unwrap();
        assert_eq!(value.expose_secret().len(), 32);
    }

    #[test]
    fn test_generate_hex_zero_bytes() {
        let config = GenerateConfig::Options(GenerateOptions {
            bytes: Some(0),
            ..Default::default()
        });
        let value = generate("hex", &config).unwrap();
        assert_eq!(value.expose_secret().len(), 0);
    }

    #[test]
    fn test_generate_base64_default() {
        let value = generate("base64", &GenerateConfig::Bool(true)).unwrap();
        let s = value.expose_secret();
        // 32 bytes base64 encoded = 44 chars (with padding)
        assert_eq!(s.len(), 44);
        assert!(
            s.chars()
                .all(|c| c.is_alphanumeric() || c == '+' || c == '/' || c == '=')
        );
    }

    #[test]
    fn test_generate_base64_custom_bytes() {
        let config = GenerateConfig::Options(GenerateOptions {
            bytes: Some(64),
            ..Default::default()
        });
        let value = generate("base64", &config).unwrap();
        // 64 bytes = 88 chars base64
        assert_eq!(value.expose_secret().len(), 88);
    }

    #[test]
    fn test_generate_uuid() {
        let value = generate("uuid", &GenerateConfig::Bool(true)).unwrap();
        let s = value.expose_secret();
        // UUID v4 format: 8-4-4-4-12 = 36 chars
        assert_eq!(s.len(), 36);
        let parts: Vec<&str> = s.split('-').collect();
        assert_eq!(parts.len(), 5);
        assert_eq!(parts[0].len(), 8);
        assert_eq!(parts[1].len(), 4);
        assert_eq!(parts[2].len(), 4);
        assert_eq!(parts[3].len(), 4);
        assert_eq!(parts[4].len(), 12);
        // Version nibble = 4
        assert!(parts[2].starts_with('4'));
    }

    #[test]
    fn test_generate_command() {
        let config = GenerateConfig::Options(GenerateOptions {
            command: Some("echo hello".to_string()),
            ..Default::default()
        });
        let value = generate("command", &config).unwrap();
        assert_eq!(value.expose_secret(), "hello");
    }

    #[test]
    fn test_generate_command_failing() {
        let config = GenerateConfig::Options(GenerateOptions {
            command: Some("false".to_string()),
            ..Default::default()
        });
        let result = generate("command", &config);
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("failed with exit code")
        );
    }

    #[test]
    fn test_generate_command_empty_output() {
        let config = GenerateConfig::Options(GenerateOptions {
            command: Some("echo -n ''".to_string()),
            ..Default::default()
        });
        let result = generate("command", &config);
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("empty output"));
    }

    #[test]
    fn test_generate_command_not_found() {
        let config = GenerateConfig::Options(GenerateOptions {
            command: Some("nonexistent_command_xyz_12345".to_string()),
            ..Default::default()
        });
        let result = generate("command", &config);
        assert!(result.is_err());
    }

    #[test]
    fn test_generate_command_bool_config_fails() {
        let result = generate("command", &GenerateConfig::Bool(true));
        assert!(result.is_err());
    }

    #[test]
    fn test_generate_rsa_default() {
        let value = generate("rsa_private_key", &GenerateConfig::Bool(true)).unwrap();
        let s = value.expose_secret();
        assert!(s.starts_with("-----BEGIN RSA PRIVATE KEY-----"));
        assert!(s.trim().ends_with("-----END RSA PRIVATE KEY-----"));
    }

    #[test]
    fn test_generate_rsa_custom_bits() {
        let config = GenerateConfig::Options(GenerateOptions {
            bits: Some(4096),
            ..Default::default()
        });
        let value = generate("rsa_private_key", &config).unwrap();
        let s = value.expose_secret();
        assert!(s.starts_with("-----BEGIN RSA PRIVATE KEY-----"));
        // 4096-bit key PEM is longer than 2048-bit
        assert!(s.len() > 1700);
    }

    #[test]
    fn test_generate_rsa_uniqueness() {
        let v1 = generate("rsa_private_key", &GenerateConfig::Bool(true)).unwrap();
        let v2 = generate("rsa_private_key", &GenerateConfig::Bool(true)).unwrap();
        assert_ne!(v1.expose_secret(), v2.expose_secret());
    }

    #[test]
    fn test_generate_unknown_type() {
        let result = generate("unknown_type", &GenerateConfig::Bool(true));
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("unknown secret type")
        );
    }

    #[test]
    fn test_generate_uniqueness() {
        let v1 = generate("password", &GenerateConfig::Bool(true)).unwrap();
        let v2 = generate("password", &GenerateConfig::Bool(true)).unwrap();
        assert_ne!(v1.expose_secret(), v2.expose_secret());
    }
}