rch 2.1.34

Remote Compilation Helper - PreToolUse hook CLI
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

//! Real loopback HTTP and filesystem tests. No public network, worker access,
//! global environment changes, or substituted downloader/verification logic.

use super::*;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpListener;
use tokio::sync::oneshot;
use tokio::task::JoinHandle;

const BOUND: Duration = Duration::from_secs(5);

struct Reply {
    wire: Vec<u8>,
    hold: Option<oneshot::Receiver<()>>,
}

impl From<Vec<u8>> for Reply {
    fn from(wire: Vec<u8>) -> Self {
        Self { wire, hold: None }
    }
}

struct Peer {
    url: String,
    task: Option<JoinHandle<Vec<String>>>,
}

impl Peer {
    async fn new(replies: Vec<Reply>) -> Self {
        let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
        let url = format!("http://{}/release", listener.local_addr().unwrap());
        let task = tokio::spawn(async move {
            let mut requests = Vec::new();
            for reply in replies {
                let (mut socket, _) = tokio::time::timeout(BOUND, listener.accept())
                    .await
                    .unwrap()
                    .unwrap();
                let request = tokio::time::timeout(BOUND, async {
                    let mut bytes = Vec::new();
                    while !bytes.ends_with(b"\r\n\r\n") {
                        assert!(bytes.len() < 16 * 1024, "request exceeded fixture limit");
                        bytes.push(socket.read_u8().await.unwrap());
                    }
                    String::from_utf8(bytes).unwrap()
                })
                .await
                .unwrap();
                requests.push(request);
                // A deliberately invalid response may make the client close
                // early. The client verdict and retained bytes are asserted.
                let _ = tokio::time::timeout(BOUND, socket.write_all(&reply.wire))
                    .await
                    .unwrap();
                if let Some(hold) = reply.hold {
                    let _ = tokio::time::timeout(BOUND, hold).await.unwrap();
                }
                let _ = socket.shutdown().await;
            }
            requests
        });
        Self {
            url,
            task: Some(task),
        }
    }

    async fn finish(mut self) -> Vec<String> {
        tokio::time::timeout(BOUND, self.task.as_mut().unwrap())
            .await
            .unwrap()
            .unwrap()
    }
}

impl Drop for Peer {
    fn drop(&mut self) {
        if let Some(task) = &self.task {
            task.abort();
        }
    }
}

fn response(status: &str, headers: &str, body: &[u8]) -> Vec<u8> {
    let mut wire = format!("HTTP/1.1 {status}\r\nConnection: close\r\n{headers}\r\n").into_bytes();
    wire.extend_from_slice(body);
    wire
}

fn full(size: usize, etag: &str, body: &[u8]) -> Vec<u8> {
    response("200 OK", &format!("Content-Length: {size}\r\n{etag}"), body)
}

fn partial(start: usize, end: usize, total: usize, body: &[u8]) -> Vec<u8> {
    response(
        "206 Partial Content",
        &format!(
            "ETag: \"v1\"\r\nContent-Range: bytes {start}-{end}/{total}\r\nContent-Length: {}\r\n",
            end - start + 1,
        ),
        body,
    )
}

async fn transfer(peer: &Peer, path: &Path, size: usize) -> AssetDownload {
    let client = client_builder().no_proxy().timeout(BOUND).build().unwrap();
    AssetDownload::with_client(client, &peer.url, path, size as u64)
        .await
        .unwrap()
}

fn request_header<'a>(request: &'a str, name: &str) -> Option<&'a str> {
    request
        .lines()
        .filter_map(|line| line.split_once(':'))
        .find(|(key, _)| key.eq_ignore_ascii_case(name))
        .map(|(_, value)| value.trim())
}

#[tokio::test]
async fn flushed_prefix_is_visible_before_eof_and_resumes_only_the_suffix() {
    let directory = tempfile::tempdir().unwrap();
    let path = directory.path().join("archive");
    let body: Vec<u8> = (0..131_073).map(|i| (i % 251) as u8).collect();
    let split = 65_537;
    let (release, hold) = oneshot::channel();
    let peer = Peer::new(vec![
        Reply {
            wire: full(body.len(), "ETag: \"v1\"\r\n", &body[..split]),
            hold: Some(hold),
        },
        partial(split, body.len() - 1, body.len(), &body[split..]).into(),
    ])
    .await;
    let mut download = transfer(&peer, &path, body.len()).await;
    let attempt = tokio::spawn(async move {
        let result = download.attempt().await;
        (download, result)
    });
    // The first response has not ended. Buffering the entire response before
    // writing (the old path) cannot meet this assertion, regardless of speed.
    let observed = tokio::time::timeout(BOUND, async {
        loop {
            if std::fs::metadata(&path).unwrap().len() == split as u64 {
                break;
            }
            tokio::time::sleep(Duration::from_millis(5)).await;
        }
    })
    .await;
    let before_eof = std::fs::read(&path).unwrap();
    let _ = release.send(());
    let (mut download, result) = tokio::time::timeout(BOUND, attempt).await.unwrap().unwrap();
    observed.expect("response chunks must reach disk before HTTP EOF");
    assert_eq!(before_eof, body[..split]);
    assert!(super::super::is_transient_error(&result.unwrap_err()));
    assert_eq!(download.offset, split as u64);
    download.attempt().await.unwrap();
    assert_eq!(std::fs::read(&path).unwrap(), body);
    let requests = peer.finish().await;
    assert_eq!(request_header(&requests[0], "Range"), None);
    assert_eq!(request_header(&requests[1], "Range"), Some("bytes=65537-"));
    assert_eq!(request_header(&requests[1], "If-Range"), Some("\"v1\""));
    assert!(
        requests
            .iter()
            .all(|r| request_header(r, "Accept-Encoding") == Some("identity"))
    );
}

