secpar 0.3.0

A tool that leverages AWS Rust SDK for Secrets Manager & Parameter Store
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
413
414
415
416
417
418
419
420
use crate::errors::{SecParError, format_sdk_error};
use crate::opt::{GlobalOpts, SecCommand};
use crate::specs::SecretsSpec;
use crate::ui::{
    build_secrets_table, confirm_action, confirm_delete, new_spinner, print_aborted,
    print_env_context, print_info, print_success, print_value, select_from_list,
};
use aws_sdk_secretsmanager::Client;
use color_eyre::Result;
use tracing::debug;
use uuid::Uuid;

/// Returns a list of all secrets as `(name, arn, last_changed)` tuples.
///
/// # Arguments
///
/// * `client` - An initialised Secrets Manager [`Client`].
///
/// # Returns
///
/// A `Vec` of `(name, arn, last_changed)` tuples where each field falls back
/// to `"unknown"` / `""` when the AWS response omits it.
///
/// # Errors
///
/// Returns [`SecParError::AwsSdk`] if the AWS `list_secrets` call fails.
///
/// # Examples
///
/// ```no_run
/// use aws_sdk_secretsmanager::Client;
/// use secpar::cli::sec::list_secrets;
/// # async fn run(client: &Client) -> Result<(), secpar::errors::SecParError> {
/// let rows = list_secrets(client).await?;
/// for (name, arn, last_changed) in &rows {
///     println!("{name}  {arn}  {last_changed}");
/// }
/// # Ok(())
/// # }
/// ```
pub async fn list_secrets(client: &Client) -> Result<Vec<(String, String, String)>, SecParError> {
    match client.list_secrets().send().await {
        Ok(output) => {
            let rows = output
                .secret_list()
                .iter()
                .map(|s| {
                    let name = s.name().unwrap_or("unknown").to_owned();
                    let arn = s.arn().unwrap_or("").to_owned();
                    let last_changed = s
                        .last_changed_date()
                        .map(|d| d.to_string())
                        .unwrap_or_default();
                    (name, arn, last_changed)
                })
                .collect();
            Ok(rows)
        }
        Err(e) => {
            debug!("Error: {:?}", e.to_string());
            Err(SecParError::AwsSdk(format_sdk_error(&e)))
        }
    }
}

/// Describes a secret and prints its full details.
///
/// # Arguments
///
/// * `client` - An initialised Secrets Manager [`Client`].
/// * `name` - The secret name or ARN.
///
/// # Errors
///
/// Returns [`SecParError::AwsSdk`] if the AWS `describe_secret` call fails.
///
/// # Examples
///
/// ```no_run
/// use aws_sdk_secretsmanager::Client;
/// use secpar::cli::sec::describe_secret;
/// # async fn run(client: &Client) -> Result<(), secpar::errors::SecParError> {
/// describe_secret(client, "my-secret").await?;
/// # Ok(())
/// # }
/// ```
pub async fn describe_secret(client: &Client, name: &str) -> Result<(), SecParError> {
    match client.describe_secret().secret_id(name).send().await {
        Ok(output) => {
            println!("ℹ️  Secret details");
            println!("  Name          : {}", output.name().unwrap_or("-"));
            println!("  ARN           : {}", output.arn().unwrap_or("-"));
            println!("  Description   : {}", output.description().unwrap_or("-"));
            println!(
                "  Last Changed  : {}",
                output
                    .last_changed_date()
                    .map(|d| d.to_string())
                    .as_deref()
                    .unwrap_or("-")
            );
            println!(
                "  Last Accessed : {}",
                output
                    .last_accessed_date()
                    .map(|d| d.to_string())
                    .as_deref()
                    .unwrap_or("-")
            );
            println!(
                "  Rotation      : {}",
                if output.rotation_enabled().unwrap_or(false) {
                    "enabled"
                } else {
                    "disabled"
                }
            );
            Ok(())
        }
        Err(e) => {
            debug!("Error: {:?}", e.to_string());
            Err(SecParError::AwsSdk(format_sdk_error(&e)))
        }
    }
}

/// Deletes the specified secret.
///
/// # Arguments
///
/// * `client` - An initialised Secrets Manager [`Client`].
/// * `name` - The secret name or ARN.
/// * `force` - When `true`, sets `force_delete_without_recovery` to bypass the
///   7-day recovery window and delete immediately.
///
/// # Errors
///
/// Returns [`SecParError::AwsSdk`] if the AWS `delete_secret` call fails.
///
/// # Examples
///
/// ```no_run
/// use aws_sdk_secretsmanager::Client;
/// use secpar::cli::sec::delete_secret;
/// # async fn run(client: &Client) -> Result<(), secpar::errors::SecParError> {
/// delete_secret(client, "my-secret", false).await?;
/// delete_secret(client, "my-secret", true).await?; // immediate, no recovery window
/// # Ok(())
/// # }
/// ```
pub async fn delete_secret(client: &Client, name: &str, force: bool) -> Result<(), SecParError> {
    match client
        .delete_secret()
        .secret_id(name)
        .force_delete_without_recovery(force)
        .send()
        .await
    {
        Ok(_) => Ok(()),
        Err(e) => {
            debug!("Error: {:?}", e.to_string());
            Err(SecParError::AwsSdk(format_sdk_error(&e)))
        }
    }
}

