Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

2.2 KB
Raw Blame
// SiYuan - https://github.com/siyuan-note/siyuan
// Copyright (c) 2020-present, b3log.org
// SPDX-License-Identifier: AGPL-3.0-or-later

package conf

import "github.com/siyuan-note/siyuan/kernel/util"

// NotebookCrypto 维护加密笔记本的全局密钥管理参数,随 conf.json 持久化。
// MasterSalt 与 KEKVerifier 设计为可明文存储:salt 不保密,verifier 本身是密文(用 KEK 加密的固定魔数)。
type NotebookCrypto struct {
	Enabled         bool              `json:"enabled"`         // 是否已启用加密笔记本功能
	MasterSalt      []byte            `json:"masterSalt"`      // 主密码 Argon2id 派生的 salt,全局唯一
	KDFParams       util.Argon2Params `json:"kdfParams"`       // Argon2id 参数,落盘以便跨平台一致派生
	KEKVerifier     []byte            `json:"kekVerifier"`     // 用 KEK 经 AES-GCM 加密的固定魔数,用于离线校验主密码
	VerifierNonce   []byte            `json:"verifierNonce"`   // verifier 的 GCM nonce(从加密信封中提取)
	AutoLockMinutes int               `json:"autoLockMinutes"` // 加密笔记本自动锁定闲置分钟数,0 表示禁用,默认 5

	// 当前备份的完整性字段。Checksum 防损坏,KEKMAC 需主密码验证。
	Spec      int    `json:"spec"`                // 当前备份规范标识(见 CurrentNotebookCryptoSpec)
	BackupID  string `json:"backupID,omitempty"`  // 备份唯一标识(UUID)
	CreatedAt int64  `json:"createdAt,omitempty"` // 备份创建/更新时间(unix 秒)
	Checksum  string `json:"checksum,omitempty"`  // SHA-256 校验和
	KEKMAC    []byte `json:"kekMAC,omitempty"`    // KEK HMAC-SHA256(需主密码验证)

	// 历次 KEK 由当前 KEK 认证加密,用于恢复本机、其他设备或离线快照中尚未重新包络的笔记本。
	HistoryKEKs [][]byte `json:"historyKEKs,omitempty"`
}

// NewNotebookCrypto 创建带默认 Argon2id 参数的 NotebookCrypto。
func NewNotebookCrypto() *NotebookCrypto {
	return &NotebookCrypto{
		KDFParams:       util.DefaultArgon2Params(),
		AutoLockMinutes: 5,
		Spec:            CurrentNotebookCryptoSpec,
	}
}

// CurrentNotebookCryptoSpec 是当前备份规范版本号。
const CurrentNotebookCryptoSpec = 1