#[tokio::test]
async fn ignored_ranges_or_changed_representations_replace_instead_of_concatenating() {
    for etag in ["ETag: \"v1\"\r\n", "ETag: \"v2\"\r\n", ""] {
        let directory = tempfile::tempdir().unwrap();
        let path = directory.path().join("archive");
        let peer = Peer::new(vec![
            full(10, "ETag: \"v1\"\r\n", b"OLD!").into(),
            full(10, etag, b"0123456789").into(),
        ])
        .await;
        let mut download = transfer(&peer, &path, 10).await;
        assert!(download.attempt().await.is_err());
        assert_eq!(std::fs::read(&path).unwrap(), b"OLD!");
        download.attempt().await.unwrap();
        assert_eq!(std::fs::read(&path).unwrap(), b"0123456789");
        let requests = peer.finish().await;
        assert_eq!(request_header(&requests[1], "Range"), Some("bytes=4-"));
    }
}

#[tokio::test]
async fn absent_or_weak_validators_force_a_fresh_request() {
    for etag in ["", "ETag: W/\"v1\"\r\n"] {
        let directory = tempfile::tempdir().unwrap();
        let path = directory.path().join("archive");
        let peer = Peer::new(vec![
            full(10, etag, b"OLD!").into(),
            full(10, "ETag: \"v2\"\r\n", b"0123456789").into(),
        ])
        .await;
        let mut download = transfer(&peer, &path, 10).await;
        assert!(download.attempt().await.is_err());
        download.attempt().await.unwrap();
        assert_eq!(std::fs::read(&path).unwrap(), b"0123456789");
        let requests = peer.finish().await;
        assert_eq!(request_header(&requests[1], "Range"), None);
        assert_eq!(request_header(&requests[1], "If-Range"), None);
    }
}

#[tokio::test]
async fn mismatched_or_duplicate_partial_headers_preserve_the_existing_prefix() {
    for headers in [
        "ETag: \"v2\"\r\nContent-Range: bytes 4-9/10\r\nContent-Length: 6\r\n",
        "ETag: \"v1\"\r\nContent-Range: bytes 3-8/10\r\nContent-Length: 6\r\n",
        "ETag: \"v1\"\r\nContent-Range: bytes 4-9/11\r\nContent-Length: 6\r\n",
        "ETag: \"v1\"\r\nContent-Range: bytes 4-9/10\r\nContent-Length: 7\r\n",
        "ETag: \"v1\"\r\nETag: \"v1\"\r\nContent-Range: bytes 4-9/10\r\nContent-Length: 6\r\n",
        "ETag: \"v1\"\r\nContent-Length: 6\r\n",
    ] {
        let directory = tempfile::tempdir().unwrap();
        let path = directory.path().join("archive");
        let peer = Peer::new(vec![
            full(10, "ETag: \"v1\"\r\n", b"0123").into(),
            response("206 Partial Content", headers, b"ATTACK!").into(),
        ])
        .await;
        let mut download = transfer(&peer, &path, 10).await;
        assert!(download.attempt().await.is_err());
        let error = download.attempt().await.unwrap_err();
        assert!(matches!(error, UpdateError::DownloadFailed(_)), "{error}");
        assert!(!super::super::is_transient_error(&error));
        assert_eq!(std::fs::read(&path).unwrap(), b"0123");
        assert_eq!(peer.finish().await.len(), 2);
    }
}

#[tokio::test]
async fn refused_ranges_require_a_new_full_response_never_infer_completion() {
    for status in ["412 Precondition Failed", "416 Range Not Satisfiable"] {
        let directory = tempfile::tempdir().unwrap();
        let path = directory.path().join("archive");
        let peer = Peer::new(vec![
            full(10, "ETag: \"v1\"\r\n", b"0123").into(),
            response(
                status,
                "Content-Range: bytes */4\r\nContent-Length: 0\r\n",
                b"",
            )
            .into(),
            full(10, "ETag: \"v2\"\r\n", b"9876543210").into(),
        ])
        .await;
        let mut download = transfer(&peer, &path, 10).await;
        assert!(download.attempt().await.is_err());
        let error = download.attempt().await.unwrap_err();
        assert!(super::super::is_transient_error(&error));
        assert_eq!(std::fs::read(&path).unwrap(), b"0123");
        download.attempt().await.unwrap();
        assert_eq!(std::fs::read(&path).unwrap(), b"9876543210");
        let requests = peer.finish().await;
        assert_eq!(request_header(&requests[1], "Range"), Some("bytes=4-"));
        assert_eq!(request_header(&requests[2], "Range"), None);
    }
}

