# encryption

**Repository Path**: xu_zhibin/encryption

## Basic Information

- **Project Name**: encryption
- **Description**: 这是一个基于SpringBoot2.x的HTTP数据传输加密框架，该框架是为了给仍在使用HTTP进行数据传输的项目提供一层有效的数据安全防护。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 2
- **Created**: 2022-04-02
- **Last Updated**: 2024-09-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 数据加密, SpringBoot

## README

# encryption

#### 介绍
这是一个基于SpringBoot2.x的HTTP数据传输加密框架，该框架是为了给仍在使用HTTP进行数据传输的项目提供一层有效的数据安全防护，
有效了避免重要敏感数据在传输过程中被窃取的风险，框架开箱即用，只需简单的配置就可以融入你的项目之中。


#### 特性
- 内置超过8种常用的算法或模式（对称、非对称、混合模式），基本上可以覆盖大部分项目的加密需求
- 支持如@DecryptParam、@DecryptBody等在内的丰富的注解
- 兼容SpringMVC的Validation校验体系，可以无缝使用了其进行参数校验
- 兼容SpringBoot2.x的JSON框架体系，默认集成了Jackson、Gson、Fastjson，也可拓展其他Json框架的集成
- 内置调试模式，可方便查看和调试加解密时的数据，可配置详细输出类目
- 支持自定义参数加密器
- 新增Mock功能，支持快速模拟请求数据进行测试

#### 下个版本前瞻
预计新增：
- 响应字段值脱敏
- 请求体的只解密部分字段的方式

预计优化：
- 优化反射性能


#### 使用手册
[使用手册](https://gitee.com/xu_zhibin/encryption/wikis/%E7%94%A8%E5%89%8D%E5%BF%85%E8%AF%BB)


#### Maven坐标
支持Maven依赖安装，如果中央仓库（后续会上传）没有，则需要打包编译安装到本地仓库或私服（版本号为最新版本号）：
~~~xml
<!-- 导入 starter 包-->
<dependency>
    <groupId>com.github.xzb617</groupId>
    <artifactId>encryption-spring-boot-starter</artifactId>
    <version>1.0.1</version>
</dependency>
~~~


1.  引入 encryption-spring-boot-starter
    ~~~xml
    <dependency>
        <groupId>com.github.xzb617</groupId>
        <artifactId>encryption-spring-boot-starter</artifactId>
        <version>1.0.1</version>
    </dependency>
    ~~~

2.  配置加密器使用的算法模式，其中configs的配置是根据不同算法模式有不同的配置项，参考：
    ~~~yaml
    # 加密配置
    encryption:
      charset: 'UTF-8'
      algorithm: rsa_with_aes
      # 不同算法模式有不同的配置项
      configs:
        public-key: 'xxxxxxxxxx'
        private-key: 'xxxxxxxxxx'
        secret: 'xxxxxxxxxx'
        iv: 'xxxxxxxxxx'
    ~~~
3.  在启动类或配置类上添加开启注解 @EnableEncryption
    ~~~java
    @EnableEncryption
    @SpringBootApplication
    public class EncryptionSpringBootSampleApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(EncryptionSpringBootSampleApplication.class, args);
        }
    
    }
    ~~~
4.  控制台打印出下面的信息就代表，框架可以正常使用了
    ~~~shell script
    2022-xx-xx 23:07:39.782  INFO 14864 --- [           main] c.g.x.e.a.EncryptionAutoConfiguration    : Encryption has take effective successfully
    ~~~
  
    
#### 入门案例
~~~java
@RestController
@RequestMapping("/decryptParam")
public class DecryptParamController {

    /**
     * 测试 @DecryptParam 注解
     * @param intKey 
     * @param longKey
     * @param doubleKey
     * @param strKey
     * @param boolKey
     * @param dateKey
     * @return
     */
    @GetMapping("/index")
    public Result index(@DecryptParam(required = true, message = "intKey不能为空") Integer intKey,
                        @DecryptParam(required = true, message = "longKey不能为空") Long longKey,
                        @DecryptParam(required = true, message = "doubleKey不能为空") Double doubleKey,
                        @DecryptParam(required = true, message = "strKey不能为空") String strKey,
                        @DecryptParam(required = true, message = "boolKey不能为空") Boolean boolKey,
                        @DecryptParam(required = true, message = "dateKey不能为空") @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") Date dateKey) {
        return Result.success("解密参数成功",
                String.format(
                    "intKey: %d, longKey: %d, doubleKey: %f, strKey: %s, boolKey: %s, dateKey: %s",
                    intKey, longKey, doubleKey, strKey, boolKey, dateKey
                )
        );
    }

}
~~~

更多的使用说明详见使用手册