Update README.md

This commit is contained in:
Zhi Guan
2017-02-14 10:00:50 +08:00
committed by GitHub
parent 2e7cc8525a
commit d2254170b8

112
README.md
View File

@@ -1,114 +1,4 @@
# GmSSL
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项目的核心目标是通过开源的密码技术推动国内网络空间安全建设。
## 最新动态
- 2017.01.18 更新了项目主页
## 国密算法
国密算法是国家商用密码算法的简称。自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带来的开销。
## 快速上手
快速上手指南介绍GmSSL的编译、安装和`gmssl`命令行工具的基本指令。
1. 下载源代码,解压缩至当前工作目录
```sh
$ tar xzvf gmssl-<version>.tar.gz
```
2. 编译与安装
Linux平台其他平台的安装过程见[编译与安装](http://gmssl.org)
```sh
$ ./config
$ make
$ sudo make install
```
安装之后可以执行`gmssl`命令行工具检查是否成功
```sh
$ gmssl version
GmSSL 1.3.0 - OpenSSL 1.0.2d
```
3. SM4加密文件
```sh
$ gmssl sms4 -e -in <yourfile> -out <yourfile>.sms4
enter sms4-cbc encryption password: <your-password>
Verifying - enter sms4-cbc encryption password: <your-password>
```
解密
```sh
$ gmssl sms4 -d -in <yourfile>.sms4
enter sms4-cbc decryption password: <your-password>
```
4. 生成SM3摘要
```
$ gmssl sm3 <yourfile>
SM3(yourfile)= 66c7f0f462eeedd9d1f2d46bdc10e4e24167c4875cf2f7a2297da02b8f4ba8e0
```
5. 生成SM2密钥并签名
```sh
$ gmssl genpkey -algorithm EC -pkeyopt ec_paramgen_curve:sm2p256v1 \
-pkeyopt ec_param_enc:named_curve -out signkey.pem
$ gmssl pkeyutl -sign -pkeyopt ec_sign_algor:sm2 -inkey signkey.pem \
-in <yourfile> -out <yourfile>.sig
```
可以将公钥从`signkey.pem`中导出并发发布给验证签名的一方
```sh
$ gmssl pkey -in signkey.pem -out vrfykey.pem
$ gmssl pkeyutl -verify -pkeyopt ec_sign_algor:sm2 -inkey vrfykey.pem \
-in <yourfile> -sigfile <yourfile>.sig
```
## 项目文档
用户手册:
[编译与安装](https://github.com/guanzhi/GmSSL/wiki/install)
[命令行工具手册](https://github.com/guanzhi/GmSSL/wiki/commands.md)
[GmSSL EVP API](https://github.com/guanzhimSSL/blob/develop/doc/gmssl/evp.md)
[GmSSL Java API](https://github.com/guanzhi/GmSSL/blob/develop/doc/gmssl/java.md)
密码算法
[SM1分组密码](https://github.com/guanzhi/GmSSL/wiki/sm1)
[SSF33分组密码](https://github.com/guanzhi/GmSSL/wiki/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/sms4)
[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)
[BF-IBE (Boneh-Franklin Identity-Based Encryption)](https://github.com/guanzhi/GmSSL/wiki/bfibe)
[BB~1~-IBE (Boneh-Boyen Identity-Based Encryption)](https://github.com/guanzhi/GmSSL/wiki/bb1-ibe)
安全协议:
[SSL/TLS协议]()、
[国密SSL VPN协议]()
[国密IPSec VPN协议]()
开发者:
[GmSSL编码风格 (Coding Style)](https://github.com/guanzhi/GmSSL/blob/develop/doc/gmssl/codingstyle.md)
[开发路线 (Road Map)]()
国密应用编程接口(GmSSL SAF/SDF/SKF/SOF API)
- 标准规范:[中华人民共和国密码行业标准(共44项)]()
[国密算法标识OID](https://github.com/guanzhi/GmSSL/blob/develop/doc/gmssl/oid.md)
Please visit http://gmssl.org for documents and more details.