aws_secretsmanager_provider 3.1.1

The AWS Secrets Manager Provider is a local HTTP service that you can install and use in your compute environments to read secrets from Secrets Manager and cache them in memory.
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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
use crate::cache_manager::CacheManager;
use aws_sdk_secretsmanager::types::{Filter, FilterNameStringType};
use aws_workload_credentials_provider_common::config::types::{
    SecretPrefetchConfig, SecretsManagerConfig, TagFilter,
};
use log::{debug, error, info, warn};
use rand::RngExt;
use std::collections::HashMap;
use std::sync::Arc;
use tokio::time::{sleep, Duration};

/// Maximum number of secrets per BatchGetSecretValue call.
const BATCH_SIZE: usize = 20;

/// Rate limiting delay between batch calls (~30 TPS).
const BATCH_DELAY_MS: u64 = 34;

/// Format role ARN for log messages. Shows "default credentials" for None.
fn role_display(role_arn: Option<&str>) -> &str {
    role_arn.unwrap_or("default credentials")
}

/// Tracks success and failure counts across the prefetch operation.
#[derive(Debug, Default)]
struct PrefetchStats {
    success: usize,
    failed: usize,
}

/// Spawn the prefetch background task.
///
/// Adds random jitter (0 to max_jitter_seconds) to prevent fleet-wide synchronized
/// API calls, then runs the prefetch logic. Default jitter is 0 (no delay).
///
/// # Arguments
///
/// * `cache_manager` - Shared reference to the cache manager (same instance the server uses).
/// * `config` - Provider configuration containing prefetch settings and cache size.
pub fn start_prefetch_task(cache_manager: Arc<CacheManager>, config: SecretsManagerConfig) {
    tokio::spawn(async move {
        let max_jitter = config.prefetch.max_jitter_seconds;
        if max_jitter > 0 {
            let jitter = rand::rng().random_range(0.0..max_jitter as f64);
            sleep(Duration::from_secs_f64(jitter)).await;
        }

        let mut stats = PrefetchStats::default();
        run_prefetch(&cache_manager, &config, &mut stats).await;

        info!(
            "Pre-fetch complete: success={}, failed={}",
            stats.success, stats.failed
        );
    });
}

/// Run the prefetch logic: resolve secrets from config, group by role, and fetch.
///
/// Two independent paths are executed:
/// 1. Explicit secrets from `prefetch.secrets` — fetched via BatchGetSecretValue with SecretIdList.
/// 2. Tag-based secrets from `prefetch.filter_tags` — fetched via BatchGetSecretValue with Filters.
///
/// # Arguments
///
/// * `cm` - The cache manager providing per-role caching clients.
/// * `config` - Provider configuration with prefetch settings and cache size.
/// * `stats` - Mutable stats tracker updated throughout the operation.
async fn run_prefetch(cm: &CacheManager, config: &SecretsManagerConfig, stats: &mut PrefetchStats) {
    let cache_size: usize = config.cache.cache_size.get();
    let warmup_limit = ((cache_size as f32 * config.prefetch.cache_buffer_ratio) as usize).max(1);
    let prefetch = &config.prefetch;

    // Track remaining capacity per role across both paths to prevent
    // exceeding cache_buffer_ratio when the same role appears in both
    // prefetch.secrets and prefetch.filter_tags.
    let mut remaining_by_role: HashMap<Option<String>, usize> = HashMap::new();

    // Path 1: Explicit secrets grouped by role_arn
    if !prefetch.secrets.is_empty() {
        let grouped = group_secrets_by_role(&prefetch.secrets);
        for (role_arn, secret_ids) in &grouped {
            let remaining = remaining_by_role
                .entry(role_arn.clone())
                .or_insert(warmup_limit);
            fetch_secret_id_group(cm, role_arn.as_deref(), secret_ids, remaining, stats).await;
        }
    }

    // Path 2: Tag-based filtering grouped by role_arn
    if !prefetch.filter_tags.is_empty() {
        let grouped = group_tags_by_role(&prefetch.filter_tags);
        for (role_arn, keys) in &grouped {
            let remaining = remaining_by_role
                .entry(role_arn.clone())
                .or_insert(warmup_limit);
            if *remaining == 0 {
                continue;
            }
            fetch_tag_group(cm, role_arn.as_deref(), keys, remaining, stats).await;
        }
    }
}

