-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
auth.rs
264 lines (231 loc) · 7.32 KB
/
auth.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
use std::time::Duration;
use aws_config::{
default_provider::credentials::DefaultCredentialsChain, sts::AssumeRoleProviderBuilder,
};
use aws_types::{credentials::SharedCredentialsProvider, region::Region, Credentials};
use vector_config::configurable_component;
// matches default load timeout from the SDK as of 0.10.1, but lets us confidently document the
// default rather than relying on the SDK default to not change
const DEFAULT_LOAD_TIMEOUT: Duration = Duration::from_secs(5);
/// Configuration of the authentication strategy for interacting with AWS services.
#[configurable_component]
#[derive(Clone, Debug, Derivative)]
#[derivative(Default)]
#[serde(deny_unknown_fields, untagged)]
pub enum AwsAuthentication {
/// Authenticate using a fixed access key and secret pair.
Static {
/// The AWS access key ID.
access_key_id: String,
/// The AWS secret access key.
secret_access_key: String,
},
/// Authenticate using credentials stored in a file.
///
/// Additionally, the specific credential profile to use can be set.
File {
/// Path to the credentials file.
credentials_file: String,
/// The credentials profile to use.
profile: Option<String>,
},
/// Assume the given role ARN.
Role {
/// The ARN of the role to assume.
assume_role: String,
/// Timeout for assuming the role, in seconds.
load_timeout_secs: Option<u64>,
/// The AWS region to send STS requests to.
///
/// If not set, this will default to the configured region
/// for the service itself.
region: Option<String>,
},
/// Default authentication strategy which tries a variety of substrategies in a one-after-the-other fashion.
#[derivative(Default)]
Default {
/// Timeout for successfully loading any credentials, in seconds.
load_timeout_secs: Option<u64>,
},
}
impl AwsAuthentication {
pub async fn credentials_provider(
&self,
service_region: Region,
) -> crate::Result<SharedCredentialsProvider> {
match self {
Self::Static {
access_key_id,
secret_access_key,
} => Ok(SharedCredentialsProvider::new(Credentials::from_keys(
access_key_id,
secret_access_key,
None,
))),
AwsAuthentication::File { .. } => {
Err("Overriding the credentials file is not supported.".into())
}
AwsAuthentication::Role {
assume_role,
load_timeout_secs,
region,
} => {
let auth_region = region.clone().map(Region::new).unwrap_or(service_region);
let provider = AssumeRoleProviderBuilder::new(assume_role)
.region(auth_region.clone())
.build(default_credentials_provider(auth_region, *load_timeout_secs).await);
Ok(SharedCredentialsProvider::new(provider))
}
AwsAuthentication::Default { load_timeout_secs } => Ok(SharedCredentialsProvider::new(
default_credentials_provider(service_region, *load_timeout_secs).await,
)),
}
}
#[cfg(test)]
pub fn test_auth() -> AwsAuthentication {
AwsAuthentication::Static {
access_key_id: "dummy".to_string(),
secret_access_key: "dummy".to_string(),
}
}
}
async fn default_credentials_provider(
region: Region,
load_timeout_secs: Option<u64>,
) -> SharedCredentialsProvider {
let chain = DefaultCredentialsChain::builder()
.region(region)
.load_timeout(
load_timeout_secs
.map(Duration::from_secs)
.unwrap_or(DEFAULT_LOAD_TIMEOUT),
);
SharedCredentialsProvider::new(chain.build().await)
}
#[cfg(test)]
mod tests {
use super::*;
use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize, Clone, Debug)]
struct ComponentConfig {
assume_role: Option<String>,
#[serde(default)]
auth: AwsAuthentication,
}
#[test]
fn parsing_default() {
let config = toml::from_str::<ComponentConfig>(
r#"
"#,
)
.unwrap();
assert!(matches!(config.auth, AwsAuthentication::Default { .. }));
}
#[test]
fn parsing_default_with_load_timeout() {
let config = toml::from_str::<ComponentConfig>(
r#"
auth.load_timeout_secs = 10
"#,
)
.unwrap();
assert!(matches!(
config.auth,
AwsAuthentication::Default {
load_timeout_secs: Some(10)
}
));
}
#[test]
fn parsing_old_assume_role() {
let config = toml::from_str::<ComponentConfig>(
r#"
assume_role = "root"
"#,
)
.unwrap();
assert!(matches!(config.auth, AwsAuthentication::Default { .. }));
}
#[test]
fn parsing_assume_role() {
let config = toml::from_str::<ComponentConfig>(
r#"
auth.assume_role = "root"
auth.load_timeout_secs = 10
"#,
)
.unwrap();
assert!(matches!(config.auth, AwsAuthentication::Role { .. }));
}
#[test]
fn parsing_both_assume_role() {
let config = toml::from_str::<ComponentConfig>(
r#"
assume_role = "root"
auth.assume_role = "auth.root"
auth.load_timeout_secs = 10
auth.region = "us-west-2"
"#,
)
.unwrap();
match config.auth {
AwsAuthentication::Role {
assume_role,
load_timeout_secs,
region,
} => {
assert_eq!(&assume_role, "auth.root");
assert_eq!(load_timeout_secs, Some(10));
assert_eq!(region.unwrap(), "us-west-2");
}
_ => panic!(),
}
}
#[test]
fn parsing_static() {
let config = toml::from_str::<ComponentConfig>(
r#"
auth.access_key_id = "key"
auth.secret_access_key = "other"
"#,
)
.unwrap();
assert!(matches!(config.auth, AwsAuthentication::Static { .. }));
}
#[test]
fn parsing_file() {
let config = toml::from_str::<ComponentConfig>(
r#"
auth.credentials_file = "/path/to/file"
auth.profile = "foo"
"#,
)
.unwrap();
match config.auth {
AwsAuthentication::File {
credentials_file,
profile,
} => {
assert_eq!(&credentials_file, "/path/to/file");
assert_eq!(&profile.unwrap(), "foo");
}
_ => panic!(),
}
let config = toml::from_str::<ComponentConfig>(
r#"
auth.credentials_file = "/path/to/file"
"#,
)
.unwrap();
match config.auth {
AwsAuthentication::File {
credentials_file,
profile,
} => {
assert_eq!(&credentials_file, "/path/to/file");
assert_eq!(profile, None);
}
_ => panic!(),
}
}
}