openharmony 鸿蒙 capi-native-huks-type-h

2026-08-25 浏览 (1)

native_huks_type.h

概述

提供huks中的枚举变量、结构体定义与宏定义。

引用文件： <huks/native_huks_type.h>

库： libhuks_ndk.z.so

系统能力： SystemCapability.Security.Huks.Core

在API 9-19，系统能力为SystemCapability.Security.Huks；从API 20起，系统能力变更为SystemCapability.Security.Huks.Core

起始版本： 9

相关模块： HuksTypeApi

汇总

结构体

名称描述
OH_Huks_Result表示状态返回数据，包括返回码和消息。
OH_Huks_Blob定义存放数据的结构体类型。
OH_Huks_Param定义参数集中的参数结构体类型。
OH_Huks_ParamSet定义参数集的结构体类型。
OH_Huks_CertChain定义证书链的结构体类型。
OH_Huks_KeyInfo定义密钥信息的结构体类型。
OH_Huks_PubKeyInfo定义公钥信息的结构体类型。
OH_Huks_KeyMaterialRsa定义Rsa密钥的结构体类型。
OH_Huks_KeyMaterialEcc定义Ecc密钥的结构体类型。
OH_Huks_KeyMaterialDsa定义Dsa密钥的结构体类型。
OH_Huks_KeyMaterialDh定义Dh密钥的结构体类型。
OH_Huks_KeyMaterial25519定义25519类型密钥的结构体类型。
OH_Huks_KeyAliasSet定义密钥别名集的结构体类型。

枚举

名称typedef关键字描述
OH_Huks_KeyPurpose-密钥用途类型。
OH_Huks_KeyDigest-摘要算法类型。
OH_Huks_KeyPadding-填充算法类型。
OH_Huks_CipherMode-加密模式。
OH_Huks_KeySize-算法密钥长度。
OH_Huks_KeyAlg-密钥使用的算法。
OH_Huks_AlgSuite-密文导入所需的算法套件类型。
OH_Huks_KeyGenerateType-生成的密钥类型。
OH_Huks_KeyFlag-密钥的产生方式。
OH_Huks_KeyStorageType-密钥的存储方式。
OH_Huks_ImportKeyType-导入密钥的类型，默认为导入公钥，导入对称密钥时不需要该字段。
OH_Huks_RsaPssSaltLenType-PSS填充模式下盐值长度类型。
OH_Huks_ErrCode-错误码。
OH_Huks_TagType-参数集中参数的类型。
OH_Huks_UserAuthType-密钥访问控制中的用户认证类型。
OH_Huks_AuthAccessType-安全访问控制类型，表示密钥失效的原则。
OH_Huks_AuthStorageLevel-表示生成或导入密钥时，指定该密钥的存储安全等级。
OH_Huks_ChallengeType-密钥使用时生成challenge的类型。
OH_Huks_UserAuthMode-密钥访问控制中的用户认证模式。
OH_Huks_ChallengePosition-challenge类型为用户自定义类型时，生成的challenge有效长度仅为8字节连续的数据，且仅支持4种位置。
OH_Huks_SecureSignType-生成或导入密钥时，指定该密钥的安全签名类型。
OH_Huks_KeyClassTypeOH_Huks_KeyClassType密钥类型。
OH_Huks_KeyWrapType-生成或导入密钥时，指定该密钥的封装类型。
OH_Huks_Tag-参数集所用的TAG值枚举。

宏定义

名称描述
OH_HUKS_AE_TAG_LEN 16AEAD认证标签的字节长度。
起始版本： 9
OH_HUKS_BITS_PER_BYTE 8每个字节的比特位数。
起始版本： 9
OH_HUKS_MAX_KEY_SIZE 2048密钥最大字节长度。
起始版本： 9
OH_HUKS_AE_NONCE_LEN 12AEAD一次性随机数的字节长度。
起始版本： 9
OH_HUKS_MAX_KEY_ALIAS_LEN 64密钥别名最大字节长度。
起始版本： 9
OH_HUKS_MAX_PROCESS_NAME_LEN 50进程名最大字节长度。
起始版本： 9
OH_HUKS_MAX_RANDOM_LEN 1024随机数的最大字节长度。
起始版本： 9
OH_HUKS_SIGNATURE_MIN_SIZE 64签名结果的最小字节长度。
起始版本： 9
OH_HUKS_MAX_OUT_BLOB_SIZE (5 * 1024 * 1024)导出数据最大字节数。
起始版本： 9
OH_HUKS_WRAPPED_FORMAT_MAX_SIZE (1024 * 1024)待导入加密密钥的最大字节数。
起始版本： 9
OH_HUKS_IMPORT_WRAPPED_KEY_TOTAL_BLOBS 10待导入加密密钥传入数据的数据块最大数量。
起始版本： 9
TOKEN_CHALLENGE_LEN 32在进行访问控制时挑战值的字节长度。
起始版本： 9
SHA256_SIGN_LEN 32SHA256签名的字节长度。
起始版本： 9
TOKEN_SIZE 32在进行访问控制时挑战值的字节长度。
起始版本： 9
MAX_AUTH_TIMEOUT_SECOND 60最大用户认证超时时间。
起始版本： 9
SECURE_SIGN_VERSION 0x01000001安全签名数据的版本。
起始版本： 9

