# SecureTransmit

**Repository Path**: YangHaiJi/SecureTransmit

## Basic Information

- **Project Name**: SecureTransmit
- **Description**: SecureTransmit专注于解决传输层数据的安全性问题，并提供全面的数据安全解决方案。不仅赋予用户将全字段加密的能力，还可以实现对特定字段的精细加密。此外，SecureTransmit还提供了对RSA和AES等加解密算法的无缝支持，从而确保您的数据在传输过程中得到最佳的保护，使其更加安全可靠。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2023-08-21
- **Last Updated**: 2023-10-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 数据加密, AES, RSA, DES

## README


<h1 align="center">
  <a href="https://github.com/yanghaiji/SecureTransmit"><img src="https://github.com/yanghaiji/SecureTransmit/blob/main/doc/logo.png" alt="Standard - SecureTransmit" width="500"></a>
  <br>
  SecureTransmit
  <br>
  <br>
</h1>

<p align="center">
    <a href="https://spring.io/projects"><img src='https://img.shields.io/badge/license-Apache%202-borightgreen' alt='License'/></a>
    <a href="https://spring.io/projects/spring-boot"><img src="https://img.shields.io/badge/Spring%20Boot-2.6.2-brightgreen)" alt="npm version"></a>
    <a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard - Java Style Guide"></a>
</p>


