基于 Sharding Sphere，实现数据 “一键脱敏”！

╰半橙微兮° 2022-09-02 14:46 84阅读 0赞

**点击关注公众号，Java干货****及时送达**![b6757cdfc4dd94efcd77986c960896d0.png][]

*来源：https://jaskey.github.io/blog/2020/03/18/sharding-sphere-data-desensitization/*

在真实业务场景中，数据库中经常需要存储某些客户的关键性敏感信息如：身份证号、银行卡号、姓名、手机号码等，此类信息按照合规要求，通常需要实现加密存储以满足合规要求。

## 痛点一： ##

通常的解决方案是我们书写SQL的时候，把对应的加密字段手动进行加密再进行插入，在查询的时候使用之前再手动进行解密。此方法固然可行，但是使用起来非常不便捷且繁琐，使得日常的业务开发与存储合规的细节紧耦合

## 痛点二： ##

对于一些为了快速上线而一开始没有实现合规脱敏的系统，如何比较快速的使得已有业务满足合规要求的同时，尽量减少对原系统的改造。（通常的这个过程至少包括：1.新增脱敏列的存储 2.同时做数据迁移 3.业务的代码做兼容逻辑等）。

Apache ShardingSphere下面存在一个数据脱敏模块，此模块集成的常用的数据脱敏的功能。其基本原理是对用户输入的SQL进行解析拦截，并依靠用户的脱敏配置进行SQL的改写，从而实现对原文字段的加密及加密字段的解密。最终实现对用户无感的加解密存储、查询。

## 脱敏配置Quick Start——Spring 显示配置： ##

以下介绍基于Spring如何快速让系统支持脱敏配置。[*Spring Boot 学习笔记*，][Spring Boot]推荐给你学习下。

### 1.引入依赖 ###

<dependency>
        <groupId>org.apache.shardingsphere</groupId>
        <artifactId>sharding-jdbc-spring-namespace</artifactId>
        <version>${sharding-sphere.version}</version>
    </dependency>

### 2.创建脱敏配置规则对象 ###

[在创建数据源之前，需要准备一个EncryptRuleConfiguration进行脱敏的配置，以下是一个例子，对于同一个数据源里两张表card\_info，pay\_order的不同字段进行AES的加密：][Spring Boot]

private EncryptRuleConfiguration getEncryptRuleConfiguration() {
        Properties props = new Properties();
    
        //自带aes算法需要
        props.setProperty("aes.key.value", aeskey);
        EncryptorRuleConfiguration encryptorConfig = new EncryptorRuleConfiguration("AES", props);
    
        //自定义算法
        //props.setProperty("qb.finance.aes.key.value", aeskey);
        //EncryptorRuleConfiguration encryptorConfig = new EncryptorRuleConfiguration("QB-FINANCE-AES", props);
    
        EncryptRuleConfiguration encryptRuleConfig = new EncryptRuleConfiguration();
        encryptRuleConfig.getEncryptors().put("aes", encryptorConfig);
    
        //START: card_info 表的脱敏配置
        {
            EncryptColumnRuleConfiguration columnConfig1 = new EncryptColumnRuleConfiguration("", "name", "", "aes");
            EncryptColumnRuleConfiguration columnConfig2 = new EncryptColumnRuleConfiguration("", "id_no", "", "aes");
            EncryptColumnRuleConfiguration columnConfig3 = new EncryptColumnRuleConfiguration("", "finshell_card_no", "", "aes");
            Map<String, EncryptColumnRuleConfiguration> columnConfigMaps = new HashMap<>();
            columnConfigMaps.put("name", columnConfig1);
            columnConfigMaps.put("id_no", columnConfig2);
            columnConfigMaps.put("finshell_card_no", columnConfig3);
            EncryptTableRuleConfiguration tableConfig = new EncryptTableRuleConfiguration(columnConfigMaps);
            encryptRuleConfig.getTables().put("card_info", tableConfig);
        }
        //END: card_info 表的脱敏配置
    
        //START: pay_order 表的脱敏配置
        {
            EncryptColumnRuleConfiguration columnConfig1 = new EncryptColumnRuleConfiguration("", "card_no", "", "aes");
            Map<String, EncryptColumnRuleConfiguration> columnConfigMaps = new HashMap<>();
            columnConfigMaps.put("card_no", columnConfig1);
            EncryptTableRuleConfiguration tableConfig = new EncryptTableRuleConfiguration(columnConfigMaps);
            encryptRuleConfig.getTables().put("pay_order", tableConfig);
        }
    
        log.info("脱敏配置构建完成:{} ", encryptRuleConfig);
        return encryptRuleConfig;
    
    }

