Skip to content

Security: harrisonwang/spoor

Security

SECURITY.md

安全说明

spoor 可以解析来源不明的文档,但它不能代替沙箱。内置的大小限制和格式检查只能提前拦下一部分异常文件。要强制中止超时任务、限制内存或隔离崩溃,仍需由你的程序处理。

各格式的限制见格式与限制。

各部分负责什么

  • spoor-core 只接收文件内容、文件名、MIME 类型和筛选参数,不读文件、不联网、不读取环境变量,也不启动其他程序。
  • CLI、Python、Node.js 和 WASM 负责读取文件字节。CLI 只有在输入网址时才会联网。
  • Rust、Python 和 Node.js 版本会和你的程序运行在同一个进程里。需要强制超时、限制内存或隔离崩溃时,应改用独立进程、容器,或限制好内存和执行时间的 WASM 环境。
  • spoor 不执行文档中的宏、公式、脚本、Notebook 代码或其他程序。
  • 文档内容始终是不可信数据。解析不会识别提示注入,也不会判断事实真伪。

内置限制

风险 默认限制 如何调整
输入和中间结果过大 spoor-core 每次解析最多 64 MiB;CLI 一次运行处理的所有文件共用 64 MiB ParseLimits.max_parse_bytes;CLI --max-parse-mib
ZIP 条目过多 最多 10,000 个条目 暂不可改
ZIP 中的单个文件过大 最多 50 MiB,并计入总大小 暂不可改
ZIP 中单个文件的压缩比异常 最多 200 倍 暂不可改
ZIP 解压后的总量过大 解压前检查总量,并计入单次大小限制 跟随单次大小限制
CLI 输出过大 标准输出默认最多 256 KiB,截断时保留提示 CLI --max-output-kib
小文件触发大量计算 可限制单次解析的工作量 ParseLimits.max_work_units;CLI --max-work-units
旧版或加密 Office 被当成文本 识别 OLE/CFB 后直接拒绝 不可改
加密 PDF 返回固定错误码 不可改
损坏的压缩包类文件 返回固定错误码 不可改
Rust 发生 panic spoor-core 会捕获 panic,并返回 parse_failed 不可改

工作量上限只有在解析器主动检查时才会生效,不能代替强制超时。第三方底层库直接终止或崩溃时,同一进程中的程序也无法恢复。

错误处理

CLI 和各语言包使用同一组 code,并附带处理建议,有时还会指出出错环节。程序应根据 code 处理错误,不要匹配错误消息中的文字。完整列表见接口参考。

对外提供服务前

允许用户上传文件,或同时服务多个用户时,至少应做到:

  • 独立进程、容器,或限制好内存和执行时间的 WASM 环境;
  • 强制超时、并发限制和进程级内存上限;
  • 请求大小、文件数量和总输出限制;
  • 身份认证、用户数据隔离和速率限制;
  • 不在日志中记录敏感内容,及时清理临时文件,并规定数据保存多久;
  • 不要丢掉 warnings 和表格的 truncated 状态,不能只判断解析是否成功。

“本地解析”的含义

spoor 不会主动上传本地文件,但整个使用过程不一定离线。你的应用、浏览器扩展、日志、剪贴板或之后调用的模型服务仍可能把内容发送出去。如果对外宣称“本地解析”,应同时说明原文件和解析后的文字是否会被发送到其他服务。

报告漏洞

请不要为疑似漏洞创建公开 issue。请通过 GitHub 的 Security 页面提交私有安全报告,并附上最小复现、受影响版本和实际影响。

There aren't any published security advisories