API 参考

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

• KeyHoldError — 表示带稳定错误码和可选原因的 KeyHold 错误。
• Cipher — 表示经过验证的 AES-GCM 密文区段。
• CipherParameters — 定义 AES-GCM 导出所需的显式参数。
• Document — 表示完整、已验证的 KeyHold 文档。
• DocumentSummary — 表示文档的公开、非秘密摘要。
• EncryptedStateInput — 表示无需解密即可序列化的已加密状态。
• KeyDerivation — 表示经过验证的密码派生区段。
• KeyDerivationParameters — 定义 PBKDF2 导出所需的显式参数。
• PrivateKeyExportInput — 表示创建加密文档所需的明文私钥输入。
• RecommendedParameters — 返回推荐的显式导出参数。
• UnlockResult — 表示解锁后恢复的私钥和匹配公钥。
• ERROR_CODES — 列出 SDK 对外暴露的稳定错误码。
• FORMAT — 表示 KeyHold 文档格式标识。
• parse — 解析并验证 KeyHold 文档。
• RECOMMENDED_ITERATIONS — 表示新导出推荐使用的 PBKDF2 迭代次数。
• serialize — 将文档序列化为规范 JSON。
• unlock — 解密文档并校验恢复的私钥。
• validate — 验证 KeyHold 文档结构。
• VERSION — 表示支持的 KeyHold 文档版本。
• exportEncryptedState — 序列化已经加密的状态，无需解密私钥。
• exportPrivateKey — 使用密码加密私钥并返回完整 JSON 文档。
• isKeyHoldError — 判断一个值是否为 KeyHold SDK 错误。
• parseDocument — 解析 JSON 文本或 UTF-8 字节并验证文档。
• recommendedParameters — 返回 SDK 推荐的显式导出参数。
• serializeDocument — 将已验证文档序列化为规范 JSON。
• summary — 返回已验证文档的非秘密元数据。
• unlockDocument — 解密并验证文档中包含的私钥。
• validateDocument — 验证内存中的值并返回规范化文档。