跳转至

12 crypto-加解密和HASH

作者:沈园园 | 最后修改:2026-10-28

一、概述

加解密算法是信息安全领域的核心技术,用于保护数据的机密性、完整性和真实性。根据加密密钥的特点和应用场景,可分为对称加密、非对称加密、哈希算法三大类,以下是具体介绍:

1.1 对称加密算法(Symmetric Encryption)

特点:加密和解密使用相同的密钥,运算速度快,适合处理大量数据。

1.1.1 AES(Advanced Encryption Standard,高级加密标准)

  • 地位:目前应用最广泛的对称加密算法,替代了 DES 成为国际标准。
  • 密钥长度:128 位、192 位、256 位(密钥越长,安全性越高)。
  • 工作模式:支持 ECB、CBC、GCM 等(推荐 GCM,带认证功能)。
  • 应用场景:文件加密、数据库加密、SSL/TLS 会话加密、磁盘加密(如 BitLocker)。
  • 优势:安全性高(256 位密钥目前无法被暴力破解)、速度快、跨平台支持好。

1.1.2 DES/3DES(Data Encryption Standard)

  • DES:老牌算法,密钥长度 56 位,安全性不足(已被破解),基本淘汰。
  • 3DES:对 DES 进行三次加密,密钥长度 168 位,安全性提升,但速度较慢,逐渐被 AES 替代。
  • 应用:早期金融系统、信用卡加密(部分遗留系统仍在使用)。

1.2 非对称加密算法(Asymmetric Encryption)

特点:使用公钥(加密)和私钥(解密) 一对密钥,公钥可公开,私钥需保密,安全性高但速度慢,适合小数据加密(如密钥交换)。

1.2.1 RSA

  • 原理:基于大整数分解难题(质因数分解)。
  • 密钥长度:推荐 2048 位及以上(1024 位已不安全)。
  • 应用场景:数字签名、密钥交换(如 HTTPS 握手时交换对称密钥)、证书加密。
  • 局限:密钥生成慢,加密大数据效率低。

1.2.2 SM2(国密算法)

  • 特点:中国自主设计的椭圆曲线算法,类似 ECC,满足国家密码标准。
  • 应用:政务系统、金融领域(如银行、证券)、国内合规场景。

1.3 哈希算法(Hash Algorithm)

特点:将任意长度数据转换为固定长度的哈希值(摘要),不可逆(无法从哈希值还原原始数据),用于数据完整性校验和身份认证。

1.3.1 SHA 系列(Secure Hash Algorithm)

  • SHA-256:生成 256 位哈希值,应用最广,安全性高(抗碰撞能力强)。
  • 应用:文件校验(如 BT 种子)、密码存储(加盐哈希)、区块链(比特币用 SHA-256)。

1.3.2 MD5

  • 特点:生成 128 位哈希值,速度快,但已被破解(存在碰撞漏洞)。
  • 现状:仅用于非安全场景(如文件校验),禁止用于密码存储或关键数据。

1.4 典型应用场景

1.4.1 HTTPS 通信:

  • 非对称加密(RSA/ECC):用于客户端和服务器交换对称密钥(如 AES 密钥)。
  • 对称加密(AES):用于加密后续传输的大量数据(速度快)。
  • 哈希算法(SHA-256):用于验证服务器证书的完整性。

1.4.2 文件加密:

  • 对称加密(AES-256):直接加密文件内容(效率高)。
  • 密钥管理:用用户密码加密 AES 密钥(避免明文存储)。

1.4.3 数字签名:

  • 哈希算法(SHA-256):对原始数据生成摘要。
  • 非对称加密(RSA/ECC):用私钥加密摘要,接收方用公钥解密并验证。

1.5 选择建议

  • 大量数据加密:优先用 AES(速度快、安全性高)。
  • 密钥交换 / 数字签名:用 ECC(密钥短、效率高)或 RSA(兼容性好)。
  • 数据完整性校验:用 SHA-256(避免 MD5)。
  • 国内合规场景:选择国密算法(SM2/SM3/SM4)。

加解密算法的安全性依赖于密钥管理(如密钥长度、存储安全),即使是强算法,若密钥泄露也会导致安全失效。

二、核心示例

1、核心示例是指:使用本库文件提供的核心API,开发的基础业务逻辑的演示代码;

2、核心示例的作用是:帮助开发者快速理解如何使用本库,所以核心示例的逻辑都比较简单;

3、更加完整和详细的demo,请参考 LuatOS仓库 中各个产品目录下的demo/crypto

-- MD5,输出结果已经hex编码
log.info("md5", crypto.md5("abc"))
log.info("hmac_md5", crypto.hmac_md5("abc", "1234567890"))

-- SHA1,输出结果已经hex编码
log.info("sha1", crypto.sha1("abc"))
log.info("hmac_sha1", crypto.hmac_sha1("abc", "1234567890"))

-- SHA256,输出结果已经hex编码
log.info("sha256", crypto.sha256("abc"))
log.info("hmac_sha256", crypto.hmac_sha256("abc", "1234567890"))

-- SHA512,输出结果已经hex编码
log.info("sha512", crypto.sha512("abc"))
log.info("hmac_sha512", crypto.hmac_sha512("abc", "1234567890"))

local data_encrypt = crypto.cipher_encrypt("AES-128-ECB", "ZERO", "023001", "HZBIT@WLW/YSBKEY")
log.info("AES", "aes-128-ecb", data_encrypt:toHex())
local data_decrypt = crypto.cipher_decrypt("AES-128-ECB", "ZERO", data_encrypt, "HZBIT@WLW/YSBKEY")
log.info("AES", "aes-128-ecb", data_decrypt)

-- AES加密, 未经Hex编码. AES-128-ECB 算法
local data_encrypt = crypto.cipher_encrypt("AES-128-ECB", "PKCS7", "12345678901234 > 123456", "1234567890123456")
local data2_encrypt = crypto.cipher_encrypt("AES-128-CBC", "PKCS7", "12345678901234 > 123456", "1234567890123456", "1234567890666666")
log.info("AES", "aes-128-ecb", data_encrypt:toHex())
log.info("AES", "aes-128-cbc", data2_encrypt:toHex())

-- AES解密, 未经Hex编码
local data_decrypt = crypto.cipher_decrypt("AES-128-ECB", "PKCS7", data_encrypt, "1234567890123456")
local data2_decrypt = crypto.cipher_decrypt("AES-128-CBC", "PKCS7", data2_encrypt, "1234567890123456", "1234567890666666")
log.info("AES", "aes-128-ecb", data_decrypt)
log.info("AES", "aes-128-cbc", data2_decrypt)
log.info("mem", rtos.meminfo("sys"))

-- DES-ECB 加解密
local data1 = crypto.cipher_encrypt("DES-ECB", "PKCS7", "abcdefg", "12345678")
if data1 then -- DES-ECB 在某些平台不支持的
log.info("des", data1:toHex())
local data2 = crypto.cipher_decrypt("DES-ECB", "PKCS7", data1, "12345678")
log.info("des", data2)
else
log.info("des", "当前固件不支持DES/3DES")
end

-- 3DES-ECB 加解密
local data1 = crypto.cipher_encrypt("DES-EDE3-ECB", "PKCS7", "abcdefg!!--ZZSS", "123456781234567812345678")
if data1 then -- DES-ECB 在某些平台不支持的
log.info("3des", data1:toHex())
local data2 = crypto.cipher_decrypt("DES-EDE3-ECB", "PKCS7", data1, "123456781234567812345678")
log.info("3des", data2)
else
log.info("3des", "当前固件不支持DES/3DES")
end

-- 打印所有支持的cipher
if crypto.cipher_list then
log.info("cipher", "list", json.encode(crypto.cipher_list()))
else
log.info("cipher", "当前固件不支持crypto.cipher_list")
end
-- 打印所有支持的cipher suites
if crypto.cipher_suites then
log.info("cipher", "suites", json.encode(crypto.cipher_suites()))
else
log.info("cipher", "当前固件不支持crypto.cipher_suites")
end