枚举类型说明

OH_Huks_KeyPurpose

enum OH_Huks_KeyPurpose

描述

密钥用途类型。

起始版本： 9

枚举项描述
OH_HUKS_KEY_PURPOSE_ENCRYPT = 1表示密钥用于对明文进行加密操作。
OH_HUKS_KEY_PURPOSE_DECRYPT = 2表示密钥用于对密文进行解密操作。
OH_HUKS_KEY_PURPOSE_SIGN = 4表示密钥用于对数据进行签名。
OH_HUKS_KEY_PURPOSE_VERIFY = 8表示密钥用于验证签名后的数据。
OH_HUKS_KEY_PURPOSE_DERIVE = 16表示密钥用于派生密钥。
OH_HUKS_KEY_PURPOSE_WRAP = 32表示密钥用于加密导出。
OH_HUKS_KEY_PURPOSE_UNWRAP = 64表示密钥加密导入。
OH_HUKS_KEY_PURPOSE_MAC = 128表示密钥用于生成mac消息验证码。
OH_HUKS_KEY_PURPOSE_AGREE = 256表示密钥用于进行密钥协商。

OH_Huks_KeyDigest

enum OH_Huks_KeyDigest

描述

摘要算法类型。

起始版本： 9

枚举项描述
OH_HUKS_DIGEST_NONE = 0无摘要算法。
OH_HUKS_DIGEST_MD5 = 1MD5摘要算法。
OH_HUKS_DIGEST_SM3 = 2SM3摘要算法。
OH_HUKS_DIGEST_SHA1 = 10SHA1摘要算法。
OH_HUKS_DIGEST_SHA224 = 11SHA224摘要算法。
OH_HUKS_DIGEST_SHA256 = 12SHA256摘要算法。
OH_HUKS_DIGEST_SHA384 = 13SHA384摘要算法。
OH_HUKS_DIGEST_SHA512 = 14SHA512摘要算法。

OH_Huks_KeyPadding

enum OH_Huks_KeyPadding

描述

填充算法类型。

起始版本： 9

枚举项描述
OH_HUKS_PADDING_NONE = 0不使用填充算法。
OH_HUKS_PADDING_OAEP = 1使用OAEP填充算法。
OH_HUKS_PADDING_PSS = 2使用PSS填充算法。
OH_HUKS_PADDING_PKCS1_V1_5 = 3使用PKCS1_V1_5填充算法。
OH_HUKS_PADDING_PKCS5 = 4使用PKCS5填充算法。
OH_HUKS_PADDING_PKCS7 = 5使用PKCS7填充算法。
OH_HUKS_PADDING_ISO_IEC_9796_2 = 6使用ISO IEC 9796-2填充算法。
起始版本： 18
OH_HUKS_PADDING_ISO_IEC_9797_1 = 7使用ISO IEC 9797-1填充算法。
起始版本： 18

OH_Huks_CipherMode

enum OH_Huks_CipherMode

描述

加密模式。

起始版本： 9

枚举项描述
OH_HUKS_MODE_ECB = 1使用ECB模式。
OH_HUKS_MODE_CBC = 2使用CBC模式。
OH_HUKS_MODE_CTR = 3使用CTR模式。
OH_HUKS_MODE_OFB = 4使用OFB模式。
OH_HUKS_MODE_CFB = 5使用CFB模式。
起始版本： 12
OH_HUKS_MODE_CCM = 31使用CCM模式。
OH_HUKS_MODE_GCM = 32使用GCM模式。

OH_Huks_KeySize

enum OH_Huks_KeySize

描述

算法密钥长度。

起始版本： 9

