配置云同步使用指南
文档版本:20260811
文档当前版本对应的 APP 版本:
- iOS:>= 3.14
- Android:>= 1.4.0
- macOS / Windows(PC 端):>= 1.0.14
配置云同步(Cloud Sync)可在登录同一账号后,于 Windows、macOS、Android、iOS 等设备之间同步规则类配置,免去重复导入、手动拷贝的麻烦。
重要说明: 云同步只同步「规则与配置文件」,不会上传您的抓包数据。抓包数据始终只保存在您的设备本地。
一、支持同步哪些数据
云同步目前支持以下 6 类 配置。您可以在各端「设置 → 配置云同步 → 同步内容」中按需勾选:
| 同步类型 | 说明 |
|---|---|
| Host 黑白名单 | 抓包时的 Host 过滤规则 |
| DNS 映射 | 自定义域名解析到指定 IP 的规则 |
| 重写规则 | Mock、改写、丢弃、重定向等请求/响应重写规则 |
| 脚本 | 用户编写的 JavaScript 脚本 |
| 组合重放 | 组合重放流程规则 |
| Protobuf 描述文件 | 用于 Protobuf 解码的 .desc 等描述文件 |
不会同步的内容(请知悉):
- 抓包历史、Session、请求/响应 Body 等流量数据
- 证书、收藏的请求记录、API 文档收藏等
- 您的加密口令(见下文「端到端加密」)
二、如何使用
2.1 前置条件
- 登录 ApiCatcher 账号(邮箱验证码登录)
- 账号已具备配置云同步使用权限
- 在「设置 → 配置云同步」中配置 加密口令(见第三节)
- 打开「启用云同步」开关
2.2 首次在一台设备上启用
- 进入 设置 → 配置云同步
- 阅读页面上的端到端加密说明
- 设置并确认 加密口令,点击保存
- 打开「启用云同步」
- 选择需要同步的配置类型
- 可点击「立即同步」手动触发一次同步
2.3 在新设备上使用(已有云端数据)
- 登录 同一账号
- 进入配置云同步,输入 与第一台设备相同的加密口令
- 保存口令后启用云同步
- 点击「立即同步」,本机会从云端拉取并解密配置
若口令输入错误,应用会提示口令不一致或部分配置无法解密,此时请检查口令是否与最初设置的一致。
2.4 日常使用
- 修改 Host 规则、DNS 映射、重写规则等被勾选同步的配置后,应用会在本地稍作等待(约 2 秒)后 自动上传变更,一般无需手动操作。
- 打开应用或切换回前台时,也会自动检查云端是否有更新并拉取。
- 进入各类规则列表页时,会自动拉取该类型在云端的最新配置。
- 您也可以随时点击「立即同步」手动同步。
2.5 删除云端数据
在配置云同步页面底部,可执行「删除云端配置数据」。
- 仅删除服务器上的加密备份,不会删除您设备上的本地配置。
- 忘记加密口令、需要更换口令时,通常也需要先删除云端数据(见第五节)。
三、增量同步是怎么工作的
云同步采用 增量同步,不会每次把全部配置重新上传一遍。下面用通俗方式说明原理,便于您理解同步行为。
3.1 本地改了什么,就只传什么
当您在某一类配置里 新增、修改或删除 一条规则时,应用会在本地把这条记录标记为「待同步」。稍等片刻后,只把这些 有变更的条目 加密并上传到云端,而不是整库重传。
3.2 云端有一份「变更清单」
每一类配置在云端维护一个 版本号 和 条目清单(每条配置的 ID、更新时间、是否已删除)。同步时:
- 本机先询问云端:「这一类配置现在是什么版本?有哪些条目变了?」
- 对比本机记录,找出 云端有而本机没有的新变更,只下载这些条目
- 本机再把 自己这边待上传的变更 推送给云端
因此,即使您有上百条重写规则,日常只改一条,通常也只会同步这一条。
3.3 多设备同时修改时怎么办
若两台设备 几乎同时 修改了 同一条 配置,云端会以 更新时间较新的那一份为准(Last Write Wins,即「后写入的覆盖先写入的」)。这是为了保证各端最终能收敛到一致状态,而不是让同步卡死。
建议:对同一条规则尽量避免多设备同时编辑;若发生冲突,以最后保存/同步成功的版本为准。
3.4 同步不会碰您的抓包流量
上述流程只针对 规则与配置文件。抓包得到的请求列表、响应内容等 从不进入云同步管道,也不会上传到 ApiCatcher 服务器。
四、端到端加密(E2EE)
配置云同步采用 端到端加密。您可以把它理解为:只有知道加密口令的您本人(以及您授权使用同一口令的设备)才能读懂配置内容;服务器和 ApiCatcher 运营方在正常情况下 无法查看 您同步的配置明文。
4.1 加密发生在您的设备上
启用云同步并保存配置时,流程大致如下:
- 您在设备上输入 加密口令
- 应用在本机用标准算法从口令 派生出加密密钥(密钥不会上传)
- 配置内容在本机 加密并压缩 后,才上传到服务器
- 服务器收到的只是 密文(一段无法直接阅读的数据)
因此:服务器只存储密文,不存储可读的 Host 规则、脚本源码等明文。
4.2 加密口令只保存在您的设备本地
- 加密口令 不会 上传到 ApiCatcher 服务器
- 口令经安全存储保存在本机(如 iOS Keychain、Android 加密存储、PC 本地安全存储)
- 退出账号时,自动清除存储在本机的加密口令
ApiCatcher 不知道、也不保存您的加密口令。 我们无法帮您「找回口令」。
4.3 服务器上存的是什么?有没有存我的口令?
没有。 服务器上与加密相关的数据主要是:
| 存储项 | 作用 | 能否还原口令或配置明文 |
|---|---|---|
| 加密后的配置(密文) | 备份您的规则数据 | 不能,没有口令/密钥无法解密 |
| 密钥指纹(Key Fingerprint) | 判断各设备是否使用 同一套 加密密钥 | 不能,指纹是密钥的哈希值,无法反推口令 |
| 盐值(Salt) | 参与口令派生密钥的公开参数 | 不能,盐值本身不能解密数据 |
可以简单理解:
- 口令 → 只在您的设备上使用,不上传
- 密钥 → 由口令在设备上计算得出,不上传
- 密钥指纹 → 上传的是密钥的「指纹」(类似校验码),用来判断口令是否一致,不是口令本身
4.4 新设备上如何验证口令是否正确?
这是 很多 用户会关心的问题:「既然服务器不知道我的口令,那新手机怎么知道我输对了?」
流程如下:
- 您在 第一台设备 上设置口令并启用云同步时,本机从口令派生出加密密钥,并计算该密钥的 指纹,将指纹注册到云端(与您的账号关联)。
- 在 新设备 上登录同一账号后,应用会从云端读取:盐值 和 已注册的密钥指纹(仍然 没有 口令)。
- 您在新设备输入口令后,应用用 同样的算法 在本地派生密钥,并计算指纹。
- 若本地算出的指纹与云端保存的指纹 一致,说明口令正确,可以解密和同步。
- 若 不一致,说明口令错误,或与第一台设备使用的口令不同;应用会拒绝上传,拉取到的密文也无法正确解密。
因此:验证是在您的新设备本地完成的,云端只提供一个「标准答案的指纹」供比对,全程不需要、也不会传输您的口令。
4.5 各设备必须使用相同的加密口令
所有要同步的设备必须配置 相同的加密口令,这样派生出的密钥和指纹才一致。若某台设备使用了不同口令,会出现「口令与另一台设备不一致」等提示,且无法与已有云端数据互通。
4.6 安全提示
- 请使用足够强度的口令,并妥善保管。
- 不要将口令告诉不可信的人;知道口令的人理论上可以在其设备上解密您的云端配置。
- ApiCatcher 官方 不会 向您索要加密口令。
五、忘记加密口令怎么办
由于端到端加密的设计,加密口令一旦遗忘,无法通过 ApiCatcher 或服务器找回——我们从未保存口令,也没有「重置口令并保留原数据」的后门。
5.1 为什么无法直接改口令继续用旧数据?
云端保存的配置是用 旧口令派生的密钥 加密的。没有旧口令,就无法在本地生成正确的解密密钥,密文将永久无法解读。这不是 bug,而是端到端加密 刻意 达到的安全效果:即使服务器数据泄露,没有口令的人也无法读取内容。
5.2 正确处理方式
若您确认 无法想起 加密口令:
- 在已开启云同步的设备上,进入 配置云同步
- 执行 「更换口令」,这会清空云端存储的加密数据,以及密钥指纹
- 因为该操作不仅会清除本机加密口令,也会清除云端数据,所以先继续在其它已开启云同步的设备上执行 「更换口令」 操作
- 所有设备上都执行完 「更换口令」 后,逐个设备配置新的加密口令,并开启云同步,重新开启云同步后本机当前的本地配置会上传,形成 新的 云端备份
5.3 建议
- 将加密口令记录在您信任的密码管理器中。
- 在更换口令前,确认至少有一台设备上仍保留可用的 本地配置 副本。
六、常见问题
Q1:云同步和「实时同步到 Burp Suite / 桌面端」是一回事吗?
不是。配置云同步 同步的是规则与配置文件。实时同步(如推送到 Burp Suite、WebSocket 接收端)同步的是 抓包流量,属于另一项功能,二者互不影响。
Q2:不登录可以用云同步吗?
不可以。云同步需要将加密备份与您的账号关联,并校验您的账号是否具备使用权限。
Q3:关闭云同步后,云端数据还在吗?
关闭开关只会停止继续同步,不会自动删除 已有云端备份。若要删除服务器上的数据,请使用「删除云端配置数据」。
Q4:卸载应用会删除云端数据吗?
不会。卸载只影响本机。云端加密备份需通过应用内「删除云端配置数据」或账号注销流程处理。
Q5:登录过期了会怎样?
登录会话过期后,云同步会自动关闭,需要重新登录后再开启。
七、相关链接
如有疑问,请联系:[email protected]