-- ---------------------------------------
log.info("随机数测试")
for i=1, 10 do
sys.wait(100)
log.info("crypto", "真随机数",string.unpack("I",crypto.trng(4)))
log.info("crypto", "伪随机数",math.random()) -- 输出的是浮点数,不推荐
log.info("crypto", "伪随机数",math.random(1, 65525)) -- 不推荐
end

-- totp的密钥
log.info("totp的密钥")
local secret = "VK54ZXPO74ISEM2E"
--写死时间戳用来测试
local ts = 1646796576
--生成十分钟的动态码验证下
for i=1,600,30 do
local r = crypto.totp(secret,ts+i)
local time = os.date("*t",ts+i + 8*3600)--东八区
log.info("totp", string.format("%06d" ,r),time.hour,time.min,time.sec)
end

-- 文件测试
log.info("文件hash值测试")
if crypto.md_file then
log.info("md5", crypto.md_file("MD5", "/luadb/logo.jpg"))
log.info("sha1", crypto.md_file("SHA1", "/luadb/logo.jpg"))
log.info("sha256", crypto.md_file("SHA256", "/luadb/logo.jpg"))

log.info("hmac_md5", crypto.md_file("MD5", "/luadb/logo.jpg", "123456"))
log.info("hmac_sha1", crypto.md_file("SHA1", "/luadb/logo.jpg", "123456"))
log.info("hmac_sha256", crypto.md_file("SHA256", "/luadb/logo.jpg", "123456"))
else
log.info("文件hash值测试", "当前固件不支持crypto.md_file")
end

-- if crypto.checksum then
--     log.info("checksum", "OK", string.char(crypto.checksum("OK")):toHex())
--     log.info("checksum", "357E", string.char(crypto.checksum("357E", 1)):toHex())
-- else
--     log.info("checksum", "当前固件不支持crypto.checksum")
-- end

-- 流式hash测试
log.info("流式hash测试")
if crypto.hash_init then
-- MD5
local md5_obj = crypto.hash_init("MD5")
crypto.hash_update(md5_obj, "1234567890")
crypto.hash_update(md5_obj, "1234567890")
crypto.hash_update(md5_obj, "1234567890")
crypto.hash_update(md5_obj, "1234567890")
local md5_result = crypto.hash_finish(md5_obj)
log.info("md5_stream", md5_result)
log.info("md5", crypto.md5("1234567890123456789012345678901234567890"))

-- HMAC_MD5
local hmac_md5_obj = crypto.hash_init("MD5", "1234567890")
crypto.hash_update(hmac_md5_obj, "1234567890")
crypto.hash_update(hmac_md5_obj, "1234567890")
crypto.hash_update(hmac_md5_obj, "1234567890")
crypto.hash_update(hmac_md5_obj, "1234567890")
local hmac_md5_result = crypto.hash_finish(hmac_md5_obj)
log.info("hmac_md5_stream", hmac_md5_result)
log.info("hmac_md5", crypto.hmac_md5("1234567890123456789012345678901234567890", "1234567890"))

-- SHA1
local sha1_obj = crypto.hash_init("SHA1")
crypto.hash_update(sha1_obj, "1234567890")
crypto.hash_update(sha1_obj, "1234567890")
crypto.hash_update(sha1_obj, "1234567890")
crypto.hash_update(sha1_obj, "1234567890")
local sha1_result = crypto.hash_finish(sha1_obj)
log.info("sha1_stream", sha1_result)
log.info("sha1", crypto.sha1("1234567890123456789012345678901234567890"))

-- HMAC_SHA1
local hmac_sha1_obj = crypto.hash_init("SHA1", "1234567890")
crypto.hash_update(hmac_sha1_obj, "1234567890")
crypto.hash_update(hmac_sha1_obj, "1234567890")
crypto.hash_update(hmac_sha1_obj, "1234567890")
crypto.hash_update(hmac_sha1_obj, "1234567890")
local hmac_sha1_result = crypto.hash_finish(hmac_sha1_obj)
log.info("hmac_sha1_stream", hmac_sha1_result)
log.info("hmac_sha1", crypto.hmac_sha1("1234567890123456789012345678901234567890", "1234567890"))

-- SHA256
local sha256_obj = crypto.hash_init("SHA256")
crypto.hash_update(sha256_obj, "1234567890")
crypto.hash_update(sha256_obj, "1234567890")
crypto.hash_update(sha256_obj, "1234567890")
crypto.hash_update(sha256_obj, "1234567890")
local sha256_result = crypto.hash_finish(sha256_obj)
log.info("sha256_stream", sha256_result)
log.info("sha256", crypto.sha256("1234567890123456789012345678901234567890"))

-- HMAC_SHA256
local hmac_sha256_obj = crypto.hash_init("SHA256", "1234567890")
crypto.hash_update(hmac_sha256_obj, "1234567890")
crypto.hash_update(hmac_sha256_obj, "1234567890")
crypto.hash_update(hmac_sha256_obj, "1234567890")
crypto.hash_update(hmac_sha256_obj, "1234567890")
local hmac_sha256_result = crypto.hash_finish(hmac_sha256_obj)
log.info("hmac_sha256_stream", hmac_sha256_result)
log.info("hmac_sha256", crypto.hmac_sha256("1234567890123456789012345678901234567890", "1234567890"))

-- SHA512
local sha512_obj = crypto.hash_init("SHA512")
if sha512_obj then
    crypto.hash_update(sha512_obj, "1234567890")
    crypto.hash_update(sha512_obj, "1234567890")
    crypto.hash_update(sha512_obj, "1234567890")
    crypto.hash_update(sha512_obj, "1234567890")
    local sha512_result = crypto.hash_finish(sha512_obj)
    log.info("sha512_stream", sha512_result)
    log.info("sha512", crypto.sha512("1234567890123456789012345678901234567890"))
end

-- HMAC_SHA512
local hmac_sha512_obj = crypto.hash_init("SHA512", "1234567890")
if hmac_sha512_obj then
    crypto.hash_update(hmac_sha512_obj, "1234567890")
    crypto.hash_update(hmac_sha512_obj, "1234567890")
    crypto.hash_update(hmac_sha512_obj, "1234567890")
    crypto.hash_update(hmac_sha512_obj, "1234567890")
    local hmac_sha512_result = crypto.hash_finish(hmac_sha512_obj)
    log.info("hmac_sha512_stream", hmac_sha512_result)
    log.info("hmac_sha512", crypto.hmac_sha512("1234567890123456789012345678901234567890", "1234567890"))
end
else
log.info("crypto", "当前固件不支持crypto.hash_init")
end

log.info("crc7测试")
if crypto.crc7 then
local result = crypto.crc7(string.char(0xAA), 0xE5, 0x00)
log.info("crc7测试", result, string.format("%02X", result))
else
log.info("crypto", "当前固件不支持crypto.crc7")
end

log.info("crypto", "ALL Done")

三、常量详解

核心库常量,顾名思义是由合宙 LuatOS 内核固件中定义的、不可重新赋值或修改的固定值,在脚本代码中不需要声明,可直接调用;

每个常量对应的常量取值仅做日志打印时查询使用,不要将这个常量取值用做具体的业务逻辑判断,因为LuatOS内核固件可能会变更每个常量对应的常量取值;

如果用做具体的业务逻辑判断,一旦常量取值发生改变,业务逻辑就会出错;

3.1 哈希算法类型常量

这组常量只用作 crypto.pk_sign 与 crypto.pk_verify 的 md_type 参数,表示签名时使用的摘要算法;它们不是 crypto.md() / crypto.hash_init() 里那种字符串类型名(那边要传 "MD5" "SHA1" 这样的字符串)。

适用范围:这组常量随 pk_sign / pk_verify 一起编译,TYPE_EC718PM 与 LUAT_USE_CRYPTO_LITE 精简固件里不包含。

3.1.1 crypto.MD_MD5(MD5 摘要)

常量含义:MD5哈希类型常量,用于pk_sign/pk_verify的md_type参数;
数据类型:number;

注意事项:1. 仅用于签名/验签的参数,不能传给crypto.md();
         2. 摘要长度16字节;
示例代码:crypto.pk_sign(crypto.MD_MD5, hash, privkey)

3.1.2 crypto.MD_SHA1(SHA1 摘要)

