ping-rust 0.3.2

Menu-driven installer and manager for the shoes proxy server
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
use super::{temporary::Temporary, Mode};
use anyhow::{bail, Context, Result};
use serde_json::{json, Value};
use std::{path::Path, time::Duration};

const TIMEOUT: Duration = Duration::from_secs(10);

fn configuration(
    domain: &str,
    target: &str,
    mode: Mode,
    server_port: u16,
    socks_port: u16,
) -> Result<(String, Vec<String>)> {
    let (server, client, secrets) = match mode {
        Mode::Reality => {
            let key = crate::config::generate_reality_keypair();
            let user = uuid::Uuid::new_v4().to_string();
            let sid = hex::encode(rand::random::<[u8; 8]>());
            (
                json!({"type":"tls", "reality_targets":{(domain):{
                    "private_key":key.private_key, "short_ids":[sid], "dest":target,
                    "max_time_diff":crate::config::GenerationOptions::default().reality_max_time_diff,
                    "vision":true,
                    "protocol":{"type":"vless", "user_id":user, "udp_enabled":false}
                }}}),
                json!({"type":"reality", "public_key":key.public_key,
                    "short_id":sid, "sni_hostname":domain, "vision":true,
                    "protocol":{"type":"vless", "user_id":user, "udp_enabled":false}
                }),
                vec![key.private_key, key.public_key, user, sid],
            )
        }
        Mode::ShadowTls => {
            let password = crate::config::generated_password();
            let ss_password = crate::config::generate_shadowsocks_password(
                crate::config::ShadowsocksCipher::Aes128Gcm2022,
            );
            let inner = json!({"type":"shadowsocks", "cipher":"2022-blake3-aes-128-gcm", "password":ss_password, "udp_enabled":false});
            (
                json!({"type":"tls", "shadowtls_targets":{(domain):{
                    "password":password, "handshake":{"address":target}, "protocol":inner
                }}}),
                json!({"type":"shadowtls", "password":password, "sni_hostname":domain, "protocol":inner}),
                vec![password, ss_password],
            )
        }
    };
    let rules = json!([{"masks":["0.0.0.0/0", "::/0"], "action":"allow"}]);
    let config: Value = json!([
        {"address":format!("127.0.0.1:{server_port}"), "protocol":server, "rules":rules},
        {"address":format!("127.0.0.1:{socks_port}"), "protocol":{"type":"socks", "udp_enabled":false},
         "rules":[{"masks":["0.0.0.0/0", "::/0"], "action":"allow", "client_chains":[{"address":format!("127.0.0.1:{server_port}"), "protocol":client}]}]}
    ]);
    let yaml = crate::yaml::to_string(&config).context("生成 SNI 本机预检配置失败")?;
    Ok((yaml, secrets))
}

pub(super) async fn run(domain: &str, mode: Mode) -> Result<()> {
    let binary = std::env::var_os("PING_RUST_TEST_SHOES")
        .or_else(|| std::env::var_os("PING_RUST_SHOES_E2E_BIN"))
        .unwrap_or_else(|| crate::utils::SHOES_BIN.into());
    let url = std::env::var("PING_RUST_SNI_TEST_URL")
        .or_else(|_| std::env::var("PING_RUST_CHAIN_TEST_URL"))
        .unwrap_or_else(|_| "https://www.gstatic.com/generate_204".to_owned());
    run_with(
        domain,
        &format!("{domain}:443"),
        mode,
        Path::new(&binary),
        &url,
        TIMEOUT,
    )
    .await
}

