Go to file
Zhi Guan 926e063353 Fix sm4-cbc iv related bug 2024-05-20 18:02:16 +08:00
.github/workflows 修复Windows编译的问题。 2024-04-20 12:23:30 +08:00
demos Update demos 2023-12-16 11:42:10 +08:00
docs/tools Create docs folder 2023-02-25 21:57:40 +08:00
include/gmssl Remove warnings 2024-05-17 13:12:51 +08:00
src Fix sm4-cbc iv related bug 2024-05-20 18:02:16 +08:00
tests Remove warnings 2024-05-17 13:12:51 +08:00
tools Remove warnings 2024-05-17 13:12:51 +08:00
.gitignore Use z256 and jacobian coordinates as inner presentation of SM2 point 2024-04-18 21:27:00 +08:00
CMakeLists.txt Remove warnings 2024-05-17 13:12:51 +08:00
INSTALL.md Update INSTALL.md 2023-02-23 14:09:56 +08:00
LICENSE Revert "修改License" 2022-08-26 13:44:26 +08:00
README.md Update README.md 2024-05-17 16:21:36 +08:00

README.md

GmSSL

CMake-Ubuntu/macOS CMake-Windows CMake-Android CMake-iOS

GmSSL是由北京大学自主开发的国产商用密码开源库实现了对国密算法、标准和安全通信协议的全面功能覆盖支持包括移动端在内的主流操作系统和处理器支持密码钥匙、密码卡等典型国产密码硬件提供功能丰富的命令行工具及多种编译语言编程接口。

主要特性

  • 超轻量GmSSL 3 大幅度降低了内存需求和二进制代码体积,不依赖动态内存,可以用于无操作系统的低功耗嵌入式环境(MCU、SOC等)开发者也可以更容易地将国密算法和SSL协议嵌入到现有的项目中。
  • 更合规GmSSL 3 可以配置为仅包含国密算法和国密协议(TLCP协议)依赖GmSSL 的密码应用更容易满足密码产品型号检测的要求,避免由于混杂非国密算法、不安全算法等导致的安全问题和合规问题。
  • 更安全TLS 1.3在安全性和通信延迟上相对之前的TLS协议有巨大的提升GmSSL 3 支持TLS 1.3协议和RFC 8998的国密套件。GmSSL 3 默认支持密钥的加密保护,提升了密码算法的抗侧信道攻击能力。
  • 跨平台GmSSL 3 更容易跨平台构建系统不再依赖Perl默认的CMake构建系统可以容易地和Visual Studio、Android NDK等默认编译工具配合使用开发者也可以手工编写Makefile在特殊环境中编译、剪裁。

下载

  • GmSSL的主分支版本为 GmSSL-3.1.1主要增加跨平台特性特别是对Windows/Visual Studio的支持Windows、Android、iOS平台的开发者需要使用该版本。

编译与安装

GmSSL 3 采用了cmake构建系统。下载源代码后将其解压缩进入源码目录执行

mkdir build
cd build
cmake ..
make
make test
sudo make install

make install完成后GmSSL会在默认安装目录中安装gmssl命令行工具,在头文件目录中创建gmssl目录,并且在库目录中安装libgmssl.alibgmssl.so等库文件。

Visual Studio环境编译

在Visual Studio命令提示符下执行

mkdir build
cd build
cmake .. -G "NMake Makefiles" -DWIN32=ON
nmake

主要功能

密码算法

  • 分组密码SM4 (CBC/CTR/GCM), AES (CBC/CTR/GCM)
  • 序列密码ZUC/ZUC-256, ChaCha20, RC4
  • 哈希函数: SM3, SHA-224/256/384/512, SHA-1, MD5
  • 公钥密码SM2加密/签名, SM9加密/签名
  • MAC算法HMAC, GHASH
  • 密钥导出函数PBKDF2、HKDF
  • 随机数生成器Intel RDRAND, HASH_DRBG (NIST.SP.800-90A)

证书和数字信封

  • 数字证书X.509证书, CRL证书注销列表, CSR (PKCS #10) 证书签名请求
  • 私钥加密基于SM4/SM3口令加密的PEM格式私钥 (PKCS #8)
  • 数字信封SM2密码消息 (GM/T 0010-2012)

SSL协议

  • TLCP 1.1,支持密码套TLS_ECC_SM4_CBC_SM3 {0xE0,0x13} (GB/T 38636-2020、GM/T 0024-2014)
  • TLS 1.2,支持密码套件TLS_ECDHE_SM4_CBC_SM3 {0xE0,0x11} (GB/T 38636-2020、GM/T 0024-2014)
  • TLS 1.3,支持密码套件TLS_SM4_GCM_SM3 {0x00,0xC6} (RFC 8998)

多语言接口

GmSSL通过子项目提供多种多种编程语言绑定

  • GmSSL-Java 以JNI方式实现的Java语言绑定
  • GmSSL-PHP 以PHP扩展方式实现的PHP语言绑定
  • GmSSL-Go 以CGO方式实现的Go语言绑定
  • GmSSL-Python 以ctypes方式实现的Python语言绑定
  • GmSSL-JS 纯JavaScript实现的国密算法库

典型应用

Nginx-with-GmSSL3.0

GmSSL支持Nginx的适配并提供了Docker实现具体参见Nginx-with-GmSSL3.0 项目。

ChangeLog

自从3.1.1版本以来

  • 提升了全部国密算法的性能,并在tests测试程序中增加了国密算法的性能测试
  • 增加了SM4 ECB/CFB/OFB/CCM/XTS加密模式带SM3-HMAC的SM4 CBC/CTR模式并且在gmssl命令行工具中增加了所有SM4加密模式的选项
  • gmssl命令行中增加了GHASH计算的选项
  • 增加了sdftest正确性和兼容性测试命令以独立子项目的形式提供了SDF的软件实现SoftSDF
  • 移除了RC4, MD5等已被攻破的密码算法

开发者们

Stargazers over time

Stargazers over time