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