diff --git a/zh-cn/native_sdk/security/huks/include/native_huks_api.h b/zh-cn/native_sdk/security/huks/include/native_huks_api.h
index 526327d33c74a8da3d84d2c8f6a951c97ba5305f..78fc5663c8754f9eb6d9ef4113b8491849c05d99 100644
--- a/zh-cn/native_sdk/security/huks/include/native_huks_api.h
+++ b/zh-cn/native_sdk/security/huks/include/native_huks_api.h
@@ -51,8 +51,8 @@ extern "C" {
* @brief 获取当前Huks sdk版本号。
*
* @param sdkVersion 用于存放获取到的版本信息（字符串格式）。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：sdkVersion或者sdkVersion->data是null，或者sdkVersion->size太小。
* @since 9
* @version 1.0
@@ -65,19 +65,19 @@ struct OH_Huks_Result OH_Huks_GetSdkVersion(struct OH_Huks_Blob *sdkVersion);
* @param keyAlias 给要生成的密钥的别名，需要保证业务所在进程内唯一，否则会发生覆盖。
* @param paramSetIn 生成密钥的属性信息的参数集。
* @param paramSetOut 生成密钥为临时类型时，存放着密钥数据；非临时类型可为空。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSetIn、paramSetOut有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：基础密钥文件不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
- * OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015 ：连接用户IAM失败。
- * OH_HUKS_ERR_CODE_DEVICE_PASSWORD_UNSET = 12000016 ：需要设备密码但没有设置。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSetIn、paramSetOut有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：基础密钥文件不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
+ * OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015 ：连接用户IAM失败。\n
+ * OH_HUKS_ERR_CODE_DEVICE_PASSWORD_UNSET = 12000016 ：需要设备密码但没有设置。\n
* OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
* @since 9
* @version 1.0
@@ -91,16 +91,16 @@ struct OH_Huks_Result OH_Huks_GenerateKeyItem(const struct OH_Huks_Blob *keyAlia
* @param keyAlias 待导入密钥的别名，需要保证业务所在进程内唯一，否则会发生覆盖。
* @param paramSet 待导入密钥的属性参数。
* @param key 待导入密钥数据，需符合Huks的格式要求，具体见{@link HuksTypeApi}。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet、key有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
- * OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015 ：连接用户IAM失败。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet、key有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
+ * OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015 ：连接用户IAM失败。\n
* OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
* @since 9
* @version 1.0
@@ -115,17 +115,17 @@ struct OH_Huks_Result OH_Huks_ImportKeyItem(const struct OH_Huks_Blob *keyAlias,
* @param wrappingKeyAlias 密钥别名，该对应密钥用于密钥协商出密钥解密待导入密钥。
* @param paramSet 待导入加密密钥的属性参数。
* @param wrappedKeyData 需要导入的加密的密钥数据，需要符合Huks定义的格式，具体见{@link OH_Huks_AlgSuite}。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、wrappingKeyAlias、paramSet、wrappedKeyData有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
- * OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015 ：连接用户IAM失败。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、wrappingKeyAlias、paramSet、wrappedKeyData有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
+ * OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015 ：连接用户IAM失败。\n
* OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
* @since 9
* @version 1.0
@@ -140,15 +140,15 @@ struct OH_Huks_Result OH_Huks_ImportWrappedKeyItem(const struct OH_Huks_Blob *ke
* @param keyAlias 待导出公钥的密钥别名，应与所用密钥生成时使用的别名相同。
* @param paramSet 导出公钥需要的属性参数。
* @param key 存放导出的公钥。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet、key有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet、key有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
* OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
* @since 9
* @version 1.0
@@ -160,15 +160,15 @@ struct OH_Huks_Result OH_Huks_ExportPublicKeyItem(const struct OH_Huks_Blob *key
* @brief 删除密钥。
*
* @param keyAlias 待删除密钥的别名，应与密钥生成时使用的别名相同。
- * @param paramSet 删除密钥需要属性参数（默认传空）。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
+ * @param paramSet 删除密钥需要属性参数（默认传空）。若不指定则默认要删除的密钥存储等级为{@link OH_HUKS_AUTH_STORAGE_LEVEL_CE}。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
* OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
* @since 9
* @version 1.0
@@ -182,15 +182,15 @@ struct OH_Huks_Result OH_Huks_DeleteKeyItem(const struct OH_Huks_Blob *keyAlias,
* @param keyAlias 要获取参数集的密钥别名。
* @param paramSetIn 要获取参数集需要的属性TAG（默认传空）。
* @param paramSetOut 获取到的输出参数集。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSetIn、paramSetOut有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSetIn、paramSetOut有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
* OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
* @since 9
* @version 1.0
@@ -203,14 +203,14 @@ struct OH_Huks_Result OH_Huks_GetKeyItemParamSet(const struct OH_Huks_Blob *keyA
*
* @param keyAlias 要查找的密钥的别名。
* @param paramSet 查询密钥需要的属性TAG（默认传空）。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
* OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
* @since 9
* @version 1.0
@@ -219,23 +219,23 @@ struct OH_Huks_Result OH_Huks_IsKeyItemExist(const struct OH_Huks_Blob *keyAlias
const struct OH_Huks_ParamSet *paramSet);
/**
- * @brief 获取密钥证书链。这个API只能由系统应用调用。
+ * @brief 获取密钥证书链。该API仅面向系统应用开放。
*
- * @permission ohos.permission.ATTEST_KEY
+ * @permission ohos.permission.ATTEST_KEY，该权限仅系统应用可申请。
* @param keyAlias 要获取证书的密钥的别名。
* @param paramSet 获取密钥证书需要的参数。
* @param certChain 存放输出的密钥证书链。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet、certChain有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
- * OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet、certChain有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
+ * OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。\n
* OH_HUKS_ERR_CODE_PERMISSION_FAIL = 201 ：权限检查失败，请先申请请求权限。
* @since 9
* @version 1.0
@@ -244,26 +244,26 @@ struct OH_Huks_Result OH_Huks_AttestKeyItem(const struct OH_Huks_Blob *keyAlias,
const struct OH_Huks_ParamSet *paramSet, struct OH_Huks_CertChain *certChain);
/**
- * @brief 获取密钥证书链。
+ * @brief 获取密钥证书链。\n
+ * 这是一个涉及网络的耗时接口，调用方可以通过异步线程获取证书链。
*
* @param keyAlias 要获取证书的密钥的别名。
* @param paramSet 获取密钥证书需要的参数。
* @param certChain 存放输出的密钥证书链。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet、certChain有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
- * OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数keyAlias、paramSet、certChain有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
+ * OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。\n
* OH_HUKS_ERR_CODE_PERMISSION_FAIL = 201 ：权限检查失败，请先申请请求权限。
* @since 11
* @version 1.0
- * @note 这是一个涉及网络的耗时接口，调用方可以通过异步线程获取证书链。
*/
struct OH_Huks_Result OH_Huks_AnonAttestKeyItem(const struct OH_Huks_Blob *keyAlias,
const struct OH_Huks_ParamSet *paramSet, struct OH_Huks_CertChain *certChain);
@@ -276,17 +276,17 @@ struct OH_Huks_Result OH_Huks_AnonAttestKeyItem(const struct OH_Huks_Blob *keyAl
* @param handle 密钥会话的句柄，后续其他操作时传入该句柄，包括{@link OH_Huks_UpdateSession}，
* {@link OH_Huks_FinishSession}，{@link OH_Huks_AbortSession}。
* @param token 存放安全访问控制时传回的token。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数 keyAlias、paramSet、handle、token有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_SESSION_LIMIT = 12000010 ：已达最大会话限制。
- * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数 keyAlias、paramSet、handle、token有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_SESSION_LIMIT = 12000010 ：已达最大会话限制。\n
+ * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
* OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
* @since 9
* @version 1.0
@@ -300,25 +300,25 @@ struct OH_Huks_Result OH_Huks_InitSession(const struct OH_Huks_Blob *keyAlias,
/**
* @brief 分段添加密钥操作的数据并进行相应的密钥操作，输出处理数据。
*
- * @param handle 密钥会话句柄，通过{@link OH_Huks_InitSession}接口生成的。
+ * @param handle 密钥会话句柄，通过{@link OH_Huks_InitSession}接口生成。
* @param paramSet 密钥操作对应的输入参数集。
* @param inData 要处理的输入数据，如果数据过大，可分片多次调用。
* @param outData 经过对应的密钥操作后输出的数据。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数handle、paramSet、inData、outData有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在，或handle不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST = 12000013 ：证书不存在。
- * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。
- * OH_HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED = 12000008 ：认证令牌校验失败。
- * OH_HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED = 12000007 ：认证令牌信息校验失败。
- * OH_HUKS_ERR_CODE_KEY_AUTH_TIME_OUT = 12000009 ：认证令牌超时。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
- * OH_HUKS_ERR_CODE_DEVICE_PASSWORD_UNSET = 12000016 ：需要设备密码但没有设置。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数handle、paramSet、inData、outData有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在，或handle不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST = 12000013 ：证书不存在。\n
+ * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。\n
+ * OH_HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED = 12000008 ：认证令牌校验失败。\n
+ * OH_HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED = 12000007 ：认证令牌信息校验失败。\n
+ * OH_HUKS_ERR_CODE_KEY_AUTH_TIME_OUT = 12000009 ：认证令牌超时。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
+ * OH_HUKS_ERR_CODE_DEVICE_PASSWORD_UNSET = 12000016 ：需要设备密码但没有设置。\n
* OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
* @since 9
* @version 1.0
@@ -332,25 +332,25 @@ struct OH_Huks_Result OH_Huks_UpdateSession(const struct OH_Huks_Blob *handle,
/**
* @brief 结束密钥会话并进行相应的密钥操作，输出处理数据。
*
- * @param handle 密钥会话句柄，通过{@link OH_Huks_InitSession}接口生成的。
+ * @param handle 密钥会话句柄，通过{@link OH_Huks_InitSession}接口生成。
* @param paramSet 密钥操作对应的输入参数集。
* @param inData 要处理的输入数据。
* @param outData 经过对应的密钥操作后输出的数据。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数handle、paramSet、inData、outData有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在，或handle不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST = 12000013 ：证书不存在。
- * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。
- * OH_HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED = 12000008 ：认证令牌校验失败。
- * OH_HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED = 12000007 ：认证令牌信息校验失败。
- * OH_HUKS_ERR_CODE_KEY_AUTH_TIME_OUT = 12000009 ：认证令牌超时。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
- * OH_HUKS_ERR_CODE_DEVICE_PASSWORD_UNSET = 12000016 ：需要设备密码但没有设置。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数handle、paramSet、inData、outData有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在，或handle不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST = 12000013 ：证书不存在。\n
+ * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。\n
+ * OH_HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED = 12000008 ：认证令牌校验失败。\n
+ * OH_HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED = 12000007 ：认证令牌信息校验失败。\n
+ * OH_HUKS_ERR_CODE_KEY_AUTH_TIME_OUT = 12000009 ：认证令牌超时。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
+ * OH_HUKS_ERR_CODE_DEVICE_PASSWORD_UNSET = 12000016 ：需要设备密码但没有设置。\n
* OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001 ：暂不支持该功能。
* @since 9
* @version 1.0
@@ -364,17 +364,17 @@ struct OH_Huks_Result OH_Huks_FinishSession(const struct OH_Huks_Blob *handle,
/**
* @brief 取消密钥会话。
*
- * @param handle 密钥会话句柄，通过{@link OH_Huks_InitSession}接口生成的。
+ * @param handle 密钥会话句柄，通过{@link OH_Huks_InitSession}接口生成。
* @param paramSet 取消密钥会话需要的输入参数集（默认传空）。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数handle、paramSet、inData、outData有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在，或handle不存在。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST = 12000013 ：证书不存在。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数handle、paramSet、inData、outData有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011 ：密钥文件不存在，或handle不存在。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST = 12000013 ：证书不存在。\n
* OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
* @since 9
* @version 1.0
@@ -390,11 +390,11 @@ struct OH_Huks_Result OH_Huks_AbortSession(const struct OH_Huks_Blob *handle,
*
* @param paramSet 获取密钥别名集需要的输入参数集（默认传空）。
* @param outData 经过对应的密钥操作后输出的数据。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数paramSet、outData有一个无效。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数paramSet、outData有一个无效。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
* OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
* @since 20
*/
@@ -407,16 +407,16 @@ struct OH_Huks_Result OH_Huks_ListAliases(const struct OH_Huks_ParamSet *paramSe
* @param keyAlias 表示要导出的密钥别名。
* @param paramSet 表示加密导出密钥的参数集。
* @param wrappedKey 表示要导出的封装好的密钥。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_NOT_SUPPORTED_API = 801 ：接口不支持。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_NOT_SUPPORTED_API = 801 ：接口不支持。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
* OH_HUKS_ERR_CODE_INVALID_ARGUMENT = 12000018 ：密钥别名、参数集或者封装密钥不合法。
* @since 20
*/
@@ -430,20 +430,20 @@ struct OH_Huks_Result OH_Huks_WrapKey(const struct OH_Huks_Blob *keyAlias, const
* 在服务进程中，别名必须唯一。否则，密钥将被覆盖。
* @param paramSet 表示加密导入密钥的参数集。
* @param wrappedKey 表示要导入的封装好的密钥。
- * @return {@link OH_Huks_ErrCode}：
- * OH_HUKS_SUCCESS = 0 ：操作成功。
- * OH_HUKS_ERR_CODE_NOT_SUPPORTED_API = 801 ：接口不支持。
- * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。
- * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。
- * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。
- * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。
- * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。
- * OH_HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED = 12000007 ：认证令牌信息校验失败。
- * OH_HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED = 12000008 ：认证令牌校验失败。
- * OH_HUKS_ERR_CODE_KEY_AUTH_TIME_OUT = 12000009 ：认证令牌超时。
- * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。
- * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
- * OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015 ：连接用户IAM失败。
+ * @return 可能的返回码（errorCode）：\n
+ * OH_HUKS_SUCCESS = 0 ：操作成功。\n
+ * OH_HUKS_ERR_CODE_NOT_SUPPORTED_API = 801 ：接口不支持。\n
+ * OH_HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002 ：获取密钥参数失败。\n
+ * OH_HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003 ：密钥参数无效。\n
+ * OH_HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004 ：删除或者写文件失败。\n
+ * OH_HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005 ：IPC通信失败。\n
+ * OH_HUKS_ERR_CODE_CRYPTO_FAIL = 12000006 ：加密引擎失败。\n
+ * OH_HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED = 12000007 ：认证令牌信息校验失败。\n
+ * OH_HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED = 12000008 ：认证令牌校验失败。\n
+ * OH_HUKS_ERR_CODE_KEY_AUTH_TIME_OUT = 12000009 ：认证令牌超时。\n
+ * OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012 ：发生系统错误。\n
+ * OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。\n
+ * OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015 ：连接用户IAM失败。\n
* OH_HUKS_ERR_CODE_INVALID_ARGUMENT = 12000018 ：密钥别名、参数集或者封装密钥不合法。
* @since 20
*/
diff --git a/zh-cn/native_sdk/security/huks/include/native_huks_param.h b/zh-cn/native_sdk/security/huks/include/native_huks_param.h
index 86a9f1f451d31420218b915e118c25737fb6686e..79c037c4eb46ab8b76212d079fc3798940035684 100644
--- a/zh-cn/native_sdk/security/huks/include/native_huks_param.h
+++ b/zh-cn/native_sdk/security/huks/include/native_huks_param.h
@@ -17,8 +17,7 @@
* @addtogroup HuksParamSetApi
* @{
*
- * @brief HUKS参数集支持密钥管理接口的使用，包括初始化参数集、添加参数、构造参数集、释放参数集等生命周期管理函数，还包括获取参数、
- * 复制参数集、查询参数集、检查有效性等函数。
+ * @brief HUKS参数集支持密钥管理接口的使用，包括初始化参数集、添加参数、构造参数集、释放参数集等生命周期管理函数， 还包括获取参数、复制参数集、查询参数集、检查有效性等函数。
*
* @syscap SystemCapability.Security.Huks
* @since 9
@@ -52,7 +51,7 @@ extern "C" {
* @brief 初始化参数集。
*
* @param paramSet 指向要初始化的参数集的指针地址。
- * @return {@link OH_Huks_ErrCode}：
+ * @return 可能的返回码（errorCode）：
* OH_HUKS_SUCCESS = 0 ：初始化操作成功。
* OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数paramSet为null。
@@ -68,7 +67,7 @@ struct OH_Huks_Result OH_Huks_InitParamSet(struct OH_Huks_ParamSet **paramSet);
* @param paramSet 指向要被添加参数的参数集的指针。
* @param params 指向要添加的参数数组的指针。
* @param paramCnt 待添加参数数组的参数个数。
- * @return {@link OH_Huks_ErrCode}：
+ * @return 可能的返回码（errorCode）：
* OH_HUKS_SUCCESS = 0 ：操作成功。
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：params为null或者paramSet无效。
* @since 9
@@ -81,7 +80,7 @@ struct OH_Huks_Result OH_Huks_AddParams(struct OH_Huks_ParamSet *paramSet,
* @brief 构造正式的参数集。
*
* @param paramSet 指向要被正式构造的参数集的指针地址。
- * @return {@link OH_Huks_ErrCode}：
+ * @return 可能的返回码（errorCode）：
* OH_HUKS_SUCCESS = 0 ：操作成功。
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数paramSet无效。
* OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
@@ -105,7 +104,7 @@ void OH_Huks_FreeParamSet(struct OH_Huks_ParamSet **paramSet);
* @param fromParamSet 指向要被复制的参数集的指针。
* @param fromParamSetSize 被复制的参数集占用内存的大小。
* @param paramSet 指向生成新的参数集的指针地址。
- * @return {@link OH_Huks_ErrCode}：
+ * @return 可能的返回码（errorCode）：
* OH_HUKS_SUCCESS = 0 ：操作成功。
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数fromParamSet、fromParamSetSize、paramSet有一个无效。
* OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
@@ -121,7 +120,7 @@ struct OH_Huks_Result OH_Huks_CopyParamSet(const struct OH_Huks_ParamSet *fromPa
* @param paramSet 指向参数集的指针。
* @param tag 要获取的对应参数的值。
* @param param 指向获取到的参数的指针地址。
- * @return {@link OH_Huks_ErrCode}：
+ * @return 可能的返回码（errorCode）：
* OH_HUKS_SUCCESS = 0 ：操作成功。
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数paramSet或者param无效，或者参数param不在paramSet里面。
* @since 9
@@ -131,11 +130,11 @@ struct OH_Huks_Result OH_Huks_GetParam(const struct OH_Huks_ParamSet *paramSet,
struct OH_Huks_Param **param);
/**
- * @brief 刷新参数集内OH_Huks_Blob类型的数据。
+ * @brief 刷新参数集内{@link OH_Huks_Blob}类型的数据。
*
* @param paramSet 指向参数集的指针。
- * @param isCopy 如果为true，刷新OH_Huks_Blob类型数据的地址并复制到参数集。否则，只会刷新OH_Huks_Blob类型数据的地址。
- * @return {@link OH_Huks_ErrCode}：
+ * @param isCopy 如果为true，刷新{@link OH_Huks_Blob}类型数据的地址并复制到参数集。否则，只会刷新{@link OH_Huks_Blob}类型数据的地址。
+ * @return 可能的返回码（errorCode）：
* OH_HUKS_SUCCESS = 0 ：操作成功。
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数paramSet无效。
* OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014 ：内存不足。
@@ -148,7 +147,7 @@ struct OH_Huks_Result OH_Huks_FreshParamSet(struct OH_Huks_ParamSet *paramSet, b
* @brief 检查参数集中的参数是否有效、是否有重复。
*
* @param paramSet 指向参数集的指针。
- * @return {@link OH_Huks_ErrCode}：
+ * @return 可能的返回码（errorCode）：
* OH_HUKS_SUCCESS = 0 ：paramSet中的参数都有效。
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数paramSet无效或者参数集中有无效、重复、不正确的标签。
* @since 9
@@ -161,7 +160,7 @@ struct OH_Huks_Result OH_Huks_IsParamSetTagValid(const struct OH_Huks_ParamSet *
*
* @param paramSet 指向参数集的指针。
* @param size 参数集占用的内存大小。
- * @return {@link OH_Huks_ErrCode}：
+ * @return 可能的返回码（errorCode）：
* OH_HUKS_SUCCESS = 0 ：参数集大小合法。
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：参数paramSet无效。
* @since 9
@@ -170,11 +169,11 @@ struct OH_Huks_Result OH_Huks_IsParamSetTagValid(const struct OH_Huks_ParamSet *
struct OH_Huks_Result OH_Huks_IsParamSetValid(const struct OH_Huks_ParamSet *paramSet, uint32_t size);
/**
- * @brief 比较两个参数是否相同
+ * @brief 比较两个参数是否相同。
*
* @param baseParam 指向被比较的参数的指针。
* @param param 指向比较的参数的指针。
- * @return {@link OH_Huks_ErrCode}：
+ * @return 可能的返回码（errorCode）：
* OH_HUKS_SUCCESS = 0 ：比较的两个参数相同。
* OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401 ：其中一个参数集是无效的，或者参数不匹配，
或者内部有无效标签。
@@ -187,7 +186,7 @@ struct OH_Huks_Result OH_Huks_CheckParamMatch(const struct OH_Huks_Param *basePa
* @brief 销毁参数集。
*
* @param keyAliasSet 指向要被销毁的参数集的指针地址。
- * @since 12
+ * @since 20
* @version 1.0
*/
void OH_Huks_FreeKeyAliasSet(struct OH_Huks_KeyAliasSet *keyAliasSet);
diff --git a/zh-cn/native_sdk/security/huks/include/native_huks_type.h b/zh-cn/native_sdk/security/huks/include/native_huks_type.h
index 88b800a7afba57e9e1db076b5ab4e97cbe48bcb8..464fa297e5e722b3bb8be117da1569bbd78ce733 100644
--- a/zh-cn/native_sdk/security/huks/include/native_huks_type.h
+++ b/zh-cn/native_sdk/security/huks/include/native_huks_type.h
@@ -137,11 +137,11 @@ enum OH_Huks_KeyPadding {
OH_HUKS_PADDING_PKCS5 = 4,
/** 使用PKCS7补齐算法。 */
OH_HUKS_PADDING_PKCS7 = 5,
- /** 使用ISO IEC 9796-2补齐算法
+ /** @brief 使用ISO IEC 9796-2补齐算法。
* @since 18
*/
OH_HUKS_PADDING_ISO_IEC_9796_2 = 6,
- /** 使用ISO IEC 9797-1补齐算法
+ /** @brief 使用ISO IEC 9797-1补齐算法。
* @since 18
*/
OH_HUKS_PADDING_ISO_IEC_9797_1 = 7,
@@ -163,7 +163,7 @@ enum OH_Huks_CipherMode {
/** 使用OFB加密模式。 */
OH_HUKS_MODE_OFB = 4,
/**
- * 使用CFB加密模式。
+ * @brief 使用CFB加密模式。
* @since 12
*/
OH_HUKS_MODE_CFB = 5,
@@ -226,15 +226,15 @@ enum OH_Huks_KeySize {
/** 使用SM4算法支持的密钥长度为128位。 */
OH_HUKS_SM4_KEY_SIZE_128 = 128,
- /** 使用DES算法的密钥长度为64bit。
+ /** @brief 使用DES算法的密钥长度为64bit。
* @since 18
*/
OH_HUKS_DES_KEY_SIZE_64 = 64,
- /** 使用3DES算法的密钥长度为128bit。
+ /** @brief 使用3DES算法的密钥长度为128bit。
* @since 18
*/
OH_HUKS_3DES_KEY_SIZE_128 = 128,
- /** 使用3DES算法的密钥长度为192bit。
+ /** @brief 使用3DES算法的密钥长度为192bit。
* @since 18
*/
OH_HUKS_3DES_KEY_SIZE_192 = 192,
@@ -279,41 +279,41 @@ enum OH_Huks_KeyAlg {
/** 使用SM4算法。*/
OH_HUKS_ALG_SM4 = 152,
- /** 使用DES算法。
+ /** @brief 使用DES算法。
* @since 18
*/
OH_HUKS_ALG_DES = 160,
- /** 使用3DES算法。
+ /** @brief 使用3DES算法。
* @since 18
*/
OH_HUKS_ALG_3DES = 161,
- /** 使用CMAC算法。
+ /** @brief 使用CMAC算法。
* @since 18
*/
OH_HUKS_ALG_CMAC = 162,
};
/**
- * @brief 密文导入所需的算法套件类型
+ * @brief 密文导入所需的算法套件类型。
*
* @since 9
* @version 1.0
*/
enum OH_Huks_AlgSuite {
- /** 密文导入密钥材料格式(Length-Value格式）采用X25519密钥协商同时采用AES-256-GCM加解密:
- * | x25519_plain_pubkey_length (4 Byte) | x25519_plain_pubkey | agreekey_aad_length (4 Byte) | agreekey_aad
- * | agreekey_nonce_length (4 Byte) | agreekey_nonce | agreekey_aead_tag_len(4 Byte) | agreekey_aead_tag
- * | kek_enc_data_length (4 Byte) | kek_enc_data | kek_aad_length (4 Byte) | kek_aad
- * | kek_nonce_length (4 Byte) | kek_nonce | kek_aead_tag_len (4 Byte) | kek_aead_tag
+ /** 密文导入密钥材料格式（Length-Value格式）采用X25519密钥协商同时采用AES-256-GCM加解密：\n
+ * | x25519_plain_pubkey_length (4 Byte) | x25519_plain_pubkey | agreekey_aad_length (4 Byte) | agreekey_aad
+ * | agreekey_nonce_length (4 Byte) | agreekey_nonce | agreekey_aead_tag_len(4 Byte) | agreekey_aead_tag
+ * | kek_enc_data_length (4 Byte) | kek_enc_data | kek_aad_length (4 Byte) | kek_aad
+ * | kek_nonce_length (4 Byte) | kek_nonce | kek_aead_tag_len (4 Byte) | kek_aead_tag
* | key_material_size_len (4 Byte) | key_material_size | key_mat_enc_length (4 Byte) | key_mat_enc_data
*/
OH_HUKS_UNWRAP_SUITE_X25519_AES_256_GCM_NOPADDING = 1,
- /** 密文导入密钥材料格式(Length-Value格式）采用ECDH-p256密钥协商同时采用AES-256-GCM加解密:
+ /** 密文导入密钥材料格式（Length-Value格式）采用ECDH-p256密钥协商同时采用AES-256-GCM加解密：\n
* | ECC_plain_pubkey_length (4 Byte) | ECC_plain_pubkey | agreekey_aad_length (4 Byte) | agreekey_aad
* | agreekey_nonce_length (4 Byte) | agreekey_nonce | agreekey_aead_tag_len(4 Byte) | agreekey_aead_tag
- * | kek_enc_data_length (4 Byte) | kek_enc_data | kek_aad_length (4 Byte) | kek_aad
- * | kek_nonce_length (4 Byte) | kek_nonce | kek_aead_tag_len (4 Byte) | kek_aead_tag
+ * | kek_enc_data_length (4 Byte) | kek_enc_data | kek_aad_length (4 Byte) | kek_aad
+ * | kek_nonce_length (4 Byte) | kek_nonce | kek_aead_tag_len (4 Byte) | kek_aead_tag
* | key_material_size_len (4 Byte) | key_material_size | key_mat_enc_length (4 Byte) | key_mat_enc_data
*/
OH_HUKS_UNWRAP_SUITE_ECDH_AES_256_GCM_NOPADDING = 2,
@@ -358,13 +358,13 @@ enum OH_Huks_KeyFlag {
* @version 1.0
*/
enum OH_Huks_KeyStorageType {
- /** 通过本地直接管理密钥。*/
+ /** 通过接口返回给业务。*/
OH_HUKS_STORAGE_TEMP = 0,
- /** 通过HUKS service管理密钥。*/
+ /** 密钥托管在HUKS中。 */
OH_HUKS_STORAGE_PERSISTENT = 1,
- /** 密钥只存储在huks中。 */
+ /** 在进行密钥派生或协商时，结果密钥托管在HUKS中。 */
OH_HUKS_STORAGE_ONLY_USED_IN_HUKS = 2,
- /** 密钥从huks中导出，不存储。 */
+ /** 在进行密钥派生或协商时，结果密钥可以返回给业务。 */
OH_HUKS_STORAGE_KEY_EXPORT_ALLOWED = 3,
};
@@ -384,7 +384,7 @@ enum OH_Huks_ImportKeyType {
};
/**
- * @brief 枚举密钥存储格式
+ * @brief 枚举密钥存储格式。
*
* @since 10
* @version 1.0
@@ -443,13 +443,13 @@ enum OH_Huks_ErrCode {
/** 调用服务失败。 */
OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015,
/**
- * 需要锁屏密码，但没有设置。
+ * @brief 需要锁屏密码，但没有设置。
*
* @since 11
*/
OH_HUKS_ERR_CODE_DEVICE_PASSWORD_UNSET = 12000016,
/**
- * 输入的参数是无效的。
+ * @brief 输入的参数无效。
*
* @since 20
*/
@@ -474,12 +474,12 @@ enum OH_Huks_TagType {
OH_HUKS_TAG_TYPE_ULONG = 3 << 28,
/** 该Tag的数据类型为bool类型。 */
OH_HUKS_TAG_TYPE_BOOL = 4 << 28,
- /** 该Tag的数据类型为OH_Huks_Blob类型。 */
+ /** 该Tag的数据类型为{@link OH_Huks_Blob}类型。 */
OH_HUKS_TAG_TYPE_BYTES = 5 << 28,
};
/**
- * @brief 密钥访问控制中的用户认证类型
+ * @brief 密钥访问控制中的用户认证类型。
*
* @since 9
* @version 1.0
@@ -498,7 +498,7 @@ enum OH_Huks_UserAuthType {
};
/**
- * @brief 安全访问控制类型，表示密钥失效的原则
+ * @brief 安全访问控制类型，表示密钥失效的原则。
*
* @since 9
* @version 1.0
@@ -509,7 +509,7 @@ enum OH_Huks_AuthAccessType {
/** 安全访问控制类型为新录入生物特征后密钥无效。 */
OH_HUKS_AUTH_ACCESS_INVALID_NEW_BIO_ENROLL = 1 << 1,
/**
- * 安全访问控制类型为该密钥总是有效。
+ * @brief 安全访问控制类型为该密钥总是有效。
*
* @since 11
*/
@@ -524,23 +524,20 @@ enum OH_Huks_AuthAccessType {
enum OH_Huks_AuthStorageLevel {
/**
* 表示密钥仅在开机后可访问。
- * @since 11
*/
OH_HUKS_AUTH_STORAGE_LEVEL_DE = 0,
/**
* 表示密钥仅在首次解锁后可访问。
- * @since 11
*/
OH_HUKS_AUTH_STORAGE_LEVEL_CE = 1,
/**
* 表示密钥仅在解锁状态时可访问。
- * @since 11
*/
OH_HUKS_AUTH_STORAGE_LEVEL_ECE = 2,
};
/**
- * @brief 密钥使用时生成challenge的类型
+ * @brief 密钥使用时生成challenge的类型。
* @see OH_Huks_ChallengePosition
*
* @since 9
@@ -597,7 +594,7 @@ enum OH_Huks_SecureSignType {
};
/**
- * @brief 密钥封装类型。
+ * @brief 生成或导入密钥时，指定该密钥的封装类型。
*
* @since 20
* @version 1.0
@@ -608,13 +605,19 @@ enum OH_Huks_KeyWrapType {
};
/**
- * @brief 参数集所用的TAG值枚举
+ * @brief 参数集所用的TAG值枚举。\n
+ * 1-200：密钥参数标签值。\n
+ * 301-500：密钥使用访问控制和使用认证相关的标签值。\n
+ * 501-600：密钥认证相关的标签值。\n
+ * 601-1000：其他类型的标签值预留值。\n
+ * 1001-9999：扩展标签值。\n
+ * 11000-12000：预留值。\n
+ * 20001-N：其他标签预留值。
*
* @since 9
* @version 1.0
*/
enum OH_Huks_Tag {
- /** 密钥参数标签值：从1到200。 */
/** 算法类型。 */
OH_HUKS_TAG_ALGORITHM = OH_HUKS_TAG_TYPE_UINT | 1,
/** 密钥用途。 */
@@ -657,7 +660,7 @@ enum OH_Huks_Tag {
OH_HUKS_TAG_KEY_ALIAS = OH_HUKS_TAG_TYPE_BYTES | 23,
/** 派生密钥大小。 */
OH_HUKS_TAG_DERIVE_KEY_SIZE = OH_HUKS_TAG_TYPE_UINT | 24,
- /** 导入密钥类型, 类型可在枚举{@link OH_Huks_ImportKeyType}中选择。 */
+ /** 导入密钥类型，类型可在枚举{@link OH_Huks_ImportKeyType}中选择。 */
OH_HUKS_TAG_IMPORT_KEY_TYPE = OH_HUKS_TAG_TYPE_UINT | 25,
/** 导入加密密钥的套件。 */
OH_HUKS_TAG_UNWRAP_ALGORITHM_SUITE = OH_HUKS_TAG_TYPE_UINT | 26,
@@ -666,7 +669,6 @@ enum OH_Huks_Tag {
/** RSA算法，填充模式为PSS时的盐值长度类型。 */
OH_HUKS_TAG_RSA_PSS_SALT_LEN_TYPE = OH_HUKS_TAG_TYPE_UINT | 30,
- /** 密钥使用访问控制和使用认证相关的标签取值范围: 301 - 500 */
/** 多用户中的所有用户。 */
OH_HUKS_TAG_ALL_USERS = OH_HUKS_TAG_TYPE_BOOL | 301,
/** 表示多用户id。 */
@@ -677,7 +679,7 @@ enum OH_Huks_Tag {
OH_HUKS_TAG_USER_AUTH_TYPE = OH_HUKS_TAG_TYPE_UINT | 304,
/** 表示密钥访问控制类型中密钥访问的超时时间。 */
OH_HUKS_TAG_AUTH_TIMEOUT = OH_HUKS_TAG_TYPE_UINT | 305,
- /** 表示密钥访问控制中使用密钥时传入的authtoken的类型 */
+ /** 表示密钥访问控制中使用密钥时传入的authtoken的类型。 */
OH_HUKS_TAG_AUTH_TOKEN = OH_HUKS_TAG_TYPE_BYTES | 306,
/** 表示安全访问控制类型，需要和用户认证类型同时设置，类型可在枚举{@link OH_Huks_AuthAccessType}中选择。 */
OH_HUKS_TAG_KEY_AUTH_ACCESS_TYPE = OH_HUKS_TAG_TYPE_UINT | 307,
@@ -691,20 +693,19 @@ enum OH_Huks_Tag {
OH_HUKS_TAG_KEY_AUTH_PURPOSE = OH_HUKS_TAG_TYPE_UINT | 311,
/**
- * 密钥文件存储访问控制的类别，类型可在枚举{@link OH_Huks_AuthStorageLevel}中选择。
+ * @brief 密钥文件存储访问控制的类别，类型可在枚举{@link OH_Huks_AuthStorageLevel}中选择。
*
* @since 11
*/
OH_HUKS_TAG_AUTH_STORAGE_LEVEL = OH_HUKS_TAG_TYPE_UINT | 316,
/**
- * 表示密钥访问控制中用户认证模式，类型可在枚举{@link OH_Huks_UserAuthMode}中选择。
+ * @brief 表示密钥访问控制中用户认证模式，类型可在枚举{@link OH_Huks_UserAuthMode}中选择。
*
* @since 12
*/
OH_HUKS_TAG_USER_AUTH_MODE = OH_HUKS_TAG_TYPE_UINT | 319,
- /** 密钥认证相关的标签值: 501 - 600 */
/** 密钥认证时的挑战值。 */
OH_HUKS_TAG_ATTESTATION_CHALLENGE = OH_HUKS_TAG_TYPE_BYTES | 501,
/** 密钥认证时拥有该密钥的application的Id。 */
@@ -716,14 +717,9 @@ enum OH_Huks_Tag {
/** 密钥认证时的版本号。 */
OH_HUKS_TAG_ATTESTATION_ID_VERSION_INFO = OH_HUKS_TAG_TYPE_BYTES | 515,
- /**
- * 其他类型的标签值预留: 601 - 1000
- *
- * 扩展标签值: 1001 - 9999
- */
/** 是否是密钥别名。 */
OH_HUKS_TAG_IS_KEY_ALIAS = OH_HUKS_TAG_TYPE_BOOL | 1001,
- /** 密钥存储方式的标签, 类型可在枚举 {@link OH_Huks_KeyStorageType}选择。 */
+ /** 密钥存储方式的标签，类型可在枚举 {@link OH_Huks_KeyStorageType}选择。 */
OH_HUKS_TAG_KEY_STORAGE_FLAG = OH_HUKS_TAG_TYPE_UINT | 1002,
/** 是否允许密钥封装。 */
OH_HUKS_TAG_IS_ALLOWED_WRAP = OH_HUKS_TAG_TYPE_BOOL | 1003,
@@ -733,15 +729,15 @@ enum OH_Huks_Tag {
OH_HUKS_TAG_KEY_AUTH_ID = OH_HUKS_TAG_TYPE_BYTES | 1005,
/** 密钥角色。 */
OH_HUKS_TAG_KEY_ROLE = OH_HUKS_TAG_TYPE_UINT | 1006,
- /** 密钥标记, 类型可在枚举{@link OH_Huks_KeyFlag}选择。 */
+ /** 密钥标记，类型可在枚举{@link OH_Huks_KeyFlag}选择。 */
OH_HUKS_TAG_KEY_FLAG = OH_HUKS_TAG_TYPE_UINT | 1007,
/** 是否异步。 */
OH_HUKS_TAG_IS_ASYNCHRONIZED = OH_HUKS_TAG_TYPE_UINT | 1008,
/** 密钥域。 */
OH_HUKS_TAG_KEY_DOMAIN = OH_HUKS_TAG_TYPE_UINT | 1011,
/**
- * 表示密钥锁屏密码访问控制字段，可限制密钥只有在用户设置了锁屏密码时可用。
- * True 表示只有在密码设置时才能生成和使用密钥。
+ * @brief 表示密钥锁屏密码访问控制字段，可限制密钥只有在用户设置了锁屏密码时可用。\n
+ * True表示只有在密码设置时才能生成和使用密钥。
*
* @since 11
*/
@@ -750,16 +746,11 @@ enum OH_Huks_Tag {
/** 用于传入GCM模式中的AEAD数据的字段。 */
OH_HUKS_TAG_AE_TAG = OH_HUKS_TAG_TYPE_BYTES | 10009,
- /**
- * 预留值: 11000 - 12000
- *
- * 其他标签预留值: 20001 - N
- */
- /** 对称密钥数据 */
+ /** 对称密钥数据。 */
OH_HUKS_TAG_SYMMETRIC_KEY_DATA = OH_HUKS_TAG_TYPE_BYTES | 20001,
- /** 非对称密钥公钥数据 */
+ /** 非对称密钥公钥数据。 */
OH_HUKS_TAG_ASYMMETRIC_PUBLIC_KEY_DATA = OH_HUKS_TAG_TYPE_BYTES | 20002,
- /** 非对称密钥私钥数据 */
+ /** 非对称密钥私钥数据。 */
OH_HUKS_TAG_ASYMMETRIC_PRIVATE_KEY_DATA = OH_HUKS_TAG_TYPE_BYTES | 20003,
};
@@ -770,7 +761,7 @@ enum OH_Huks_Tag {
* @version 1.0
*/
struct OH_Huks_Result {
- /** 状态返回码。 */
+ /** 状态返回码，参考{@link OH_Huks_ErrCode}。 */
int32_t errorCode;
/** 对状态返回码的说明信息。 */
const char *errorMsg;
@@ -785,9 +776,9 @@ struct OH_Huks_Result {
* @version 1.0
*/
struct OH_Huks_Blob {
- /** 数据大小 */
+ /** 数据大小。 */
uint32_t size;
- /** 指向数据内存的指针 */
+ /** 指向数据内存的指针。 */
uint8_t *data;
};
@@ -970,14 +961,14 @@ struct OH_Huks_KeyMaterial25519 {
uint32_t pubKeySize;
/** 私钥的长度。 */
uint32_t priKeySize;
- /** 保留。 */
+ /** 预留字段。建议开发者赋值为0。 */
uint32_t reserved;
};
/**
* @brief 定义密钥别名集的结构体类型。
*
- * @since 12
+ * @since 20
* @version 1.0
*/
struct OH_Huks_KeyAliasSet {