枚举项描述
OH_HUKS_RSA_KEY_SIZE_512 = 512使用RSA算法的密钥长度为512bit。
OH_HUKS_RSA_KEY_SIZE_768 = 768使用RSA算法的密钥长度为768bit。
OH_HUKS_RSA_KEY_SIZE_1024 = 1024使用RSA算法的密钥长度为1024bit。
OH_HUKS_RSA_KEY_SIZE_2048 = 2048使用RSA算法的密钥长度为2048bit。
OH_HUKS_RSA_KEY_SIZE_3072 = 3072使用RSA算法的密钥长度为3072bit。
OH_HUKS_RSA_KEY_SIZE_4096 = 4096使用RSA算法的密钥长度为4096bit。
OH_HUKS_ECC_KEY_SIZE_224 = 224使用ECC算法的密钥长度为224bit。
OH_HUKS_ECC_KEY_SIZE_256 = 256使用ECC算法的密钥长度为256bit。
OH_HUKS_ECC_KEY_SIZE_384 = 384使用ECC算法的密钥长度为384bit。
OH_HUKS_ECC_KEY_SIZE_521 = 521使用ECC算法的密钥长度为521bit。
OH_HUKS_AES_KEY_SIZE_128 = 128使用AES算法的密钥长度为128bit。
OH_HUKS_AES_KEY_SIZE_192 = 192使用AES算法的密钥长度为192bit。
OH_HUKS_AES_KEY_SIZE_256 = 256使用AES算法的密钥长度为256bit。
OH_HUKS_AES_KEY_SIZE_512 = 512使用AES算法的密钥长度为512bit。
OH_HUKS_CURVE25519_KEY_SIZE_256 = 256使用CURVE25519算法的密钥长度为256bit。
OH_HUKS_DH_KEY_SIZE_2048 = 2048使用DH算法的密钥长度为2048bit。
OH_HUKS_DH_KEY_SIZE_3072 = 3072使用DH算法的密钥长度为3072bit。
OH_HUKS_DH_KEY_SIZE_4096 = 4096使用DH算法的密钥长度为4096bit。
OH_HUKS_SM2_KEY_SIZE_256 = 256使用SM2算法的密钥长度为256bit。
OH_HUKS_SM4_KEY_SIZE_128 = 128使用SM4算法支持的密钥长度为128位。
OH_HUKS_DES_KEY_SIZE_64 = 64使用DES算法的密钥长度为64bit。
起始版本： 18
OH_HUKS_3DES_KEY_SIZE_128 = 128使用3DES算法的密钥长度为128bit。
起始版本： 18
OH_HUKS_3DES_KEY_SIZE_192 = 192使用3DES算法的密钥长度为192bit。
起始版本： 18

OH_Huks_KeyAlg

enum OH_Huks_KeyAlg

描述

密钥使用的算法。

起始版本： 9

枚举项描述
OH_HUKS_ALG_RSA = 1使用RSA算法。
OH_HUKS_ALG_ECC = 2使用ECC算法。
OH_HUKS_ALG_DSA = 3使用DSA算法。
OH_HUKS_ALG_AES = 20使用AES算法。
OH_HUKS_ALG_HMAC = 50使用HMAC算法。
OH_HUKS_ALG_HKDF = 51使用HKDF算法。
OH_HUKS_ALG_PBKDF2 = 52使用PBKDF2算法。
OH_HUKS_ALG_ECDH = 100使用ECDH算法。
OH_HUKS_ALG_X25519 = 101使用X25519算法。
OH_HUKS_ALG_ED25519 = 102使用ED25519算法。
OH_HUKS_ALG_DH = 103使用DH算法。
OH_HUKS_ALG_SM2 = 150使用SM2算法。
OH_HUKS_ALG_SM3 = 151使用SM3算法。
OH_HUKS_ALG_SM4 = 152使用SM4算法。
OH_HUKS_ALG_DES = 160使用DES算法。
起始版本： 18
OH_HUKS_ALG_3DES = 161使用3DES算法。
起始版本： 18
OH_HUKS_ALG_CMAC = 162使用CMAC算法。
起始版本： 18

OH_Huks_AlgSuite

enum OH_Huks_AlgSuite

描述

密文导入所需的算法套件类型。

OH_HUKS_UNWRAP_SUITE_X25519_AES_256_GCM_NOPADDING对应的密钥材料格式：

|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_ECDH_AES_256_GCM_NOPADDING对应的密钥材料格式：

| 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 
|  key_material_size_len     (4 Byte)| key_material_size|  key_mat_enc_length (4 Byte)|key_mat_enc_data

