mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-11-18 02:34:41 +00:00
refactor(ng2): encrypt proxy listening configuration
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
# 分离本地监听与局域网监听
|
||||
|
||||
后续修订:监听认证的持久化与读取失败重置方向见 [ADR-0042](0042-encrypt-proxy-listening-configuration.md);该修订已实施。
|
||||
|
||||
**状态**:已接受。
|
||||
|
||||
2026-10-13 修订:局域网启用状态与监听模式独立。
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# 持久服务器库整体加密与主密钥恢复边界
|
||||
|
||||
后续修订:范围外的监听配置采用独立主密钥整体加密,见 [ADR-0042](0042-encrypt-proxy-listening-configuration.md);该修订已实施,服务器库自身的恢复规则保持不变。
|
||||
|
||||
Status: Accepted(2026-10-18)。
|
||||
|
||||
实施状态:整体加密、记录直接携带秘密及移除 NG2 历史格式兼容均已实施。当前实现以代码为准,验证结果见对应交付记录。
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# 分离独立偏好,将 JSON 限定为代理监听配置
|
||||
|
||||
后续修订:监听配置整体加密与确认重置方向见 [ADR-0042](0042-encrypt-proxy-listening-configuration.md);该修订已实施,本 ADR 的存储范围分离继续有效。
|
||||
|
||||
**状态**:已接受并实施(2026-10-19)。
|
||||
|
||||
当前 `settings.json` 同时保存监听配置和独立偏好,模式与开关等修改需要重写整份快照。将独立偏好直接分离,以缩小文件存储 module 的职责;不另建通用设置仓库,也不为原整快照保存路径专门建设集中管理 module。
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# 代理监听配置整体加密与确认重置
|
||||
|
||||
**状态**:已接受并实施(2026-10-19)。
|
||||
|
||||
代理监听配置改用与服务器库相同的主密钥加密方法,但保留独立文件和独立主密钥。复用 AES-256-GCM 加密与经典 Keychain 主密钥存储的实现,不共用服务器库当前的实际密钥。服务器库重置不改变监听配置及其密钥,监听配置重置也不改变服务器库。
|
||||
|
||||
用户名和密码随所属监听配置整体加密保存。移除逐项凭据存储、密码引用及跨存储提交补偿;保留完整配置校验、原子保存、保存失败不发布,以及保存成功后再执行运行状态收敛的契约。运行配置准备、编辑与终端命令从已解密内存读取所需值;状态投影、日志与诊断不得因此携带密码。
|
||||
|
||||
## 读取失败与重置
|
||||
|
||||
读取失败时保留原文件并阻断正常启动,不进入可操作的工作区,也不允许普通监听保存覆盖原配置。显示说明性错误 alert,只提供“重置监听配置”选项,不提供取消或退出选项。提示重置将放弃原监听配置,包括端口和局域网认证资料,并关闭局域网监听。不要求判断密钥是否永久丢失,不提供找回密钥或人工删除文件的恢复分支。
|
||||
|
||||
静默启动遇到相同错误时也直接显示该 alert,不等待用户打开主窗口。正常启动的静默行为保持不变。
|
||||
|
||||
只有用户明确确认重置后,才创建独立的新主密钥并原子保存默认监听配置。保存成功后发布默认值并解除监听配置读取失败的运行阻断。保存失败则保留原文件,不发布默认值,继续报告错误。默认配置关闭局域网监听,避免保留原共享入口却移除身份验证。
|
||||
|
||||
读取失败、等待确认及重置失败期间,保留已有后台代理和系统代理,不执行停止、重部署或系统代理修改。GUI 无法读取监听配置,不代表后台代理已经使用的独立运行配置失效;正常启动的运行状态收敛必须等待监听配置可用。重置成功后,再按默认监听配置、现有活动目标和已保存的代理服务与系统代理开关意图执行正常收敛,不重置这些独立意图。
|
||||
|
||||
不新增恢复页面、恢复向导或复杂的错误恢复状态机。相较于要求用户定位并删除配置文件,错误 alert 中的确认重置能以有限交互成本降低恢复成本。这是对 ADR-0040 人工恢复取舍的局部修订。
|
||||
|
||||
启动组合根在装配其他应用 module 前完成监听配置读取或确认重置。读取失败不会进入工作区或启动正常运行状态收敛;普通保存也不能绕过读取失败门禁。
|
||||
|
||||
## 取舍与适用范围
|
||||
|
||||
独立密钥使两个存储 module 保持各自的生命周期与恢复规则。共用实际密钥虽然减少一条 Keychain 记录,却要求协调两份密文的首次创建、读取和重置,收益不足。
|
||||
|
||||
不迁移旧监听 JSON,也不读取或清理旧逐项 Keychain 凭据。检测到旧监听文件时报告格式不支持,由用户明确确认后重置,不静默忽略旧文件并使用默认值。
|
||||
|
||||
本决定修订 ADR-0034、ADR-0035、ADR-0041 对监听密码继续独立保存于 Keychain 的规定。ADR-0041 对监听配置与独立偏好的存储范围分离继续有效。
|
||||
|
||||
本 ADR 记录产品行为,不授权在设计讨论期间重置本机实际配置或 Keychain 项。
|
||||
@@ -168,6 +168,6 @@ The user-facing import from the old ShadowsocksX-NG application remains availabl
|
||||
|
||||
- [ServerLibraryStorage.swift](../ShadowsocksX-NG2/Domain/Catalog/ServerLibraryStorage.swift): header, encryption, decryption, payload size limits, and historical-file handling.
|
||||
- [CatalogFileStore.swift](../ShadowsocksX-NG2/Domain/Catalog/CatalogFileStore.swift): direct catalog JSON encoding, schema v7, and structure validation.
|
||||
- [LibraryMasterKeyStore.swift](../ShadowsocksX-NG2/Domain/Credentials/LibraryMasterKeyStore.swift): master key attributes and keychain access.
|
||||
- [MasterKeyStore.swift](../ShadowsocksX-NG2/Domain/Credentials/MasterKeyStore.swift): master key attributes and keychain access.
|
||||
- [CatalogModels.swift](../ShadowsocksX-NG2/Domain/Catalog/CatalogModels.swift) and [SubscriptionRecord.swift](../ShadowsocksX-NG2/Domain/Subscription/SubscriptionRecord.swift): Codable models for catalog records and inline secrets.
|
||||
- [AtomicFileWriter.swift](../ShadowsocksX-NG2/Domain/Runtime/AtomicFileWriter.swift): temporary files and permission baseline.
|
||||
|
||||
@@ -168,6 +168,6 @@ NG2 尚未发版,读取器不迁移其历史数据:
|
||||
|
||||
- [ServerLibraryStorage.swift](../ShadowsocksX-NG2/Domain/Catalog/ServerLibraryStorage.swift):文件头、加解密、payload 大小限制与历史文件处理。
|
||||
- [CatalogFileStore.swift](../ShadowsocksX-NG2/Domain/Catalog/CatalogFileStore.swift):直接目录 JSON 编码、schema v7 和结构校验。
|
||||
- [LibraryMasterKeyStore.swift](../ShadowsocksX-NG2/Domain/Credentials/LibraryMasterKeyStore.swift):主密钥的 Keychain 属性与访问方式。
|
||||
- [MasterKeyStore.swift](../ShadowsocksX-NG2/Domain/Credentials/MasterKeyStore.swift):主密钥的 Keychain 属性与访问方式。
|
||||
- [CatalogModels.swift](../ShadowsocksX-NG2/Domain/Catalog/CatalogModels.swift)、[SubscriptionRecord.swift](../ShadowsocksX-NG2/Domain/Subscription/SubscriptionRecord.swift):目录记录及内联秘密的 Codable 模型。
|
||||
- [AtomicFileWriter.swift](../ShadowsocksX-NG2/Domain/Runtime/AtomicFileWriter.swift):临时文件与权限基线。
|
||||
|
||||
Reference in New Issue
Block a user