MDBX 规范索引
这个文件夹是 MDBX 项目的规范主目录。
MDBX 是一种本地优先的加密密码数据库格式与参考架构。 它的核心设计目标是:
- 本地优先
- 长期存档稳定
- 类 Git 的冲突防止与恢复能力
- 在网盘工作流中显著优于 KDBX 的同步表现
- 通过 Tiga 模型提供三档安全状态
- 以
project为中心组织密码 - 原生支持附件
RFC 风格分层
从现在开始,这套文档按更正式的 RFC 风格分层:
00到05- 核心规范层
- 定义术语、原则、产品模型、存储同步、安全和 RFC 文档约定
06到09- 实现指导层
- 定义 SQLite schema、任务拆分、KDBX 映射、Tiga 参数
10- 状态总结层
- 定义当前完成度、风险、下一步建议
阅读顺序
如果你是负责实现的低端模型,请严格按下面顺序阅读:
00-agent-rules.md01-product-spec.md02-storage-sync-spec.md03-security-spec.md04-roadmap-acceptance.md05-rfc-structure.zh-CN.md
如果你是中文阅读者,请按下面顺序阅读:
00-agent-rules.zh-CN.md01-product-spec.zh-CN.md02-storage-sync-spec.zh-CN.md03-security-spec.zh-CN.md04-roadmap-acceptance.zh-CN.md05-rfc-structure.zh-CN.md06-sqlite-schema-v1.zh-CN.md07-low-end-model-task-breakdown.zh-CN.md08-kdbx-to-mdbx-mapping.zh-CN.md09-tiga-parameters.zh-CN.md10-status-summary.zh-CN.md
文档职责
00-agent-rules.md/00-agent-rules.zh-CN.md- 给执行模型的规则文档。
- 规定什么可以做,什么不可以擅自发明。
01-product-spec.md/01-product-spec.zh-CN.md- 产品目标、核心约束、领域模型、对象模型、用户可见行为。
02-storage-sync-spec.md/02-storage-sync-spec.zh-CN.md- 单文件格式、内部存储、增量写入、同步、冲突处理、附件存储规则。
03-security-spec.md/03-security-spec.zh-CN.md- Tiga 模式、加密、密钥层级、内存处理、安全约束。
04-roadmap-acceptance.md/04-roadmap-acceptance.zh-CN.md- 路线图、MVP 边界、验收标准、测试矩阵、任务拆解模板。
05-rfc-structure.zh-CN.md- 说明这套 spec 如何按 RFC 风格组织,哪些文档是规范性的,哪些是实现指导性的。
06-sqlite-schema-v1.zh-CN.md- SQLite 初版 schema 设计文档,定义项目、条目、附件、提交历史等表结构。
07-low-end-model-task-breakdown.zh-CN.md- 专门给低端模型使用的任务拆分清单,可直接派活。
08-kdbx-to-mdbx-mapping.zh-CN.md- KDBX 到 MDBX 的映射规范,减少导入器实现时的自由发挥。
09-tiga-parameters.zh-CN.md- Tiga 三模式的参数推荐表和行为差异说明。
10-status-summary.zh-CN.md- 当前 spec 完成度、风险项、MVP 就绪度、下一步建议。
不可妥协原则
所有实现和所有设计决策都必须保留以下性质:
- 本地优先
- 长期可读、可迁移
- 前向兼容与后向兼容
- 不依赖中心服务器
- 以
project为中心组织密码 - 原生附件能力
- 比 KDBX 更安全的同步与冲突处理
- 比 KDBX 更好的网盘同步性能
核心词汇
vault- 一个 MDBX 数据库文件。
project- 一个现实世界中的账号、网站、应用、组织、身份集合、工作环境、服务集合的主容器。
entryproject内部的具体记录,例如登录项、笔记、卡片、令牌、密钥等。
attachment- 归属于
project或entry的文件或二进制内容。
- 归属于
tiga mode- 三档安全模式之一:
Power Type、Multi Type、Sky Type。 - 语义映射为:
Power Type= 最高防护,Multi Type= 平衡默认,Sky Type= 更快更轻便。
- 三档安全模式之一:
oplog- 追加式变更历史,用于同步与恢复。
snapshot- 可用于恢复的压缩状态快照。
后续新增文档的写法要求
以后如果继续往这个目录里补规范,必须遵守:
- 使用
MUST、MUST NOT、SHOULD、SHOULD NOT、MAY这种 RFC 风格词汇 - 每条核心要求都要可测试
- 规范性要求和建议性说明要分开
- 先写规则,再写示例
- 核心数据模型不能留下歧义
范围边界
这个目录定义的是规范和实现指导。 它不是生产代码目录。 生产代码必须遵循这里的规则,而不是重新定义这里的规则。