OH_HUKS_UNWRAP_SUITE_SM2_SM4_ECB_NOPADDING对应的密钥材料格式：

|kek_SM4_enc_length (4 Byte)|EN_SM4_key|importkey_enc_length (4 Byte)|importkey_enc|

起始版本： 9

枚举项描述
OH_HUKS_UNWRAP_SUITE_X25519_AES_256_GCM_NOPADDING = 1密文导入密钥材料格式（Length-Value格式）采用X25519密钥协商同时采用AES-256-GCM加解密。具体材料格式见上方枚举描述。
OH_HUKS_UNWRAP_SUITE_ECDH_AES_256_GCM_NOPADDING = 2密文导入密钥材料格式（Length-Value格式）采用ECDH-p256密钥协商同时采用AES-256-GCM加解密。具体材料格式见上方枚举描述。
OH_HUKS_UNWRAP_SUITE_SM2_SM4_ECB_NOPADDING = 5密文导入密钥材料格式（Length-Value格式）使用临时SM4密钥加密导入密钥，使用已导入HUKS的SM2密钥加密SM4密钥。具体材料格式见上方枚举描述。
**起始版本：**23

OH_Huks_KeyGenerateType

enum OH_Huks_KeyGenerateType

描述

生成的密钥类型。

起始版本： 9

枚举项描述
OH_HUKS_KEY_GENERATE_TYPE_DEFAULT = 0默认生成的密钥。
OH_HUKS_KEY_GENERATE_TYPE_DERIVE = 1派生生成的密钥。
OH_HUKS_KEY_GENERATE_TYPE_AGREE = 2协商生成的密钥。

OH_Huks_KeyFlag

enum OH_Huks_KeyFlag

描述

密钥的产生方式。

起始版本： 9

枚举项描述
OH_HUKS_KEY_FLAG_IMPORT_KEY = 1通过导入公钥接口导入的密钥。
OH_HUKS_KEY_FLAG_GENERATE_KEY = 2通过生成密钥接口生成的密钥。
OH_HUKS_KEY_FLAG_AGREE_KEY = 3通过生成密钥协商接口生成的密钥。
OH_HUKS_KEY_FLAG_DERIVE_KEY = 4通过生成密钥派生接口生成的密钥。

OH_Huks_KeyStorageType

enum OH_Huks_KeyStorageType

描述

密钥的存储方式。

起始版本： 9

枚举项描述
OH_HUKS_STORAGE_TEMP = 0通过接口返回给业务。
OH_HUKS_STORAGE_PERSISTENT = 1密钥托管在HUKS中。
OH_HUKS_STORAGE_ONLY_USED_IN_HUKS = 2在进行密钥派生或协商时，结果密钥托管在HUKS中。
OH_HUKS_STORAGE_KEY_EXPORT_ALLOWED = 3在进行密钥派生或协商时，结果密钥可以返回给业务。

OH_Huks_ImportKeyType

enum OH_Huks_ImportKeyType

描述

导入密钥的类型，默认为导入公钥，导入对称密钥时不需要该字段。

起始版本： 9

枚举项描述
OH_HUKS_KEY_TYPE_PUBLIC_KEY = 0导入的密钥类型为公钥。
OH_HUKS_KEY_TYPE_PRIVATE_KEY = 1导入的密钥类型为私钥。
OH_HUKS_KEY_TYPE_KEY_PAIR = 2导入的密钥类型为公私钥对。

OH_Huks_RsaPssSaltLenType

enum OH_Huks_RsaPssSaltLenType

描述

PSS填充模式下盐值长度类型。

起始版本： 10

枚举项描述
OH_HUKS_RSA_PSS_SALT_LEN_DIGEST = 0以摘要长度设置盐值长度。
OH_HUKS_RSA_PSS_SALT_LEN_MAX = 1以最大长度设置盐值长度。

OH_Huks_ErrCode

enum OH_Huks_ErrCode

描述

错误码。

起始版本： 9

