# java-gm

**Repository Path**: EdgarLQS/java-gm

## Basic Information

- **Project Name**: java-gm
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-15
- **Last Updated**: 2022-01-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# java-gm

基于BouncyCastle实现国密算法SM2、SM3、SM4的操作类，并验证与其他语言（NodeJS、Go）实现的国密库的互操作性。

[![Build Status](https://dev.azure.com/Hyperledger/TWGC/_apis/build/status/Hyperledger-TWGC.java-gm?branchName=master)](https://dev.azure.com/Hyperledger/TWGC/_build/latest?definitionId=129&branchName=master)

## Feature 功能支持列表

|  SM2功能   | 支持范围  | 
|  ----  | ----  |
| Generate KeyPair  | `是` |
| Derive public key from private key  | `是` |
| Sign  | `是` |
| Verify | `是` |
| PEM格式导出 | `私钥/公钥/CSR`|
| PEM文件加密 | RFC5958 |
| PEM格式导入 | `私钥/公钥/CSR` |
 
 备注：
 
 C1C3C2和SM2SM3作为默认的加密和Hash算法，同时接口层面保留C1C2C3和其他Hash方式的支持。

|  SM4功能   | 支持范围  | 
|  ----  | ----  |
| Generate Key |  |
| Encrypt, Decrypt | `是` |
| PEM格式导出 |   |
| PEM文件加密 | |
| 分组模式 | ECB/CBC/CFB/OFB/CTR |


|  SM3功能   | 支持范围  | 
|  ----  | ----  |
| 当前语言Hash接口兼容 | `是` |

## ObjectPoolSupport
我们采用了可配置的对象池的方案来提供相对便利的多线程支持。
如:
```
    static SM2EnginePool sm2EnginePool = new SM2EnginePool(SM2Engine.Mode.C1C3C2);
    SM2Engine sm2Engine = sm2EnginePool.borrowObject();
    byte[] encrypted = instance.encrypt(sm2Engine, this.pubKey, message);
    byte[] rs = instance.decrypt(sm2Engine, this.privKey, encrypted);
    Assert.assertEquals(new String(message), new String(rs));
    sm2EnginePool.returnObject(sm2Engine);
```
具体对象池的配置参考如下文件：
`SM2Pool.properties`, `SM3Pool.properties`, `SM4Pool.properties`
我们目前尚未使用统一的对象池，而是根据不同密码学算法使用不同的对象池。
这里是考虑到不同算法的执行效率并不相同，因此例如sm2+sm3的操作：
我们可以考虑用一个数量更小的sm3对象池，来对接一个sm2对象池，来实现摘要（SM3）签名（SM2）这一密码学实现。

## Terminology 术语
- SM2: 国密椭圆曲线算法库
- SM3: 国密hash算法库
- SM4: 国密分组密码算法库

## How to Contribute 贡献须知
We welcome contributions to Hyperledger in many forms, and there's always plenty to do!

Please visit the [contributors guide](CONTRIBUTING.md) in the
docs to learn how to make contributions to this exciting project.

<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

## License 许可证
Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file.