aws_sdk_sso/config/
auth.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Auth scheme resolver trait specific to AWS Single Sign-On
3                pub trait ResolveAuthScheme: ::std::marker::Send + ::std::marker::Sync + ::std::fmt::Debug {
4                    /// Resolve a priority list of auth scheme options with the given parameters
5                    fn resolve_auth_scheme<'a>(
6                        &'a self,
7                        params: &'a crate::config::auth::Params,
8                        cfg: &'a ::aws_smithy_types::config_bag::ConfigBag,
9                        runtime_components: &'a ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents,
10                    ) -> ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture<'a>;
11
12                    /// Convert this service-specific resolver into a `SharedAuthSchemeOptionResolver`
13                    fn into_shared_resolver(self) -> ::aws_smithy_runtime_api::client::auth::SharedAuthSchemeOptionResolver
14                    where
15                        Self: ::std::marker::Sized + 'static,
16                    {
17                        ::aws_smithy_runtime_api::client::auth::SharedAuthSchemeOptionResolver::new(DowncastParams(self))
18                    }
19                }
20
21                #[derive(Debug)]
22                struct DowncastParams<T>(T);
23                impl<T> ::aws_smithy_runtime_api::client::auth::ResolveAuthSchemeOptions for DowncastParams<T>
24                where
25                    T: ResolveAuthScheme,
26                {
27                    fn resolve_auth_scheme_options_v2<'a>(
28                        &'a self,
29                        params: &'a ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams,
30                        cfg: &'a ::aws_smithy_types::config_bag::ConfigBag,
31                        runtime_components: &'a ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents,
32                    ) -> ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture<'a> {
33                        match params.get::<crate::config::auth::Params>() {
34                            ::std::option::Option::Some(concrete_params) => self.0.resolve_auth_scheme(concrete_params, cfg, runtime_components),
35                            ::std::option::Option::None => ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture::ready(::std::result::Result::Err("params of expected type was not present".into())),
36                        }
37                    }
38                }
39
40/// The default auth scheme resolver
41                #[derive(Debug)]
42                #[allow(dead_code)]
43                pub struct DefaultAuthSchemeResolver {
44                    service_defaults: Vec<::aws_smithy_runtime_api::client::auth::AuthSchemeOption>,
45                    operation_overrides: ::std::collections::HashMap<&'static str, Vec<::aws_smithy_runtime_api::client::auth::AuthSchemeOption>>,
46                    preference: ::std::option::Option<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>,
47                }
48
49                // TODO(https://github.com/smithy-lang/smithy-rs/issues/4177): Remove `allow(...)` once the issue is addressed.
50                // When generating code for tests (e.g., `codegen-client-test`), this manual implementation
51                // of the `Default` trait may appear as if it could be derived automatically.
52                // However, that is not the case in production.
53                #[allow(clippy::derivable_impls)]
54                impl Default for DefaultAuthSchemeResolver {
55                    fn default() -> Self {
56                        Self {
57                            service_defaults: vec![::aws_smithy_runtime_api::client::auth::AuthSchemeOption::builder()
58            .scheme_id(::aws_runtime::auth::sigv4::SCHEME_ID)
59            
60            .build()
61            .expect("required fields set")],
62                            operation_overrides: [
63    ("GetRoleCredentials", vec![::aws_smithy_runtime_api::client::auth::AuthSchemeOption::from(::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID)])
64    ,
65    ("ListAccountRoles", vec![::aws_smithy_runtime_api::client::auth::AuthSchemeOption::from(::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID)])
66    ,
67    ("ListAccounts", vec![::aws_smithy_runtime_api::client::auth::AuthSchemeOption::from(::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID)])
68    ,
69    ("Logout", vec![::aws_smithy_runtime_api::client::auth::AuthSchemeOption::from(::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID)])
70    ,
71]
72.into(),
73                            preference: ::std::option::Option::None,
74                        }
75                    }
76                }
77
78                impl crate::config::auth::ResolveAuthScheme for DefaultAuthSchemeResolver {
79                    fn resolve_auth_scheme<'a>(
80                        &'a self,
81                        params: &'a crate::config::auth::Params,
82                        _cfg: &'a ::aws_smithy_types::config_bag::ConfigBag,
83                        _runtime_components: &'a ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents,
84                    ) -> ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture<'a> {
85                        let operation_name = params.operation_name();
86
87                        let modeled_auth_options = match self.operation_overrides.get(operation_name) {
88                            Some(overrides) => overrides,
89                            None => &self.service_defaults,
90                        };
91
92                        let _fut = ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture::ready(Ok(modeled_auth_options.clone()));
93
94                        
95
96                        match &self.preference {
97                            ::std::option::Option::Some(preference) => {
98                                _fut.map_ok({
99                                    // maps auth scheme ID to the index in the preference list
100                                    let preference_map: ::std::collections::HashMap<_, _> = preference
101                                        .clone()
102                                        .into_iter()
103                                        .enumerate()
104                                        .map(|(i, s)| (s, i))
105                                        .collect();
106                                    move |auth_scheme_options| {
107                                        let (mut preferred, non_preferred): (::std::vec::Vec<_>, ::std::vec::Vec<_>) = auth_scheme_options
108                                            .into_iter()
109                                            .partition(|auth_scheme_option| {
110                                                preference_map.contains_key(auth_scheme_option.scheme_id())
111                                            });
112
113                                        preferred.sort_by_key(|opt| {
114                                            preference_map
115                                                .get(opt.scheme_id())
116                                                .expect("guaranteed by `partition`")
117                                        });
118                                        preferred.extend(non_preferred);
119                                        preferred
120                                    }
121                                })
122                            },
123                            ::std::option::Option::None => _fut,
124                        }
125                    }
126                }
127
128                impl DefaultAuthSchemeResolver {
129                    /// Set auth scheme preference to the default auth scheme resolver
130                    pub fn with_auth_scheme_preference(mut self, preference: impl ::std::convert::Into<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>) -> Self {
131                        self.preference = ::std::option::Option::Some(preference.into());
132                        self
133                    }
134                }
135
136/// Configuration parameters for resolving the correct auth scheme
137#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
138pub struct Params {
139    operation_name: ::std::borrow::Cow<'static, str>
140}
141impl Params {
142    /// Create a builder for [`Params`]
143                    pub fn builder() -> crate::config::auth::ParamsBuilder {
144                        crate::config::auth::ParamsBuilder::default()
145                    }
146    
147                    /// Return the operation name for [`Params`]
148                    pub fn operation_name(&self) -> &str {
149                        self.operation_name.as_ref()
150                    }
151}
152
153#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
154/// Builder for [`Params`]
155pub struct ParamsBuilder {
156    operation_name: ::std::option::Option<::std::borrow::Cow<'static, str>>,
157}
158impl ParamsBuilder {
159    /// Set the operation name for the builder
160                    pub fn operation_name(self, operation_name: impl Into<::std::borrow::Cow<'static, str>>) -> Self {
161                        self.set_operation_name(::std::option::Option::Some(operation_name.into()))
162                    }
163    
164                    /// Set the operation name for the builder
165                    pub fn set_operation_name(mut self, operation_name: ::std::option::Option<::std::borrow::Cow<'static, str>>) -> Self {
166                        self.operation_name = operation_name;
167                        self
168                    }
169    /// Consume this builder, create [`Params`]."
170    /// 
171    /// Return [`BuildError`] if any of the required fields are unset.
172    /// 
173    pub fn build(self) -> ::std::result::Result<crate::config::auth::Params, crate::config::auth::BuildError> {
174        ::std::result::Result::Ok(crate::config::auth::Params {
175                                operation_name: self.operation_name
176                                    .ok_or_else(||BuildError::missing("operation_name"))?
177                            })
178    }
179}
180
181/// An error that occurred while constructing `config::auth::Params`
182                #[derive(Debug)]
183                pub struct BuildError {
184                    field: ::std::borrow::Cow<'static, str>
185                }
186
187                impl BuildError {
188                    fn missing(field: &'static str) -> Self {
189                        Self { field: field.into() }
190                    }
191                }
192
193                impl std::fmt::Display for BuildError {
194                    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
195                        write!(f, "a required field was missing: `{}`", self.field)
196                    }
197                }
198
199                impl std::error::Error for BuildError { }
200