常量含义:SHA1哈希类型常量,用于pk_sign/pk_verify的md_type参数;
数据类型:number;

注意事项:1. 摘要长度20字节;
         2. 新设计不建议再用SHA1;
示例代码:crypto.pk_sign(crypto.MD_SHA1, hash, privkey)

3.1.3 crypto.MD_SHA224(SHA224 摘要)

常量含义:SHA224哈希类型常量,用于pk_sign/pk_verify的md_type参数;
数据类型:number;

注意事项:1. 摘要长度28字节;
         2. 与签名的hash参数长度必须匹配;
示例代码:crypto.pk_sign(crypto.MD_SHA224, hash, privkey)

3.1.4 crypto.MD_SHA256(SHA256 摘要)

常量含义:SHA256哈希类型常量,用于pk_sign/pk_verify的md_type参数;
数据类型:number;

注意事项:1. 摘要长度32字节,是最常用的签名摘要;
         2. 与crypto.sha256()的输出长度一致;
示例代码:local hash = crypto.sha256("hello world"):fromHex()
         crypto.pk_sign(crypto.MD_SHA256, hash, privkey)

3.1.5 crypto.MD_SHA384(SHA384 摘要)

常量含义:SHA384哈希类型常量,用于pk_sign/pk_verify的md_type参数;
数据类型:number;

注意事项:1. 摘要长度48字节;
         2. EC P-384 曲线配它比较常见;
示例代码:crypto.pk_sign(crypto.MD_SHA384, hash, privkey)

3.1.6 crypto.MD_SHA512(SHA512 摘要)

常量含义:SHA512哈希类型常量,用于pk_sign/pk_verify的md_type参数;
数据类型:number;

注意事项:1. 摘要长度64字节;
         2. 与crypto.sha512()的输出长度一致;
示例代码:local hash = crypto.sha512("hello world"):fromHex()
         crypto.pk_sign(crypto.MD_SHA512, hash, privkey)

四、函数详解

4.1 crypto.md5(str)

计算md5值

参数

str

参数含义:需要计算的字符串
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"abc";

返回值 local data = crypto.md5(str)

data

含义说明:计算得出的md5值的hex字符串
数据类型:string;
取值范围:32;
注意事项:暂无;
返回示例:"900150983CD24FB0D6963F7D28E17F72";

示例

-- 计算字符串"abc"的md5
log.info("md5", crypto.md5("abc"))
--"900150983CD24FB0D6963F7D28E17F72"

4.2 crypto.hmac_md5(str, key)

计算hmac_md5值

参数

str

参数含义:需要计算的字符串
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"abc";

key

参数含义:密钥
数据类型:string;
取值范围:无强制上下限,但推荐 16~64 字节,最优为 64 字节;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"1234567890";

返回值 local data = crypto.hmac_md5(str, key)

data

含义说明:计算得出的md5值的hex字符串
数据类型:string;
取值范围:32;
注意事项:暂无;
返回示例:"416478FC0ACE1C4AB37F85F4F86A16B1";

示例

-- 计算字符串"abc"的hmac_md5
log.info("hmac_md5", crypto.hmac_md5("abc", "1234567890"))
--"416478FC0ACE1C4AB37F85F4F86A16B1"

4.3 crypto.sha1(str)

计算sha1值

参数

str

参数含义:需要计算的字符串
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"abc";

返回值 local data = crypto.sha1(str)

data

含义说明:计算得出的sha1值的hex字符串
数据类型:string;
取值范围:40;
注意事项:暂无;
返回示例:"A9993E364706816ABA3E25717850C26C9CD0D89D";

示例

-- 计算字符串"abc"的sha1
log.info("sha1", crypto.sha1("abc"))
--"A9993E364706816ABA3E25717850C26C9CD0D89D"

4.4 crypto.hmac_sha1(str, key)

计算hmac_sha1值

参数

str

参数含义:需要计算的字符串
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"abc";

key

参数含义:密钥
数据类型:string;
取值范围:无强制上下限,但推荐 16~64 字节,最优为 64 字节;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"1234567890";

返回值 local data = crypto.hmac_sha1(str, key)

data

含义说明:计算得出的hmac_sha1值的hex字符串
数据类型:string;
取值范围:40;
注意事项:暂无;
返回示例:"DAE54822C0DAF6C115C97B0AD62C7BCBE9D5E6FC";

示例

-- 计算字符串"abc"的hmac_sha1
log.info("hmac_sha1", crypto.hmac_sha1("abc", "1234567890"))
--"DAE54822C0DAF6C115C97B0AD62C7BCBE9D5E6FC"

4.5 crypto.sha256(str)

计算sha256值

参数

str

参数含义:需要计算的字符串
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"abc";

返回值 local data = crypto.sha256(str)

data

含义说明:计算得出的sha256值的hex字符串
数据类型:string;
取值范围:64;
注意事项:暂无;
返回示例:"BA7816BF8F01CFEA414140DE5DAE2223B00361A396177A9CB410FF61F20015AD";

示例

-- 计算字符串"abc"的sha256
log.info("sha256", crypto.sha256("abc"))
--"BA7816BF8F01CFEA414140DE5DAE2223B00361A396177A9CB410FF61F20015AD

4.6 crypto.hmac_sha256(str, key)

计算hmac_sha256值

参数

str

参数含义:需要计算的字符串
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"abc";

key

参数含义:密钥
数据类型:string;
取值范围:无强制上下限,但推荐 32~64 字节,最优为 64 字节;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"1234567890";

返回值 local data = crypto.hmac_sha256(str, key)

data

含义说明:计算得出的hmac_sha256值的hex字符串
数据类型:string;
取值范围:64;
注意事项:暂无;
返回示例:"86055184805B4A466A7BE398FF4A7159F9055EA7EEF339FC94DCEC6F165898BA";

示例

-- 计算字符串"abc"的hmac_sha256
log.info("hmac_sha256", crypto.hmac_sha256("abc", "1234567890"))
--"86055184805B4A466A7BE398FF4A7159F9055EA7EEF339FC94DCEC6F165898BA";

4.7 crypto.sha512(str)

计算sha512值

参数

str

参数含义:需要计算的字符串
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"abc";

返回值 local data = crypto.sha512(str)

data

含义说明:计算得出的sha512值的hex字符串
数据类型:string;
取值范围:128;
注意事项:暂无;
返回示例:"DDAF35A193617ABACC417349AE20413112E6FA4E89A97EA20A9EEEE64B55D39A2192992A274FC1A836BA3C23A3FEEBBD454D4423643CE80E2A9AC94FA54CA49F";

示例

-- 计算字符串"abc"的sha512
log.info("sha512", crypto.sha512("abc"))
--"DDAF35A193617ABACC417349AE20413112E6FA4E89A97EA20A9EEEE64B55D39A2192992A274FC1A836BA3C23A3FEEBBD454D4423643CE80E2A9AC94FA54CA49F"

4.8 crypto.hmac_sha512(str, key)

计算hmac_sha512值

参数

str

参数含义:需要计算的字符串
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"abc";

key

参数含义:密钥
数据类型:string;
取值范围:无强制上下限,但推荐 64~128 字节,最优为 128 字节;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"1234567890";

返回值 local data = crypto.hmac_sha512(str, key)

data

含义说明:计算得出的hmac_sha512值的hex字符串
数据类型:string;
取值范围:64;
注意事项:暂无;
返回示例:"0F92B9AC88949E0BF7C9F1E6F9901BAB8EDFDC9E561DFDE428BC4339961A0569AD01B44343AA56E439949655D15C4D28492D459E75015489920243F3C9986F2A";

示例

-- 计算字符串"abc"的hmac_sha512
log.info("hmac_sha512", crypto.hmac_sha512("abc", "1234567890"))
--"0F92B9AC88949E0BF7C9F1E6F9901BAB8EDFDC9E561DFDE428BC4339961A0569AD01B44343AA56E439949655D15C4D28492D459E75015489920243F3C9986F2A"

4.9 crypto.cipher_encrypt(type, padding, str, key, iv)

说明:crypto.cipher 是本函数的别名(与 crypto.cipher_encrypt 指向同一实现),参数与返回值完全一致,历史代码里的 crypto.cipher(...) 可以继续用。