枚举项描述
OH_HUKS_SUCCESS = 0成功。
OH_HUKS_ERR_CODE_PERMISSION_FAIL = 201权限校验失败。
OH_HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401非法参数（通用）。
OH_HUKS_ERR_CODE_NOT_SUPPORTED_API = 801不支持该API。
OH_HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001不支持该子功能（特性）。
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进程通信错误。
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_SESSION_LIMIT = 12000010密钥操作会话数已达上限。
OH_HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011该项实体不存在。
OH_HUKS_ERR_CODE_INTERNAL_ERROR = 12000012内部错误。
OH_HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST = 12000013认证凭据不存在。
OH_HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014内存不足。
OH_HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015调用服务失败。
OH_HUKS_ERR_CODE_DEVICE_PASSWORD_UNSET = 12000016需要锁屏密码，但没有设置。
起始版本： 11
OH_HUKS_ERR_CODE_KEY_ALREADY_EXIST = 12000017同名密钥已存在。
起始版本： 20
OH_HUKS_ERR_CODE_INVALID_ARGUMENT = 12000018输入的参数无效。
起始版本： 20
OH_HUKS_ERR_CODE_ITEM_EXISTS = 12000019该项实体已存在。
起始版本： 22
OH_HUKS_ERR_CODE_EXTERNAL_MODULE = 12000020提供者或Ukey内部执行失败。
起始版本： 22
OH_HUKS_ERR_CODE_PIN_LOCKED = 12000021Pin码被锁定。
起始版本： 22
OH_HUKS_ERR_CODE_PIN_INCORRECT = 12000022Pin码错误。
起始版本： 22
OH_HUKS_ERR_CODE_PIN_NO_AUTH = 12000023Pin码未认证通过。
起始版本： 22
OH_HUKS_ERR_CODE_BUSY = 12000024提供者或Ukey中的资源正在被使用。
起始版本： 22
OH_HUKS_ERR_CODE_EXCEED_LIMIT = 12000025资源超过限制。
起始版本： 22

OH_Huks_TagType

enum OH_Huks_TagType

描述

参数集中参数的类型。

起始版本： 9

枚举项描述
OH_HUKS_TAG_TYPE_INVALID = 0 << 28非法的Tag类型。
OH_HUKS_TAG_TYPE_INT = 1 << 28该Tag的数据类型为int32_t类型。
OH_HUKS_TAG_TYPE_UINT = 2 << 28该Tag的数据类型为uin32_t类型。
OH_HUKS_TAG_TYPE_ULONG = 3 << 28该Tag的数据类型为uin64_t类型。
OH_HUKS_TAG_TYPE_BOOL = 4 << 28该Tag的数据类型为bool类型。
OH_HUKS_TAG_TYPE_BYTES = 5 << 28该Tag的数据类型为OH_Huks_Blob类型。

参考：

OH_Huks_Param

OH_Huks_UserAuthType

enum OH_Huks_UserAuthType

描述

密钥访问控制中的用户认证类型。

起始版本： 9

枚举项描述
OH_HUKS_USER_AUTH_TYPE_FINGERPRINT = 1 << 0用户认证类型为指纹。
OH_HUKS_USER_AUTH_TYPE_FACE = 1 << 1用户认证类型为人脸。
OH_HUKS_USER_AUTH_TYPE_PIN = 1 << 2用户认证类型为PIN码。
OH_HUKS_USER_AUTH_TYPE_TUI_PIN = 1 << 5用户认证类型为TUI PIN码。
起始版本： 20

OH_Huks_AuthAccessType

enum OH_Huks_AuthAccessType

描述

安全访问控制类型，表示密钥失效的原则。

起始版本： 9

枚举项描述
OH_HUKS_AUTH_ACCESS_INVALID_CLEAR_PASSWORD = 1 << 0安全访问控制类型为清除密码后密钥无效。
OH_HUKS_AUTH_ACCESS_INVALID_NEW_BIO_ENROLL = 1 << 1安全访问控制类型为新录入生物特征后密钥无效。
OH_HUKS_AUTH_ACCESS_ALWAYS_VALID = 1 << 2安全访问控制类型为该密钥总是有效。
起始版本： 11

OH_Huks_AuthStorageLevel

enum OH_Huks_AuthStorageLevel

描述

表示生成或导入密钥时，指定该密钥的存储安全等级。

起始版本： 11

枚举项描述
OH_HUKS_AUTH_STORAGE_LEVEL_DE = 0表示密钥仅在开机后可访问。
OH_HUKS_AUTH_STORAGE_LEVEL_CE = 1表示密钥仅在首次解锁后可访问。
OH_HUKS_AUTH_STORAGE_LEVEL_ECE = 2表示密钥仅在解锁状态时可访问。

说明：

业务在使用存储等级为ECE的密钥时，建议通过感知锁屏事件来清理使用该密钥创建的会话资源，以保证安全性。

OH_Huks_ChallengeType

enum OH_Huks_ChallengeType

描述

密钥使用时生成challenge的类型。

起始版本： 9

