Wiosenne wartości rozruchu procesu rozruchu wartości

Question

Mam za zadanie zaciemnianie haseł w naszych plikach konfiguracyjnych. Chociaż nie sądzę, że jest to właściwe podejście, menedżerowie nie zgadzają się ...

Projekt, nad którym pracuję, jest oparty na Spring Boot i używamy plików konfiguracyjnych YAML. Obecnie są hasła w postaci zwykłego tekstu:

spring: 
    datasource: 
     url: jdbc:sqlserver://DatabaseServer 
     driverClassName: com.microsoft.sqlserver.jdbc.SQLServerDriver 
     username: ele 
     password: NotTheRealPassword 

Chodzi o to, aby mieć jakąś specjalną składnię, która wspiera się zaciemniony lub zaszyfrowane hasło:

spring: 
    datasource: 
     url: jdbc:sqlserver://DatabaseServer 
     driverClassName: com.microsoft.sqlserver.jdbc.SQLServerDriver 
     username: ele 
     password: password(Tm90VGhlUmVhbFBhc3N3b3Jk) 

Aby to zadziałało chcę analizować właściwość wartości za pomocą wyrażenia regularnego i jeśli jest zgodne, zamień wartość na wartość odszyfrowaną/odszyfrowaną.

Ale jak mogę przechwycić wartość właściwości?

Answer 1

Jeśli w końcu to zadziałało. (Głównie dzięki stephane-deraco pod numerem telefonu)

Kluczem do rozwiązania jest klasa implementująca ApplicationContextInitializer<ConfigurableApplicationContext>. Nazwałem to PropertyPasswordDecodingContextInitializer.

Głównym problemem było uzyskanie wiosny, aby korzystać z tego ApplicationContextInitializer. Ważne informacje można znaleźć w reference. Wybrałem metodę używając META-INF/spring.factories o następującej treści:

org.springframework.context.ApplicationContextInitializer=ch.mycompany.myproject.PropertyPasswordDecodingContextInitializer 

PropertyPasswordDecodingContextInitializer używa PropertyPasswordDecoder oraz klasę wykonawczą, obecnie dla uproszczenia Base64PropertyPasswordDecoder.

PropertyPasswordDecodingContextInitializer.java

package ch.mycompany.myproject; 

import java.util.LinkedHashMap; 
import java.util.Map; 
import java.util.regex.Matcher; 
import java.util.regex.Pattern; 

import org.springframework.context.ApplicationContextInitializer; 
import org.springframework.context.ConfigurableApplicationContext; 
import org.springframework.core.env.CompositePropertySource; 
import org.springframework.core.env.ConfigurableEnvironment; 
import org.springframework.core.env.EnumerablePropertySource; 
import org.springframework.core.env.MapPropertySource; 
import org.springframework.core.env.PropertySource; 
import org.springframework.stereotype.Component; 

@Component 
public class PropertyPasswordDecodingContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> { 

    private static final Pattern decodePasswordPattern = Pattern.compile("password\\((.*?)\\)"); 

    private PropertyPasswordDecoder passwordDecoder = new Base64PropertyPasswordDecoder(); 

    @Override 
    public void initialize(ConfigurableApplicationContext applicationContext) { 
     ConfigurableEnvironment environment = applicationContext.getEnvironment(); 
     for (PropertySource<?> propertySource : environment.getPropertySources()) { 
      Map<String, Object> propertyOverrides = new LinkedHashMap<>(); 
      decodePasswords(propertySource, propertyOverrides); 
      if (!propertyOverrides.isEmpty()) { 
       PropertySource<?> decodedProperties = new MapPropertySource("decoded "+ propertySource.getName(), propertyOverrides); 
       environment.getPropertySources().addBefore(propertySource.getName(), decodedProperties); 
      } 
     } 
    } 

    private void decodePasswords(PropertySource<?> source, Map<String, Object> propertyOverrides) { 
     if (source instanceof EnumerablePropertySource) { 
      EnumerablePropertySource<?> enumerablePropertySource = (EnumerablePropertySource<?>) source; 
      for (String key : enumerablePropertySource.getPropertyNames()) { 
       Object rawValue = source.getProperty(key); 
       if (rawValue instanceof String) { 
        String decodedValue = decodePasswordsInString((String) rawValue); 
        propertyOverrides.put(key, decodedValue); 
       } 
      } 
     } 
    } 

    private String decodePasswordsInString(String input) { 
     if (input == null) return null; 
     StringBuffer output = new StringBuffer(); 
     Matcher matcher = decodePasswordPattern.matcher(input); 
     while (matcher.find()) { 
      String replacement = passwordDecoder.decodePassword(matcher.group(1)); 
      matcher.appendReplacement(output, replacement); 
     } 
     matcher.appendTail(output); 
     return output.toString(); 
    } 

} 

PropertyPasswordDecoder.java

package ch.mycompany.myproject; 

public interface PropertyPasswordDecoder { 

    public String decodePassword(String encodedPassword); 

} 

Base64PropertyPasswordDecoder.java

package ch.mycompany.myproject; 

import java.io.UnsupportedEncodingException; 

import org.apache.commons.codec.binary.Base64; 

public class Base64PropertyPasswordDecoder implements PropertyPasswordDecoder { 

