# TencentKonaSMSuite

**Repository Path**: z_w_code/TencentKonaSMSuite

## Basic Information

- **Project Name**: TencentKonaSMSuite
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2022-11-30
- **Last Updated**: 2024-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 腾讯Kona国密套件

## 概览

腾讯Kona国密套件是一组Java安全特性的Provider实现，主要服务于Java生态中的国密应用场景。具体地，该套件包含有四个Provider：

- [KonaCrypto]，它遵循标准的[JCA]框架实现了国密基础算法SM2，SM3和SM4。
- [KonaPKIX]，它实现了国密证书的解析与验证，并可加载和创建包含国密证书的密钥库文件。它需要依赖`KonaCrypto`。
- [KonaSSL]，它实现了中国的传输层密码协议（TLCP），并遵循RFC 8998规范将国密基础算法应用到了TLS 1.3协议中。它需要依赖`KonaCrypto`和`KonaPKIX`。
- [Kona]，它将`KonaCrypto`，`KonaPKIX`和`KonaSSL`中的特性进行了简单的封装。一般地，建议使用这个Provider。根据实际需求，它需要依赖`KonaCrypto`，`KonaPKIX`和`KonaSSL`中的一个或多个。

## 系统要求

### 操作系统
腾讯Kona国密套件为纯Java语言编写，可以运行在任何支持JDK的操作系统上。

### JDK版本
腾讯Kona国密套件支持JDK的全部三个长期支持（LTS）版本，即8，11和17。

注意：已经使用Oracle颁发的JCE代码签名[证书]对本套组件的jar文件签名，所以它们也可以运行在Oracle JDK上。另外，欢迎使用腾讯的OpenJDK发行版，即Tencent Kona JDK，提供[8]，[11]和[17]三大版本，支持Linux，macOS和Windows等主流操作系统以及x86_64和aarch64等主流CPU架构。

## 安装
腾讯Kona国密套件的所有制品（jar文件）都已经上传到了[Maven中央仓库]。一般地，只需要在项目的构建脚本中把它们声明为依赖就可以了。比如，在[Gradle]的构建脚本中可以有如下的依赖声明，

```
repositories {
    mavenCentral()
}

dependencies {
    implementation("com.tencent.kona:kona-crypto:1.0.4")
    implementation("com.tencent.kona:kona-pkix:1.0.4")
    implementation("com.tencent.kona:kona-ssl:1.0.4")
    implementation("com.tencent.kona:kona-provider:1.0.4")
}
```

注意，并不一定要将所有的Provider都加到类路径中，请根据实际需求去声明依赖。例如，只需要使用国密的基础算法，且想使用Provider名称`Kona`时，那么依赖声明可能就像下面这样，

```
dependencies {
    implementation("com.tencent.kona:kona-crypto:1.0.4")
    implementation("com.tencent.kona:kona-provider:1.0.4")
}
```

## 构建
腾讯Kona国密套件使用Gradle进行构建，其脚本使用[Kotlin DSL]。该Gradle项目包含有四个子模块，即*kona-crypto*，*kona-pkix*，*kona-ssl*和*kona-provider*，它们分别对应于四个Provider，即`KonaCrypto`，`KonaPKIX`，`KonaSSL`和`Kona`。

构建该项目的一个典型方法就是在项目的根目录下执行命令：

```
gradle build
```

它会编译源代码，并执行单元测试，最后制作出jar文件。也可以仅构建某个子模块，比如像下面这样：

```
gradle :kona-pkix:build
```

## 贡献
非常欢迎与我们一起改进和维护腾讯Kona国密套件，请阅读[CONTRIBUTING.md]以了解如何报告缺陷，安全漏洞，提出需求和贡献代码。

## 许可协议
腾讯Kona国密套件使用的许可协议是GNU GPL v2.0 license with classpath exception，请详见附带的许可协议[文本]。


[JCA]:
<https://docs.oracle.com/en/java/javase/11/security/java-cryptography-architecture-jca-reference-guide.html>

[KonaCrypto]:
<kona-crypto/README_cn.md>

[KonaPKIX]:
<kona-pkix/README_cn.md>

[KonaSSL]:
<kona-ssl/README_cn.md>

[Kona]:
<kona-provider/README_cn.md>

[证书]:
<https://www.oracle.com/java/technologies/javase/getcodesigningcertificate.html#jcacodesigning>

[8]:
<https://github.com/Tencent/TencentKona-8>

[11]:
<https://github.com/Tencent/TencentKona-11>

[17]:
<https://github.com/Tencent/TencentKona-17>

[Maven中央仓库]:
<https://repo1.maven.org/maven2/com/tencent/kona/>

[Gradle]:
<https://gradle.org>

[Kotlin DSL]:
<https://docs.gradle.org/current/userguide/kotlin_dsl.html>

[CONTRIBUTING.md]:
<CONTRIBUTING_cn.md>

[文本]:
<LICENSE.txt>