表 2-1 SM2 算法库函数表
函数 |
描述 |
uint32_t SM2_Init(void) |
初始化 SM2 模块 |
uint32_t SM2_GetKey(uint8_t priKey[32], uint8_t pubKey[65]) |
生成 SM2 密钥对函数 |
uint32_t SM2_GetPubKey(uint8_t priKey[32], uint8_t pubKey[65]) |
由私钥获取公钥 |
uint32_t SM2_PointisOnCurve(uint8_t Point[64]) |
判断点是否在曲线上 |
uint32_t SM2_Sign(uint8_t E[32], uint8_t priKey[32], uint8_t r[32], uint8_t s[32]) |
签名函数 |
uint32_t SM2_Verify(uint8_t E[32], uint8_t pubKey[65], uint8_t r[32], uint8_t s[32]) |
验证函数 |
uint32_t SM2_ExchangeKey(uint8_t role, uint8_t *IDA, uint32_t IDAByteLen, uint8_t *IDB, uint32_t IDBByteLen, uint8_t dA[32], uint8_t PA[65],uint8_t PB[65], uint8_t rA[32], uint8_t RA[65], uint8_t RB[65], uint32_t kByteLen, uint8_t *KA, uint8_t S1[32], uint8_t SA[32]) |
密钥交换 |
uint32_t SM2_GetZ(uint8_t* ID, uint16_t IDByteLen, uint8_t pubKey[65], uint8_t Z[32]) |
身份标识杂凑值计算函数 |
uint32_t SM2_GetE(uint8_t* M, uint32_t MByteLen, uint8_t Z[32], uint8_t E[32]) |
消息的 HUSH 值 |
uint32_t SM2_EncryptInit(uint8_t pubKey[65], uint8_t C1[65]) |
SM2 分步加密初始化函数 |
uint32_t SM2_EncryptUpdate(uint8_t* M, uint32_t MByteLen, uint8_t* C2) |
SM2 分步加密更新函数 |
uint32_t SM2_EncryptDone(uint8_t C3[32]) |
SM2 分步加密完成函数 |
uint32_t SM2_Encrypt(uint8_t *M, uint32_t MByteLen, uint8_t pubKey[65], uint8_t *C, uint32_t *CByteLen) |
单次加密函数 |
uint32_t SM2_DecryptInit(uint8_t priKey[32], uint8_t C1[65]) |
SM2 分步解密初始化函数 |
uint32_t SM2_DecryptUpdate(uint8_t* C2, uint32_t C2ByteLen, uint8_t* M) |
SM2 分步解密更新函数 |
uint32_t SM2_DecryptDone(uint8_t C3[32]) |
SM2 分步解密完成函数 |
uint32_t SM2_Decrypt(uint8_t * C, uint32_t CByteLen, uint8_t priKey[32], uint8_t * M, uint32_t *MByteLen) |
单次解密函数
|
void SM2_Close(void) |
关闭 SM2 函数 |
void SM2_Version(uint8_t *type, uint8_t *customer, uint8_t date[3], uint8_t *version) |
获取 SM2 算法库版本
|
SM2_Init |
初始化SM2模块 |
函数原型 |
void SM2_Init(void) |
参数说明 |
|
返回值 |
SM2_OK:初始化成功;其他值:初始化失败,详见枚举类型定义 |
注意事项 |
1. 进行SM2运算时,若还未初始化或已切换到其他算法,必须先调用此函数来 开启SM2模块。 |
SM2_GetKey |
随机密钥对生成 |
函数原型 |
uint32_t SM2_GetKey(uint8_t priKey[32], uint8_t pubKey[65]) |
参数说明 |
priKey 输出,私钥,字节大端输出,即高位在前低位在后 pubKey 输出,公钥,字节大端输出,首字节是 0x04,然后分别是 x|y 坐标 |
返回值 |
SM2_OK:运算正确;其他值:计算错误,详见枚举类型定义 |
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动SM2 模块; 2.私钥即一大数,要求必须在[1,n-2]中,n 是 SM2 曲线参数。 |
SM2_GetPubKey |
私钥生成公钥 |
函数原型 |
uint32_t SM2_GetPubKey(uint8_t priKey[32], uint8_t pubKey[65]) |
参数说明 |
priKey 输入,私钥,字节大端输入,即高位在前低位在后 pubKey 输出,公钥,字节大端输出,首字节是 0x04,然后分别是 x|y 坐标 |
返回值 |
SM2_OK:运算正确;其他值:计算错误,详见枚举类型定义 |
注意事项 |
1.调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动SM2 模块 2. 私钥即一大数,要求必须在[1,n-2]中,n 是 SM2 曲线参数
|
SM2_PointisOnCurve |
判断点是否在曲线上 |
函数原型 |
uint32_t SM2_PointisOnCurve(uint8_t Point[64]) |
参数说明 |
Point输入, 点坐标(x|y) ,x 与 y 均为字节大端输入 |
返回值 |
SM2_PointIsOnCrv_YES :点在曲线上;其他值: 错误,详见枚举类型定义 |
注意事项 |
1.调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动SM2 模块 |
SM2_Sign |
签名生成 |
函数原型 |
uint32_t SM2_Sign(uint8_t E[32], uint8_t priKey[32], uint8_t r[32], uint8_t s[32]) |
参数说明 |
E 输入,待签名消息的 HASH 值 priKey 输入,签名者的私钥 r 输出,签名结果 s 输出,签名结果
|
返回值 |
SM2_OK:运算正确;其他值:计算错误,详见枚举类型定义 |
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动SM2 模块; 2. E 或 prikey 存储介质可以为 RAM 或 FLASH; 3. 若 E 或 prikey 为 RAM 存储,则签名结果 r 和 s 可以复用此空间,但需保证空间足够; 4. prikey 要求必须在[1,n-1]中。 |
SM2_Verify |
签名验证 |
函数原型 |
uint32_t SM2_Verify(uint8_t E[32], uint8_t pubKey[65], uint8_t r[32], uint8_t s[32]) |
参数说明 |
E 输入,待签名消息的 HASH 值 pubKey 输入,签名者的公钥 r 输入,签名结果 s 输入,签名结果
|
返回值 |
SM2_OK:运算正确;其他值:计算错误,详见枚举类型定义 |
注意事项 |
1.调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动SM2 模块 2. E 或 pubKey 存储介质可以为 RAM 或 FLASH |
SSM2_ExchangeKey |
密钥协商(交换) |
函数原型 |
uint32_t SM2_ExchangeKey(uint8_t role, uint8_t *IDA, uint32_t IDAByteLen, uint8_t *IDB, uint32_t IDBByteLen, uint8_t dA[32], uint8_t PA[65],uint8_t PB[65], uint8_t rA[32], uint8_t RA[65], uint8_t RB[65], uint32_t kByteLen, uint8_t *KA, uint8_t S1[32], uint8_t SA[32]) |
参数说明 |
role 输入,角色,1-发起者,0-接受者 IDA 输入,发起方 ID IDAByteLen 输入,IDB 的字节数 IDB 输入,接受方 ID IDBByteLen 输入,IDB 的字节数 dA[32] 输入,己方私钥 PA[65] 输入,己方公钥 PB[65] 输入,对方公钥 rA[32] 输入,己方临时私钥 RA[65] 输入,己方临时公钥 RB[65] 输入,对方临时公钥 kByteLen 输入,协商密钥字节长度 KA [kByteLen] 输出,协商密钥 S1 [32] 输出,己方 S1 值 SA [32] 输出,己方 SA 值 |
返回值 |
SM2_OK:运算正确;其他值:计算错误,详见枚举类型值定义 |
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动 SM2 模块 2. 如果计算后的 S1=SB,S2=SA,则密钥交换成功,协商后的密钥为 KA 3. dA、PB、rA、RA、RB、ZA、ZB 存储介质可以为 RAM 或 FLASH 4. 输出参数 KA、S1、SA 不能和输入参数 dA、PB、rA、RA、RB、ZA、ZB 使用同一 buffer。 |
SSM2_GetZy |
用户身份标识杂凑值计算函数 |
函数原型 |
uint32_t SM2_GetZ(uint8_t* ID, uint16_t IDByteLen, uint8_t pubKey[65], uint8_t Z[32])
|
参数说明 |
ID 输入,用户 A 的 ID IDByteLen 输入,用户 A 的 ID 的字节数- 22 - Pubkey 输入,用户 A 的公钥,65 字节 Z[32] 输出,用户 A 的杂凑值,32 字节 |
返回值 |
SM2_OK:计算成功,其他值:计算错误,详见枚举类型值定义 |
注意事项 |
1.符合 SM2 算法标准 2.调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动 SM2 模块 3.运算结束后,本函数内部已再次调用 SM2_Init()启动 SM2 模块。 |
SSM2_GetEy |
消息的杂凑值计算函数 |
函数原型 |
uint32_t SM2_GetE(uint8_t* M, uint32_t MByteLen, uint8_t Z[32], uint8_t E[32])
|
参数说明 |
M 输入,待签名验证消息 MByteLen 输入,待签名验证消息的字节数 Z 输入,签名者的 ID 杂凑值 E 输出,输入值 M 与 Z 的杂凑值,32 字节
|
返回值 |
SM2_OK:计算成功, 其他值:计算错误,详见枚举类型值定义 |
注意事项 |
1.符合 SM2 算法标准; 2. 运算结束后,本函数内部已再次调用 SM2_Init()启动 SM2 模块。 |
SM2_EncryptInity |
SM2 分步加密初始化函数 |
函数原型 |
uint32_t SM2_EncryptInit(uint8_t pubKey[65], uint8_t C1[65]) |
参数说明 |
Pubkey 输入,公钥 C1 输出,密文的第一组成部分
|
返回值 |
SM2_OK:计算成功, 其他值:计算错误,详见枚举类型值定义 |
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动SM2 模块; 2. pubkey 存储介质可以为 RAM 或 FLASH; 3. pubkey 和 C1 也不能是同一 buffer; 4.按照新的国密规范,密文顺序从 C1||C2||C3 修正为 C1||C3||C2。
|
SM2_EncryptUpdate |
SM2 分步加密更新函数 |
函数原型 |
uint32_t SM2_EncryptUpdate(uint8_t* M, uint32_t MByteLen, uint8_t* C2)
|
参数说明 |
M 输入,待加密消息 MByteLen 输入,消息的字节数 C2 输出,密文的第二组成部分,长度与 MByteLen 相同
|
返回值 |
SM2_OK:运算正确, 其他值:计算错误,详见枚举类型值定义 |
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动 SM2 模块,且需与 SM2_EncryptInit 配合使用; 2. M 存储介质可以为 RAM 或 FLASH; 3. M 和 C2 可以是同一 buffer; 4.按照新的国密规范,密文顺序从 C1||C2||C3 修正为 C1||C3||C2。
|
SM2_EncryptDone |
SM2 分步加密完成函数 |
函数原型 |
uint32_t SM2_EncryptDone(uint8_t C3[32]
|
参数说明 |
C3 输出,密文的第三组成部分 |
返回值 |
SM2_OK:加密正确; 其他值:计算错误,详见枚举类型值定义
|
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动 SM2 模块,且需与 SM2_EncryptInit、SM2_EncryptUpdate 配合使用; 2.按照新的国密规范,密文顺序从 C1||C2||C3 修正为 C1||C3||C2。 |
SM2_Encrypt |
SM2 单次加密函数 |
函数原型 |
uint32_t SM2_Encrypt(uint8_t *M, uint32_t MByteLen, uint8_t pubKey[65], uint8_t *C, uint32_t *CByteLen) |
参数说明 |
M 输入,明文 MByteLen 输入,明文的字节长度,0< MByteLen < (232 -97) Pubkey 输入,公钥 C 输出,密文 CByteLen 输出,密文的字节长度,应为(MByteLen +97)
|
返回值 |
SM2_OK:运算正确; 其他值:计算错误,详见枚举类型值定义
|
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动 SM2 模块; 2. M 或 pubkey 存储介质可以为 RAM 或 FLASH; 3. M 和 C 不能是同一 buffer;pubkey 和 C 也不能是同一 buffer; 4.按照新的国密规范,密文顺序从 C1||C2||C3 修正为 C1||C3||C2。
|
SSM2_DecryptInit |
SM2 分步解密初始化函数 |
函数原型 |
uint32_t SM2_DecryptInit(uint8_t priKey[32], uint8_t C1[65]) |
参数说明 |
priKey 输入,私钥 C1 输入,密文的第一组成部分
|
返回值 |
SM2_OK:运算正确; 其他值:计算错误,详见枚举类型值定义
|
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动 SM2 模块; 2. priKey 存储介质可以为 RAM 或 FLASH; 3.按照新的国密规范,密文顺序从 C1||C2||C3 修正为 C1||C3||C2。
|
SM2_DecrypUpdate |
SM2 分步解密更新函数 |
函数原型 |
uint32_t SM2_DecryptUpdate(uint8_t* C2, uint32_t C2ByteLen, uint8_t* M) |
参数说明 |
C2 输入,密文的第二组成部分 C2ByteLen 输入,C2 的字节数 M 输出,消息,长度与 C2ByteLen 相同
|
返回值 |
SM2_OK:运算正确; 其他值:计算错误,详见枚举类型值定义
|
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动 SM2 模块,且需与 SM2_DecryptInit 配合使用; 2. C2 存储介质可以为 RAM 或 FLASH; 3. M 和 C2 可以是同一 buffer; 4.按照新的国密规范,密文顺序从 C1||C2||C3 修正为 C1||C3||C2。
|
SSM2_DecrypDone |
SM2 分步解密完成函数 |
函数原型 |
uint32_t SM2_DecryptDone(uint8_t C3[32]) |
参数说明 |
C3 输入,密文的第三组成部分
|
返回值 |
SM2_OK:解密正确; 其他值:计算错误,详见枚举类型值定义
|
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动SM2 模块,且需与 SM2_DecryptInit、SM2_DecryptUpdate 配合使用; 2.按照新的国密规范,密文顺序从 C1||C2||C3 修正为 C1||C3||C2。
|
SSM2_Decrypt |
SM2 单次解密 |
函数原型 |
uint32_t SM2_DecryptDone(uint8_t C3[32]) |
参数说明 |
C3 输入,密文的第三组成部分
|
返回值 |
SM2_OK:解密正确; 其他值:计算错误,详见枚举类型值定义
|
注意事项 |
1. 调用本函数前,若还未初始化或已切换到其他算法,先调用 SM2_Init()启动SM2 模块,且需与 SM2_DecryptInit、SM2_DecryptUpdate 配合使用; 2.按照新的国密规范,密文顺序从 C1||C2||C3 修正为 C1||C3||C2。
|
SSM2_Close |
关闭 SM2 模块 |
函数原型 |
|
参数说明 |
|
返回值 |
|
注意事项 |
1. SM2 运算完后,可调用本函数关闭 SM2 模块。 |
SSM2_Version |
获取 SM2 库版本信息 |
函数原型 |
void SM2_Version(uint8_t *type, uint8_t *customer, uint8_t date[3], uint8_t*version) |
参数说明 |
type 商业或安全版本 customer 标准或定制版本 date 年,月,日 version //版本 x.x
|
返回值 |
|
注意事项 |
*type = 0x03; // 商业和安全版 *customer = 0x00; // 标准版本 date[0] = 18; //Year() date[1] = 12; //Month() date[2] = 28; //Day () *version = 0x10; //表示版本 1.0
|