    @Override 
    public String decodePassword(String encodedPassword) { 
     try { 
      byte[] decodedData = Base64.decodeBase64(encodedPassword); 
      String decodedString = new String(decodedData, "UTF-8"); 
      return decodedString; 
     } catch (UnsupportedEncodingException e) { 
      throw new RuntimeException(e); 
     } 
    } 


} 

Pamiętaj, że ApplicationContext nie został na tym etapie zainicjalizowany, więc automowowanie lub inne mechanizmy związane z komponentami bean nie będą działać.

---

Aktualizacja: wliczony @jny „s sugestie.

Answer 2

Użyłem odpowiedzi @Daniele Torino i wprowadziłem kilka drobnych zmian.

Po pierwsze, dzięki jego link do opcji na jak zrobić sprężynę rozpoznać initializer, wybrałem to zrobić w Application:

public static void main(String[] args) throws Exception { 
    SpringApplication application=new SpringApplication(Application.class); 
    application.addInitializers(new PropertyPasswordDecodingContextInitializer()); 
    application.run(args); 
} 

drugie, IDEA powiedział mi, że else if (source instanceof CompositePropertySource) { jest zbędny i jest ponieważ CompositePropertySource dziedziczy po EnumerablePropertySource.

Po trzecie, uważam, że istnieje drobny błąd: zakłóca to kolejność rozwiązywania własności. Jeśli masz jedną zakodowaną właściwość w środowisku, a inną w pliku application.properties, wartość środowiska zostanie zastąpiona wartością application.properties. Zmieniłem logikę do wstawienia na decodedProperties tuż przed zakodowane:

 for (PropertySource<?> propertySource : environment.getPropertySources()) { 
       Map<String, Object> propertyOverrides = new LinkedHashMap<>(); 
       decodePasswords(propertySource, propertyOverrides); 
       if (!propertyOverrides.isEmpty()) { 
         environment.getPropertySources().addBefore(propertySource.getName(), new MapPropertySource("decoded"+propertySource.getName(), propertyOverrides)); 
       } 
     } 

Answer 3

Wystarczy użyć https://github.com/ulisesbocchio/jasypt-spring-boot, działa po wyjęciu z pudełka

Answer 4

Zainspirowany @gogstad. Tu jest mój główny działania w projekcie bagażnika sprężyna szyfrowane moją nazwę użytkownika i hasło i rozszyfrował je w projekcie pracować z tomcat:

1. W pliku pom.xml

<dependency> 
     <groupId>com.github.ulisesbocchio</groupId> 
     <artifactId>jasypt-spring-boot</artifactId> 
     <version>1.12</version> 
    </dependency> 
    … 
    <build> 
     <resources> 
      <resource> 
       <directory>src/main/java</directory> 
       <includes> 
       <include>**/*.properties</include> 
       <include>**/*.xml</include> 
       </includes> 
       <targetPath>${project.build.directory}/classes</targetPath> 
      </resource> 
      <resource> 
       <directory>src/main/resources</directory> 
       <includes> 
        <include>**/*.properties</include> 
       </includes> 
       <targetPath>${project.build.directory}/classes</targetPath> 
     </resource> 
    </resources> 
    … 
    </build> 

2. W App.java (Uwaga: aby wdrożyć decryted springboot na Tomcat, należy dodać @ServletComponentScan adnotacji i rozszerza SpringBootServletInitializer)

@SpringBootApplication 
    @ServletComponentScan 
    @EnableEncryptableProperties 
    @PropertySource(name="EncryptedProperties", value = "classpath:config/encrypted.properties") 
    public class App extends SpringBootServletInitializer { 
    public static void main(String[] args) throws Exception { 
     SpringApplication.run(App.class, args); 
     } 

    } 

3. Szyfrowane swój login i hasło, a następnie wypełnić plik application.properties z wynikiem:

java -cp ~/.m2/repository/org/jasypt/jasypt/1.9.2/jasypt-1.9.2.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input="mypassword" password=mykey algorithm=PBEWithMD5AndDES 

wyjście jest jak poniżej Demo:

java -cp ~/.m2/repository/org/jasypt/jasypt/1.9.2/jasypt-1.9.2.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input="mypassword" password=mykey algorithm=PBEWithMD5AndDES 

    ----ENVIRONMENT----------------- 

    Runtime: Oracle Corporation Java HotSpot(TM) 64-Bit Server VM 25.45-b02 



    ----ARGUMENTS------------------- 

    algorithm: PBEWithMD5AndDES 
    input: mypassword 
    password: mykey 



    ----OUTPUT---------------------- 

    5XNwZF4qoCKTO8M8KUjRprQbivTkmI8H 

4. Zgodnie z katalog src/main/resources/config dodaj dwa pliki właściwości:

a. application.properties 
     spring.datasource.driver-class-name=com.mysql.jdbc.Driver 
     spring.datasource.url=jdbc:mysql://xxx 
     spring.datasource.username=ENC(xxx) 
     spring.datasource.password=ENC(xxx) 
     mybatis.mapper-locations=classpath:*/mapper/*.xml 
     mybatis.type-aliases-package=com.xx.xxx.model 
     logging.level.com.xx.xxx: DEBUG 

    b. encrypted.properties 
     jasypt.encryptor.password=mykey