对称加密

参数

type

参数含义:算法名称,
数据类型:string;
取值范围:{
            ["AES-128-ECB","AES-192-ECB","AES-256-ECB","AES-128-CBC","AES-192-CBC","AES-256-CBC","AES-128-CTR","AES-192-CTR","AES-256-CTR","AES-128-GCM",
            "AES-192-GCM","AES-256-GCM","AES-128-CCM","AES-192-CCM","AES-256-CCM","DES-ECB","DES-EDE-ECB","DES-EDE3-ECB","DES-CBC","DES-EDE-CBC","DES-EDE3-CBC"]
         };
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"AES-128-ECB";

padding

参数含义:对齐方式
数据类型:string;
取值范围:支持"PKCS7","ZERO","ONE_AND_ZEROS","ZEROS_AND_LEN","NONE";
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"ZERO";

str

参数含义:需要加密的数据
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"023001";

key

参数含义:密钥
数据类型:string;
取值范围:{
            无统一长度:完全依赖底层加密算法,
            AES:AES-128-* 需 16 字节(128 位), AES-192-* 需 24 字节(192 位),AES-256-* 需 32 字节(256 位)
            DES:无论模式如何,均需 8 字节(64 位,含 56 位有效密钥 + 8 位校验位)
         }
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"HZBIT@WLW/YSBKEY";

iv

参数含义:IV值
数据类型:string;
取值范围:{
            iv 长度必须与块大小一致,否则加密失败
            AES 块大小固定为 16 字节(128 位)→ iv 需 16 字节。
            DES 块大小固定为 8 字节(64 位)→ iv 需 8 字节;
         };
是否必选:非ECB算法需要;
注意事项:暂无;
参数示例:"1234567890123456";

返回值 local data_encrypt, tag = crypto.cipher_encrypt(type, padding, str, key, iv)

data_encrypt

含义说明:加密后的字符串
数据类型:string;
取值范围:cipher_encrypt 是加密函数的抽象名称,其输出的密文长度取决于多个因素,包括原始明文长度、加密算法、分组模式、填充方式等,没有固定值;
注意事项:暂无;
返回示例:可能会含有不可见字符通过data_encrypt:toHex()格式打印,如下示例所示;

tag

含义说明:AES-GCM的认证消息验证码
数据类型:string;
取值范围:16字节;
注意事项:V2021及其以上固件版本支持;
返回示例:可能会含有不可见字符通过string.toHex(tag)格式打印,如下示例所示;

示例

-- 计算AES
local data_encrypt = crypto.cipher_encrypt("AES-128-ECB", "ZERO", "023001", "HZBIT@WLW/YSBKEY")
log.info("AES", "aes-128-ecb", data_encrypt:toHex()) --013EEA6EBACCBD7AD990FAEF75FB99C4 32
local data2_encrypt = crypto.cipher_encrypt("AES-128-CBC", "PKCS7", "12345678901234 > 123456", "1234567890123456", "1234567890666666")
log.info("AES", "aes-128-cbc", data2_encrypt:toHex())--26D98EA512AE92BC487536B83F2BE99B467649A9700338F4B4FF75AA2654DD2C 64
--AES-128-GCM
local key = "0123456789abcdef" -- 16字节密钥
local iv = "abcdef9876543210"  -- 16字节初始向量
local plaintext = "Hello, LuaTools! This is a test message for GCM encryption."
log.info("Plaintext:", plaintext) --Hello, LuaTools! This is a test message for GCM encryption.
local ciphertext, tag = crypto.cipher_encrypt("AES-128-GCM", "NONE", plaintext, key, iv)
log.info("Ciphertext (hex):", string.toHex(ciphertext))--B23DD8E88600EEEE384EECC036ED5DDF51AB7CBCC73A3B53E2B63155867CDC4459C82F00070970609040B880AED39353A3F2DDD1D90E2284D26544 118
log.info("Tag (hex):", string.toHex(tag))--9097754B19EDC1C8422FA17A48CCDE50 32

4.10 crypto.cipher_decrypt(type, padding, str, key, iv, tag)

对称解密

参数

type

参数含义:算法名称,
数据类型:string;
取值范围:{
            ["AES-128-ECB","AES-192-ECB","AES-256-ECB","AES-128-CBC","AES-192-CBC","AES-256-CBC","AES-128-CTR","AES-192-CTR","AES-256-CTR","AES-128-GCM",
            "AES-192-GCM","AES-256-GCM","AES-128-CCM","AES-192-CCM","AES-256-CCM","DES-ECB","DES-EDE-ECB","DES-EDE3-ECB","DES-CBC","DES-EDE-CBC","DES-EDE3-CBC"]
         };
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"AES-128-ECB";

padding

参数含义:对齐方式
数据类型:string;
取值范围:支持"PKCS7","ZERO","ONE_AND_ZEROS","ZEROS_AND_LEN","NONE";
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"ZERO";

str

参数含义:需要解密的数据
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"013EEA6EBACCBD7AD990FAEF75FB99C4";

key

参数含义:密钥
数据类型:string;
取值范围:{
            无统一长度:完全依赖底层加密算法,
            AES:AES-128-* 需 16 字节(128 位), AES-192-* 需 24 字节(192 位),AES-256-* 需 32 字节(256 位)
            DES:无论模式如何,均需 8 字节(64 位,含 56 位有效密钥 + 8 位校验位)
         }
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"HZBIT@WLW/YSBKEY";

iv

参数含义:IV值
数据类型:string;
取值范围:{
            iv 长度必须与块大小一致,否则加密失败
            AES 块大小固定为 16 字节(128 位)→ iv 需 16 字节。
            DES 块大小固定为 8 字节(64 位)→ iv 需 8 字节;
         };
是否必选:非ECB算法需要;
注意事项:暂无;
参数示例:"1234567890666666";

tag

参数含义:AES-GCM的认证消息验证码
数据类型:string;
取值范围:16字节
是否必选:非必选;
注意事项:V2021及其以上固件版本支持;
参数示例:可能会含有不可见字符通过string.toHex(tag)格式打印,如下示例所示;

返回值

local data_encrypt = crypto.cipher_decrypt(type, padding, str, key, iv)

data_encrypt

含义说明:解密后的字符串;
数据类型:string;
取值范围:加密之前的数据长度;
注意事项:暂无;
返回示例:"023001";

示例

-- 用AES加密,然后用AES解密
local data_encrypt = crypto.cipher_encrypt("AES-128-ECB", "ZERO", "023001", "HZBIT@WLW/YSBKEY")
log.info("AES", "aes-128-ecb", data_encrypt:toHex()) --013EEA6EBACCBD7AD990FAEF75FB99C4 32
local data_decrypt = crypto.cipher_decrypt("AES-128-ECB", "ZERO", data_encrypt, "HZBIT@WLW/YSBKEY")
log.info("AES", "aes-128-ecb", data_decrypt)--023001
local data2_encrypt = crypto.cipher_encrypt("AES-128-CBC", "PKCS7", "12345678901234 > 123456", "1234567890123456", "1234567890666666")
log.info("AES", "aes-128-cbc", data2_encrypt:toHex())--26D98EA512AE92BC487536B83F2BE99B467649A9700338F4B4FF75AA2654DD2C 64
local data2_decrypt = crypto.cipher_decrypt("AES-128-CBC", "PKCS7", data2_encrypt, "1234567890123456", "1234567890666666")
log.info("AES", "aes-128-cbc", data2_decrypt)--12345678901234 > 123456
-- AES解密, AES-128-GCM 算法 对称解密,对齐方式:"NONE"
local key = "0123456789abcdef" -- 16字节密钥
local iv = "abcdef9876543210"  -- 16字节初始向量
local plaintext = "Hello, LuaTools! This is a test message for GCM encryption."
log.info("Plaintext:", plaintext) --Hello, LuaTools! This is a test message for GCM encryption.
-- 加密
local ciphertext, tag = crypto.cipher_encrypt("AES-128-GCM", "NONE", plaintext, key, iv)
log.info("Ciphertext (hex):", string.toHex(ciphertext))--B23DD8E88600EEEE384EECC036ED5DDF51AB7CBCC73A3B53E2B63155867CDC4459C82F00070970609040B880AED39353A3F2DDD1D90E2284D26544 118
log.info("Tag (hex):", string.toHex(tag))--9097754B19EDC1C8422FA17A48CCDE50 32
-- 解密
local decrypted_text = crypto.cipher_decrypt("AES-128-GCM", "NONE", ciphertext, key, iv, tag)
log.info("Decrypted Text:", decrypted_text)--Hello, LuaTools! This is a test message for GCM encryption.
log.info("GCM Encryption/Decryption Test Completed")
-- 对照一下网页上的加密结果
-- https://www.devglan.com/online-tools/aes-encryption-decryption
-- 注意, 这个网站的GCM加密结果是把tag附加在密文后面的
log.info("is same?", decrypted_text == plaintext)--is same? true
-- B23DD8E88600EEEE384EECC036ED5DDF51AB7CBCC73A3B53E2B63155867CDC4459C82F00070970609040B880AED39353A3F2DDD1D90E2284D26544
log.info("is same?", string.toHex(ciphertext) == "B23DD8E88600EEEE384EECC036ED5DDF51AB7CBCC73A3B53E2B63155867CDC4459C82F00070970609040B880AED39353A3F2DDD1D90E2284D26544")--is same? true

