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
use crate::credentials::Key;
use crate::error::*;
use crate::header::Header;
use crate::mac::{Mac, MacType};
/// A Response represents a response from an HTTP server.
///
/// The structure is created from a request and then used to either create (server) or validate
/// (client) a `Server-Authentication` header.
///
/// Like `Request`, Responses are built with `ResponseBuilders`.
///
/// # Examples
///
/// See the documentation in the crate root for examples.
#[derive(Debug, Clone)]
pub struct Response<'a> {
method: &'a str,
host: &'a str,
port: u16,
path: &'a str,
req_header: &'a Header,
hash: Option<&'a [u8]>,
ext: Option<&'a str>,
}
impl<'a> Response<'a> {
/// Create a new Header for this response, based on the given request and request header
pub fn make_header(&self, key: &Key) -> Result<Header> {
let ts = self.req_header.ts.ok_or(Error::MissingTs)?;
let nonce = self.req_header.nonce.as_ref().ok_or(Error::MissingNonce)?;
let mac = Mac::new(
MacType::Response,
key,
ts,
nonce,
self.method,
self.host,
self.port,
self.path,
self.hash,
self.ext,
)?;
// Per JS implementation, the Server-Authorization header includes only mac, hash, and ext
Header::new(
None,
None,
None,
Some(mac),
self.ext.map(|v| v.to_string()),
self.hash.map(|v| v.to_vec()),
None,
None,
)
}
/// Validate a Server-Authorization header.
///
/// This checks that the MAC matches and, if a hash has been supplied locally,
/// checks that one was provided from the server and that it, too, matches.
pub fn validate_header(&self, response_header: &Header, key: &Key) -> bool {
// extract required fields, returning early if they are not present
let ts = match self.req_header.ts {
Some(ts) => ts,
None => {
return false;
}
};
let nonce = match self.req_header.nonce {
Some(ref nonce) => nonce,
None => {
return false;
}
};
let header_mac = match response_header.mac {
Some(ref mac) => mac,
None => {
return false;
}
};
let header_ext = response_header.ext.as_ref().map(|ext| &ext[..]);
let header_hash = response_header.hash.as_ref().map(|hash| &hash[..]);
// first verify the MAC
match Mac::new(
MacType::Response,
key,
ts,
nonce,
self.method,
self.host,
self.port,
self.path,
header_hash,
header_ext,
) {
Ok(calculated_mac) => {
if &calculated_mac != header_mac {
return false;
}
}
Err(_) => {
return false;
}
};
// ..then the hashes
if let Some(local_hash) = self.hash {
if let Some(server_hash) = header_hash {
if local_hash != server_hash {
return false;
}
} else {
return false;
}
}
// NOTE: the timestamp self.req_header.ts was generated locally, so
// there is no need to verify it
true
}
}
#[derive(Debug, Clone)]
pub struct ResponseBuilder<'a>(Response<'a>);
impl<'a> ResponseBuilder<'a> {
/// Generate a new Response from a request header.
///
/// This is more commonly accessed through `Request::make_response`.
pub fn from_request_header(
req_header: &'a Header,
method: &'a str,
host: &'a str,
port: u16,
path: &'a str,
) -> Self {
ResponseBuilder(Response {
method,
host,
port,
path,
req_header,
hash: None,
ext: None,
})
}
/// Set the content hash for the response.
///
/// This should always be calculated from the response payload, not copied from a header.
pub fn hash<H: Into<Option<&'a [u8]>>>(mut self, hash: H) -> Self {
self.0.hash = hash.into();
self
}
/// Set the `ext` Hawk property for the response.
///
/// This need only be set on the server; it is ignored in validating responses on the client.
pub fn ext<S: Into<Option<&'a str>>>(mut self, ext: S) -> Self {
self.0.ext = ext.into();
self
}
/// Get the response from this builder
pub fn response(self) -> Response<'a> {
self.0
}
}
#[cfg(all(test, any(feature = "use_ring", feature = "use_openssl")))]
mod test {
use super::ResponseBuilder;
use crate::credentials::Key;
use crate::header::Header;
use crate::mac::Mac;
use std::time::{Duration, UNIX_EPOCH};
fn make_req_header() -> Header {
Header::new(
None,
Some(UNIX_EPOCH + Duration::new(1353832234, 0)),
Some("j4h3g2"),
None,
None,
None,
None,
None,
)
.unwrap()
}
#[test]
fn test_validation_no_hash() {
let req_header = make_req_header();
let resp =
ResponseBuilder::from_request_header(&req_header, "POST", "localhost", 9988, "/a/b")
.response();
let mac: Mac = Mac::from(vec![
48, 133, 228, 163, 224, 197, 222, 77, 117, 81, 143, 73, 71, 120, 68, 238, 228, 40, 55,
64, 190, 73, 102, 123, 79, 185, 199, 26, 62, 1, 137, 170,
]);
let server_header = Header::new(
None,
None,
None,
Some(mac),
Some("server-ext"),
None,
None,
None,
)
.unwrap();
assert!(resp.validate_header(&server_header, &Key::new("tok", crate::SHA256).unwrap()));
}
#[test]
fn test_validation_hash_in_header() {
// When a hash is provided in the response header, but no hash is added to the Response,
// it is ignored (so validation succeeds)
let req_header = make_req_header();
let resp =
ResponseBuilder::from_request_header(&req_header, "POST", "localhost", 9988, "/a/b")
.response();
let mac: Mac = Mac::from(vec![
33, 147, 159, 211, 184, 194, 189, 74, 53, 229, 241, 161, 215, 145, 22, 34, 206, 207,
242, 100, 33, 193, 36, 96, 149, 133, 180, 4, 132, 87, 207, 238,
]);
let server_header = Header::new(
None,
None,
None,
Some(mac),
Some("server-ext"),
Some(vec![1, 2, 3, 4]),
None,
None,
)
.unwrap();
assert!(resp.validate_header(&server_header, &Key::new("tok", crate::SHA256).unwrap()));
}
#[test]
fn test_validation_hash_required_but_not_given() {
// When Response.hash is called, but no hash is in the hader, validation fails.
let req_header = make_req_header();
let hash = vec![1, 2, 3, 4];
let resp =
ResponseBuilder::from_request_header(&req_header, "POST", "localhost", 9988, "/a/b")
.hash(&hash[..])
.response();
let mac: Mac = Mac::from(vec![
48, 133, 228, 163, 224, 197, 222, 77, 117, 81, 143, 73, 71, 120, 68, 238, 228, 40, 55,
64, 190, 73, 102, 123, 79, 185, 199, 26, 62, 1, 137, 170,
]);
let server_header = Header::new(
None,
None,
None,
Some(mac),
Some("server-ext"),
None,
None,
None,
)
.unwrap();
assert!(!resp.validate_header(&server_header, &Key::new("tok", crate::SHA256).unwrap()));
}
#[test]
fn test_validation_hash_validated() {
// When a hash is provided in the response header and the Response.hash method is called,
// the two must match
let req_header = make_req_header();
let hash = vec![1, 2, 3, 4];
let resp =
ResponseBuilder::from_request_header(&req_header, "POST", "localhost", 9988, "/a/b")
.hash(&hash[..])
.response();
let mac: Mac = Mac::from(vec![
33, 147, 159, 211, 184, 194, 189, 74, 53, 229, 241, 161, 215, 145, 22, 34, 206, 207,
242, 100, 33, 193, 36, 96, 149, 133, 180, 4, 132, 87, 207, 238,
]);
let server_header = Header::new(
None,
None,
None,
Some(mac),
Some("server-ext"),
Some(vec![1, 2, 3, 4]),
None,
None,
)
.unwrap();
assert!(resp.validate_header(&server_header, &Key::new("tok", crate::SHA256).unwrap()));
// a different supplied hash won't match..
let hash = vec![99, 99, 99, 99];
let resp =
ResponseBuilder::from_request_header(&req_header, "POST", "localhost", 9988, "/a/b")
.hash(&hash[..])
.response();
assert!(!resp.validate_header(&server_header, &Key::new("tok", crate::SHA256).unwrap()));
}
}