/// Group explicit secrets by role_arn for batching.
///
/// Secrets without a role_arn are grouped under `None` (default credentials).
/// Secrets sharing the same role_arn are batched together so they use the
/// same caching client.
///
/// # Arguments
///
/// * `secrets` - The list of secret configurations from the prefetch config.
///
/// # Returns
///
/// * `HashMap<Option<String>, Vec<String>>` - Secret IDs grouped by role ARN.
fn group_secrets_by_role(secrets: &[SecretPrefetchConfig]) -> HashMap<Option<String>, Vec<String>> {
    let mut grouped: HashMap<Option<String>, Vec<String>> = HashMap::new();
    for s in secrets {
        grouped
            .entry(s.role_arn.clone())
            .or_default()
            .push(s.secret_id.clone());
    }
    grouped
}

/// Group tag filters by role_arn for batching.
///
/// Tags without a role_arn are grouped under `None` (default credentials).
/// Tags sharing the same role_arn are combined into a single
/// BatchGetSecretValue call with multiple Filters.
///
/// # Arguments
///
/// * `tags` - The list of tag filter configurations from the prefetch config.
///
/// # Returns
///
/// * `HashMap<Option<String>, Vec<String>>` - Tag keys grouped by role ARN.
fn group_tags_by_role(tags: &[TagFilter]) -> HashMap<Option<String>, Vec<String>> {
    let mut grouped: HashMap<Option<String>, Vec<String>> = HashMap::new();
    for t in tags {
        grouped
            .entry(t.role_arn.clone())
            .or_default()
            .push(t.key.clone());
    }
    grouped
}

/// Fetch explicit secrets using BatchGetSecretValue with SecretIdList.
///
/// Obtains the appropriate caching client for the role (or default), chunks
/// the secret IDs into batches of 20, and calls BatchGetSecretValue for each
/// chunk. Respects the warmup_limit to avoid filling the cache beyond the
/// configured buffer ratio.
///
/// # Arguments
///
/// * `cm` - The cache manager providing per-role caching clients.
/// * `role_arn` - Optional IAM role ARN. `None` uses default credentials.
/// * `secret_ids` - The secret IDs to fetch.
/// * `remaining` - Mutable remaining capacity for this role group (shared across paths).
/// * `stats` - Mutable stats tracker.
async fn fetch_secret_id_group(
    cm: &CacheManager,
    role_arn: Option<&str>,
    secret_ids: &[String],
    remaining: &mut usize,
    stats: &mut PrefetchStats,
) {
    let client = match cm.get_client(role_arn).await {
        Ok(c) => c,
        Err(e) => {
            error!(
                "Pre-fetch: failed to get client for {}: {}",
                role_display(role_arn),
                e.1
            );
            stats.failed += secret_ids.len();
            return;
        }
    };

    let total = secret_ids.len();
    let mut processed = 0;

    for chunk in secret_ids.chunks(BATCH_SIZE) {
        if *remaining == 0 {
            warn!(
                "Pre-fetch: cache buffer limit reached for {}, {} secret(s) not fetched",
                role_display(role_arn),
                total - processed
            );
            break;
        }

        let truncated = chunk.len() > *remaining;
        let batch_size = chunk.len().min(*remaining);
        if truncated {
            warn!(
                "Pre-fetch: cache buffer limit reached for {}, {} secret(s) not fetched",
                role_display(role_arn),
                total - processed - batch_size
            );
        }
        let batch: Vec<String> = chunk[..batch_size].to_vec();
        let batch_len = batch.len();

        match client
            .batch_get_secret_value(Some(batch), None, None, None)
            .await
        {
            Ok(Some(resp)) => {
                let fetched = resp.secret_values().len();
                stats.success += fetched;
                stats.failed += resp.errors().len();
                *remaining = remaining.saturating_sub(fetched);
                for err in resp.errors() {
                    debug!(
                        "Pre-fetch: failed to fetch {}: {}",
                        err.secret_id().unwrap_or("unknown"),
                        err.error_code().unwrap_or("unknown")
                    );
                }
            }
            Ok(None) => {
                stats.failed += batch_len;
            }
            Err(e) => {
                error!("Pre-fetch: BatchGetSecretValue failed: {}", e);
                stats.failed += batch_len;
            }
        }

        processed += batch_len;

        if truncated {
            break;
        }

        if *remaining > 0 {
            sleep(Duration::from_millis(BATCH_DELAY_MS)).await;
        }
    }
}