4.11 crypto.crc16(method, data, poly, initial, finally, inReverse, outReverse)

计算CRC16

参数

method

参数含义:CRC16模式;
数据类型:string;
取值范围:"IBM","MAXIM","USB","MODBUS","CCITT","CCITT-FALSE","X25","XMODEM","DNP","USER-DEFINED";
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"IBM";

data

参数含义:需要校验的字符串;
数据类型:string或者zbuff对象;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"123456sdfdsfdsfdsffdsfdsfsdfs1234";

poly

参数含义:16 位多项式;
数据类型:number;
取值范围:范围0-0xFFFF;
是否必选:可选传入此参数,默认0x0000;
注意事项:暂无;
参数示例:0x0000;

initial

参数含义:初始校验值;
数据类型:number;
取值范围:范围0-0xFFFF;
是否必选:可选传入此参数,默认0x0000;
注意事项:暂无;
参数示例:0x0000;

finally

参数含义:计算完成后的异或值;
数据类型:number;
取值范围:范围0-0xFFFF;
是否必选:可选传入此参数,默认0x0000;
注意事项:暂无;
参数示例:0x0000;

inReverse

参数含义:输入字节是否进行位反转(影响每个字节的处理顺序);
数据类型:number;
取值范围:1反转,默认0不反转;
是否必选:可选传入此参数,不填时,默认是0;
注意事项:暂无;
参数示例:0;

outReverse

参数含义:输出数据是否进行逆序;
数据类型:number;
取值范围:0执行逆序, 1不执行, 默认0;
是否必选:可选传入此参数,不填时,默认是0;
注意事项:暂无;
参数示例:0;

返回值

local crc16 = crypto.crc16(method, data, poly, initial, finally, inReverse, outReverse)

crc16

含义说明:对应的CRC16值;
数据类型:number;
取值范围:0 到 65535;
注意事项:暂无;
返回示例:54188;

示例

-- 计算CRC16
local originStr = "123456sdfdsfdsfdsffdsfdsfsdfs1234"
local crc16 = crypto.crc16("MODBUS",originStr)
log.info("crc16", crc16) --54188

4.12 crypto.crc16_modbus(data, start)

直接计算modbus的crc16值

参数

data

参数含义:需要校验的字符串;
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"123456sdfdsfdsfdsffdsfdsfsdfs1234";

start

参数含义:初始化值,默认0xFFFF;
数据类型:number;
取值范围:0x0000 ~ 0xFFFF;
是否必选:可选传入此参数,不填时,默认是0xFFFF;
注意事项:暂无;
参数示例:0xFFFF;

返回值

local crc16 = crypto.crc16_modbus(data, start)

crc16

含义说明:对应的CRC16值;
数据类型:number;
取值范围:0 到 65535;
注意事项:暂无;
返回示例:54188;

示例

-- 计算CRC16 modbus
local crc16 = crypto.crc16_modbus("123456sdfdsfdsfdsffdsfdsfsdfs1234")
log.info("crc16", crc16)  --54188
-- 2023.11.06 新增初始值设置
crc16 = crypto.crc16_modbus("123456sdfdsfdsfdsffdsfdsfsdfs1234", 0xFFFF)
log.info("crc16", crc16)  --54188

4.13 crypto.crc32(data, start, poly, endv)

计算crc32值

参数

data

参数含义:需要校验的字符串;
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"sdfdsfdsfdsffdsfdsfsdfs1234";

start

参数含义:初始化值,默认0xFFFFFFFF;
数据类型:number;
取值范围:0x00000000 ~ 0xFFFFFFFF;
是否必选:可选传入此参数,不填时,默认0xFFFFFFFF;
注意事项:暂无;
参数示例:0xFFFFFFFF;

poly

参数含义:crc多项式;
数据类型:number;
取值范围:0x00000000 ~ 0xFFFFFFFF;
是否必选:可选,默认0x04C11DB7;
注意事项:暂无;
参数示例:0x04C11DB7;

endv

参数含义:结束值,计算完成后与结果进行异或的值(32 位整数);
数据类型:number;
取值范围:0x00000000 ~ 0xFFFFFFFF;
是否必选:可选,默认0xFFFFFFFF;
注意事项:暂无;
参数示例:0xFFFFFFFF;

返回值

local crc32 = crypto.crc32(data, start, poly, endv)

crc16

含义说明:对应的CRC32值;
数据类型:number;
取值范围:32 位 CRC 校验值(范围:0x00000000 ~ 0xFFFFFFFF);
注意事项:暂无;
返回示例:21438764;

示例

-- 计算CRC32
local data = "123456sdfdsfdsfdsffdsfdsfsdfs1234" 
local crc32 = crypto.crc32(data)
log.info("crc32", crc32) --21438764
-- start和poly可选, 是 2025.4.14 新增的参数
local crc32 = crypto.crc32(data, 0xFFFFFFFF, 0x04C11DB7, 0xFFFFFFFF) --等同于crypto.crc32(data)
log.info("crc32", crc32) --21438764

4.14 crypto.crc8(data, poly, start, revert)

计算crc8值

参数

data

参数含义:需要校验的字符串;
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"sdfdsfdsfdsffdsfdsfsdfs1234";

poly

参数含义:crc多项式;
数据类型:number;
取值范围:0x00 ~ 0xFF;
是否必选:可选,如果不写,默认值为0;
注意事项:如果不写,将忽略除了数据外所有参数;
参数示例:0x0;

start

参数含义:crc初始值;
数据类型:number;
取值范围:0x00 ~ 0xFF;
是否必选:可选传入此参数,不填时,默认0;
注意事项:暂无;
参数示例:0;

revert

参数含义:是否需要逆序处理;
数据类型:boolean;
取值范围:true/false;
是否必选:可选,默认false;
注意事项:暂无;
参数示例:false;

返回值

local crc8 = crypto.crc8(data, poly, start, revert)

crc8

含义说明:对应的CRC8值;
数据类型:int;
取值范围:0 到 255;
注意事项:暂无;
返回示例:197;

示例

-- 计算CRC8
local data= "sdfdsfdsfdsffdsfdsfsdfs1234"
local crc8 = crypto.crc8(data)
log.info("crc8", crc8) --197
local crc8 = crypto.crc8(data, 0x31, 0xff, false)
log.info("crc8", crc8) --243

4.15 crypto.crc7(data, poly, start)

计算crc7值

参数

data

参数含义:需要校验的字符串;
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"abc";

poly

参数含义:crc多项式;
数据类型:number;
取值范围:0x80 ~ 0xFF;
是否必选:可选,默认0xE5;
注意事项:暂无;
参数示例:0xE5;

start

参数含义:crc初始值;
数据类型:number;
取值范围:0x00 ~ 0x7F;
是否必选:可选传入此参数,不填时,默认0x00;
注意事项:暂无;
参数示例:0x00;

返回值

local crc7 = crypto.crc7(data, poly, start)

crc7

