|
1 | 1 | # GmSSL |
2 | 2 |
|
3 | | -GmSSL [(http://gmssl.org)](http://gmssl.org) 是支持国密算法和标准的OpenSSL分支，是一个提供了丰富密码学功能和安全功能的开源软件包。在保持OpenSSL原有功能并实现和OpenSSL API兼容的基础上，GmSSL新增多种密码算法、标准和协议，其中包括： |
| 3 | +GmSSL是一个开源的密码工具箱，支持SM2/SM3/SM4/SM9等国密(国家商用密码)算法、SM2国密数字证书及基于SM2证书的SSL/TLS安全通信协议，支持国密硬件密码设备，提供符合国密规范的编程接口与命令行工具，可以用于构建PKI/CA、安全通信、数据加密等符合国密标准的安全应用。GmSSL项目是[OpenSSL](https://www.openssl.org)项目的分支，并与OpenSSL保持接口兼容。因此GmSSL可以替代应用中的OpenSSL组件，并使应用自动具备基于国密的安全能力。GmSSL项目采用对商业应用友好的类BSD开源许可证，开源且可以用于闭源的商业应用。GmSSL项目由北京大学[关志](http://infosec.pku.edu.cn/~guanzhi/)副研究员的密码学研究组开发维护，项目源码托管于[GitHub](https://github.com/guanzhi/GmSSL)。自2014年发布以来，GmSSL已经在多个项目和产品中获得部署与应用，并获得2015年度“一铭杯”中国Linux软件大赛二等奖(年度最高奖项)与[开源中国](https://www.oschina.net/p/GmSSL)密码类推荐项目。GmSSL项目的核心目标是通过开源的密码技术推动国内网络空间安全建设。 |
4 | 4 |
|
5 | | -* 椭圆曲线公钥加密国际标准ECIES |
6 | | -* 国密SM2椭圆曲线公钥密码标准，包含数字签名算法、公钥加密算法、密钥交换协议及推荐椭圆曲线参数 |
7 | | -* 国密SM3密码杂凑算法、HMAC-SM3消息认证码算法、PBKDF2口令加密算法 |
8 | | -* 国密SM4/SMS4分组密码、ECB/CBC/CFB/OFB/CTR/GCM/FFX加密模式和CBC-MAC/CMAC消息认证码算法 |
9 | | -* 组合公钥(CPK)身份密码，可同时支持椭圆曲线国际标准算法和国密标准算法 |
10 | | -* 国密动态口令密码规范 |
11 | | -* 祖冲之(ZUC)序列密码 |
| 5 | +## 最新动态 |
12 | 6 |
|
13 | | -GmSSL还可以以安全中间件的方式访问PCI-E密码加速卡、USB Key等硬件密码设备，为上层应用提供密钥安全存储、密码计算硬件加速以及国密SM1分组密码、国密SSF33分组密码等硬件实现的保密算法。GmSSL通过ENGINE机制支持符合不同接口规范的密码设备： |
| 7 | +- 2017.01.18 更新了项目主页 |
14 | 8 |
|
15 | | -* 提供国密算法和国密SKF接口规范实现的硬件密码设备 |
16 | | -* 提供Windows Crypto API Provider的密码硬件设备 |
17 | | -* 提供PKCS #11 (Cryptoki)接口实现的密码硬件设备 |
| 9 | +## 国密算法 |
18 | 10 |
|
19 | | -GmSSL主要包含通用密码库`libcrypto`、SSL/TLS协议库`libssl`和命令行工具`gmssl`。除`gmssl`的命令行接口之外，GmSSL还通过`libcrypto`密码库提供原生的EVP API抽象密码接口以及国密智能IC卡及智能密码钥匙密码应用接口SKF API，以及通过JNI (Java Native Interface)本地接口实现的Java语言绑定。 |
| 11 | +国密算法是国家商用密码算法的简称。自2012年以来，国家密码管理局以《中华人民共和国密码行业标准》的方式，陆续公布了SM2/SM3/SM4等密码算法标准及其应用规范。其中“SM”代表“商密”，即用于商用的、不涉及国家秘密的密码技术。其中SM2为基于椭圆曲线密码的公钥密码算法标准，包含数字签名、密钥交换和公钥加密，用于替换RSA/Diffie-Hellman/ECDSA/ECDH等国际算法；SM3为密码哈希算法，用于替代MD5/SHA-1/SHA-256等国际算法；SM4为分组密码，用于替代DES/AES等国际算法；SM9为基于身份的密码算法，可以替代基于数字证书的PKI/CA体系。通过部署国密算法，可以降低由弱密码和错误实现带来的安全风险和部署PKI/CA带来的开销。 |
20 | 12 |
|
21 | | -为了便于商业软件安全地采用GmSSL，GmSSL保持了和OpenSSL相似的BSD/Apache风格的许可证，因此闭源软件或者商业软件可以安全地在产品中采用GmSSL的代码。自发布以来GmSSL荣获开源中国[(http://oschina.net)](http://oschina.net)密码类推荐开源项目、2015年度“一铭杯”中国Linux软件大赛二等奖(该年度最高奖项)等奖励和荣誉。 |
| 13 | +## 快速上手 |
22 | 14 |
|
23 | | -GmSSL项目目前由北京大学信息安全实验室开发和维护，项目的长期目标是推动国产密码算法在国内互联网和开源领域的广泛应用，提高国内商用非涉密领域的自主密码应用水平。 |
| 15 | +快速上手指南介绍GmSSL的编译、安装和`gmssl`命令行工具的基本指令。 |
24 | 16 |
|
25 | | -## 编译和安装 |
| 17 | +1. 下载源代码，当前稳定版 `gmssl-1.3.0.tar.gz` |
26 | 18 |
|
27 | | -OpenSSL通过其独有的编译脚本支持非常广泛的硬件和操作系统，GmSSL项目力求保持其跨平台特性。目前GmSSL可以在Linux平台和苹果OS X平台顺利编译安装，在Windows上暂时无法编译通过。我们预计可以在下一个版本发布时修正Windows平台的编译问题。 |
| 19 | +2. 解压缩至当前工作目录 |
28 | 20 |
|
29 | | -在Linux平台上通过如下指令实现编译和安装： |
| 21 | + ```sh |
| 22 | + $ tar xzvf gmssl-1.3.0.tar.gz |
| 23 | + ``` |
30 | 24 |
|
31 | | -``` |
32 | | -./config |
33 | | -make |
34 | | -make install |
35 | | -``` |
| 25 | +3. 编译与安装 |
36 | 26 |
|
37 | | -在苹果OS X操作系统上通过如下指令实现编译和安装： |
38 | | -``` |
39 | | -./Configure darwin64-x86_64-cc --prefix=/usr/local --openssldir=/usr/local/openssl |
40 | | -make |
41 | | -sudo make install |
42 | | -``` |
| 27 | + Linux平台（其他平台的安装过程见[编译与安装](http://gmssl.org)） |
43 | 28 |
|
44 | | -在WIN32(MINGW+MSYS)操作系统上通过如下指令实现编译和安装： |
| 29 | + ```sh |
| 30 | + $ ./config |
| 31 | + make |
| 32 | + sudo make install |
| 33 | + ``` |
45 | 34 |
|
46 | | -(请在MSYS环境解压或Git clone代码，否则会因换行符导致出现编译错误) |
| 35 | + 安装之后可以执行`gmssl`命令行工具检查是否成功 |
| 36 | + |
| 37 | + ```sh |
| 38 | + gmssl version -a |
| 39 | + ``` |
| 40 | + |
| 41 | +4. SM4加解密文件 |
| 42 | + |
| 43 | + ```sh |
| 44 | + gmssl sms4 -a -in <your-file> -out <your-file>.sms4 |
| 45 | + ``` |
| 46 | + |
| 47 | + 通过SM3哈希算法生成文件摘要 |
| 48 | + |
| 49 | + ``` |
| 50 | + gmssl sm3 -in <your-file> -out <your-file>.sm3 |
| 51 | + ``` |
| 52 | + |
| 53 | + |
| 54 | +1. SM2签名 |
| 55 | + |
| 56 | + ```sh |
| 57 | + gmssl genpkey -algorithm EC -pkeyopt ec_paramgen_curve:sm2p256v1 -pkeyopt ec_param_enc:named_curve -out signkey.pem |
| 58 | + |
| 59 | + gmssl pkeyutl -sign -pkeyopt ec_sign_algor:sm2 -inkey signkey.pem -in <yourfile>.sm3 -out <yourfile>.sig |
| 60 | + gmssl |
| 61 | + ``` |
| 62 | + |
| 63 | +## 项目文档 |
| 64 | + |
| 65 | +- [编译与安装](https://github.com/guanzhi/GmSSL/wiki/编译和安装) |
| 66 | +- 密码算法：[SM1分组密码](https://github.com/guanzhi/GmSSL/wiki/SM1和SSF33分组密码)；[SSF33分组密码](https://github.com/guanzhi/GmSSL/wiki/SM1和SSF33分组密码)；[SM2椭圆曲线公钥密码](https://github.com/guanzhi/GmSSL/wiki/SM2椭圆曲线公钥密码)；[SM3密码杂凑算法](https://github.com/guanzhi/GmSSL/wiki/SM3密码杂凑算法)；[SM4/SMS4分组密码](https://github.com/guanzhi/GmSSL/wiki/SM4分组密码)；[SM9基于身份的密码](https://github.com/guanzhi/GmSSL/wiki/SM9身份密码)；[ZUC序列密码](https://github.com/guanzhi/GmSSL/blob/develop/doc/gmssl/zuc.md)；[CPK组合公钥密码](https://github.com/guanzhi/GmSSL/wiki/CPK组合公钥) |
| 67 | +- 安全协议：国密SSL VPN协议；国密IPSec VPN协议 |
| 68 | +- [GmSSL命令行工具](https://github.com/guanzhi/GmSSL/blob/develop/doc/gmssl/gmsslcli.md) |
| 69 | +- [GmSSL编码风格 (GmSSL Coding Style)](https://github.com/guanzhi/GmSSL/blob/develop/doc/gmssl/codingstyle.md) |
| 70 | +- GmSSL编程接口：国密应用编程接口(GmSSL SAF/SDF/SKF/SOF API)；GmSSL EVP API](https://github.com/guanzhi/GmSSL/blob/develop/doc/gmssl/evp.md)；[GmSSL Java API](https://github.com/guanzhi/GmSSL/blob/develop/doc/gmssl/java.md)；[国密算法标识OID](https://github.com/guanzhi/GmSSL/blob/develop/doc/gmssl/oid.md) |
| 71 | +- [中华人民共和国密码行业标准(共44项)]() |
47 | 72 |
|
48 | | -``` |
49 | | -./config |
50 | | -make |
51 | | -make install |
52 | | -``` |
53 | 73 |
|
0 commit comments