API 参考

以下页面由 SDK 源码元数据和中文翻译目录生成。

Format — 表示文档格式标识。
Version — 表示支持的文档版本。
KDFAlgorithm — 表示密码派生算法。
PasswordEncoding — 表示密码编码方式。
CipherAlgorithm — 表示密码算法。
KeyLengthBits — 表示派生密钥长度。
OutputLengthBits — 表示派生输出长度。
TagLengthBits — 表示认证标签长度。
MinIterations — 表示 PBKDF2 最小迭代次数。
MaxIterations — 表示 PBKDF2 最大迭代次数。
RecommendedIterations — 表示推荐的 PBKDF2 迭代次数。
SaltLengthBytes — 表示盐值长度。
IVLengthBytes — 表示初始化向量长度。
PrivateKeyLengthBytes — 表示私钥长度。
PublicKeyLengthBytes — 表示公钥长度。
CiphertextAndTagLengthBytes — 表示密文和认证标签的总长度。
TagLengthBytes — 表示认证标签长度。
Serialize — 验证文档并编码为规范 JSON。
Summary — 返回已验证文档的非秘密元数据。
Unlock — 解密文档并确认恢复的私钥匹配公钥。
RecommendedParameters — 返回推荐的显式导出参数。
ExportEncryptedState — 序列化已经按 KeyHold 语义加密的状态。
ExportPrivateKey — 使用密码加密私钥并返回完整 JSON 文档。
KeyDerivation — 表示经过验证的密码派生区段。
Cipher — 表示经过验证的 AES-GCM 密文区段。
Document — 表示完整、已验证的 KeyHold 文档。
KeyDerivationParameters — 定义 PBKDF2 导出所需的显式参数。
CipherParameters — 定义 AES-GCM 导出所需的显式参数。
Parameters — 表示 Go SDK 导出所需的完整参数集。
EncryptedKDFInput — 表示已派生的文档 KDF 区段和原始盐。
EncryptedCipherInput — 表示已加密的文档 cipher 区段。
EncryptedStateInput — 表示无需解密即可序列化的已加密状态。
PrivateKeyExportInput — 表示创建加密文档所需的明文私钥输入。
UnlockResult — 表示解锁后恢复的私钥和匹配公钥。
DocumentSummary — 表示文档的公开、非秘密摘要。
EncodeBase64URL — 将字节编码为规范的无填充 base64url。
DecodeBase64URL — 解码规范的无填充 base64url 值。
EncodeHex — 将字节编码为小写十六进制。
DecodeHex — 解码小写十六进制值。
ErrorCode — 表示 KeyHold 失败的稳定分类。
ErrInvalidJSON — 表示 JSON 无效错误的稳定错误码。
ErrUnsupportedFormat — 表示文档格式不支持错误的稳定错误码。
ErrUnsupportedVersion — 表示文档版本不支持错误的稳定错误码。
ErrInvalidDocument — 表示文档无效错误的稳定错误码。
ErrInvalidParameter — 表示传入参数无效错误的稳定错误码。
ErrUnsupportedAlgorithm — 表示密码算法不支持错误的稳定错误码。
ErrInvalidPrivateKey — 表示私钥无效错误的稳定错误码。
ErrUnlockFailed — 表示解锁失败错误的稳定错误码。
KeyHoldError — 表示带稳定错误码和可选原因的 KeyHold 错误。
E — 构造带有可选底层原因的 KeyHoldError。
ErrorCodeOf — 从错误包装链中返回第一个 KeyHold 错误码。
PublicKeyFromPrivate — 从私钥派生压缩格式的 secp256k1 公钥。
ValidatePublicKeyHex — 验证并解码压缩格式的 secp256k1 公钥。
Validate — 检查文档结构和密码学公开字段。
Parse — 解析 JSON 字节并验证所得文档。