#[tokio::test]
async fn transient_status_keeps_the_prefix_and_short_contiguous_ranges_progress() {
    let directory = tempfile::tempdir().unwrap();
    let path = directory.path().join("archive");
    let peer = Peer::new(vec![
        full(10, "ETag: \"v1\"\r\n", b"0123").into(),
        response("503 Service Unavailable", "Content-Length: 0\r\n", b"").into(),
        partial(4, 6, 10, b"456").into(),
        partial(7, 9, 10, b"789").into(),
    ])
    .await;
    let mut download = transfer(&peer, &path, 10).await;
    for expected in [4, 4, 7] {
        let error = download.attempt().await.unwrap_err();
        assert!(super::super::is_transient_error(&error), "{error}");
        assert_eq!(download.offset, expected);
    }
    download.attempt().await.unwrap();
    assert_eq!(std::fs::read(&path).unwrap(), b"0123456789");
    let requests = peer.finish().await;
    assert_eq!(request_header(&requests[2], "Range"), Some("bytes=4-"));
    assert_eq!(request_header(&requests[3], "Range"), Some("bytes=7-"));
}

#[tokio::test]
async fn chunked_bodies_obey_metadata_size_without_content_length() {
    for length in [9, 10, 11] {
        let directory = tempfile::tempdir().unwrap();
        let path = directory.path().join("archive");
        let body = format!("{length:x}\r\n{}\r\n0\r\n\r\n", "x".repeat(length));
        let peer = Peer::new(vec![
            response("200 OK", "Transfer-Encoding: chunked\r\n", body.as_bytes()).into(),
        ])
        .await;
        let mut download = transfer(&peer, &path, 10).await;
        let result = download.attempt().await;
        if length == 10 {
            result.unwrap();
        } else if length < 10 {
            assert!(super::super::is_transient_error(&result.unwrap_err()));
        } else {
            assert!(matches!(result, Err(UpdateError::DownloadFailed(_))));
        }
        assert!(std::fs::metadata(&path).unwrap().len() <= 10);
        peer.finish().await;
    }
}

#[tokio::test]
async fn complete_range_bytes_still_require_a_valid_signature() {
    // The independently signed fixture already used by update::verify tests.
    let payload = b"rch minisign test payload v1\n";
    let signature = "untrusted comment: signature from minisign secret key\n\
RUTZPaZ0gaEhqDSXunnChY49+8G9WeMdP7wwnCG9s382LwYf7h09hfwypAG0pKwYrhcX+N1Ujyzv1r4ZpRClO4To6jTL1DR1ewo=\n\
trusted comment: rch test fixture\n\
xfmvGjlaWGXfdNKtFwBNm45V0V6VPZ3lLFhIzfLmQ7xUjPzacD1iHPC0MO2oczUBCt2gAZtoGnuQMxpswMpMCw==\n";
    let key = minisign_verify::PublicKey::from_base64(
        "RWTZPaZ0gaEhqMa/pPZEdaALWkxxAm/EtQzB6egPldD4Uh1cCRlw/b0w",
    )
    .unwrap();
    for tamper in [false, true] {
        let directory = tempfile::tempdir().unwrap();
        let path = directory.path().join("archive");
        let mut body = payload.to_vec();
        if tamper {
            body[8] ^= 1;
        }
        let split = 7;
        let peer = Peer::new(vec![
            full(body.len(), "ETag: \"v1\"\r\n", &body[..split]).into(),
            partial(split, body.len() - 1, body.len(), &body[split..]).into(),
        ])
        .await;
        let mut download = transfer(&peer, &path, body.len()).await;
        assert!(download.attempt().await.is_err());
        download.attempt().await.unwrap();
        let downloaded = std::fs::read(&path).unwrap();
        let signature = minisign_verify::Signature::decode(signature).unwrap();
        assert_eq!(key.verify(&downloaded, &signature, false).is_ok(), !tamper);
        peer.finish().await;
    }
}

#[tokio::test]
async fn existing_files_and_zero_attempts_are_never_overwritten() {
    let directory = tempfile::tempdir().unwrap();
    let path = directory.path().join("keep");
    std::fs::write(&path, b"caller bytes").unwrap();
    assert!(
        AssetDownload::new("http://127.0.0.1:1/unused", &path, 12)
            .await
            .is_err()
    );
    assert_eq!(std::fs::read(&path).unwrap(), b"caller bytes");
    let never_created = directory.path().join("absent");
    let result = super::super::download_with_retry(
        "http://127.0.0.1:1/unused",
        &never_created,
        "unused",
        12,
        0,
    )
    .await;
    assert!(matches!(result, Err(UpdateError::DownloadFailed(_))));
    assert!(!never_created.exists());
}