如何实现自定义数据库账号密码加解密

背景

在实际的项目开发中我们有时候基于安全考虑需要在项目配置文件中对数据库账号密码做加密处理，这个时候我们就可以使用jasypt这个组件来实现。如果有些项目安全等级要求比较高，可能加密的算法需要自定义或者使用SM4国密算法来实现加解密，那么这个时候我们该如何使用jasypt这个组件来实现自定义算法加解密？

准备工作

首先我们需要引入jasypt组件，在pom文件中添加相关依赖

<dependency>
    <groupId>com.github.ulisesbocchiogroupId>
    <artifactId>jasypt-spring-boot-starterartifactId>
    <version>1.14version>
dependency>
<dependency>
    <groupId>com.github.ulisesbocchiogroupId>
    <artifactId>jasypt-spring-bootartifactId>
    <version>1.14version>
dependency>

写好加解密算法，这个我们就以常用的SM4国密算法为例(为了方便直接将整个hutool引入，实际项目中可以按模块引入相关依赖)

<dependency>
    <groupId>cn.hutoolgroupId>
    <artifactId>hutool-allartifactId>
    <version>5.3.8version>
dependency>

代码编写

SM4工具类代码

package com.example.springdemo.databaseEncryptor;

import cn.hutool.core.codec.Base64;
import cn.hutool.core.util.CharsetUtil;
import cn.hutool.crypto.Mode;
import cn.hutool.crypto.Padding;
import cn.hutool.crypto.symmetric.SM4;
import cn.hutool.crypto.symmetric.SymmetricCrypto;


/**
 * Created with IntelliJ IDEA
 *
 * @author kingMouse
 * @date 2023/8/31 09:39
 * Description: SM4工具类
 */

public class SM4Util {
    private static final SymmetricCrypto SM4_CONTEXT = new SM4(Mode.CBC, Padding.PKCS5Padding, "GJeeXX_B4dr7JWJW".getBytes(CharsetUtil.CHARSET_UTF_8), "Zkw_SdNoSsFT=568".getBytes(CharsetUtil.CHARSET_UTF_8));

    /**
     * 加密
     * @param plainTxt
     * @return
     */
    public static String encrypt(String plainTxt){
        byte[] encrypHex = SM4_CONTEXT.encrypt(plainTxt);
        return Base64.encode(encrypHex);
    }


    /**
     * 解密
     * @param cipherTxt
     * @return
     */
    public static String decrypt(String cipherTxt){
        byte[] cipherHex = Base64.decode(cipherTxt);
        return SM4_CONTEXT.decryptStr(cipherHex, CharsetUtil.CHARSET_UTF_8);
    }
}

提供一个名为jasyptStringEncryptor名称的Bean来替换jasypt默认的加解密算法

package com.example.springdemo.databaseEncryptor;


import com.ulisesbocchio.jasyptspringboot.properties.JasyptEncryptorConfigurationProperties;
import org.jasypt.encryption.StringEncryptor;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Created with IntelliJ IDEA
 *
 * @author kingMouse
 * @date 2023/8/31 09:40
 * Description: 自定义数据库sm4加密器
 */
@Configuration
@EnableConfigurationProperties(JasyptEncryptorConfigurationProperties.class)
public class SM4EncryptorConfig {

    @Bean
    StringEncryptor jasyptStringEncryptor(JasyptEncryptorConfigurationProperties properties){

        return new StringEncryptor() {
            // 加密
            @Override
            public String encrypt(String message) {
                return SM4Util.encrypt(message);
            }
            // 解密
            @Override
            public String decrypt(String message) {
                return SM4Util.decrypt(message);
            }
        };
    }
}

配置文件修改

将数据库账号密码使用我们代码中的SM4工具类进行加密，然后将加密后的字符串配置我们的配置文件中

注意要使用ENC()包裹起来，如果不使用ENC()包裹起来则不走加解密规则

spring.datasource.username=ENC(kLUMJ9z/cLqON680m4zalA==)
spring.datasource.password=ENC(n5zn71QTbr2WGC6puEJi8g==)

测试

启动项目访问接口进行数据库数据查询，验证能否正常将数据库中数据查询出来