• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Querying Key Aliases (C/C++)
2
3<!--Kit: Universal Keystore Kit-->
4<!--Subsystem: Security-->
5<!--Owner: @wutiantian-gitee-->
6<!--Designer: @HighLowWorld-->
7<!--Tester: @wxy1234564846-->
8<!--Adviser: @zengyawen-->
9
10This topic walks you through on how to query key aliases.
11
12>**NOTE**<br>
13> <!--RP1-->The mini-system devices<!--RP1End--> do not support query of key aliases.
14
15## Add the dynamic library in the CMake script.
16```txt
17target_link_libraries(entry PUBLIC libhuks_ndk.z.so)
18```
19
20## How to Develop
21
221. Initialize the key property set to query the tags of key aliases. The tags support only [OH_HUKS_TAG_AUTH_STORAGE_LEVEL](../../reference/apis-universal-keystore-kit/capi-native-huks-type-h.md#oh_huks_authstoragelevel).
23
242. Call [OH_Huks_ListAliases](../../reference/apis-universal-keystore-kit/capi-native-huks-api-h.md#oh_huks_listaliases) to query key aliases.
25
26 ```c++
27/* Query key aliases. */
28#include "huks/native_huks_api.h"
29#include "huks/native_huks_param.h"
30#include "napi/native_api.h"
31#include <string.h>
32OH_Huks_Result InitParamSet(
33    struct OH_Huks_ParamSet **paramSet,
34    const struct OH_Huks_Param *params,
35    uint32_t paramCount)
36{
37    OH_Huks_Result ret = OH_Huks_InitParamSet(paramSet);
38    if (ret.errorCode != OH_HUKS_SUCCESS) {
39        return ret;
40    }
41    ret = OH_Huks_AddParams(*paramSet, params, paramCount);
42    if (ret.errorCode != OH_HUKS_SUCCESS) {
43        OH_Huks_FreeParamSet(paramSet);
44        return ret;
45    }
46    ret = OH_Huks_BuildParamSet(paramSet);
47    if (ret.errorCode != OH_HUKS_SUCCESS) {
48        OH_Huks_FreeParamSet(paramSet);
49        return ret;
50    }
51    return ret;
52}
53struct OH_Huks_Param g_testQueryParam[] = {
54    {
55        .tag = OH_HUKS_TAG_AUTH_STORAGE_LEVEL,
56        .uint32Param = OH_HUKS_AUTH_STORAGE_LEVEL_DE
57    },
58};
59static napi_value ListAliases(napi_env env, napi_callback_info info)
60{
61    struct OH_Huks_ParamSet *testQueryParamSet = nullptr;
62    struct OH_Huks_KeyAliasSet *outData = nullptr;
63    struct OH_Huks_Result ohResult;
64    do {
65        /* 1. Initialize the key property set. */
66        ohResult = InitParamSet(&testQueryParamSet, g_testQueryParam,
67            sizeof(g_testQueryParam) / sizeof(OH_Huks_Param));
68        if (ohResult.errorCode != OH_HUKS_SUCCESS) {
69            break;
70        }
71        /* 2. Query key aliases. */
72        ohResult = OH_Huks_ListAliases(testQueryParamSet, &outData);
73    } while (0);
74
75    OH_Huks_FreeParamSet(&testQueryParamSet);
76    OH_Huks_FreeKeyAliasSet(outData);
77    napi_value ret;
78    napi_create_int32(env, ohResult.errorCode, &ret);
79    return ret;
80}
81```
82