/// Retrieves the plaintext value of a secret.
///
/// # Arguments
///
/// * `client` - An initialised Secrets Manager [`Client`].
/// * `name` - The secret name or ARN.
///
/// # Returns
///
/// The `secret_string` field from the AWS response as an owned `String`.
///
/// # Errors
///
/// Returns [`SecParError::AwsSdk`] on API failure or
/// [`SecParError::MissingValue`] when `secret_string` is absent.
///
/// # Examples
///
/// ```no_run
/// use aws_sdk_secretsmanager::Client;
/// use secpar::cli::sec::retrieve_secret;
/// # async fn run(client: &Client) -> Result<(), secpar::errors::SecParError> {
/// let value = retrieve_secret(client, "my-secret").await?;
/// println!("{value}");
/// # Ok(())
/// # }
/// ```
pub async fn retrieve_secret(client: &Client, name: &str) -> Result<String, SecParError> {
    match client.get_secret_value().secret_id(name).send().await {
        Ok(output) => match output.secret_string() {
            Some(secret) => Ok(secret.to_owned()),
            None => Err(SecParError::MissingValue(format!(
                "secret value is empty for {name}"
            ))),
        },
        Err(e) => {
            debug!("Error: {:?}", e.to_string());
            Err(SecParError::AwsSdk(format_sdk_error(&e)))
        }
    }
}

/// Creates a new secret with the given name and value.
///
/// # Arguments
///
/// * `client` - An initialised Secrets Manager [`Client`].
/// * `name` - The secret name.
/// * `secret` - The secret value (string).
///
/// # Returns
///
/// The ARN of the newly created secret.
///
/// # Errors
///
/// Returns [`SecParError::AwsSdk`] on API failure or
/// [`SecParError::MissingValue`] when the response omits the ARN.
///
/// # Examples
///
/// ```no_run
/// use aws_sdk_secretsmanager::Client;
/// use secpar::cli::sec::save_secret;
/// # async fn run(client: &Client) -> Result<(), secpar::errors::SecParError> {
/// let arn = save_secret(client, "my-secret", r#"{"key":"value"}"#).await?;
/// println!("Created: {arn}");
/// # Ok(())
/// # }
/// ```
pub async fn save_secret(client: &Client, name: &str, secret: &str) -> Result<String, SecParError> {
    match client
        .create_secret()
        .name(name)
        .secret_string(secret)
        .client_request_token(Uuid::new_v4().to_string())
        .send()
        .await
    {
        Ok(output) => match output.arn() {
            Some(arn) => Ok(arn.to_owned()),
            None => Err(SecParError::MissingValue(format!(
                "secret ARN is missing for {name}"
            ))),
        },
        Err(e) => {
            debug!("Error: {:?}", e.to_string());
            Err(SecParError::AwsSdk(format_sdk_error(&e)))
        }
    }
}

/// Reads a YAML spec file and creates every secret defined in it.
///
/// Secrets that already exist are skipped with an informational message rather
/// than aborting the whole apply.  Each entry is strongly typed via
/// [`SecretEntry`](crate::specs::SecretEntry).
///
/// # Arguments
///
/// * `client` - An initialised Secrets Manager [`Client`].
/// * `path` - Path to the YAML spec file.
///
/// # Errors
///
/// Returns [`SecParError::InvalidSpec`] if the file cannot be parsed, or
/// [`SecParError::AwsSdk`] if a create call fails for a reason other than
/// the secret already existing.
///
/// # Examples
///
/// ```no_run
/// use aws_sdk_secretsmanager::Client;
/// use secpar::cli::sec::apply_secrets;
/// # async fn run(client: &Client) -> Result<(), secpar::errors::SecParError> {
/// apply_secrets(client, std::path::Path::new("./templates/secrets_template.yaml")).await?;
/// # Ok(())
/// # }
/// ```
pub async fn apply_secrets(client: &Client, path: &std::path::Path) -> Result<(), SecParError> {
    let spec = SecretsSpec::new(path)?;
    let total = spec.secrets.len();
    for (i, entry) in spec.secrets.iter().enumerate() {
        match save_secret(client, &entry.name, &entry.secret).await {
            Ok(arn) => {
                print_info(&format!(
                    "[{}/{}] created '{}' → {arn}",
                    i + 1,
                    total,
                    entry.name
                ));
            }
            Err(SecParError::AwsSdk(ref msg))
                if msg.to_lowercase().contains("already exists")
                    || msg.to_lowercase().contains("resourceexistsexception") =>
            {
                print_info(&format!(
                    "[{}/{}] '{}' already exists — skipped",
                    i + 1,
                    total,
                    entry.name
                ));
            }
            Err(e) => return Err(e),
        }
    }
    Ok(())
}

