Orb — 零信任文件夹隧道工具

Orb 是一个安全的、终端优先的实用工具，让你能够通过端到端加密在互联网上共享本地文件夹。无需账户、无需云存储、无需端口转发。

演示

共享文件夹

单命令共享文件夹——全程端到端加密

浏览共享文件

用于安全文件访问的交互式 TUI 浏览器

特性

• 零信任架构：中继服务器永远无法看到明文数据
• 强加密：Argon2id 用于密钥派生，Noise Protocol 用于握手，ChaCha20-Poly1305 用于传输加密
• 跨平台：支持 Linux、macOS 和 Windows
• NAT 穿透：所有连接均为出站连接，可在防火墙后工作
• TUI 文件浏览器：交互式终端界面，用于浏览和下载文件
• 无私密资料长期留痕：会话自动过期
• 安全设计：路径净化、符号链接保护、重放保护

快速开始

安装

# 下载对应平台的二进制文件
curl -L https://github.com/Zayan-Mohamed/orb/releases/latest/download/orb-$(uname -s)-$(uname -m) -o orb
chmod +x orb
sudo mv orb /usr/local/bin/

或者 从源码构建。

共享文件夹

orb share ./myfolder

输出：

Session ID: abc123def456
Passcode: secure-random-passcode
Relay: ws://localhost:8080

请安全地将这些凭据分享给接收方。
等待连接中...

连接到共享文件夹

orb connect 7F9Q2A

提示输入密码，随后打开交互式文件浏览器。

命令

orb share <路径>

通过加密隧道共享本地目录。

选项：

• --relay <url>：中继服务器 URL（默认：http://localhost:8080）
• --readonly：以只读模式共享文件夹

示例：

orb share ./documents --readonly

orb connect <会话ID>

连接到一个共享会话。

选项：

• --relay <url>：中继服务器 URL
• --passcode <密码>：会话密码（如果未提供则提示输入）
• --tui：使用 TUI 文件浏览器（默认：true）
• --mount <路径>：FUSE 挂载点（仅 Linux/macOS）

示例：

orb connect 7F9Q2A --passcode 493-771 --tui

orb relay

启动一个中继服务器。

选项：

• --listen <地址>：监听地址（默认：:8080）

示例：

orb relay --listen 0.0.0.0:8080

安全特性

密码学

• 密钥派生：Argon2id，使用 64MB 内存，3 次迭代
• 握手：Noise Protocol 框架，采用 X25519 密钥交换
• 传输：ChaCha20-Poly1305 已验证加密
• 随机数生成：使用密码学安全的随机数

防护措施

• 密码暴力破解（Argon2id 内存硬函数）
• 重放攻击（每个数据包使用唯一 nonce）
• 中间人攻击（Noise Protocol 双向身份验证）
• 路径遍历（路径净化和验证）
• 符号链接攻击（符号链接解析与边界检查）
• 会话劫持（速率限制与会话锁定）
• 中继服务器被攻破（端到端加密，中继服务器对数据不可见）

文件系统安全

• 所有路径均经过净化和验证
• 指向共享目录外的符号链接被阻止
• 无法远程执行文件
• 可配置的只读模式
• 会话自动过期

架构

Orb 包含三个组件：

1. CLI：用于共享和连接的用户界面
2. 中继服务器：转发加密数据的盲字节管道
3. 加密隧道：端到端加密的通信通道

┌─────────┐                  ┌───────────┐                  ┌─────────┐
│ 共享方  │◄────加密──────►│  中继服务器 │◄────加密──────►│ 接收方  │
│  (CLI)  │                  │           │                  │  (CLI)  │
└─────────┘                  └───────────┘                  └─────────┘
     │                              │                              │
     │                              │                              │
     └──────────────────────────────┴──────────────────────────────┘
              所有加密在端点侧完成
              中继服务器永远无法看到明文数据

从源码构建

前提条件

• Go 1.22 或更高版本
• Make（可选，但推荐）

构建

# 克隆仓库
git clone https://github.com/Zayan-Mohamed/orb.git
cd orb

# 安装依赖
go mod download

# 为当前平台构建
make build-local

# 或为所有平台构建
./build.sh

跨平台构建

# 为所有平台构建
./build.sh

# 二进制文件将位于 build/ 目录
ls build/
# orb-linux-amd64
# orb-linux-arm64
# orb-darwin-amd64
# orb-darwin-arm64
# orb-windows-amd64.exe

开发

运行测试

make test

代码覆盖率

go test -cover ./...

本地运行中继服务器

make relay

运行共享方

make share

运行接收方

SESSION=<session-id> make connect

配置

Orb 使用合理的默认值，无需配置文件。所有设置均通过命令行标志传递。

文档

完整文档请访问 Orb 文档：

• 入门指南

  • 安装指南
  • 第一步
  • 使用示例

• 用户指南

  • 共享文件
  • 连接
  • TUI 浏览器
  • 故障排除

• 安全

  • 密码学详情
  • 最佳实践
  • 威胁模型

• 部署

  • 中继服务器
  • 生产环境
  • Docker

• 开发

  • 从源码构建
  • 贡献指南
  • API 参考

构建文档站点

# 安装 MkDocs
pip install -r requirements.txt

# 本地运行
mkdocs serve

# 构建静态站点
mkdocs build

平台相关说明

Linux

• TUI 模式开箱即用
• 安装：使用提供的二进制文件或从源码构建

macOS

• TUI 模式开箱即用
• 安装：使用提供的二进制文件或从源码构建

Windows

• TUI 模式开箱即用
• 安装：使用提供的二进制文件或从源码构建

限制

• 最大文件大小：受可用内存限制（每次读取操作 10MB）
• 会话在 24 小时后过期
• 最多允许 5 次失败密码尝试，之后会话锁定
• 只读访问（不支持文件上传/修改）

安全披露

如果你发现安全漏洞，请发送邮件至 [email protected]。请勿针对安全漏洞创建公开 issues。

许可

MIT 许可 - 详见 LICENSE 文件

贡献

欢迎贡献！请阅读《贡献指南》以了解相关规范。

鸣谢

• Noise Protocol Framework
• ChaCha20-Poly1305 (RFC 8439)
• Argon2id (RFC 9106)
• Bubble Tea TUI framework
• Go crypto libraries