/// Fetch tag-based secrets using BatchGetSecretValue with Filters.
///
/// Obtains the appropriate caching client for the role (or default), builds
/// tag key filters, and calls BatchGetSecretValue with pagination. Each page
/// discovers and caches secrets matching the tag keys. Respects the
/// warmup_limit to avoid filling the cache beyond the configured buffer ratio.
///
/// # Arguments
///
/// * `cm` - The cache manager providing per-role caching clients.
/// * `role_arn` - Optional IAM role ARN. `None` uses default credentials.
/// * `keys` - The tag keys to filter by.
/// * `remaining` - Mutable remaining capacity for this role group (shared across paths).
/// * `stats` - Mutable stats tracker.
async fn fetch_tag_group(
    cm: &CacheManager,
    role_arn: Option<&str>,
    keys: &[String],
    remaining: &mut usize,
    stats: &mut PrefetchStats,
) {
    let client = match cm.get_client(role_arn).await {
        Ok(c) => c,
        Err(e) => {
            error!(
                "Pre-fetch: failed to get client for {}: {}",
                role_display(role_arn),
                e.1
            );
            return;
        }
    };

    let filters: Vec<Filter> = keys
        .iter()
        .map(|k| {
            Filter::builder()
                .key(FilterNameStringType::TagKey)
                .values(k)
                .build()
        })
        .collect();

    let mut next_token: Option<String> = None;

    loop {
        if *remaining == 0 {
            warn!(
                "Pre-fetch: cache buffer limit reached for {}",
                role_display(role_arn)
            );
            break;
        }

        let max_results = (*remaining as i32).min(BATCH_SIZE as i32);

        match client
            .batch_get_secret_value(None, Some(filters.clone()), Some(max_results), next_token)
            .await
        {
            Ok(Some(resp)) => {
                let fetched = resp.secret_values().len();
                stats.success += fetched;
                stats.failed += resp.errors().len();
                *remaining = remaining.saturating_sub(fetched);

                for err in resp.errors() {
                    debug!(
                        "Pre-fetch: failed to fetch {}: {}",
                        err.secret_id().unwrap_or("unknown"),
                        err.error_code().unwrap_or("unknown")
                    );
                }

                if fetched == 0 && resp.errors().is_empty() {
                    warn!("Pre-fetch: no secrets found for tag filters {:?}", keys);
                }

                next_token = resp.next_token().map(String::from);
            }
            Ok(None) => break,
            Err(e) => {
                error!("Pre-fetch: BatchGetSecretValue with filters failed: {}", e);
                break;
            }
        }

        if next_token.is_none() {
            break;
        }
        sleep(Duration::from_millis(BATCH_DELAY_MS)).await;
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use aws_workload_credentials_provider_common::config::types::PrefetchConfig;

    async fn test_cache_manager(config: &SecretsManagerConfig) -> Arc<CacheManager> {
        Arc::new(
            CacheManager::new(config)
                .await
                .expect("cache manager failed"),
        )
    }

    #[test]
    fn test_group_secrets_no_roles() {
        let secrets = vec![
            SecretPrefetchConfig {
                secret_id: "s1".into(),
                role_arn: None,
            },
            SecretPrefetchConfig {
                secret_id: "s2".into(),
                role_arn: None,
            },
        ];
        let grouped = group_secrets_by_role(&secrets);
        assert_eq!(grouped.len(), 1);
        assert_eq!(grouped[&None].len(), 2);
    }

    #[test]
    fn test_group_secrets_mixed_roles() {
        let secrets = vec![
            SecretPrefetchConfig {
                secret_id: "s1".into(),
                role_arn: None,
            },
            SecretPrefetchConfig {
                secret_id: "s2".into(),
                role_arn: Some("arn:aws:iam::111:role/A".into()),
            },
            SecretPrefetchConfig {
                secret_id: "s3".into(),
                role_arn: Some("arn:aws:iam::111:role/A".into()),
            },
            SecretPrefetchConfig {
                secret_id: "s4".into(),
                role_arn: Some("arn:aws:iam::222:role/B".into()),
            },
        ];
        let grouped = group_secrets_by_role(&secrets);
        assert_eq!(grouped.len(), 3);
        assert_eq!(grouped[&None].len(), 1);
        assert_eq!(grouped[&Some("arn:aws:iam::111:role/A".into())].len(), 2);
        assert_eq!(grouped[&Some("arn:aws:iam::222:role/B".into())].len(), 1);
    }

    #[test]
    fn test_group_tags_no_roles() {
        let tags = vec![
            TagFilter {
                key: "Env".into(),
                role_arn: None,
            },
            TagFilter {
                key: "Team".into(),
                role_arn: None,
            },
        ];
        let grouped = group_tags_by_role(&tags);
        assert_eq!(grouped.len(), 1);
        assert_eq!(grouped[&None].len(), 2);
    }

    #[test]
    fn test_group_tags_mixed_roles() {
        let tags = vec![
            TagFilter {
                key: "Env".into(),
                role_arn: None,
            },
            TagFilter {
                key: "Team".into(),
                role_arn: Some("arn:aws:iam::111:role/A".into()),
            },
            TagFilter {
                key: "App".into(),
                role_arn: Some("arn:aws:iam::111:role/A".into()),
            },
        ];
        let grouped = group_tags_by_role(&tags);
        assert_eq!(grouped.len(), 2);
        assert_eq!(grouped[&None].len(), 1);
        assert_eq!(grouped[&Some("arn:aws:iam::111:role/A".into())].len(), 2);
    }

    // Verify prefetch with explicit secrets populates the cache.
    #[tokio::test]
    async fn test_fetch_secret_id_group_success() {
        let config = SecretsManagerConfig::default();
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();

        fetch_secret_id_group(
            &cache_manager,
            None,
            &["MyTest".to_string()],
            &mut 100,
            &mut stats,
        )
        .await;

        assert_eq!(stats.success, 1);
        assert_eq!(stats.failed, 0);

        // Verify the secret is actually in the cache (not a fetch-on-miss)
        let client = cache_manager.get_client(None).await.unwrap();
        assert!(client.cache_contains("MyTest").await);
    }

    // Verify prefetch with a role_arn creates a role client and caches the secret.
    #[tokio::test]
    async fn test_fetch_secret_id_group_with_role() {
        let config = SecretsManagerConfig::default();
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();
        let role = "arn:aws:iam::123456789012:role/TestRole";

        fetch_secret_id_group(
            &cache_manager,
            Some(role),
            &["MyTest".to_string()],
            &mut 100,
            &mut stats,
        )
        .await;

        assert_eq!(stats.success, 1);
        assert_eq!(stats.failed, 0);

        // Verify the secret is in the role client's cache
        let client = cache_manager.get_client(Some(role)).await.unwrap();
        assert!(client.cache_contains("MyTest").await);
    }

    // Verify prefetch stops when warmup_limit is zero.
    #[tokio::test]
    async fn test_fetch_secret_id_group_buffer_limit() {
        let config = SecretsManagerConfig::default();
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();

        fetch_secret_id_group(
            &cache_manager,
            None,
            &["MyTest".to_string(), "MyTest2".to_string()],
            &mut 0,
            &mut stats,
        )
        .await;

        assert_eq!(stats.success, 0);
    }

    // Verify run_prefetch orchestrates correctly with a secrets config.
    #[tokio::test]
    async fn test_run_prefetch_with_secrets() {
        let config = SecretsManagerConfig {
            prefetch: PrefetchConfig {
                secrets: vec![SecretPrefetchConfig {
                    secret_id: "MyTest".into(),
                    role_arn: None,
                }],
                ..Default::default()
            },
            ..Default::default()
        };
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();

        run_prefetch(&cache_manager, &config, &mut stats).await;

        assert_eq!(stats.success, 1);
        assert_eq!(stats.failed, 0);
    }

    // Verify run_prefetch is a no-op with empty config.
    #[tokio::test]
    async fn test_run_prefetch_empty_config() {
        let config = SecretsManagerConfig::default();
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();

        run_prefetch(&cache_manager, &config, &mut stats).await;

        assert_eq!(stats.success, 0);
        assert_eq!(stats.failed, 0);
    }

    // Verify API-level batch error is handled gracefully.
    #[tokio::test]
    async fn test_fetch_secret_id_group_api_error() {
        let config = SecretsManagerConfig::default();
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();

        fetch_secret_id_group(
            &cache_manager,
            None,
            &["BATCHAPIERROR_secret".to_string()],
            &mut 100,
            &mut stats,
        )
        .await;

        assert_eq!(stats.success, 0);
        assert_eq!(stats.failed, 1);
    }

    // Verify partial batch failure: some secrets succeed, some fail.
    #[tokio::test]
    async fn test_fetch_secret_id_group_partial_failure() {
        let config = SecretsManagerConfig::default();
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();

        fetch_secret_id_group(
            &cache_manager,
            None,
            &["NOTFOUNDsecret".to_string(), "ValidSecret".to_string()],
            &mut 100,
            &mut stats,
        )
        .await;

        assert_eq!(stats.success, 1);
        assert_eq!(stats.failed, 1);
    }

    // Verify tag-based prefetch discovers and caches secrets.
    #[tokio::test]
    async fn test_fetch_tag_group_success() {
        let config = SecretsManagerConfig::default();
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();

        fetch_tag_group(
            &cache_manager,
            None,
            &["Environment".to_string()],
            &mut 100,
            &mut stats,
        )
        .await;

        assert_eq!(stats.success, 1);
        assert_eq!(stats.failed, 0);

        // Verify the tagged secret is in the cache
        let client = cache_manager.get_client(None).await.unwrap();
        assert!(client.cache_contains("TaggedSecret").await);
    }

    // Verify total = success + failed when get_client() fails (max_roles exceeded).
    #[tokio::test]
    async fn test_fetch_secret_id_group_client_failure_counts_total() {
        let config = SecretsManagerConfig {
            max_roles: 2,
            ..Default::default()
        };
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();

        // Fill both role slots
        fetch_secret_id_group(
            &cache_manager,
            Some("arn:aws:iam::111111111111:role/Role1"),
            &["MyTest".to_string()],
            &mut 100,
            &mut stats,
        )
        .await;
        fetch_secret_id_group(
            &cache_manager,
            Some("arn:aws:iam::222222222222:role/Role2"),
            &["MyTest".to_string()],
            &mut 100,
            &mut stats,
        )
        .await;

        // Third role exceeds max_roles — get_client() returns Err
        let mut stats3 = PrefetchStats::default();
        fetch_secret_id_group(
            &cache_manager,
            Some("arn:aws:iam::333333333333:role/Role3"),
            &["MyTest".to_string(), "MyTest2".to_string()],
            &mut 100,
            &mut stats3,
        )
        .await;

        // Both secrets should be counted in total and failed
        assert_eq!(stats3.failed, 2);
        assert_eq!(stats3.success, 0);
    }

    // Verify tag-based prefetch respects buffer limit.
    #[tokio::test]
    async fn test_fetch_tag_group_buffer_limit() {
        let config = SecretsManagerConfig::default();
        let cache_manager = test_cache_manager(&config).await;
        let mut stats = PrefetchStats::default();

        fetch_tag_group(
            &cache_manager,
            None,
            &["Env".to_string()],
            &mut 0,
            &mut stats,
        )
        .await;

        assert_eq!(stats.success, 0);
    }
}