• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 消息摘要计算SHA256(ArkTS)
2
3对应的算法规格请查看[消息摘要计算算法规格](crypto-generate-message-digest-overview.md#支持的算法与规格)。
4
5> **说明：**
6>
7> 从API version 12开始，轻量级智能穿戴设备支持消息摘要的计算与操作。
8
9## 开发步骤
10
11在调用update接口传入数据时，可以[一次性传入所有数据](#摘要算法一次性传入)，也可以把数据人工分段，然后[分段update](#分段摘要算法)。对于同一段数据而言，计算结果没有差异。对于数据量较大的数据，开发者可以根据实际需求选择是否分段传入。
12
13下面分别提供两种方式的示例代码。
14
15### 摘要算法（一次性传入）
16
171. 调用[cryptoFramework.createMd](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatemd)，指定摘要算法SHA256，生成摘要实例（Md）。
18
192. 调用[Md.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-6)，传入自定义消息，进行摘要更新计算。单次update长度没有限制。
20
213. 调用[Md.digest](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#digest)，获取摘要计算结果。
22
234. 调用[Md.getMdLength](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getmdlength)，获取摘要计算长度，单位为字节。
24
25- 以使用await方式单次传入数据，获取摘要计算结果为例：
26
27  ```ts
28  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
29  import { buffer } from '@kit.ArkTS';
30
31  async function doMd() {
32    let mdAlgName = 'SHA256'; // 摘要算法名。
33    let message = 'mdTestMessage'; // 待摘要的数据。
34    let md = cryptoFramework.createMd(mdAlgName);
35    // 数据量较少时，可以只做一次update，将数据全部传入，接口未对入参长度做限制。
36    await md.update({ data: new Uint8Array(buffer.from(message, 'utf-8').buffer) });
37    let mdResult = await md.digest();
38    console.info('Md result:' + mdResult.data);
39    let mdLen = md.getMdLength();
40    console.info("md len: " + mdLen);
41  }
42  ```
43
44- 以使用同步方式单次传入数据，获取摘要计算结果为例：
45
46  ```ts
47  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
48  import { buffer } from '@kit.ArkTS';
49
50  function doMdBySync() {
51    let mdAlgName = 'SHA256'; // 摘要算法名。
52    let message = 'mdTestMessage'; // 待摘要的数据。
53    let md = cryptoFramework.createMd(mdAlgName);
54    // 数据量较少时，可以只做一次update，将数据全部传入，接口未对入参长度做限制。
55    md.updateSync({ data: new Uint8Array(buffer.from(message, 'utf-8').buffer) });
56    let mdResult = md.digestSync();
57    console.info('[Sync]:Md result:' + mdResult.data);
58    let mdLen = md.getMdLength();
59    console.info("md len: " + mdLen);
60  }
61  ```
62
63### 分段摘要算法
64
651. 调用[cryptoFramework.createMd](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatemd)，指定摘要算法SHA256，生成摘要实例（Md）。
66
672. 传入自定义消息，将一次传入数据量设置为20字节，多次调用[Md.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-7)，进行摘要更新计算。
68
693. 调用[Md.digest](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#digest-1)，获取摘要计算结果。
70
714. 调用[Md.getMdLength](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getmdlength)，获取摘要计算长度，单位为字节。
72
73- 以使用await方式分段传入数据，获取摘要计算结果为例：
74
75  ```ts
76  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
77  import { buffer } from '@kit.ArkTS';
78
79  async function doLoopMd() {
80    let mdAlgName = "SHA256"; // 摘要算法名。
81    let md = cryptoFramework.createMd(mdAlgName);
82    // 假设信息总共43字节，根据utf-8解码后，也是43字节。
83    let messageText = "aaaaa.....bbbbb.....ccccc.....ddddd.....eee";
84    let messageData = new Uint8Array(buffer.from(messageText, 'utf-8').buffer);
85    let updateLength = 20; // 假设以20字节为单位进行分段update，实际并无要求。
86    for (let i = 0; i < messageData.length; i += updateLength) {
87      let updateMessage = messageData.subarray(i, i + updateLength);
88      let updateMessageBlob: cryptoFramework.DataBlob = { data: updateMessage };
89      await md.update(updateMessageBlob);
90    }
91    let mdOutput = await md.digest();
92    console.info("md result: " + mdOutput.data);
93    let mdLen = md.getMdLength();
94    console.info("md len: " + mdLen);
95  }
96  ```
97
98- 以使用同步方式分段传入数据，获取摘要计算结果为例：
99
100  ```ts
101  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
102  import { buffer } from '@kit.ArkTS';
103
104  function doLoopMdBySync() {
105    let mdAlgName = "SHA256"; // 摘要算法名。
106    let md = cryptoFramework.createMd(mdAlgName);
107    // 假设信息总共43字节，根据utf-8解码后，也是43字节。
108    let messageText = "aaaaa.....bbbbb.....ccccc.....ddddd.....eee";
109    let messageData = new Uint8Array(buffer.from(messageText, 'utf-8').buffer);
110    let updateLength = 20; // 假设以20字节为单位进行分段update，实际并无要求。
111    for (let i = 0; i < messageData.length; i += updateLength) {
112      let updateMessage = messageData.subarray(i, i + updateLength);
113      let updateMessageBlob: cryptoFramework.DataBlob = { data: updateMessage };
114      md.updateSync(updateMessageBlob);
115    }
116    let mdOutput = md.digestSync();
117    console.info("[Sync]:md result: " + mdOutput.data);
118    let mdLen = md.getMdLength();
119    console.info("md len: " + mdLen);
120  }
121  ```