• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# HMAC(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
10HMAC是密钥相关的哈希运算消息认证码（Hash-based Message Authentication Code）。具体的场景介绍及支持的算法规格，请参考[HMAC介绍及算法规格](huks-hmac-overview.md)。
11
12## 在CMake脚本中链接相关动态库
13```txt
14target_link_libraries(entry PUBLIC libhuks_ndk.z.so)
15```
16
17## 开发步骤
18
19**生成密钥**
20
211. 指定密钥别名，密钥别名命名规范参考[密钥生成介绍及算法规格](huks-key-generation-overview.md)。
22
232. 初始化密钥属性集。
24
253. 调用[OH_Huks_GenerateKeyItem](../../reference/apis-universal-keystore-kit/capi-native-huks-api-h.md#oh_huks_generatekeyitem)生成密钥，HMAC支持的规格请参考[密钥生成支持的算法](huks-key-generation-overview.md#支持的算法)。
26
27除此之外，开发者也可以参考[密钥导入](huks-key-import-overview.md#支持的算法)的规格介绍，导入已有的密钥。
28
29**执行HMAC**
30
311. 获取密钥别名。
32
332. 获取待运算的数据。
34
353. 调用[OH_Huks_InitParamSet](../../reference/apis-universal-keystore-kit/capi-native-huks-param-h.md#oh_huks_initparamset)指定算法参数配置。
36
374. 调用[OH_Huks_InitSession](../../reference/apis-universal-keystore-kit/capi-native-huks-api-h.md#oh_huks_initsession)初始化密钥会话，并获取会话的句柄handle。
38
395. 调用[OH_Huks_FinishSession](../../reference/apis-universal-keystore-kit/capi-native-huks-api-h.md#oh_huks_finishsession)结束密钥会话，获取哈希后的数据。
40
41```c++
42#include "huks/native_huks_api.h"
43#include "huks/native_huks_param.h"
44#include "napi/native_api.h"
45#include <string.h>
46
47OH_Huks_Result InitParamSet(
48    struct OH_Huks_ParamSet **paramSet,
49    const struct OH_Huks_Param *params,
50    uint32_t paramCount)
51{
52    OH_Huks_Result ret = OH_Huks_InitParamSet(paramSet);
53    if (ret.errorCode != OH_HUKS_SUCCESS) {
54        return ret;
55    }
56    ret = OH_Huks_AddParams(*paramSet, params, paramCount);
57    if (ret.errorCode != OH_HUKS_SUCCESS) {
58        OH_Huks_FreeParamSet(paramSet);
59        return ret;
60    }
61    ret = OH_Huks_BuildParamSet(paramSet);
62    if (ret.errorCode != OH_HUKS_SUCCESS) {
63        OH_Huks_FreeParamSet(paramSet);
64        return ret;
65    }
66    return ret;
67}
68
69static struct OH_Huks_Param g_genHmacParams[] = {
70    {
71        .tag = OH_HUKS_TAG_ALGORITHM,
72        .uint32Param = OH_HUKS_ALG_HMAC
73    }, {
74        .tag = OH_HUKS_TAG_PURPOSE,
75        .uint32Param = OH_HUKS_KEY_PURPOSE_MAC
76    }, {
77        .tag = OH_HUKS_TAG_KEY_SIZE,
78        .uint32Param = OH_HUKS_AES_KEY_SIZE_256
79    }, {
80        .tag = OH_HUKS_TAG_DIGEST,
81        .uint32Param = OH_HUKS_DIGEST_SHA384
82    }
83};
84static const uint32_t HMAC_COMMON_SIZE = 1024;
85OH_Huks_Result HksHmacTest(
86    const struct OH_Huks_Blob *keyAlias,
87    const struct OH_Huks_ParamSet *hmacParamSet,
88    const struct OH_Huks_Blob *inData,
89    struct OH_Huks_Blob *hashText)
90{
91    uint8_t handleE[sizeof(uint64_t)] = {0};
92    struct OH_Huks_Blob handle = {sizeof(uint64_t), handleE};
93    OH_Huks_Result ret = OH_Huks_InitSession(keyAlias, hmacParamSet, &handle, nullptr);
94    if (ret.errorCode != OH_HUKS_SUCCESS) {
95        return ret;
96    }
97    ret = OH_Huks_FinishSession(&handle, hmacParamSet, inData, hashText);
98    return ret;
99}
100
101static napi_value HmacKey(napi_env env, napi_callback_info info)
102{
103    /* 1. Generate Key */
104    /*
105     * 模拟生成密钥场景
106     * 1.1. 确定密钥别名
107     */
108    char tmpKeyAlias[] = "test_hmac";
109    struct OH_Huks_Blob keyAlias = {(uint32_t)strlen(tmpKeyAlias), (uint8_t *)tmpKeyAlias};
110    struct OH_Huks_ParamSet *hmacParamSet = nullptr;
111    OH_Huks_Result ohResult;
112    do {
113        /*
114         * 1.2. 获取生成密钥算法参数配置
115         */
116        ohResult = InitParamSet(&hmacParamSet, g_genHmacParams, sizeof(g_genHmacParams) / sizeof(OH_Huks_Param));
117        if (ohResult.errorCode != OH_HUKS_SUCCESS) {
118            break;
119        }
120        /*
121         * 1.3. 调用generateKeyItem
122         */
123        ohResult = OH_Huks_GenerateKeyItem(&keyAlias, hmacParamSet, nullptr);
124        if (ohResult.errorCode != OH_HUKS_SUCCESS) {
125            break;
126        }
127        /* 2. HMAC */
128        /*
129         * 模拟哈希场景
130         * 2.1. 获取密钥别名
131         */
132        /*
133         * 2.2. 获取待哈希的数据
134         */
135        char tmpInData[] = "HMAC_MAC_INDATA_1";
136        struct OH_Huks_Blob inData = {(uint32_t)strlen(tmpInData), (uint8_t *)tmpInData};
137        uint8_t cipher[HMAC_COMMON_SIZE] = {0};
138        struct OH_Huks_Blob hashText = {HMAC_COMMON_SIZE, cipher};
139        /*
140         * 2.3. 调用initSession获取handle
141         */
142        /*
143         * 2.4. 调用finishSession获取哈希后的内容
144         */
145        ohResult = HksHmacTest(&keyAlias, hmacParamSet, &inData, &hashText);
146        if (ohResult.errorCode != OH_HUKS_SUCCESS) {
147            break;
148        }
149    } while (0);
150    OH_Huks_FreeParamSet(&hmacParamSet);
151    napi_value ret;
152    napi_create_int32(env, ohResult.errorCode, &ret);
153    return ret;
154}
155```