• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 获取密钥属性(ArkTS)
2
3HUKS提供了接口供业务获取指定密钥的相关属性。在获取指定密钥属性前,需要确保已在HUKS中生成或导入持久化存储的密钥。
4>**说明:**
5> 轻量级设备不支持获取密钥属性功能。
6
7## 开发步骤
8
91. 指定待查询的密钥别名keyAlias,密钥别名最大长度为128字节。
10
112. 调用接口[getKeyItemProperties](../../reference/apis-universal-keystore-kit/js-apis-huks.md#huksgetkeyitemproperties9),传入参数keyAlias和options。
12   options为预留参数,当前可传入空。
13
143. 返回值为[HuksReturnResult](../../reference/apis-universal-keystore-kit/js-apis-huks.md#huksreturnresult9)类型对象,获取的属性集在properties字段中。
15
16```ts
17import { huks } from '@kit.UniversalKeystoreKit';
18
19/* 1. 设置密钥别名 */
20let keyAlias = 'keyAlias';
21/* option对象传空 */
22let emptyOptions: huks.HuksOptions = {
23  properties: []
24};
25try {
26  /* 2. 获取密钥属性 */
27  huks.getKeyItemProperties(keyAlias, emptyOptions, (error, data) => {
28    if (error) {
29      console.error(`callback: getKeyItemProperties failed, ` + JSON.stringify(error));
30    } else {
31      console.info(`callback: getKeyItemProperties success, data = ${JSON.stringify(data)}`);
32    }
33  });
34} catch (error) {
35  console.error(`callback: getKeyItemProperties input arg invalid, ` + JSON.stringify(error));
36}
37```
38