Data

Tools

Indexes

Applications

Experiments

Open Source Science

gmsm

ShangMi (SM) cipher suites for Go (Go语言商用密码软件)

https://github.com/emmansun/gmsm

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.7%) to scientific vocabulary

Keywords

aes-ni cfca cryptography go ml-dsa slh-dsa sm2 sm3 sm4 sm9 zuc

Keywords from Contributors

mesh interpretability sequences projection interactive optim hacking network-simulation
Last synced: 6 months ago · JSON representation ·

Repository

ShangMi (SM) cipher suites for Go (Go语言商用密码软件)

Basic Info
Statistics
  • Stars: 433
  • Watchers: 12
  • Forks: 77
  • Open Issues: 8
  • Releases: 119
Topics
aes-ni cfca cryptography go ml-dsa slh-dsa sm2 sm3 sm4 sm9 zuc
Created about 5 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation Security

README-EN.md

GM-Standards SM2/SM3/SM4/SM9/ZUC for Go

Github CI arm64-qemu sm3-sm4-ni-qemu codecov Go Report Card Documentation GitHub go.mod Go version (branch) Release

English | 简体中文

ShangMi (SM) cipher suites for Golang, referred to as GMSM, is a secure, high-performance, easy-to-use Golang ShangMi (SM) cipher suites library, covering public algorithms SM2/SM3/SM4/SM9/ZUC.

Packages

  • SM2 - This is a SM2 sm2p256v1 implementation whose performance is similar like golang native NIST P256 under amd64, arm64, s390x and ppc64le, for implementation detail, please refer SM2实现细节. It supports ShangMi sm2 digital signature, public key encryption algorithm and also key exchange.

  • SM3 - This is also a SM3 implementation whose performance is similar like golang native SHA 256 with SIMD under amd64, arm64, s390x, ppc64x, for implementation detail, please refer SM3性能优化. It also provides A64 cryptographic instructions SM3 tested with QEMU.

  • SM4 - For SM4 implementation, SIMD & AES-NI are used under amd64, arm64 and ppc64x, for detail please refer SM4性能优化. It is optimized for ECB/CBC/GCM/XTS operation modes. It also provides A64 cryptographic instructions SM4 tested with QEMU.

  • SM9 - For SM9 implementation, please reference SM9实现及优化

  • ZUC - For ZUC implementation, SIMD, AES-NI and CLMUL are used under amd64, arm64 and ppc64x, for detail please refer Efficient Software Implementations of ZUC

  • CBCMAC - CBC-MAC and its variants (EMAC/ANSI retail MAC/MacDES/CMAC/LMAC/TrCBC/CBCR).

  • CFCA - some cfca specific implementations.

  • CIPHER - ECB/CCM/XTS/HCTR/BC/OFBNLF operation modes, XTS mode also supports GB/T 17964-2021. Current XTS mode implementation is NOT concurrent safe! BC and OFBNLF are legacy operation modes, HCTR is new operation mode in GB/T 17964-2021. BC operation mode is similar like CBC, there is no room for performance optimization in OFBNLF operation mode.

  • SMX509 - a fork of golang X509 that supports ShangMi.

  • PKCS7 - a fork of mozilla-services/pkcs7 that supports ShangMi.

  • PKCS8 - a fork of youmark/pkcs8 that supports ShangMi.

  • ECDH - a similar implementation of golang ECDH that supports SM2 ECDH & SM2MQV without usage of big.Int, a replacement of SM2 key exchange. For detail, pleaes refer is my code constant time?

  • DRBG - Random Number Generation Using Deterministic Random Bit Generators, for detail, please reference NIST Special Publication 800-90A and GM/T 0105-2021: CTR-DRBG using derivation function and HASH-DRBG. NIST related implementations are tested with part of NIST provided test vectors. It's NOT concurrent safe! You can also use randomness tool to check the generated random bits.

  • MLDSA - NIST FIPS 204 Module-Lattice-Based Digital Signature Standard.

  • SLHDSA - NIST FIPS 205 Stateless Hash-Based Digital Signature Standard

Some Related Projects

  • TLCP - An implementation of GB/T 38636-2020 Information security technology Transport Layer Cryptography Protocol (TLCP).
  • Trisia/Randomness - An implementation of GM/T 0005-2021 Randomness test specification.
  • PKCS12 - pkcs12 supports ShangMi, a fork of SSLMate/go-pkcs12.
  • MKSMCERT - A simple tool for making locally-trusted development ShangMi certificates, a fork of FiloSottile/mkcert.

License

This work is licensed under a MIT License. See the LICENSE file for details.

Acknowledgements

The basic architecture, design and some codes are from golang crypto.

The SM4 amd64 SIMD AES-NI implementation is inspired by code from mjosaarinen/sm4ni.

The original SM9/BN256 version is based on code from cloudflare/bn256.

The ZUC amd64 SIMD AES-NI, CLMUL implementation is inspired by code from Intel(R) Multi-Buffer Crypto for IPsec Library.

The pkcs7 is based on code from mozilla-services/pkcs7, which has been archived by the owner on Feb 10, 2024.

The pkcs8 is based on code from youmark/pkcs8.

Disclaimer

This library is not fully audited and is offered as-is, and without a guarantee. Therefore, it is expected that changes in the code, repository, and API occur in the future. We recommend to take caution before using this library in a production application.

