sm-crypto 项目使用教程

sm-crypto 项目使用教程

sm-crypto国密算法sm2、sm3和sm4的java版。基于js版本进行封装，无缝兼容js版公私钥加解密。项目地址:https://gitcode.com/gh_mirrors/smcr/sm-crypto

1. 项目的目录结构及介绍

sm-crypto/
├── src/
│   ├── main/
│   └── test/
├── gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── pom.xml

• src/: 包含项目的主要源代码和测试代码。
  • main/: 主要源代码文件。
  • test/: 测试代码文件。
• gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 src/main/ 目录下。具体文件名和路径可能因项目结构而异，但通常会包含主要的入口点文件。例如：

src/main/java/com/antherd/smcrypto/Main.java

这个文件是项目的入口点，负责初始化项目并启动应用。

3. 项目的配置文件介绍

• pom.xml: Maven 项目配置文件，包含项目的依赖、插件、构建配置等信息。

<dependency>
  <groupId>com.antherd</groupId>
  <artifactId>sm-crypto</artifactId>
  <version>0.3.2</version>
</dependency>

• gitignore: Git 忽略文件配置，指定哪些文件和目录不需要被 Git 管理。

# Java
*.class

# IDEs
.idea/
*.iml

• LICENSE: 项目许可证，声明项目的许可协议。

MIT License

Copyright (c) [year] [fullname]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

• README.md: 项目说明文档，包含项目的介绍、安装、使用等信息。

# sm-crypto

国密算法 sm2、sm3 和 sm4 的 Java 版，基于 JS 版本进行封装，无缝兼容 JS 版公私钥加解密。

## 如何使用

### 如何引入依赖

如果需要使用已发布的版本，在 `dependencies` 中添加如下依赖：

```xml
<dependency>
  <groupId>com.antherd</groupId>
  <artifactId>sm-crypto</artifactId>
  <version>0.3.2</version>
</dependency>

sm2 获取密钥对

Keypair keypair = Sm2.generateKeyPairHex();
String privateKey = keypair.getPrivateKey(); // 私钥
String publicKey = keypair.getPublicKey(); // 公钥

加密解密

// cipherMode 1 - C1C3C2, 0 - C1C2C3

sm-crypto国密算法sm2、sm3和sm4的java版。基于js版本进行封装，无缝兼容js版公私钥加解密。项目地址:https://gitcode.com/gh_mirrors/smcr/sm-crypto