含义说明:对应的CRC7值;
数据类型:number;
取值范围:7 位的整数(范围:0x00 ~ 0x7F),即 CRC7 校验结果;
注意事项:暂无;
返回示例:50;

示例

-- 计算CRC7, 本API于2023.10.07新增
local result = crypto.crc7("abc", 0xE5, 0x00)
log.info("crc7", result, string.format("%02X", result))  --25 19

4.16 crypto.trng(len)

生成真随机数

参数

len

参数含义:生成真随机数的字节长度;
数据类型:number;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:4;

返回值

local trdata = crypto.trng(len)

trdata

含义说明:指定长度随机数字符串;
数据类型:string;
取值范围:和指定长度有关;
注意事项:暂无;
返回示例:打印可能有不可显示字符,可以参考下面示例打印结果;

示例

-- 生成32位随机数ir
local r = crypto.trng(4)
local _, ir = pack.unpack(r, "I")
log.info("crypto ir", "真随机数",r,r:toHex(),ir) --��E; 96F5453B 994440598

4.17 crypto.totp(secret,time)

计算TOTP动态密码的结果

参数

secret

参数含义:密钥(网站提供的密钥(BASE32编码后的结果));
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"VK54ZXPO74ISEM2E";

time

参数含义:时间戳;
数据类型:number;
取值范围:无特别限制;
是否必选:可选传入此参数,不填时,默认当前时间;
注意事项:暂无;
参数示例:1646796576;

返回值

local totp = crypto.totp(secret,time)

totp

含义说明:计算得出的六位数结果,计算失败返回nil;
数据类型:number;
取值范围:六位数结果或者nil;
注意事项:暂无;
返回示例:491229;

示例

local totp = crypto.totp("VK54ZXPO74ISEM2E") 
log.info("totp",totp)  --491229

4.18 crypto.base64_encode(data)

将数据进行base64编码

参数

data

参数含义:待编码的数据;
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"123";

返回值

local bdata = crypto.base64_encode(data)

bdata

含义说明:编码后的数据;
数据类型:string;
取值范围:无特别限制;
注意事项:暂无;
返回示例:"MTIz";

示例

-- 本函数与 string.toBase64 是同一个
local bdata = crypto.base64_encode("123")
log.info("base64", "encode", bdata) --MTIz

4.19 crypto.base64_decode(data)

将数据进行base64解码

参数

data

参数含义:待解码的数据;
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"MTIz";

返回值

local data = crypto.base64_decode(data)

data

含义说明:解码后的数据;
数据类型:string;
取值范围:无特别限制;
注意事项:暂无;
返回示例:"123";

示例

-- 本函数与 string.fromBase64 是同一个
local data = crypto.base64_decode("MTIz")
log.info("base64", "decode", bdata, data)--123

4.20 crypto.cipher_list()

获取当前固件支持的cipher列表

参数

无

返回值

local ciphers = crypto.cipher_list()

ciphers

含义说明:本固件支持的cipher列表,字符串数组;
数据类型:table;
取值范围:无特别限制;
注意事项:暂无;
返回示例:{
            ["AES-128-ECB","AES-192-ECB","AES-256-ECB","AES-128-CBC","AES-192-CBC","AES-256-CBC","AES-128-CTR","AES-192-CTR","AES-256-CTR","AES-128-GCM",
            "AES-192-GCM","AES-256-GCM","AES-128-CCM","AES-192-CCM","AES-256-CCM","DES-ECB","DES-EDE-ECB","DES-EDE3-ECB","DES-CBC","DES-EDE-CBC","DES-EDE3-CBC"]
         }

示例

-- 本API于2022.07.27添加
local ciphers = crypto.cipher_list()
if ciphers then
    log.info("crypto", "ciphers list", json.encode(ciphers))
end
--["AES-128-ECB","AES-192-ECB","AES-256-ECB","AES-128-CBC","AES-192-CBC","AES-256-CBC","AES-128-CTR","AES-192-CTR","AES-256-CTR","AES-128-GCM",
--"AES-192-GCM","AES-256-GCM","AES-128-CCM","AES-192-CCM","AES-256-CCM","DES-ECB","DES-EDE-ECB","DES-EDE3-ECB","DES-CBC","DES-EDE-CBC","DES-EDE3-CBC"]

4.21 crypto.cipher_suites()

获取当前固件支持的cipher suites列表

参数

无

返回值

含义说明:本固件支持的cipher suites列表,字符串数组;
数据类型:table;
取值范围:无特别限制;
注意事项:暂无;
返回示例:{
            ["TLS-RSA-WITH-AES-128-CCM","TLS-RSA-WITH-AES-128-CBC-SHA","TLS-RSA-WITH-AES-128-CCM-8",
            "TLS-RSA-WITH-AES-128-CBC-SHA256","TLS-RSA-WITH-AES-256-CCM","TLS-RSA-WITH-AES-256-CBC-SHA256",
            "TLS-RSA-WITH-AES-256-CBC-SHA","TLS-RSA-WITH-AES-256-CCM-8","TLS-RSA-WITH-AES-128-GCM-SHA256",
            "TLS-RSA-WITH-AES-256-GCM-SHA384","TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384","TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384",
            "TLS-ECDHE-ECDSA-WITH-AES-256-CCM","TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384","TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384",
            "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA","TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA","TLS-ECDHE-ECDSA-WITH-AES-256-CCM-8",
            "TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256","TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256","TLS-ECDHE-ECDSA-WITH-AES-128-CCM",
            "TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256","TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256","TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA",
            "TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA","TLS-ECDHE-ECDSA-WITH-AES-128-CCM-8","TLS-RSA-PSK-WITH-AES-256-GCM-SHA384",
            "TLS-RSA-PSK-WITH-AES-256-CBC-SHA384","TLS-RSA-PSK-WITH-AES-256-CBC-SHA","TLS-RSA-PSK-WITH-AES-128-GCM-SHA256",
            "TLS-RSA-PSK-WITH-AES-128-CBC-SHA256","TLS-RSA-PSK-WITH-AES-128-CBC-SHA"]
         }

示例

-- 本API于2022.11.16添加
local suites = crypto.cipher_suites()
if suites then
    log.info("crypto", "ciphers suites", json.encode(suites))
end
--[[
["TLS-RSA-WITH-AES-128-CCM","TLS-RSA-WITH-AES-128-CBC-SHA","TLS-RSA-WITH-AES-128-CCM-8",
"TLS-RSA-WITH-AES-128-CBC-SHA256","TLS-RSA-WITH-AES-256-CCM","TLS-RSA-WITH-AES-256-CBC-SHA256",
"TLS-RSA-WITH-AES-256-CBC-SHA","TLS-RSA-WITH-AES-256-CCM-8","TLS-RSA-WITH-AES-128-GCM-SHA256",
"TLS-RSA-WITH-AES-256-GCM-SHA384","TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384","TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384",
"TLS-ECDHE-ECDSA-WITH-AES-256-CCM","TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384","TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384",
"TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA","TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA","TLS-ECDHE-ECDSA-WITH-AES-256-CCM-8",
"TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256","TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256","TLS-ECDHE-ECDSA-WITH-AES-128-CCM",
"TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256","TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256","TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA",
"TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA","TLS-ECDHE-ECDSA-WITH-AES-128-CCM-8","TLS-RSA-PSK-WITH-AES-256-GCM-SHA384",
"TLS-RSA-PSK-WITH-AES-256-CBC-SHA384","TLS-RSA-PSK-WITH-AES-256-CBC-SHA","TLS-RSA-PSK-WITH-AES-128-GCM-SHA256",
"TLS-RSA-PSK-WITH-AES-128-CBC-SHA256","TLS-RSA-PSK-WITH-AES-128-CBC-SHA"]
 ]]           

4.22 crypto.md_file(tp, path, hmac)

计算文件的hash值(md5/sha1/sha256及hmac形式)

参数

tp

参数含义:hash算法类型;
数据类型:string;
取值范围:"MD5" "SHA1" "SHA256";
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"MD5";

path

参数含义:文件路径, 例如 "/luadb/logo.jpg";
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"/luadb/logo.jpg";

hmac

参数含义:hmac密钥;
数据类型:string;
取值范围:无特别限制;
是否必选:可选;
注意事项:暂无;
参数示例:"123456";

