消息摘要计算
消息摘要算法是一种能将任意长度的输入消息,通过特定运算生成固定长度摘要的算法。消息摘要算法也被称为哈希算法或单向散列算法。
在摘要算法相同时,生成的摘要值主要有下列特点:
-
当输入消息相同时,生成摘要序列相同。
-
当输入消息的长度不一致时,生成摘要序列长度固定(摘要长度由算法决定)。
-
当输入消息不一致时,生成摘要序列几乎不会相同(依然存在相同概率,由摘要长度决定相同概率)。
支持的算法与规格
当创建MD消息摘要时,需要使用表中“支持种类”一列,指定MD消息摘要算法规格。
摘要算法 | 支持种类 | API版本 |
---|---|---|
HASH | SHA1 | 9+ |
HASH | SHA224 | 9+ |
HASH | SHA256 | 9+ |
HASH | SHA384 | 9+ |
HASH | SHA512 | 9+ |
HASH | MD5 | 9+ |
HASH | SM3 | 10+ |
开发步骤
在调用update接口传入数据时,可以一次性传入所有数据,也可以把数据人工分段,然后分段update。对于同一段数据而言,计算结果没有差异。对于数据量较大的数据,开发者可以根据实际需求选择是否分段传入。
下面分别提供两种方式的示例代码。
摘要算法(一次性传入)
-
调用cryptoFramework.createMd,指定摘要算法SHA256,生成摘要操作实例(Md)。
-
调用Md.update,传入自定义消息,进行摘要更新计算。单次update长度没有限制。
-
调用Md.digest,获取摘要计算结果。
-
调用Md.getMdLength,获取摘要计算长度,单位为字节。
以使用await方式单次传入数据,获取摘要计算结果为例:
import cryptoFramework from '@ohos.security.cryptoFramework';
import buffer from '@ohos.buffer';
async function doMd() {
let mdAlgName = 'SHA256'; // 摘要算法名
let message = 'mdTestMessgae'; // 待摘要的数据
let md = cryptoFramework.createMd(mdAlgName);
// 数据量较少时,可以只做一次update,将数据全部传入,接口未对入参长度做限制
await md.update({ data: new Uint8Array(buffer.from(message, 'utf-8').buffer) });
let mdResult = await md.digest();
console.info('Md result:' + mdResult.data);
let mdLen = md.getMdLength();
console.info("md len: " + mdLen);
}
分段摘要算法
-
调用cryptoFramework.createMd,指定摘要算法SHA256,生成摘要操作实例(Md)。
-
传入自定义消息,将一次传入数据量设置为20字节,多次调用Md.update,进行摘要更新计算。
-
调用Md.digest,获取摘要计算结果。
-
调用Md.getMdLength,获取摘要计算长度,单位为字节。
以使用await方式分段传入数据,获取摘要计算结果为例:
import cryptoFramework from '@ohos.security.cryptoFramework';
import buffer from '@ohos.buffer';
async function doLoopMd() {
let mdAlgName = "SHA256"; // 摘要算法名
let md = cryptoFramework.createMd(mdAlgName);
// 假设信息总共43字节,根据utf-8解码后,也是43字节
let messageText = "aaaaa.....bbbbb.....ccccc.....ddddd.....eee";
let messageData = new Uint8Array(buffer.from(messageText, 'utf-8').buffer);
let updateLength = 20; // 假设以20字节为单位进行分段update,实际并无要求
for (let i = 0; i < messageData.length; i += updateLength) {
let updateMessage = messageData.subarray(i, i + updateLength);
let updateMessageBlob: cryptoFramework.DataBlob = { data: updateMessage };
await md.update(updateMessageBlob);
}
let mdOutput = await md.digest();
console.info("md result: " + mdOutput.data);
let mdLen = md.getMdLength();
console.info("md len: " + mdLen);
}