实战：隐藏SpringBoot中的私密数据！

冷不防 2023-10-03 12:43 5阅读 0赞

![480e0880d8b61242d982d9b2d3c11370.png][]

这几天公司在排查内部数据账号泄漏，原因是发现某些实习生小可爱居然连带着账号、密码将源码私传到`GitHub`上，导致核心数据外漏，孩子还是没挨过社会毒打，这种事的后果可大可小。

![eeabba188848373b950e462c1cc00e51.png][]

说起这个我是比较有感触的，之前[我TM被删库][TM]的经历，到现在想起来心里还难受，我也是把数据库账号明文密码误提交到`GitHub`，然后被哪个大宝贝给我测试库删了，后边我长记性了把配置文件内容都加密了，数据安全问题真的不容小觑，不管工作汇还是生活，敏感数据一定要做脱敏处理。

所以接下来，咱们需要开展两方面的工作：

1.  对配置文件进行脱敏操作；
2.  对敏感的数据库字段进行脱敏操作。

说干就干，接下来咱们一起来对项目进行脱敏操作。

#### 1.配置脱敏 ####

实现配置的脱敏我使用了`Java`的一个加解密工具`Jasypt`，它提供了`单密钥对称加密`和`非对称加密`两种脱敏方式。

单密钥对称加密：一个密钥加盐，可以同时用作内容的加密和解密依据；

非对称加密：使用公钥和私钥两个密钥，才可以对内容加密和解密；

以上两种加密方式使用都非常简单，咱们以`springboot`集成单密钥对称加密方式做示例。

首先引入`jasypt-spring-boot-starter` jar

<dependency>
         <groupId>com.github.ulisesbocchio</groupId>
         <artifactId>jasypt-spring-boot-starter</artifactId>
         <version>2.1.0</version>
     </dependency>

配置文件加入秘钥配置项`jasypt.encryptor.password`，并将需要脱敏的`value`值替换成预先经过加密的内容`ENC(mVTvp4IddqdaYGqPl9lCQbzM3H/b0B6l)`。

这个格式我们是可以随意定义的，比如想要`abc[mVTvp4IddqdaYGqPl9lCQbzM3H/b0B6l]`格式，只要配置前缀和后缀即可。

jasypt:
      encryptor:
        property:
          prefix: "abc["
          suffix: "]"