async fn run_with(
    domain: &str,
    target: &str,
    mode: Mode,
    binary: &Path,
    url: &str,
    timeout: Duration,
) -> Result<()> {
    // 与 Chain 测试一样:私有目录、dry-run、kill_on_drop、等待 SOCKS 入口、经代理请求。
    // 外层 deadline 包括 dry-run、启动和 HTTP,取消 future 也会析构 Temporary。
    let temporary = Temporary::new()?;
    // 保留在 timeout future 外,整体超时取消操作后仍能在目录析构前脱敏日志。
    let mut secrets = Vec::new();
    match tokio::time::timeout(timeout, async {
        if !binary.is_file() {
            bail!("未找到 shoes,请先运行 prs install 后重新检测");
        }
        // 同时保留两个端口,避免内核连续分配同一个空闲端口。
        let server = std::net::TcpListener::bind(("127.0.0.1", 0))
            .context("无法绑定本机预检端口,请检查系统权限")?;
        let socks =
            std::net::TcpListener::bind(("127.0.0.1", 0)).context("无法绑定本机 SOCKS 测试端口")?;
        let server_port = server.local_addr()?.port();
        let socks_port = socks.local_addr()?.port();
        let path = temporary.path().join("probe.yaml");
        let (yaml, credentials) = configuration(domain, target, mode, server_port, socks_port)?;
        secrets = credentials;
        crate::utils::atomic_write(&path, yaml.as_bytes(), 0o600)?;
        temporary.spawn(binary, &["--dry-run".as_ref(), path.as_os_str()])?;
        if !temporary.wait().await?.success() {
            bail!(
                "shoes 拒绝本机预检配置,请确认已安装项目固定版本的 shoes;{}",
                temporary.log_notice(&secrets)
            );
        }
        drop((server, socks));
        temporary.spawn(binary, &[path.as_os_str()])?;
        loop {
            if let Some(status) = temporary.status()? {
                bail!(
                    "临时 shoes 提前退出({status}),请检查内核版本和端口权限;{}",
                    temporary.log_notice(&secrets)
                );
            }
            if tokio::net::TcpStream::connect(("127.0.0.1", socks_port))
                .await
                .is_ok()
            {
                break;
            }
            tokio::time::sleep(Duration::from_millis(50)).await;
        }
        let client = reqwest::Client::builder()
            .no_proxy()
            .proxy(reqwest::Proxy::all(format!(
                "socks5h://127.0.0.1:{socks_port}"
            ))?)
            .timeout(timeout)
            .redirect(reqwest::redirect::Policy::none())
            .build()?;
        let response = match client.get(url).send().await {
            Ok(response) => response,
            Err(error) => {
                temporary.settle_log().await;
                return Err(anyhow::Error::new(error).context(format!(
                    "经 shoes 的请求失败,请更换候选或检查 VPS 出站网络;{}",
                    temporary.log_notice(&secrets)
                )));
            }
        };
        if response.status() != reqwest::StatusCode::NO_CONTENT {
            temporary.settle_log().await;
            bail!(
                "shoes 请求返回 {},预期 204,请检查探测地址或更换候选;{}",
                response.status(),
                temporary.log_notice(&secrets)
            );
        }
        Ok(())
    })
    .await
    {
        Ok(result) => result,
        Err(_) => {
            temporary.settle_log().await;
            bail!(
                "shoes 本机预检整体超时(10 秒),请检查网络或更换候选;{}",
                temporary.log_notice(&secrets)
            )
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::shoes_e2e::{shoes_binary, SHOES_E2E_BIN, TEST_SHOES};
    use std::{net::SocketAddr, path::PathBuf, sync::Arc};
    use tokio::{
        io::{AsyncReadExt, AsyncWriteExt},
        net::TcpListener,
        task::JoinHandle,
    };

    struct Target {
        address: SocketAddr,
        task: JoinHandle<()>,
    }
    impl Drop for Target {
        fn drop(&mut self) {
            self.task.abort();
        }
    }

    /// 预检先占住空闲端口、释放后再启动 shoes。正式路径逐个候选串行检测;
    /// cargo 并行跑测试时,另一个用例可能在释放间隙拿到同一端口,所以需要 shoes 的用例串行执行。
    static SHOES_E2E: tokio::sync::Mutex<()> = tokio::sync::Mutex::const_new(());

    fn shoes(test: &str) -> Option<PathBuf> {
        let test = format!("sni::preflight::tests::{test}");
        shoes_binary(&test, &[TEST_SHOES, SHOES_E2E_BIN])
    }

    #[test]
    fn reality_preflight_uses_production_time_tolerance() {
        let (yaml, _) = configuration(
            "example.com",
            "example.com:443",
            Mode::Reality,
            20001,
            20002,
        )
        .unwrap();
        let value: Value = crate::yaml::from_str(&yaml).unwrap();
        let tolerance = value[0]["protocol"]["reality_targets"]["example.com"]["max_time_diff"]
            .as_u64()
            .unwrap();
        assert_eq!(
            tolerance,
            crate::config::GenerationOptions::default().reality_max_time_diff
        );
        assert!(tolerance > 0);
    }

    #[test]
    fn shadowtls_preflight_matches_server_and_client_credentials() {
        let (yaml, _) = configuration(
            "example.com",
            "127.0.0.1:20003",
            Mode::ShadowTls,
            20001,
            20002,
        )
        .unwrap();
        let value: Value = crate::yaml::from_str(&yaml).unwrap();
        let server = &value[0]["protocol"]["shadowtls_targets"]["example.com"];
        let client = &value[1]["rules"][0]["client_chains"][0]["protocol"];
        assert_eq!(server["handshake"]["address"], "127.0.0.1:20003");
        assert_eq!(client["type"], "shadowtls");
        assert_eq!(client["sni_hostname"], "example.com");
        assert!(!server["password"].as_str().unwrap().is_empty());
        assert!(server["password"] == client["password"]);
        assert!(server["protocol"] == client["protocol"]);
        assert_eq!(client["protocol"]["type"], "shadowsocks");
        assert_eq!(client["protocol"]["udp_enabled"], false);
        assert_eq!(client["protocol"]["cipher"], "2022-blake3-aes-128-gcm");
        use base64::Engine;
        let password = base64::engine::general_purpose::STANDARD
            .decode(client["protocol"]["password"].as_str().unwrap())
            .unwrap();
        assert_eq!(password.len(), 16);
    }

    #[test]
    fn configurations_return_all_credentials_for_redaction() {
        for mode in [Mode::Reality, Mode::ShadowTls] {
            let (yaml, secrets) =
                configuration("example.com", "example.com:443", mode, 20001, 20002).unwrap();
            let value: Value = crate::yaml::from_str(&yaml).unwrap();
            let client = &value[1]["rules"][0]["client_chains"][0]["protocol"];
            let expected = match mode {
                Mode::Reality => vec![
                    &value[0]["protocol"]["reality_targets"]["example.com"]["private_key"],
                    &client["public_key"],
                    &client["protocol"]["user_id"],
                    &client["short_id"],
                ],
                Mode::ShadowTls => vec![&client["password"], &client["protocol"]["password"]],
            };
            assert_eq!(
                secrets,
                expected
                    .into_iter()
                    .map(|value| value.as_str().unwrap())
                    .collect::<Vec<_>>()
            );
            assert!(secrets.iter().all(|secret| !secret.is_empty()));
        }
    }

    fn tls_config(version: &'static rustls::SupportedProtocolVersion) -> rustls::ServerConfig {
        let rcgen::CertifiedKey { cert, key_pair } =
            rcgen::generate_simple_self_signed(vec!["example.com".to_owned()]).unwrap();
        let mut config = rustls::ServerConfig::builder_with_provider(Arc::new(
            rustls::crypto::ring::default_provider(),
        ))
        .with_protocol_versions(&[version])
        .unwrap()
        .with_no_client_auth()
        .with_single_cert(
            vec![cert.der().clone()],
            rustls::pki_types::PrivatePkcs8KeyDer::from(key_pair.serialize_der()).into(),
        )
        .unwrap();
        config.alpn_protocols = vec![b"h2".to_vec(), b"http/1.1".to_vec()];
        config
    }

    #[test]
    fn local_tls13_target_flight_matches_shoes_requirements() {
        // 在内存中检查实际 TLS 记录,不依赖 shoes 或监听端口。
        let client_config = rustls::ClientConfig::builder_with_provider(Arc::new(
            rustls::crypto::ring::default_provider(),
        ))
        .with_protocol_versions(&[&rustls::version::TLS13])
        .unwrap()
        .with_root_certificates(rustls::RootCertStore::empty())
        .with_no_client_auth();
        let mut client = rustls::ClientConnection::new(
            Arc::new(client_config),
            "example.com".try_into().unwrap(),
        )
        .unwrap();
        let mut hello = Vec::new();
        client.write_tls(&mut hello).unwrap();
        let mut server =
            rustls::ServerConnection::new(Arc::new(tls_config(&rustls::version::TLS13))).unwrap();
        server.read_tls(&mut hello.as_slice()).unwrap();
        server.process_new_packets().unwrap();
        let mut flight = Vec::new();
        server.write_tls(&mut flight).unwrap();
        let mut records = Vec::new();
        let mut remaining = flight.as_slice();
        while !remaining.is_empty() {
            assert!(remaining.len() >= 5);
            let length = u16::from_be_bytes([remaining[3], remaining[4]]) as usize;
            records.push((remaining[0], length));
            remaining = &remaining[5 + length..];
        }
        assert_eq!(
            records.len(),
            3,
            "shoes(v0.3.6 起)要求三条记录:{records:?}"
        );
        assert_eq!(records[0].0, 22);
        assert_eq!(records[1], (20, 1));
        assert_eq!(records[2].0, 23);
        assert!(
            records[2].1 > 512,
            "shoes(v0.3.6 起)要求合并加密记录大于 512 字节:{records:?}"
        );
    }

    async fn tls_target(version: &'static rustls::SupportedProtocolVersion) -> Target {
        let config = Arc::new(tls_config(version));
        let listener = TcpListener::bind(("127.0.0.1", 0)).await.unwrap();
        let address = listener.local_addr().unwrap();
        let task = tokio::spawn(async move {
            let mut connections = tokio::task::JoinSet::new();
            loop {
                tokio::select! {
                    result = listener.accept() => {
                        let (stream, _) = result.unwrap();
                        let config = config.clone();
                        connections.spawn(async move {
                            if let Ok(mut tls) = tokio_rustls::TlsAcceptor::from(config).accept(stream).await {
                                let mut buffer = [0u8; 4096];
                                while tls.read(&mut buffer).await.is_ok_and(|n| n > 0) {}
                            }
                        });
                    }
                    _ = connections.join_next(), if !connections.is_empty() => {}
                }
            }
        });
        Target { address, task }
    }

    async fn origin() -> Target {
        let listener = TcpListener::bind(("127.0.0.1", 0)).await.unwrap();
        let address = listener.local_addr().unwrap();
        let task = tokio::spawn(async move {
            let (mut stream, _) = listener.accept().await.unwrap();
            let mut request = [0u8; 4096];
            assert!(stream.read(&mut request).await.unwrap() > 0);
            stream
                .write_all(b"HTTP/1.1 204 No Content\r\nConnection: close\r\n\r\n")
                .await
                .unwrap();
        });
        Target { address, task }
    }

    #[tokio::test]
    async fn local_sni_preflight_accepts_local_tls13_target() {
        let Some(binary) = shoes("local_sni_preflight_accepts_local_tls13_target") else {
            return;
        };
        let _serial = SHOES_E2E.lock().await;
        let target = tls_target(&rustls::version::TLS13).await;
        // shoes(v0.3.6 起)的 Reality dest 必须是域名,IP 会被拒绝(REALITY requires a hostname destination)。
        let target_address = format!("localhost:{}", target.address.port());
        for mode in [Mode::Reality, Mode::ShadowTls] {
            let origin = origin().await;
            run_with(
                "example.com",
                &target_address,
                mode,
                &binary,
                &format!("http://{}/generate_204", origin.address),
                TIMEOUT,
            )
            .await
            .expect("本地 TLS1.3 目标的 shoes 预检应返回 204");
        }
    }

    #[tokio::test]
    async fn local_sni_preflight_rejects_tls12_target() {
        let Some(binary) = shoes("local_sni_preflight_rejects_tls12_target") else {
            return;
        };
        let _serial = SHOES_E2E.lock().await;
        let target = tls_target(&rustls::version::TLS12).await;
        let origin = origin().await;
        // 用域名,确保失败原因是 TLS1.2 目标,而不是 Reality 拒绝 IP dest。
        let error = run_with(
            "example.com",
            &format!("localhost:{}", target.address.port()),
            Mode::Reality,
            &binary,
            &format!("http://{}/generate_204", origin.address),
            TIMEOUT,
        )
        .await
        .unwrap_err();
        assert!(
            error.to_string().contains("经 shoes") || error.to_string().contains("超时"),
            "必须在握手/请求阶段失败:{error:#}"
        );
        assert!(
            error.to_string().contains("ProtocolVersion"),
            "应附上 shoes 的 TLS 版本错误:{error:#}"
        );
    }

    #[tokio::test]
    async fn local_sni_preflight_rejects_reality_ip_destination() {
        let Some(binary) = shoes("local_sni_preflight_rejects_reality_ip_destination") else {
            return;
        };
        let _serial = SHOES_E2E.lock().await;
        let target = tls_target(&rustls::version::TLS13).await;
        let origin = origin().await;
        let error = run_with(
            "example.com",
            &target.address.to_string(),
            Mode::Reality,
            &binary,
            &format!("http://{}/generate_204", origin.address),
            TIMEOUT,
        )
        .await
        .unwrap_err();
        assert!(
            error.to_string().contains("hostname destination"),
            "应附上 shoes 拒绝 Reality IP dest 的原因:{error:#}"
        );
    }

    #[tokio::test]
    async fn local_sni_preflight_timeout_cleans_process_and_private_files() {
        let test = "local_sni_preflight_timeout_cleans_process_and_private_files";
        let Some(binary) = shoes(test) else {
            return;
        };
        let _serial = SHOES_E2E.lock().await;
        // 直接观察预检使用的相同 RAII 资源;目标不响应时外层 deadline 取消操作。
        let temporary = Temporary::new().unwrap();
        let directory = temporary.path();
        let listener = std::net::TcpListener::bind(("127.0.0.1", 0)).unwrap();
        let port = listener.local_addr().unwrap().port();
        let path = directory.join("probe.yaml");
        crate::utils::atomic_write(&path, format!("- address: 127.0.0.1:{port}\n  protocol:\n    type: socks\n    udp_enabled: false\n").as_bytes(), 0o600).unwrap();
        #[cfg(unix)]
        {
            use std::os::unix::fs::PermissionsExt;
            assert_eq!(
                std::fs::metadata(&directory).unwrap().permissions().mode() & 0o777,
                0o700
            );
            assert_eq!(
                std::fs::metadata(&path).unwrap().permissions().mode() & 0o777,
                0o600
            );
        }
        temporary
            .spawn(&binary, &["--dry-run".as_ref(), path.as_os_str()])
            .unwrap();
        assert!(temporary.wait().await.unwrap().success());
        drop(listener);
        temporary.spawn(&binary, &[path.as_os_str()]).unwrap();
        let pid = temporary.child_id().unwrap();
        let result = tokio::time::timeout(Duration::from_millis(200), temporary.wait()).await;
        assert!(result.is_err(), "测试进程应一直运行到 deadline");
        drop(temporary);
        assert!(!directory.exists());
        #[cfg(target_os = "linux")]
        assert!(
            !Path::new(&format!("/proc/{pid}")).exists(),
            "超时后不应遗留 shoes 进程"
        );
        assert!(
            std::net::TcpListener::bind(("127.0.0.1", port)).is_ok(),
            "超时后端口必须释放"
        );
    }

    #[test]
    fn configurations_only_listen_on_loopback_and_use_one_sni() {
        for mode in [Mode::Reality, Mode::ShadowTls] {
            let (yaml, _) =
                configuration("example.com", "example.com:443", mode, 20001, 20002).unwrap();
            let value: Value = crate::yaml::from_str(&yaml).unwrap();
            assert_eq!(value[0]["address"], "127.0.0.1:20001");
            assert_eq!(value[1]["address"], "127.0.0.1:20002");
            let targets = if mode == Mode::Reality {
                "reality_targets"
            } else {
                "shadowtls_targets"
            };
            assert_eq!(value[0]["protocol"][targets].as_object().unwrap().len(), 1);
            assert!(value[0]["protocol"][targets].get("example.com").is_some());
            assert!(value[1]["rules"][0]["client_chains"].is_array());
        }
    }
}