This documentation is for WSO2 Carbon 4.4.0. View documentation for the latest release.
Page Comparison - Encrypting Passwords with Cipher Tool (v.64 vs v.65) - 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. The first step is to update the file and the file with information of the passwords that you want to encrypt. 


    By default, the and files that are shipped with your product will contain information on the most common passwords that require encryption. If a required password is missing in the default files, you can add them manually

    Follow the steps given below.

    1. Open the file stored in the <PRODUCT_HOME>/repository/conf/security folder. This file should contain information about the configuration files in which the passwords (that require encryption) are located. The following format is used:

      Code Block


      • The <alias> should be the same value that is hardcoded in the relevant Carbon component.
      • The <file_path> specifies the path to the XML file that contains the password. This can be the relative file path, or the absolute file path (starting from <PRODUCT_HOME>).

      • The <xpath> specifies the XPath to the XML element/attribute/tag that should be encrypted. See the examples given below.
      • The flag that follows the XPath should be set to 'false' if you are encrypting the value of an XML element, or the value of an XML attribute's tag. The flag should be 'true' if you are encrypting the tag of an XML attribute. See the examples given below.

      Example 1: Consider the admin user's password in the user-mgt.xml file shown below. 

      Code Block

      To encrypt this password, the file should contain the details shown below. Note that this password is a value given to an XML element (which is 'Password'). Therefore, the XPath ends with the element name, and the flag that follows the XPath is set to 'false'.

      Code Block

      Example 2: Consider the password that is used to connect to an LDAP user store (configured in the user-mgt.xml file) shown below.

      Code Block
      <Property name="ConnectionPassword">admin</Property>

      To encrypt this password, the file should be updated as shown below. Note that there are two possible alias values you can use for this attribute. In this example, the 'Property' element of the XML file uses the 'name' attribute with the "ConnectionPassword" tag. The password we are encrypting is the value of this "ConnectionPassword" tag. This is denoted in the XPath as 'Property[@name='ConnectionPassword']', and the flag that follows the XPath is set to 'false'.

      • Using the UserStoreManager.Property.ConnectionPassword alias:

        Code Block
      • Using the UserManager.Configuration.Property.ConnectionPassword alias:

        Code Block

      If you are trying the above example, be sure that only the relevant user store manager is enabled in the user-mgt.xml file.

      Example 3: Consider the keystore password specified in the catalina-server.xml file shown below. 

      Code Block
      <Connector protocol="org.apache.coyote.http11.Http11NioProtocol"  
      ... >

      To encrypt this password, the file should contain the details shown below. In this example, 'Connector' is the XML element, and 'keystorePass' is an attribute of that element. The password value that we are encrypting is the tag of the XML attribute. This is denoted in the XPath as 'Connector[@keystorePass]', and the flag that follows the XPath is set to ‘true’.

      Code Block
    2. Open the file stored in the <PRODUCT_HOME>/repository/conf/security folder. This file should contain the secret alias names and the corresponding plaintext passwords (enclosed within square brackets) as shown below.

      Code Block

      Shown below are the records in the file for the three examples discussed above.

      Code Block
      //Example 1: Encrypting the admin user's password in the user-mgt.xml file.
      //Example 2: Encrypting the LDAP connection password in the user-mgt.xml file. Use one of the following:
      # UserManager.Configuration.Property.ConnectionPassword=[admin]
      //Example 3: Encrypting the keystore password in the catalina-server.xml file.

    If your password contains a backslash character (\) you need to use an alias with the escape characters. For example, if your password is admin\} the value should be given as shown in the example below.

    Code Block
  2. Open a command prompt and go to the <PRODUCT_HOME>/bin directory, where the cipher tool scripts (for Windows and Linux) are stored. 

  3. Execute the cipher tool script from the command prompt using the command relevant to your OS: 

    • On Windows: ./ciphertool.bat -Dconfigure

    • On Linux: ./ -Dconfigure

  4. The following message will be prompted:  "[Please Enter Primary KeyStore Password of Carbon Server :]". Enter the keystore password (which is "wso2carbon" for the default keystoredefault keystore) and proceed. If the script execution is successful, you will see the following message: "Secret Configurations are written to the property file successfully".


    If you are using the cipher tool for the first time, the-Dconfigure command will first initialize the tool for your product. The tool will then start encrypting the plain text plaintext passwords you specified in the file.

    Shown below is an example of an alias and the corresponding plaintext password (in square brackets) in the file:

    Code Block

    If a password is not specified in the file for an alias, the user needs to provide it through the command line. Check whether the alias is a known password alias in Carbon configurations. If the tool modifies the configuration element and file, you must replace the configuration element with the alias name. Define a Secret Callback in the configuration file and add proper namespaces for defining the Secure Vault.

  5. Now, to verify the password encryption: 

    • Open the file and see that the plain text passwords are replaced by a cipher value.

    • Open the file from the <PRODUCT_HOME>/repository/conf/security/ folder and see that the default configurations are changed.