1# 获取密钥属性(C/C++)
2
3
4HUKS提供了接口供业务获取指定密钥的相关属性。在获取指定密钥属性前，需要确保已在HUKS中生成或导入持久化存储的密钥。
5>**说明：**
6> 轻量级设备不支持获取密钥属性功能。
7
8## 在CMake脚本中链接相关动态库
9```txt
10   target_link_libraries(entry PUBLIC libhuks_ndk.z.so)
11```
12
13## 开发步骤
14
151. 构造对应参数。
16   - keyAlias：密钥别名，封装成[OH_Huks_Blob](../../reference/apis-universal-keystore-kit/_o_h___huks___blob.md)结构，密钥别名最大长度为128字节。
17   - paramSetIn：预留参数，暂不需要处理，传空即可。
18   - paramSetOut：用于放置获取到的参数集结果，为[OH_Huks_ParamSet](../../reference/apis-universal-keystore-kit/_o_h___huks___param_set.md)类型对象，需要业务提前申请好内存，需申请足够容纳获取到的密钥属性集的内存大小。
19
202. 调用接口[OH_Huks_GetKeyItemParamSet](../../reference/apis-universal-keystore-kit/_huks_key_api.md#oh_huks_getkeyitemparamset)，传入上述参数。
21
223. 返回值为成功码/错误码，获取成功后，从参数集中读取需要的参数。
23
24```c++
25#include "huks/native_huks_api.h"
26#include "huks/native_huks_param.h"
27#include <string.h>
28static napi_value GetKeyParamSet(napi_env env, napi_callback_info info)
29{
30    /* 1. 参数构造：确定密钥别名 */
31    const char *alias = "test_key";
32    struct OH_Huks_Blob aliasBlob = { .size = (uint32_t)strlen(alias), .data = (uint8_t *)alias };
33    /* 构造参数：为参数集申请内存 */
34    struct OH_Huks_ParamSet *outParamSet = (struct OH_Huks_ParamSet *)malloc(512); // 请业务按实际情况评估大小进行申请
35    if (outParamSet == nullptr) {
36        return nullptr;
37    }
38    outParamSet->paramSetSize = 512;
39    struct OH_Huks_Result ohResult;
40    do {
41        /* 2. 获取密钥属性集 */
42        ohResult = OH_Huks_GetKeyItemParamSet(&aliasBlob, nullptr, outParamSet);
43        if (ohResult.errorCode != OH_HUKS_SUCCESS) {
44            break;
45        }
46        /* 3. 从参数集中读取参数，以OH_HUKS_TAG_PURPOSE为例 */
47        OH_Huks_Param *purposeParam = nullptr; // 无需申请内存，获取后指针指向该参数在参数集中所处内存地址
48        ohResult = OH_Huks_GetParam(outParamSet, OH_HUKS_TAG_PURPOSE, &purposeParam);
49        if (ohResult.errorCode != OH_HUKS_SUCCESS) {
50            break;
51        }
52    } while (0);
53    OH_Huks_FreeParamSet(&outParamSet);
54    napi_value ret;
55    napi_create_int32(env, ohResult.errorCode, &ret);
56    return ret;
57}
58```
59