3 Commits

Author SHA1 Message Date
e3cb065b35 fix(shim): 优化配置解析、跨平台编码与 UAC 提权逻辑
- 使用 `OsString`/`PathBuf` 替代 `String`,实现跨平台无损编码与命令行参数透传
- 完善 `FromLua` 转换与边界校验,拦截空洞 (`nil`) 及非整数键
- 修复环境变量拼接时由于内置分隔符导致的 `join_paths` 报错
- 优化 Windows 下 UAC 提权执行逻辑,改用宽字符 API (`ShellExecuteExW`)
2026-08-18 11:15:30 +08:00
5e69a6a980 refactor: 迁移 winapi 到 windows-sys,修复配置解析漏洞
- 依赖替换为 windows-sys 0.61,main.rs 全面适配新 API
  - 配置解析错误显式传播:env/args 类型错误、数组空洞、非法键不再静默
  吞错
  - 修正空环境变量与空参数语义,补充 UTF-8 与路径拼接校验
  - require 容错移至 Rust 侧,模块加载失败记录日志并跳过
  - 新增配置解析与运行时单元测试(19 个)
2026-08-14 20:09:34 +08:00
ed5439eaa1 refactor: 拆分代码结构为 lib.rs 与多模块架构
- 将核心业务逻辑抽离至 lib.rs,精简 main.rs 为纯粹的 CLI 入口
- 将代码按职责拆分为 config、env、runtime、shim 等子模块
- 提高可测试性与代码复用度
2026-08-14 10:36:09 +08:00
13 changed files with 1117 additions and 407 deletions

1
.gitignore vendored
View File

@@ -1,4 +1,5 @@
/target
/.vscode
/.idea
*.exe
./Cargo.lock

View File

