通用密钥库系统

2024-01-23 16:00 更新

向应用提供密钥库能力,包括密钥管理及密钥的密码学操作等功能。

HUKS所管理的密钥可以由应用导入或者由应用调用HUKS接口生成。

说明

本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

  1. import huks from '@ohos.security.huks'

HuksParam

调用接口使用的options中的properties数组中的param。

系统能力:SystemCapability.Security.Huks

名称

类型

必填

说明

tag

HuksTag

标签。

value

boolean|number|bigint|Uint8Array

标签对应值。

HuksOptions

调用接口使用的options。

系统能力:SystemCapability.Security.Huks

名称

类型

必填

说明

properties

Array<HuksParam>

属性,用于存HuksParam的数组。

inData

Uint8Array

输入数据。

HuksSessionHandle9+

huks Handle结构体。

系统能力:SystemCapability.Security.Huks

名称

类型

必填

说明

handle

number

表示handle值。

challenge

Uint8Array

表示initSession操作之后获取到的challenge信息。

HuksReturnResult9+

调用接口返回的result。

系统能力:SystemCapability.Security.Huks

名称

类型

必填

说明

outData

Uint8Array

表示输出数据。

properties

Array<HuksParam>

表示属性信息。

certChains

Array<string>

表示证书链数据。

huks.generateKeyItem9+

generateKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback<void>) : void

生成密钥,使用Callback回调异步返回结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

别名。

options

HuksOptions

用于存放生成key所需TAG。其中密钥使用的算法、密钥用途、密钥长度为必选参数。

callback

AsyncCallback<void>

回调函数。未捕获error时代表用户指定别名的密钥生成成功,基于密钥不出TEE原则,此接口不会返回密钥材料内容,若捕获error,则为生成阶段出现异常。

