gitee.com/ks-custle/core-gm@v0.0.0-20230922171213-b83bdd97b62c/README.md (about)

     1  core-gm
     2  ================
     3  基于`go1.17.5`实现的国密算法库，包括:
     4  - sm2 : 基于`emmansun/gmsm`的sm2部分实现部分扩展。
     5  - sm2soft : 基于`tjfoc/gmsm`的sm2部分的纯软实现,仅作验证与参考用。
     6  - sm3 : 基于`emmansun/gmsm`的sm3部分实现部分扩展。
     7  - sm3soft : 基于`tjfoc/gmsm`的sm3部分的纯软实现,仅作验证与参考用。
     8  - sm4 : 基于`emmansun/gmsm`的sm4部分实现部分扩展。
     9  - sm4soft : 基于`tjfoc/gmsm`的sm4部分的纯软实现,仅作验证与参考用。
    10  - ecbase : 椭圆曲线基础通用包，目前为sm2/ecdsa_ext提供了基础的签名/验签相关接口与一些通用函数。
    11  - ecdsa_ext : ecdsa扩展包，实现了low-s处理
    12  - x509 : 基于`go1.17.5`的x509包与本项目的sm2/sm3/sm4/ecbase/ecdsa_ext等包实现国密改造。
    13  - gmtls : 基于`go1.17.5`的tls包与本项目的相关包实现国密改造。
    14  - gmhttp : 基于`go1.17.5`的`net/http`包做了对应的国密改造。
    15  - grpc : 基于`google.golang.org/grpc`的`v1.44.0`版本做了对应的国密改造。
    16  
    17  > 在x509与gmtls的实现中，国密算法采用的是基于`emmansun/gmsm`的国密实现，该开源项目已实现利用amd64与arm64架构CPU实现对应国密算法的硬件加速。sm2soft/sm3soft/sm4soft是对应国密算法的纯软实现，仅用作验证与参考。
    18  
    19  # core-gm的包路径
    20  go package： `gitee.com/zhaochuninhefei/core-gm`
    21  
    22  # 国密标准参考
    23  本项目涉及到的国密有SM2、SM3和SM4，相关国密标准如下：
    24  
    25  - GB/T 33560-2017 密码应用标识规范
    26  - GB/T 32918.1-2016 SM2椭圆曲线公钥密码算法 第1部分：总则
    27  - GB/T 32918.2-2016 SM2椭圆曲线公钥密码算法 第2部分：数字签名算法
    28  - GB/T 32918.3-2016 SM2椭圆曲线公钥密码算法 第3部分：密钥交换协议
    29  - GB/T 32918.4-2016 SM2椭圆曲线公钥密码算法 第4部分：公钥加密算法
    30  - GB/T 32918.5-2017 SM2椭圆曲线公钥密码算法 第5部分：参数定义
    31  - GB/T 35275-2017 SM2密码算法加密签名消息语法规范
    32  - GB/T 35276-2017 SM2密码算法使用规范
    33  - GB/T 32905-2016 SM3密码杂凑算法
    34  - GB/T 32907-2016 SM4分组密码算法
    35  
    36  # 测试案例
    37  从测试案例入手快速了解core-gm的使用。
    38  
    39  ## sm2
    40  测试案例代码: `sm2test/sm2_test.go`
    41  ```sh
    42  cd sm2test
    43  go test
    44  
    45  ```
    46  
    47  ## sm3
    48  测试案例代码: `sm3/sm3_test.go`
    49  ```sh
    50  cd sm3
    51  go test
    52  
    53  ```
    54  
    55  ## sm4
    56  测试案例代码: `sm4/sm4_test.go`、`sm4/sm4_gcm_test.go`
    57  ```sh
    58  cd sm4
    59  go test
    60  
    61  ```
    62  
    63  ## x509
    64  测试案例代码: `x509test/x509_test.go`
    65  ```sh
    66  cd x509
    67  go test
    68  
    69  ```
    70  
    71  注意，`x509_test`的`TestCreateCertFromCA`测试函数生成的sm2系列密钥文件与证书将会用于`gmtls`与`gmgrpc`的测试案例。
    72  
    73  
    74  ## gmtls
    75  测试案例代码: `gmtls/tls_test/tls_test.go`
    76  ```sh
    77  cd gmtls/tls_test
    78  go test
    79  
    80  ```
    81  
    82  执行之前请确认`certs`目录下的sm2系列文件是否最新。可以在该目录下执行`copyCerts.sh`直接从x509的对应目录下拷贝。
    83  
    84  ## gmgrpc
    85  测试案例代码: `grpc/grpc_test/grpc_test.go`
    86  ```sh
    87  cd grpc/grpc_test
    88  go test
    89  
    90  ```
    91  
    92  执行之前请确认`testdata`目录下的文件是否最新。可以在该目录下执行`copyCerts.sh`直接从x509的对应目录下拷贝。
    93  
    94  # 关于版权声明
    95  本项目自身采用木兰宽松许可证(第2版)，具体参考`LICENSE`文件。
    96  
    97  本项目参考了以下开源项目，基于其代码做了部分二次开发，向对应的开源作者表示感谢!
    98  - `https://github.com/emmansun/gmsm`
    99  - `https://github.com/tjfoc/gmsm`
   100  - `https://github.com/golang/go`
   101  - `https://github.com/grpc/grpc-go`
   102  - `https://github.com/envoyproxy/go-control-plane`
   103  - `https://github.com/golang/net`
   104  - `https://github.com/gorilla/mux`
   105  - `https://github.com/gorilla/handlers`
   106  - `https://github.com/felixge/httpsnoop`
   107  - `https://github.com/grpc-ecosystem/go-grpc-middleware`
   108  - `https://github.com/prometheus/client_golang`
   109  
   110  对应的版权声明参见目录`thrid_licenses`。
   111  
   112  # JetBrains support
   113  Thanks to JetBrains for supporting open source projects.
   114  
   115  <a href="https://jb.gg/OpenSourceSupport" target="_blank">https://jb.gg/OpenSourceSupport.</a>