This documentation is for WSO2 Carbon 4.4.6. View documentation for the latest release.
Page Comparison - Enabling Cipher Tool for Password Encryption (v.1 vs v.2) - Carbon 4.4.6 - WSO2 Documentation

Versions Compared


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

Cipher Tool is developed by WSO2 for encrypting sensitive data in files stored in a file system. Thereby, Cipher Tool can be used in WSO2 products as well as in non-WSO2 environments. However, in order to use the Cipher Tool in a WSO2 product or any other environment, product developers must ensure that Cipher Tool is enabled in the respective product build. The instructions on this page explain how developers can install the Cipher Tool feature when building a product.

 Cipher Tool consists of the following files:

  • org.wso2.ciphertool-1.0.0-wso2v3.jar: This is the JAR of the Cipher Tool.

  • ciphertool.bat: The script for running the tool on Windows.

  • The script for running the tool on Linux.

  • This file contains the secret alias, file and the xpath of the sensitive data that should be encrypted. In the case of WSO2 products, the default file that is shipped with a pack should contain the sensitive data in the file system of that particular product.

  • This file contains the secret aliases with the encrypted values. In the case of WSO2 products, the default file that is shipped with a pack should contain the data relevant to the respective product.

  • This file contains the configurations for non-WSO2 environmentsWSO2 environments. 

You can find the source code of Cipher Tool Tool here.

 See the following topics:

Table of Contents

Enabling Cipher Tool for WSO2 products

WSO2 products use the Cipher Tool for encrypting passwords in configuration files. The tool uses the the Secure Vault implementation that is built into Carbon. Cipher Tool is available as a separate feature that can be installed in each product. Given below are the instructions for installing the Cipher Tool feature in a WSO2 product using the pom.xml. 

  1. In the the pom.xml of  of the p2-profile-gen, the Cipher Tool features needs to be added under under <featureArtifacts> as  as given below.

    Code Block
  2. Under the "default" profile, the Cipher Tool feature ID needs to be added as given below:

    Code Block
  3. In the the bin.xml (in distribution), the location in the product pack to which the Cipher Tool Jar and its configuration files should be copied is mentioned as given below. Note that ${cipher.tool.version} refers to the Cipher Tool version:

    Code Block
        <!-- Cipher Tool Files -->
  4. Now you must create the the and  and files  files for your product and store them in the the <PRODUCT_HOME>/repsoistory/conf/security directory. Note that these two files are always product specific. This is because the type and number of passwords in configuration files that require encryption may be different in each product. Therefore, each product team should create these files with the information that is relevant to the product. For example, shown below are the the and  and files  files that are 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.

    Sample Sample

    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"

If you have developed your WSO2 product with the configurations given above, the Cipher Tool feature will be installed. Alternatively, you can also install this feature using the management console of a Carbon product. See the following topics for more information:

Enabling Cipher Tool for non-WSO2 environments

The cipher tool can only encrypt the password. Therefore in a non-WSO2 environment, the decrypting code needs to be written. Follow the steps given below to configure and run Cipher Tool.

  1. Download the latest released org.wso2.ciphertool-{version}.jar from the nexus repository.

  2. Copy the following configuration files from from Github to  to a folder called “conf” where your Cipher Tool Jar is placed:




  3. Now, you must update the the and the  and the files  files with information on the configuration files and the passwords that you want to encrypt.

    • Update the file with the location of the file (this can be the absolute path or the relative path from the .jar file) and the XPath of the value to be encrypted.

    • The file should contains the secret aliases with the encrypted values.

  4. Update the file. This file is used in a non-WSO2 environment to get the location of the Keystore, the Keystore type, Key alias, location of the the and  and In this case, Cipher Tool also returns the file name (along with the path) where it should create the the file file.

  5. To run the tool, execute the following command:

    Code Block
    java -jar org.wso2.ciphertool-1.0.0-wso2v3.jar