projects/code-sandbox/README.md
基于 Bun + Hono 的代码执行沙盒,支持 JS 和 Python。采用进程池架构,预热长驻 worker 进程,通过 stdin/stdout JSON 协议通信,消除每次请求的进程启动开销。
HTTP Request → Hono Server → Process Pool → Worker (long-lived) → Result
↓
┌──────────────┐
│ JS Workers │ bun run worker.ts (×N)
│ Py Workers │ python3 worker.py (×N)
└──────────────┘
stdin: JSON task → stdout: JSON result
__import__ 拦截 + resource 资源限制SystemHelper.httpRequest() / system_helper.http_request() 收口,内置 SSRF 防护进程池 vs 旧版 spawn-per-request 对比(SANDBOX_POOL_SIZE=20):
| 场景 | 旧版 QPS / P50 | 进程池 QPS / P50 | 提升 |
|---|---|---|---|
| JS 简单函数 (c50) | 22 / 1,938ms | 1,414 / 7ms | 64x |
| JS IO 500ms (c50) | 22 / 2,107ms | 38 / 1,005ms | 1.7x |
| JS 高 CPU (c10) | 9 / 1,079ms | 12 / 796ms | 1.3x |
| JS 高内存 (c10) | — | 13 / 787ms | — |
| Python 简单函数 (c50) | 14.7 / 2,897ms | 4,247 / 4ms | 289x |
| Python IO 500ms (c50) | 14.2 / 3,066ms | 38 / 1,003ms | 2.7x |
| Python 高 CPU (c10) | 3.1 / 2,845ms | 4 / 2,191ms | 1.3x |
| Python 高内存 (c10) | — | 11 / 893ms | — |
资源占用(20+20 workers):空闲 ~1.5GB RSS,压测峰值 ~2GB RSS。
# 安装依赖
bun install
# 开发运行
bun run src/index.ts
# 运行测试
bun run test
# 构建
docker build -f projects/code-sandbox/Dockerfile -t fastgpt-code-sandbox .
# 运行
docker run -p 3000:3000 \
-e SANDBOX_TOKEN=your-secret-token \
-e SANDBOX_POOL_SIZE=20 \
fastgpt-code-sandbox
POST /sandbox/js执行 JavaScript 代码。
{
"code": "async function main(variables) {\n return { result: variables.a + variables.b }\n}",
"variables": { "a": 1, "b": 2 }
}
POST /sandbox/python执行 Python 代码。
{
"code": "def main(variables):\n return {'result': variables['a'] + variables['b']}",
"variables": { "a": 1, "b": 2 }
}
GET /health健康检查,返回进程池状态。
{
"status": "ok",
"version": "5.0.0",
"jsPool": { "total": 20, "idle": 18, "busy": 2, "queued": 0 },
"pythonPool": { "total": 20, "idle": 20, "busy": 0, "queued": 0 }
}
成功:
{
"success": true,
"data": {
"codeReturn": { "result": 3 },
"log": "console.log 输出内容"
}
}
失败:
{
"success": false,
"message": "错误信息"
}
| 变量 | 说明 | 默认值 |
|---|---|---|
SANDBOX_PORT | 服务端口 | 3000 |
SANDBOX_TOKEN | Bearer Token 认证密钥 | 空(不鉴权) |
| 变量 | 说明 | 默认值 |
|---|---|---|
SANDBOX_POOL_SIZE | 每种语言的 worker 进程数 | 20 |
| 变量 | 说明 | 默认值 |
|---|---|---|
SANDBOX_MAX_TIMEOUT | 超时上限(ms),请求不可超过此值 | 60000 |
SANDBOX_MAX_MEMORY_MB | 内存上限(MB) | 256 |
| 变量 | 说明 | 默认值 |
|---|---|---|
SANDBOX_REQUEST_MAX_COUNT | 单次执行最大 HTTP 请求数 | 30 |
SANDBOX_REQUEST_TIMEOUT | 单次 HTTP 请求超时(ms) | 60000 |
SANDBOX_REQUEST_MAX_RESPONSE_MB | 最大响应体大小(MB) | 10 |
SANDBOX_REQUEST_MAX_BODY_MB | 最大请求体大小(MB) | 5 |
src/
├── index.ts # 入口:Hono 服务 + 进程池初始化
├── env.ts # 环境变量校验(zod)
├── config.ts # 配置导出
├── types.ts # 类型定义
├── pool/
│ ├── process-pool.ts # JS 进程池管理
│ ├── python-process-pool.ts # Python 进程池管理
│ ├── worker.ts # JS worker(长驻进程,含安全 shim)
│ └── worker.py # Python worker(长驻进程,含安全沙箱)
└── utils/
└── semaphore.ts # 信号量(通用并发控制)
test/
├── unit/ # 单元测试(进程池、信号量)
├── integration/ # 集成测试(API 路由)
├── boundary/ # 边界测试(超时、内存限制)
├── security/ # 安全测试(沙箱逃逸防护)
├── compat/ # 兼容性测试(旧版代码格式)
├── examples/ # 示例测试(常用包)
└── benchmark/ # 压测脚本
沙盒内的 JS 代码通过 require() 加载包,但仅允许白名单内的包。
lodash、dayjs、moment、uuid、crypto-js、qs、url、querystring
cd projects/code-sandbox
bun add <package-name>
SANDBOX_JS_ALLOWED_MODULES):在逗号分隔列表中添加包名:
SANDBOX_JS_ALLOWED_MODULES=lodash,dayjs,moment,uuid,crypto-js,qs,url,querystring,your-new-package
SystemHelper.httpRequest(),不要放行 axios、node-fetch 等网络库numpy、pandas(通过 requirements.txt 安装)
requirements.txt:numpy
pandas
your-new-package
SANDBOX_PYTHON_ALLOWED_MODULES):在逗号分隔列表中添加包名。如果新包依赖了黑名单中的模块(如 os),标准库路径的间接导入会自动放行,无需额外配置。
__import__ 拦截实现,只拦截用户代码的直接 importos、sys、subprocess、socket 等)始终被拦截require() 白名单,非白名单模块直接拒绝Bun.spawn、Bun.write、Bun.serve 等 API 禁用Function 构造器冻结,阻止 constructor.constructor 逃逸process.env 清理,仅保留必要变量fetch、XMLHttpRequest、WebSocket 禁用__import__ 黑名单拦截:用户代码无法 import 危险模块(os、sys、subprocess 等)exec()/eval() 内的 import 同样被拦截(基于调用栈帧检测)builtins.__import__ 通过代理对象保护,用户无法覆盖signal.SIGALRM 超时保护httpRequest() 收口10.0.0.0/8、172.16.0.0/12、192.168.0.0/16、127.0.0.0/8、169.254.0.0/16http: / https: 协议| 函数 | 说明 |
|---|---|
SystemHelper.httpRequest(url, opts?) | HTTP 请求(opts: {method, headers, body, timeout}) |
| 函数 | 说明 |
|---|---|
SystemHelper.httpRequest(url, opts?) | HTTP 请求(opts: {method, headers, body, timeout}) |
# 全部测试(332 cases)
bun run test
# 单个文件
bunx vitest run test/security/security.test.ts
# 带详细输出
bunx vitest run --reporter=verbose
# 压测(需先启动服务)
bash test/benchmark/bench-sandbox.sh
bash test/benchmark/bench-sandbox-python.sh
测试配置:串行执行(fileParallelism: false),池大小 1(避免资源竞争)。
测试覆盖维度:
| 分类 | 文件数 | 用例数 | 说明 |
|---|---|---|---|
| 单元测试 | 4 | 43 | 进程池生命周期/恢复/健康检查、Semaphore 并发控制 |
| 集成测试 | 2 | 53 | HTTP API 路由、JS/Python 功能验证 |
| 安全测试 | 1 | 102 | 模块拦截、逃逸攻击、SSRF 防护、注入攻击 |
| 边界测试 | 1 | 58 | 空输入、超时、大数据、类型边界 |
| 兼容性测试 | 2 | 39 | 旧版 JS/Python 代码格式兼容 |
| 示例测试 | 1 | 31 | 常用场景和第三方包 |