返回值

local hashdata = crypto.md_file(tp, path, hmac)

hashdata

含义说明:HEX过的hash值,若失败会无返回值;
数据类型:string或者nil;
取值范围:{
            算法为MD5返回32长度hex字符串,
            算法为SHA1返回40长度hex字符串,
            算法为SHA256返回64长度hex字符串;
         }
注意事项:暂无;
返回示例:"D364D04CCD734D2757B25F3216CC431B";

示例

-- 无hmac的hash值
log.info("md5", crypto.md_file("MD5", "/luadb/logo.jpg"))
--D364D04CCD734D2757B25F3216CC431B
log.info("sha1", crypto.md_file("SHA1", "/luadb/logo.jpg"))
--04DA64874D415B1FB9CDD2E89927397D8F48C441
log.info("sha256", crypto.md_file("SHA256", "/luadb/logo.jpg"))
--0C601722B4BD2BC1A76BC3701F4EB646F5119C31702852978C326CD8D7C9212C
-- 带hmac的hash值
log.info("hmac_md5", crypto.md_file("MD5", "/luadb/logo.jpg", "123456"))
--B5F5A687DB904DB67D3311899932DD61
log.info("hmac_sha1", crypto.md_file("SHA1", "/luadb/logo.jpg", "123456"))
--2A0B55C290D54ADF2F185EAE460254D267C7CE1F
log.info("hmac_sha256", crypto.md_file("SHA256", "/luadb/logo.jpg", "123456"))
--6E443C84D4D7A4721A9A195EB9038EDCFA8A8F60A3F1E8A0090B57B3BAB4942E

4.23 crypto.md(tp, data, hmac)

计算数据的hash值(md5/sha1/sha256及hmac形式)

参数

tp

参数含义:hash算法类型
         {
             crypto.md("MD5", data) 相当于 crypto.md5(str),
             crypto.md("MD5", data,hmac) 相当于 crypto.hmac_md5(str, key),
             crypto.md("SHA1", data) 相当于 crypto.sha1(str), 
             crypto.md("SHA1", data,hmac) 相当于 crypto.hmac_sha1(str, key),
             crypto.md("SHA256", data) 相当于 crypto.sha256(str), 
             crypto.md("SHA256", data,hmac) 相当于 crypto.hmac_sha256(str, key),
         };
数据类型:string;
取值范围:"MD5" "SHA1" "SHA256";
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"MD5";

data

参数含义:待处理的数据;
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"1234567890";

hmac

参数含义:hmac密钥;
数据类型:string;
取值范围:无特别限制;
是否必选:可选;
注意事项:暂无;
参数示例:"123456";

返回值

local hashdata = crypto.md(tp, data, hmac)

hashdata

含义说明:HEX过的hash值,若失败会无返回值;
数据类型:string或者nil;
取值范围:{
            算法为MD5返回32长度hex字符串,
            算法为SHA1返回40长度hex字符串,
            算法为SHA256返回64长度hex字符串;
         };
注意事项:暂无;
返回示例:"E807F1FCF82D132F9BB018CA6738A19F";

示例

-- 无hmac的hash值
log.info("md5", crypto.md("MD5", "1234567890"))
--E807F1FCF82D132F9BB018CA6738A19F
log.info("sha1", crypto.md("SHA1", "1234567890"))
--01B307ACBA4F54F55AAFC33BB06BBBF6CA803E9A
log.info("sha256", crypto.md("SHA256", "1234567890"))
--C775E7B757EDE630CD0AA1113BD102661AB38829CA52A6422AB782862F268646
-- 带hmac的hash值
log.info("hmac_md5", crypto.md("MD5", "1234567890", "123456"))
--3324A5385619D5485AAD1D8D274214A0
log.info("hmac_sha1", crypto.md("SHA1", "1234567890", "123456"))
--E374E1A5449F65E6566F910BAE824CE163B4CE3D
log.info("hmac_sha256", crypto.md("SHA256", "1234567890", "123456"))
--30CFE99B630FCFB71DA1D68FAAC41B9944728A44244A385DDAE0ADB35910BB41

4.24 crypto.hash_init(tp,hmac)

创建流式hash用的stream

参数

tp

参数含义:hash算法类型;
数据类型:string;
取值范围:"MD5" "SHA1" "SHA256";
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"MD5";

hmac

参数含义:hmac密钥值;
数据类型:string;
取值范围:无特别限制;
是否必选:可选;
注意事项:暂无;
参数示例:"123456";

返回值

含义说明:成功返回一个数据结构,否则返回nil;
数据类型:userdata;
取值范围:无特别限制;
注意事项:暂无;
返回示例:;

示例

-- 无hmac的hash stream
local md5_stream = crypto.hash_init("MD5")
local sha1_stream = crypto.hash_init("SHA1")
local sha256_stream = crypto.hash_init("SHA256")

-- 带hmac的hash stream
local md5_stream = crypto.hash_init("MD5", "123456")
local sha1_stream = crypto.hash_init("SHA1", "123456")
local sha256_stream = crypto.hash_init("SHA256", "123456")

4.25 crypto.hash_update(stream, data)

流式hash更新数据

参数

stream

参数含义:crypto.hash_init()创建的stream;
数据类型:userdata;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:;

data

参数含义:待计算的数据;
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"OK";

返回值

无

示例

crypto.hash_update(stream, "OK")

4.26 crypto.hash_finish(stream)

获取流式hash校验值并释放创建的stream

参数

stream

参数含义:crypto.hash_init()创建的stream;
数据类型:userdata;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:;

返回值

local hashResult = crypto.hash_finish(stream)

hashResult

含义说明:成功返回计算得出的流式hash值的hex字符串,失败无返回;
数据类型:string;
取值范围:无特别限制;
注意事项:暂无;
返回示例:"F5BF3E984432AE6F9F98840951E5CEF3";

示例

-- MD5
local md5_obj = crypto.hash_init("MD5")
crypto.hash_update(md5_obj, "1234567890")
crypto.hash_update(md5_obj, "1234567890")
crypto.hash_update(md5_obj, "1234567890")
crypto.hash_update(md5_obj, "1234567890")
local md5_result = crypto.hash_finish(md5_obj)
log.info("md5_stream", md5_result) --F5BF3E984432AE6F9F98840951E5CEF3
log.info("md5", crypto.md5("1234567890123456789012345678901234567890")) --F5BF3E984432AE6F9F98840951E5CEF3

4.27 crypto.checksum(data, mode)

计算checksum校验和

参数

data

参数含义:待计算的数据;
数据类型:string;
取值范围:无特别限制;
是否必选:必须传入此参数;
注意事项:暂无;
参数示例:"OK";

mode

参数含义:模式(0 异或, 1 累加);
数据类型:number;
取值范围:0 异或, 1 累加;
是否必选:非必须传入此参数,默认为0;
注意事项:暂无;
参数示例:0;

返回值

local ck = crypto.checksum(data, mode)

ck

含义说明:checksum值,校验和;
数据类型:number;
取值范围:0 ~ 255
注意事项:暂无;
返回示例:4;

示例

-- 本函数在 2022.12.28 添加
-- 单纯计算checksum值
local ck = crypto.checksum("OK")
log.info("checksum", "ok", string.format("%02X", ck))--04
-- 第二个参数mode在2023.5.23日添加

4.28 crypto.crc_file(mode, path, ...)

计算文件的 CRC 校验值

参数

mode

参数含义:CRC模式;
数据类型:string;
取值范围:"crc32" 计算crc32,"crc8" 计算crc8,"crc16_modbus" 计算modbus crc16,
         其他值则作为crc16的method参数(IBM/MAXIM/USB/MODBUS/CCITT/CCITT-FALSE/X25/XMODEM/DNP/USER-DEFINED);
是否必选:必须传入此参数;
注意事项:模式字符串区分大小写,按上面的写法传;
参数示例:"crc32";

path

参数含义:待计算文件的路径;
数据类型:string;
取值范围:文件系统内的合法路径;
是否必选:必须传入此参数;
注意事项:文件不存在时无返回值,调用后要判空;
参数示例:"/luadb/test.bin";

...

