# gmgo

**Repository Path**: zhaochuninhefei/gmgo

## Basic Information

- **Project Name**: gmgo
- **Description**: 基于`go1.22`实现的国密算法库，实现了国密算法sm2/sm3/sm4，以及x509/tls/http/grpc的国密支持版本。
- **Primary Language**: Go
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 21
- **Forks**: 14
- **Created**: 2022-02-17
- **Last Updated**: 2025-07-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

gmgo
================
基于`go1.17.5`(目前go版本已升级至`1.22`)实现的国密算法库，包括:
- sm2 : 基于`emmansun/gmsm`的sm2部分实现部分扩展。
- sm2soft : 基于`tjfoc/gmsm`的sm2部分的纯软实现,仅作验证与参考用。
- sm3 : 基于`emmansun/gmsm`的sm3部分实现部分扩展。
- sm3soft : 基于`tjfoc/gmsm`的sm3部分的纯软实现,仅作验证与参考用。
- sm4 : 基于`emmansun/gmsm`的sm4部分实现部分扩展。
- sm4soft : 基于`tjfoc/gmsm`的sm4部分的纯软实现,仅作验证与参考用。
- ecbase : 椭圆曲线基础通用包，目前为sm2/ecdsa_ext提供了基础的签名/验签相关接口与一些通用函数。
- ecdsa_ext : ecdsa扩展包，实现了low-s处理
- x509 : 基于`go1.17.5`的x509包与本项目的sm2/sm3/sm4/ecbase/ecdsa_ext等包实现国密改造。
- gmtls : 基于`go1.17.5`的tls包与本项目的相关包实现国密改造。
- gmhttp : 基于`go1.17.5`的`net/http`包做了对应的国密改造。
- grpc : 基于`google.golang.org/grpc`的`v1.44.0`版本做了对应的国密改造。

> 在x509与gmtls的实现中，国密算法采用的是基于`emmansun/gmsm`的国密实现，该开源项目已实现利用amd64与arm64架构CPU实现对应国密算法的硬件加速。sm2soft/sm3soft/sm4soft是对应国密算法的纯软实现，仅用作验证与参考。

# gmgo的包路径
go package： `gitee.com/zhaochuninhefei/gmgo`

# 国密标准参考
本项目涉及到的国密有SM2、SM3和SM4，相关国密标准如下：

- GB/T 33560-2017 密码应用标识规范
- GB/T 32918.1-2016 SM2椭圆曲线公钥密码算法 第1部分：总则
- GB/T 32918.2-2016 SM2椭圆曲线公钥密码算法 第2部分：数字签名算法
- GB/T 32918.3-2016 SM2椭圆曲线公钥密码算法 第3部分：密钥交换协议
- GB/T 32918.4-2016 SM2椭圆曲线公钥密码算法 第4部分：公钥加密算法
- GB/T 32918.5-2017 SM2椭圆曲线公钥密码算法 第5部分：参数定义
- GB/T 35275-2017 SM2密码算法加密签名消息语法规范
- GB/T 35276-2017 SM2密码算法使用规范
- GB/T 32905-2016 SM3密码杂凑算法
- GB/T 32907-2016 SM4分组密码算法

# 测试用例
从测试用例入手快速了解gmgo的使用。

## sm2
测试用例代码: `sm2test/sm2_test.go`
```sh
cd sm2test
go test

```

## sm3
测试用例代码: `sm3/sm3_test.go`
```sh
cd sm3
go test

```

## sm4
测试用例代码: `sm4/sm4_test.go`、`sm4/sm4_gcm_test.go`
```sh
cd sm4
go test

```

## x509
测试用例代码: `x509test/x509_test.go`
```sh
cd x509
go test

cd ../x509test
go test

```

注意，`x509/x509_test.go`的`TestCreateCertFromCA`系列测试函数生成的sm2系列密钥文件与证书(`x509/testdata`目录下)将会用于`gmtls`与`gmgrpc`的测试用例。


## gmtls
测试用例代码: `gmtls/tls_test/tls_test.go`
```sh
cd gmtls/tls_test
go test

```

执行之前请确认`certs`目录下的sm2系列文件是否最新。可以在该目录下执行`copyCerts.sh`直接从`x509/testdata`拷贝。

## gmgrpc
测试用例代码: `grpc/grpc_test/grpc_test.go`
```sh
cd grpc/grpc_test
go test

```

执行之前请确认`testdata`目录下的文件是否最新。可以在该目录下执行`copyCerts.sh`直接从`x509/testdata`拷贝。

## 测试脚本
本工程根目录测试脚本`run_test.sh`可运行上述测试用例。

# 关于编译
gmgo本身不提供入口程序，仅仅作为其他golang项目的依赖包。但依然提供了Makefile用于编译检查代码,一般直接用`make`命令编译即可。

也可以直接使用编译脚本: `build.sh`

# 关于版权声明
本项目自身采用木兰宽松许可证(第2版)，具体参考`LICENSE`文件。

本项目参考了以下开源项目，基于其代码做了部分二次开发，向对应的开源作者表示感谢!
- `https://github.com/emmansun/gmsm`
- `https://github.com/tjfoc/gmsm`
- `https://github.com/golang/go`
- `https://github.com/grpc/grpc-go`
- `https://github.com/envoyproxy/go-control-plane`
- `https://github.com/golang/net`
- `https://github.com/gorilla/mux`
- `https://github.com/gorilla/handlers`
- `https://github.com/felixge/httpsnoop`
- `https://github.com/grpc-ecosystem/go-grpc-middleware`
- `https://github.com/prometheus/client_golang`

对应的版权声明参见目录`thrid_licenses`。

# JetBrains support
Thanks to JetBrains for supporting open source projects.

<a href="https://jb.gg/OpenSourceSupport" target="_blank">https://jb.gg/OpenSourceSupport.</a>