详解如何利用jasypt实现配置文件加密

Miette ·

更新时间:2024-09-20

· 1057 次阅读

引入依赖

生效

作用域

应用

工具类

配置

属性一览

进阶

Jasypt (Java Simplified Encryption) 是一个 java 库，它允许开发人员以最小的成本将基本的加密功能添加到项目中，而无需深入了解密码学的工作原理。

引入依赖

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

生效

如果是为spring boot项目的配置文件加密，则无需额外配置，启动类上的@SpringBootApplication自动会将其注入程序，使其生效。

作用域

指定配置文件的作用域，其他配置文件不受jasypt影响

@Configuration
@EncryptablePropertySources({
    @EncryptablePropertySource("classpath:sentinel-1.properties"),                          
    @EncryptablePropertySource("classpath:sentinel-2.properties")
    })

应用 工具类


import org.jasypt.encryption.StringEncryptor;
import org.jasypt.encryption.pbe.PooledPBEStringEncryptor;
import org.jasypt.encryption.pbe.config.SimpleStringPBEConfig;
/**
 * @author issavior
 */
public class JasyptUtil {
    /**
     * org.jasypt.encryption.StringEncryptor对象
     */
    private static StringEncryptor stringEncryptor = null;
    public static StringEncryptor getInstance(String secretKey) throws Exception {
        if (secretKey == null || secretKey.trim().equals("")) {
            System.out.println("秘钥不能为空！");
            throw new Exception("org.jasypt.encryption.StringEncryptor秘钥不能为空！");
        }
        if (stringEncryptor == null) {
            PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();
            SimpleStringPBEConfig config = new SimpleStringPBEConfig();
            // 这个秘钥必须是我们自己定义
            config.setPassword(secretKey);
            config.setAlgorithm("PBEWITHHMACSHA512ANDAES_256");
            config.setKeyObtentionIterations("1000");
            config.setPoolSize("1");
            config.setProviderName("SunJCE");
            config.setSaltGeneratorClassName("org.jasypt.salt.RandomSaltGenerator");
            config.setIvGeneratorClassName("org.jasypt.iv.RandomIvGenerator");
            config.setStringOutputType("base64");
            encryptor.setConfig(config);
            stringEncryptor = encryptor;
        }
        return stringEncryptor;
    }
    public static void main(final String[] args) {
        // 秘钥字符串
        String secretKey = "123!@#";
        // 待加密的明文密码
        String pass = "123456";
        try {
            StringEncryptor stringEncryptor = JasyptUtil.getInstance(secretKey);
            String encryptPass = stringEncryptor.encrypt(pass);
            System.out.println("【" + pass + "】被加密成【" + encryptPass + "】");
            String clearPass = stringEncryptor.decrypt(encryptPass);
            System.out.println("【" + encryptPass + "】被解密成【" + clearPass + "】");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

配置

jasypt:
  encryptor:
    password: 123!@#
my:
  # 必须用ENC()包起来，这样jasypt才能识别出来这个密码需要解密再传给应用程序
  msg: ENC(PwyGulNOC9YERAC9A6zpH8Da1tn50dtgJ1XBqygkdNoBTkjmENd+F5yJJMp4sthf)

属性一览