Publish

💾 安全备份工作区,密钥零泄露

OpenClaw工作区安全备份与恢复工具,内置100+密钥模式检测,防御性设计防止敏感信息泄露至GitHub

收藏
3.6k
安装
1.1k
版本
1.0.10
CLS 安全性认证2026-08-03
点击查看完整报告 >

使用说明

核心用法

ClawSync 是一套专为 OpenClaw 工作空间设计的备份与恢复解决方案,通过 GitHub 仓库实现数据持久化。用户需配置三个环境变量(GITHUB_TOKEN、BACKUP_REPO、OPENCLAW_WORKSPACE),执行 sync.sh 即可完成备份,restore.sh 实现还原。

备份范围采用严格的白名单机制:身份文件(AGENTS.md、SOUL.md 等)自动包含;技能和脚本目录需人工审查后纳入。关键安全文件如 SITES.md(含API密钥)、MEMORY.md(含敏感对话)及 credentials/、.env、node_modules 等目录被明确排除。

显著优点

1. 纵深防御架构:预检环境变量→白名单复制→正则扫描密钥→Git操作前二次校验,四层防护确保敏感信息零泄露
2. 智能密钥检测:内置100+正则模式,覆盖 GitHub Token、OpenAI Key、AWS凭证、JWT、私钥等常见 secret 类型,误报率极低

3. 最小权限原则:推荐使用 GitHub Fine-Grained PAT,仅授予目标仓库 Contents:Write 权限,降低凭证泄露后的 blast radius

4. 安全还原机制:默认交互式确认,支持 --force 强制模式,防止误覆盖当前工作区

5. CI/CD 集成:ShellCheck 静态检查 + 集成测试 + 秘密检测审计测试,发布流程规范

潜在缺点与局限

  • 手动审查负担:skills/ 和 scripts/ 目录需人工审核后纳入备份,自动化程度受限
  • 密钥检测非绝对:基于正则的模式匹配无法捕获所有变种(如 base64 编码后的密钥),存在漏报可能
  • GitHub 依赖:备份目标单一,不支持 GitLab、Gitea 等替代平台
  • Shell 脚本可维护性:复杂逻辑以 bash 实现,长期维护成本高于 Python/Go 等类型安全语言
  • 无加密传输层:依赖 Git HTTPS/TLS,不支持客户端加密后再上传

适合人群

  • 使用 OpenClaw 框架的开发者与团队
  • 对数据安全有较高要求、接受适度手动审查的技术用户
  • 需要跨设备同步工作区配置的个人用户

常规风险

  • 凭证泄露:若用户误用经典 PAT 而非 Fine-Grained Token,或将其配置在全局环境变量中,可能导致横向移动攻击
  • 仓库权限失控:备份仓库若设为公开,即使经过密钥扫描,仍可能通过文件元数据泄露敏感信息
  • 恢复误操作:--force 模式在脚本化调用时可能覆盖未提交的本地产出,建议生产环境禁用强制模式
  • 供应链攻击:依赖 gh CLI 作为认证回退,需确保 gh 本身未被篡改

安全认证摘要

系统报告为占位生成,未执行实际安全扫描。建议用户自行运行「Security Audit Test」验证密钥检测有效性。

安全解读

核心用法

ClawSync 是一款专为 OpenClaw 工作空间设计的安全备份与恢复工具,通过 Shell 脚本实现本地工作空间与 GitHub 仓库的双向同步。用户需配置三个环境变量:GITHUB_TOKEN(推荐细粒度 PAT)、BACKUP_REPO(目标仓库)和 OPENCLAW_WORKSPACE(本地路径),执行 sync.sh 即可完成备份,restore.sh 实现恢复。

备份流程采用严格的白名单机制:仅复制身份文件(AGENTS.md、SOUL.md 等)、技能和脚本目录,同时通过 deny list 排除 .git、node_modules、credentials/ 等目录。关键安全特性在于预提交密钥扫描——脚本会在 git add 前扫描 100+ 种密钥模式(GitHub tokens、OpenAI keys、AWS keys、JWT、私钥等),一旦检测到高熵字符串或密钥特征,立即中止备份并告警。

恢复流程设计保守:默认需要用户交互确认,仅当显式传入 --force 参数才跳过提示,且使用 cp -n 避免覆盖现有文件,配合临时目录和自动清理机制防止残留数据。

显著优点

纵深防御架构是该 skill 的核心竞争力。相比常规备份工具,ClawSync 在三个层面构建安全壁垒:文件层通过硬编码白名单主动排除 SITES.md、MEMORY.md 等高风险文件;内容层通过正则匹配扫描 100+ 密钥模式;传输层优先使用 gh CLI 认证,避免 token 暴露在进程列表中。

零依赖设计大幅降低了供应链攻击面。脚本仅依赖系统标准工具(bash、git、gh、rsync),无 npm/pip 等第三方包管理器引入的依赖风险,且通过 ShellCheck 静态检查确保代码质量。

合规友好特性突出。主动设计符合 GDPR、CCPA 等隐私法规要求,内置的密钥管理和权限最小化原则(推荐 Fine-Grained PAT 仅授予 Contents: Write)满足企业安全审计标准。

潜在缺点与局限性

功能范围刻意受限可能带来使用摩擦。为安全牺牲便利性,用户无法备份包含 API 密钥的 SITES.md 或对话历史的 MEMORY.md,需手动管理这些文件的分发。对于依赖完整工作空间快照的用户,这种碎片化备份策略需要额外协调。

误报与漏报风险客观存在。正则扫描虽覆盖主流密钥格式,但对自定义密钥格式、base64 编码后的密钥或分段存储的敏感信息可能漏检;反之,高熵的随机字符串也可能触发误报阻塞正常备份。

T3 来源可信度要求用户承担额外审查责任。作为个人开发者项目,缺乏企业级 SLA 保障和长期维护承诺,代码虽开源但用户需自行评估更新活跃度和社区支持状况。

平台锁定明显。设计深度绑定 OpenClaw 工作空间结构和 GitHub 生态,迁移至其他 Git 托管平台或备份系统需要脚本改造。

适合的目标群体

  • 安全意识强的个人开发者:重视密钥保护,愿意接受严格限制换取泄露风险降低
  • 小型团队协作场景:需要共享 OpenClaw 配置但需避免敏感信息扩散的团队
  • 合规敏感行业从业者:金融、医疗等领域需满足审计要求的配置备份需求
  • 技术审核能力者:具备阅读 Shell 脚本能力,能自行验证安全机制有效性的用户

不适合:追求一键完整备份的便利性优先用户、缺乏技术背景无法处理环境变量配置和潜在误报的非技术用户、需要跨平台多云备份的企业级场景。

使用风险

配置错误风险:GITHUB_TOKEN 权限过宽(Classic PAT)或误提交 .env 文件可能导致仓库泄露,需严格遵循文档使用 Fine-Grained PAT 并确认 .gitignore 配置。

扫描绕过风险:密钥分段存储、编码混淆或新型密钥格式可能逃避检测,重要仓库建议配合 GitHub Secret Scanning 等二次防护。

恢复覆盖风险:尽管有 -n 保护和确认提示,批量自动化部署时 --force 参数滥用仍可能导致配置丢失,建议恢复前进行本地 Git 备份。

维护中断风险:个人项目更新频率不确定,关键漏洞修复依赖社区贡献,建议 fork 后自行维护或设置更新监控。

Publish 内容

scripts文件夹
手动下载zip · 6.0 kB
test.shtext/x-shellscript
请选择文件