Spring Boot how to hide passwords in properties file

Question

Spring Boot uses the properties file  and at least by default  the passwords are in plain text  Is it possible to somehow hide decrypt these

User · Answer

Spring Cloud Config Server will allow this type of behavior. Using JCE you can setup a key on the server and use it to cipher the apps properties.

http://cloud.spring.io/spring-cloud-config/spring-cloud-config.html

User · Answer

In case you are using quite popular in Spring Boot environment Kubernetes  K8S  or OpenShift  there s a possibility to store and retrieve application properties on runtime  This technique called secrets  In your configuration yaml file for Kubernetes or OpenShift you declare variable and placeholder for it  and on K8S OpenShift side declare actual value which corresponds to this placeholder  For implementation details  see  K8S  https   kubernetes io docs concepts configuration secret  OpenShift  https   docs openshift com container-platform 3 11 dev guide secrets html

User · Answer

You can use Jasypt to encrypt properties  so you could have your property like this   db password ENC XcBjfjDDjxeyFBoaEPhG14wEzc6Ja Xx hNPrJyQT88     Jasypt allows you to encrypt your properties using different algorithms  once you get the encrypted property you put inside the ENC       For instance  you can encrypt this way through Jasypt using the terminal   encrypted-pwd  java -cp    m2 repository org jasypt jasypt 1 9 2 jasypt-1 9 2 jar  org jasypt intf cli JasyptPBEStringEncryptionCLI input  contactspassword  password supersecretz algorithm PBEWithMD5AndDES  ----ENVIRONMENT-----------------  Runtime  Oracle Corporation Java HotSpot TM  64-Bit Server VM 24 45-b08    ----ARGUMENTS-------------------  algorithm  PBEWithMD5AndDES input  contactspassword password  supersecretz    ----OUTPUT----------------------  XcBjfjDDjxeyFBoaEPhG14wEzc6Ja Xx hNPrJyQT88    To easily configure it with Spring Boot you can use its starter jasypt-spring-boot-starter with group ID com github ulisesbocchio  Keep in mind  that you will need to start your application using the same password you used to encrypt the properties  So  you can start your app this way   mvn -Djasypt encryptor password supersecretz spring-boot run   Or using the environment variable  thanks to spring boot relaxed binding    export JASYPT ENCRYPTOR PASSWORD supersecretz mvn spring-boot run   You can check below link for more details   https   www ricston com blog encrypting-properties-in-spring-boot-with-jasypt-spring-boot   To use your encrypted properties in your app just use it as usual  use either method you like  Spring Boot wires the magic  anyway the property must be of course in the classpath    Using  Value annotation   Value    db password    private String password    Or using Environment   Autowired private Environment environment   public void doSomething Environment env        System out println env getProperty  db password         Update  for production environment  to avoid exposing the password in the command line  since you can query the processes with ps  previous commands with history  etc etc  You could    Create a script like this  touch setEnv sh Edit setEnv sh to export the JASYPT ENCRYPTOR PASSWORD variable        bin bash      export JASYPT ENCRYPTOR PASSWORD supersecretz  Execute the file with   setEnv sh Run the app in background with mvn spring-boot run  amp  Delete the file setEnv sh Unset the previous environment variable with  unset JASYPT ENCRYPTOR PASSWORD

User · Answer

UPDATE  I noticed folks down-voting this  so I have to say that although this is not an ideal solution  but this works and acceptable in some use-cases  Cloudfoundry uses Environment variables to inject credentials when a Service is binded to an application  More info https   docs cloudfoundry org devguide services application-binding html  And also if your system is not shared  then for local development this is also acceptable  Of course  the more safe and secure way is explained in Answer by  J-Alex   Answer   If you want to hide your passwords then the easiest solution is to use Environment variables in application properties file or directly in your code   In application properties   mypassword   password    Then in your configuration class    Autowired private Environment environment          Inside a method System out println environment getProperty  mypassword       In your configuration class    Value    password    private String herokuPath          Inside a method System out println herokuPath     Note  You might have to restart after setting the environment variable   For windows     Refer this Documentation for more info

User · Answer

To the already proposed solutions I can add an option to configure an external Secrets Manager such as Vault    Configure Vault Server vault server -dev  Only for DEV and not for PROD  Write secrets vault write secret somename key1 value1 key2 value2 Verify secrets vault read secret somename   Add the following dependency to your SpringBoot project    lt dependency gt       lt groupId gt org springframework cloud lt  groupId gt       lt artifactId gt spring-cloud-starter-vault-config lt  artifactId gt   lt  dependency gt    Add Vault config properties   spring cloud vault host localhost spring cloud vault port 8200 spring cloud vault scheme http spring cloud vault authentication token spring cloud vault token   VAULT TOKEN    Pass VAULT TOKEN as an environment variable    Refer to the documentation here   There is a Spring Vault project which is also can be used for accessing  storing and revoking secrets   Dependency    lt dependency gt       lt groupId gt org springframework vault lt  groupId gt       lt artifactId gt spring-vault-core lt  artifactId gt   lt  dependency gt    Configuring Vault Template    Configuration class VaultConfiguration extends AbstractVaultConfiguration       Override   public VaultEndpoint vaultEndpoint         return new VaultEndpoint            Override   public ClientAuthentication clientAuthentication         return new TokenAuthentication                 Inject and use VaultTemplate   public class Example       Autowired   private VaultOperations operations     public void writeSecrets String userId  String password          Map lt String  String gt  data   new HashMap lt String  String gt           data put  password   password         operations write userId  data          public Person readSecrets String userId          VaultResponseSupport lt Person gt  response   operations read userId  Person class         return response getBody            Use Vault PropertySource    VaultPropertySource value    aws creds s3     propertyNamePrefix    aws     renewal   Renewal RENEW  public class Config        Usage example   public class S3Client         inject the actual values    Value    aws access key      private String awsAccessKey     Value    aws secret key      private String awsSecretKey     public InputStream getFileFromS3 String filenname

User · Answer

In additional to the popular K8s  jasypt or vault solutions  there s also Karmahostage  It enables you to do   EncryptedValue  quot   application secret  quot   private String application   It works the same way jasypt does  but encryption happens on a dedicated saas solution  with a more fine-grained ACL model attached to it

User · Answer

My solution to hiding a DB-Password in Spring Boot App s application properties does implemented here  Scenario  some fake password already reading and saved from application properties on start  in global Spring object ConfigurableEnvironment will be  in Run-Time replaced programmaticaly  by real DB-Password  The real password will be reading from another config file  saved in safe  project-outer place  Don t forget  call the the Bean from main class with   Autowired private SchedUtilility utl

[java] Spring Boot how to hide passwords in properties file

Examples related to java

Examples related to spring

Examples related to spring-boot