`SecureTransmit`致力于应对传输层数据安全问题，为广泛的安全需求提供高效而综合的解决方案。其核心目标在于确保通过网络传输的数据在各个环节得到可靠的保护，从而防范潜在的安全威胁。
作为其关键特征，`SecureTransmit`不仅赋予用户将全字段加密的能力，更为难得的是，其还允许用户在需求情景下实现针对特定字段的精确加密，从而最大程度地维护数据隐私。
值得一提的是，`SecureTransmit`秉承高标准的加密实践，全面支持行业主流的`RSA`、`AES`等加解密算法(更加详细的加密算法请查看[加密算法的规划](#加密算法的规划))，为用户提供可信赖的安全通信通道。
无论是在数据的传输、存储，亦或是处理过程中，`SecureTransmit`均旨在确保数据的机密性与完整性，为您的敏感信息提供最优保障。

# 源代码地址

- [Github 地址 https://github.com/yanghaiji/SecureTransmit](https://github.com/yanghaiji/SecureTransmit)

- [Gitee 地址 https://gitee.com/YangHaiJi/SecureTransmit](https://gitee.com/YangHaiJi/SecureTransmit)

> github上为最新版本，gitee上会略微滞后一些
> 如果对您有所帮助可以给个star， ✨不迷路，您的star是我们编写的动力 🙏

# 加密算法的规划

✅ 支持    ⬜ 暂未支持

| 算法名称                              | 简要介绍                                                     | 是否支持 |
| ------------------------------------- | ------------------------------------------------------------ | -------- |
| AES（Advanced Encryption Standard）   | 是一种对称加密算法，用于替代过时的DES（Data Encryption Standard）。AES支持128位、192位和256位密钥长度，被广泛用于保护敏感信息。 | ✅        |
| AES-GCM (Advanced Encryption Standard - Galois/Counter Mode)   | AES-GCM是一种强大的对称加密算法，不仅可以加密数据，还可以提供完整性和认证。由于GCM模式使用并行处理，它在加密大文件时表现良好。 | ✅       |
| RSA（Rivest-Shamir-Adleman            | 是一种非对称加密算法，用于实现数据的加密和数字签名。RSA基于数学问题，涉及公钥和私钥，公钥用于加密，私钥用于解密。 | ✅        |
| Diffie-Hellman                        | 是一种用于安全地交换密钥的协议，通过不安全的通信渠道，双方可以生成一个共享的密钥，然后用于对称加密。 | ⬜        |
| ECC（Elliptic Curve Cryptography      | 是一种基于椭圆曲线数学问题的非对称加密算法，与RSA相比，可以实现相同的安全性，但使用更短的密钥长度。 | ✅        |
| Blowfish                              | 是一种对称加密算法，适用于加密较大的数据块，由于其速度较快，被广泛用于加密通信和文件 | ⬜        |
| Twofish                               | 也是一种对称加密算法，是Blowfish的后续版本，被认为在安全性方面更为强大。 | ⬜        |
| DES（Data Encryption Standard）       | 是一种对称加密算法，但由于其56位密钥长度较短，已被认为不够安全，逐渐被AES所取代。 | ⬜        |
| 3DES（Triple Data Encryption Standard | 是对DES的改进，通过多次应用DES算法来增加安全性，但由于其计算开销较大，逐渐被更高效的加密算法取代。 | ⬜        |

# 数据加密

目前项目中主要采用的是RSA的加密算法，公钥加密私钥解密的方式

项目中提供了生成key的策略，参考如下：

```
    public static void main(String[] args) throws Exception {
        // aes
        String aes = AES.initKey(256, 256);
        System.out.println(aes);
        // rsa
        Map<String, Object> rsa = RSA.initKey();
        System.out.println(RSA.getPrivateKey(rsa));
        System.out.println(RSA.getPublicKey(rsa));
        // ecc
        KeyPair keyPair = DataKeyGenerator.ECC.generateKeyPair();
        String publicKey = DataKeyGenerator.ECC.keyToString(keyPair.getPublic());
        String privateKey = DataKeyGenerator.ECC.keyToString(keyPair.getPrivate());
        //gcm
        SecretKey secretKey = DataKeyGenerator.GCM.generateAESGCMKey();
        String gcmKey = DataKeyGenerator.GCM.keyToString(secretKey);
    }
```



# 使用参考
## 制作依赖

```
mvn clean package install
```

## 引入依赖

```
<dependency>
    <groupId>com.javayh.secure.transmit</groupId>
    <artifactId>secure.transmit.boot.starter</artifactId>
    <version>2.6.2</version>
</dependency>
```

## 参加配置

```
secure:
  transmit:
    enable: true
    is-show-log: true
    type: aes
    # 序列化方式 
    serialization: com.javayh.secure.transmit.serialize.FastJsonSerialization
    # aes 加解密
    aes:
        # 自定义的 iv 加言
      iv: 长度为10的iv
        # 生成的 key
      key: 生成的key
    gcm:
        # 生成的 key
      key: 生成的key
        # 自定义的 iv 加言
      iv: 长度为10的iv
    # rsa 加解密
    rsa:
      private-key: 生成的私钥
      public-key: 生成公钥
    # ecc 加解密
    ecc:
      private-key: 生成的私钥
      public-key: 生成公钥
 
```

这里的`private-key` 和 `public-key` 在实际项目中需要换成自己的key，参考[数据加密](#数据加密)


## 序列化方式

- Serialization
服务内提供了标准的序列化接口，模式采用了`FastJson`，支持自定义序列化方式

### 实现自定义序列化方式的步骤
>
> 修改了原有的实现逻辑，将其托管到spring容器中，减少配置的方式
>
- 实现`Serialization`接口，将其注入到spring容器中
- 修改`secure.transmit.serialization` 的值为，自定序列化名字的全路径

- ~~在`resources` 下创建 `META-INF/services` 文件夹(`resources/META-INF/services`)~~
- ~~创建一个名字为 `com.javayh.secure.transmit.serialize.Serialization` 的文件，内容为自定序列化名字的全路径即可~~



## 示例1 

### json全文加解密

提供了两个注解用于全字段加解密 `@Encrypt` `@Decrypt` 在需要加解密的方法上使用注解即可

```
    @Encrypt
    @GetMapping(value = "/get/Encrypt")
    public ProbeLink getUsertEncrypt() {
        ProbeLink test = ProbeLink.builder().appName("test").contextPath("sys/api").status(1).build();
        return test;
    }
```

返回值效果
```
"5FgayzyGz0m6D7AI61yAzsJEEblACsdqJFNBvB++KBns5VSnXAOVHOB7ww9ozvqicNLLyIyD2wqVO9bPxGmCVp2LBXKUsTGAe8D1PxCFTbuZpNhg0G/TwqpgZyk5Pxhd"
```


## 示例2

### 指定字段的加解密

提供了两个注解用于全字段加解密 `@SecureCrypto` `@EncryptField` `@DecryptField` 在需要加解密的方法和指定的字段上即可

```
    @SecureCrypto
    @PostMapping(value = "/add/Encrypt/Decrypt")
    public ProbeLink userDecrypt(@RequestBody ProbeLink probeLink) {
        return probeLink;
    }


    public class ProbeLink {
    
    
        private Long id;
    
    
        /**
         * 服务名
         */
        @DecryptField
        @EncryptField
        private String appName;
    
        /**
         * context path
         */
        private String contextPath;
    
        /**
         * 方法
         */
        @EncryptField
        private String method;
    }
```

返回值效果

```
{
    "id": null,
    "appName": "1IJo//PzO5irNYxCzPtitw==",
    "contextPath": "sys/api",
    "method": null

}
```

## 示例3

### 指定算法的加解密

提供了两个注解用于全字段加解密 `@SecureTransmit` 配置`@EncryptField` `@DecryptField` 实现指定加解密的算法，实现多场景的混动模式

```
    @SecureTransmit(type = SecretType.ECC)
    @PostMapping(value = "/add/Encrypt/Decrypt")
    public ProbeLink userDecrypt(@RequestBody ProbeLink probeLink) {
        return probeLink;
    }
```

```

{
    "id": null,
    "appName": "BAGvlFt9rJwPyCG7elNWV91KqXzQK6PE4iTnkuYEHcWoN/xnjZ9FwdUHxXZrpageJ6hAqaOVAB0GoSA12nQe3HMiagBtQHmxHgKJQR8guPVUNRoJWKNYDygrToUGUL7kO/TTlH7rLnNdlExKUmAyugL55ic0u4HJ/fDzicuD6S5EtXrRFJjJDUfLPbAPoPxcqt/o2hIb/VrK19u9Vw==",
    "contextPath": "sys/api",
    "method": "BAG2ekWI3+XkrljmUKTxJCZUW2KMV8VnsY35EESiF5j9mjzRZOZxnYL9hhPv+LrtpAD+1ZuywQ7g5G9OFLKgA0zEBgGyEqkMs8dJHkDYw2VCRhImOyROma1uspF+EC7VsJ1/Dh4a/kda2Ybx5TTsrJiRpURzTrK9Ewb6KmlED/zLk9LVn4qj/vEAMv1F1GtnJNiuARvvgo9R1seXaQ==",
   }
```