参数含义:crc32 或自定义 crc16 时可选的多余参数,依次为 poly、initial、finally 等;
数据类型:number;
取值范围:按所选算法决定;
是否必选:非必须传入此参数;
注意事项:不传则使用该算法的默认参数;
参数示例:0x04C11DB7;

返回值

local crc = crypto.crc_file(mode, path, ...)

crc

含义说明:文件计算得到的CRC值;
数据类型:number;
取值范围:随算法而定;
注意事项:文件不存在时无返回值;
返回示例:3735928559;

示例

-- 计算文件的CRC32
local crc = crypto.crc_file("crc32", "/luadb/test.bin")
log.info("crc32", string.format("%08X", crc))
-- 自定义参数的CRC32
local crc2 = crypto.crc_file("crc32", "/luadb/test.bin", 0xFFFFFFFF, 0x04C11DB7, 0xFFFFFFFF)
-- CRC16 MODBUS
local crc3 = crypto.crc_file("crc16_modbus", "/luadb/test.bin")
-- CRC16 IBM(其他值按 crc16 的 method 处理)
local crc4 = crypto.crc_file("IBM", "/luadb/test.bin")
-- CRC8
local crc5 = crypto.crc_file("crc8", "/luadb/test.bin")

4.29 crypto.pk_generate(key_type, param)

生成非对称密钥对(RSA / EC),私钥与公钥都以 PEM 字符串返回

参数

key_type

参数含义:密钥类型;
数据类型:string;
取值范围:"rsa" 或 "ec";
是否必选:必须传入此参数;
注意事项:传其他值会返回nil;
参数示例:"rsa";

param

参数含义:密钥参数,RSA 时为位数,EC 时为曲线名;
数据类型:string;
取值范围:RSA 传 "2048" 这类位数字符串;EC 传 "P-256"/"P-384"/"P-521";
是否必选:可选,不传则使用默认值;
注意事项:RSA 位数越大生成越慢,模组上建议 2048;
参数示例:"2048";

返回值

local priv, pub = crypto.pk_generate(key_type, param)

priv

含义说明:私钥PEM字符串;
数据类型:string;
取值范围:PEM文本;
注意事项:失败时返回nil;
返回示例:"-----BEGIN PRIVATE KEY-----...";

pub

含义说明:公钥PEM字符串;
数据类型:string;
取值范围:PEM文本;
注意事项:失败时返回nil;
返回示例:"-----BEGIN PUBLIC KEY-----...";

示例

-- 生成 RSA-2048 密钥对
local priv, pub = crypto.pk_generate("rsa", "2048")
-- 生成 EC P-256 密钥对
local priv, pub = crypto.pk_generate("ec", "P-256")
if priv and pub then
    log.info("pk", "gen ok", #priv, #pub)
end

注意事项

生成的密钥对占用的堆空间与位数相关,RSA-2048 在内存紧张的固件上要留足余量;私钥属于敏感数据,落盘时建议加密或放在受限分区。

4.30 crypto.pk_sign(md_type, hash, privkey, password)

使用非对称私钥签名,自动识别密钥类型(RSA / EC)

参数

md_type

参数含义:hash算法类型常量;
数据类型:number;
取值范围:crypto.MD_MD5 / MD_SHA1 / MD_SHA224 / MD_SHA256 / MD_SHA384 / MD_SHA512;
是否必选:必须传入此参数;
注意事项:这里的长度必须与传入的hash原始字节长度匹配;
参数示例:crypto.MD_SHA256;

hash

参数含义:待签名的hash原始字节;
数据类型:string;
取值范围:长度须与所选摘要算法输出一致(SHA256为32字节);
是否必选:必须传入此参数;
注意事项:必须是原始字节(用 :fromHex() 转换),不能直接传hex字符串;
参数示例:crypto.sha256("hello world"):fromHex();

privkey

参数含义:私钥数据;
数据类型:string;
取值范围:PEM格式(-----BEGIN ...)或DER二进制;
是否必选:必须传入此参数;
注意事项:EC 私钥与 RSA 私钥都支持PEM,密钥类型由内容自动识别;
参数示例:私钥PEM字符串;

password

参数含义:私钥密码;
数据类型:string;
取值范围:加密私钥的密码;
是否必选:非必须传入此参数,默认为空;
注意事项:私钥未加密时不传;
参数示例:"123456";

返回值

local sig = crypto.pk_sign(md_type, hash, privkey, password)

sig

含义说明:签名结果;
数据类型:string;
取值范围:原始字节(非hex);
注意事项:失败时返回nil,调用后要判空;
返回示例:二进制签名串;

示例

-- RSA 签名
local hash = crypto.sha256("hello world"):fromHex()
local sig = crypto.pk_sign(crypto.MD_SHA256, hash, privkey_pem)
log.info("pk", "sign len", sig and #sig or 0)

-- EC 签名(私钥为 PEM,验签侧公钥用 SPKI 格式)
local hash = crypto.sha256("hello world"):fromHex()
local sig2 = crypto.pk_sign(crypto.MD_SHA256, hash, ec_privkey_pem)
log.info("pk", "ec sign len", sig2 and #sig2 or 0)

注意事项

TYPE_EC718PM 与 LUAT_USE_CRYPTO_LITE 精简固件不含本组接口,用到签名要选完整固件。

4.31 crypto.pk_verify(md_type, hash, pubkey, signature)

使用非对称公钥验签,自动识别密钥类型(RSA / EC)

参数

md_type

参数含义:hash算法类型常量;
数据类型:number;
取值范围:与签名时使用的常量一致;
是否必选:必须传入此参数;
注意事项:签名与验签必须用同一种摘要算法;
参数示例:crypto.MD_SHA256;

hash

参数含义:待验证的hash原始字节;
数据类型:string;
取值范围:长度与摘要算法输出一致;
是否必选:必须传入此参数;
注意事项:对被验签原文重新算一次摘要再传进来;
参数示例:crypto.sha256("hello world"):fromHex();

pubkey

参数含义:公钥数据;
数据类型:string;
取值范围:PEM格式或DER二进制;
是否必选:必须传入此参数;
注意事项:RSA 支持 "-----BEGIN RSA PUBLIC KEY-----" 与 "-----BEGIN PUBLIC KEY-----",EC 只支持 SPKI 格式的 "-----BEGIN PUBLIC KEY-----";
参数示例:公钥PEM字符串;

signature

参数含义:签名数据;
数据类型:string;
取值范围:pk_sign 返回的原始字节;
是否必选:必须传入此参数;
注意事项:不要做hex转换,原样传入;
参数示例:sig;

返回值

local ok = crypto.pk_verify(md_type, hash, pubkey, signature)

ok

含义说明:验签结果;
数据类型:boolean;
取值范围:true 验签成功,false 验签失败;
注意事项:公钥格式不对时会直接返回false,先确认PEM头;
返回示例:true;

示例

local hash = crypto.sha256("hello world"):fromHex()
local ok = crypto.pk_verify(crypto.MD_SHA256, hash, pubkey_pem, sig)
log.info("pk", "verify", ok)

4.32 crypto.pk_type(key, is_private)

获取密钥的类型字符串

参数

key

参数含义:密钥数据;
数据类型:string;
取值范围:PEM格式或DER二进制;
是否必选:必须传入此参数;
注意事项:解析不出类型时返回nil;
参数示例:公钥PEM字符串;

is_private

参数含义:是否为私钥;
数据类型:boolean;
取值范围:true 私钥,false/nil 公钥;
是否必选:非必须传入此参数,默认按公钥处理;
注意事项:传错会解析失败,拿到nil先检查这个参数;
参数示例:true;

返回值

local ktype = crypto.pk_type(key, is_private)

ktype

含义说明:密钥类型字符串;
数据类型:string;
取值范围:"rsa" / "ec" / "ecdsa" / "ec_dh" 等;
注意事项:解析失败返回nil;
返回示例:"rsa";

示例

local kpub  = crypto.pk_type(pubkey_pem)          -- 公钥
local kpriv = crypto.pk_type(privkey_pem, true)   -- 私钥
log.info("pk", "key type", kpub, kpriv)

五、产品支持说明

支持LuatOS开发的所有产品都支持cryto核心库。

搜索