tsafe-aws 1.2.0

AWS Secrets Manager and SSM HTTP client for tsafe — pull/push secrets from AWS to the local encrypted vault
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
//! AWS Secrets Manager HTTP client.
// `ureq::Error` is large; propagating it through `Result` triggers `clippy::result_large_err`.
#![allow(clippy::result_large_err)]

use super::config::{AwsConfig, AwsCredentials};
use super::error::AwsError;
use super::sigv4::sign;

const MAX_RETRIES: u32 = 3;
const DEFAULT_RETRY_SECS: u64 = 2;

fn http_agent() -> ureq::Agent {
    ureq::AgentBuilder::new()
        .timeout_connect(std::time::Duration::from_secs(10))
        .timeout(std::time::Duration::from_secs(30))
        .build()
}

/// Execute an HTTP call with retry on 429 (throttled) responses.
///
/// On the final attempt (`attempt == MAX_RETRIES`), the throttled-retry guard
/// is false, so a 429 falls into the catch-all `Err(e) => return Err(e)` arm
/// and the caller sees `AwsError::Http { status: 429, .. }` via
/// `map_ureq_error`. The loop therefore always returns from inside; the
/// trailing `Err(...)` below is unreachable in practice but exists so a future
/// edit to the retry guard can never panic the process.
fn call_with_retry(
    make_request: impl Fn() -> Result<ureq::Response, ureq::Error>,
) -> Result<ureq::Response, ureq::Error> {
    for attempt in 0..=MAX_RETRIES {
        match make_request() {
            Ok(resp) => return Ok(resp),
            Err(ureq::Error::Status(429, resp)) if attempt < MAX_RETRIES => {
                let retry_after = resp
                    .header("Retry-After")
                    .and_then(|v| v.parse::<u64>().ok())
                    .unwrap_or(DEFAULT_RETRY_SECS * 2u64.pow(attempt));
                let wait = std::cmp::min(retry_after, 30); // cap at 30 s
                std::thread::sleep(std::time::Duration::from_secs(wait));
            }
            Err(e) => return Err(e),
        }
    }
    let body = format!(
        "secrets manager retry loop exhausted after {} attempts",
        MAX_RETRIES + 1
    );
    let resp = ureq::Response::new(504, "Retries Exhausted", &body)
        .expect("static 504 response must build");
    Err(ureq::Error::Status(504, resp))
}

fn map_ureq_error(e: ureq::Error, secret_name: Option<&str>) -> AwsError {
    match e {
        ureq::Error::Status(400, resp) => {
            let body = resp.into_string().unwrap_or_default();
            // ResourceNotFoundException is a 400 in some SDK versions but
            // more commonly Secrets Manager returns it as a serialized error.
            if body.contains("ResourceNotFoundException") {
                AwsError::NotFound(secret_name.unwrap_or("").to_string())
            } else {
                AwsError::Http {
                    status: 400,
                    message: body,
                }
            }
        }
        ureq::Error::Status(s, resp) => AwsError::Http {
            status: s,
            message: resp
                .into_string()
                .unwrap_or_else(|_| "<unreadable response>".into()),
        },
        other => AwsError::Transport(other.to_string()),
    }
}

/// Normalise an AWS Secrets Manager secret name to an environment variable key.
/// `/` and `-` are replaced with `_`; the result is uppercased.
///
/// Examples:
///   `my-secret`           → `MY_SECRET`
///   `myapp/db-password`   → `MYAPP_DB_PASSWORD`
pub fn normalize_name(name: &str) -> String {
    name.replace(['/', '-'], "_").to_uppercase()
}

/// Pull secrets from AWS Secrets Manager, optionally filtered by `prefix`.
///
/// `get_creds` is called once per page during listing and once more before
/// the per-secret fetch phase, so credentials are always fresh even on
/// large vaults that span multiple ListSecrets pages.
///
/// Returns `(normalized_key, value)` pairs ready to set in the local vault.
pub fn pull_secrets(
    cfg: &AwsConfig,
    get_creds: &impl Fn() -> Result<AwsCredentials, AwsError>,
    prefix: Option<&str>,
) -> Result<Vec<(String, String)>, AwsError> {
    let names = list_secret_names(cfg, get_creds, prefix)?;
    // Refresh credentials before the per-secret fetch phase.
    let creds = get_creds()?;
    let mut secrets = Vec::new();

    for name in &names {
        let value = get_secret_value(cfg, &creds, name)?;
        let key = normalize_name(name);
        secrets.push((key, value));
    }

    Ok(secrets)
}