ENC(XXX）格式主要为了便于识别该值是否需要解密，如不按照该格式配置，在加载配置项的时候`jasypt`将保持原值，不进行解密。

spring:
      datasource:
        url: jdbc:mysql://1.2.3.4:3306/xiaofu?useSSL=false&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&ze oDateTimeBehavior=convertToNull&serverTimezone=Asia/Shanghai
        username: xiaofu
        password: ENC(mVTvp4IddqdaYGqPl9lCQbzM3H/b0B6l)
    
    # 秘钥
    jasypt:
      encryptor:
        password: 程序员内点事(然而不支持中文)

秘钥是个安全性要求比较高的属性，所以一般不建议直接放在项目内，可以通过启动时`-D`参数注入，或者放在配置中心，避免泄露。

java -jar -Djasypt.encryptor.password=1123  springboot-jasypt-2.3.3.RELEASE.jar

预先生成的加密值，可以通过代码内调用API生成

@Autowired
    private StringEncryptor stringEncryptor;
    
    public void encrypt(String content) {
        String encryptStr = stringEncryptor.encrypt(content);
        System.out.println("加密后的内容：" + encryptStr);
    }

或者通过如下Java命令生成，几个参数`D:\maven_lib\org\jasypt\jasypt\1.9.3\jasypt-1.9.3.jar`为jasypt核心jar包，`input`待加密文本，`password`秘钥，`algorithm`为使用的加密算法。

java -cp  D:\maven_lib\org\jasypt\jasypt\1.9.3\jasypt-1.9.3.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input="root" password=xiaofu  algorithm=PBEWithMD5AndDES

![f1d16b13fe3432238864a4bf5f4663e7.png][]

一顿操作后如果还能正常启动，说明配置文件脱敏就没问题了。

#### 2.敏感字段脱敏 ####

生产环境用户的隐私数据，比如手机号、身份证或者一些账号配置等信息，入库时都要进行不落地脱敏，也就是在进入我们系统时就要实时的脱敏处理。

用户数据进入系统，脱敏处理后持久化到数据库，用户查询数据时还要进行反向解密。这种场景一般需要全局处理，那么用`AOP`切面来实现在适合不过了。

![1dbfbea32da27780d59e7ad20d4ff675.png][]

首先自定义两个注解`@EncryptField`、`@EncryptMethod`分别用在字段属性和方法上，实现思路很简单，只要方法上应用到`@EncryptMethod`注解，则检查入参字段是否标注`@EncryptField`注解，有则将对应字段内容加密。

@Documented
    @Target({ElementType.FIELD,ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface EncryptField {
    
        String[] value() default "";
    }

@Documented
    @Target({ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface EncryptMethod {
    
        String type() default ENCRYPT;
    }

切面的实现也比较简单，对入参加密，返回结果解密。为了方便阅读这里就只贴出部分代码，完整案例Github地址：https://github.com/chengxy-nds/Springboot-Notebook/tree/master/springboot-jasypt

@Slf4j
    @Aspect
    @Component
    public class EncryptHandler {
    
        @Autowired
        private StringEncryptor stringEncryptor;
    
        @Pointcut("@annotation(com.xiaofu.annotation.EncryptMethod)")
        public void pointCut() {
        }
    
        @Around("pointCut()")
        public Object around(ProceedingJoinPoint joinPoint) {
            /**
             * 加密
             */
            encrypt(joinPoint);
            /**
             * 解密
             */
            Object decrypt = decrypt(joinPoint);
            return decrypt;
        }
    
        public void encrypt(ProceedingJoinPoint joinPoint) {
    
            try {
                Object[] objects = joinPoint.getArgs();
                if (objects.length != 0) {
                    for (Object o : objects) {
                        if (o instanceof String) {
                            encryptValue(o);
                        } else {
                            handler(o, ENCRYPT);
                        }
                        //TODO 其余类型自己看实际情况加
                    }
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
    
        public Object decrypt(ProceedingJoinPoint joinPoint) {
            Object result = null;
            try {
                Object obj = joinPoint.proceed();
                if (obj != null) {
                    if (obj instanceof String) {
                        decryptValue(obj);
                    } else {
                        result = handler(obj, DECRYPT);
                    }
                    //TODO 其余类型自己看实际情况加
                }
            } catch (Throwable e) {
                e.printStackTrace();
            }
            return result;
        }
        。。。
    }

紧接着测试一下切面注解的效果，我们对字段`mobile`、`address`加上注解`@EncryptField`做脱敏处理。

@EncryptMethod
    @PostMapping(value = "test")
    @ResponseBody
    public Object testEncrypt(@RequestBody UserVo user, @EncryptField String name) {
    
        return insertUser(user, name);
    }
    
    private UserVo insertUser(UserVo user, String name) {
        System.out.println("加密后的数据：user" + JSON.toJSONString(user));
        return user;
    }
    
    @Data
    public class UserVo implements Serializable {
    
        private Long userId;
    
        @EncryptField
        private String mobile;
    
        @EncryptField
        private String address;
    
        private String age;
    }

请求这个接口，看到参数被成功加密，而返回给用户的数据依然是脱敏前的数据，符合我们的预期，那到这简单的脱敏实现就完事了。

![833e38755356311457e815dc04627a18.png][] ![52887915fff2557093de9092bd101abe.png][]

#### 3.原理分析 ####

`Jasypt`工具虽然简单好用，但作为程序员我们不能仅满足于熟练使用，底层实现原理还是有必要了解下的，这对后续调试bug、二次开发扩展功能很重要。

个人认为`Jasypt`配置文件脱敏的原理很简单，无非就是在具体使用配置信息之前，先拦截获取配置的操作，将对应的加密配置解密后再使用。

具体是不是如此我们简单看下源码的实现，既然是以`springboot`方式集成，那么就先从`jasypt-spring-boot-starter`源码开始入手。

`starter`代码很少，主要的工作就是通过`SPI`机制注册服务和`@Import`注解来注入需前置处理的类`JasyptSpringBootAutoConfiguration`。

![164fd22733e482dbf5405652efb21245.png][]

在前置加载类`EnableEncryptablePropertiesConfiguration`中注册了一个核心处理类`EnableEncryptablePropertiesBeanFactoryPostProcessor`。

![fdd82ec916f6af2c2556b815e9f43ba2.png][]

它的构造器有两个参数，`ConfigurableEnvironment`用来获取所有配属信息，`EncryptablePropertySourceConverter`对配置信息做解析处理。

顺藤摸瓜发现具体负责解密的处理类`EncryptablePropertySourceWrapper`，它通过对`Spring`属性管理类`PropertySource<T>`做拓展，重写了`getProperty(String name)`方法，在获取配置时，凡是指定格式如**ENC(x)** 包裹的值全部解密处理。

![4545a3367ececdead8d4e64d26267870.png][]

既然知道了原理那么后续我们二次开发，比如：切换加密算法或者实现自己的脱敏工具就容易的多了。

> “
> 
> 案例Github地址：https://github.com/chengxy-nds/Springboot-Notebook/tree/master/springboot-jasypt

**PBE算法**

再来聊一下`Jasypt`中用的加密算法，其实它是在JDK的`JCE.jar`包基础上做了封装，本质上还是用的JDK提供的算法，默认使用的是`PBE`算法`PBEWITHMD5ANDDES`，看到这个算法命名很有意思，段个句看看，PBE、WITH、MD5、AND、DES 好像有点故事，继续看。

![30fb937756b0fbd701c265f0bc1fe645.png][]

`PBE`算法（`Password Based Encryption`，基于口令（密码）的加密）是一种基于口令的加密算法，其特点在于口令是由用户自己掌握，在加上随机数多重加密等方法保证数据的安全性。

PBE算法本质上并没有真正构建新的加密、解密算法，而是对我们已知的算法做了包装。比如：常用的消息摘要算法`MD5`和`SHA`算法，对称加密算法`DES`、`RC2`等，而`PBE`算法就是将这些算法进行合理组合，这也呼应上前边算法的名字。

![bf7c3783c5da18a2a3ee7e47feb0739a.png][]

既然PBE算法使用我们较为常用的对称加密算法，那就会涉及密钥的问题。但它本身又没有钥的概念，只有口令密码，密钥则是口令经过加密算法计算得来的。

口令本身并不会很长，所以不能用来替代密钥，只用口令很容易通过穷举攻击方式破译，这时候就得加点**盐**了。

盐通常会是一些随机信息，比如随机数、时间戳，将盐附加在口令上，通过算法计算加大破译的难度。

**源码里的猫腻**

简单了解PBE算法，回过头看看`Jasypt`源码是如何实现加解密的。

在加密的时候首先实例化秘钥工厂`SecretKeyFactory`，生成八位盐值，默认使用的`jasypt.encryptor.RandomSaltGenerator`生成器。

public byte[] encrypt(byte[] message) {
        // 根据指定算法，初始化秘钥工厂
        final SecretKeyFactory factory = SecretKeyFactory.getInstance(algorithm1);
        // 盐值生成器，只选八位
        byte[] salt = saltGenerator.generateSalt(8);
        // 
        final PBEKeySpec keySpec = new PBEKeySpec(password.toCharArray(), salt, iterations);
        // 盐值、口令生成秘钥
        SecretKey key = factory.generateSecret(keySpec);
    
        // 构建加密器
        final Cipher cipherEncrypt = Cipher.getInstance(algorithm1);
        cipherEncrypt.init(Cipher.ENCRYPT_MODE, key);
        // 密文头部（盐值）
        byte[] params = cipherEncrypt.getParameters().getEncoded();
    
        // 调用底层实现加密
        byte[] encryptedMessage = cipherEncrypt.doFinal(message);
    
        // 组装最终密文内容并分配内存（盐值+密文）
        return ByteBuffer
                .allocate(1 + params.length + encryptedMessage.length)
                .put((byte) params.length)
                .put(params)
                .put(encryptedMessage)
                .array();
    }

由于默认使用的是随机盐值生成器，导致相同**内容每次加密后的内容都是不同的**。

那么解密时该怎么对应上呢？

看上边的源码发现，最终的加密文本是由两部分组成的，`params`消息头里边包含口令和随机生成的盐值，`encryptedMessage`密文。

![92ea533f02b91b4cfc1e9ffe8d246505.png][] 加密

而在解密时会根据密文`encryptedMessage`的内容拆解出`params`内容解析出盐值和口令，在调用JDK底层算法解密出实际内容。

@Override
    @SneakyThrows
    public byte[] decrypt(byte[] encryptedMessage) {
        // 获取密文头部内容
        int paramsLength = Byte.toUnsignedInt(encryptedMessage[0]);
        // 获取密文内容
        int messageLength = encryptedMessage.length - paramsLength - 1;
        byte[] params = new byte[paramsLength];
        byte[] message = new byte[messageLength];
        System.arraycopy(encryptedMessage, 1, params, 0, paramsLength);
        System.arraycopy(encryptedMessage, paramsLength + 1, message, 0, messageLength);
    
        // 初始化秘钥工厂
        final SecretKeyFactory factory = SecretKeyFactory.getInstance(algorithm1);
        final PBEKeySpec keySpec = new PBEKeySpec(password.toCharArray());
        SecretKey key = factory.generateSecret(keySpec);
    
        // 构建头部盐值口令参数
        AlgorithmParameters algorithmParameters = AlgorithmParameters.getInstance(algorithm1);
        algorithmParameters.init(params);
    
        // 构建加密器，调用底层算法
        final Cipher cipherDecrypt = Cipher.getInstance(algorithm1);
        cipherDecrypt.init(
                Cipher.DECRYPT_MODE,
                key,
                algorithmParameters
        );
        return cipherDecrypt.doFinal(message);
    }

![663146f8233ff3002de2b17be6dd66b8.png][] 解密

**我是磊哥～**，如果对你有用**在看**、**关注**支持下，咱们下期见~

![89eb5da16203bb779772c0a9502e2e36.gif][]

往期推荐

[![4befdca53b9451178d1a2bda5258fbe3.png][]][4befdca53b9451178d1a2bda5258fbe3.png 1]

[SpringBoot 如何统一后端返回格式？老鸟们都是这样玩的！][4befdca53b9451178d1a2bda5258fbe3.png 1]

[![5781ecec5c21cee4af85178391574dc0.png][]][5781ecec5c21cee4af85178391574dc0.png 1]

[SpringBoot时间格式化的5种方法！][5781ecec5c21cee4af85178391574dc0.png 1]

[![c80d37bdfadc3049bdbe44026038bff5.png][]][c80d37bdfadc3049bdbe44026038bff5.png 1]

[SpringBoot 优雅的参数效验！][c80d37bdfadc3049bdbe44026038bff5.png 1]

[480e0880d8b61242d982d9b2d3c11370.png]: https://img-blog.csdnimg.cn/img_convert/480e0880d8b61242d982d9b2d3c11370.png
[eeabba188848373b950e462c1cc00e51.png]: https://img-blog.csdnimg.cn/img_convert/eeabba188848373b950e462c1cc00e51.png
[TM]: https://mp.weixin.qq.com/s?__biz=MzAxNTM4NzAyNg%3D%3D&idx=1&mid=2247493189&scene=21&sn=5e18220de87c5cc29208ccd595327f22#wechat_redirect
[f1d16b13fe3432238864a4bf5f4663e7.png]: https://img-blog.csdnimg.cn/img_convert/f1d16b13fe3432238864a4bf5f4663e7.png
[1dbfbea32da27780d59e7ad20d4ff675.png]: https://img-blog.csdnimg.cn/img_convert/1dbfbea32da27780d59e7ad20d4ff675.png
[833e38755356311457e815dc04627a18.png]: https://img-blog.csdnimg.cn/img_convert/833e38755356311457e815dc04627a18.png
[52887915fff2557093de9092bd101abe.png]: https://img-blog.csdnimg.cn/img_convert/52887915fff2557093de9092bd101abe.png
[164fd22733e482dbf5405652efb21245.png]: https://img-blog.csdnimg.cn/img_convert/164fd22733e482dbf5405652efb21245.png
[fdd82ec916f6af2c2556b815e9f43ba2.png]: https://img-blog.csdnimg.cn/img_convert/fdd82ec916f6af2c2556b815e9f43ba2.png
[4545a3367ececdead8d4e64d26267870.png]: https://img-blog.csdnimg.cn/img_convert/4545a3367ececdead8d4e64d26267870.png
[30fb937756b0fbd701c265f0bc1fe645.png]: https://img-blog.csdnimg.cn/img_convert/30fb937756b0fbd701c265f0bc1fe645.png
[bf7c3783c5da18a2a3ee7e47feb0739a.png]: https://img-blog.csdnimg.cn/img_convert/bf7c3783c5da18a2a3ee7e47feb0739a.png
[92ea533f02b91b4cfc1e9ffe8d246505.png]: https://img-blog.csdnimg.cn/img_convert/92ea533f02b91b4cfc1e9ffe8d246505.png
[663146f8233ff3002de2b17be6dd66b8.png]: https://img-blog.csdnimg.cn/img_convert/663146f8233ff3002de2b17be6dd66b8.png
[89eb5da16203bb779772c0a9502e2e36.gif]: https://img-blog.csdnimg.cn/img_convert/89eb5da16203bb779772c0a9502e2e36.gif
[4befdca53b9451178d1a2bda5258fbe3.png]: https://img-blog.csdnimg.cn/img_convert/4befdca53b9451178d1a2bda5258fbe3.png
[4befdca53b9451178d1a2bda5258fbe3.png 1]: http://mp.weixin.qq.com/s?__biz=MzU1NTkwODE4Mw%3D%3D&chksm=fbcf99c5ccb810d30abb43dd5ac0c1e8f3213f699bfbab6002396a64d4e17ae7e59d598ebf16&idx=1&mid=2247496957&scene=21&sn=ac0a27516353f337245f0d70ebfd9ae8#wechat_redirect
[5781ecec5c21cee4af85178391574dc0.png]: https://img-blog.csdnimg.cn/img_convert/5781ecec5c21cee4af85178391574dc0.png
[5781ecec5c21cee4af85178391574dc0.png 1]: http://mp.weixin.qq.com/s?__biz=MzU1NTkwODE4Mw%3D%3D&chksm=fbcf99deccb810c8d5d0dcdf62ceb5b5a913bfed419bd4d8db7ccaf2de61fef10b4f9d91956b&idx=1&mid=2247496934&scene=21&sn=709fac349ed677ea68a3256ac078228e#wechat_redirect
[c80d37bdfadc3049bdbe44026038bff5.png]: https://img-blog.csdnimg.cn/img_convert/c80d37bdfadc3049bdbe44026038bff5.png
[c80d37bdfadc3049bdbe44026038bff5.png 1]: http://mp.weixin.qq.com/s?__biz=MzU1NTkwODE4Mw%3D%3D&chksm=fbcf9947ccb8105111209535bf9dae8b899427df93dafe1b435897c25f1da45b9c34f90a0ab7&idx=1&mid=2247496831&scene=21&sn=f6d965fd606d607476fa7e33d45a28af#wechat_redirect