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