Chapter 4. How to use encrypted property placeholders in Spring Boot

Procedure

1. Add jasypt dependency to your project’s pom.xml file.

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

   Copy to Clipboard Toggle word wrap

2. Add Maven repository to your project’s pom.xml.

   <repository>
   <id>jasypt-basic</id>
   <name>Jasypt Repository</name>
   <url>https://repo1.maven.org/maven2/</url>
   </repository>

   Copy to Clipboard Toggle word wrap

3. Add the Jasypt Maven plugin to your project as well as it allows you to use the Maven commands for encryption and decryption.

   <plugin>
      <groupId>com.github.ulisesbocchio</groupId>
      <artifactId>jasypt-maven-plugin</artifactId>
      <version>3.0.3</version>
    </plugin>

   Copy to Clipboard Toggle word wrap

4. Add the plugin repository to pom.xml.

   <pluginRepository>
      <id>jasypt-basic</id>
      <name>Jasypt Repository</name>
      <url>https://repo1.maven.org/maven2/</url>
   </pluginRepository>

   Copy to Clipboard Toggle word wrap

5. To encrypt the username and password listed in the application.properties file, wrap these values inside DEC() as shown below.

   spring.datasource.username=DEC(root)
   spring.datasource.password=DEC(Password@1)

   Copy to Clipboard Toggle word wrap

6. Run the following command to encrypt the username and password.

   mvn jasypt:encrypt -Djasypt.encryptor.password=mypassword

   Copy to Clipboard Toggle word wrap

   This replaces the DEC() placeholders in the application.properties file with the encrypted value, for example,

   spring.datasource.username=ENC(3UtB1NhSZdVXN9xQBwkT0Gn+UxR832XP+tOOfFTlNL57FiMM7BWPRTeychVtLLhB)
   spring.datasource.password=ENC(4ErqElyCHjjFnqPOCZNAaTdRC7u7yJSy16UsHtVkwPIr+3zLyabNmQwwpFo7F7LU)

   Copy to Clipboard Toggle word wrap

7. To decrypt the credentials in the Spring application configuration file, run following command.

   mvn jasypt:decrypt -Djasypt.encryptor.password=mypassword

   Copy to Clipboard Toggle word wrap

   This prints out the content of the application.properties file as it was before the encryption. However, this does not update the configuration file.