• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 消息摘要计算
2
3
4消息摘要算法是一种能将任意长度的输入消息,通过特定运算生成固定长度摘要的算法。消息摘要算法也被称为哈希算法或单向散列算法。
5
6
7在摘要算法相同时,生成的摘要值主要有下列特点:
8
9
10- 当输入消息相同时,生成摘要序列相同。
11
12- 当输入消息的长度不一致时,生成摘要序列长度固定(摘要长度由算法决定)。
13
14- 当输入消息不一致时,生成摘要序列几乎不会相同(依然存在相同概率,由摘要长度决定相同概率)。
15
16
17## 支持的算法与规格
18
19当创建MD消息摘要时,需要使用表中“支持种类”一列,指定MD消息摘要算法规格。
20
21| 摘要算法 | 支持种类 | API版本 |
22| -------- | -------- | -------- |
23| HASH | SHA1 | 9+ |
24| HASH | SHA224 | 9+ |
25| HASH | SHA256 | 9+ |
26| HASH | SHA384 | 9+ |
27| HASH | SHA512 | 9+ |
28| HASH | MD5 | 9+ |
29| HASH | SM3 | 10+ |
30
31
32## 开发步骤
33
34在调用update接口传入数据时,可以[一次性传入所有数据](#摘要算法一次性传入),也可以把数据人工分段,然后[分段update](#分段摘要算法)。对于同一段数据而言,计算结果没有差异。对于数据量较大的数据,开发者可以根据实际需求选择是否分段传入。
35
36下面分别提供两种方式的示例代码。
37
38
39### 摘要算法(一次性传入)
40
411. 调用[cryptoFramework.createMd](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatemd),指定摘要算法SHA256,生成摘要操作实例(Md)。
42
432. 调用[Md.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-6),传入自定义消息,进行摘要更新计算。单次update长度没有限制。
44
453. 调用[Md.digest](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#digest),获取摘要计算结果。
46
474. 调用[Md.getMdLength](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getmdlength),获取摘要计算长度,单位为字节。
48
49以使用await方式单次传入数据,获取摘要计算结果为例:
50
51```ts
52import cryptoFramework from '@ohos.security.cryptoFramework';
53import buffer from '@ohos.buffer';
54
55async function doMd() {
56  let mdAlgName = 'SHA256'; // 摘要算法名
57  let message = 'mdTestMessgae'; // 待摘要的数据
58  let md = cryptoFramework.createMd(mdAlgName);
59  // 数据量较少时,可以只做一次update,将数据全部传入,接口未对入参长度做限制
60  await md.update({ data: new Uint8Array(buffer.from(message, 'utf-8').buffer) });
61  let mdResult = await md.digest();
62  console.info('Md result:' + mdResult.data);
63}
64```
65
66
67### 分段摘要算法
68
691. 调用[cryptoFramework.createMd](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatemd),指定摘要算法SHA256,生成摘要操作实例(Md)。
70
712. 传入自定义消息,将一次传入数据量设置为20字节,多次调用[Md.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-7),进行摘要更新计算。
72
733. 调用[Md.digest](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#digest-1),获取摘要计算结果。
74
754. 调用[Md.getMdLength](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getmdlength),获取摘要计算长度,单位为字节。
76
77以使用await方式分段传入数据,获取摘要计算结果为例:
78
79```ts
80import cryptoFramework from '@ohos.security.cryptoFramework';
81import buffer from '@ohos.buffer';
82
83async function doLoopMd() {
84  let mdAlgName = "SHA256"; // 摘要算法名
85  let md = cryptoFramework.createMd(mdAlgName);
86  // 假设信息总共43字节,根据utf-8解码后,也是43字节
87  let messageText = "aaaaa.....bbbbb.....ccccc.....ddddd.....eee";
88  let messageData = new Uint8Array(buffer.from(messageText, 'utf-8').buffer);
89  let updateLength = 20; // 假设以20字节为单位进行分段update,实际并无要求
90  for (let i = 0; i < messageData.length; i += updateLength) {
91    let updateMessage = messageData.subarray(i, i + updateLength);
92    let updateMessageBlob: cryptoFramework.DataBlob = { data: updateMessage };
93    await md.update(updateMessageBlob);
94  }
95  let mdOutput = await md.digest();
96  console.info("md result: " + mdOutput.data);
97}
98```
99