Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ edition = "2024"
license = "Apache-2.0"

[dependencies]
vnt-core = { path = "vnt-core" }
vnt-ipc = { path = "vnt-ipc", optional = true }
vnt-web = { path = "vnt-web", optional = true }
clap = { version = "4.5", features = ["derive", "env"] }
Expand All @@ -17,6 +18,7 @@ log.workspace = true
log4rs = "1.4"

serde.workspace = true
serde_json.workspace = true
anyhow.workspace = true
toml.workspace = true
hostname.workspace = true
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ NAS、跨地区协作等场景。
- **ping 不通对方?** 请确认两边组网编号、服务端地址完全一致,且均已启动组网;防火墙可能拦截 ICMP,可使用共享文件夹等实际业务进行验证。
- **没有公网服务器?** 可先使用公共服务端 `vnt2.rustvnt.com:29872` 体验;正式使用建议自建服务端,以获得更好的稳定性和私密性。
- **不希望修改系统网络设置?** 可将设备模式设为 `no`(无网卡模式),仅提供流量出口和端口映射,无需管理员权限。
- **同时装了桌面端和命令行,虚拟网里所有设备都 ping 不通?** 同一台机器、同一个组网编号只允许一个客户端运行。设备标识取自机器标识(`machine_uid`),两个客户端会算出同一个设备 ID,服务端因此把后连上的当成"同一设备的新连接"而踢掉先连上的,双方随即互相重连、无限循环——表现为全网都不通,而对端本身完全正常。现在第二个实例会被直接拒绝并打印已有客户端的状态(退出码 0),按提示退出多余的那个即可。不同组网编号互不影响。

## 安全说明

Expand Down
204 changes: 204 additions & 0 deletions src/instance_probe.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
//! 抢锁失败后的探测:找出本机已有的客户端,把它的状态打印出来。
//!
//! 单实例锁只能告诉调用方"已被占用",但用户真正需要知道的是"谁在占用、
//! 现在是什么状态"。这里依次尝试两条路径:
//!
//! 1. `vnt2_cli` 的 ctrl IPC(完整状态),由 [`crate::main_cli`] 直接调用
//! `vnt_ipc::client`,因此不在本模块内。
//! 2. VNT Desktop 内核的 HTTP API:先读它写下的 `web_access.toml` 拿到
//! 监听地址与令牌,再请求 `/api/instances` 列出实例。
//!
//! 探测是"尽力而为"的:任何一步失败都只降级为更少的输出,不影响主流程。

use std::path::PathBuf;
use std::time::Duration;
use tokio::io::{AsyncReadExt, AsyncWriteExt};

/// 桌面端内核未写配置时的默认监听端口。
const DEFAULT_KERNEL_PORT: u16 = 19099;
const CONNECT_TIMEOUT: Duration = Duration::from_millis(1200);
const READ_TIMEOUT: Duration = Duration::from_millis(1500);
/// 探测响应只需要一小段 JSON,超过这个体积一律截断。
const MAX_RESPONSE_BYTES: u64 = 64 * 1024;

/// VNT Desktop 内核记录下来的接入信息(字段与 `web_access.toml` 对应)。
#[derive(Debug, serde::Deserialize)]
struct KernelAccess {
#[serde(default = "default_listen_address")]
listen_address: String,
#[serde(default = "default_kernel_port")]
port: u16,
#[serde(default)]
token: String,
}

fn default_listen_address() -> String {
"127.0.0.1".to_string()
}

fn default_kernel_port() -> u16 {
DEFAULT_KERNEL_PORT
}

#[derive(Debug, serde::Deserialize)]
struct ApiEnvelope<T> {
#[serde(default)]
code: i32,
#[serde(default)]
msg: String,
data: Option<T>,
}

#[derive(Debug, serde::Deserialize)]
struct InstanceSummary {
#[serde(default)]
config_name: String,
#[serde(default)]
status: String,
}

/// 探测 VNT Desktop 内核,返回可直接打印的状态描述。
///
/// `None` 表示没有探测到桌面端内核在运行。
pub async fn probe_desktop_kernel() -> Option<String> {
let access = read_kernel_access()?;
let addr = format!("{}:{}", access.listen_address, access.port);
let body = http_get_body(&addr, "/api/instances", &access.token).await?;
let envelope: ApiEnvelope<Vec<InstanceSummary>> = serde_json::from_str(&body).ok()?;
if envelope.code != 0 {
return Some(format!(
"VNT Desktop 内核在 {addr} 运行,但查询实例失败:{}",
envelope.msg
));
}
let instances = envelope.data.unwrap_or_default();
let mut lines = vec![format!("VNT Desktop 内核在 {addr} 运行,实例:")];
if instances.is_empty() {
lines.push(" (暂无配置)".to_string());
}
for instance in instances {
let name = if instance.config_name.is_empty() {
"未命名配置".to_string()
} else {
instance.config_name
};
let status = if instance.status.is_empty() {
"未知".to_string()
} else {
instance.status
};
lines.push(format!(" - {name}:{status}"));
}
Some(lines.join("\n"))
}

