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
use crate::signer::{
OperationSigningConfig, RequestConfig, SigV4Signer, SigningError, SigningRequirements,
};
use aws_sigv4::http_request::SignableBody;
use aws_smithy_http::middleware::MapRequest;
use aws_smithy_http::operation::Request;
use aws_smithy_http::property_bag::PropertyBag;
use aws_types::region::SigningRegion;
use aws_types::Credentials;
use aws_types::SigningService;
use std::time::SystemTime;
use thiserror::Error;
#[non_exhaustive]
pub struct Signature(String);
impl Signature {
pub fn new(signature: String) -> Self {
Self(signature)
}
}
impl AsRef<str> for Signature {
fn as_ref(&self) -> &str {
&self.0
}
}
#[derive(Clone, Debug)]
pub struct SigV4SigningStage {
signer: SigV4Signer,
}
impl SigV4SigningStage {
pub fn new(signer: SigV4Signer) -> Self {
Self { signer }
}
}
#[derive(Debug, Error)]
pub enum SigningStageError {
#[error("No credentials in the property bag")]
MissingCredentials,
#[error("No signing region in the property bag")]
MissingSigningRegion,
#[error("No signing service in the property bag")]
MissingSigningService,
#[error("No signing configuration in the property bag")]
MissingSigningConfig,
#[error("The request body could not be signed by this configuration")]
InvalidBodyType,
#[error("Signing failed")]
SigningFailure(#[from] SigningError),
}
fn signing_config(
config: &PropertyBag,
) -> Result<(&OperationSigningConfig, RequestConfig, Credentials), SigningStageError> {
let operation_config = config
.get::<OperationSigningConfig>()
.ok_or(SigningStageError::MissingSigningConfig)?;
let credentials = config
.get::<Credentials>()
.ok_or(SigningStageError::MissingCredentials)?
.clone();
let region = config
.get::<SigningRegion>()
.ok_or(SigningStageError::MissingSigningRegion)?;
let signing_service = config
.get::<SigningService>()
.ok_or(SigningStageError::MissingSigningService)?;
let payload_override = config.get::<SignableBody<'static>>();
let request_config = RequestConfig {
request_ts: config
.get::<SystemTime>()
.copied()
.unwrap_or_else(SystemTime::now),
region,
payload_override,
service: signing_service,
};
Ok((operation_config, request_config, credentials))
}
impl MapRequest for SigV4SigningStage {
type Error = SigningStageError;
fn apply(&self, req: Request) -> Result<Request, Self::Error> {
req.augment(|mut req, config| {
let operation_config = config
.get::<OperationSigningConfig>()
.ok_or(SigningStageError::MissingSigningConfig)?;
let (operation_config, request_config, creds) =
match &operation_config.signing_requirements {
SigningRequirements::Disabled => return Ok(req),
SigningRequirements::Optional => match signing_config(config) {
Ok(parts) => parts,
Err(_) => return Ok(req),
},
SigningRequirements::Required => signing_config(config)?,
};
let signature = self
.signer
.sign(operation_config, &request_config, &creds, &mut req)
.map_err(|err| SigningStageError::SigningFailure(err))?;
config.insert(signature);
Ok(req)
})
}
}
#[cfg(test)]
mod test {
use crate::middleware::{SigV4SigningStage, Signature, SigningStageError};
use crate::signer::{OperationSigningConfig, SigV4Signer};
use aws_endpoint::partition::endpoint::{Protocol, SignatureVersion};
use aws_endpoint::{set_endpoint_resolver, AwsEndpointStage};
use aws_smithy_http::body::SdkBody;
use aws_smithy_http::middleware::MapRequest;
use aws_smithy_http::operation;
use aws_types::region::{Region, SigningRegion};
use aws_types::Credentials;
use aws_types::SigningService;
use http::header::AUTHORIZATION;
use std::convert::Infallible;
use std::sync::Arc;
use std::time::{Duration, UNIX_EPOCH};
#[test]
fn places_signature_in_property_bag() {
let req = http::Request::builder()
.uri("https://test-service.test-region.amazonaws.com/")
.body(SdkBody::from(""))
.unwrap();
let region = Region::new("us-east-1");
let req = operation::Request::new(req)
.augment(|req, properties| {
properties.insert(region.clone());
properties.insert(UNIX_EPOCH + Duration::new(1611160427, 0));
properties.insert(SigningService::from_static("kinesis"));
properties.insert(OperationSigningConfig::default_config());
properties.insert(Credentials::new("AKIAfoo", "bar", None, None, "test"));
properties.insert(SigningRegion::from(region));
Result::<_, Infallible>::Ok(req)
})
.expect("succeeds");
let signer = SigV4SigningStage::new(SigV4Signer::new());
let req = signer.apply(req).unwrap();
let property_bag = req.properties();
let signature = property_bag.get::<Signature>();
assert!(signature.is_some());
}
#[test]
fn endpoint_plus_signer() {
let provider = Arc::new(aws_endpoint::partition::endpoint::Metadata {
uri_template: "kinesis.{region}.amazonaws.com",
protocol: Protocol::Https,
credential_scope: Default::default(),
signature_versions: SignatureVersion::V4,
});
let req = http::Request::new(SdkBody::from(""));
let region = Region::new("us-east-1");
let req = operation::Request::new(req)
.augment(|req, conf| {
conf.insert(region.clone());
conf.insert(UNIX_EPOCH + Duration::new(1611160427, 0));
conf.insert(SigningService::from_static("kinesis"));
set_endpoint_resolver(conf, provider);
Result::<_, Infallible>::Ok(req)
})
.expect("succeeds");
let endpoint = AwsEndpointStage;
let signer = SigV4SigningStage::new(SigV4Signer::new());
let mut req = endpoint.apply(req).expect("add endpoint should succeed");
let mut errs = vec![signer
.apply(req.try_clone().expect("can clone"))
.expect_err("no signing config")];
let mut config = OperationSigningConfig::default_config();
config.signing_options.content_sha256_header = true;
req.properties_mut().insert(config);
errs.push(
signer
.apply(req.try_clone().expect("can clone"))
.expect_err("no cred provider"),
);
req.properties_mut()
.insert(Credentials::new("AKIAfoo", "bar", None, None, "test"));
let req = signer.apply(req).expect("signing succeeded");
assert!(errs.iter().all(|el| matches!(
el,
SigningStageError::MissingCredentials | SigningStageError::MissingSigningConfig
)));
let (req, _) = req.into_parts();
assert_eq!(
req.headers()
.get("x-amz-date")
.expect("x-amz-date must be present"),
"20210120T163347Z"
);
let auth_header = req
.headers()
.get(AUTHORIZATION)
.expect("auth header must be present");
assert_eq!(auth_header, "AWS4-HMAC-SHA256 Credential=AKIAfoo/20210120/us-east-1/kinesis/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=af71a409f0229dfd6e88409cd1b11f5c2803868d6869888e53bbf9ee12a97ea0");
}
}