K230 SHA256 API参考
版权所有©2023北京嘉楠捷思信息技术有限公司
免责声明
您购买的产品、服务或特性等应受北京嘉楠捷思信息技术有限公司（“本公司”，下同）及其关联公司的商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，本公司不对本文档的任何陈述、信息、内容的正确性、可靠性、完整性、适销性、符合特定目的和不侵权提供任何明示或默示的声明或保证。除非另有约定，本文档仅作为使用指导参考。
由于产品版本升级或其他原因，本文档内容将可能在未经任何通知的情况下，不定期进行更新或修改。
商标声明
、“嘉楠”和其他嘉楠商标均为北京嘉楠捷思信息技术有限公司及其关联公司的商标。本文档可能提及的其他所有商标或注册商标，由各自的所有人拥有。
版权所有 © 2023北京嘉楠捷思信息技术有限公司。保留一切权利。 非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。
目录
[TOC]
前言
概述
本文档主要介绍 K230 SHA256 软件的使用，内容主要包括 SHA256 API 的使用及测试程序介绍。
读者对象
本文档（本指南）主要适用于以下人员：
技术支持工程师
软件开发工程师
缩略词定义
简称 |
说明 |
|---|---|
SHA256 |
Secure Hash Algorithm |
修订记录
文档版本号 |
修改说明 |
修改者 |
日期 |
|---|---|---|---|
V1.0 |
初版 |
杨帆 |
2023-05-30 |
1. 功能介绍
SHA256 主要用于计算数据的 hash 值，大核 rt-smart 中实现了 SHA256 算法，用于计算数据的 hash 值，代码逻辑如下图所示：
2. API 参考
SHA256模块主要提供了以下 API：
2.1 kd_mpi_cipher_sha256
【描述】
根据传入的消息计算消息的 hash 值。
【语法】
kd_mpi_cipher_sha256(const void *data, k_u32 len, k_u8 *hash);
【参数】
参数名称 |
描述 |
输入/输出 |
|---|---|---|
data |
传入的消息 |
输入 |
len |
传入消息的长度 |
输入 |
hash |
计算得到的 hash 值 |
输出 |
【返回值】
返回值 |
描述 |
|---|---|
0 |
成功。 |
非 0 |
失败，参考错误码定义 |
【芯片差异】
无
【需求】
头文件：mpi_cipher_api.h
库文件：libcipher.a
【注意】
无
【举例】
无
【相关主题】
无
3. 调试及打印信息
写一个用户态应用程序 sample_cipher.c 来测试 SHA256 功能。
测试代码已经写好，位于 mpp/userapps/sample/sample_cipher 目录下，具体的调试方法如下：
大核启动之后，进入 bin 目录；
运行 sample_cipher.elf 程序；
打印信息。
具体的打印信息如下所示：
msh />cd bin/
msh /bin>./sample_cipher.elf
input = ''
digest: e3b0c442 98fc1c14 9afbf4c8 996fb924 27ae41e4 649b934c a495991b 7852b855
result: PASS
input = 'abc'
digest: ba7816bf 8f01cfea 414140de 5dae2223 b00361a3 96177a9c b410ff61 f20015ad
result: PASS
input = 'abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq'
digest: 248d6a61 d20638b8 e5c02693 0c3e6039 a33ce459 64ff2167 f6ecedd4 19db06c1
result: PASS
input = 'The quick brown fox jumps over the lazy dog'
digest: d7a8fbb3 07d78094 69ca9abc b0082e4f 8d5651e4 6d3cdb76 2d02d0bf 37c9e592
result: PASS
input = 'The quick brown fox jumps over the lazy cog'
digest: e4c4d8f3 bf76b692 de791a17 3e053211 50f7a345 b46484fe 427f6acc 7ecc81be
result: PASS
input = 'bhn5bjmoniertqea40wro2upyflkydsibsk8ylkmgbvwi420t44cq034eou1szc1k0mk46oeb7ktzmlxqkbte2sy'
digest: 9085df2f 02e0cc45 5928d0f5 1b27b4bf 1d9cd260 a66ed1fd a11b0a3f f5756d99
result: PASS