/// 读取桌面端内核写入的 `web_access.toml`。
fn read_kernel_access() -> Option<KernelAccess> {
for path in kernel_access_candidates() {
let Ok(content) = std::fs::read_to_string(&path) else {
continue;
};
let Ok(access) = toml::from_str::<KernelAccess>(&content) else {
continue;
};
return Some(access);
}
None
}

/// 桌面端数据目录的候选位置,按平台排列。
fn kernel_access_candidates() -> Vec<PathBuf> {
let mut candidates = Vec::new();
if let Some(appdata) = std::env::var_os("APPDATA") {
candidates.push(PathBuf::from(&appdata).join("com.vnt.desktop").join("web_access.toml"));
}
if let Some(config) = std::env::var_os("XDG_CONFIG_HOME") {
candidates.push(PathBuf::from(&config).join("com.vnt.desktop").join("web_access.toml"));
}
if let Some(home) = std::env::var_os("HOME") {
let home = PathBuf::from(home);
candidates.push(home.join(".config/com.vnt.desktop/web_access.toml"));
candidates.push(
home.join("Library/Application Support/com.vnt.desktop/web_access.toml"),
);
}
if let Some(local) = std::env::var_os("LOCALAPPDATA") {
candidates.push(PathBuf::from(&local).join("com.vnt.desktop").join("web_access.toml"));
}
candidates
}