@@ -1,32 +1,32 @@
[package]
name = "rshim"
version = "0.1.0"
authors = ["anonymous <anonymous@example.com>"]
edition = "2024"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
rust-version = "1.94"
license = "MIT OR Unlicense"
description = "A fast, safe Rust shim launcher for Scoop"
[profile.release]
opt-level = "z"
panic = "abort"
[dependencies]
fs-err = "3.3.1"
unicode-bom = "2.0.3"
thiserror={version = "2.0.20"}
thiserror = "2.0.20"
mlua = { version = "0.12.0", features = ["lua54", "vendored"] }
winapi = { version = "0.3", features = [
"wincon",
"consoleapi",
"minwindef",
"shellapi",
"winuser",
"synchapi",
"combaseapi",
"winbase",
"processthreadsapi",
"objbase",
"impl-default"
windows-sys = { version = "0.61.2", features = [
"Win32_Foundation",
"Win32_System_Com",
"Win32_System_Console",
"Win32_System_Registry",
"Win32_System_Threading",
"Win32_UI_Shell",
"Win32_UI_WindowsAndMessaging",
] }
dunce = "1.0.5"
# 日志
tracing = "0.1.44"
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
tracing-appender = "0.2"
encoding_rs = "0.8.35"

View File

@@ -18,25 +18,24 @@ fn main() {
// 在 target/debug/ 或 target/release/ 下创建 bin2 目录
let output_dir = target_dir.join(&profile).join("bin2");
// cargo:rerun-if-changed -> 当指定文件变化时,重新运行 xxx
println!("cargo:rerun-if-changed=build.rs");
println!("cargo:rerun-if-changed=shims.lua");
println!("cargo:rerun-if-changed=rshim.lua");
println!("cargo:rustc-env=OUTPUT_DIR={}", output_dir.display());
// 创建目录
let dirs = ["bin", "tools"];
for dir in &dirs {
let path = output_dir.join(dir);
let subdirs = ["bin", "tools"];
for subdir in &subdirs {
let path = output_dir.join(subdir);
if !path.exists() {
fs::create_dir_all(&path).expect(&format!("Failed to create {} directory", dir));
fs::create_dir_all(&path).expect(&format!("Failed to create {} directory", subdir));
println!("Created: {:?}", path);
}
}
// 复制文件
let source = PathBuf::from(&manifest_dir).join("shims.lua");
let destination = output_dir.join("shims.lua");
let destination = output_dir.join("rshim.lua");
if source.exists() {
fs::copy(&source, &destination).expect("Failed to copy shims.lua");

View File

@@ -9,8 +9,18 @@ return {
---------------------------------------------------
-- 1. 标准相对路径 + 正斜杠拼接 (最推荐,绿色便携)
---------------------------------------------------
["numa"] = {
target = base_dir .. "/tools/numa/numa.exe",
-- 追加参数
args = { "--help" },
-- 注入环境变量,使用 get_env 获取宿主机当前值
env = {
PATH = { base_dir .. "/tools/numa", get_env("PATH") }
}
},
["git"] = {
path = base_dir .. "/git/bin/git.exe",
target = base_dir .. "/git/bin/git.exe",
-- 追加参数
args = { "--no-pager" },
-- 注入环境变量,使用 get_env 获取宿主机当前值
@@ -24,7 +34,7 @@ return {
---------------------------------------------------
["python"] = {
-- 在 [[]] 内部,\ 不需要写成 \\,直接粘贴即可
path = [[C:\Python310\python.exe]],
target = [[C:\Python310\python.exe]],
args = { "-B" },
-- 空字典也是合法的,等同于不设置
env = {
@@ -46,14 +56,15 @@ return {
-- 3. 极简参数覆盖 (没有 args 和 env)
---------------------------------------------------
["curl"] = {
path = base_dir .. "/curl/curl.exe"
target = base_dir .. "/curl/curl.exe"
},
---------------------------------------------------
-- 4. 模块化路由 (得益于 Rust 注入的 package.path)
-- require 能够直接在当前目录 或 conf.d/ 目录下寻找 node.lua
-- require 能够直接在当前目录 或 tools/ 目录下寻找 node.lua
-- 模块缺失时由 Rust 侧记录日志并跳过该条目(见 runtime.rs
---------------------------------------------------
["node"] = require("node"),
["npm"] = require("npm")
}
}

438
src/config.rs Normal file
View File

@@ -0,0 +1,438 @@
use mlua::{FromLua, Lua, LuaString, ObjectLike, Table, Value};
use std::collections::HashMap;
use std::ffi::OsString;
use std::path::PathBuf;
use std::process::Command;
/// 构造一个带上下文的 FromLua 转换错误,便于定位配置问题
fn conversion_error(message: impl Into<String>) -> mlua::Error {
mlua::Error::FromLuaConversionError {
from: "Lua value",
to: "ShimConfig".into(),
message: Some(message.into()),
}
}
/// 将 Lua 字符串转为 Rust 字符串;非 UTF-8 字节替换为 U+FFFD 并告警
fn lua_string_to_os_string(s: LuaString) -> Result<OsString, mlua::Error> {
let raw_bytes = &s.as_bytes().to_vec();
// 1. Unix 平台:直接零拷贝透传原始字节(无损支持任意编码)
#[cfg(unix)]
{
use std::os::unix::ffi::OsStrExt;
Ok(OsStr::from_bytes(raw_bytes).to_os_string())
}
// 2. Windows 平台:优先按 UTF-8 解码,失败则按当前系统本地代码页 (ANSI/GBK) 转换
#[cfg(windows)]
{
// 先尝试标准的 UTF-8
if let Ok(utf8_str) = std::str::from_utf8(raw_bytes) {
return Ok(OsString::from(utf8_str));
}
// 非 UTF-8 时,按系统默认的 ANSI/OEM (如 GBK) 进行安全解码
let (cow, _, had_errors) = encoding_rs::GBK.decode(raw_bytes);
if had_errors {
return Err(mlua::Error::RuntimeError(
"Path contains invalid/unsupported byte encoding".into(),
));
}
Ok(OsString::from(cow.as_ref()))
}
}
/// 按连续整数下标遍历表的序列部分;存在空洞或非序列键时返回错误,避免静默截断
fn for_each_sequence_item(
tbl: &Table,
mut f: impl FnMut(Value) -> mlua::Result<()>,
) -> mlua::Result<()> {
let mut index = 1i64;
loop {
let item: Value = tbl.raw_get(index)?;
if matches!(item, Value::Nil) {
break;
}
f(item)?;
index += 1;
}
// 校验剩余键:只允许已经被遍历的连续整数键
for pair in tbl.pairs::<Value, Value>() {
let (key, _) = pair?;
match key {
Value::Integer(i) if i >= 1 && i < index => {}
_ => {
return Err(conversion_error(format!(
"数组只能包含连续的整数下标 [1..{}],发现非序列键或空洞",
index - 1
)));
}
}
}
Ok(())
}
/// 校验环境变量名的合法性Windows 约束:非空、不含 '='、不含 NUL
fn validate_env_key(key: &str) -> mlua::Result<()> {
if key.is_empty() {
return Err(conversion_error("环境变量名不能为空"));
}
if key.contains('=') {
return Err(conversion_error(format!(
"环境变量名 [{}] 不能包含 '='",
key
)));
}
if key.contains('\0') {
return Err(conversion_error(format!(
"环境变量名 [{}] 不能包含 NUL 字符",
key
)));
}
Ok(())
}
/// 递归将任意 Lua Value 展开为扁平的字符串片段列表
fn collect_env_strings(value: Value, out: &mut Vec<OsString>) -> mlua::Result<()> {
match value {
// 1. 字符串
Value::String(s) => out.push(lua_string_to_os_string(s)?),
// 2. 整数与浮点数
Value::Integer(i) => out.push(OsString::from(i.to_string())),
Value::Number(n) => {
tracing::warn!(value = %n, "环境变量中的浮点数将按十进制格式转换为字符串");
out.push(OsString::from(n.to_string()));
}
// 3. 布尔值
Value::Boolean(b) => {
tracing::warn!(value = %b, "环境变量中的布尔值将转换为字符串");
out.push(OsString::from(b.to_string()));
}
// 4. 表/数组:必须是连续整数下标的纯序列,递归解包(支持任意深度的嵌套数组)
Value::Table(tbl) => for_each_sequence_item(&tbl, |item| collect_env_strings(item, out))?,
// 5. 安全忽
// 略 nil
Value::Nil => {}
// 6. 无法转为环境变量的非法类型函数、协程、UserData 等):报错而非静默忽略
other => {
return Err(conversion_error(format!(
"环境变量值不支持类型 {}(仅支持 string/number/boolean/数组)",
other.type_name()
)));
}
}
Ok(())
}
#[derive(Debug, Clone, Default)]
pub struct ShimConfig {
pub target: PathBuf,
pub args: Vec<OsString>,
pub env: HashMap<String, OsString>,
}
impl ShimConfig {
/// 根据配置快速构建准备执行的 Command 对象
pub fn to_command<I, S>(&self, runtime_args: I) -> Command
where
I: IntoIterator<Item = S>,
S: AsRef<std::ffi::OsStr>,
{
let mut cmd = Command::new(&self.target);
// 1. 先追加配置里固定的默认参数 (例如: node, --max-old-space-size=4096)
cmd.args(&self.args);
// 2. 透传外部动态运行时参数
cmd.args(runtime_args);
for (key, val) in &self.env {
// 直接应用环境变量Lua 端已经处理好字符串拼接或列表合并)
cmd.env(key, val);
}
cmd
}
}
/// 实现 FromLua Trait由 mlua 自动处理 Table 转换
impl FromLua for ShimConfig {
fn from_lua(value: Value, _lua: &Lua) -> mlua::Result<Self> {
// 脚本返回必须是一个 Table 变体
let table = match value {
Value::Table(t) => t,
_ => {
return Err(conversion_error(format!(
"期望得到一个 Lua Table 配置对象,实际是 {}",
value.type_name()
)));
}
};
// 必填字段: target严格限定为字符串避免数字被 mlua 宽松转为字符串后掩盖错误)
let target = match table.get::<Value>("target")? {
Value::String(s) => lua_string_to_os_string(s)?,
Value::Nil => {
return Err(conversion_error("缺少必填字段 target应为字符串路径"));
}
other => {
return Err(conversion_error(format!(
"target 需为有效的路径且类型必须是字符串,实际类型是 {}",
other.type_name()
)));
}
};
// 可选字段: args缺失或 nil 时默认空列表;保留空字符串参数,与提权路径的 "" 语义一致)
// let args = match table.get::<Option<Value>>("args")? {
// None => Vec::new(),
// Some(Value::Table(tbl)) => {
// let mut args = Vec::new();
// for_each_sequence_item(&tbl, |item| match item {
// Value::String(s) => {
// args.push(lua_string_to_string(s));
// Ok(())
// }
// other => Err(conversion_error(format!(
// "args 数组元素必须是字符串,实际是 {}",
// other.type_name()
// ))),
// })?;
// args
// }
let args = match table.get::<Option<Value>>("args")? {
None => Vec::new(),
Some(Value::Table(tbl)) => {
let mut args = Vec::new();
for_each_sequence_item(&tbl, |item| match item {
Value::String(s) => {
args.push(lua_string_to_os_string(s)?);
Ok(())
}
other => Err(conversion_error(format!(
"args 数组元素必须是字符串,实际是 {}",
other.type_name()
))),
})?;
args
}
Some(other) => {
return Err(conversion_error(format!(
"args 必须是字符串数组,实际是 {}",
other.type_name()
)));
}
};
// 可选字段: env只允许缺失/nil其他类型由 Option<Table> 转换报错,不再静默忽略)
let env_table = table.get::<Option<Table>>("env")?;
println!("env_table:{:?}", env_table);
let mut env = HashMap::new();
if let Some(env_table) = env_table {
for pair in env_table.pairs::<String, Value>() {
let (key, value) = pair?;
validate_env_key(&key)?;
let mut parts = Vec::new();
collect_env_strings(value, &mut parts)?;
// 空数组/空串也显式设置(空值表示清空该变量),
// 与“未配置该变量(继承宿主环境)”相区分
let joined_os_str = std::env::join_paths(parts).map_err(|e| {
conversion_error(format!(
"环境变量 [{}] 的值无法用系统路径分隔符拼接: {}",
key, e
))
})?;
println!("环境变量拼接结果:{:?}", joined_os_str);
// 检查是否包含非法 NUL 字符
#[cfg(unix)]
{
use std::os::unix::ffi::OsStrExt;
if joined_os_str.as_bytes().contains(&0) {
return Err(conversion_error(format!(
"环境变量 [{}] 的值不能包含 NUL 字符",
key
)));
}
}
#[cfg(windows)]
{
use std::os::windows::ffi::OsStrExt;
if joined_os_str.encode_wide().any(|c| c == 0) {
return Err(conversion_error(format!(
"环境变量 [{}] 的值不能包含 NUL 字符",
key
)));
}
}
env.insert(key, joined_os_str);
}
}
println!("环境变量结果:{:?}", env);
Ok(ShimConfig {
target: PathBuf::from(target),
args,
env,
})
}
}
#[cfg(test)]
mod tests {
use super::*;
fn parse(src: &str) -> mlua::Result<ShimConfig> {
let lua = Lua::new();
// 模拟 runtime 注入的 get_env返回按平台分隔符拆分的段数组空变量返回空表
let get_env = lua
.create_function(|lua, key: String| -> mlua::Result<Table> {
let value = std::env::var(key).unwrap_or_default();
let segments: Vec<String> = if value.is_empty() {
Vec::new()
} else {
std::env::split_paths(std::ffi::OsStr::new(&value))
.map(|p| p.to_string_lossy().into_owned())
.collect()
};
lua.create_sequence_from(segments)
})
.unwrap();
lua.globals().set("get_env", get_env).unwrap();
let value = lua.load(src).eval::<Value>()?;
let t = ShimConfig::from_lua(value, &lua);
println!("读取出的数据:{:?}", t.clone()?);
t
}
#[test]
fn parses_basic_config() {
let cfg = parse(
r#"
return {
target = "C:/tools/git.exe",
args = { "--no-pager" },
env = {
PATH = { "C:/tools/git/bin", "C:/Windows",get_env("PATH") },
HOME = "C:/tools/home",
CONST = 3,
BOOL = true
}
}
"#,
)
.unwrap();
assert_eq!(cfg.target, PathBuf::from("C:/tools/git.exe"));
assert_eq!(cfg.args, vec!["--no-pager"]);
assert_eq!(cfg.env.get("HOME").unwrap().to_str(), Some("C:/tools/home"));
// PATH 前缀来自配置,随后附加 get_env("PATH") 拆出的宿主 PATH 段
let path = cfg.env.get("PATH").unwrap().to_str().unwrap();
assert!(
path == "C:/tools/git/bin;C:/Windows"
|| path.starts_with("C:/tools/git/bin;C:/Windows;"),
"unexpected PATH: {path}"
);
}
#[test]
fn missing_args_and_env_are_empty() {
let cfg = parse(r#"return { target = "t.exe" }"#).unwrap();
assert!(cfg.args.is_empty());
assert!(cfg.env.is_empty());
}
#[test]
fn keeps_empty_args() {
let cfg = parse(r#"return { target = "t.exe", args = { "" } }"#).unwrap();
assert_eq!(cfg.args, vec![""]);
}
#[test]
fn keeps_empty_env_value() {
let cfg = parse(r#"return { target = "t.exe", env = { FOO = "" } }"#).unwrap();
assert_eq!(cfg.env.get("FOO").unwrap().to_str(), Some(""));
}
#[test]
fn empty_array_clears_env_var() {
let cfg = parse(r#"return { target = "t.exe", env = { PATH = {} } }"#).unwrap();
assert_eq!(cfg.env.get("PATH").unwrap().to_str(), Some(""));
}
#[test]
fn expands_nested_env_array() {
// get_env("PATH") 现在返回拆分后的段数组,嵌套表应被递归展开
let cfg = parse(
r#"return { target = "t.exe", env = { PATH = { "C:/a", { "C:/b", "C:/c" } } } }"#,
)
.unwrap();
assert_eq!(
cfg.env.get("PATH").unwrap().to_str(),
Some("C:/a;C:/b;C:/c")
);
}
#[test]
fn rejects_wrong_env_type() {
assert!(parse(r#"return { target = "t.exe", env = "PATH=C:/x" }"#).is_err());
}
#[test]
fn rejects_sparse_env_array() {
assert!(parse(r#"return { target = "t.exe", env = { P = { "a", nil, "b" } } }"#).is_err());
}
#[test]
fn rejects_mixed_key_env_array() {
assert!(parse(r#"return { target = "t.exe", env = { P = { a = "b" } } }"#).is_err());
}
#[test]
fn rejects_invalid_env_key() {
assert!(parse(r#"return { target = "t.exe", env = { ["FOO=1"] = "x" } }"#).is_err());
assert!(parse(r#"return { target = "t.exe", env = { [""] = "x" } }"#).is_err());
}
#[test]
fn rejects_nul_in_env_value() {
assert!(parse(r#"return { target = "t.exe", env = { P = { string.char(0) } } }"#).is_err());
}
#[test]
fn rejects_quote_in_env_value() {
// Windows 的 join_paths 对含双引号的路径元素返回错误
assert!(
parse(r#"return { target = "t.exe", env = { P = { string.char(34) } } }"#).is_err()
);
}
#[test]
fn rejects_unsupported_env_value_type() {
assert!(parse(r#"return { target = "t.exe", env = { F = function() end } }"#).is_err());
}
#[test]
fn missing_target_is_error() {
assert!(parse(r#"return { args = { "x" } }"#).is_err());
}
#[test]
fn rejects_non_string_target() {
assert!(parse(r#"return { target = 123 }"#).is_err());
assert!(parse(r#"return { target = false }"#).is_err());
}
#[test]
fn rejects_non_string_args_element() {
assert!(parse(r#"return { target = "t.exe", args = { 1 } }"#).is_err());
}
#[test]
fn rejects_sparse_args() {
assert!(parse(r#"return { target = "t.exe", args = { "a", nil, "b" } }"#).is_err());
}
#[test]
fn rejects_non_table_args() {
assert!(parse(r#"return { target = "t.exe", args = "-B" }"#).is_err());
}
}

View File

@@ -1,19 +1,18 @@
use std::path::PathBuf;
use thiserror::Error; // 推荐引入 thiserror 库,若不使用可手动实现 std::fmt::Display
#[derive(Debug, Error)]
pub enum ShimError {
#[error("路径解析失败: {0}")]
PathResolutionError(String),
PathResolution(String),
#[error("获取环境信息失败: {0}")]
EnvError(String),
Environment(String),
#[error("配置文件未找到: {0}")]
ConfigNotFound(String),
ConfigMissing(String),
#[error("Lua 运行时/语法错误 [{file}]: {source}")]
LuaExecutionError {
LuaExecution {
file: String,
#[source]
source: mlua::Error,
@@ -24,4 +23,4 @@ pub enum ShimError {
#[error("IO 错误: {0}")]
Io(#[from] std::io::Error),
}
}

45
src/layout.rs Normal file
View File

@@ -0,0 +1,45 @@
use crate::error::ShimError;
use std::path::{Path, PathBuf};
pub struct ShimLayout {
pub root_dir: PathBuf,
pub bin_dir: PathBuf,
pub tools_dir: PathBuf,
}
impl ShimLayout {
/// 从当前可执行文件解析 shim 安装目录布局
pub fn from_executable(exe_path: impl AsRef<Path>) -> Result<Self, ShimError> {
let exe_path = exe_path.as_ref();
let bin_dir = exe_path
.parent()
.ok_or_else(|| {
ShimError::PathResolution(format!(
"无法获取程序 [{}] 的父级 bin 目录",
exe_path.display()
))
})?
.to_path_buf();
eprintln!("bin_dir目录 {}", bin_dir.display());
let root_dir = bin_dir
.parent()
.ok_or_else(|| {
ShimError::PathResolution(format!(
"无法获取 bin 目录 [{}] 的父级 root 目录",
bin_dir.display()
))
})?
.to_path_buf();
eprintln!("root_dir 目录 {}", root_dir.display());
let tools_dir = root_dir.join("tools");
eprintln!("tools_dir 目录 {}", tools_dir.display());
Ok(Self {
root_dir,
bin_dir,
tools_dir,
})
}
}

12
src/lib.rs Normal file
View File

@@ -0,0 +1,12 @@
mod config;
mod error;
mod layout;
mod logger;
mod runtime;
mod shim;
pub use config::ShimConfig;
pub use error::ShimError;
pub use layout::ShimLayout;
pub use runtime::LuaRuntime;
pub use shim::Shim;

39
src/logger.rs Normal file
View File

@@ -0,0 +1,39 @@
use std::path::Path;
use tracing_appender::non_blocking::WorkerGuard;
use tracing_subscriber::{EnvFilter, fmt};
/// 初始化日志系统,返回的 `_guard` 必须在 main 作用域内保持存活直到程序退出
pub fn init_file_logger(log_dir: impl AsRef<Path>) -> Option<WorkerGuard> {
// 允许通过环境变量动态控制日志级别,如 SHIM_LOG=debug默认 debug 或 info
let filter = EnvFilter::try_from_env("SHIM_LOG").unwrap_or_else(|_| EnvFilter::new("debug"));
// 1. 创建按天滚动的日志追加器 (每天生成类似 shim.2026-08-14.log)
let file_appender = tracing_appender::rolling::daily(log_dir, "shim.log");
// 2. 包装为非阻塞后台写入(不会拖慢主程序的启动与执行速度)
let (non_blocking, guard) = tracing_appender::non_blocking(file_appender);
// 3. 构建 Subscriber只输出到文件不输出到控制台
tracing_subscriber::fmt()
.with_env_filter(filter)
.with_writer(non_blocking) // 写入文件
.with_ansi(false) // 关闭终端彩色转义字符
.with_target(false) // 隐藏模块前缀(可选)
.init();
Some(guard)
}
// 调用
// fn main() -> Result<(), Box<dyn std::error::Error>> {
// // 假设日志存放在安装根目录下的 logs 文件夹
// // 也可以先快速推导 layout 拿到 log_dir
// let log_dir = "path/to/root_dir/logs";
// let _guard = init_file_logger(log_dir);
//
// // 此处写你的 Shim 业务逻辑
// // 业务代码中所有的 debug!/info!/warn! 都会静默写入文件,控制台干干净净
// let config = Shim::load()?;
//
// Ok(())
// }

View File

@@ -1,38 +1,41 @@
use std::{
env,
ffi::CString,
mem::size_of,
path::Path,
process::{Command, exit},
ptr::null_mut,
};
mod shims;
mod error;
use rshim::Shim;
use std::os::windows::ffi::OsStrExt;
use std::{env, ffi::CString, mem::size_of, path::Path, process::exit, ptr::null_mut};
use tracing_subscriber::{EnvFilter, fmt};
use shims::Shim;
use std::ffi::{OsStr, OsString};
use winapi::{
shared::minwindef::{BOOL, DWORD, FALSE, TRUE},
um::{
combaseapi::CoInitializeEx,
consoleapi,
objbase::{COINIT_APARTMENTTHREADED, COINIT_DISABLE_OLE1DDE},
processthreadsapi::GetExitCodeProcess,
shellapi::{SEE_MASK_NOASYNC, SEE_MASK_NOCLOSEPROCESS, SHELLEXECUTEINFOA, ShellExecuteExA},
synchapi::WaitForSingleObject,
winbase::INFINITE,
wincon,
winuser::SW_NORMAL,
use windows_sys::Win32::UI::Shell::{SHELLEXECUTEINFOW, ShellExecuteExW};
use windows_sys::Win32::Foundation::CloseHandle;
use windows_sys::{
Win32::{
Foundation::{FALSE, TRUE},
System::{
Com::{COINIT_APARTMENTTHREADED, COINIT_DISABLE_OLE1DDE, CoInitializeEx},
Console::{
CTRL_BREAK_EVENT, CTRL_C_EVENT, CTRL_CLOSE_EVENT, CTRL_LOGOFF_EVENT,
CTRL_SHUTDOWN_EVENT, SetConsoleCtrlHandler,
},
Threading::{GetExitCodeProcess, INFINITE, WaitForSingleObject},
},
UI::{
Shell::{
SEE_MASK_NOASYNC, SEE_MASK_NOCLOSEPROCESS, SHELLEXECUTEINFOA, ShellExecuteExA,
},
WindowsAndMessaging::SW_NORMAL,
},
},
core::BOOL,
};
unsafe extern "system" fn routine_handler(evt: DWORD) -> BOOL {
unsafe extern "system" fn console_ctrl_handler(evt: u32) -> BOOL {
match evt {
wincon::CTRL_C_EVENT => TRUE, //eprintln!("ctrl_c handled!"),
wincon::CTRL_BREAK_EVENT => TRUE, //eprintln!("ctrl_break handled!"),
wincon::CTRL_CLOSE_EVENT => TRUE, //eprintln!("ctrl_close handled!"),
wincon::CTRL_LOGOFF_EVENT => TRUE, //eprintln!("ctrl_logoff handled!"),
wincon::CTRL_SHUTDOWN_EVENT => TRUE, //eprintln!("ctrl_shutdown handled!"),
CTRL_C_EVENT => TRUE, //eprintln!("ctrl_c handled!"),
CTRL_BREAK_EVENT => TRUE, //eprintln!("ctrl_break handled!"),
CTRL_CLOSE_EVENT => TRUE, //eprintln!("ctrl_close handled!"),
CTRL_LOGOFF_EVENT => TRUE, //eprintln!("ctrl_logoff handled!"),
CTRL_SHUTDOWN_EVENT => TRUE, //eprintln!("ctrl_shutdown handled!"),
other => {
eprintln!("未知的系统事件编号: {},未处理!", other);
FALSE
@@ -47,13 +50,21 @@ const EXIT_PROG_TERMINATED: i32 = 4;
const ERROR_ELEVATION_REQUIRED: i32 = 740;
fn main() {
let res: BOOL = unsafe { consoleapi::SetConsoleCtrlHandler(Some(routine_handler), TRUE) };
// 初始化日志:输出到 stderr避免污染 shim 子进程的 stdout
fmt()
.with_writer(std::io::stderr)
.with_env_filter(
EnvFilter::try_from_env("SHIM_LOG").unwrap_or_else(|_| EnvFilter::new("warn")),
)
.init();
let res: BOOL = unsafe { SetConsoleCtrlHandler(Some(console_ctrl_handler), TRUE) };
if res == FALSE {
eprintln!("警告: 注册控制台中断事件处理器失败。");
}
let calling_args: Vec<_> = env::args().skip(1).collect();
let shim = match Shim::init() {
let calling_args: Vec<_> = env::args_os().skip(1).collect();
let shim = match Shim::load() {
Ok(v) => v,
Err(e) => {
eprintln!("加载代理(shim)配置时发生错误: {}", e);
@@ -61,42 +72,33 @@ fn main() {
}
};
let args = if let Some(mut shim_args) = shim.args {
shim_args.extend_from_slice(calling_args.as_slice());
shim_args
} else {
calling_args
};
// ======= 【修改位置 1构建 Command 并注入环境变量】 =======
let mut cmd_builder = Command::new(&shim.target_path);
cmd_builder.args(&args);
// 构建 Command复用 ShimConfig::to_command含 args/env 注入),避免重复逻辑
let mut cmd = shim.to_command(&calling_args);
// 仅作用于目标子进程,完全 Safe 且隔离
if let Some(ref envs) = shim.envs {
cmd_builder.envs(envs);
}
let mut cmd = match cmd_builder.spawn() {
// 提权回退时需要完整参数:配置默认参数 + 调用方透传参数
let mut args = shim.args.clone();
args.extend_from_slice(&calling_args);
let mut child = match cmd.spawn() {
Ok(v) => v,
Err(e) if e.raw_os_error() == Some(ERROR_ELEVATION_REQUIRED) => exit(execute_elevated(
&shim.target_path,
&args,
shim.envs.as_ref(),
)),
Err(e) if e.raw_os_error() == Some(ERROR_ELEVATION_REQUIRED) => {
exit(execute_elevated(&shim.target, &args, Some(&shim.env)))
}
Err(e) => {
eprintln!(
"启动目标程序 [{}] 时发生错误: {}",
shim.target_path.to_string_lossy(),
shim.target.to_string_lossy(),
e
);
exit(EXIT_FAILED_SPAWN_PROG);
}
};
let status = match cmd.wait() {
let status = match child.wait() {
Ok(v) => v,
Err(e) => {
eprintln!(
"等待目标程序 [{}] 执行完毕时发生错误: {}",
shim.target_path.to_string_lossy(),
shim.target.to_string_lossy(),
e
);
exit(EXIT_FAILED_WAIT_PROG);
@@ -104,67 +106,130 @@ fn main() {
};
exit(status.code().unwrap_or(EXIT_PROG_TERMINATED))
}
// 辅助函数:将任意 OsStr 转换为以 \0 结尾的 UTF-16 宽字符向量 (Vec<u16>)
fn to_wide_null(s: impl AsRef<OsStr>) -> Vec<u16> {
s.as_ref().encode_wide().chain(std::iter::once(0)).collect()
}
fn execute_elevated(
program: &Path,
args: &[String],
envs: Option<&std::collections::HashMap<String, String>>,
args: &[OsString],
env_vars: Option<&std::collections::HashMap<String, OsString>>,
) -> i32 {
// 若提权启动,在此处将环境变量设置给当前进程(即将弹窗 UAC 的进程,随后会被子进程继承)
if let Some(env_map) = envs {
if let Some(env_map) = env_vars {
for (k, v) in env_map {
unsafe {
env::set_var(k, v);
}
}
}
let runas = CString::new("runas").unwrap();
let program = CString::new(program.to_str().unwrap()).unwrap();
let mut params = String::new();
for arg in args.iter() {
params.push(' ');
if arg.len() == 0 {
params.push_str("\"\"");
} else if arg.find(&[' ', '\t', '"'][..]).is_none() {
params.push_str(&arg);
// 2. 将参数列表按 Windows 命令行规则拼装为单个命令行字符串
let mut arguments_os = OsString::new();
for (i, arg) in args.iter().enumerate() {
if i > 0 {
arguments_os.push(" ");
}
let arg_str = arg.to_string_lossy();
if arg_str.is_empty() {
arguments_os.push("\"\"");
} else if !arg_str.contains([' ', '\t', '"']) {
arguments_os.push(arg);
} else {
params.push('"');
for c in arg.chars() {
// 包含空格或引号时进行标准转义包裹
arguments_os.push("\"");
for c in arg_str.chars() {
match c {
'\\' => params.push_str("\\\\"),
'"' => params.push_str("\\\""),
c => params.push(c),
'\\' => arguments_os.push("\\\\"),
'"' => arguments_os.push("\\\""),
_ => arguments_os.push(c.to_string()),
}
}
params.push('"');
arguments_os.push("\"");
}
}
// let runas = CString::new("runas").unwrap();
// let program = CString::new(program.to_str().unwrap()).unwrap();
// let mut arguments = String::new();
// for arg in args.iter() {
// arguments.push(' ');
// if arg.len() == 0 {
// arguments.push_str("\"\"");
// } else if arg.find(&[' ', '\t', '"'][..]).is_none() {
// arguments.push_str(&arg);
// } else {
// arguments.push('"');
// for c in arg.chars() {
// match c {
// '\\' => arguments.push_str("\\\\"),
// '"' => arguments.push_str("\\\""),
// c => arguments.push(c),
// }
// }
// arguments.push('"');
// }
// }
// 3. 准备 Windows 宽字符参数
let runas = to_wide_null("runas");
let program_wide = to_wide_null(program.as_os_str());
let arguments_wide = to_wide_null(&arguments_os);
let params = CString::new(&params[..]).unwrap();
let mut info = SHELLEXECUTEINFOA::default();
info.cbSize = size_of::<SHELLEXECUTEINFOA>() as DWORD;
info.fMask = SEE_MASK_NOASYNC | SEE_MASK_NOCLOSEPROCESS;
info.lpVerb = runas.as_ptr();
info.lpFile = program.as_ptr();
info.lpParameters = params.as_ptr();
info.nShow = SW_NORMAL;
let mut info = SHELLEXECUTEINFOW {
cbSize: size_of::<SHELLEXECUTEINFOW>() as u32,
fMask: SEE_MASK_NOASYNC | SEE_MASK_NOCLOSEPROCESS,
hwnd: null_mut(),
lpVerb: runas.as_ptr(),
lpFile: program_wide.as_ptr(),
lpParameters: arguments_wide.as_ptr(),
lpDirectory: null_mut(),
nShow: SW_NORMAL as i32,
hInstApp: null_mut(),
lpIDList: null_mut(),
lpClass: null_mut(),
hkeyClass: null_mut(),
dwHotKey: 0,
Anonymous: unsafe { std::mem::zeroed() },
hProcess: null_mut(),
};
// let arguments = CString::new(&arguments[..]).unwrap();
// let mut info = SHELLEXECUTEINFOA::default();
// info.cbSize = size_of::<SHELLEXECUTEINFOA>() as u32;
// info.fMask = SEE_MASK_NOASYNC | SEE_MASK_NOCLOSEPROCESS;
// info.lpVerb = runas.as_ptr().cast::<u8>();
// info.lpFile = program.as_ptr().cast::<u8>();
// info.lpParameters = arguments.as_ptr().cast::<u8>();
// info.nShow = SW_NORMAL;
let res = unsafe {
CoInitializeEx(
null_mut(),
COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE,
(COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE) as u32,
);
ShellExecuteExA(&mut info as *mut _)
// ShellExecuteExA(&mut info as *mut _)
ShellExecuteExW(&mut info)
};
if res == FALSE || info.hProcess == null_mut() {
return EXIT_FAILED_SPAWN_PROG;
}
let mut code: DWORD = 0;
// 5. 等待提权子进程执行结束并获取退出状态码
let mut exit_code: u32 = 0;
unsafe {
WaitForSingleObject(info.hProcess, INFINITE);
if GetExitCodeProcess(info.hProcess, &mut code as *mut _) == FALSE {
let ok = GetExitCodeProcess(info.hProcess, &mut exit_code);
CloseHandle(info.hProcess); // 释放进程句柄,防止资源泄露
if ok == FALSE {
return EXIT_FAILED_WAIT_PROG;
}
}
code as i32
exit_code as i32
// let mut code: u32 = 0;
// unsafe {
// WaitForSingleObject(info.hProcess, INFINITE);
// if GetExitCodeProcess(info.hProcess, &mut code as *mut _) == FALSE {
// return EXIT_FAILED_WAIT_PROG;
// }
// }
// code as i32
}

284
src/runtime.rs Normal file
View File

@@ -0,0 +1,284 @@
use crate::error::ShimError;
use crate::{ShimConfig, ShimLayout};
use mlua::{FromLua, Lua, StdLib, Table, Value};
use std::ffi::OsStr;
use std::path::Path;
use std::{env, fs};
/// 将 Path 转换为适合 Lua 使用的安全字符串路径
fn normalize_path_for_lua(path: &Path) -> String {
// 自动将 Windows UNC 规范路径转回传统路径
let simplified = dunce::simplified(path);
simplified.to_string_lossy().replace('\\', "/")
}
pub struct LuaRuntime {
lua: Lua,
}
impl LuaRuntime {
/// 初始化限定权限的 Lua 沙箱环境
pub fn new(layout: &ShimLayout) -> Result<Self, ShimError> {
// 只加载安全的标准库,剥离 os / io 等风险模块
let lua = Lua::new_with(
StdLib::TABLE | StdLib::STRING | StdLib::MATH | StdLib::PACKAGE,
mlua::LuaOptions::default(),
)
.map_err(|e| ShimError::Environment(format!("初始化 Lua 失败: {}", e)))?;
let globals = lua.globals();
// 统一使用 POSIX 风格路径规范化路径字符串
let root_dir = normalize_path_for_lua(&layout.root_dir);
let tools_dir = normalize_path_for_lua(&layout.tools_dir);
// 1. 注入锚点变量 __SHIM_DIR__shim 安装根目录)
globals
.set("__SHIM_DIR__", root_dir.clone())
.map_err(|e| ShimError::Environment(e.to_string()))?;
// 2. 安全暴露 get_env 供配置读取环境变量
// 返回按平台路径分隔符拆分后的段数组(自动剥离引号包裹),
// 便于 PATH 等列表变量直接嵌入数组PATH = { prefix, get_env("PATH") }
let get_env = lua
.create_function(|lua, key: String| -> mlua::Result<Table> {
// 缺失变量视为空字符串,拆分后得到空表(不贡献任何路径段)
let value = env::var_os(key).unwrap_or_default();
// 空输入返回空表否则按平台分隔符拆分split_paths 会剥离引号包裹)
if value.is_empty() {
return lua.create_table();
}
let table = lua.create_table()?;
for (i, p) in env::split_paths(&value).enumerate() {
// 3. 跨平台提取原始字节并转为 LuaString保证 100% 无损
#[cfg(unix)]
let lua_str = {
use std::os::unix::ffi::OsStrExt;
lua.create_string(p.as_os_str().as_bytes())?
};
#[cfg(windows)]
let lua_str = {
// Windows 路径是 UTF-16转成字符串或保持其字节表达
let s = p.to_string_lossy();
lua.create_string(s.as_bytes())?
};
table.set(i + 1, lua_str)?;
}
Ok(table)
})
.map_err(|e| ShimError::Environment(e.to_string()))?;
globals
.set("get_env", get_env)
.map_err(|e| ShimError::Environment(e.to_string()))?;
// 3. 配置 package.path确保 require 行为正常
if let Ok(package) = globals.get::<Table>("package") {
let _ = package.set("cpath", "");
let _ = package.set("loadlib", Value::Nil);
if let Ok(path) = package.get::<String>("path") {
let new_path = format!(
"{};{}/?.lua;{}/?/init.lua;{}/?.lua;{}/?/init.lua",
path, root_dir, root_dir, tools_dir, tools_dir
);
let _ = package.set("path", new_path);
}
}
// 4. 包装 require配置模块缺失/加载失败时记录日志并跳过该条目,
// 而不是让整个 shims.lua 解析失败(排查问题时日志可见)
let original_require: mlua::Function = globals
.get("require")
.map_err(|e| ShimError::Environment(format!("获取 require 失败: {}", e)))?;
globals
.set("_rshim_original_require", &original_require)
.map_err(|e| ShimError::Environment(e.to_string()))?;
let wrapped_require = lua
.create_function(|lua, module: String| -> mlua::Result<Value> {
let original: mlua::Function = lua.globals().get("_rshim_original_require")?;
match original.call::<Value>(module.clone()) {
Ok(value) => Ok(value),
Err(e) => {
tracing::warn!(
module = %module,
error = %e,
"配置模块加载失败,已跳过该条目(可在独立配置文件中定义)"
);
Ok(Value::Nil)
}
}
})
.map_err(|e| ShimError::Environment(e.to_string()))?;
globals
.set("require", wrapped_require)
.map_err(|e| ShimError::Environment(e.to_string()))?;
Ok(Self { lua })
}
/// 执行指定脚本文件,直接返回完整的 Lua Table
pub fn eval_script<T: FromLua>(&self, path: impl AsRef<Path>) -> Result<T, ShimError> {
let path = path.as_ref();
// println!("path {:?}", path);
let bytes = fs::read(path)?;
let code = String::from_utf8(bytes).map_err(|e| {
ShimError::InvalidConfig(format!(
"{} 不是有效的 UTF-8 文件(请将 Lua 配置文件保存为 UTF-8 编码): {}",
path.display(),
e.utf8_error()
))
})?;
println!("code {:?}", code);
let chunk_name = format!("@{}", path.display());
self.lua
.load(&code)
.set_name(&chunk_name)
.eval::<T>()
.map_err(|e| ShimError::LuaExecution {
file: path.display().to_string(),
source: e,
})
}
// /// 将 Lua Value 解析转化为 ShimConfig 数据对象
// pub fn parse_config(&self, value: Value) -> Result<ShimConfig, ShimError> {
// ShimConfig::from_lua(value, &self.lua).map_err(|e| ShimError::InvalidConfig(e.to_string()))
// }
}
#[cfg(test)]
mod tests {
use super::*;
use crate::ShimLayout;
fn test_layout() -> ShimLayout {
let root = std::env::temp_dir().join("rshim-test-layout");
ShimLayout {
root_dir: root.clone(),
bin_dir: root.join("bin"),
tools_dir: root.join("tools"),
}
}
#[test]
fn missing_module_require_returns_nil() {
let runtime = LuaRuntime::new(&test_layout()).unwrap();
let value: Value = runtime
.lua
.load(r#"return require("rshim_test_no_such_module")"#)
.eval()
.unwrap();
assert!(matches!(value, Value::Nil));
}
#[test]
fn builtin_module_require_still_works() {
let runtime = LuaRuntime::new(&test_layout()).unwrap();
let value: Value = runtime
.lua
.load(r#"return pcall(require, "string")"#)
.eval()
.unwrap();
assert!(matches!(value, Value::Boolean(true)));
}
#[test]
fn get_env_returns_split_table() {
let runtime = LuaRuntime::new(&test_layout()).unwrap();
let value: Value = runtime
.lua
.load(r#"return get_env("PATH")"#)
.eval()
.unwrap();
let table = match value {
Value::Table(t) => t,
other => panic!("expected table, got {}", other.type_name()),
};
assert!(
table.raw_len() >= 1,
"PATH should have at least one segment"
);
// split_paths 会剥离引号包裹,拆分段不应再含双引号
for i in 1..=table.raw_len() {
let seg: String = table.raw_get(i).unwrap();
assert!(
!seg.contains('"'),
"segment should not contain quote: {seg:?}"
);
}
}
#[test]
fn get_env_missing_returns_empty_table() {
let runtime = LuaRuntime::new(&test_layout()).unwrap();
let value: Value = runtime
.lua
.load(r#"return get_env("RSHIM_TEST_NO_SUCH_VAR_12345")"#)
.eval()
.unwrap();
match value {
Value::Table(t) => assert_eq!(t.raw_len(), 0),
other => panic!("expected table, got {}", other.type_name()),
}
}
#[test]
fn path_with_get_env_joins_without_quote_error() {
// 复现用户场景PATH = { base_dir .. "/tools/numa", get_env("PATH") }
// 宿主 PATH 即使含双引号,也应拆分后正常拼接,而不是报错
let runtime = LuaRuntime::new(&test_layout()).unwrap();
let cfg: ShimConfig = runtime
.lua
.load(
r#"
return {
target = __SHIM_DIR__ .. "/tools/numa/numa.exe",
args = { "--help" },
env = {
PATH = { __SHIM_DIR__ .. "/tools/numa", get_env("PATH") }
}
}
"#,
)
.eval()
.unwrap();
let path = cfg.env.get("PATH").unwrap().to_str().unwrap();
let prefix = std::env::temp_dir()
.join("rshim-test-layout")
.to_string_lossy()
.replace('\\', "/")
+ "/tools/numa;";
assert!(path.starts_with(&prefix), "unexpected PATH: {path}");
// 宿主 PATH 的段应被附加在配置前缀之后
let host = std::env::var("PATH").unwrap_or_default();
if !host.is_empty() {
let host_first = std::env::split_paths(&host)
.next()
.unwrap()
.to_string_lossy()
.into_owned();
assert!(
path.contains(&host_first),
"missing host PATH segment: {host_first}"
);
}
// 宿主 PATH 里引号包裹的畸形段(如 "D:\\...\\bin;")应被原样保留,
// 而不是让整个配置加载失败
if host.contains('"') {
assert!(
path.contains('"'),
"quoted host segments should be preserved"
);
}
}
}

100
src/shim.rs Normal file
View File

@@ -0,0 +1,100 @@
use crate::ShimError;
use crate::{LuaRuntime, ShimConfig, ShimLayout};
use mlua::{Table, Value};
use std::{
env,
io::{Error, ErrorKind},
};
use tracing::{debug, trace, warn};
pub struct Shim;
impl Shim {
pub fn load() -> Result<ShimConfig, ShimError> {
let current_exe = env::current_exe()
.map_err(|e| Error::new(ErrorKind::Other, format!("获取代理程序路径失败: {}", e)))?;
debug!("当前目录 {}", current_exe.display());
let target_name = current_exe
.file_stem()
.and_then(|s| s.to_str())
.ok_or_else(|| {
ShimError::PathResolution(format!(
"无法从路径 [{}] 提取有效的程序名称",
current_exe.display()
))
})?
.to_lowercase();
debug!(
target_name = %target_name,
current_exe = %current_exe.display(),
"开始加载 Shim 配置"
);
let layout = ShimLayout::from_executable(current_exe)?;
debug!(
root_dir = %layout.root_dir.display(),
bin_dir = %layout.bin_dir.display(),
tools_dir = %layout.tools_dir.display(),
"Shim 目录布局解析完成"
);
let runtime = LuaRuntime::new(&layout)?;
Self::resolve_config(&runtime, &layout, &target_name)
}
fn resolve_config(
runtime: &LuaRuntime,
paths: &ShimLayout,
target_name: &str,
) -> Result<ShimConfig, ShimError> {
// 策略 1: 尝试加载全局配置文件 shims.lua
let global_config = paths.root_dir.join("rshim.lua");
if global_config.is_file() {
trace!(path = %global_config.display(), "发现全局配置文件,尝试解析");
let root_table: Table = runtime.eval_script(&global_config)?;
// 检查 shims.lua 中是否存在以 target_name 命名的 Table 节点
if root_table
.contains_key(target_name)
.map_err(|e| ShimError::InvalidConfig(format!("检查全局配置失败: {}", e)))?
{
let target_val: ShimConfig = root_table.get(target_name).map_err(|e| {
ShimError::InvalidConfig(format!("解析配置 [{}] 失败: {}", target_name, e))
})?;
debug!(
target = %target_name,
source = %global_config.display(),
"成功从全局配置文件中匹配到目标工具"
);
return Ok(target_val);
}
// 穿透:若全局配置文件存在但未包含当前程序的 key继续向下探查
trace!(target = %target_name, "全局配置文件中未包含该目标,继续探查独立配置");
}
// 策略 2: 降级寻找独立文件 ({exe}.lua)优先顺序tools/ > root/
let target_filename = format!("{}.lua", target_name);
let candidates = [
paths.tools_dir.join(&target_filename),
paths.root_dir.join(&target_filename),
];
for config_path in &candidates {
if config_path.is_file() {
debug!(path = %config_path.display(), "找到独立配置文件,开始加载");
// 直接泛型反序列化为 ShimConfig
return runtime.eval_script::<ShimConfig>(config_path);
}
trace!(path = %config_path.display(), "独立配置文件不存在,跳过");
}
// 策略 3: 所有查找失败,抛出错误
warn!(target = %target_name, "未找到任何匹配的配置文件");
Err(ShimError::ConfigMissing(format!(
"未找到关于 '{}' 的配置。请检查 shims.lua 或特定的 {}.lua 文件",
target_name, target_name
)))
}
}

View File

@@ -1,283 +0,0 @@
use crate::error::ShimError;
use mlua::{Error as LuaError, FromLua, Lua, StdLib, Table, Value};
use std::process::Command;
use std::{
collections::HashMap,
env, fs,
io::{Error, ErrorKind},
path::{Path, PathBuf},
};
/// 将 Path 转换为适合 Lua 使用的安全字符串路径
fn normalize_path_for_lua(path: &Path) -> String {
let path_str = path.to_string_lossy();
// 1. 剥离 Windows UNC 规范路径前缀 (\\?\)
let clean_str = path_str.strip_prefix(r"\\?\").unwrap_or(&path_str);
// 2. 将反斜杠转换成正斜杠(在非 UNC 路径下Windows 和 Lua 均完美支持 /
// 这样既避免了 Lua 字符串转义隐患,又不会破坏 Windows 路径
clean_str.replace('\\', "/")
}
pub struct ShimEnv {
pub bin_dir: PathBuf,
pub root_dir: PathBuf,
pub tools_dir: PathBuf,
pub target_name: String,
}
impl ShimEnv {
/// 提取当前代理程序的运行环境信息
pub fn new(current_exe: PathBuf) -> Result<Self, ShimError> {
let bin_dir = current_exe
.parent()
.ok_or_else(|| {
ShimError::PathResolutionError(format!(
"无法获取程序 [{}] 的父级 bin 目录",
current_exe.display()
))
})?
.to_path_buf();
println!("bin_dir目录 {}", bin_dir.display());
let root_dir = bin_dir
.parent()
.ok_or_else(|| {
ShimError::PathResolutionError(format!(
"无法获取 bin 目录 [{}] 的父级 root 目录",
bin_dir.display()
))
})?
.to_path_buf();
println!("root_dir 目录 {}", root_dir.display());
let tools_dir = root_dir.join("tools");
println!("tools_dir 目录 {}", tools_dir.display());
let target_name = current_exe
.file_stem()
.and_then(|s| s.to_str())
.ok_or_else(|| {
ShimError::PathResolutionError(format!(
"无法从路径 [{}] 提取有效的程序名称",
current_exe.display()
))
})?
.to_lowercase();
println!("程序名称 {}", target_name);
Ok(Self {
bin_dir,
root_dir,
tools_dir,
target_name,
})
}
}
#[derive(Debug, Clone)]
pub struct ShimConfig {
pub target_path: PathBuf,
pub args: Option<Vec<String>>,
pub envs: Option<HashMap<String, String>>,
}
impl ShimConfig {
/// 根据配置快速构建准备执行的 Command 对象
pub fn to_command(&self) -> Command {
let mut cmd = Command::new(&self.target_path);
if let Some(args) = &self.args {
cmd.args(args);
}
if let Some(envs) = &self.envs {
for (key, val) in envs {
// 直接应用环境变量Lua 端已经处理好字符串拼接或列表合并)
cmd.env(key, val);
}
}
cmd
}
}
/// 实现 FromLua Trait由 mlua 自动处理 Table 转换
impl FromLua for ShimConfig {
fn from_lua(value: Value, _lua: &Lua) -> mlua::Result<Self> {
match value {
Value::Table(table) => {
let path_str: String = table.get("path")?;
let args: Option<Vec<String>> = table.get("args")?;
// 解析 env Table
let mut envs_map = HashMap::new();
if let Ok(env_table) = table.get::<Table>("env") {
// 获取当前系统的路径分隔符Windows 为 ";"Unix 为 ":"
#[cfg(windows)]
let sep = ";";
#[cfg(not(windows))]
let sep = ":";
for pair in env_table.pairs::<String, Value>() {
let (k, v) = pair?;
match v {
// 情况 1: 普通字符串,如 HOME = "C:/path" -> 直接覆盖
Value::String(s) => {
envs_map.insert(k, s.to_str()?.to_string());
}
// 情况 2: 数组 Table如 PATH = { bin_dir, get_env("PATH") }
Value::Table(arr) => {
let paths: Vec<String> = arr
// 将 arr 作为序列(数组)处理,每个元素转为 String
.sequence_values::<String>()
.filter_map(|r| r.ok())
.filter(|s| !s.is_empty()) // 过滤空串,防止生成不必要的连续 ;;
.collect();
let combined = paths.join(sep);
envs_map.insert(k, combined);
}
_ => {}
}
}
}
let envs = if envs_map.is_empty() {
None
} else {
Some(envs_map)
};
Ok(ShimConfig {
target_path: PathBuf::from(path_str),
args,
envs,
})
}
_ => Err(mlua::Error::FromLuaConversionError {
from: value.type_name(),
to: "ShimConfig".into(),
message: Some("Expected a Lua table".to_string()),
}),
}
}
}
pub struct LuaRuntime {
lua: Lua,
}
impl LuaRuntime {
/// 初始化限定权限的 Lua 沙箱环境
pub fn new(shim_env: &ShimEnv) -> Result<Self, ShimError> {
// 只加载安全的标准库,剥离 os / io 等风险模块
let lua = Lua::new_with(
StdLib::TABLE | StdLib::STRING | StdLib::MATH | StdLib::PACKAGE,
mlua::LuaOptions::default(),
)
.map_err(|e| ShimError::EnvError(format!("初始化 Lua 失败: {}", e)))?;
let globals = lua.globals();
// 统一使用 POSIX 风格路径规范化路径字符串
let root_dir_str = normalize_path_for_lua(&shim_env.root_dir);
let tools_dir_str = normalize_path_for_lua(&shim_env.tools_dir);
// 1. 注入锚点变量
globals
.set("__SHIM_DIR__", root_dir_str.clone())
.map_err(|e| ShimError::EnvError(e.to_string()))?;
// 2. 安全暴露 get_env 供配置读取环境变量
let get_env = lua
.create_function(|_, key: String| -> mlua::Result<String> {
Ok(env::var(key).unwrap_or_default())
})
.map_err(|e| ShimError::EnvError(e.to_string()))?;
globals
.set("get_env", get_env)
.map_err(|e| ShimError::EnvError(e.to_string()))?;
// 3. 配置 package.path确保 require 行为正常
if let Ok(package) = globals.get::<Table>("package") {
if let Ok(path) = package.get::<String>("path") {
let new_path = format!(
"{};{}/?.lua;{}/?/init.lua;{}/?.lua;{}/?/init.lua",
path, root_dir_str, root_dir_str, tools_dir_str, tools_dir_str
);
let _ = package.set("path", new_path);
}
}
Ok(Self { lua })
}
/// 执行指定脚本文件,直接返回完整的 Lua Table
pub fn evaluate_lua_script(&self, path: &Path) -> Result<Table, ShimError> {
let code = fs::read_to_string(path)?;
self.lua
.load(&code)
.set_name(path.to_string_lossy())
.eval::<Table>()
.map_err(|e| ShimError::LuaExecutionError {
file: path.display().to_string(),
source: e,
})
}
/// 将 Lua Value 解析转化为 ShimConfig 数据对象
pub fn parse_config(&self, value: Value) -> Result<ShimConfig, ShimError> {
ShimConfig::from_lua(value, &self.lua).map_err(|e| ShimError::InvalidConfig(e.to_string()))
}
}
pub struct Shim;
impl Shim {
pub fn init() -> Result<ShimConfig, ShimError> {
let current_exe = env::current_exe()
.map_err(|e| Error::new(ErrorKind::Other, format!("获取代理程序路径失败: {}", e)))?;
println!("当前目录 {}", current_exe.display());
let shim_env = ShimEnv::new(current_exe)?;
let runtime = LuaRuntime::new(&shim_env)?;
Self::resolve_config(&runtime, &shim_env)
}
fn resolve_config(engine: &LuaRuntime, env: &ShimEnv) -> Result<ShimConfig, ShimError> {
// 策略 1: 尝试加载全局配置文件 shims.lua
let global_config = env.root_dir.join("shims.lua");
if global_config.is_file() {
let root_table = engine.evaluate_lua_script(&global_config)?;
// 检查 shims.lua 中是否存在以 target_name 命名的 Table 节点
if let Ok(target_val) = root_table.get::<Value>(env.target_name.as_str()) {
if matches!(target_val, Value::Table(_)) {
return engine.parse_config(target_val);
}
}
// 穿透:若全局配置文件存在但未包含当前程序的 key继续向下探查
}
// 策略 2: 降级寻找独立文件 ({exe}.lua)优先顺序tools/ > root/
let target_filename = format!("{}.lua", env.target_name);
let candidates = [
env.tools_dir.join(&target_filename),
env.root_dir.join(&target_filename),
];
for config_path in &candidates {
if config_path.is_file() {
let table = engine.evaluate_lua_script(config_path)?;
return engine.parse_config(Value::Table(table));
}
}
// 策略 3: 所有查找失败,抛出错误
Err(ShimError::ConfigNotFound(format!(
"未找到关于 '{}' 的配置。请检查 shims.lua 或特定的 {}.lua 文件",
env.target_name, env.target_name
)))
}
}