aws_config/provider_config.rs
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
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
//! Configuration Options for Credential Providers
use crate::profile;
#[allow(deprecated)]
use crate::profile::profile_file::ProfileFiles;
use crate::profile::{ProfileFileLoadError, ProfileSet};
use aws_smithy_async::rt::sleep::{default_async_sleep, AsyncSleep, SharedAsyncSleep};
use aws_smithy_async::time::{SharedTimeSource, TimeSource};
use aws_smithy_runtime_api::client::http::HttpClient;
use aws_smithy_runtime_api::shared::IntoShared;
use aws_smithy_types::error::display::DisplayErrorContext;
use aws_smithy_types::retry::RetryConfig;
use aws_types::os_shim_internal::{Env, Fs};
use aws_types::region::Region;
use aws_types::sdk_config::SharedHttpClient;
use aws_types::SdkConfig;
use std::borrow::Cow;
use std::fmt::{Debug, Formatter};
use std::sync::Arc;
use tokio::sync::OnceCell;
/// Configuration options for Credential Providers
///
/// Most credential providers builders offer a `configure` method which applies general provider configuration
/// options.
///
/// To use a region from the default region provider chain use [`ProviderConfig::with_default_region`].
/// Otherwise, use [`ProviderConfig::without_region`]. Note that some credentials providers require a region
/// to be explicitly set.
#[derive(Clone)]
pub struct ProviderConfig {
env: Env,
fs: Fs,
time_source: SharedTimeSource,
http_client: Option<SharedHttpClient>,
sleep_impl: Option<SharedAsyncSleep>,
region: Option<Region>,
use_fips: Option<bool>,
use_dual_stack: Option<bool>,
/// An AWS profile created from `ProfileFiles` and a `profile_name`
parsed_profile: Arc<OnceCell<Result<ProfileSet, ProfileFileLoadError>>>,
/// A list of [std::path::Path]s to profile files
#[allow(deprecated)]
profile_files: ProfileFiles,
/// An override to use when constructing a `ProfileSet`
profile_name_override: Option<Cow<'static, str>>,
}
impl Debug for ProviderConfig {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("ProviderConfig")
.field("env", &self.env)
.field("fs", &self.fs)
.field("time_source", &self.time_source)
.field("http_client", &self.http_client)
.field("sleep_impl", &self.sleep_impl)
.field("region", &self.region)
.field("use_fips", &self.use_fips)
.field("use_dual_stack", &self.use_dual_stack)
.field("profile_name_override", &self.profile_name_override)
.finish()
}
}
impl Default for ProviderConfig {
fn default() -> Self {
Self {
env: Env::default(),
fs: Fs::default(),
time_source: SharedTimeSource::default(),
http_client: None,
sleep_impl: default_async_sleep(),
region: None,
use_fips: None,
use_dual_stack: None,
parsed_profile: Default::default(),
#[allow(deprecated)]
profile_files: ProfileFiles::default(),
profile_name_override: None,
}
}
}
#[cfg(test)]
impl ProviderConfig {
/// ProviderConfig with all configuration removed
///
/// Unlike [`ProviderConfig::empty`] where `env` and `fs` will use their non-mocked implementations,
/// this method will use an empty mock environment and an empty mock file system.
pub fn no_configuration() -> Self {
use aws_smithy_async::time::StaticTimeSource;
use std::collections::HashMap;
use std::time::UNIX_EPOCH;
let fs = Fs::from_raw_map(HashMap::new());
let env = Env::from_slice(&[]);
Self {
parsed_profile: Default::default(),
#[allow(deprecated)]
profile_files: ProfileFiles::default(),
env,
fs,
time_source: SharedTimeSource::new(StaticTimeSource::new(UNIX_EPOCH)),
http_client: None,
sleep_impl: None,
region: None,
use_fips: None,
use_dual_stack: None,
profile_name_override: None,
}
}
}
impl ProviderConfig {
/// Create a default provider config with the region unset.
///
/// Using this option means that you may need to set a region manually.
///
/// This constructor will use a default value for the HTTPS connector and Sleep implementation
/// when they are enabled as crate features which is usually the correct option. To construct
/// a `ProviderConfig` without these fields set, use [`ProviderConfig::empty`].
///
///
/// # Examples
/// ```no_run
/// # #[cfg(feature = "rustls")]
/// # fn example() {
/// use aws_config::provider_config::ProviderConfig;
/// use aws_sdk_sts::config::Region;
/// use aws_config::web_identity_token::WebIdentityTokenCredentialsProvider;
/// let conf = ProviderConfig::without_region().with_region(Some(Region::new("us-east-1")));
///
/// let credential_provider = WebIdentityTokenCredentialsProvider::builder().configure(&conf).build();
/// # }
/// ```
pub fn without_region() -> Self {
Self::default()
}
/// Constructs a ProviderConfig with no fields set
pub fn empty() -> Self {
ProviderConfig {
env: Env::default(),
fs: Fs::default(),
time_source: SharedTimeSource::default(),
http_client: None,
sleep_impl: None,
region: None,
use_fips: None,
use_dual_stack: None,
parsed_profile: Default::default(),
#[allow(deprecated)]
profile_files: ProfileFiles::default(),
profile_name_override: None,
}
}
/// Initializer for ConfigBag to avoid possibly setting incorrect defaults.
pub(crate) fn init(
time_source: SharedTimeSource,
sleep_impl: Option<SharedAsyncSleep>,
) -> Self {
Self {
parsed_profile: Default::default(),
#[allow(deprecated)]
profile_files: ProfileFiles::default(),
env: Env::default(),
fs: Fs::default(),
time_source,
http_client: None,
sleep_impl,
region: None,
use_fips: None,
use_dual_stack: None,
profile_name_override: None,
}
}
/// Create a default provider config with the region region automatically loaded from the default chain.
///
/// # Examples
/// ```no_run
/// # async fn test() {
/// use aws_config::provider_config::ProviderConfig;
/// use aws_sdk_sts::config::Region;
/// use aws_config::web_identity_token::WebIdentityTokenCredentialsProvider;
/// let conf = ProviderConfig::with_default_region().await;
/// let credential_provider = WebIdentityTokenCredentialsProvider::builder().configure(&conf).build();
/// }
/// ```
pub async fn with_default_region() -> Self {
Self::without_region().load_default_region().await
}
pub(crate) fn client_config(&self) -> SdkConfig {
let mut builder = SdkConfig::builder()
.retry_config(RetryConfig::standard())
.region(self.region())
.time_source(self.time_source())
.use_fips(self.use_fips().unwrap_or_default())
.use_dual_stack(self.use_dual_stack().unwrap_or_default())
.behavior_version(crate::BehaviorVersion::latest());
builder.set_http_client(self.http_client.clone());
builder.set_sleep_impl(self.sleep_impl.clone());
builder.build()
}
// When all crate features are disabled, these accessors are unused
#[allow(dead_code)]
pub(crate) fn env(&self) -> Env {
self.env.clone()
}
#[allow(dead_code)]
pub(crate) fn fs(&self) -> Fs {
self.fs.clone()
}
#[allow(dead_code)]
pub(crate) fn time_source(&self) -> SharedTimeSource {
self.time_source.clone()
}
#[allow(dead_code)]
pub(crate) fn http_client(&self) -> Option<SharedHttpClient> {
self.http_client.clone()
}
#[allow(dead_code)]
pub(crate) fn sleep_impl(&self) -> Option<SharedAsyncSleep> {
self.sleep_impl.clone()
}
#[allow(dead_code)]
pub(crate) fn region(&self) -> Option<Region> {
self.region.clone()
}
#[allow(dead_code)]
pub(crate) fn use_fips(&self) -> Option<bool> {
self.use_fips
}
#[allow(dead_code)]
pub(crate) fn use_dual_stack(&self) -> Option<bool> {
self.use_dual_stack
}
pub(crate) async fn try_profile(&self) -> Result<&ProfileSet, &ProfileFileLoadError> {
let parsed_profile = self
.parsed_profile
.get_or_init(|| async {
let profile = profile::load(
&self.fs,
&self.env,
&self.profile_files,
self.profile_name_override.clone(),
)
.await;
if let Err(err) = profile.as_ref() {
tracing::warn!(err = %DisplayErrorContext(&err), "failed to parse profile")
}
profile
})
.await;
parsed_profile.as_ref()
}
pub(crate) async fn profile(&self) -> Option<&ProfileSet> {
self.try_profile().await.ok()
}
/// Override the region for the configuration
pub fn with_region(mut self, region: Option<Region>) -> Self {
self.region = region;
self
}
/// Override the `use_fips` setting.
pub(crate) fn with_use_fips(mut self, use_fips: Option<bool>) -> Self {
self.use_fips = use_fips;
self
}
/// Override the `use_dual_stack` setting.
pub(crate) fn with_use_dual_stack(mut self, use_dual_stack: Option<bool>) -> Self {
self.use_dual_stack = use_dual_stack;
self
}
pub(crate) fn with_profile_name(self, profile_name: String) -> Self {
let profile_files = self.profile_files.clone();
self.with_profile_config(Some(profile_files), Some(profile_name))
}
/// Override the profile file paths (`~/.aws/config` by default) and name (`default` by default)
#[allow(deprecated)]
pub(crate) fn with_profile_config(
self,
profile_files: Option<ProfileFiles>,
profile_name_override: Option<String>,
) -> Self {
// if there is no override, then don't clear out `parsed_profile`.
if profile_files.is_none() && profile_name_override.is_none() {
return self;
}
ProviderConfig {
// clear out the profile since we need to reparse it
parsed_profile: Default::default(),
profile_files: profile_files.unwrap_or(self.profile_files),
profile_name_override: profile_name_override
.map(Cow::Owned)
.or(self.profile_name_override),
..self
}
}
/// Use the [default region chain](crate::default_provider::region) to set the
/// region for this configuration
///
/// Note: the `env` and `fs` already set on this provider will be used when loading the default region.
pub async fn load_default_region(self) -> Self {
use crate::default_provider::region::DefaultRegionChain;
let provider_chain = DefaultRegionChain::builder().configure(&self).build();
self.with_region(provider_chain.region().await)
}
pub(crate) fn with_fs(self, fs: Fs) -> Self {
ProviderConfig {
parsed_profile: Default::default(),
fs,
..self
}
}
pub(crate) fn with_env(self, env: Env) -> Self {
ProviderConfig {
parsed_profile: Default::default(),
env,
..self
}
}
/// Override the time source for this configuration
pub fn with_time_source(self, time_source: impl TimeSource + 'static) -> Self {
ProviderConfig {
time_source: time_source.into_shared(),
..self
}
}
/// Override the HTTP client for this configuration
pub fn with_http_client(self, http_client: impl HttpClient + 'static) -> Self {
ProviderConfig {
http_client: Some(http_client.into_shared()),
..self
}
}
/// Override the sleep implementation for this configuration
pub fn with_sleep_impl(self, sleep_impl: impl AsyncSleep + 'static) -> Self {
ProviderConfig {
sleep_impl: Some(sleep_impl.into_shared()),
..self
}
}
}