/// 最小 HTTP/1.1 GET:只取响应体。
///
/// 不用现成的 HTTP 客户端是刻意的——探测发生在启动失败路径上,不应引入
/// TLS provider 之类的额外初始化负担;失败一律返回 `None` 由调用方降级。
async fn http_get_body(addr: &str, path: &str, token: &str) -> Option<String> {
// 令牌直接拼进请求头,先排除 CR/LF,避免注入额外的头。
if token.bytes().any(|byte| byte == b'\r' || byte == b'\n') {
return None;
}
let mut stream = tokio::time::timeout(CONNECT_TIMEOUT, tokio::net::TcpStream::connect(addr))
.await
.ok()?
.ok()?;
let request = format!(
"GET {path} HTTP/1.1\r\nHost: {addr}\r\nAuthorization: Bearer {token}\r\n\
Connection: close\r\n\r\n"
);
stream.write_all(request.as_bytes()).await.ok()?;
// 限制响应体积:探测只需要一小段 JSON,异常对端不该把内存打满。
let mut reader = stream.take(MAX_RESPONSE_BYTES);
let mut buffer = Vec::new();
tokio::time::timeout(READ_TIMEOUT, reader.read_to_end(&mut buffer))
.await
.ok()?
.ok()?;
let response = String::from_utf8_lossy(&buffer);
let (head, body) = response.split_once("\r\n\r\n")?;
// 未处理分块编码:桌面端返回的是定长 JSON,分块场景直接放弃解析。
if head.to_ascii_lowercase().contains("transfer-encoding: chunked") {
return None;
}
let status_ok = head
.lines()
.next()
.is_some_and(|line| line.contains(" 200"));
if !status_ok {
return None;
}
Some(body.trim().to_string())
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn kernel_access_defaults_are_localhost() {
let access: KernelAccess = toml::from_str("").expect("空配置应可用默认值");
assert_eq!(access.listen_address, "127.0.0.1");
assert_eq!(access.port, DEFAULT_KERNEL_PORT);
assert!(access.token.is_empty());
}

#[test]
fn kernel_access_parses_desktop_file() {
let access: KernelAccess = toml::from_str(
"listen_address = \"127.0.0.1\"\nport = 19099\ntoken = \"0123456789abcdef\"\n",
)
.expect("应能解析桌面端写入的配置");
assert_eq!(access.port, 19099);
assert_eq!(access.token, "0123456789abcdef");
}

#[test]
fn instance_summary_tolerates_missing_fields() {
let envelope: ApiEnvelope<Vec<InstanceSummary>> =
serde_json::from_str(r#"{"code":0,"msg":"success","data":[{"config_name":"home"}]}"#)
.expect("缺失字段应可解析");
let instances = envelope.data.expect("data 应存在");
assert_eq!(instances.len(), 1);
assert_eq!(instances[0].config_name, "home");
assert!(instances[0].status.is_empty());
}
}
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
pub mod instance_probe;
pub mod log;
39 changes: 37 additions & 2 deletions src/main_cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,44 @@ mod extract_wintun_dll;

#[tokio::main]
pub async fn main() {
if let Err(error) = main0().await {
log::error!("{error:?}");
match main0().await {
Ok(()) => {}
Err(error) => {
// 已有实例在跑属于正常情况(用户重复启动),不算失败:
// 输出它的状态后按成功退出,避免脚本把它当成错误。
if report_existing_client(&error).await {
return;
}
log::error!("{error:?}");
}
}
}

/// 若错误是单实例锁被占用,输出本机已有客户端的状态并返回 `true`。
///
/// 优先询问 `vnt2_cli` 的 ctrl IPC(能给出完整的服务器/地址/节点信息),
/// 拿不到再退到 VNT Desktop 内核的 HTTP API。
async fn report_existing_client(error: &anyhow::Error) -> bool {
let Some(held) = error.downcast_ref::<vnt_core::utils::instance_lock::LockHeld>() else {
return false;
};
println!("本机已有 VNT 客户端在为同一网络运行,无需重复启动。");
println!("(单实例锁:{})", held.name);
println!();
let ctrl_cmd = vnt_ipc::message::ipc_request::IpcCmd::AppInfo(Default::default());
if vnt_ipc::client::run_client(ctrl_cmd, None).await.is_ok() {
return true;
}
match vnt2::instance_probe::probe_desktop_kernel().await {
Some(status) => {
println!("{status}");
}
None => {
println!("未能查询到已有客户端的状态,请检查 VNT Desktop 是否在运行,");
println!("或本机是否有其它 vnt2_cli / vnt2_web 进程。");
}
}
true
}

async fn main0() -> anyhow::Result<()> {
Expand Down
7 changes: 7 additions & 0 deletions src/main_web.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,13 @@ impl DesktopKernelConfig {

fn main() {
if let Err(error) = run() {
// 已有实例在同一网络上注册属于正常情况(用户重复启动),
// 说明清楚后按成功退出,不把它当成程序故障。
if let Some(held) = error.downcast_ref::<vnt_core::utils::instance_lock::LockHeld>() {
eprintln!("本机已有 VNT 客户端在为同一网络运行(单实例锁:{})。", held.name);
eprintln!("请先退出已有的客户端(VNT Desktop 或 vnt2_cli)再启动。");
return;
}
eprintln!("{error:#}");
std::process::exit(1);
}
Expand Down
2 changes: 1 addition & 1 deletion vnt-core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ route_manager.workspace = true
[target.'cfg(target_os = "windows")'.dependencies]
winapi = { version = "0.3.9", features = ["winreg"] }
widestring = "1.2"
windows-sys = { version = "0.61", features = ["Win32_Networking_WinSock"] }
windows-sys = { version = "0.61", features = ["Win32_Networking_WinSock", "Win32_Foundation", "Win32_System_Threading"] }

[target.'cfg(unix)'.dependencies]
libc = "0.2"
Expand Down
23 changes: 23 additions & 0 deletions vnt-core/src/core/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,14 @@ pub struct NetworkManager {
/// FEC 编码句柄:保留它使 `fec` 开关可以在运行期双向切换
/// (policy 中是否引用该句柄决定编码是否生效)
fec_encoder: FecEncoder,
/// 单实例锁:同一台机器、同一网络只允许一个客户端注册。
///
/// device_id 由机器标识派生,因此 cli、Desktop 内核或重复启动的进程会
/// 派生出同一个 device_id;若它们同时加入同一网络,服务端会把后注册的
/// 连接当作"同一设备的新连接"并踢掉先注册的那条,双方随即互相替换、
/// 无限重连。该锁在实例创建时获取,随实例销毁释放。
#[allow(dead_code)]
instance_lock: std::sync::Arc<crate::utils::instance_lock::InstanceLock>,
}

pub type NetworkInstance = NetworkManager;
Expand Down Expand Up @@ -188,6 +196,20 @@ impl NetworkManager {
app_state.nat_info.set_on_change(move || backoff.cap_all());
config.normalize()?;
config.check()?;
// 抢单实例锁要早于任何建网/注册动作:抢不到说明本机已有客户端在为
// 同一网络注册,继续下去只会与服务端互相替换会话。
let instance_lock = match crate::utils::instance_lock::InstanceLock::acquire(
&config.network_code,
) {
Ok(lock) => lock,
// 保留 `LockHeld` 作为错误根源,调用方可以 downcast 出结构化信息。
Err(crate::utils::instance_lock::AcquireError::Held(held)) => {
return Err(anyhow::Error::new(held));
}
Err(crate::utils::instance_lock::AcquireError::Io(error)) => {
return Err(anyhow::Error::new(error).context("获取单实例锁失败"));
}
};
// Install the route source before any server or gossip producer can
// publish automatic routes. Every source is therefore observed even
// when it changes during network task startup.
Expand Down Expand Up @@ -496,6 +518,7 @@ impl NetworkManager {
registration_status: registration_status_rx,
runtime_policy: runtime_policy.clone(),
fec_encoder: shared_fec_encoder,
instance_lock,
};
// 连接服务器并注册:注册在实例任务组内后台进行,调用方无需关心注册
// 动作,通过 current_network 获取网段信息即可
Expand Down
Loading
Loading