codec

type Authentication struct {
	HMAC hash.Hash // 消息认证使用的 HMAC。
	// contains filtered or unexported fields
}

type Compression struct {
	CompressionStream method.CompressionStream // 压缩算法适配器。
}

type Decoder struct {
	MsgCreator          gtp.IMsgCreator // 用于构造消息体的消息构建器。
	Encryption          IEncryption     // 可选的解密模块。
	Authentication      IAuthentication // 可选的消息认证模块。
	Compression         ICompression    // 可选的解压模块。
	MaxUncompressedSize int             // 解压后负载的字节上限，用于防御压缩炸弹。
	MaxPacketSize       int             // 完整消息包的字节上限；小于等于零时不限制。
}

type Encoder struct {
	Encryption           IEncryption     // 可选的加密模块。
	Authentication       IAuthentication // 可选的消息认证模块；仅在启用加密时使用。
	Compression          ICompression    // 可选的压缩模块。
	CompressionThreshold int             // 启用压缩的字节阈值；小于等于零时禁用压缩。
}

type Encryption struct {
	Cipher     method.Cipher  // 加密或解密变换。
	Padding    method.Padding // 密码要求时使用的填充方案。
	FetchNonce FetchNonce     // 密码要求时为每次变换提供 nonce。
}

type FetchNonce = generic.FuncPair0[[]byte, error]

type IAuthentication interface {
	// Sign 包装消息体和认证码；返回的池化缓冲区由调用方释放。
	Sign(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (signedBuf binaryutil.Bytes, err error)
	// Auth 验证认证码并返回包装中的原始消息体。
	Auth(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (authBuf []byte, err error)
	// SizeOfAddition 返回认证包装相对原消息体增加的字节数。
	SizeOfAddition(msgLen int) (size int, err error)
}

type ICompression interface {
	// Compress 仅在编码结果更小时返回压缩数据；池化结果由调用方释放。
	Compress(src []byte) (compressedBuf binaryutil.Bytes, compressed bool, err error)
	// Uncompress 在 max 字节上限内还原数据；池化结果由调用方释放。
	Uncompress(src []byte, max int) (uncompressedBuf binaryutil.Bytes, err error)
}

type IEncryption interface {
	// Transforming 将 src 变换到 dst 或新池化缓冲区；结果由调用方释放。
	Transforming(dst, src []byte) (transformedBuf binaryutil.Bytes, err error)
	// SizeOfAddition 返回变换结果相对输入可能增加的字节数。
	SizeOfAddition(msgLen int) (size int, err error)
}

type IValidation interface {
	// Validate 校验原始消息包；返回错误会中止解码。
	Validate(msgHead gtp.MsgHead, msgBuf []byte) error
}