/// Resolves a secret name: returns `name` directly when provided, or presents
/// an interactive selection menu populated from `list_secrets`.
async fn resolve_secret_name(client: &Client, name: Option<&str>) -> Result<String, SecParError> {
    if let Some(n) = name {
        return Ok(n.to_owned());
    }
    let spinner = new_spinner("Fetching secrets for selection…");
    let rows = list_secrets(client).await?;
    spinner.finish_and_clear();
    let names: Vec<String> = rows.into_iter().map(|(n, _, _)| n).collect();
    select_from_list("Select a secret", &names)
}

/// Dispatches a `sec` subcommand.
///
/// # Arguments
///
/// * `command` - The parsed [`SecCommand`] variant.
/// * `opts` - Global CLI options (region, profile).
///
/// # Errors
///
/// Propagates any [`SecParError`] produced by the underlying operations,
/// wrapped in [`color_eyre::Report`].
pub async fn process_sec_command(command: &SecCommand, opts: &GlobalOpts) -> Result<()> {
    let shared_config = crate::cli::load_shared_config(opts).await;
    let client = Client::new(&shared_config);
    match command {
        SecCommand::List {} => {
            let spinner = new_spinner("🔍 Listing secrets…");
            let rows = list_secrets(&client).await?;
            spinner.finish_and_clear();
            if rows.is_empty() {
                print_info("No secrets found.");
            } else {
                let count = rows.len();
                let refs: Vec<(&str, &str, &str)> = rows
                    .iter()
                    .map(|(n, a, l)| (n.as_str(), a.as_str(), l.as_str()))
                    .collect();
                println!("{}", build_secrets_table(&refs));
                print_info(&format!("{count} secret(s) found."));
            }
        }
        SecCommand::Get { name } => {
            let resolved = resolve_secret_name(&client, name.as_deref()).await?;
            let spinner = new_spinner(&format!("🔍 Retrieving secret '{resolved}'…"));
            let secret = retrieve_secret(&client, &resolved).await?;
            spinner.finish_and_clear();
            print_value(&resolved, &secret);
        }
        SecCommand::Describe { name } => {
            let resolved = resolve_secret_name(&client, name.as_deref()).await?;
            let spinner = new_spinner(&format!("🔍 Describing secret '{resolved}'…"));
            let result = describe_secret(&client, &resolved).await;
            spinner.finish_and_clear();
            result?;
        }
        SecCommand::Create { name, secret, yes } => {
            if !yes {
                print_env_context(&crate::cli::env_context(opts));
                if !confirm_action(&format!("Create secret '{name}'?"))? {
                    print_aborted();
                    return Ok(());
                }
            }
            let spinner = new_spinner(&format!("✨ Creating secret '{name}'…"));
            let arn = save_secret(&client, name, secret).await?;
            spinner.finish_and_clear();
            print_success(&format!("Secret '{name}' created."));
            print_info(&format!("ARN: {arn}"));
        }
        SecCommand::Delete { name, force } => {
            let resolved = resolve_secret_name(&client, name.as_deref()).await?;
            if !force {
                print_env_context(&crate::cli::env_context(opts));
                if !confirm_delete(&resolved)? {
                    print_aborted();
                    return Ok(());
                }
            }
            let spinner = new_spinner(&format!("🗑️  Deleting secret '{resolved}'…"));
            delete_secret(&client, &resolved, *force).await?;
            spinner.finish_and_clear();
            print_success(&format!(
                "Secret '{resolved}' deleted{}.",
                if *force { " (force)" } else { "" }
            ));
        }
        SecCommand::Apply { path, yes } => {
            if !yes {
                print_env_context(&crate::cli::env_context(opts));
                if !confirm_action(&format!("Apply secrets from '{}'?", path.display()))? {
                    print_aborted();
                    return Ok(());
                }
            }
            let spinner = new_spinner(&format!("📂 Applying secrets from '{}'…", path.display()));
            spinner.finish_and_clear();
            apply_secrets(&client, path).await?;
            print_success("Secrets applied successfully.");
        }
    }
    Ok(())
}