示例:

  1. /* 以生成ECC256密钥为例 */
  2. let keyAlias = 'keyAlias';
  3. let properties = new Array();
  4. properties[0] = {
  5. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  6. value: huks.HuksKeyAlg.HUKS_ALG_ECC
  7. };
  8. properties[1] = {
  9. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  10. value: huks.HuksKeySize.HUKS_ECC_KEY_SIZE_256
  11. };
  12. properties[2] = {
  13. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  14. value:
  15. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_SIGN |
  16. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_VERIFY
  17. };
  18. properties[3] = {
  19. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  20. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  21. };
  22. let options = {
  23. properties: properties
  24. };
  25. try {
  26. huks.generateKeyItem(keyAlias, options, function (error, data) {
  27. if (error) {
  28. console.error(`callback: generateKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  29. } else {
  30. console.info(`callback: generateKeyItem key success`);
  31. }
  32. });
  33. } catch (error) {
  34. console.error(`callback: generateKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  35. }

huks.generateKeyItem9+

generateKeyItem(keyAlias: string, options: HuksOptions) : Promise<void>

生成密钥,使用Promise方式异步返回结果。基于密钥不出TEE原则,通过promise不会返回密钥材料内容,只用于表示此次调用是否成功。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名。

options

HuksOptions

用于存放生成key所需TAG。其中密钥使用的算法、密钥用途、密钥长度为必选参数。

示例:

  1. /* 以生成ECC256密钥为例 */
  2. let keyAlias = 'keyAlias';
  3. let properties = new Array();
  4. properties[0] = {
  5. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  6. value: huks.HuksKeyAlg.HUKS_ALG_ECC
  7. };
  8. properties[1] = {
  9. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  10. value: huks.HuksKeySize.HUKS_ECC_KEY_SIZE_256
  11. };
  12. properties[2] = {
  13. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  14. value:
  15. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_SIGN |
  16. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_VERIFY
  17. };
  18. properties[3] = {
  19. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  20. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  21. };
  22. let options = {
  23. properties: properties
  24. };
  25. try {
  26. huks.generateKeyItem(keyAlias, options)
  27. .then((data) => {
  28. console.info(`promise: generateKeyItem success`);
  29. })
  30. .catch(error => {
  31. console.error(`promise: generateKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  32. });
  33. } catch (error) {
  34. console.error(`promise: generateKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  35. }

huks.deleteKeyItem9+

deleteKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback<void>) : void

删除密钥,使用Callback回调异步返回结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应为生成key时传入的别名。

options

HuksOptions

空对象(此处传空即可)。

callback

AsyncCallback<void>

回调函数。不返回err值时表示接口使用成功,其他时为错误。

示例:

  1. /* 此处options选择emptyOptions传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. try {
  7. huks.deleteKeyItem(keyAlias, emptyOptions, function (error, data) {
  8. if (error) {
  9. console.error(`callback: deleteKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  10. } else {
  11. console.info(`callback: deleteKeyItem key success`);
  12. }
  13. });
  14. } catch (error) {
  15. console.error(`callback: deleteKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  16. }

huks.deleteKeyItem9+

deleteKeyItem(keyAlias: string, options: HuksOptions) : Promise<void>

删除密钥,使用Promise方式异步返回结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应为生成key时传入的别名。

options

HuksOptions

空对象(此处传空即可)。

示例:

  1. /* 此处options选择emptyOptions传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. try {
  7. huks.deleteKeyItem(keyAlias, emptyOptions)
  8. .then ((data) => {
  9. console.info(`promise: deleteKeyItem key success`);
  10. })
  11. .catch(error => {
  12. console.error(`promise: deleteKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  13. });
  14. } catch (error) {
  15. console.error(`promise: deleteKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  16. }

huks.getSdkVersion

getSdkVersion(options: HuksOptions) : string

获取当前系统sdk版本。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

options

HuksOptions

空对象,用于存放sdk版本。

返回值:

类型

说明

string

返回sdk版本。

示例:

  1. /* 此处options选择emptyOptions传空 */
  2. let emptyOptions = {
  3. properties: []
  4. };
  5. let result = huks.getSdkVersion(emptyOptions);

huks.importKeyItem9+

importKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback<void>) : void

导入明文密钥,使用Callback方式回调异步返回结果 。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名。

options

HuksOptions

用于导入时所需TAG和需要导入的密钥。其中密钥使用的算法、密钥用途、密钥长度为必选参数。

callback

AsyncCallback<void>

回调函数。不返回err值时表示接口使用成功,其他时为错误。

示例:

  1. /* 以导入AES256密钥为例 */
  2. let plainTextSize32 = makeRandomArr(32);
  3. function makeRandomArr(size) {
  4. let arr = new Uint8Array(size);
  5. for (let i = 0; i < size; i++) {
  6. arr[i] = Math.floor(Math.random() * 10);
  7. }
  8. return arr;
  9. };
  10. let keyAlias = 'keyAlias';
  11. let properties = new Array();
  12. properties[0] = {
  13. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  14. value: huks.HuksKeyAlg.HUKS_ALG_AES
  15. };
  16. properties[1] = {
  17. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  18. value: huks.HuksKeySize.HUKS_AES_KEY_SIZE_256
  19. };
  20. properties[2] = {
  21. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  22. value:
  23. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT | huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_DECRYPT
  24. };
  25. properties[3] = {
  26. tag: huks.HuksTag.HUKS_TAG_PADDING,
  27. value:huks.HuksKeyPadding.HUKS_PADDING_PKCS7
  28. };
  29. properties[4] = {
  30. tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
  31. value: huks.HuksCipherMode.HUKS_MODE_CBC
  32. };
  33. let options = {
  34. properties: properties,
  35. inData: plainTextSize32
  36. };
  37. try {
  38. huks.importKeyItem(keyAlias, options, function (error, data) {
  39. if (error) {
  40. console.error(`callback: importKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  41. } else {
  42. console.info(`callback: importKeyItem success`);
  43. }
  44. });
  45. } catch (error) {
  46. console.error(`callback: importKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  47. }

huks.importKeyItem9+

importKeyItem(keyAlias: string, options: HuksOptions) : Promise<void>

导入明文密钥,使用Promise方式异步返回结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名。

options

HuksOptions

用于导入时所需TAG和需要导入的密钥。其中密钥使用的算法、密钥用途、密钥长度为必选参数。

示例:

  1. /* 以导入AES128为例 */
  2. let plainTextSize32 = makeRandomArr(32);
  3. function makeRandomArr(size) {
  4. let arr = new Uint8Array(size);
  5. for (let i = 0; i < size; i++) {
  6. arr[i] = Math.floor(Math.random() * 10);
  7. }
  8. return arr;
  9. };
  10. /*第一步:生成密钥*/
  11. let keyAlias = 'keyAlias';
  12. let properties = new Array();
  13. properties[0] = {
  14. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  15. value: huks.HuksKeyAlg.HUKS_ALG_AES
  16. };
  17. properties[1] = {
  18. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  19. value: huks.HuksKeySize.HUKS_AES_KEY_SIZE_128
  20. };
  21. properties[2] = {
  22. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  23. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT | huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_DECRYPT
  24. };
  25. properties[3] = {
  26. tag: huks.HuksTag.HUKS_TAG_PADDING,
  27. value:huks.HuksKeyPadding.HUKS_PADDING_PKCS7
  28. };
  29. properties[4] = {
  30. tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
  31. value: huks.HuksCipherMode.HUKS_MODE_CBC
  32. };
  33. let huksoptions = {
  34. properties: properties,
  35. inData: plainTextSize32
  36. };
  37. try {
  38. huks.importKeyItem(keyAlias, huksoptions)
  39. .then ((data) => {
  40. console.info(`promise: importKeyItem success`);
  41. })
  42. .catch(error => {
  43. console.error(`promise: importKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  44. });
  45. } catch (error) {
  46. console.error(`promise: importKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  47. }

huks.attestKeyItem9+

attestKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksReturnResult>) : void

获取密钥证书,使用Callback方式回调异步返回结果 。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,存放待获取证书密钥的别名。

options

HuksOptions

用于获取证书时指定所需参数与数据。

callback

AsyncCallback<void>

回调函数。不返回err值时表示接口使用成功,其他时为错误。

示例:

  1. let securityLevel = stringToUint8Array('sec_level');
  2. let challenge = stringToUint8Array('challenge_data');
  3. let versionInfo = stringToUint8Array('version_info');
  4. let keyAliasString = "key attest";
  5. function stringToUint8Array(str) {
  6. let arr = [];
  7. for (let i = 0, j = str.length; i < j; ++i) {
  8. arr.push(str.charCodeAt(i));
  9. }
  10. let tmpUint8Array = new Uint8Array(arr);
  11. return tmpUint8Array;
  12. }
  13. async function generateKey(alias) {
  14. let properties = new Array();
  15. properties[0] = {
  16. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  17. value: huks.HuksKeyAlg.HUKS_ALG_RSA
  18. };
  19. properties[1] = {
  20. tag: huks.HuksTag.HUKS_TAG_KEY_STORAGE_FLAG,
  21. value: huks.HuksKeyStorageType.HUKS_STORAGE_PERSISTENT
  22. };
  23. properties[2] = {
  24. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  25. value: huks.HuksKeySize.HUKS_RSA_KEY_SIZE_2048
  26. };
  27. properties[3] = {
  28. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  29. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_VERIFY
  30. };
  31. properties[4] = {
  32. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  33. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  34. };
  35. properties[5] = {
  36. tag: huks.HuksTag.HUKS_TAG_PADDING,
  37. value: huks.HuksKeyPadding.HUKS_PADDING_PSS
  38. };
  39. properties[6] = {
  40. tag: huks.HuksTag.HUKS_TAG_KEY_GENERATE_TYPE,
  41. value: huks.HuksKeyGenerateType.HUKS_KEY_GENERATE_TYPE_DEFAULT
  42. };
  43. properties[7] = {
  44. tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
  45. value: huks.HuksCipherMode.HUKS_MODE_ECB
  46. };
  47. let options = {
  48. properties: properties
  49. };
  50. try {
  51. huks.generateKeyItem(alias, options, function (error, data) {
  52. if (error) {
  53. console.error(`callback: generateKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  54. } else {
  55. console.info(`callback: generateKeyItem success`);
  56. }
  57. });
  58. } catch (error) {
  59. console.error(`callback: generateKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  60. }
  61. }
  62. async function attestKey() {
  63. let aliasString = keyAliasString;
  64. let aliasUint8 = stringToUint8Array(aliasString);
  65. let properties = new Array();
  66. properties[0] = {
  67. tag: huks.HuksTag.HUKS_TAG_ATTESTATION_ID_SEC_LEVEL_INFO,
  68. value: securityLevel
  69. };
  70. properties[1] = {
  71. tag: huks.HuksTag.HUKS_TAG_ATTESTATION_CHALLENGE,
  72. value: challenge
  73. };
  74. properties[2] = {
  75. tag: huks.HuksTag.HUKS_TAG_ATTESTATION_ID_VERSION_INFO,
  76. value: versionInfo
  77. };
  78. properties[3] = {
  79. tag: huks.HuksTag.HUKS_TAG_ATTESTATION_ID_ALIAS,
  80. value: aliasUint8
  81. };
  82. let options = {
  83. properties: properties
  84. };
  85. await generateKey(aliasString);
  86. try {
  87. huks.attestKeyItem(aliasString, options, function (error, data) {
  88. if (error) {
  89. console.error(`callback: attestKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  90. } else {
  91. console.info(`callback: attestKeyItem success`);
  92. }
  93. });
  94. } catch (error) {
  95. console.error(`callback: attestKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  96. }
  97. }

huks.attestKeyItem9+

attestKeyItem(keyAlias: string, options: HuksOptions) : Promise<HuksReturnResult>

获取密钥证书,使用Promise方式异步返回结果 。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,存放待获取证书密钥的别名。

options

HuksOptions

用于获取证书时指定所需参数与数据。

返回值:

类型

说明

Promise<HuksReturnResult>

Promise对象。不返回err值时表示接口使用成功,其他时为错误。

示例:

  1. let securityLevel = stringToUint8Array('sec_level');
  2. let challenge = stringToUint8Array('challenge_data');
  3. let versionInfo = stringToUint8Array('version_info');
  4. let keyAliasString = "key attest";
  5. function stringToUint8Array(str) {
  6. let arr = [];
  7. for (let i = 0, j = str.length; i < j; ++i) {
  8. arr.push(str.charCodeAt(i));
  9. }
  10. let tmpUint8Array = new Uint8Array(arr);
  11. return tmpUint8Array;
  12. }
  13. async function generateKey(alias) {
  14. let properties = new Array();
  15. properties[0] = {
  16. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  17. value: huks.HuksKeyAlg.HUKS_ALG_RSA
  18. };
  19. properties[1] = {
  20. tag: huks.HuksTag.HUKS_TAG_KEY_STORAGE_FLAG,
  21. value: huks.HuksKeyStorageType.HUKS_STORAGE_PERSISTENT
  22. };
  23. properties[2] = {
  24. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  25. value: huks.HuksKeySize.HUKS_RSA_KEY_SIZE_2048
  26. };
  27. properties[3] = {
  28. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  29. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_VERIFY
  30. };
  31. properties[4] = {
  32. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  33. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  34. };
  35. properties[5] = {
  36. tag: huks.HuksTag.HUKS_TAG_PADDING,
  37. value: huks.HuksKeyPadding.HUKS_PADDING_PSS
  38. };
  39. properties[6] = {
  40. tag: huks.HuksTag.HUKS_TAG_KEY_GENERATE_TYPE,
  41. value: huks.HuksKeyGenerateType.HUKS_KEY_GENERATE_TYPE_DEFAULT
  42. };
  43. properties[7] = {
  44. tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
  45. value: huks.HuksCipherMode.HUKS_MODE_ECB
  46. };
  47. let options = {
  48. properties: properties
  49. };
  50. try {
  51. await huks.generateKeyItem(alias, options)
  52. .then((data) => {
  53. console.info(`promise: generateKeyItem success`);
  54. })
  55. .catch(error => {
  56. console.error(`promise: generateKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  57. });
  58. } catch (error) {
  59. console.error(`promise: generateKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  60. }
  61. }
  62. async function attestKey() {
  63. let aliasString = keyAliasString;
  64. let aliasUint8 = stringToUint8Array(aliasString);
  65. let properties = new Array();
  66. properties[0] = {
  67. tag: huks.HuksTag.HUKS_TAG_ATTESTATION_ID_SEC_LEVEL_INFO,
  68. value: securityLevel
  69. };
  70. properties[1] = {
  71. tag: huks.HuksTag.HUKS_TAG_ATTESTATION_CHALLENGE,
  72. value: challenge
  73. };
  74. properties[2] = {
  75. tag: huks.HuksTag.HUKS_TAG_ATTESTATION_ID_VERSION_INFO,
  76. value: versionInfo
  77. };
  78. properties[3] = {
  79. tag: huks.HuksTag.HUKS_TAG_ATTESTATION_ID_ALIAS,
  80. value: aliasUint8
  81. };
  82. let options = {
  83. properties: properties
  84. };
  85. await generateKey(aliasString);
  86. try {
  87. await huks.attestKeyItem(aliasString, options)
  88. .then ((data) => {
  89. console.info(`promise: attestKeyItem success`);
  90. })
  91. .catch(error => {
  92. console.error(`promise: attestKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  93. });
  94. } catch (error) {
  95. console.error(`promise: attestKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  96. }
  97. }

huks.importWrappedKeyItem9+

importWrappedKeyItem(keyAlias: string, wrappingKeyAlias: string, options: HuksOptions, callback: AsyncCallback<void>) : void

导入加密密钥,使用Callback方式回调异步返回结果 。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,存放待导入密钥的别名。

wrappingKeyAlias

string

密钥别名,对应密钥用于解密加密的密钥数据。

options

HuksOptions

用于导入时所需TAG和需要导入的加密的密钥数据。其中密钥使用的算法、密钥用途、密钥长度为必选参数。

callback

AsyncCallback<void>

回调函数。不返回err值时表示接口使用成功,其他时为错误。

示例:

  1. /*
  2. * 以下以SM2密钥的Callback操作验证为例
  3. */
  4. import huks from '@ohos.security.huks';
  5. /*
  6. * 确定密钥别名
  7. */
  8. let importAlias = "importAlias";
  9. let wrapAlias = "wrappingKeyAlias";
  10. let exportKey;
  11. /*
  12. * 加密导入用途的密钥材料原文:转换成HUKS ECC-P-256密钥对格式的密钥材料
  13. */
  14. let inputEccPair = new Uint8Array([
  15. 0x02, 0x00, 0x00, 0x00, // 密钥算法:huks.HuksKeyAlg.HUKS_ALG_ECC = 2
  16. 0x00, 0x01, 0x00, 0x00, // 密钥大小(比特):256
  17. 0x20, 0x00, 0x00, 0x00, // 坐标x长度(字节):32
  18. 0x20, 0x00, 0x00, 0x00, // 坐标y长度(字节):32
  19. 0x20, 0x00, 0x00, 0x00, // 坐标z长度(字节):32
  20. // 坐标x
  21. 0xa5, 0xb8, 0xa3, 0x78, 0x1d, 0x6d, 0x76, 0xe0, 0xb3, 0xf5, 0x6f, 0x43, 0x9d, 0xcf, 0x60, 0xf6,
  22. 0x0b, 0x3f, 0x64, 0x45, 0xa8, 0x3f, 0x1a, 0x96, 0xf1, 0xa1, 0xa4, 0x5d, 0x3e, 0x2c, 0x3f, 0x13,
  23. // 坐标y
  24. 0xd7, 0x81, 0xf7, 0x2a, 0xb5, 0x8d, 0x19, 0x3d, 0x9b, 0x96, 0xc7, 0x6a, 0x10, 0xf0, 0xaa, 0xbc,
  25. 0x91, 0x6f, 0x4d, 0xa7, 0x09, 0xb3, 0x57, 0x88, 0x19, 0x6f, 0x00, 0x4b, 0xad, 0xee, 0x34, 0x35,
  26. // 坐标z
  27. 0xfb, 0x8b, 0x9f, 0x12, 0xa0, 0x83, 0x19, 0xbe, 0x6a, 0x6f, 0x63, 0x2a, 0x7c, 0x86, 0xba, 0xca,
  28. 0x64, 0x0b, 0x88, 0x96, 0xe2, 0xfa, 0x77, 0xbc, 0x71, 0xe3, 0x0f, 0x0f, 0x9e, 0x3c, 0xe5, 0xf9
  29. ]);
  30. /*
  31. * 封装密钥属性参数集
  32. */
  33. // 生成加密导入用途的密钥的属性集
  34. let properties = new Array();
  35. properties[0] = {
  36. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  37. value: huks.HuksKeyAlg.HUKS_ALG_ECC
  38. };
  39. properties[1] = {
  40. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  41. value: huks.HuksKeySize.HUKS_ECC_KEY_SIZE_256
  42. };
  43. properties[2] = {
  44. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  45. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_UNWRAP
  46. };
  47. properties[3] = {
  48. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  49. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  50. };
  51. properties[4] = {
  52. tag: huks.HuksTag.HUKS_TAG_IMPORT_KEY_TYPE,
  53. value: huks.HuksImportKeyType.HUKS_KEY_TYPE_KEY_PAIR,
  54. };
  55. let huksOptions = {
  56. properties: properties,
  57. inData: inputEccPair
  58. };
  59. // 待导入密钥的属性集:AES256
  60. let importProperties = new Array();
  61. importProperties[0] = {
  62. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  63. value: huks.HuksKeyAlg.HUKS_ALG_AES
  64. };
  65. importProperties[1] = {
  66. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  67. value: huks.HuksKeySize.HUKS_AES_KEY_SIZE_256
  68. };
  69. importProperties[2] = {
  70. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  71. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT | huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_DECRYPT
  72. };
  73. importProperties[3] = {
  74. tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
  75. value: huks.HuksCipherMode.HUKS_MODE_CBC
  76. };
  77. importProperties[4] = {
  78. tag: huks.HuksTag.HUKS_TAG_PADDING,
  79. value: huks.HuksKeyPadding.HUKS_PADDING_NONE
  80. };
  81. importProperties[5] = {
  82. tag: huks.HuksTag.HUKS_TAG_UNWRAP_ALGORITHM_SUITE,
  83. value: huks.HuksUnwrapSuite.HUKS_UNWRAP_SUITE_ECDH_AES_256_GCM_NOPADDING // 使用“ECDH+AES256GCM”加密导入套件
  84. };
  85. let importOptions = {
  86. properties: importProperties,
  87. inData: new Uint8Array(new Array())
  88. };
  89. // 导出加密导入用途的公钥
  90. function exportKeyItem(keyAlias:string, huksOptions:huks.HuksOptions, throwObject) : Promise<huks.HuksReturnResult> {
  91. return new Promise((resolve, reject) => {
  92. try {
  93. huks.exportKeyItem(keyAlias, huksOptions, function (error, data) {
  94. if (error) {
  95. reject(error);
  96. } else {
  97. resolve(data);
  98. }
  99. });
  100. } catch (error) {
  101. throwObject.isThrow = true;
  102. throw(error);
  103. }
  104. });
  105. }
  106. async function publicExportKeyFunc(keyAlias:string, huksOptions:huks.HuksOptions) {
  107. console.info(`enter callback export`);
  108. let throwObject = {isThrow: false};
  109. try {
  110. await exportKeyItem(keyAlias, huksOptions, throwObject)
  111. .then ((data) => {
  112. console.info(`callback: exportKeyItem success, data = ${JSON.stringify(data)}`);
  113. exportKey = data.outData;
  114. })
  115. .catch(error => {
  116. if (throwObject.isThrow) {
  117. throw(error);
  118. } else {
  119. console.error(`callback: exportKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  120. }
  121. });
  122. } catch (error) {
  123. console.error(`callback: exportKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  124. }
  125. }
  126. // 此处用导入密钥来模拟“生成加密导入用途的密钥”
  127. function importKeyItem(keyAlias:string, huksOptions:huks.HuksOptions, throwObject) {
  128. return new Promise((resolve, reject) => {
  129. try {
  130. huks.importKeyItem(keyAlias, huksOptions, function (error, data) {
  131. if (error) {
  132. reject(error);
  133. } else {
  134. resolve(data);
  135. }
  136. });
  137. } catch (error) {
  138. throwObject.isThrow = true;
  139. throw(error);
  140. }
  141. });
  142. }
  143. async function publicImportKeyFunc(keyAlias:string, huksOptions:huks.HuksOptions) {
  144. console.info(`enter promise importKeyItem`);
  145. let throwObject = {isThrow: false};
  146. try {
  147. await importKeyItem(keyAlias, huksOptions, throwObject)
  148. .then ((data) => {
  149. console.info(`callback: importKeyItem success, data = ${JSON.stringify(data)}`);
  150. })
  151. .catch(error => {
  152. if (throwObject.isThrow) {
  153. throw(error);
  154. } else {
  155. console.error(`callback: importKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  156. }
  157. });
  158. } catch (error) {
  159. console.error(`callback: importKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  160. }
  161. }
  162. // 执行加密导入
  163. async function publicImportWrappedKey(keyAlias:string, wrappingKeyAlias:string, huksOptions:huks.HuksOptions) {
  164. console.info(`enter callback importWrappedKeyItem`);
  165. var throwObject = {isThrow: false};
  166. try {
  167. await importWrappedKeyItem(keyAlias, wrappingKeyAlias, huksOptions, throwObject)
  168. .then ((data) => {
  169. console.info(`callback: importWrappedKeyItem success, data = ${JSON.stringify(data)}`);
  170. })
  171. .catch(error => {
  172. if (throwObject.isThrow) {
  173. throw(error);
  174. } else {
  175. console.error(`callback: importWrappedKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  176. }
  177. });
  178. } catch (error) {
  179. console.error(`callback: importWrappedKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  180. }
  181. }
  182. function importWrappedKeyItem(keyAlias:string, wrappingKeyAlias:string, huksOptions:huks.HuksOptions, throwObject) {
  183. return new Promise((resolve, reject) => {
  184. try {
  185. huks.importWrappedKeyItem(keyAlias, wrappingKeyAlias, huksOptions, function (error, data) {
  186. if (error) {
  187. reject(error);
  188. } else {
  189. resolve(data);
  190. }
  191. });
  192. } catch (error) {
  193. throwObject.isThrow = true;
  194. throw(error);
  195. }
  196. });
  197. }
  198. // 删除加密导入用途的密钥
  199. function deleteKeyItem(keyAlias:string, huksOptions:huks.HuksOptions, throwObject) {
  200. return new Promise((resolve, reject) => {
  201. try {
  202. huks.deleteKeyItem(keyAlias, huksOptions, function (error, data) {
  203. if (error) {
  204. reject(error);
  205. } else {
  206. resolve(data);
  207. }
  208. });
  209. } catch (error) {
  210. throwObject.isThrow = true;
  211. throw(error);
  212. }
  213. });
  214. }
  215. async function publicDeleteKeyFunc(keyAlias:string, huksOptions:huks.HuksOptions) {
  216. console.info(`enter callback deleteKeyItem`);
  217. let throwObject = {isThrow: false};
  218. try {
  219. await deleteKeyItem(keyAlias, huksOptions, throwObject)
  220. .then ((data) => {
  221. console.info(`callback: deleteKeyItem key success, data = ${JSON.stringify(data)}`);
  222. })
  223. .catch(error => {
  224. if (throwObject.isThrow) {
  225. throw(error);
  226. } else {
  227. console.error(`callback: deleteKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  228. }
  229. });
  230. } catch (error) {
  231. console.error(`callback: deletKeeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  232. }
  233. }
  234. async function ImportWrappedKeyNormalTest() {
  235. console.info(`enter ImportWrapKey test`);
  236. /*
  237. * 生成加密导入用途的密钥(此处使用导入进行模拟)
  238. */
  239. await publicImportKeyFunc(wrapAlias, huksOptions);
  240. /*
  241. * 导出加密导入用途密钥的公钥材料
  242. */
  243. await publicExportKeyFunc(wrapAlias, huksOptions);
  244. /*----------------------------------------------------------------------------------------------
  245. * 此处省略业务本地生成ECC密钥对、业务本地ECDH密钥协商、业务本地生成密钥加密密钥K3、业务本地加密K1'和K3的流程
  246. *----------------------------------------------------------------------------------------------*/
  247. /* 封装加密导入密钥材料:参考加密导入
  248. * 拼接importOptions.inData字段,满足以下格式:
  249. * PK2长度(4字节) + PK2的数据 + AAD2的长度(4字节) + AAD2的数据 +
  250. * Nonce2的长度(4字节)+ Nonce2的数据 + AEAD2的长度(4字节) + AEAD2的数据 +
  251. * K3密文的长度(4字节) + K3密文的数据 + AAD3的长度(4字节) + AAD3的数据 +
  252. * Nonce3的长度(4字节) + Nonce3的数据 + AEAD3的长度(4字节) + AEAD3的数据 +
  253. * K1'_size的长度(4字节) + K1'_size + K1'_enc的长度(4字节) + K1'_enc的数据
  254. */
  255. let inputKey = new Uint8Array([
  256. 0x5b, 0x00, 0x00, 0x00, // ECC-P-256 公钥长度(X.509规范DER格式):91
  257. // ECC-P-256 公钥
  258. 0x30, 0x59, 0x30, 0x13, 0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02, 0x01, 0x06, 0x08, 0x2a,
  259. 0x86, 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07, 0x03, 0x42, 0x00, 0x04, 0xa5, 0xb8, 0xa3, 0x78, 0x1d,
  260. 0x6d, 0x76, 0xe0, 0xb3, 0xf5, 0x6f, 0x43, 0x9d, 0xcf, 0x60, 0xf6, 0x0b, 0x3f, 0x64, 0x45, 0xa8,
  261. 0x3f, 0x1a, 0x96, 0xf1, 0xa1, 0xa4, 0x5d, 0x3e, 0x2c, 0x3f, 0x13, 0xd7, 0x81, 0xf7, 0x2a, 0xb5,
  262. 0x8d, 0x19, 0x3d, 0x9b, 0x96, 0xc7, 0x6a, 0x10, 0xf0, 0xaa, 0xbc, 0x91, 0x6f, 0x4d, 0xa7, 0x09,
  263. 0xb3, 0x57, 0x88, 0x19, 0x6f, 0x00, 0x4b, 0xad, 0xee, 0x34, 0x35,
  264. 0x10, 0x00, 0x00, 0x00, // AAD2长度:16
  265. // AAD2
  266. 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x00,
  267. 0x0c, 0x00, 0x00, 0x00, // Nonce2长度:16
  268. // Nonce2
  269. 0x68, 0x61, 0x68, 0x61, 0x68, 0x61, 0x68, 0x61, 0x68, 0x61, 0x68, 0x00,
  270. 0x10, 0x00, 0x00, 0x00, // AEAD2长度:16
  271. // AEAD2
  272. 0x85, 0xfe, 0xff, 0x5b, 0x47, 0x30, 0xbe, 0x10, 0xea, 0x3c, 0x30, 0x94, 0x8a, 0x99, 0xc4, 0x86,
  273. 0x20, 0x00, 0x00, 0x00, // K3密文长度:32
  274. // K3密文
  275. 0xb4, 0xa9, 0x31, 0x5f, 0x28, 0x39, 0x53, 0x12, 0xa0, 0xfd, 0x8c, 0x9e, 0xfd, 0x36, 0xb8, 0xcb,
  276. 0x73, 0xb3, 0x08, 0xce, 0x16, 0xc9, 0x3b, 0xea, 0xd5, 0xca, 0x41, 0x85, 0xb8, 0x25, 0x7d, 0x1b,
  277. 0x10, 0x00, 0x00, 0x00, // AAD3长度:16
  278. // AAD3
  279. 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x62, 0x61, 0x00,
  280. 0x0c, 0x00, 0x00, 0x00, // Nonce3长度:16
  281. // Nonce3
  282. 0x68, 0x61, 0x68, 0x61, 0x68, 0x61, 0x68, 0x61, 0x68, 0x61, 0x68, 0x00,
  283. 0x10, 0x00, 0x00, 0x00, // AEAD3长度:16
  284. // AEAD3
  285. 0x23, 0xe2, 0xdb, 0xb5, 0x2e, 0xa7, 0xbb, 0x2d, 0xc5, 0x57, 0x05, 0xd8, 0x9d, 0x0e, 0xcf, 0x62,
  286. 0x04, 0x00, 0x00, 0x00, // “密钥明文材料长度”的长度(字节):4
  287. // 密钥明文材料的长度:32字节
  288. 0x20, 0x00, 0x00, 0x00,
  289. 0x20, 0x00, 0x00, 0x00, // 待导入密钥密文长度(字节):32
  290. // 待导入密钥密文
  291. 0xf4, 0x17, 0xbb, 0x90, 0x88, 0x62, 0x3d, 0x6e, 0xd8, 0x5f, 0x03, 0x51, 0x7f, 0xf5, 0x8b, 0x97,
  292. 0x8a, 0x41, 0x33, 0x64, 0xf5, 0x6f, 0x61, 0x16, 0xf9, 0x3c, 0x7a, 0x0b, 0xee, 0x3d, 0x92, 0xbb,
  293. ]);
  294. importOptions.inData = inputKey;
  295. /*
  296. * 导入封装的加密密钥材料
  297. */
  298. await publicImportWrappedKey(importAlias, wrapAlias, importOptions);
  299. /*
  300. * 删除用于加密导入的密钥
  301. */
  302. await publicDeleteKeyFunc(wrapAlias, huksOptions);
  303. }

huks.importWrappedKeyItem9+

importWrappedKeyItem(keyAlias: string, wrappingKeyAlias: string, options: HuksOptions) : Promise<void>

导入加密密钥,使用Promise方式异步返回结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,存放待导入密钥的别名。

wrappingKeyAlias

string

密钥别名,对应密钥用于解密加密的密钥数据。

options

HuksOptions

用于导入时所需TAG和需要导入的加密的密钥数据。其中密钥使用的算法、密钥用途、密钥长度为必选参数。

示例:

  1. /* 处理流程与callback类似,主要差异点为如下函数: */
  2. async function TestImportWrappedFunc(alias, wrappingAlias, options) {
  3. try {
  4. await huks.importWrappedKeyItem(alias, wrappingAlias, options)
  5. .then ((data) => {
  6. console.info(`promise: importWrappedKeyItem success`);
  7. })
  8. .catch(error => {
  9. console.error(`promise: importWrappedKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  10. });
  11. } catch (error) {
  12. console.error(`promise: importWrappedKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  13. }
  14. }

huks.exportKeyItem9+

exportKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksReturnResult>) : void

导出密钥,使用Callback方式回调异步返回的结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应与所用密钥生成时使用的别名相同。

options

HuksOptions

空对象(此处传空即可)。

callback

AsyncCallback<HuksReturnResult>

回调函数。不返回err值时表示接口使用成功,其他时为错误。outData:返回从密钥中导出的公钥。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. try {
  7. huks.exportKeyItem(keyAlias, emptyOptions, function (error, data) {
  8. if (error) {
  9. console.error(`callback: exportKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  10. } else {
  11. console.info(`callback: exportKeyItem success, data = ${JSON.stringify(data)}`);
  12. }
  13. });
  14. } catch (error) {
  15. console.error(`callback: exportKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  16. }

huks.exportKeyItem9+

exportKeyItem(keyAlias: string, options: HuksOptions) : Promise<HuksReturnResult>

导出密钥,使用Promise方式回调异步返回的结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应与所用密钥生成时使用的别名相同。

options

HuksOptions

空对象(此处传空即可)。

返回值:

类型

说明

Promise<HuksReturnResult>

Promise对象。不返回err值时表示接口使用成功,其他时为错误。outData:返回从密钥中导出的公钥。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. try {
  7. huks.exportKeyItem(keyAlias, emptyOptions)
  8. .then ((data) => {
  9. console.info(`promise: exportKeyItem success, data = ${JSON.stringify(data)}`);
  10. })
  11. .catch(error => {
  12. console.error(`promise: exportKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  13. });
  14. } catch (error) {
  15. console.error(`promise: exportKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  16. }

huks.getKeyItemProperties9+

getKeyItemProperties(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksReturnResult>) : void

获取密钥属性,使用Callback回调异步返回结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应与所用密钥生成时使用的别名相同。

options

HuksOptions

空对象(此处传空即可)。

callback

AsyncCallback<HuksReturnResult>

回调函数。不返回err值时表示接口使用成功,其他时为错误。properties:返回值为生成密钥时所需参数。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. try {
  7. huks.getKeyItemProperties(keyAlias, emptyOptions, function (error, data) {
  8. if (error) {
  9. console.error(`callback: getKeyItemProperties failed, code: ${error.code}, msg: ${error.message}`);
  10. } else {
  11. console.info(`callback: getKeyItemProperties success, data = ${JSON.stringify(data)}`);
  12. }
  13. });
  14. } catch (error) {
  15. console.error(`callback: getKeyItemProperties input arg invalid, code: ${error.code}, msg: ${error.message}`);
  16. }

huks.getKeyItemProperties9+

getKeyItemProperties(keyAlias: string, options: HuksOptions) : Promise<HuksReturnResult>

获取密钥属性,使用Promise回调异步返回结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应与所用密钥生成时使用的别名相同。

options

HuksOptions

空对象(此处传空即可)。

返回值:

类型

说明

Promise<HuksReturnResult>

Promise对象。不返回err值时表示接口使用成功,其他时为错误。properties:返回值为生成密钥时所需参数。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. try {
  7. huks.getKeyItemProperties(keyAlias, emptyOptions)
  8. .then ((data) => {
  9. console.info(`promise: getKeyItemProperties success, data = ${JSON.stringify(data)}`);
  10. })
  11. .catch(error => {
  12. console.error(`promise: getKeyItemProperties failed, code: ${error.code}, msg: ${error.message}`);
  13. });
  14. } catch (error) {
  15. console.error(`promise: getKeyItemProperties input arg invalid, code: ${error.code}, msg: ${error.message}`);
  16. }

huks.isKeyItemExist9+

isKeyItemExist(keyAlias: string, options: HuksOptions, callback: AsyncCallback<boolean>) : void

判断密钥是否存在,使用Callback回调异步返回结果 。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

所需查找的密钥的别名。

options

HuksOptions

空对象(此处传空即可)。

callback

AsyncCallback<boolean>

回调函数。若密钥存在,data为true,若密钥不存在,则error中会输出密钥不存在的error code。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. huks.isKeyItemExist(keyAlias, emptyOptions, function (error, data) {
  7. if (data) {
  8. promptAction.showToast({
  9. message: "keyAlias: " + keyAlias +"is existed!",
  10. duration: 2500,
  11. })
  12. } else {
  13. promptAction.showToast({
  14. message: "find key failed,error code: " + error.code + " error msg: " + error.message,
  15. duration: 2500,
  16. })
  17. }
  18. });

huks.isKeyItemExist9+

isKeyItemExist(keyAlias: string, options: HuksOptions) : Promise<boolean>

判断密钥是否存在,使用Promise回调异步返回结果 。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

所需查找的密钥的别名。

options

HuksOptions

空对象(此处传空即可)。

返回值:

类型

说明

Promise<boolean>

Promise对象。密钥存在时,可通过then进行密钥存在后的相关处理,若不存在,可通过error处理密钥不存在后的相关业务操作。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. await huks.isKeyItemExist(keyAlias, emptyOptions).then((data) => {
  7. promptAction.showToast({
  8. message: "keyAlias: " + keyAlias +"is existed!",
  9. duration: 500,
  10. })
  11. }).catch((err)=>{
  12. promptAction.showToast({
  13. message: "find key failed, error code: " + err.code + " error message: " + err.message,
  14. duration: 6500,
  15. })
  16. })

huks.initSession9+

initSession(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksSessionHandle>) : void

initSession操作密钥接口,使用Callback回调异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

initSession操作密钥的别名。

options

HuksOptions

initSession操作的参数集合。

callback

AsyncCallback<HuksSessionHandle>

回调函数。将initSession操作返回的handle添加到密钥管理系统的回调。

huks.initSession9+

initSession(keyAlias: string, options: HuksOptions) : Promise<HuksSessionHandle>

initSession操作密钥接口,使用Promise方式异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

initSession操作密钥的别名。

options

HuksOptions

initSession参数集合。

返回值

类型

说明

Promise<HuksSessionHandle>

Promise对象。将initSession操作返回的handle添加到密钥管理系统的回调。

huks.updateSession9+

updateSession(handle: number, options: HuksOptions, callback: AsyncCallback<HuksReturnResult>) : void

updateSession操作密钥接口,使用Callback回调异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

updateSession操作的handle。

options

HuksOptions

updateSession的参数集合。

callback

AsyncCallback<HuksReturnResult>

回调函数。将updateSession操作的结果添加到密钥管理系统的回调。

huks.updateSession9+

updateSession(handle: number, options: HuksOptions, token: Uint8Array, callback: AsyncCallback<HuksReturnResult>) : void

updateSession操作密钥接口,使用Callback回调异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

updateSession操作的handle。

options

HuksOptions

updateSession操作的参数集合。

token

Uint8Array

updateSession操作的token。

callback

AsyncCallback<HuksReturnResult>

回调函数。将updateSession操作的结果添加到密钥管理系统的回调。

huks.updateSession9+

updateSession(handle: number, options: HuksOptions, token?: Uint8Array) : Promise<HuksReturnResult>

updateSession操作密钥接口,使用Promise方式异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

updateSession操作的handle。

options

HuksOptions

updateSession操作的参数集合。

token

Uint8Array

updateSession操作的token。

返回值

类型

说明

Promise<HuksReturnResult>

Promise对象。将updateSession操作的结果添加到密钥管理系统的回调。

huks.finishSession9+

finishSession(handle: number, options: HuksOptions, callback: AsyncCallback<HuksReturnResult>) : void

finishSession操作密钥接口,使用Callback回调异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

finishSession操作的handle。

options

HuksOptions

finishSession的参数集合。

callback

AsyncCallback<HuksReturnResult>

回调函数。将finishSession操作的结果添加到密钥管理系统的回调。

huks.finishSession9+

finishSession(handle: number, options: HuksOptions, token: Uint8Array, callback: AsyncCallback<HuksReturnResult>) : void

finishSession操作密钥接口,使用Callback回调异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

finishSession操作的handle。

options

HuksOptions

finishSession的参数集合。

token

Uint8Array

finishSession操作的token。

callback

AsyncCallback<HuksReturnResult>

回调函数。将finishSession操作的结果添加到密钥管理系统的回调。

huks.finishSession9+

finishSession(handle: number, options: HuksOptions, token?: Uint8Array) : Promise<HuksReturnResult>

finishSession操作密钥接口,使用Promise方式异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

finishSession操作的handle。

options

HuksOptions

finishSession操作的参数集合。

token

Uint8Array

finishSession操作的token。

返回值

类型

说明

Promise<HuksReturnResult>

Promise对象,用于获取异步返回结果。

huks.abortSession9+

abortSession(handle: number, options: HuksOptions, callback: AsyncCallback<void>) : void

abortSession操作密钥接口,使用Callback回调异步返回结果 。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

abortSession操作的handle。

options

HuksOptions

abortSession操作的参数集合。

callback

AsyncCallback<void>

回调函数。将abortSession操作的结果添加到密钥管理系统的回调。

示例:

  1. /* huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用,当
  2. * huks.initSession和huks.updateSession
  3. * 以及huks.finishSession操作中的任一阶段发生错误时,
  4. * 都需要调用huks.abortSession来终止密钥的使用。
  5. *
  6. * 以下以RSA2048密钥的callback功能使用为例
  7. */
  8. function stringToUint8Array(str) {
  9. let arr = [];
  10. for (let i = 0, j = str.length; i < j; ++i) {
  11. arr.push(str.charCodeAt(i));
  12. }
  13. let tmpUint8Array = new Uint8Array(arr);
  14. return tmpUint8Array;
  15. }
  16. let keyAlias = "HuksDemoRSA";
  17. let properties = new Array();
  18. let options = {
  19. properties: properties,
  20. inData: new Uint8Array(0)
  21. };
  22. let handle;
  23. async function generateKey() {
  24. properties[0] = {
  25. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  26. value: huks.HuksKeyAlg.HUKS_ALG_RSA
  27. };
  28. properties[1] = {
  29. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  30. value: huks.HuksKeySize.HUKS_RSA_KEY_SIZE_2048
  31. };
  32. properties[2] = {
  33. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  34. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT
  35. };
  36. properties[3] = {
  37. tag: huks.HuksTag.HUKS_TAG_PADDING,
  38. value: huks.HuksKeyPadding.HUKS_PADDING_PKCS1_V1_5
  39. };
  40. properties[4] = {
  41. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  42. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  43. };
  44. properties[5] = {
  45. tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
  46. value: huks.HuksCipherMode.HUKS_MODE_ECB,
  47. }
  48. try {
  49. await huks.generateKeyItem(keyAlias, options, function (error, data) {
  50. if (error) {
  51. console.error(`callback: generateKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  52. } else {
  53. console.info(`callback: generateKeyItem success`);
  54. }
  55. });
  56. } catch (error) {
  57. console.error(`callback: generateKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  58. }
  59. }
  60. async function huksInit() {
  61. console.log('enter huksInit');
  62. try {
  63. huks.initSession(keyAlias, options, function (error, data) {
  64. if (error) {
  65. console.error(`callback: initSession failed, code: ${error.code}, msg: ${error.message}`);
  66. } else {
  67. console.info(`callback: initSession success, data = ${JSON.stringify(data)}`);
  68. handle = data.handle;
  69. }
  70. });
  71. } catch (error) {
  72. console.error(`callback: initSession input arg invalid, code: ${error.code}, msg: ${error.message}`);
  73. }
  74. }
  75. async function huksUpdate() {
  76. console.log('enter huksUpdate');
  77. options.inData = stringToUint8Array("huksHmacTest");
  78. try {
  79. huks.updateSession(handle, options, function (error, data) {
  80. if (error) {
  81. console.error(`callback: updateSession failed, code: ${error.code}, msg: ${error.message}`);
  82. } else {
  83. console.info(`callback: updateSession success, data = ${JSON.stringify(data)}`);
  84. }
  85. });
  86. } catch (error) {
  87. console.error(`callback: updateSession input arg invalid, code: ${error.code}, msg: ${error.message}`);
  88. }
  89. }
  90. async function huksFinish() {
  91. console.log('enter huksFinish');
  92. options.inData = new Uint8Array(0);
  93. try {
  94. huks.finishSession(handle, options, function (error, data) {
  95. if (error) {
  96. console.error(`callback: finishSession failed, code: ${error.code}, msg: ${error.message}`);
  97. } else {
  98. console.info(`callback: finishSession success, data = ${JSON.stringify(data)}`);
  99. }
  100. });
  101. } catch (error) {
  102. console.error(`callback: finishSession input arg invalid, code: ${error.code}, msg: ${error.message}`);
  103. }
  104. }
  105. async function huksAbort() {
  106. console.log('enter huksAbort');
  107. try {
  108. huks.abortSession(handle, options, function (error, data) {
  109. if (error) {
  110. console.error(`callback: abortSession failed, code: ${error.code}, msg: ${error.message}`);
  111. } else {
  112. console.info(`callback: abortSession success`);
  113. }
  114. });
  115. } catch (error) {
  116. console.error(`callback: abortSession input arg invalid, code: ${error.code}, msg: ${error.message}`);
  117. }
  118. }

huks.abortSession9+

abortSession(handle: number, options: HuksOptions) : Promise<void>;

abortSession操作密钥接口,使用Promise方式异步返回结果。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

abortSession操作的handle。

options

HuksOptions

abortSession操作的参数集合。

返回值

类型

说明

Promise<void>

Promise对象。将abortSession操作的结果添加到密钥管理系统的回调。

示例:

  1. /* huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用,当
  2. * huks.initSession和huks.updateSession
  3. * 以及huks.finishSession操作中的任一阶段发生错误时,
  4. * 都需要调用huks.abortSession来终止密钥的使用。
  5. *
  6. * 以下以RSA2048密钥的callback功能使用为例
  7. */
  8. function stringToUint8Array(str) {
  9. let arr = [];
  10. for (let i = 0, j = str.length; i < j; ++i) {
  11. arr.push(str.charCodeAt(i));
  12. }
  13. let tmpUint8Array = new Uint8Array(arr);
  14. return tmpUint8Array;
  15. }
  16. let keyAlias = "HuksDemoRSA";
  17. let properties = new Array();
  18. let options = {
  19. properties: properties,
  20. inData: new Uint8Array(0)
  21. };
  22. let handle;
  23. async function generateKey() {
  24. properties[0] = {
  25. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  26. value: huks.HuksKeyAlg.HUKS_ALG_RSA
  27. };
  28. properties[1] = {
  29. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  30. value: huks.HuksKeySize.HUKS_RSA_KEY_SIZE_2048
  31. };
  32. properties[2] = {
  33. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  34. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT
  35. };
  36. properties[3] = {
  37. tag: huks.HuksTag.HUKS_TAG_PADDING,
  38. value: huks.HuksKeyPadding.HUKS_PADDING_PKCS1_V1_5
  39. };
  40. properties[4] = {
  41. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  42. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  43. };
  44. properties[5] = {
  45. tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
  46. value: huks.HuksCipherMode.HUKS_MODE_ECB,
  47. }
  48. try {
  49. await huks.generateKeyItem(keyAlias, options)
  50. .then((data) => {
  51. console.info(`promise: generateKeyItem success`);
  52. })
  53. .catch(error => {
  54. console.error(`promise: generateKeyItem failed, code: ${error.code}, msg: ${error.message}`);
  55. });
  56. } catch (error) {
  57. console.error(`promise: generateKeyItem input arg invalid, code: ${error.code}, msg: ${error.message}`);
  58. }
  59. }
  60. async function huksInit() {
  61. console.log('enter huksInit');
  62. try {
  63. await huks.initSession(keyAlias, options)
  64. .then ((data) => {
  65. console.info(`promise: initSession success, data = ${JSON.stringify(data)}`);
  66. handle = data.handle;
  67. })
  68. .catch(error => {
  69. console.error(`promise: initSession key failed, code: ${error.code}, msg: ${error.message}`);
  70. });
  71. } catch (error) {
  72. console.error(`promise: initSession input arg invalid, code: ${error.code}, msg: ${error.message}`);
  73. }
  74. }
  75. async function huksUpdate() {
  76. console.log('enter huksUpdate');
  77. options.inData = stringToUint8Array("huksHmacTest");
  78. try {
  79. await huks.updateSession(handle, options)
  80. .then ((data) => {
  81. console.info(`promise: updateSession success, data = ${JSON.stringify(data)}`);
  82. })
  83. .catch(error => {
  84. console.error(`promise: updateSession failed, code: ${error.code}, msg: ${error.message}`);
  85. });
  86. } catch (error) {
  87. console.error(`promise: updateSession input arg invalid, code: ${error.code}, msg: ${error.message}`);
  88. }
  89. }
  90. async function huksFinish() {
  91. console.log('enter huksFinish');
  92. options.inData = new Uint8Array(0);
  93. try {
  94. await huks.finishSession(handle, options)
  95. .then ((data) => {
  96. console.info(`promise: finishSession success, data = ${JSON.stringify(data)}`);
  97. })
  98. .catch(error => {
  99. console.error(`promise: finishSession failed, code: ${error.code}, msg: ${error.message}`);
  100. });
  101. } catch (error) {
  102. console.error(`promise: finishSession input arg invalid, code: ${error.code}, msg: ${error.message}`);
  103. }
  104. }
  105. async function huksAbort() {
  106. console.log('enter huksAbort');
  107. try {
  108. await huks.abortSession(handle, options)
  109. .then ((data) => {
  110. console.info(`promise: abortSession success`);
  111. })
  112. .catch(error => {
  113. console.error(`promise: abortSession failed, code: ${error.code}, msg: ${error.message}`);
  114. });
  115. } catch (error) {
  116. console.error(`promise: abortSession input arg invalid, code: ${error.code}, msg: ${error.message}`);
  117. }
  118. }

HuksExceptionErrCode9+

表示错误码的枚举以及对应的错误信息, 错误码表示错误类型,错误信息展示错误详情。

关于错误码的具体信息,可在错误码参考文档中查看。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_ERR_CODE_PERMISSION_FAIL

201

权限错误导致失败。

HUKS_ERR_CODE_ILLEGAL_ARGUMENT

401

参数错误导致失败。

HUKS_ERR_CODE_NOT_SUPPORTED_API

801

不支持的API。

HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED

12000001

不支持的功能/特性。

HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT

12000002

缺少密钥算法参数。

HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT

12000003

无效密钥算法参数。

HUKS_ERR_CODE_FILE_OPERATION_FAIL

12000004

文件操作失败。

HUKS_ERR_CODE_COMMUNICATION_FAIL

12000005

通信失败。

HUKS_ERR_CODE_CRYPTO_FAIL

12000006

算法库操作失败。

HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED

12000007

密钥访问失败-密钥访问失效。

HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED

12000008

密钥访问失败-密钥认证失败。

HUKS_ERR_CODE_KEY_AUTH_TIME_OUT

12000009

密钥访问失败-密钥访问超时。

HUKS_ERR_CODE_SESSION_LIMIT

12000010

密钥操作会话数已达上限。

HUKS_ERR_CODE_ITEM_NOT_EXIST

12000011

目标对象不存在。

HUKS_ERR_CODE_EXTERNAL_ERROR

12000012

外部错误。

HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST

12000013

缺失所需凭据。

HUKS_ERR_CODE_INSUFFICIENT_MEMORY

12000014

内存不足。

HUKS_ERR_CODE_CALL_SERVICE_FAILED

12000015

调用其他系统服务失败。

HuksKeyPurpose

表示密钥用途。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_KEY_PURPOSE_ENCRYPT

1

表示密钥用于对明文进行加密操作。

HUKS_KEY_PURPOSE_DECRYPT

2

表示密钥用于对密文进行解密操作。

HUKS_KEY_PURPOSE_SIGN

4

表示密钥用于对数据进行签名。

HUKS_KEY_PURPOSE_VERIFY

8

表示密钥用于验证签名后的数据。

HUKS_KEY_PURPOSE_DERIVE

16

表示密钥用于派生密钥。

HUKS_KEY_PURPOSE_WRAP

32

表示密钥用于加密导出。

HUKS_KEY_PURPOSE_UNWRAP

64

表示密钥加密导入。

HUKS_KEY_PURPOSE_MAC

128

表示密钥用于生成mac消息验证码。

HUKS_KEY_PURPOSE_AGREE

256

表示密钥用于进行密钥协商。

HuksKeyDigest

表示摘要算法。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_DIGEST_NONE

0

表示无摘要算法。

HUKS_DIGEST_MD5

1

表示MD5摘要算法。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_DIGEST_SM39+

2

表示SM3摘要算法。

HUKS_DIGEST_SHA1

10

表示SHA1摘要算法。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_DIGEST_SHA224

11

表示SHA224摘要算法。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_DIGEST_SHA256

12

表示SHA256摘要算法。

HUKS_DIGEST_SHA384

13

表示SHA384摘要算法。

HUKS_DIGEST_SHA512

14

表示SHA512摘要算法。

HuksKeyPadding

表示补齐算法。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_PADDING_NONE

0

表示不使用补齐算法。

HUKS_PADDING_OAEP

1

表示使用OAEP补齐算法。

HUKS_PADDING_PSS

2

表示使用PSS补齐算法。

HUKS_PADDING_PKCS1_V1_5

3

表示使用PKCS1_V1_5补齐算法。

HUKS_PADDING_PKCS5

4

表示使用PKCS5补齐算法。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_PADDING_PKCS7

5

表示使用PKCS7补齐算法。

HuksCipherMode

表示加密模式。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_MODE_ECB

1

表示使用ECB加密模式。

HUKS_MODE_CBC

2

表示使用CBC加密模式。

HUKS_MODE_CTR

3

表示使用CTR加密模式。

HUKS_MODE_OFB

4

表示使用OFB加密模式。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_MODE_CCM

31

表示使用CCM加密模式。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_MODE_GCM

32

表示使用GCM加密模式。

HuksKeySize

表示密钥长度。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_RSA_KEY_SIZE_512

512

表示使用RSA算法的密钥长度为512bit。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_RSA_KEY_SIZE_768

768

表示使用RSA算法的密钥长度为768bit。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_RSA_KEY_SIZE_1024

1024

表示使用RSA算法的密钥长度为1024bit。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_RSA_KEY_SIZE_2048

2048

表示使用RSA算法的密钥长度为2048bit。

HUKS_RSA_KEY_SIZE_3072

3072

表示使用RSA算法的密钥长度为3072bit。

HUKS_RSA_KEY_SIZE_4096

4096

表示使用RSA算法的密钥长度为4096bit。

HUKS_ECC_KEY_SIZE_224

224

表示使用ECC算法的密钥长度为224bit。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_ECC_KEY_SIZE_256

256

表示使用ECC算法的密钥长度为256bit。

HUKS_ECC_KEY_SIZE_384

384

表示使用ECC算法的密钥长度为384bit。

HUKS_ECC_KEY_SIZE_521

521

表示使用ECC算法的密钥长度为521bit。

HUKS_AES_KEY_SIZE_128

128

表示使用AES算法的密钥长度为128bit。

HUKS_AES_KEY_SIZE_192

192

表示使用AES算法的密钥长度为192bit。

HUKS_AES_KEY_SIZE_256

256

表示使用AES算法的密钥长度为256bit。

HUKS_AES_KEY_SIZE_512

512

表示使用AES算法的密钥长度为512bit。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_CURVE25519_KEY_SIZE_256

256

表示使用CURVE25519算法的密钥长度为256bit。

HUKS_DH_KEY_SIZE_2048

2048

表示使用DH算法的密钥长度为2048bit。

HUKS_DH_KEY_SIZE_3072

3072

表示使用DH算法的密钥长度为3072bit。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_DH_KEY_SIZE_4096

4096

表示使用DH算法的密钥长度为4096bit。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_SM2_KEY_SIZE_2569+

256

表示SM2算法的密钥长度为256bit。

HUKS_SM4_KEY_SIZE_1289+

128

表示SM4算法的密钥长度为128bit。

HuksKeyAlg

表示密钥使用的算法。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_ALG_RSA

1

表示使用RSA算法。

HUKS_ALG_ECC

2

表示使用ECC算法。

HUKS_ALG_DSA

3

表示使用DSA算法。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回12000003错误码。

HUKS_ALG_AES

20

表示使用AES算法。

HUKS_ALG_HMAC

50

表示使用HMAC算法。

HUKS_ALG_HKDF

51

表示使用HKDF算法。

HUKS_ALG_PBKDF2

52

表示使用PBKDF2算法。

HUKS_ALG_ECDH

100

表示使用ECDH算法。

HUKS_ALG_X25519

101

表示使用X25519算法。

HUKS_ALG_ED25519

102

表示使用ED25519算法。

HUKS_ALG_DH

103

表示使用DH算法。

HUKS_ALG_SM29+

150

表示使用SM2算法。

HUKS_ALG_SM39+

151

表示使用SM3算法。

HUKS_ALG_SM49+

152

表示使用SM4算法。

HuksKeyGenerateType

表示生成密钥的类型。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_KEY_GENERATE_TYPE_DEFAULT

0

默认生成的密钥。

HUKS_KEY_GENERATE_TYPE_DERIVE

1

派生生成的密钥。

HUKS_KEY_GENERATE_TYPE_AGREE

2

协商生成的密钥。

HuksKeyFlag

表示密钥的产生方式。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_KEY_FLAG_IMPORT_KEY

1

表示通过导入公钥接口导入的密钥。

HUKS_KEY_FLAG_GENERATE_KEY

2

表示通过生成密钥接口生成的密钥。

HUKS_KEY_FLAG_AGREE_KEY

3

表示通过生成密钥协商接口生成的密钥。

HUKS_KEY_FLAG_DERIVE_KEY

4

表示通过生成密钥派生接口生成的密钥。

HuksKeyStorageType

表示密钥存储方式。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_STORAGE_TEMP

0

表示通过本地直接管理密钥。

HUKS_STORAGE_PERSISTENT

1

表示通过HUKS service管理密钥。

HuksSendType

表示发送Tag的方式。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_SEND_TYPE_ASYNC

0

表示异步发送TAG。

HUKS_SEND_TYPE_SYNC

1

表示同步发送TAG。

HuksUnwrapSuite9+

表示导入加密密钥的算法套件。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_UNWRAP_SUITE_X25519_AES_256_GCM_NOPADDING

1

导入加密密钥时,X25519密钥协商后使用AES-256 GCM加密。

HUKS_UNWRAP_SUITE_ECDH_AES_256_GCM_NOPADDING

2

导入加密密钥时,ECDH密钥协商后使用AES-256 GCM加密。

HuksImportKeyType9+

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

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_KEY_TYPE_PUBLIC_KEY

0

表示导入的密钥类型为公钥。

HUKS_KEY_TYPE_PRIVATE_KEY

1

表示导入的密钥类型为私钥。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回401错误码。

HUKS_KEY_TYPE_KEY_PAIR

2

表示导入的密钥类型为公私钥对。

HuksUserAuthType9+

表示用户认证类型。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_USER_AUTH_TYPE_FINGERPRINT

1 << 0

表示用户认证类型为指纹。

HUKS_USER_AUTH_TYPE_FACE

1 << 1

表示用户认证类型为人脸 。

HUKS_USER_AUTH_TYPE_PIN

1 << 2

表示用户认证类型为PIN码。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回801错误码。

HuksAuthAccessType9+

表示安全访问控制类型。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_AUTH_ACCESS_INVALID_CLEAR_PASSWORD

1 << 0

表示安全访问控制类型为清除密码后密钥无效。

HUKS_AUTH_ACCESS_INVALID_NEW_BIO_ENROLL

1 << 1

表示安全访问控制类型为新录入生物特征后密钥无效。

HuksChallengeType9+

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

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_CHALLENGE_TYPE_NORMAL

0

表示challenge为普通类型,默认32字节。

HUKS_CHALLENGE_TYPE_CUSTOM

1

表示challenge为用户自定义类型。支持使用多个密钥仅一次认证。

HUKS_CHALLENGE_TYPE_NONE

2

表示免challenge类型。

HuksChallengePosition9+

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

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_CHALLENGE_POS_0

0

表示0~7字节为当前密钥的有效challenge。

HUKS_CHALLENGE_POS_1

1

表示8~15字节为当前密钥的有效challenge。

HUKS_CHALLENGE_POS_2

2

表示16~23字节为当前密钥的有效challenge。

HUKS_CHALLENGE_POS_3

3

表示24~31字节为当前密钥的有效challenge。

HuksSecureSignType9+

表示生成或导入密钥时,指定该密钥的签名类型。

说明

当前HarmonyOS设备均不支持该接口,应用调用时将返回801错误码。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_SECURE_SIGN_WITH_AUTHINFO

1

表示签名类型为携带认证信息。生成或导入密钥时指定该字段,则在使用密钥进行签名时,对待签名的数据添加认证信息后进行签名。

HuksTagType

表示Tag的数据类型。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_TAG_TYPE_INVALID

0 << 28

表示非法的Tag类型。

HUKS_TAG_TYPE_INT

1 << 28

表示该Tag的数据类型为int类型的number。

HUKS_TAG_TYPE_UINT

2 << 28

表示该Tag的数据类型为uint类型的number。

HUKS_TAG_TYPE_ULONG

3 << 28

表示该Tag的数据类型为bigint。

HUKS_TAG_TYPE_BOOL

4 << 28

表示该Tag的数据类型为boolean。

HUKS_TAG_TYPE_BYTES

5 << 28

表示该Tag的数据类型为Uint8Array。

HuksTag

表示调用参数的Tag。

系统能力:SystemCapability.Security.Huks

名称

说明

HUKS_TAG_INVALID

HuksTagType.HUKS_TAG_TYPE_INVALID | 0

表示非法的Tag。

HUKS_TAG_ALGORITHM

HuksTagType.HUKS_TAG_TYPE_UINT | 1

表示算法的Tag。

HUKS_TAG_PURPOSE

HuksTagType.HUKS_TAG_TYPE_UINT | 2

表示密钥用途的Tag。

HUKS_TAG_KEY_SIZE

HuksTagType.HUKS_TAG_TYPE_UINT | 3

表示密钥长度的Tag。

HUKS_TAG_DIGEST

HuksTagType.HUKS_TAG_TYPE_UINT | 4

表示摘要算法的Tag。

HUKS_TAG_PADDING

HuksTagType.HUKS_TAG_TYPE_UINT | 5

表示补齐算法的Tag。

HUKS_TAG_BLOCK_MODE

HuksTagType.HUKS_TAG_TYPE_UINT | 6

表示加密模式的Tag。

HUKS_TAG_KEY_TYPE

HuksTagType.HUKS_TAG_TYPE_UINT | 7

表示密钥类型的Tag。

HUKS_TAG_ASSOCIATED_DATA

HuksTagType.HUKS_TAG_TYPE_BYTES | 8

表示附加身份验证数据的Tag。

HUKS_TAG_NONCE

HuksTagType.HUKS_TAG_TYPE_BYTES | 9

表示密钥加解密的字段。

HUKS_TAG_IV

HuksTagType.HUKS_TAG_TYPE_BYTES | 10

表示密钥初始化的向量。

HUKS_TAG_INFO

HuksTagType.HUKS_TAG_TYPE_BYTES | 11

表示密钥派生时的info。

HUKS_TAG_SALT

HuksTagType.HUKS_TAG_TYPE_BYTES | 12

表示密钥派生时的盐值。

HUKS_TAG_PWD

HuksTagType.HUKS_TAG_TYPE_BYTES | 13

表示密钥派生时的password。

HUKS_TAG_ITERATION

HuksTagType.HUKS_TAG_TYPE_UINT | 14

表示密钥派生时的迭代次数。

HUKS_TAG_KEY_GENERATE_TYPE

HuksTagType.HUKS_TAG_TYPE_UINT | 15

表示生成密钥类型的Tag。

HUKS_TAG_DERIVE_MAIN_KEY

HuksTagType.HUKS_TAG_TYPE_BYTES | 16

表示密钥派生时的主密钥。

HUKS_TAG_DERIVE_FACTOR

HuksTagType.HUKS_TAG_TYPE_BYTES | 17

表示密钥派生时的派生因子。

HUKS_TAG_DERIVE_ALG

HuksTagType.HUKS_TAG_TYPE_UINT | 18

表示密钥派生时的算法类型。

HUKS_TAG_AGREE_ALG

HuksTagType.HUKS_TAG_TYPE_UINT | 19

表示密钥协商时的算法类型。

HUKS_TAG_AGREE_PUBLIC_KEY_IS_KEY_ALIAS

HuksTagType.HUKS_TAG_TYPE_BOOL | 20

表示密钥协商时的公钥别名。

HUKS_TAG_AGREE_PRIVATE_KEY_ALIAS

HuksTagType.HUKS_TAG_TYPE_BYTES | 21

表示密钥协商时的私钥别名。

HUKS_TAG_AGREE_PUBLIC_KEY

HuksTagType.HUKS_TAG_TYPE_BYTES | 22

表示密钥协商时的公钥。

HUKS_TAG_KEY_ALIAS

HuksTagType.HUKS_TAG_TYPE_BYTES | 23

表示密钥别名。

HUKS_TAG_DERIVE_KEY_SIZE

HuksTagType.HUKS_TAG_TYPE_UINT | 24

表示派生密钥的大小。

HUKS_TAG_IMPORT_KEY_TYPE9+

HuksTagType.HUKS_TAG_TYPE_UINT | 25

表示导入的密钥类型。

HUKS_TAG_UNWRAP_ALGORITHM_SUITE9+

HuksTagType.HUKS_TAG_TYPE_UINT | 26

表示导入加密密钥的套件。

HUKS_TAG_ACTIVE_DATETIME(deprecated)

HuksTagType.HUKS_TAG_TYPE_ULONG | 201

原为证书业务预留字段,当前证书管理已独立,此字段废弃,不再预留。

HUKS_TAG_ORIGINATION_EXPIRE_DATETIME(deprecated)

HuksTagType.HUKS_TAG_TYPE_ULONG | 202

原为证书业务预留字段,当前证书管理已独立,此字段废弃,不再预留。

HUKS_TAG_USAGE_EXPIRE_DATETIME(deprecated)

HuksTagType.HUKS_TAG_TYPE_ULONG | 203

原为证书业务预留字段,当前证书管理已独立,此字段废弃,不再预留。

HUKS_TAG_CREATION_DATETIME(deprecated)

HuksTagType.HUKS_TAG_TYPE_ULONG | 204

原为证书业务预留字段,当前证书管理已独立,此字段废弃,不再预留。

HUKS_TAG_ALL_USERS

HuksTagType.HUKS_TAG_TYPE_BOOL | 301

预留字段。

HUKS_TAG_USER_ID

HuksTagType.HUKS_TAG_TYPE_UINT | 302

表示当前密钥属于哪个userID。

HUKS_TAG_NO_AUTH_REQUIRED

HuksTagType.HUKS_TAG_TYPE_BOOL | 303

预留字段。

HUKS_TAG_USER_AUTH_TYPE

HuksTagType.HUKS_TAG_TYPE_UINT | 304

表示用户认证类型。从HuksUserAuthType中选择,需要与安全访问控制类型同时设置。支持同时指定两种用户认证类型,如:安全访问控制类型指定为HUKS_SECURE_ACCESS_INVALID_NEW_BIO_ENROLL时,密钥访问认证类型可以指定以下三种: HUKS_USER_AUTH_TYPE_FACE 、HUKS_USER_AUTH_TYPE_FINGERPRINT、HUKS_USER_AUTH_TYPE_FACE | HUKS_USER_AUTH_TYPE_FINGERPRINT

HUKS_TAG_AUTH_TIMEOUT

HuksTagType.HUKS_TAG_TYPE_UINT | 305

表示authtoken单次有效期。

HUKS_TAG_AUTH_TOKEN

HuksTagType.HUKS_TAG_TYPE_BYTES | 306

用于传入authToken的字段。

HUKS_TAG_KEY_AUTH_ACCESS_TYPE9+

HuksTagType.HUKS_TAG_TYPE_UINT | 307

表示安全访问控制类型。从HuksAuthAccessType中选择,需要和用户认证类型同时设置。

HUKS_TAG_KEY_SECURE_SIGN_TYPE9+

HuksTagType.HUKS_TAG_TYPE_UINT | 308

表示生成或导入密钥时,指定该密钥的签名类型。

HUKS_TAG_CHALLENGE_TYPE9+

HuksTagType.HUKS_TAG_TYPE_UINT | 309

表示密钥使用时生成的challenge类型。从HuksChallengeType中选择

HUKS_TAG_CHALLENGE_POS9+

HuksTagType.HUKS_TAG_TYPE_UINT | 310

表示challenge类型为用户自定义类型时,huks产生的challenge有效长度仅为8字节连续的数据。从HuksChallengePosition中选择。

HUKS_TAG_ATTESTATION_CHALLENGE

HuksTagType.HUKS_TAG_TYPE_BYTES | 501

表示attestation时的挑战值。

HUKS_TAG_ATTESTATION_APPLICATION_ID

HuksTagType.HUKS_TAG_TYPE_BYTES | 502

表示attestation时拥有该密钥的application的Id。

HUKS_TAG_ATTESTATION_ID_BRAND

HuksTagType.HUKS_TAG_TYPE_BYTES | 503

表示设备的品牌。

HUKS_TAG_ATTESTATION_ID_DEVICE

HuksTagType.HUKS_TAG_TYPE_BYTES | 504

表示设备的设备ID。

HUKS_TAG_ATTESTATION_ID_PRODUCT

HuksTagType.HUKS_TAG_TYPE_BYTES | 505

表示设备的产品名。

HUKS_TAG_ATTESTATION_ID_SERIAL

HuksTagType.HUKS_TAG_TYPE_BYTES | 506

表示设备的SN号。

HUKS_TAG_ATTESTATION_ID_IMEI

HuksTagType.HUKS_TAG_TYPE_BYTES | 507

表示设备的IMEI号。

HUKS_TAG_ATTESTATION_ID_MEID

HuksTagType.HUKS_TAG_TYPE_BYTES | 508

表示设备的MEID号。

HUKS_TAG_ATTESTATION_ID_MANUFACTURER

HuksTagType.HUKS_TAG_TYPE_BYTES | 509

表示设备的制造商。

HUKS_TAG_ATTESTATION_ID_MODEL

HuksTagType.HUKS_TAG_TYPE_BYTES | 510

表示设备的型号。

HUKS_TAG_ATTESTATION_ID_ALIAS

HuksTagType.HUKS_TAG_TYPE_BYTES | 511

表示attestation时的密钥别名。

HUKS_TAG_ATTESTATION_ID_SOCID

HuksTagType.HUKS_TAG_TYPE_BYTES | 512

表示设备的SOCID。

HUKS_TAG_ATTESTATION_ID_UDID

HuksTagType.HUKS_TAG_TYPE_BYTES | 513

表示设备的UDID。

HUKS_TAG_ATTESTATION_ID_SEC_LEVEL_INFO

HuksTagType.HUKS_TAG_TYPE_BYTES | 514

表示attestation时的安全凭据。

HUKS_TAG_ATTESTATION_ID_VERSION_INFO

HuksTagType.HUKS_TAG_TYPE_BYTES | 515

表示attestation时的版本号。

HUKS_TAG_IS_KEY_ALIAS

HuksTagType.HUKS_TAG_TYPE_BOOL | 1001

表示是否使用生成key时传入的别名的Tag。

HUKS_TAG_KEY_STORAGE_FLAG

HuksTagType.HUKS_TAG_TYPE_UINT | 1002

表示密钥存储方式的Tag。

HUKS_TAG_IS_ALLOWED_WRAP

HuksTagType.HUKS_TAG_TYPE_BOOL | 1003

预留字段。

HUKS_TAG_KEY_WRAP_TYPE

HuksTagType.HUKS_TAG_TYPE_UINT | 1004

预留字段。

HUKS_TAG_KEY_AUTH_ID

HuksTagType.HUKS_TAG_TYPE_BYTES | 1005

预留字段。

HUKS_TAG_KEY_ROLE

HuksTagType.HUKS_TAG_TYPE_UINT | 1006

预留字段。

HUKS_TAG_KEY_FLAG

HuksTagType.HUKS_TAG_TYPE_UINT | 1007

表示密钥标志的Tag。

HUKS_TAG_IS_ASYNCHRONIZED

HuksTagType.HUKS_TAG_TYPE_UINT | 1008

预留字段。

HUKS_TAG_SECURE_KEY_ALIAS

HuksTagType.HUKS_TAG_TYPE_BOOL | 1009

用于传入GCM模式中的AEAD数据的字段。

HUKS_TAG_SECURE_KEY_UUID

HuksTagType.HUKS_TAG_TYPE_BYTES | 1010

预留字段。

HUKS_TAG_KEY_DOMAIN

HuksTagType.HUKS_TAG_TYPE_UINT | 1011

预留字段。

HUKS_TAG_PROCESS_NAME

HuksTagType.HUKS_TAG_TYPE_BYTES | 10001

表示进程名称的Tag。

HUKS_TAG_PACKAGE_NAME

HuksTagType.HUKS_TAG_TYPE_BYTES | 10002

预留字段。

HUKS_TAG_ACCESS_TIME

HuksTagType.HUKS_TAG_TYPE_UINT | 10003

预留字段。

HUKS_TAG_USES_TIME

HuksTagType.HUKS_TAG_TYPE_UINT | 10004

预留字段。

HUKS_TAG_CRYPTO_CTX

HuksTagType.HUKS_TAG_TYPE_ULONG | 10005

预留字段。

HUKS_TAG_KEY

HuksTagType.HUKS_TAG_TYPE_BYTES | 10006

预留字段。

HUKS_TAG_KEY_VERSION

HuksTagType.HUKS_TAG_TYPE_UINT | 10007

表示密钥版本的Tag。

HUKS_TAG_PAYLOAD_LEN

HuksTagType.HUKS_TAG_TYPE_UINT | 10008

预留字段。

HUKS_TAG_AE_TAG

HuksTagType.HUKS_TAG_TYPE_BYTES | 10009

预留字段。

HUKS_TAG_IS_KEY_HANDLE

HuksTagType.HUKS_TAG_TYPE_ULONG | 10010

预留字段。

HUKS_TAG_OS_VERSION

HuksTagType.HUKS_TAG_TYPE_UINT | 10101

表示操作系统版本的Tag。

HUKS_TAG_OS_PATCHLEVEL

HuksTagType.HUKS_TAG_TYPE_UINT | 10102

表示操作系统补丁级别的Tag。

HUKS_TAG_SYMMETRIC_KEY_DATA

HuksTagType.HUKS_TAG_TYPE_BYTES | 20001

预留字段。

HUKS_TAG_ASYMMETRIC_PUBLIC_KEY_DATA

HuksTagType.HUKS_TAG_TYPE_BYTES | 20002

预留字段。

HUKS_TAG_ASYMMETRIC_PRIVATE_KEY_DATA

HuksTagType.HUKS_TAG_TYPE_BYTES | 20003

预留字段。

huks.generateKey(deprecated)

generateKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksResult>) : void

生成密钥,使用Callback回调异步返回结果。

说明

从API Version 9开始废弃,建议使用huks.generateKeyItem替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

别名。

options

HuksOptions

用于存放生成key所需TAG。

callback

AsyncCallback<HuksResult>

回调函数。返回HUKS_SUCCESS时表示接口使用成功,其余结果请参考HuksResult进行错误码查询。

示例:

  1. /* 以生成RSA2048密钥为例 */
  2. let keyAlias = 'keyAlias';
  3. let properties = new Array();
  4. properties[0] = {
  5. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  6. value: huks.HuksKeyAlg.HUKS_ALG_RSA
  7. };
  8. properties[1] = {
  9. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  10. value: huks.HuksKeySize.HUKS_RSA_KEY_SIZE_2048
  11. };
  12. properties[2] = {
  13. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  14. value:
  15. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT |
  16. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_DECRYPT
  17. };
  18. properties[3] = {
  19. tag: huks.HuksTag.HUKS_TAG_PADDING,
  20. value: huks.HuksKeyPadding.HUKS_PADDING_OAEP
  21. };
  22. properties[4] = {
  23. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  24. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  25. };
  26. let options = {
  27. properties: properties
  28. };
  29. huks.generateKey(keyAlias, options, function (err, data){});

huks.generateKey(deprecated)

generateKey(keyAlias: string, options: HuksOptions) : Promise<HuksResult>

生成密钥,使用Promise方式异步返回结果。

说明

从API Version 9开始废弃,建议使用huks.generateKeyItem替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名。

options

HuksOptions

用于存放生成key所需TAG。

返回值

类型

说明

Promise<HuksResult>

Promise对象。返回HUKS_SUCCESS时表示接口使用成功,其他时为错误。

示例:

  1. /* 以生成ECC256密钥为例 */
  2. let keyAlias = 'keyAlias';
  3. let properties = new Array();
  4. properties[0] = {
  5. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  6. value: huks.HuksKeyAlg.HUKS_ALG_ECC
  7. };
  8. properties[1] = {
  9. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  10. value: huks.HuksKeySize.HUKS_ECC_KEY_SIZE_256
  11. };
  12. properties[2] = {
  13. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  14. value:
  15. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_SIGN |
  16. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_VERIFY
  17. };
  18. properties[3] = {
  19. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  20. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  21. };
  22. let options = {
  23. properties: properties
  24. };
  25. let result = huks.generateKey(keyAlias, options);

huks.deleteKey(deprecated)

deleteKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksResult>) : void

删除密钥,使用Callback回调异步返回结果。

说明

从API Version 9开始废弃,建议使用huks.deleteKeyItem替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应为生成key时传入的别名。

options

HuksOptions

空对象(此处传空即可)。

callback

AsyncCallback<HuksResult>

回调函数。返回HUKS_SUCCESS时表示接口使用成功,其他时为错误。

示例:

  1. /* 此处options选择emptyOptions传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. huks.deleteKey(keyAlias, emptyOptions, function (err, data) {});

huks.deleteKey(deprecated)

deleteKey(keyAlias: string, options: HuksOptions) : Promise<HuksResult>

删除密钥,使用Promise方式异步返回结果。

说明

从API Version 9开始废弃,建议使用huks.deleteKeyItem替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应为生成key时传入的别名。

options

HuksOptions

空对象(此处传空即可)。

返回值:

类型

说明

Promise<HuksResult>

Promise对象。返回HUKS_SUCCESS时表示接口使用成功,其他时为错误。

示例:

  1. /* 此处options选择emptyOptions传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. let result = huks.deleteKey(keyAlias, emptyOptions);

huks.importKey(deprecated)

importKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksResult>) : void

导入明文密钥,使用Callback方式回调异步返回结果 。

说明

从API Version 9开始废弃,建议使用huks.importKeyItem替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名。

options

HuksOptions

用于导入时所需TAG和需要导入的密钥。

callback

AsyncCallback<HuksResult>

回调函数。返回HUKS_SUCCESS时表示接口使用成功,其他时为错误。

示例:

  1. /* 以导入AES256密钥为例 */
  2. let plainTextSize32 = makeRandomArr(32);
  3. function makeRandomArr(size) {
  4. let arr = new Uint8Array(size);
  5. for (let i = 0; i < size; i++) {
  6. arr[i] = Math.floor(Math.random() * 10);
  7. }
  8. return arr;
  9. };
  10. let keyAlias = 'keyAlias';
  11. let properties = new Array();
  12. properties[0] = {
  13. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  14. value: huks.HuksKeyAlg.HUKS_ALG_AES
  15. };
  16. properties[1] = {
  17. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  18. value: huks.HuksKeySize.HUKS_AES_KEY_SIZE_256
  19. };
  20. properties[2] = {
  21. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  22. value:
  23. huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT | huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_DECRYPT
  24. };
  25. properties[3] = {
  26. tag: huks.HuksTag.HUKS_TAG_PADDING,
  27. value:huks.HuksKeyPadding.HUKS_PADDING_PKCS7
  28. };
  29. properties[4] = {
  30. tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
  31. value: huks.HuksCipherMode.HUKS_MODE_CBC
  32. };
  33. let options = {
  34. properties: properties,
  35. inData: plainTextSize32
  36. };
  37. huks.importKey(keyAlias, options, function (err, data){});

huks.importKey(deprecated)

importKey(keyAlias: string, options: HuksOptions) : Promise<HuksResult>

导入明文密钥,使用Promise方式异步返回结果。

说明

从API Version 9开始废弃,建议使用huks.importKeyItem替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名。

options

HuksOptions

用于导入时所需TAG和需要导入的密钥。

返回值:

类型

说明

Promise<HuksResult>

Promise对象。返回HUKS_SUCCESS时表示接口使用成功,其他时为错误。

示例:

  1. /* 以导入AES128为例 */
  2. let plainTextSize32 = makeRandomArr(32);
  3. function makeRandomArr(size) {
  4. let arr = new Uint8Array(size);
  5. for (let i = 0; i < size; i++) {
  6. arr[i] = Math.floor(Math.random() * 10);
  7. }
  8. return arr;
  9. };
  10. /*第一步:生成密钥*/
  11. let keyAlias = 'keyAlias';
  12. let properties = new Array();
  13. properties[0] = {
  14. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  15. value: huks.HuksKeyAlg.HUKS_ALG_AES
  16. };
  17. properties[1] = {
  18. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  19. value: huks.HuksKeySize.HUKS_AES_KEY_SIZE_128
  20. };
  21. properties[2] = {
  22. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  23. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT | huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_DECRYPT
  24. };
  25. properties[3] = {
  26. tag: huks.HuksTag.HUKS_TAG_PADDING,
  27. value:huks.HuksKeyPadding.HUKS_PADDING_PKCS7
  28. };
  29. properties[4] = {
  30. tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
  31. value: huks.HuksCipherMode.HUKS_MODE_CBC
  32. };
  33. let huksoptions = {
  34. properties: properties,
  35. inData: plainTextSize32
  36. };
  37. let result = huks.importKey(keyAlias, huksoptions);

huks.exportKey(deprecated)

exportKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksResult>) : void

导出密钥,使用Callback方式回调异步返回的结果。

说明

从API Version 9开始废弃,建议使用huks.exportKeyItem替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应与所用密钥生成时使用的别名相同。

options

HuksOptions

空对象(此处传空即可)。

callback

AsyncCallback<HuksResult>

回调函数。返回HUKS_SUCCESS时表示接口使用成功,其他时为错误。outData:返回从密钥中导出的公钥。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. huks.exportKey(keyAlias, emptyOptions, function (err, data){});

huks.exportKey(deprecated)

exportKey(keyAlias: string, options: HuksOptions) : Promise<HuksResult>

导出密钥,使用Promise方式回调异步返回的结果。

说明

从API Version 9开始废弃,建议使用huks.exportKeyItem替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应与所用密钥生成时使用的别名相同。

options

HuksOptions

空对象(此处传空即可)。

返回值:

类型

说明

Promise<HuksResult>

Promise对象。返回HUKS_SUCCESS时表示接口使用成功,其他时为错误。outData:返回从密钥中导出的公钥。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. let result = huks.exportKey(keyAlias, emptyOptions);

huks.getKeyProperties(deprecated)

getKeyProperties(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksResult>) : void

获取密钥属性,使用Callback回调异步返回结果。

说明

从API Version 9开始废弃,建议使用huks.getKeyItemProperties替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应与所用密钥生成时使用的别名相同。

options

HuksOptions

空对象(此处传空即可)。

callback

AsyncCallback<HuksResult>

回调函数。errorCode:返回HUKS_SUCCESS时表示接口使用成功,其他时为错误。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. huks.getKeyProperties(keyAlias, emptyOptions, function (err, data){});

huks.getKeyProperties(deprecated)

getKeyProperties(keyAlias: string, options: HuksOptions) : Promise<HuksResult>

获取密钥属性,使用Promise回调异步返回结果。

说明

从API Version 9开始废弃,建议使用huks.getKeyItemProperties替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

密钥别名,应与所用密钥生成时使用的别名相同。

options

HuksOptions

空对象(此处传空即可)。

返回值:

类型

说明

Promise<HuksResult>

Promise对象。errorCode:返回HUKS_SUCCESS时表示接口使用成功,其他时为错误。properties:返回值为生成密钥时所需参数。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. let result = huks.getKeyProperties(keyAlias, emptyOptions);

huks.isKeyExist(deprecated)

isKeyExist(keyAlias: string, options: HuksOptions, callback: AsyncCallback<boolean>) : void

判断密钥是否存在,使用Callback回调异步返回结果 。

说明

从API Version 9开始废弃,建议使用huks.isKeyItemExist替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

所需查找的密钥的别名。

options

HuksOptions

空对象(此处传空即可)。

callback

AsyncCallback<boolean>

回调函数。FALSE代表密钥不存在,TRUE代表密钥存在。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. huks.isKeyExist(keyAlias, emptyOptions, function (err, data){});

huks.isKeyExist(deprecated)

isKeyExist(keyAlias: string, options: HuksOptions) : Promise<boolean>

判断密钥是否存在,使用Promise回调异步返回结果 。

说明

从API Version 9开始废弃,建议使用huks.isKeyItemExist替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

所需查找的密钥的别名。

options

HuksOptions

空对象(此处传空即可)。

返回值:

类型

说明

Promise<boolean>

Promise对象。FALSE代表密钥不存在,TRUE代表密钥存在。

示例:

  1. /* 此处options选择emptyOptions来传空 */
  2. let keyAlias = 'keyAlias';
  3. let emptyOptions = {
  4. properties: []
  5. };
  6. let result = huks.isKeyExist(keyAlias, emptyOptions);

huks.init(deprecated)

init(keyAlias: string, options: HuksOptions, callback: AsyncCallback<HuksHandle>) : void

init操作密钥接口,使用Callback回调异步返回结果。huks.init, huks.update, huks.finish为三段式接口,需要一起使用。

说明

从API Version 9开始废弃,建议使用huks.initSession替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

Init操作密钥的别名。

options

HuksOptions

Init操作的参数集合。

callback

AsyncCallback<HuksHandle>

回调函数。将Init操作操作返回的handle添加到密钥管理系统的回调。

huks.init(deprecated)

init(keyAlias: string, options: HuksOptions) : Promise<HuksHandle>

init操作密钥接口,使用Promise方式异步返回结果。huks.init, huks.update, huks.finish为三段式接口,需要一起使用。

说明

从API Version 9开始废弃,建议使用huks.initSession替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

keyAlias

string

Init操作密钥的别名。

options

HuksOptions

Init参数集合。

返回值

类型

说明

Promise<HuksHandle>

Promise对象。将Init操作返回的handle添加到密钥管理系统的回调。

huks.update(deprecated)

update(handle: number, token?: Uint8Array, options: HuksOptions, callback: AsyncCallback<HuksResult>) : void

update操作密钥接口,使用Callback回调异步返回结果。huks.init, huks.update, huks.finish为三段式接口,需要一起使用。

说明

从API Version 9开始废弃,建议使用huks.updateSession替代。

系统能力: SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

Update操作的handle。

token

Uint8Array

Update操作的token。

options

HuksOptions

Update操作的参数集合。

callback

AsyncCallback<HuksResult>

回调函数。将Update操作的结果添加到密钥管理系统的回调。

huks.update(deprecated)

update(handle: number, token?: Uint8Array, options: HuksOptions) : Promise<HuksResult>;

update操作密钥接口,使用Promise方式异步返回结果。huks.init, huks.update, huks.finish为三段式接口,需要一起使用。

说明

从API Version 9开始废弃,建议使用huks.updateSession替代。

系统能力: SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

Update操作的handle。

token

Uint8Array

Update操作的token。

options

HuksOptions

Update操作的参数集合。

返回值

类型

说明

Promise<HuksResult>

Promise对象。将Update操作的结果添加到密钥管理系统的回调。

huks.finish(deprecated)

finish(handle: number, options: HuksOptions, callback: AsyncCallback<HuksResult>) : void

finish操作密钥接口,使用Callback回调异步返回结果。huks.init, huks.update, huks.finish为三段式接口,需要一起使用。

说明

从API Version 9开始废弃,建议使用huks.finishSession替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

Finish操作的handle。

options

HuksOptions

Finish的参数集合。

callback

AsyncCallback<HuksResult>

回调函数。将Finish操作的结果添加到密钥管理系统的回调。

huks.finish(deprecated)

finish(handle: number, options: HuksOptions) : Promise<HuksResult>

finish操作密钥接口,使用Promise方式异步返回结果。huks.init, huks.update, huks.finish为三段式接口,需要一起使用。

说明

从API Version 9开始废弃,建议使用huks.finishSession替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

Finish操作的handle。

options

HuksOptions

Finish操作的参数集合。

返回值

类型

说明

Promise<HuksResult>

Promise对象,用于获取异步返回结果。

huks.abort(deprecated)

abort(handle: number, options: HuksOptions, callback: AsyncCallback<HuksResult>) : void

abort操作密钥接口,使用Callback回调异步返回结果。

说明

从API Version 9开始废弃,建议使用huks.abortSession替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

Abort操作的handle。

options

HuksOptions

Abort操作的参数集合。

callback

AsyncCallback<HuksResult>

回调函数。将Abort操作的结果添加到密钥管理系统的回调。

示例:

  1. /* huks.init, huks.update, huks.finish为三段式接口,需要一起使用,当huks.init和huks.update
  2. * 以及huks.finish操作中的任一阶段发生错误时,都需要调用huks.abort来终止密钥的使用。
  3. *
  4. * 以下以RSA2048密钥的callback操作使用为例
  5. */
  6. let keyalias = "HuksDemoRSA";
  7. let properties = new Array();
  8. let options = {
  9. properties: properties,
  10. inData: new Uint8Array(0)
  11. };
  12. let handle;
  13. let resultMessage = "";
  14. async function generateKey() {
  15. properties[0] = {
  16. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  17. value: huks.HuksKeyAlg.HUKS_ALG_RSA
  18. };
  19. properties[1] = {
  20. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  21. value: huks.HuksKeySize.HUKS_RSA_KEY_SIZE_2048
  22. };
  23. properties[2] = {
  24. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  25. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT
  26. };
  27. properties[3] = {
  28. tag: huks.HuksTag.HUKS_TAG_PADDING,
  29. value: huks.HuksKeyPadding.HUKS_PADDING_OAEP
  30. };
  31. properties[4] = {
  32. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  33. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  34. };
  35. huks.generateKey(keyalias, options);
  36. }
  37. function stringToUint8Array(str) {
  38. let arr = [];
  39. for (let i = 0, j = str.length; i < j; ++i) {
  40. arr.push(str.charCodeAt(i));
  41. }
  42. let tmpUint8Array = new Uint8Array(arr);
  43. return tmpUint8Array;
  44. }
  45. async function huksInit() {
  46. await huks.init(keyalias, options).then((data) => {
  47. console.log(`test init data: ${JSON.stringify(data)}`);
  48. handle = data.handle;
  49. }).catch((err) => {
  50. console.log("test init err information: " + JSON.stringify(err))
  51. })
  52. }
  53. async function huksUpdate() {
  54. options.inData = stringToUint8Array("huksHmacTest");
  55. await huks.update(handle, options).then((data) => {
  56. if (data.errorCode === 0) {
  57. resultMessage += "update success!";
  58. } else {
  59. resultMessage += "update fail!";
  60. }
  61. });
  62. console.log(resultMessage);
  63. }
  64. function huksFinish() {
  65. options.inData = stringToUint8Array("HuksDemoHMAC");
  66. huks.finish(handle, options).then((data) => {
  67. if (data.errorCode === 0) {
  68. resultMessage = "finish success!";
  69. } else {
  70. resultMessage = "finish fail errorCode: " + data.errorCode;
  71. }
  72. }).catch((err) => {
  73. resultMessage = "finish fail, catch errorMessage:" + JSON.stringify(err)
  74. });
  75. console.log(resultMessage);
  76. }
  77. async function huksAbort() {
  78. huks.abort(handle, options).then((data) => {
  79. if (data.errorCode === 0) {
  80. resultMessage = "abort success!";
  81. } else {
  82. resultMessage = "abort fail errorCode: " + data.errorCode;
  83. }
  84. }).catch((err) => {
  85. resultMessage = "abort fail, catch errorMessage:" + JSON.stringify(err)
  86. });
  87. console.log(resultMessage);
  88. }

huks.abort(deprecated)

abort(handle: number, options: HuksOptions) : Promise<HuksResult>;

abort操作密钥接口,使用Promise方式异步返回结果。

说明

从API Version 9开始废弃,建议使用huks.abortSession替代。

系统能力:SystemCapability.Security.Huks

参数:

参数名

类型

必填

说明

handle

number

Abort操作的handle。

options

HuksOptions

Abort操作的参数集合。

返回值

类型

说明

Promise<HuksResult>

Promise对象。将Abort操作的结果添加到密钥管理系统的回调。

示例:

  1. /* huks.init, huks.update, huks.finish为三段式接口,需要一起使用,当huks.init和huks.update
  2. * 以及huks.finish操作中的任一阶段发生错误时,都需要调用huks.abort来终止密钥的使用。
  3. *
  4. * 以下以RSA2048密钥的promise操作使用为例
  5. */
  6. let keyalias = "HuksDemoRSA";
  7. let properties = new Array();
  8. let options = {
  9. properties: properties,
  10. inData: new Uint8Array(0)
  11. };
  12. let handle;
  13. let resultMessage = "";
  14. function stringToUint8Array(str) {
  15. let arr = [];
  16. for (let i = 0, j = str.length; i < j; ++i) {
  17. arr.push(str.charCodeAt(i));
  18. }
  19. let tmpUint8Array = new Uint8Array(arr);
  20. return tmpUint8Array;
  21. }
  22. async function generateKey() {
  23. properties[0] = {
  24. tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
  25. value: huks.HuksKeyAlg.HUKS_ALG_RSA
  26. };
  27. properties[1] = {
  28. tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
  29. value: huks.HuksKeySize.HUKS_RSA_KEY_SIZE_2048
  30. };
  31. properties[2] = {
  32. tag: huks.HuksTag.HUKS_TAG_PURPOSE,
  33. value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT
  34. };
  35. properties[3] = {
  36. tag: huks.HuksTag.HUKS_TAG_PADDING,
  37. value: huks.HuksKeyPadding.HUKS_PADDING_OAEP
  38. };
  39. properties[4] = {
  40. tag: huks.HuksTag.HUKS_TAG_DIGEST,
  41. value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256
  42. };
  43. huks.generateKey(keyalias, options, function (err, data) { });
  44. }
  45. async function huksInit() {
  46. return new Promise((resolve, reject) => {
  47. huks.init(keyalias, options, async function (err, data) {
  48. if (data.errorCode === 0) {
  49. resultMessage = "init success!"
  50. handle = data.handle;
  51. } else {
  52. resultMessage = "init fail errorCode: " + data.errorCode
  53. }
  54. });
  55. });
  56. }
  57. async function huksUpdate() {
  58. options.inData = stringToUint8Array("huksHmacTest");
  59. new Promise((resolve, reject) => {
  60. huks.update(handle, options, function (err, data) {
  61. if (data.errorCode === 0) {
  62. resultMessage += "update success!";
  63. } else {
  64. resultMessage += "update fail!";
  65. }
  66. });
  67. });
  68. console.log(resultMessage);
  69. }
  70. async function huksFinish() {
  71. options.inData = stringToUint8Array("0");
  72. new Promise((resolve, reject) => {
  73. huks.finish(handle, options, function (err, data) {
  74. if (data.errorCode === 0) {
  75. resultMessage = "finish success!";
  76. } else {
  77. resultMessage = "finish fail errorCode: " + data.errorCode;
  78. }
  79. });
  80. });
  81. }
  82. function huksAbort() {
  83. new Promise((resolve, reject) => {
  84. huks.abort(handle, options, function (err, data) {
  85. console.log(`Huks_Demo hmac huksAbort1 data ${JSON.stringify(data)}`);
  86. console.log(`Huks_Demo hmac huksAbort1 err ${JSON.stringify(err)}`);
  87. });
  88. });
  89. }

HuksHandle(deprecated)

huks Handle结构体。

系统能力:SystemCapability.Security.Huks

说明

从API Version 9开始废弃,建议使用HuksSessionHandle9+替代。

名称

类型

必填

说明

errorCode

number

表示错误码。

handle

number

表示handle值。

token

Uint8Array

表示init操作之后获取到的challenge信息。

HuksResult(deprecated)

调用接口返回的result。

系统能力:SystemCapability.Security.Huks

说明

从API Version 9开始废弃,建议使用HuksReturnResult9+替代。

名称

类型

必填

说明

errorCode

number

表示错误码。

outData

Uint8Array

表示输出数据。

properties

Array<HuksParam>

表示属性信息。

certChains

Array<string>

表示证书链数据。

HuksErrorCode(deprecated)

表示错误码的枚举。

系统能力:SystemCapability.Security.Huks

说明

从API Version 9开始废弃,建议使用HuksExceptionErrCode9+替代。

名称

说明

HUKS_SUCCESS

0

表示成功。

HUKS_FAILURE

-1

表示失败。

HUKS_ERROR_BAD_STATE

-2

表示错误的状态。

HUKS_ERROR_INVALID_ARGUMENT

-3

表示无效的数据。

HUKS_ERROR_NOT_SUPPORTED

-4

表示不支持。

HUKS_ERROR_NO_PERMISSION

-5

表示没有许可。

HUKS_ERROR_INSUFFICIENT_DATA

-6

表示数据不足。

HUKS_ERROR_BUFFER_TOO_SMALL

-7

表示缓冲区太小。

HUKS_ERROR_INSUFFICIENT_MEMORY

-8

表示内存不足。

HUKS_ERROR_COMMUNICATION_FAILURE

-9

表示通讯失败。

HUKS_ERROR_STORAGE_FAILURE

-10

表示存储故障。

HUKS_ERROR_HARDWARE_FAILURE

-11

表示硬件故障。

HUKS_ERROR_ALREADY_EXISTS

-12

表示已经存在。

HUKS_ERROR_NOT_EXIST

-13

表示不存在。

HUKS_ERROR_NULL_POINTER

-14

表示空指针。

HUKS_ERROR_FILE_SIZE_FAIL

-15

表示文件大小失败。

HUKS_ERROR_READ_FILE_FAIL

-16

表示读取文件失败。

HUKS_ERROR_INVALID_PUBLIC_KEY

-17

表示无效的公钥。

HUKS_ERROR_INVALID_PRIVATE_KEY

-18

表示无效的私钥。

HUKS_ERROR_INVALID_KEY_INFO

-19

表示无效的密钥信息。

HUKS_ERROR_HASH_NOT_EQUAL

-20

表示哈希不相等。

HUKS_ERROR_MALLOC_FAIL

-21

表示MALLOC 失败。

HUKS_ERROR_WRITE_FILE_FAIL

-22

表示写文件失败。

HUKS_ERROR_REMOVE_FILE_FAIL

-23

表示删除文件失败。

HUKS_ERROR_OPEN_FILE_FAIL

-24

表示打开文件失败。

HUKS_ERROR_CLOSE_FILE_FAIL

-25

表示关闭文件失败。

HUKS_ERROR_MAKE_DIR_FAIL

-26

表示创建目录失败。

HUKS_ERROR_INVALID_KEY_FILE

-27

表示无效的密钥文件。

HUKS_ERROR_IPC_MSG_FAIL

-28

表示IPC 信息失败。

HUKS_ERROR_REQUEST_OVERFLOWS

-29

表示请求溢出。

HUKS_ERROR_PARAM_NOT_EXIST

-30

表示参数不存在。

HUKS_ERROR_CRYPTO_ENGINE_ERROR

-31

表示CRYPTO ENGINE错误。

HUKS_ERROR_COMMUNICATION_TIMEOUT

-32

表示通讯超时。

HUKS_ERROR_IPC_INIT_FAIL

-33

表示IPC 初始化失败。

HUKS_ERROR_IPC_DLOPEN_FAIL

-34

表示IPC DLOPEN 失败。

HUKS_ERROR_EFUSE_READ_FAIL

-35

表示EFUSE 读取失败。

HUKS_ERROR_NEW_ROOT_KEY_MATERIAL_EXIST

-36

表示存在新的根密钥材料。

HUKS_ERROR_UPDATE_ROOT_KEY_MATERIAL_FAIL

-37

表示更新根密钥材料失败。

HUKS_ERROR_VERIFICATION_FAILED

-38

表示验证证书链失败。

HUKS_ERROR_CHECK_GET_ALG_FAIL

-100

表示检查获取 ALG 失败。

HUKS_ERROR_CHECK_GET_KEY_SIZE_FAIL

-101

表示检查获取密钥大小失败。

HUKS_ERROR_CHECK_GET_PADDING_FAIL

-102

表示检查获取填充失败。

HUKS_ERROR_CHECK_GET_PURPOSE_FAIL

-103

表示检查获取目的失败。

HUKS_ERROR_CHECK_GET_DIGEST_FAIL

-104

表示检查获取摘要失败。

HUKS_ERROR_CHECK_GET_MODE_FAIL

-105

表示检查获取模式失败。

HUKS_ERROR_CHECK_GET_NONCE_FAIL

-106

表示检查获取随机数失败。

HUKS_ERROR_CHECK_GET_AAD_FAIL

-107

表示检查获取 AAD 失败。

HUKS_ERROR_CHECK_GET_IV_FAIL

-108

表示检查 GET IV 失败。

HUKS_ERROR_CHECK_GET_AE_TAG_FAIL

-109

表示检查获取 AE 标记失败。

HUKS_ERROR_CHECK_GET_SALT_FAIL

-110

表示检查获取SALT失败。

HUKS_ERROR_CHECK_GET_ITERATION_FAIL

-111

表示检查获取迭代失败。

HUKS_ERROR_INVALID_ALGORITHM

-112

表示无效的算法。

HUKS_ERROR_INVALID_KEY_SIZE

-113

表示无效的密钥大小。

HUKS_ERROR_INVALID_PADDING

-114

表示无效的填充。

HUKS_ERROR_INVALID_PURPOSE

-115

表示无效的目的。

HUKS_ERROR_INVALID_MODE

-116

表示无效模式。

HUKS_ERROR_INVALID_DIGEST

-117

表示无效的摘要。

HUKS_ERROR_INVALID_SIGNATURE_SIZE

-118

表示签名大小无效。

HUKS_ERROR_INVALID_IV

-119

表示无效的 IV。

HUKS_ERROR_INVALID_AAD

-120

表示无效的 AAD。

HUKS_ERROR_INVALID_NONCE

-121

表示无效的随机数。

HUKS_ERROR_INVALID_AE_TAG

-122

表示无效的 AE 标签。

HUKS_ERROR_INVALID_SALT

-123

表示无效SALT。

HUKS_ERROR_INVALID_ITERATION

-124

表示无效的迭代。

HUKS_ERROR_INVALID_OPERATION

-125

表示无效操作。

HUKS_ERROR_INTERNAL_ERROR

-999

表示内部错误。

HUKS_ERROR_UNKNOWN_ERROR

-1000

表示未知错误。


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号