Stargazers over time

Stargazers over time

Owner

  • Name: Sun Yimin
  • Login: emmansun
  • Kind: user
  • Location: Zhuhai, GD, China

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Sun"
  given-names: "Yimin"
title: "gmsm"
date-released: 2021-1-20
url: "https://github.com/emmansun/gmsm"

GitHub Events

Total
  • Fork event: 14
  • Create event: 44
  • Commit comment event: 7
  • Release event: 11
  • Issues event: 102
  • Watch event: 99
  • Delete event: 32
  • Issue comment event: 187
  • Push event: 234
  • Pull request review comment event: 1
  • Pull request review event: 4
  • Pull request event: 66
  • Gollum event: 261
Last Year
  • Fork event: 14
  • Create event: 44
  • Commit comment event: 7
  • Release event: 11
  • Issues event: 102
  • Watch event: 99
  • Delete event: 32
  • Issue comment event: 187
  • Push event: 234
  • Pull request review comment event: 1
  • Pull request review event: 4
  • Pull request event: 66
  • Gollum event: 261

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,754
  • Total Committers: 7
  • Avg Commits per committer: 250.571
  • Development Distribution Score (DDS): 0.175
Past Year
  • Commits: 610
  • Committers: 3
  • Avg Commits per committer: 203.333
  • Development Distribution Score (DDS): 0.031
Top Committers
Name Email Commits
Sun Yimin e****n 1,447
Emman e****n@c****m 244
dependabot[bot] 4****] 47
徐胖 x****6@g****m 12
cliven q****u@q****m 2
opensvn j****g@g****m 1
YuanHongYe y****e@c****n 1
Committer Domains (Top 20 + Academic)
chinatelecom.cn: 1 qq.com: 1 cargosmart.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 182
  • Total pull requests: 122
  • Average time to close issues: 26 days
  • Average time to close pull requests: about 19 hours
  • Total issue authors: 49
  • Total pull request authors: 11
  • Average comments per issue: 2.66
  • Average comments per pull request: 0.4
  • Merged pull requests: 91
  • Bot issues: 0
  • Bot pull requests: 98
Past Year
  • Issues: 68
  • Pull requests: 63
  • Average time to close issues: 9 days
  • Average time to close pull requests: 1 day
  • Issue authors: 18
  • Pull request authors: 7
  • Average comments per issue: 2.38
  • Average comments per pull request: 0.25
  • Merged pull requests: 41
  • Bot issues: 0
  • Bot pull requests: 53
View more stats
Top Authors
Issue Authors
  • emmansun (100)
  • zhangyongding (7)
  • xuyang2 (7)
  • Trisia (7)
  • pedroalbanese (5)
  • 3052 (3)
  • snowsteps (3)
  • Runninginsilence1 (2)
  • zhaochuninhefei (2)
  • Nightlan (2)
  • dzwvip (2)
  • baozinihao (2)
  • b1gcat (2)
  • tianbocheng (2)
  • MaoJianwei (2)
Pull Request Authors
  • dependabot[bot] (97)
  • emmansun (7)
  • xuyang2 (5)
  • zhangyongding (3)
  • hrimfaxi (2)
  • kvii (2)
  • jyk1987 (2)
  • github-actions[bot] (1)
  • Trisia (1)
  • opensvn (1)
  • step-security-bot (1)
Top Labels
Issue Labels
enhancement (61) sync sdk (27) FAQ (15) bug (8) help wanted (3) invalid (2) wontfix (1) duplicate (1)
Pull Request Labels
dependencies (97) github_actions (17) go (8) docker (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total docker downloads: 130
  • Total dependent packages: 69
  • Total dependent repositories: 11
  • Total versions: 120
proxy.golang.org: github.com/emmansun/gmsm
  • Versions: 120
  • Dependent Packages: 69
  • Dependent Repositories: 11
  • Docker Downloads: 130
Rankings
Dependent packages count: 0.7%
Dependent repos count: 1.6%
Docker downloads count: 1.7%
Average: 2.5%
Stargazers count: 4.3%
Forks count: 4.3%
Last synced: 6 months ago

Dependencies

go.mod go
  • golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d
  • golang.org/x/sys v0.0.0-20220712014510-0a85c31ab51e
go.sum go
  • golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d
  • golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2
  • golang.org/x/sys v0.0.0-20201119102817-f84b799fce68
  • golang.org/x/sys v0.0.0-20210423082822-04245dca01da
  • golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1
  • golang.org/x/sys v0.0.0-20220712014510-0a85c31ab51e
  • golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1
  • golang.org/x/text v0.3.6
  • golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e
.github/workflows/ci.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-go v3 composite
  • codecov/codecov-action v3 composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/macos.yml actions
  • actions/checkout v3 composite
  • actions/setup-go v3 composite
internal/sm2ec/fiat/Dockerfile docker
  • coqorg/coq 8.13.2 build
.github/workflows/test_qemu.yml actions
  • actions/checkout v3 composite
  • actions/setup-go v4 composite
  • docker/setup-qemu-action v2 composite
.github/workflows/test_sm_ni.yml actions
  • actions/checkout v3 composite
  • actions/setup-go v4 composite
  • docker/setup-qemu-action v2 composite