[说明：][Spring Boot]

1.  [创建 EncryptColumnRuleConfiguration 的时候有四个参数，前两个参数分表叫plainColumn、cipherColumn，其意思是数据库存储里面真实的两个列（名文列、脱敏列），对于新的系统，只需要设置脱敏列即可，所以以上示例为plainColumn为”“。][Spring Boot]
2.  [创建EncryptTableRuleConfiguration 的时候需要传入一个map，这个map存的value即\#1中说明的EncryptColumnRuleConfiguration ，而其key则是一个逻辑列，对于新系统，此逻辑列即为真实的脱敏列。Sharding Shpere在拦截到SQL改写的时候，会按照用户的配置，把逻辑列映射为名文列或者脱敏列（默认）如下的示例][Spring Boot]

![0a075e93517211de43279abc58e717d5.png][]

### 3.使用Sharding Sphere的数据源进行管理 ###

把原始的数据源包装一层

@Bean("tradePlatformDataSource") 
    public DataSource dataSource(
     @Qualifier("druidDataSource") DataSource ds) throws SQLException {    
     return EncryptDataSourceFactory.createDataSource(ds, getEncryptRuleConfiguration(), new Properties()); 
    }

## 脱敏配置Quick Start——Spring Boot版： ##

以下步骤使用Spring Boot管理，可以仅用配置文件解决：

#### [1.引入依赖][Spring Boot] ####

<dependency>
    <groupId>org.apache.shardingsphere</groupId>
        <artifactId>sharding-jdbc-spring-boot-starter</artifactId>
        <version>${sharding-sphere.version}</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.apache.shardingsphere</groupId>
        <artifactId>sharding-jdbc-spring-namespace</artifactId>
        <version>${sharding-sphere.version}</version>
    </dependency>

#### [2.Spring 配置文件][Spring Boot] ####

spring.shardingsphere.datasource.name=ds
    spring.shardingsphere.datasource.ds.type=com.alibaba.druid.pool.DruidDataSource
    spring.shardingsphere.datasource.ds.driver-class-name=com.mysql.jdbc.Driver
    spring.shardingsphere.datasource.ds.url=xxxxxxxxxxxxx
    spring.shardingsphere.datasource.ds.username=xxxxxxx
    spring.shardingsphere.datasource.ds.password=xxxxxxxxxxxx
    
    # 默认的AES加密器
    spring.shardingsphere.encrypt.encryptors.encryptor_aes.type=aes
    spring.shardingsphere.encrypt.encryptors.encryptor_aes.props.aes.key.value=hkiqAXU6Ur5fixGHaO4Lb2V2ggausYwW
    
    # card_info 姓名 AES加密
    spring.shardingsphere.encrypt.tables.card_info.columns.name.cipherColumn=name
    spring.shardingsphere.encrypt.tables.card_info.columns.name.encryptor=encryptor_aes
    
    # card_info 身份证 AES加密
    spring.shardingsphere.encrypt.tables.card_info.columns.id_no.cipherColumn=id_no
    spring.shardingsphere.encrypt.tables.card_info.columns.id_no.encryptor=encryptor_aes
    
    # card_info 银行卡号 AES加密
    spring.shardingsphere.encrypt.tables.card_info.columns.finshell_card_no.cipherColumn=finshell_card_no
    spring.shardingsphere.encrypt.tables.card_info.columns.finshell_card_no.encryptor=encryptor_aes
    
    # pay_order 银行卡号 AES加密
    spring.shardingsphere.encrypt.tables.pay_order.columns.card_no.cipherColumn=card_no
    spring.shardingsphere.encrypt.tables.pay_order.columns.card_no.encryptor=encryptor_aes

另外，关注公众号Java技术栈，在后台回复：面试，可以获取我整理的 Java 系列面试题和答案，非常齐全。

![5121f6522267ea3f0ab333b0b5088026.gif][]

![4c4d4a45da8355bb49432584b3b3fc36.png][]

[![34f349db7151302b3c3ad9497e329935.png][]][34f349db7151302b3c3ad9497e329935.png 1]

[![e6791620183d32462c9c9895ae3e56a8.png][]][e6791620183d32462c9c9895ae3e56a8.png 1]

[![cbc0ea37dee257c12283fb31393aa714.png][]][cbc0ea37dee257c12283fb31393aa714.png 1]

[![abd69f03bced01b7d5ad50df2d614471.png][]][abd69f03bced01b7d5ad50df2d614471.png 1]

[![d789530eec287e2a8fe87d294b0eb004.png][]][d789530eec287e2a8fe87d294b0eb004.png 1]

**关注Java技术栈看更多干货**

![98c471eac97b5a86ac651f39c024aaef.png][]

![dcbf6fe67dc0440bf9e0bf981f233de1.gif][]

获取 Spring Boot 实战笔记！

[b6757cdfc4dd94efcd77986c960896d0.png]: /images/20220829/aa84095d23184b1997057c5a4954cef9.png
[Spring Boot]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&chksm=eb50d3bbdc275aadb0d742940e0be274c873627ab4828c5d861dd391d135408088abb8bda792&idx=2&mid=2247538317&scene=21&sn=baad0e54773d69c3d96f32667957a11e#wechat_redirect
[0a075e93517211de43279abc58e717d5.png]: /images/20220829/b7340e32ceb742b980336ef61638fde5.png
[5121f6522267ea3f0ab333b0b5088026.gif]: /images/20220829/de68e3b8ed65433e9b43e244b4ca6c63.png
[4c4d4a45da8355bb49432584b3b3fc36.png]: /images/20220829/7f86372b33eb4123bacfa598a6804da4.png
[34f349db7151302b3c3ad9497e329935.png]: /images/20220829/c28fb3c66a624e1099eb40a4c38874dd.png
[34f349db7151302b3c3ad9497e329935.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247538317&scene=21&sn=43c95adbf842bcbd3c36628e46a8cff0#wechat_redirect
[e6791620183d32462c9c9895ae3e56a8.png]: /images/20220829/16848f74f5094e58a587b73b4345e59e.png
[e6791620183d32462c9c9895ae3e56a8.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247538213&scene=21&sn=2aa32b7da9aa26cc30c641769c8527c9#wechat_redirect
[cbc0ea37dee257c12283fb31393aa714.png]: /images/20220829/372728b834a24a938f9613486e9f21f0.png
[cbc0ea37dee257c12283fb31393aa714.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247530418&scene=21&sn=e6a0138c7c2f9a9ff6a8b4c878386211#wechat_redirect
[abd69f03bced01b7d5ad50df2d614471.png]: /images/20220829/c9a02a952aa44cc58eaebc4dda69bb6a.png
[abd69f03bced01b7d5ad50df2d614471.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247537730&scene=21&sn=3869e164e482b838671fa8896cb33cdb#wechat_redirect
[d789530eec287e2a8fe87d294b0eb004.png]: /images/20220829/c9ea7d8f57914086954394f799cc48d7.png
[d789530eec287e2a8fe87d294b0eb004.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247535563&scene=21&sn=b2a1de775b95890690e3295aa7e6b253#wechat_redirect
[98c471eac97b5a86ac651f39c024aaef.png]: /images/20220829/f25726bd484e438a9c50d979f14ed7d8.png
[dcbf6fe67dc0440bf9e0bf981f233de1.gif]: /images/20220829/9de2dc77e4174a4a81f6ee50a4348e92.png