Repository navigation
Expand file tree
/
Copy pathpackage_download_tests.rs
More file actions
552 lines (547 loc) · 19.1 KB
/
Copy pathpackage_download_tests.rs
File metadata and controls
552 lines (547 loc) · 19.1 KB
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
use super::{authority, configured_client, download_verified_package, download_with_client};
use crate::PackageDownloadRequest;
use crate::download_test_server::DownloadTestServer;
use ring::digest::{SHA256, digest};
use std::sync::atomic::AtomicBool;
use std::sync::atomic::Ordering;
use std::time::{Duration, Instant};
fn request(url: &str) -> PackageDownloadRequest<'_> {
PackageDownloadRequest {
url,
expected_size: 4,
expected_sha256: digest(&SHA256, b"tool").as_ref().try_into().unwrap(),
redirect_authorities: &[],
}
}
fn client(deadline: Instant) -> reqwest::Client {
configured_client(deadline)
.unwrap()
.add_root_certificate(
reqwest::Certificate::from_der(include_bytes!(
"../tests/fixtures/download_tls/root.der"
))
.unwrap(),
)
.build()
.unwrap()
}
fn deadline() -> Instant {
Instant::now() + Duration::from_secs(3)
}
#[tokio::test]
async fn https_returns_only_exact_frozen_bytes() {
let server = DownloadTestServer::new(
b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\nConnection: close\r\n\r\ntool".to_vec(),
Duration::ZERO,
);
let d = deadline();
assert_eq!(
download_with_client(&request(&server.url), d, &AtomicBool::new(false), client(d))
.await
.unwrap(),
b"tool"
);
assert!(server.seen.load(Ordering::Relaxed));
}
#[tokio::test]
async fn invalid_url_input_and_pre_cancelled_budget_make_no_requests() {
for url in [
"http://example.org/tool",
"https://user:secret@example.org/tool",
"https://example.org/tool?secret=1",
"https://example.org/tool#part",
"https://example.org/\nheader",
] {
assert!(
download_verified_package(&request(url), deadline(), &AtomicBool::new(false))
.await
.is_err()
);
}
assert!(
download_verified_package(
&request("https://example.org/tool"),
Instant::now(),
&AtomicBool::new(false)
)
.await
.is_err()
);
assert!(
download_verified_package(
&request("https://example.org/tool"),
deadline(),
&AtomicBool::new(true)
)
.await
.is_err()
);
}
#[tokio::test]
async fn bad_status_size_digest_encoding_or_short_stream_never_returns_bytes() {
for (response, expected) in [
(
b"HTTP/1.1 404 Nope\r\nContent-Length: 4\r\n\r\ntool".as_slice(),
"package_download_http_status",
),
(
b"HTTP/1.1 200 OK\r\nContent-Length: 5\r\n\r\ntool!",
"package_size_mismatch",
),
(
b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\n\r\nevil",
"package_digest_mismatch",
),
(
b"HTTP/1.1 200 OK\r\nContent-Encoding: gzip\r\nContent-Length: 4\r\n\r\ntool",
"package_download_content_encoding_invalid",
),
(
b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\n\r\nto",
"package_download_read_failed",
),
(
b"HTTP/1.1 200 OK\r\nConnection: close\r\n\r\ntool!",
"package_size_mismatch",
),
] {
let server = DownloadTestServer::new(response.to_vec(), Duration::ZERO);
let d = deadline();
assert_eq!(
download_with_client(&request(&server.url), d, &AtomicBool::new(false), client(d))
.await
.unwrap_err(),
expected
);
assert!(server.seen.load(Ordering::Relaxed));
}
}
#[tokio::test]
async fn untrusted_tls_certificate_is_rejected_by_production_client() {
let server = DownloadTestServer::new(
b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\n\r\ntool".to_vec(),
Duration::ZERO,
);
assert!(
download_verified_package(&request(&server.url), deadline(), &AtomicBool::new(false))
.await
.is_err()
);
assert!(!server.seen.load(Ordering::Relaxed));
}
#[tokio::test]
async fn blocked_network_wait_observes_deadline_and_cancellation() {
for cancel in [false, true] {
let server = DownloadTestServer::new(
b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\n\r\ntool".to_vec(),
Duration::from_secs(2),
);
let flag = AtomicBool::new(false);
let start = Instant::now();
let d = if cancel {
deadline()
} else {
start + Duration::from_millis(200)
};
let c = client(d);
let signal = async {
let end = deadline();
while !server.seen.load(Ordering::Relaxed) && Instant::now() < end {
tokio::time::sleep(Duration::from_millis(2)).await;
}
if server.seen.load(Ordering::Relaxed) {
flag.store(true, Ordering::Relaxed);
}
};
let req = request(&server.url);
let result = if cancel {
tokio::join!(download_with_client(&req, d, &flag, c), signal).0
} else {
download_with_client(&request(&server.url), d, &flag, c).await
};
assert_eq!(
result.unwrap_err(),
if cancel {
"package_download_cancelled"
} else {
"package_download_deadline_exceeded"
}
);
assert!(start.elapsed() < Duration::from_secs(1));
}
}
#[tokio::test]
async fn cross_origin_redirect_needs_explicit_authority_and_keeps_shared_budget() {
let target = DownloadTestServer::new(
b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\n\r\ntool".to_vec(),
Duration::ZERO,
);
let source = DownloadTestServer::new(
format!(
"HTTP/1.1 302 Found\r\nLocation: {}\r\nContent-Length: 0\r\n\r\n",
target.url
)
.into_bytes(),
Duration::ZERO,
);
let d = deadline();
assert_eq!(
download_with_client(&request(&source.url), d, &AtomicBool::new(false), client(d))
.await
.unwrap_err(),
"package_download_redirect_unapproved"
);
assert!(!target.seen.load(Ordering::Relaxed));
let source = DownloadTestServer::new(
format!(
"HTTP/1.1 302 Found\r\nLocation: {}\r\nContent-Length: 0\r\n\r\n",
target.url
)
.into_bytes(),
Duration::ZERO,
);
let authority = authority(&reqwest::Url::parse(&target.url).unwrap()).unwrap();
let allowed = [authority.as_str()];
let req = PackageDownloadRequest {
redirect_authorities: &allowed,
..request(&source.url)
};
let d = deadline();
assert_eq!(
download_with_client(&req, d, &AtomicBool::new(false), client(d))
.await
.unwrap(),
b"tool"
);
}
#[tokio::test]
async fn chunked_and_close_delimited_bodies_preserve_exact_package_bytes() {
for response in [
b"HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\n\r\n2\r\nto\r\n2\r\nol\r\n0\r\n\r\n"
.as_slice(),
b"HTTP/1.1 200 OK\r\nConnection: close\r\n\r\ntool",
] {
let server = DownloadTestServer::new(response.to_vec(), Duration::ZERO);
let d = deadline();
assert_eq!(
download_with_client(&request(&server.url), d, &AtomicBool::new(false), client(d))
.await
.unwrap(),
b"tool"
);
assert!(server.seen.load(Ordering::Relaxed));
}
}
#[tokio::test]
async fn redirect_downgrade_credentials_and_ambiguous_locations_are_rejected() {
for (headers, expected) in [
(
"Location: http://127.0.0.1/package\r\n",
"package_download_url_invalid",
),
(
"Location: https://user:secret@127.0.0.1/package\r\n",
"package_download_url_invalid",
),
("", "package_download_redirect_invalid"),
(
"Location: /one\r\nLocation: /two\r\n",
"package_download_redirect_invalid",
),
] {
let server = DownloadTestServer::new(
format!("HTTP/1.1 302 Found\r\n{headers}Content-Length: 0\r\n\r\n").into_bytes(),
Duration::ZERO,
);
let d = deadline();
assert_eq!(
download_with_client(&request(&server.url), d, &AtomicBool::new(false), client(d))
.await
.unwrap_err(),
expected
);
assert!(server.seen.load(Ordering::Relaxed));
}
}
#[tokio::test]
async fn transfer_encoding_must_be_only_chunked_without_content_length() {
let server = DownloadTestServer::new(
b"HTTP/1.1 200 OK\r\nTransfer-Encoding: gzip, chunked\r\n\r\n4\r\ntool\r\n0\r\n\r\n"
.to_vec(),
Duration::ZERO,
);
let d = deadline();
assert_eq!(
download_with_client(&request(&server.url), d, &AtomicBool::new(false), client(d))
.await
.unwrap_err(),
"package_download_framing_invalid"
);
assert!(server.seen.load(Ordering::Relaxed));
}
#[tokio::test]
async fn redirect_chain_stops_before_a_sixth_hop() {
let mut servers = vec![DownloadTestServer::new(
b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\n\r\ntool".to_vec(),
Duration::ZERO,
)];
for _ in 0..6 {
let next = &servers.last().unwrap().url;
servers.push(DownloadTestServer::new(
format!("HTTP/1.1 302 Found\r\nLocation: {next}\r\nContent-Length: 0\r\n\r\n")
.into_bytes(),
Duration::ZERO,
));
}
let authorities: Vec<_> = servers
.iter()
.map(|s| authority(&reqwest::Url::parse(&s.url).unwrap()).unwrap())
.collect();
let allowed: Vec<_> = authorities.iter().map(String::as_str).collect();
let req = PackageDownloadRequest {
redirect_authorities: &allowed,
..request(&servers.last().unwrap().url)
};
let d = deadline();
assert_eq!(
download_with_client(&req, d, &AtomicBool::new(false), client(d))
.await
.unwrap_err(),
"package_download_redirect_limit"
);
assert!(!servers[0].seen.load(Ordering::Relaxed));
assert!(servers[1..].iter().all(|s| s.seen.load(Ordering::Relaxed)));
}
#[tokio::test]
async fn redirect_target_cannot_reset_original_deadline() {
let target = DownloadTestServer::new(
b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\n\r\ntool".to_vec(),
Duration::from_secs(2),
);
let source = DownloadTestServer::new(
format!(
"HTTP/1.1 302 Found\r\nLocation: {}?signed=test-only\r\nContent-Length: 0\r\n\r\n",
target.url
)
.into_bytes(),
Duration::from_millis(80),
);
let authority = authority(&reqwest::Url::parse(&target.url).unwrap()).unwrap();
let allowed = [authority.as_str()];
let req = PackageDownloadRequest {
redirect_authorities: &allowed,
..request(&source.url)
};
let start = Instant::now();
let d = start + Duration::from_millis(350);
let error = download_with_client(&req, d, &AtomicBool::new(false), client(d))
.await
.unwrap_err();
assert!(matches!(
error,
"package_download_deadline_exceeded" | "package_download_timeout"
));
assert!(source.seen.load(Ordering::Relaxed));
assert!(target.seen.load(Ordering::Relaxed));
assert!(start.elapsed() < Duration::from_secs(1));
}
#[cfg(any(target_os = "macos", target_os = "linux"))]
#[tokio::test]
async fn downloaded_archive_verifies_full_tree_before_private_publication() {
use std::io::{Cursor, Write};
use std::os::unix::fs::PermissionsExt;
let mut writer = zip::ZipWriter::new(Cursor::new(Vec::new()));
writer
.add_directory("empty/", zip::write::SimpleFileOptions::default())
.unwrap();
writer
.start_file("bin/tool", zip::write::SimpleFileOptions::default())
.unwrap();
writer.write_all(b"tool").unwrap();
let zip_package = writer.finish().unwrap().into_inner();
let mut tar = tar::Builder::new(Vec::new());
for (path, bytes, kind) in [
("empty/", b"".as_slice(), tar::EntryType::Directory),
("bin/tool", b"tool".as_slice(), tar::EntryType::Regular),
] {
let mut header = tar::Header::new_gnu();
header.set_size(bytes.len() as u64);
header.set_mode(0o755);
header.set_entry_type(kind);
header.set_cksum();
tar.append_data(&mut header, path, bytes).unwrap();
}
let mut gz = flate2::write::GzEncoder::new(Vec::new(), flate2::Compression::default());
gz.write_all(&tar.into_inner().unwrap()).unwrap();
let gzip_package = gz.finish().unwrap();
for (format, package) in [("zip", zip_package), ("tar_gz", gzip_package)] {
let sha: [u8; 32] = digest(&SHA256, &package).as_ref().try_into().unwrap();
let archive = crate::ArchiveUnpackRequest {
format,
entrypoint: "bin/tool",
package_sha256: sha,
entrypoint_sha256: request("unused").expected_sha256,
max_unpacked_bytes: 1024,
};
let flag = AtomicBool::new(false);
let expected_tree =
crate::unpack_package_archive_tree(&package, &archive, deadline(), &flag).unwrap();
let expected = crate::hash_unpacked_bundle_tree(&expected_tree, deadline(), &flag).unwrap();
for invalid_tree in [false, true] {
let mut response = format!(
"HTTP/1.1 200 OK\r\nContent-Length: {}\r\n\r\n",
package.len()
)
.into_bytes();
response.extend_from_slice(&package);
let server = DownloadTestServer::new(response, Duration::ZERO);
let req = PackageDownloadRequest {
url: &server.url,
expected_size: package.len() as u64,
expected_sha256: sha,
redirect_authorities: &[],
};
let d = deadline();
let declared = if invalid_tree {
"f".repeat(64)
} else {
expected.clone()
};
let result =
super::download_archive_with_client(&req, &archive, &declared, d, &flag, client(d))
.await;
assert!(server.seen.load(Ordering::Relaxed));
if invalid_tree {
assert_eq!(result.unwrap_err(), "bundle_digest_mismatch");
} else {
let tree = result.unwrap();
assert!(tree.directories.iter().any(|v| v == "empty"));
let root = std::env::temp_dir().join(format!(
"codeguard-https-archive-{}-{}",
std::process::id(),
server
.url
.rsplit(':')
.next()
.unwrap()
.split('/')
.next()
.unwrap()
));
std::fs::create_dir(&root).unwrap();
std::fs::set_permissions(&root, std::fs::Permissions::from_mode(0o700)).unwrap();
let published =
crate::publish_tool_bundle(&root, &tree, &expected, d, &flag).unwrap();
assert_eq!(
std::fs::read(root.join(&published.relative_path).join("bin/tool")).unwrap(),
b"tool"
);
assert!(root.join(&published.relative_path).join("empty").is_dir());
std::fs::remove_dir_all(root).unwrap();
}
}
}
}
#[tokio::test]
async fn conflicting_archive_declarations_are_rejected_before_network() {
let server = DownloadTestServer::new(Vec::new(), Duration::ZERO);
let req = request(&server.url);
let archive = crate::ArchiveUnpackRequest {
format: "zip",
entrypoint: "bin/tool",
package_sha256: [1; 32],
entrypoint_sha256: req.expected_sha256,
max_unpacked_bytes: 1024,
};
let d = deadline();
assert_eq!(
crate::download_verified_archive(
&req,
&archive,
&"a".repeat(64),
d,
&AtomicBool::new(false)
)
.await
.unwrap_err(),
"package_archive_declaration_mismatch"
);
assert!(!server.seen.load(Ordering::Relaxed));
}
#[cfg(unix)]
#[tokio::test]
async fn downloaded_raw_bytes_publish_only_after_transport_identity_matches() {
use std::os::unix::fs::PermissionsExt;
for corrupt in [false, true] {
let body = if corrupt { "evil" } else { "tool" };
let server = DownloadTestServer::new(
format!("HTTP/1.1 200 OK\r\nContent-Length: 4\r\n\r\n{body}").into_bytes(),
Duration::ZERO,
);
let req = request(&server.url);
let d = deadline();
let flag = AtomicBool::new(false);
let result = download_with_client(&req, d, &flag, client(d)).await;
assert!(server.seen.load(Ordering::Relaxed));
if corrupt {
assert_eq!(result.unwrap_err(), "package_digest_mismatch");
} else {
let bytes = result.unwrap();
let root = std::env::temp_dir().join(format!(
"codeguard-https-raw-{}-{}",
std::process::id(),
server
.url
.rsplit(':')
.next()
.unwrap()
.split('/')
.next()
.unwrap()
));
std::fs::create_dir(&root).unwrap();
std::fs::set_permissions(&root, std::fs::Permissions::from_mode(0o700)).unwrap();
let installed =
crate::publish_tool_bytes(&root, &bytes, req.expected_sha256, d, &flag).unwrap();
assert_eq!(
std::fs::read(root.join(installed.relative_path)).unwrap(),
b"tool"
);
std::fs::remove_dir_all(root).unwrap();
}
}
}
#[tokio::test]
async fn invalid_archive_inputs_never_start_a_request() {
let server = DownloadTestServer::new(Vec::new(), Duration::ZERO);
let req = request(&server.url);
for (format, path, limit, entry, tree) in [
("rar", "bin/tool", 1024, req.expected_sha256, "a".repeat(64)),
("zip", "../tool", 1024, req.expected_sha256, "a".repeat(64)),
("zip", "bin/tool", 0, req.expected_sha256, "a".repeat(64)),
("zip", "bin/tool", 1024, [0; 32], "a".repeat(64)),
("zip", "bin/tool", 1024, req.expected_sha256, "0".repeat(64)),
("zip", "bin/tool", 1024, req.expected_sha256, "A".repeat(64)),
] {
let archive = crate::ArchiveUnpackRequest {
format,
entrypoint: path,
package_sha256: req.expected_sha256,
entrypoint_sha256: entry,
max_unpacked_bytes: limit,
};
assert_eq!(
crate::download_verified_archive(
&req,
&archive,
&tree,
deadline(),
&AtomicBool::new(false)
)
.await
.unwrap_err(),
"package_archive_input_invalid"
);
}
assert!(!server.seen.load(Ordering::Relaxed));
}