Skip to main content

tuwunel_service/storage/provider/
s3.rs

1//! S3-compatible storage-provider construction.
2//!
3//! Configuration and environment values feed the object-store S3 builder.
4//! Providers without a URL or bucket are treated as disabled, while enabled
5//! providers expose signing through the common interface.
6
7use std::{sync::Arc, time::Duration};
8
9/// Object-store transfer types used by the S3 provider boundary.
10///
11/// These re-exports match the common storage module's transfer vocabulary and
12/// avoid exposing backend-specific paths to callers.
13/// Their behavior remains defined by the object-store backend.
14pub use object_store::{GetResult, GetResultPayload, PutPayload, PutResult};
15use object_store::{aws::AmazonS3Builder, client::ClientOptions, signer::Signer};
16use tuwunel_core::{
17	Result,
18	config::{StorageProvider, StorageProviderS3},
19	debug, debug_info, error, trace,
20	version::user_agent,
21};
22
23use super::Provider;
24
25/// Builds an enabled S3-compatible provider.
26///
27/// A configuration with neither a URL nor a bucket returns `None`. Other
28/// settings override the environment-derived builder before the client and its
29/// URL signer are retained by the provider.
30#[tracing::instrument(name = "new", level = "info", skip_all, err)]
31pub(in super::super) fn new(
32	args: &crate::Args<'_>,
33	name: &str,
34	config: &StorageProviderS3,
35) -> Result<Option<(String, Arc<Provider>)>> {
36	if !config.is_enabled() {
37		debug!(?name, "Neither url nor bucket set. This configuration will be skipped");
38		return Ok(None);
39	}
40
41	let idle_per_host = args
42		.server
43		.config
44		.network
45		.http
46		.idle_per_host
47		.into();
48
49	let idle_timeout = Duration::from_secs(args.server.config.network.http.idle_timeout);
50
51	let mut builder = AmazonS3Builder::from_env().with_client_options(
52		ClientOptions::new()
53			.with_user_agent(user_agent().try_into()?)
54			.with_pool_max_idle_per_host(idle_per_host)
55			.with_pool_idle_timeout(idle_timeout),
56	);
57
58	if let Some(url) = config.url.clone() {
59		builder = builder.with_url(url);
60	}
61
62	if let Some(region) = config.region.clone() {
63		builder = builder.with_region(region);
64	}
65
66	if let Some(bucket) = config.bucket.clone() {
67		builder = builder.with_bucket_name(bucket);
68	}
69
70	if let Some(key) = config.key.clone() {
71		builder = builder.with_access_key_id(key);
72	}
73
74	if let Some(secret) = config.secret.clone() {
75		builder = builder.with_secret_access_key(secret);
76	}
77
78	if let Some(kms) = config.kms.clone() {
79		builder = builder.with_ssec_encryption(kms);
80	}
81
82	if let Some(token) = config.token.clone() {
83		builder = builder.with_token(token);
84	}
85
86	if let Some(endpoint) = config.endpoint.clone() {
87		builder = builder.with_endpoint(endpoint);
88	}
89
90	if let Some(use_bucket_key) = config.use_bucket_key {
91		builder = builder.with_bucket_key(use_bucket_key);
92	}
93
94	if let Some(use_https) = config.use_https {
95		builder = builder.with_allow_http(!use_https);
96	}
97
98	if let Some(use_signatures) = config.use_signatures {
99		builder = builder.with_skip_signature(!use_signatures);
100	}
101
102	if let Some(use_payload_signatures) = config.use_payload_signatures {
103		builder = builder.with_unsigned_payload(!use_payload_signatures);
104	}
105
106	if let Some(use_vhost_request) = config.use_vhost_request {
107		builder = builder.with_virtual_hosted_style_request(use_vhost_request);
108	}
109
110	trace!(?name, ?config, "Initializing S3...");
111
112	let client = builder
113		.build()
114		.inspect_err(|e| error!("Failed to configure S3 storage client: {e}"))?;
115
116	debug_info!(
117		credentials = ?client.credentials(),
118		"Started S3 storage client."
119	);
120
121	#[allow(clippy::allow_attributes, clippy::redundant_clone)] // buggy, nursery
122	let signer: Arc<dyn Signer> = Arc::new(client.clone());
123
124	let provider = Provider {
125		name: name.to_owned(),
126		base_path: config.base_path.clone().map(Into::into),
127		config: StorageProvider::s3(Box::new(config.clone())),
128		startup_check: config.startup_check,
129		provider: Box::new(client),
130		signer: Some(signer),
131	};
132
133	Ok(Some((name.to_owned(), Arc::new(provider))))
134}