枚举项描述
OH_HUKS_CHALLENGE_TYPE_NORMAL = 0challenge为普通类型，默认32字节。
OH_HUKS_CHALLENGE_TYPE_CUSTOM = 1challenge为用户自定义类型。支持使用多个密钥仅一次认证，challenge长度8字节有效。
OH_HUKS_CHALLENGE_TYPE_NONE = 2免challenge类型。

参考：

OH_Huks_ChallengePosition

OH_Huks_UserAuthMode

enum OH_Huks_UserAuthMode

描述

密钥访问控制中的用户认证模式。

起始版本： 12

枚举项描述
OH_HUKS_USER_AUTH_MODE_LOCAL = 0本地认证模式。
OH_HUKS_USER_AUTH_MODE_COAUTH = 1跨端协同认证模式。

OH_Huks_ChallengePosition

enum OH_Huks_ChallengePosition

描述

challenge类型为用户自定义类型时，生成的challenge有效长度仅为8字节连续的数据，且仅支持4种位置。

起始版本： 9

枚举项描述
OH_HUKS_CHALLENGE_POS_0 = 00~7字节为当前密钥的有效challenge。
OH_HUKS_CHALLENGE_POS_18~15字节为当前密钥的有效challenge。
OH_HUKS_CHALLENGE_POS_216~23字节为当前密钥的有效challenge。
OH_HUKS_CHALLENGE_POS_324~31字节为当前密钥的有效challenge。

OH_Huks_SecureSignType

enum OH_Huks_SecureSignType

描述

生成或导入密钥时，指定该密钥的安全签名类型。

起始版本： 9

枚举项描述
OH_HUKS_SECURE_SIGN_WITH_AUTHINFO = 1签名类型为携带认证信息。生成或导入密钥时指定该字段，则在使用密钥进行签名时，对待签名的数据添加认证信息后进行签名。注意：携带的认证信息包含身份信息，开发者需在其隐私声明中对此身份信息的使用目的、存留策略和销毁方式进行说明。

OH_Huks_KeyClassType

enum OH_Huks_KeyClassType

描述

密钥类型。

起始版本： 22

枚举项描述
OH_HUKS_KEY_CLASS_DEFAULT = 0默认类型，指定密钥存储在HUKS中。
OH_HUKS_KEY_CLASS_EXTENSION = 1密钥存储在外部加密提供者中。

OH_Huks_KeyWrapType

enum OH_Huks_KeyWrapType

描述

生成或导入密钥时，指定该密钥的封装类型。

起始版本： 20

枚举项描述
OH_HUKS_KEY_WRAP_TYPE_HUK_BASED = 2硬件唯一密钥的封装类型。

OH_Huks_Tag

enum OH_Huks_Tag

描述

参数集所用的TAG值枚举。
1-200：密钥参数标签值。
301-500：密钥使用访问控制和使用认证相关的标签值。
501-600：密钥认证相关的标签值。
601-1000：其他类型的标签值预留值。
1001-9999：扩展标签值。
11000-12000：预留值。
20001-N：其他标签预留值。

起始版本： 9

