doubleratchet

type Crypto interface {
	//创建新的dh密钥对
	GenerateDH() (DHPair, error)

	//计算公共密钥
	DH(dhPair DHPair, dhPub dh.Key) dh.Key

	//使用消息密钥 mk加密内容
	Encrypt(mk dh.Key, plaintext, ad []byte) (authCiphertext []byte)

	// Decrypt returns the AEAD decryption of ciphertext with message key mk.
	//通过消息密钥mk解密内容
	Decrypt(mk dh.Key, ciphertext, ad []byte) (plaintext []byte, err error)

	KDFer
}

type DHPair interface {
	GetPrivateKey() dh.Key
	GetPublicKey() dh.Key
}

type DefaultCrypto struct{}

type InMemoryKey struct {
	// contains filtered or unexported fields
}

type KDFer interface {
	// KdfRK 返回一对密钥(根密钥key, 链密钥key)
	KdfRK(rk, dhOut dh.Key) (rootKey, chainKey, newHeaderKey dh.Key) //

	// KdfCK returns a pair (32-byte chain key, 32-byte message key) as the output of applying
	// a KDF keyed by a 32-byte chain key ck to some constant.
	//通过链密钥ck作为常量，作为kdf的密钥，返回一对密钥（链密钥，消息密钥）
	KdfCK(ck dh.Key) (chainKey, msgKey dh.Key)
}

type KeysStorage interface {
	// get按给定的键和消息编号返回消息键。
	Get(k dh.Key, msgNum uint) (mk dh.Key, ok bool, err error)

	// 将给定的mk保存在指定的键和msgnum下。
	Put(sessionID []byte, k dh.Key, msgNum uint, mk dh.Key, keySeqNum uint) error

	// DeleteMk ensures there's no message key under the specified key and msgNum.
	//deletemk确保在指定的密钥和msgnum下没有消息密钥。
	DeleteMk(k dh.Key, msgNum uint) error

	// DeleteOldMKeys deletes old message keys for a session.
	//deleteoldmkeys删除会话的旧消息键。
	DeleteOldMks(sessionID []byte, deleteUntilSeqKey uint) error

	// TruncateMks truncates the number of keys to maxKeys.
	//truncatemks将键数截断为maxkeys。
	TruncateMks(sessionID []byte, maxKeys int) error

	// Count returns number of message keys stored under the specified key.
	//count返回存储在指定密钥下的消息密钥数。
	Count(k dh.Key) (uint, error)

	// 全部返回所有键
	All() (map[dh.Key]map[uint]dh.Key, error)
}

type KeysStorageInMemory struct {
	// contains filtered or unexported fields
}

type Message struct {
	Header     MessageHeader `json:"header"`
	Ciphertext []byte        `json:"ciphertext"`
}

type MessageEncHeader []byte

type MessageHE struct {
	Header     []byte `json:"header"`
	Ciphertext []byte `json:"ciphertext"`
}

type MessageHeader struct {
	// DHR是发送方当前的棘轮公钥。
	DH dh.Key `json:"dh"`

	// n是发送链中消息的编号。
	N uint32 `json:"n"`

	// pn是上一个发送链的长度。
	PN uint32 `json:"pn"`
}

type Session interface {
	// RatchetEncrypt performs a symmetric-key ratchet step, then AEAD-encrypts the message with
	// the resulting message key.
	//Ratchetencrypt执行对称的密钥棘轮步骤，然后用AEAD-encrypts加密消息
	//返回消息键。
	RatchetEncrypt(plaintext, associatedData []byte) (Message, error)

	// 调用ratchetdecrypt来对消息进行AEAD解密。
	RatchetDecrypt(m Message, associatedData []byte) ([]byte, error)

	//DeleteMk 从数据库中删除消息密钥
	DeleteMk(dh.Key, uint32) error
}

type SessionHE interface {
	// RatchetEncrypt performs a symmetric-key ratchet step, then AEAD-encrypts
	// the header-encrypted message with the resulting message key.
	//Ratchetencrypt执行对称的密钥棘轮步骤，然后AEAD加密
	//头用结果消息密钥加密的消息。
	RatchetEncrypt(plaintext, associatedData []byte) MessageHE

	// RatchetDecrypt is called to AEAD-decrypt header-encrypted messages.
	RatchetDecrypt(m MessageHE, associatedData []byte) ([]byte, error)
}

type SessionStorage interface {
	// Save state keyed by id
	Save(id []byte, state *State) error

	// Load state by id
	Load(id []byte) (*State, error)
}

type State struct {
	Crypto Crypto

	// DH 棘轮公钥 (远端的 key).
	DHr dh.Key

	// DH 棘轮公司约对(自己的棘轮对 key).
	DHs DHPair

	// 对称棘轮根链。
	RootCh kdfRootChain

	// 对称棘轮发送和接收链。
	SendCh, RecvCh kdfChain

	// 发送链中上一个消息的编号
	PN uint32

	//跳过消息密钥的字典，由棘轮公钥或头键和消息编号编制索引。
	MkSkipped KeysStorage

	//单个链中可以跳过的最大消息键数。应该设置得足够高，以允许例程丢失或延迟消息，但是设置得足够低，以至于恶意发送者不能触发过多的收件人计算。
	MaxSkip uint

	//接收头部key和下一个头部key。仅用于头部加密
	HKr, NHKr dh.Key

	//发送头部key和下一个头部key，仅用于头部加密。
	HKs, NHKs dh.Key

	//保留消息键的时间，以接收的消息数计，例如，如果maxkeep为5，我们只保留最后5个消息键，删除所有n-5。
	MaxKeep uint

	// 每个会话的最大消息密钥数，旧密钥将以FIFO方式删除
	MaxMessageKeysPerSession int

	// 当前棘轮步进的编号。
	Step uint

	// KeysCount 已经生成的key数量
	KeysCount uint
}