This documentation is for WSO2 Carbon 4.4.0. View documentation for the latest release.
Page Comparison - Encrypting Passwords with Cipher Tool (v.19 vs v.20) - Carbon 4.4.0 - WSO2 Documentation
Due to a known issue do not use JDK1.8.0_151 with WSO2 products. Use JDK 1.8.0_144 until JDK 1.8.0_162-ea is released.

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.



For the Cipher Tool to be installable in a WSO2 product, the product should be build with the relevant Cipher Tool configurations. If you are a developer who is building a Carbon product, see the topic on enabling Cipher Tool for password encryption for instructions on how to include Cipher Tool related configurations in your product build.

  1. In any WSO2 product that is based on Carbon 4.4.0, you can install the Cipher Tool feature from the WSO2 feature repository. See the related topics for instructions on installing features.
  2. Open the file and the file from the <PRODUCT_HOME>/repository/conf/security folder. 
  3. By default, these two files are already configured with In any WSO2 product that is based on Carbon 4.4.0, and files should already include the most common passwords that should be encrypted for your productrequire encryption. If required, you can edit the information that you want to encrypt. Given below are in these files. For example, see the default files that are created for Carbon Kernel.

    Code Block
    # Important: This properties file contains all the aliases to be used in carbon components. If any property need to be secured, you need to add alias name, file name and the xpath as follows:.
    # The value goes as, the <file_name>//<xpath>,<true/false>
    # where <file_name> - is the file (along with the file path) to be secured,
    #       <xpath> - is the xpath to the property value to be secured
    #       <true / false> - This is true if the last parameter in the xpath is parameter (starts with [ and ends with ]) and you want its value to be replaced with "password"
    Code Block
    # By default, This file contains the secret alias names and the plain text passwords enclosed with '[]' brackets
    # In Production environments, It is recommend to replace these plain text password by the encrypted values. CipherTool can be used for it.

    If there are other passwords from configuration files that you want to encrypt, you can add the details to these files. For example, in WSO2 Storage Server, you will want to configure the "root" password in the rss-config.xml file. 

    • Add the following to the file:

      Code Block
      #rss-config.xml passwords
    • Add the following to the file:

      Code Block
      #rss-config.xml passwords