Springboot如何實現對配置文件中的明文密碼加密

這篇文章主要介紹了Springboot如何實現對配置文件中的明文密碼加密的相關知識，內容詳細易懂，操作簡單快捷，具有一定借鑒價值，相信大家閱讀完這篇Springboot如何實現對配置文件中的明文密碼加密文章都會有所收獲，下面我們一起來看看吧。

示例展示

我們來看一下這個配置：

spring:
  # 數據庫鏈接配置
  datasource:
    url: jdbc:mysql://xx.xx.xx.xx:3306/database
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: "123456"

我們上述的配置spring.datasource.password對應的值為123456，這么敏感的信息直接放在配置文件中很不合適，我們要做的就是對應的值改成一個加密的密文，如下：

spring:
  # 數據庫鏈接配置
  datasource:
    url: jdbc:mysql://xx.xx.xx.xx:3306/database
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: "AES(DzANBAhBWXxZqAOsagIBCoaw8FV4gYRbid7G70UEM24=)"

這樣的話，即使該配置文件被有心之人拿去，也不知道真正的數據庫密碼是啥，也就無法構成對項目的侵害風險；

原理解析

我們為了實現這個功能，需要了解Spring的相關擴展點以及對應的數據加解密知識，我們先來看看我們應該通過Spring的哪個擴展點進行切入；

我們想要攔截配置數據的話，可以通過實現自定義的BeanFactoryPostProcessor來處理：

public class PropertySourcePostProcessor implements BeanFactoryPostProcessor {

  private ConfigurableEnvironment environment;

  public PropertySourcePostProcessor(ConfigurableEnvironment environment) {
    this.environment = environment;
  }

  @Override
  public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    // 從ConfigurableEnvironment中取出所有的配置數據
    MutablePropertySources propertySources = this.environment.getPropertySources();
    propertySources.stream()
        // 過濾不需要包裝的對象
        .filter(s -> !noWrapPropertySource(s))
        // 包裝所有的PropertySource
        .map(s -> new EncryPropertySource(s))
        .collect(Collectors.toList())
        // 替換掉propertySources中的PropertySource
        .forEach(wrap -> propertySources.replace(wrap.getName(), wrap));
  }

  private boolean noWrapPropertySource(PropertySource propertySource) {
    return propertySource instanceof EncryPropertySource || StringUtils.equalsAny(propertySource.getClass().getName(), "org.springframework.core.env.PropertySource$StubPropertySource", "org.springframework.boot.context.properties.source.ConfigurationPropertySourcesPropertySource");
  }
}

基本原理解析如下：

1.通過ConfigurableEnvironment取出所有的PropertySource并依次遍歷；

2.過濾掉不符合我們要求的PropertySource，因為PropertySource有很多子類，并不是所有的PropertySource實例都符合我們包裝的要求；

3.對符合要求的PropertySource做一層包裝，其實就是靜態代理；

4.用包裝好的PropertySource替換掉之前的PropertySource實例；

通過上述一系列的操作，我們就可以在PropertySource取值的時候做一些自定義的操作了，比如針對密文密碼進行解密；

剩下的另一個問題就是加解密的問題，密碼學里面有對稱加密和非對稱加密，這兩種加密方式的區別就是對稱加密的加密解密都需要同一個密鑰，而非對稱加密加密的時候需要公鑰，解密的時候需要私鑰；

了解了對稱加密與非對稱加密的區別，如果我們使用的是對稱加密，那么一定要避免密文和密鑰放在同一個地方；非對稱加密一定要避免密文和私鑰放在同一個地方；

工具介紹

接下來我們要介紹一款專門針對這個需求的jar工具，它就是jasypt，我們可以去maven倉庫找到相關的包：

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

它的實現原理其實就是我們上面所講述的，通過自定義BeanFactoryPostProcessor對ConfigurableEnvironment中的PropertySource實例進行攔截包裝，在包裝類的實現上做一層解密操作，這樣就實現了對密文密碼的解密；

導入上述依賴后，該工具就已經自動生效了，我們就可以修改對應的配置了，首先我們先針對該工具做一些配置：

jasypt:
  encryptor:
    # 密鑰
    password: ""
    property:
      # 密文前綴
      prefix: ""
      # 密文后綴
      suffix: ""

在上述配置中，jasypt.encryptor.password是一定要配置的，這就是加解密的密鑰，默認的加密算法是PBEWITHHMACSHA512ANDAES_256；另外jasypt.encryptor.property.prefix和jasypt.encryptor.property.suffix分別是密文前綴和密文后綴，是用來標注需要解密的密文的，如果不配置，默認的密文前綴是ENC(，密文后綴是)；默認情況下，我們的密文如下所示：

spring:
  datasource:
    password: "ENC(DzANBAhBWXxZqAOsagIBCoaw8FV4gYRbid7G70UEM24=)"

還有一個需要注意的點就是jasypt.encryptor.password不能與密文放在一起，我們可以在項目當中通過系統屬性、命令行參數或環境變量傳遞；

實現自定義加解密

如果jasypt提供的加解密方式不能滿足咱們的項目需求，我們還可以自己實現加解密：

@Bean("jasyptStringEncryptor")
  public StringEncryptor jasyptStringEncryptor(){
    return new StringEncryptor() {
      @Override
      public String encrypt(String s) {
        // TODO 加密
        return null;
      }

      @Override
      public String decrypt(String s) {
        // TODO 解密
        return null;
      }
    };
  }

注意我們的BeanName，默認情況下一定要設置成jasyptStringEncryptor，否則不會生效，如果想要改變這個BeanName，也可以通過修改這個配置參數來自定義StringEncryptor實例所對應的BeanName：

jasypt:
  encryptor:
    # 自定義StringEncryptor的BeanName
    bean: ""

如何生成密文

生成密文的這個操作還是要自個兒通過調用StringEncryptor實例來加密生成，可以參考以下代碼：

@Component
public class StringEncryptorUtil{
  @Autowired
  private StringEncryptor encryptor;
  
  public void encrypt(){
    String result = encryptor.encrypt("123456");
    System.out.println(result);
  }
}

畢竟需要加密的操作只需要在項目生命周期中執行一次，所以我們只需要簡單地寫一個工具類調用一下即可。

關于“Springboot如何實現對配置文件中的明文密碼加密”這篇文章的內容就介紹到這里，感謝各位的閱讀！相信大家對“Springboot如何實現對配置文件中的明文密碼加密”知識都有一定的了解，大家如果還想學習更多知識，歡迎關注億速云行業資訊頻道。