bestool 1.46.1

BES Deployment tooling
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

//! Credential provider for the S3 re-signing proxy, backed by Canopy.
//!
//! Fetches STS credentials from Canopy's `/backup-credentials` endpoint for a
//! `(type, purpose)`, caches them, and refreshes as they near expiry. The proxy
//! asks for credentials once per request; this answers from cache while they're
//! valid and re-fetches when they aren't, so a kopia run outlives any single
//! issuance.

use std::{future::Future, pin::Pin, sync::Arc};

use bestool_canopy::{
	CanopyClient,
	schema::{BackupCredentialsArgs, BackupPurpose, CredentialProcessOutput},
};
use bestool_kopia::proxy::{BoxError, CredentialProvider, Credentials};
use futures::future::BoxFuture;
use jiff::{Timestamp, ToSpan};
use tokio::sync::Mutex;
use uuid::Uuid;

/// Refresh creds this far ahead of their `Expiration`.
const REFRESH_MARGIN_MINUTES: i64 = 2;

/// Fetches a fresh set of creds from Canopy. Boxed so the provider is testable
/// without a live `CanopyClient`.
type Refresher =
	Arc<dyn Fn() -> BoxFuture<'static, Result<CredentialProcessOutput, String>> + Send + Sync>;

/// A [`CredentialProvider`] that draws backup credentials from Canopy.
pub struct CanopyCredentialProvider {
	refresh: Refresher,
	cached: Mutex<Option<CredentialProcessOutput>>,
}

impl CanopyCredentialProvider {
	/// Build a provider that fetches `(backup_type, purpose)` credentials from
	/// Canopy, tagged with `run_id` so Canopy can correlate every issuance,
	/// snapshot, and report of one run.
	pub fn new(
		client: Arc<CanopyClient>,
		backup_type: String,
		purpose: BackupPurpose,
		run_id: Uuid,
	) -> Self {
		let refresh: Refresher = Arc::new(move || {
			let client = client.clone();
			let backup_type = backup_type.clone();
			Box::pin(async move {
				client
					.backup_credentials(
						&BackupCredentialsArgs::builder()
							.type_(backup_type.clone())
							.purpose(purpose)
							.run_id(run_id)
							.build(),
					)
					.await
					.map_err(|err| format!("{err}"))
			})
		});
		Self::with_refresher(refresh)
	}

	fn with_refresher(refresh: Refresher) -> Self {
		Self {
			refresh,
			cached: Mutex::new(None),
		}
	}
}

/// Whether cached creds are absent or within the refresh margin of expiry.
fn needs_refresh(cached: &Option<CredentialProcessOutput>, now: Timestamp) -> bool {
	match cached {
		None => true,
		Some(creds) => creds.expiration <= now + REFRESH_MARGIN_MINUTES.minutes(),
	}
}

impl CredentialProvider for CanopyCredentialProvider {
	fn credentials(
		&self,
	) -> Pin<Box<dyn Future<Output = Result<Credentials, BoxError>> + Send + '_>> {
		Box::pin(async move {
			let mut cached = self.cached.lock().await;
			if needs_refresh(&cached, Timestamp::now()) {
				let fresh = (self.refresh)().await.map_err(|err| -> BoxError { err.into() })?;
				*cached = Some(fresh);
			}
			let creds = cached.as_ref().expect("cache populated above");
			Ok(Credentials {
				access_key: creds.access_key_id.clone(),
				secret_key: creds.secret_access_key.0.clone(),
				session_token: Some(creds.session_token.0.clone()),
			})
		})
	}
}

#[cfg(test)]
mod tests {
	use std::sync::atomic::{AtomicUsize, Ordering};

	use serde_json::json;

	use super::*;

	fn creds_expiring(expiration: &str) -> CredentialProcessOutput {
		serde_json::from_value(json!({
			"Version": 1,
			"AccessKeyId": "AKIA",
			"SecretAccessKey": "secret",
			"SessionToken": "session",
			"Expiration": expiration,
		}))
		.unwrap()
	}

	#[tokio::test]
	async fn maps_fields_and_caches_without_refetching() {
		let calls = Arc::new(AtomicUsize::new(0));
		let calls2 = calls.clone();
		let provider = CanopyCredentialProvider::with_refresher(Arc::new(move || {
			calls2.fetch_add(1, Ordering::SeqCst);
			Box::pin(async { Ok(creds_expiring("2099-01-01T00:00:00Z")) })
		}));

		let first = provider.credentials().await.unwrap();
		assert_eq!(first.access_key, "AKIA");
		assert_eq!(first.secret_key, "secret");
		assert_eq!(first.session_token.as_deref(), Some("session"));

		// Still valid: second call serves the cache, no re-fetch.
		provider.credentials().await.unwrap();
		assert_eq!(calls.load(Ordering::SeqCst), 1);
	}

	#[test]
	fn needs_refresh_logic() {
		let now: Timestamp = "2026-01-01T00:00:00Z".parse().unwrap();
		assert!(needs_refresh(&None, now));
		assert!(needs_refresh(
			&Some(creds_expiring("2026-01-01T00:01:00Z")),
			now
		));
		assert!(!needs_refresh(
			&Some(creds_expiring("2026-01-01T01:00:00Z")),
			now
		));
	}
}