• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 消息认证码计算
2
3
4MAC（Message Authentication Code，消息认证码）可以对消息进行完整性校验，通过使用双方共享的密钥，识别出信息伪装篡改等行为。
5
6
7HMAC（Hash-based Message Authentication Code）是一种基于哈希的消息认证码算法。
8
9
10HMAC通过指定摘要算法，以通信双方共享密钥与消息作为输入，生成消息认证码用于检验传递报文的完整性。HMAC在消息摘要算法的基础上增加了密钥的输入，确保了信息的正确性。生成的消息认证码为固定长度。
11
12
13## 支持的算法与规格
14
15当创建HMAC消息认证码时，需要使用表中“支持种类”一列，指定HMAC消息认证码算法规格。
16
17| 摘要算法 | 支持种类 | API版本 |
18| -------- | -------- | -------- |
19| HASH | SHA1 | 9+ |
20| HASH | SHA224 | 9+ |
21| HASH | SHA256 | 9+ |
22| HASH | SHA384 | 9+ |
23| HASH | SHA512 | 9+ |
24| HASH | SM3 | 10+ |
25
26
27## 开发步骤
28
29在调用update接口传入数据时，可以[一次性传入所有数据](#hmac一次性传入)，也可以把数据人工分段，然后[分段update](#分段hmac)。对于同一段数据而言，是否分段，计算结果没有差异。对于数据量较大的数据，开发者可以根据实际需求选择是否分段传入。
30
31下面分别提供两种方式的示例代码。
32
33
34### HMAC（一次性传入）
35
361. 调用[cryptoFramework.createMac](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatemac)，指定摘要算法SHA256，生成消息认证码操作实例（Mac）。
37
382. 调用[cryptoFramework.createSymKeyGenerator](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatesymkeygenerator)、[SymKeyGenerator.convertKey](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#convertkey-1)，生成密钥算法为AES、长度为128位的对称密钥（SymKey）。
39   生成对称密钥的详细开发指导，请参考[指定二进制数据生成对称密钥](crypto-convert-binary-data-to-sym-key.md)。
40
413. 调用[Mac.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-6)，指定共享对称密钥（SymKey），初始化Mac对象。
42
434. 调用[Mac.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-8)，传入自定义消息，进行消息认证码计算。单次update长度没有限制。
44
455. 调用[Mac.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-2)，获取Mac计算结果。
46
476. 调用[Mac.getMacLength](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getmaclength)，获取Mac消息认证码的长度，单位为字节。
48
49以使用await方式一次性传入数据，获取消息认证码计算结果为例：
50
51```ts
52import cryptoFramework from '@ohos.security.cryptoFramework';
53import buffer from '@ohos.buffer';
54
55async function genSymKeyByData(symKeyData: Uint8Array) {
56  let symKeyBlob: cryptoFramework.DataBlob = { data: symKeyData };
57  let aesGenerator = cryptoFramework.createSymKeyGenerator('AES128');
58  let symKey = await aesGenerator.convertKey(symKeyBlob);
59  console.info('convertKey success');
60  return symKey;
61}
62async function doHmac() {
63  // 把字符串按utf-8解码为Uint8Array，使用固定的128位的密钥，即16字节
64  let keyData = new Uint8Array(buffer.from("12345678abcdefgh", 'utf-8').buffer);
65  let key = await genSymKeyByData(keyData);
66  let macAlgName = 'SHA256'; // 摘要算法名
67  let message = 'hmacTestMessgae'; // 待进行HMAC的数据
68  let mac = cryptoFramework.createMac(macAlgName);
69  await mac.init(key);
70  // 数据量较少时，可以只做一次update，将数据全部传入，接口未对入参长度做限制
71  await mac.update({ data: new Uint8Array(buffer.from(message, 'utf-8').buffer) });
72  let macResult = await mac.doFinal();
73  console.info('HMAC result:' + macResult.data);
74}
75```
76
77
78### 分段HMAC
79
801. 调用[cryptoFramework.createMac](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatemac)，指定摘要算法SHA256，生成消息认证码操作实例（Mac）。
81
822. 调用[cryptoFramework.createSymKeyGenerator](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatesymkeygenerator)、[SymKeyGenerator.convertKey](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#convertkey-1)，生成密钥算法为AES、长度为128位的对称密钥（SymKey）。
83   生成对称密钥的详细开发指导，请参考[指定二进制数据生成对称密钥](crypto-convert-binary-data-to-sym-key.md)。
84
853. 调用[Mac.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-7)，指定共享对称密钥（SymKey），初始化Mac对象。
86
874. 传入自定义消息，将一次传入数据量设置为20字节，多次调用[Mac.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-9)，进行消息认证码计算。
88
895. 调用[Mac.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-3)，获取Mac计算结果。
90
916. 调用[Mac.getMacLength](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getmaclength)，获取Mac消息认证码的长度，单位为字节。
92
93以使用await方式分段传入数据，获取消息认证码计算结果为例：
94
95```ts
96import cryptoFramework from '@ohos.security.cryptoFramework';
97import buffer from '@ohos.buffer';
98
99async function genSymKeyByData(symKeyData: Uint8Array) {
100  let symKeyBlob: cryptoFramework.DataBlob = { data: symKeyData };
101  let aesGenerator = cryptoFramework.createSymKeyGenerator('AES128');
102  let symKey = await aesGenerator.convertKey(symKeyBlob);
103  console.info('convertKey success');
104  return symKey;
105}
106async function doLoopHmac() {
107  // 把字符串按utf-8解码为Uint8Array，使用固定的128位的密钥，即16字节
108  let keyData = new Uint8Array(buffer.from("12345678abcdefgh", 'utf-8').buffer);
109  let key = await genSymKeyByData(keyData);
110  let macAlgName = "SHA256"; // 摘要算法名
111  let mac = cryptoFramework.createMac(macAlgName);
112  // 假设信息总共43字节，根据utf-8解码后，也是43字节
113  let messageText = "aaaaa.....bbbbb.....ccccc.....ddddd.....eee";
114  let messageData = new Uint8Array(buffer.from(messageText, 'utf-8').buffer);
115  let updateLength = 20; // 假设以20字节为单位进行分段update，实际并无要求
116  await mac.init(key);
117  for (let i = 0; i < messageData.length; i += updateLength) {
118    let updateMessage = messageData.subarray(i, i + updateLength);
119    let updateMessageBlob: cryptoFramework.DataBlob = { data: updateMessage };
120    await mac.update(updateMessageBlob);
121  }
122  let macOutput = await mac.doFinal();
123  console.info("HMAC result: " + macOutput.data);
124}
125```
126