枚举项描述
OH_HUKS_TAG_ALGORITHM = OH_HUKS_TAG_TYPE_UINT |1算法类型。
OH_HUKS_TAG_PURPOSE = OH_HUKS_TAG_TYPE_UINT |2密钥用途。
OH_HUKS_TAG_KEY_SIZE = OH_HUKS_TAG_TYPE_UINT |3密钥长度 。
OH_HUKS_TAG_DIGEST = OH_HUKS_TAG_TYPE_UINT |4摘要算法。
OH_HUKS_TAG_PADDING = OH_HUKS_TAG_TYPE_UINT |5填充算法。
OH_HUKS_TAG_BLOCK_MODE = OH_HUKS_TAG_TYPE_UINT |6加密模式。
OH_HUKS_TAG_KEY_TYPE = OH_HUKS_TAG_TYPE_UINT |7密钥类型。
OH_HUKS_TAG_ASSOCIATED_DATA = OH_HUKS_TAG_TYPE_BYTES |8附加身份验证数据。
OH_HUKS_TAG_NONCE = OH_HUKS_TAG_TYPE_BYTES |9密钥加解密的NONCE字段。
OH_HUKS_TAG_IV = OH_HUKS_TAG_TYPE_BYTES |10初始化的向量。
OH_HUKS_TAG_INFO = OH_HUKS_TAG_TYPE_BYTES |11密钥派生时的信息。
OH_HUKS_TAG_SALT = OH_HUKS_TAG_TYPE_BYTES |12派生盐值。
OH_HUKS_TAG_ITERATION = OH_HUKS_TAG_TYPE_UINT |14派生迭代次数。
OH_HUKS_TAG_KEY_GENERATE_TYPE = OH_HUKS_TAG_TYPE_UINT |15生成密钥的类型，类型可在枚举OH_Huks_KeyGenerateType中选择。
OH_HUKS_TAG_AGREE_ALG = OH_HUKS_TAG_TYPE_UINT |19密钥协商时的算法类型。
OH_HUKS_TAG_AGREE_PUBLIC_KEY_IS_KEY_ALIAS = OH_HUKS_TAG_TYPE_BOOL |20密钥协商时的公钥别名。
OH_HUKS_TAG_AGREE_PRIVATE_KEY_ALIAS = OH_HUKS_TAG_TYPE_BYTES |21密钥协商时的私钥别名。
OH_HUKS_TAG_AGREE_PUBLIC_KEY = OH_HUKS_TAG_TYPE_BYTES |22用于协商的公钥。
OH_HUKS_TAG_KEY_ALIAS = OH_HUKS_TAG_TYPE_BYTES |23密钥别名。
OH_HUKS_TAG_DERIVE_KEY_SIZE = OH_HUKS_TAG_TYPE_UINT |24派生密钥大小。
OH_HUKS_TAG_IMPORT_KEY_TYPE = OH_HUKS_TAG_TYPE_UINT |25导入密钥类型，类型可在枚举OH_Huks_ImportKeyType中选择。
OH_HUKS_TAG_UNWRAP_ALGORITHM_SUITE = OH_HUKS_TAG_TYPE_UINT |26导入加密密钥的套件。
OH_HUKS_TAG_DERIVED_AGREED_KEY_STORAGE_FLAG = OH_HUKS_TAG_TYPE_UINT |29派生密钥/协商密钥的存储类型，类型可在枚举OH_Huks_KeyStorageType中选择。
OH_HUKS_TAG_RSA_PSS_SALT_LEN_TYPE = OH_HUKS_TAG_TYPE_UINT |30RSA算法，填充模式为PSS时的盐值长度类型。
OH_HUKS_TAG_ALL_USERS = OH_HUKS_TAG_TYPE_BOOL |301多用户中的所有用户。
OH_HUKS_TAG_USER_ID = OH_HUKS_TAG_TYPE_UINT |302表示多用户id。
OH_HUKS_TAG_NO_AUTH_REQUIRED = OH_HUKS_TAG_TYPE_BOOL |303表示是否需要密钥访问控制。
OH_HUKS_TAG_USER_AUTH_TYPE = OH_HUKS_TAG_TYPE_UINT |304表示密钥访问控制中用户认证类型。
OH_HUKS_TAG_AUTH_TIMEOUT = OH_HUKS_TAG_TYPE_UINT |305表示密钥访问控制类型中密钥访问的超时时间。
OH_HUKS_TAG_AUTH_TOKEN = OH_HUKS_TAG_TYPE_BYTES |306表示密钥访问控制中使用密钥时传入的authtoken的类型。
OH_HUKS_TAG_KEY_AUTH_ACCESS_TYPE = OH_HUKS_TAG_TYPE_UINT |307表示安全访问控制类型，需要和用户认证类型同时设置，类型可在枚举OH_Huks_AuthAccessType中选择。
OH_HUKS_TAG_KEY_SECURE_SIGN_TYPE = OH_HUKS_TAG_TYPE_UINT |308表示生成或导入密钥时，指定该密钥的签名类型。
OH_HUKS_TAG_CHALLENGE_TYPE = OH_HUKS_TAG_TYPE_UINT |309表示密钥使用时生成的challenge类型，类型可在枚举OH_Huks_ChallengeType中选择。
OH_HUKS_TAG_CHALLENGE_POS = OH_HUKS_TAG_TYPE_UINT |310表示challenge类型为用户自定义类型时，huks产生的challenge有效长度仅为8字节连续的数据的位置，类型可在枚举OH_Huks_ChallengePosition中选择。
OH_HUKS_TAG_KEY_AUTH_PURPOSE = OH_HUKS_TAG_TYPE_UINT |311表示密钥认证用途的类型。
OH_HUKS_TAG_AUTH_STORAGE_LEVEL = OH_HUKS_TAG_TYPE_UINT |316密钥文件存储访问控制的类别，类型可在枚举OH_Huks_AuthStorageLevel中选择。
起始版本： 11
OH_HUKS_TAG_USER_AUTH_MODE = OH_HUKS_TAG_TYPE_UINT |319表示密钥访问控制中用户认证模式，类型可在枚举OH_Huks_UserAuthMode中选择。
起始版本： 12
OH_HUKS_TAG_ATTESTATION_CHALLENGE = OH_HUKS_TAG_TYPE_BYTES |501密钥认证时的挑战值。
OH_HUKS_TAG_ATTESTATION_APPLICATION_ID = OH_HUKS_TAG_TYPE_BYTES |502密钥认证时拥有该密钥的application的Id。
OH_HUKS_TAG_ATTESTATION_ID_ALIAS = OH_HUKS_TAG_TYPE_BYTES |511密钥认证时的别名。
OH_HUKS_TAG_ATTESTATION_ID_SEC_LEVEL_INFO = OH_HUKS_TAG_TYPE_BYTES |514密钥认证时的安全凭据。
OH_HUKS_TAG_ATTESTATION_ID_VERSION_INFO = OH_HUKS_TAG_TYPE_BYTES |515密钥认证时的版本号。
OH_HUKS_TAG_KEY_OVERRIDE = OH_HUKS_TAG_TYPE_BOOL |520是否覆写同名密钥。
起始版本： 20
OH_HUKS_TAG_AE_TAG_LEN = OH_HUKS_TAG_TYPE_UINT |521CCM模式下指定的AEAD长度。
起始版本： 22
OH_HUKS_TAG_KEY_CLASS = OH_HUKS_TAG_TYPE_UINT |522密钥类别，用于区分设备本地由HUKS管理的密钥或者外部装置中存储的密钥。
起始版本： 22
OH_HUKS_TAG_KEY_ACCESS_GROUP = OH_HUKS_TAG_TYPE_BYTES |523表示群组标识，在同一开发者ID下归属于相同的群组可共享该群组下的密钥。
起始版本： 23
OH_HUKS_TAG_IS_KEY_ALIAS = OH_HUKS_TAG_TYPE_BOOL |1001是否是密钥别名。
OH_HUKS_TAG_KEY_STORAGE_FLAG = OH_HUKS_TAG_TYPE_UINT |1002密钥存储方式的标签，类型可在枚举 OH_Huks_KeyStorageType选择。
OH_HUKS_TAG_IS_ALLOWED_WRAP = OH_HUKS_TAG_TYPE_BOOL |1003是否允许密钥封装。
OH_HUKS_TAG_KEY_WRAP_TYPE = OH_HUKS_TAG_TYPE_UINT |1004密钥封装的类型。
OH_HUKS_TAG_KEY_AUTH_ID = OH_HUKS_TAG_TYPE_BYTES |1005密钥认证的ID。
OH_HUKS_TAG_KEY_ROLE = OH_HUKS_TAG_TYPE_UINT |1006密钥角色。
OH_HUKS_TAG_KEY_FLAG = OH_HUKS_TAG_TYPE_UINT |1007密钥标记，类型可在枚举OH_Huks_KeyFlag选择。
OH_HUKS_TAG_IS_ASYNCHRONIZED = OH_HUKS_TAG_TYPE_UINT |1008是否异步。
OH_HUKS_TAG_KEY_DOMAIN = OH_HUKS_TAG_TYPE_UINT |1011密钥域。
OH_HUKS_TAG_IS_DEVICE_PASSWORD_SET = OH_HUKS_TAG_TYPE_BOOL |1012表示密钥锁屏密码访问控制字段，可限制密钥只有在用户设置了锁屏密码时可用。
True表示只有在密码设置时才能生成和使用密钥。
起始版本： 11
OH_HUKS_TAG_AE_TAG = OH_HUKS_TAG_TYPE_BYTES |10009用于传入GCM模式中的AEAD数据的字段。
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非对称密钥私钥数据。

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 js-apis-huksExternalCrypto-sys

openharmony 鸿蒙 capi-hukstypeapi-oh-huks-keymaterialrsa

openharmony 鸿蒙 capi-hukstypeapi-oh-huks-result

openharmony 鸿蒙 js-apis-CryptoExtensionAbility

openharmony 鸿蒙 capi-hukstypeapi-oh-huks-pubkeyinfo

openharmony 鸿蒙 capi-hukstypeapi-oh-huks-certchain

openharmony 鸿蒙 js-apis-huksExternalCrypto

openharmony 鸿蒙 capi-hukstypeapi-oh-huks-keymaterialdsa

openharmony 鸿蒙 Readme-CN

openharmony 鸿蒙 capi-hukstypeapi

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/XkbaIpd2