This documentation is for WSO2 Carbon 4.4.0. View documentation for the latest release.
Page Comparison - Encrypting Passwords with Cipher Tool (v.25 vs v.26) - 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.


  1. In any WSO2 product that is based on Carbon 4.4.0 or a later version, you can install the  the Cipher Tool feature from the WSO2 feature repository. See Installing Features for instructions on how features are installed from the WSO2 feature repositorywill be installed by default.


    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 the Cipher Tool feature in your product build.

  2. Open the file and the file from the <PRODUCT_HOME>/repository/conf/security folder. 
  3. In any WSO2 product that is based on Carbon 4.4.0 or a later version, the following files should be updated with the required information: 
    • The file should contain information about the files in which the passwords (that require encryption) are located. Either the relative path or the absolute path of each file starting from <PRODUCT_HOME> should be given. The last value that follows the file path is set to 'true' or 'false' (which is a boolean value), which indicates whether or note the value to be encrypted is an attribute. 

      By default, the file that is shipped with your product pack will contain information on the most common passwords that require encryption. For example, see the default file that is 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"
    • The file should contain the secret alias names and the corresponding plain text passwords (enclosed within square brackets). For example, see the default file that is created for Carbon Kernel:

      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.