/// List names of all secrets (optionally matching `prefix`).
/// Handles pagination via `NextToken` in the request body.
fn list_secret_names(
    cfg: &AwsConfig,
    get_creds: &impl Fn() -> Result<AwsCredentials, AwsError>,
    prefix: Option<&str>,
) -> Result<Vec<String>, AwsError> {
    const TARGET: &str = "secretsmanager.ListSecrets";
    let agent = http_agent();
    let mut names = Vec::new();
    let mut next_token: Option<String> = None;

    loop {
        let creds = get_creds()?;

        // Build request body
        let body = match (&next_token, prefix) {
            (Some(tok), Some(p)) => serde_json::json!({
                "MaxResults": 100,
                "Filters": [{"Key": "name", "Values": [p]}],
                "NextToken": tok,
            }),
            (Some(tok), None) => serde_json::json!({
                "MaxResults": 100,
                "NextToken": tok,
            }),
            (None, Some(p)) => serde_json::json!({
                "MaxResults": 100,
                "Filters": [{"Key": "name", "Values": [p]}],
            }),
            (None, None) => serde_json::json!({ "MaxResults": 100 }),
        };
        let body_str = body.to_string();

        let sig = sign(
            &cfg.region,
            TARGET,
            &body_str,
            &creds.access_key_id,
            &creds.secret_access_key,
            creds.session_token.as_deref(),
        );

        let body_clone = body_str.clone();
        let endpoint = cfg.endpoint.clone();
        let resp: serde_json::Value = call_with_retry(|| {
            let mut req = agent
                .post(&endpoint)
                .set("Content-Type", "application/x-amz-json-1.1")
                .set("X-Amz-Target", TARGET)
                .set("X-Amz-Date", &sig.x_amz_date)
                .set("Authorization", &sig.authorization);
            if let Some(ref tok) = sig.x_amz_security_token {
                req = req.set("X-Amz-Security-Token", tok);
            }
            req.send_string(&body_clone)
        })
        .map_err(|e| map_ureq_error(e, None))?
        .into_json()
        .map_err(|e| AwsError::Transport(e.to_string()))?;

        let list = resp["SecretList"].as_array().ok_or_else(|| {
            AwsError::Transport("Secrets Manager response missing 'SecretList' array".into())
        })?;
        for item in list {
            if let Some(name) = item["Name"].as_str() {
                if !name.is_empty() {
                    names.push(name.to_string());
                }
            }
        }

        // Pagination — NextToken is opaque and goes in the request body (no SSRF risk)
        next_token = resp["NextToken"].as_str().map(|s| s.to_string());
        if next_token.is_none() {
            break;
        }
    }

    Ok(names)
}

/// Fetch the current string value of a single secret.
/// Returns `AwsError::NotFound` if the secret does not exist or has no `SecretString`.
fn get_secret_value(
    cfg: &AwsConfig,
    creds: &AwsCredentials,
    name: &str,
) -> Result<String, AwsError> {
    const TARGET: &str = "secretsmanager.GetSecretValue";
    let agent = http_agent();
    let body = serde_json::json!({ "SecretId": name }).to_string();

    let sig = sign(
        &cfg.region,
        TARGET,
        &body,
        &creds.access_key_id,
        &creds.secret_access_key,
        creds.session_token.as_deref(),
    );

    let body_clone = body.clone();
    let endpoint = cfg.endpoint.clone();
    let sig_date = sig.x_amz_date.clone();
    let sig_auth = sig.authorization.clone();
    let sig_tok = sig.x_amz_security_token.clone();

    let resp: serde_json::Value = call_with_retry(|| {
        let mut req = agent
            .post(&endpoint)
            .set("Content-Type", "application/x-amz-json-1.1")
            .set("X-Amz-Target", TARGET)
            .set("X-Amz-Date", &sig_date)
            .set("Authorization", &sig_auth);
        if let Some(ref tok) = sig_tok {
            req = req.set("X-Amz-Security-Token", tok);
        }
        req.send_string(&body_clone)
    })
    .map_err(|e| map_ureq_error(e, Some(name)))?
    .into_json()
    .map_err(|e| AwsError::Transport(e.to_string()))?;

    // SecretString for plain-text secrets; SecretBinary is not supported.
    resp["SecretString"]
        .as_str()
        .map(|s| s.to_string())
        .ok_or_else(|| AwsError::NotFound(name.to_string()))
}

// ── tests ─────────────────────────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use super::*;

    fn test_creds() -> AwsCredentials {
        AwsCredentials {
            access_key_id: "AKID-TEST".into(),
            secret_access_key: "secret-test".into(),
            session_token: None,
        }
    }

    fn cfg(url: &str) -> AwsConfig {
        AwsConfig::with_endpoint("us-east-1", url)
    }

    fn list_response(names: &[&str], next_token: Option<&str>) -> String {
        let items: Vec<String> = names
            .iter()
            .map(|n| {
                format!(r#"{{"Name":"{n}","ARN":"arn:aws:secretsmanager:us-east-1:123:{n}"}}"#)
            })
            .collect();
        match next_token {
            Some(tok) => format!(
                r#"{{"SecretList":[{}],"NextToken":"{tok}"}}"#,
                items.join(",")
            ),
            None => format!(r#"{{"SecretList":[{}]}}"#, items.join(",")),
        }
    }

    fn secret_response(value: &str) -> String {
        format!(r#"{{"Name":"test","SecretString":"{value}","ARN":"arn:..."}}"#)
    }

    // ── pure-logic tests ──────────────────────────────────────────────────────

    #[test]
    fn normalize_name_hyphens() {
        assert_eq!(normalize_name("my-secret"), "MY_SECRET");
    }

    #[test]
    fn normalize_name_slashes() {
        assert_eq!(normalize_name("myapp/db-password"), "MYAPP_DB_PASSWORD");
    }

    #[test]
    fn normalize_name_mixed() {
        assert_eq!(normalize_name("prod/my-app/api-key"), "PROD_MY_APP_API_KEY");
    }

    // ── mock-server tests ─────────────────────────────────────────────────────

    #[test]
    fn pull_secrets_empty_vault() {
        let mut server = mockito::Server::new();
        let _m = server
            .mock("POST", "/")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(r#"{"SecretList":[]}"#)
            .create();

        let result = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap();
        assert!(result.is_empty());
    }

    #[test]
    fn pull_secrets_fetches_and_normalises_key() {
        let mut server = mockito::Server::new();
        let _list = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(list_response(&["my-db-password"], None))
            .create();
        let _get = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.GetSecretValue")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(secret_response("s3cr3t"))
            .create();

        let secrets = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap();
        assert_eq!(secrets.len(), 1);
        assert_eq!(secrets[0].0, "MY_DB_PASSWORD");
        assert_eq!(secrets[0].1, "s3cr3t");
    }

    #[test]
    fn pull_secrets_pagination() {
        let mut server = mockito::Server::new();
        let _page1 = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(list_response(&["secret-a"], Some("page2-token")))
            .expect(1)
            .create();
        let _page2 = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(list_response(&["secret-b"], None))
            .expect(1)
            .create();
        // GetSecretValue for both secrets
        let _get = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.GetSecretValue")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(secret_response("val"))
            .expect(2)
            .create();

        let secrets = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap();
        assert_eq!(secrets.len(), 2);
        let keys: Vec<&str> = secrets.iter().map(|(k, _)| k.as_str()).collect();
        assert!(keys.contains(&"SECRET_A"));
        assert!(keys.contains(&"SECRET_B"));
    }

    #[test]
    fn pull_secrets_resource_not_found_returns_not_found_error() {
        let mut server = mockito::Server::new();
        let _list = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(list_response(&["ghost"], None))
            .create();
        let _get = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.GetSecretValue")
            .with_status(400)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(r#"{"__type":"ResourceNotFoundException","Message":"Secrets Manager can't find the specified secret."}"#)
            .create();

        let err = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap_err();
        assert!(
            matches!(err, AwsError::NotFound(_)),
            "expected NotFound, got {err:?}"
        );
    }

    #[test]
    fn pull_secrets_401_returns_http_error() {
        let mut server = mockito::Server::new();
        let _m = server
            .mock("POST", "/")
            .with_status(403)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(r#"{"__type":"AccessDeniedException","Message":"Access denied"}"#)
            .create();

        let err = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap_err();
        assert!(
            matches!(err, AwsError::Http { status: 403, .. }),
            "expected Http 403, got {err:?}"
        );
    }

    #[test]
    fn pull_secrets_503_returns_http_error() {
        let mut server = mockito::Server::new();
        let _m = server
            .mock("POST", "/")
            .with_status(503)
            .with_body("Service Unavailable")
            .create();

        let err = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap_err();
        assert!(matches!(err, AwsError::Http { status: 503, .. }));
    }

    #[test]
    fn pull_secrets_malformed_list_response_returns_transport_error() {
        let mut server = mockito::Server::new();
        let _m = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body("not valid json {{{{")
            .create();

        let err = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap_err();
        assert!(matches!(err, AwsError::Transport(_)));
    }

    #[test]
    fn pull_secrets_missing_secret_list_returns_transport_error() {
        let mut server = mockito::Server::new();
        let _m = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(r#"{"Unexpected":[]}"#)
            .create();

        let err = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap_err();
        assert!(
            matches!(err, AwsError::Transport(_)),
            "expected Transport for malformed Secrets Manager schema, got {err:?}"
        );
    }

    #[test]
    fn pull_secrets_malformed_get_response_returns_transport_error() {
        let mut server = mockito::Server::new();
        let _list = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(list_response(&["my-secret"], None))
            .create();
        let _get = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.GetSecretValue")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body("not json")
            .create();

        let err = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap_err();
        assert!(matches!(err, AwsError::Transport(_)));
    }

    #[test]
    fn pull_secrets_429_exhausts_retries_returns_http_error() {
        let mut server = mockito::Server::new();
        let _m = server
            .mock("POST", "/")
            .with_status(429)
            .with_header("Retry-After", "0")
            .with_body("Too Many Requests")
            .expect(MAX_RETRIES as usize + 1)
            .create();

        let err = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap_err();
        assert!(matches!(err, AwsError::Http { status: 429, .. }));
    }

    #[test]
    fn creds_refresh_failure_before_fetch_phase_propagates_error() {
        use std::sync::atomic::{AtomicUsize, Ordering};
        let call_count = AtomicUsize::new(0);

        let mut server = mockito::Server::new();
        let _list = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(list_response(&["my-secret"], None))
            .create();

        let err = pull_secrets(
            &cfg(&server.url()),
            &|| {
                let n = call_count.fetch_add(1, Ordering::SeqCst);
                if n == 0 {
                    Ok(test_creds())
                } else {
                    Err(AwsError::Auth("token refresh failed".into()))
                }
            },
            None,
        )
        .unwrap_err();

        assert!(
            matches!(err, AwsError::Auth(_)),
            "expected Auth error on creds refresh, got {err:?}"
        );
    }

    #[test]
    fn creds_failure_on_first_list_call_propagates_error() {
        let server = mockito::Server::new();
        // No mock needed — creds fail before first HTTP call.
        let err = pull_secrets(
            &cfg(&server.url()),
            &|| Err(AwsError::Auth("no credentials".into())),
            None,
        )
        .unwrap_err();
        assert!(matches!(err, AwsError::Auth(_)));
    }

    #[test]
    fn x_amz_target_header_sent_for_list() {
        let mut server = mockito::Server::new();
        let _m = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(r#"{"SecretList":[]}"#)
            .create();

        let result = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap();
        assert!(result.is_empty());
        // If the header didn't match, mockito returns 501 and the call would fail.
    }

    #[test]
    fn get_secret_no_secret_string_returns_not_found() {
        let mut server = mockito::Server::new();
        let _list = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.ListSecrets")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(list_response(&["binary-secret"], None))
            .create();
        // Return a response without SecretString (e.g. binary secret)
        let _get = server
            .mock("POST", "/")
            .match_header("X-Amz-Target", "secretsmanager.GetSecretValue")
            .with_status(200)
            .with_header("Content-Type", "application/x-amz-json-1.1")
            .with_body(r#"{"Name":"binary-secret","SecretBinary":"base64data=="}"#)
            .create();

        let err = pull_secrets(&cfg(&server.url()), &|| Ok(test_creds()), None).unwrap_err();
        assert!(
            matches!(err, AwsError::NotFound(_)),
            "binary secrets without SecretString should return NotFound"
        );
    }
}