Page Comparison

The instructions on this page explain how plain text passwords in configuration files can be encrypted using the secure vault implementation that is built into WSO2 products. Note that you can customize the default secure vault configurations in the product by implementing a new secret repository, call back handler etc. Read more about the Secure Vault implementation in WSO2 products.

In any WSO2 product that is based on Carbon 4.4.0 or a later version, the Cipher Tool feature will be installed by default. You can use this tool to easily encrypt passwords or other elements in configuration files.

...

Before you begin

If you are using Windows, you need to have Ant (http://ant.apache.org/) installed before using the Cipher Tool.

Encrypting passwords using the automated process

This automated process can only be used for passwords that can be given as an xpathXPath. If you cannot give an xpath XPath for the password that you want to encrypt, you must use the manual encryption process explained in the next section.

Follow the steps given below to have passwords encrypted using the automated process:

1. The first step is to update the update the cipher-tool.properties file and the  file and the cipher-text.properties file with  file with information of the passwords that you want to encrypt. 

   Open

   Info
   By default, the cipher-tool

   .properties file stored in the 

   .properties and cipher-text.properties 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 cipher-tool.properties file stored in the <PRODUCT_HOME>/repository/conf/security folder. The This file should contain information about the configuration files in which the passwords (that require encryption) are located as shown below. The following format is used:

      Code Block
      <alias>=<file_name>//<xpath>,<true/false>

      For example, if you want to encrypt the admin user password in the user-mgt.xml file, the following should be added to the cipher-tool.properties file:
      

      Info

      Important! 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
      <UserManager> <Realm> <Configuration> <AddAdmin>true</AddAdmin> <AdminRole>admin</AdminRole> <AdminUser> <UserName>admin</UserName> <Password>admin</Password> </AdminUser> ........ </Configuation> ........ </Realm> </UserManager>

      To encrypt this password, the cipher-tool.properties 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
      UserManager.AdminUser.Password=repository/conf/user-mgt.xml//UserManager/Realm/Configuration/AdminUser/Password,false

      Info
      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' indicating 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. 

      Open the cipher-text.properties file stored in the 

      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 cipher-tool.properties 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
        UserStoreManager.Property.ConnectionPassword=repository/conf/user-mgt.xml//UserManager/Realm/UserStoreManager/Property[@name='ConnectionPassword'],false

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

        Code Block
        UserManager.Configuration.Property.ConnectionPassword=repository/conf/user-mgt.xml//UserManager/Realm/UserStoreManager/Property[@name='ConnectionPassword'],false

      Note
      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" ... keystorePass="wso2carbon" ... >

      To encrypt this password, the cipher-tool.properties 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
      Server.Service.Connector.keystorePass=repository/conf/tomcat/catalina-server.xml//Server/Service/Connector[@keystorePass],true

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

      Code Block
      <alias>=[plain_text_password]

      For example, if you want to encrypt the admin user password in the user-mgt.xml file, the following should be added to the cipher-tool.properties file:

      Code BlockUserManager.AdminUser.Password=[admin

      Shown below are the records in the cipher-text.properties file for the three examples discussed above.

      Code Block

      //Example 1: Encrypting the admin user's password in the user-mgt.xml file. UserManager.AdminUser.Password=[admin] //Example 2: Encrypting the LDAP connection password in the user-mgt.xml file. Use one of the following: UserStoreManager.Property.ConnectionPassword=[admin] # UserManager.Configuration.Property.ConnectionPassword=[admin] //Example 3: Encrypting the keystore password in the catalina-server.xml file. Server.Service.Connector.keystorePass=[wso2carbon]

   Note
   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 UserStoreManager.Property.ConnectionPassword=[admin\\}]

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

3. Run the ciphertool.sh script using the command prompt as shown below. 

   Code Block

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

   • On Windows: ./ciphertool.bat -Dconfigure

   • On Linux: ./ciphertool.sh

   • -Dconfigure

4. The following message will be prompted:  "[Please Enter Primary KeyStore Password of Carbon Server :]". Enter the keystore password (which is "wso2carbon" for  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".

   Note

   If you are using the cipher tool for the first time, the ./ciphertool.sh -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 cipher-text.properties file. Shown below is an example of an alias and the corresponding plain text plaintext password (in square brackets) in the cipher-text.properties file: Code Block UserManager.AdminUser.Password=[admin] If a password is not specified in the cipher-text.properties 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 Open the cipher-text.properties file and  file and see that the plain text passwords are replaced by a cipher value.

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

Encrypting passwords manually

This manual process can be used for encrypting any password in a configuration file. However, if you want to encrypt any elements that cannot use an xpath to specify the location in a configuration file, you must use manual encryption. It is not possible to use the automated encryption process if an xpath is not specified for the element.

...

1. Download and install a WSO2 product.

2. Open a command prompt and

   navigate

   go to the <PRODUCT_HOME>/bin

    folder.

    directory, where the cipher tool scripts (for Windows and Linux) are stored. 

3. You must first enable the Cipher tool for the product by executing the following command:

   Code Blocksh

   the -Dconfigure command with the cipher tool script as shown below. 

   • On Linux: ./ciphertool.sh

   • -Dconfigure

   Now, you can start encrypting the admin password manually. Execute the Cipher tool using the following command:

   Code Blocksh ciphertool.sh

   • On Windows: ./ciphertool.bat -Dconfigure

   Note
   If you are using the cipher tool for the first time, this command will first initialize the tool for your product. The tool will then encrypt any plain text passwords that are specified in the cipher-text.properties file. See the automated encryption process for more information.

4. Now, you can start encrypting the admin password manually. Execute the Cipher tool using the relevant command for your OS:

   • On Linux: ./ciphertool.sh

   • On Windows: ./ciphertool.bat

5. You will be asked to enter the primary key password, which is by default 'wso2carbon'. Enter the password and proceed.

6. You will now be asked to enter the plain text password that you want to encrypt. Enter the following element as the password and proceed:

   Code Block
   Enter Plain Text Value :admin

   Info
   Note that in certain configuration files, the password that requires encryption may not be specified as a single value as it is in the log4j.properties file. For example, the jndi.properties file used in WSO2 ESB contains the password in the connection URL. In such cases, you need to encrypt the entire connection URL as explained here.

7. You will receive the encrypted value. For example:

   Code Block
   Encrypted value is: gaMpTzAccMScaHllsZLXspm1i4HLI0M/srL5pB8jyknRKQ2zT7NuCvt1+qEkElRLgwlrohz3lkuE0KFuapXrCSs5pxfGMOLn4/k7dNs2SlwbsG8C++/ ZfUuft1Sl6cqvDRM55fQwzCPfybl713HvKu3oDaJ9VKgSbvHlQj6zqzg=

8. Open the cipher-text.properties file, stored in the <PRODUCT_HOME>/repository/conf/security folder.

9. Add the encrypted password against the secret alias as shown below.

   Code Block
   log4j.appender.LOGEVENT.password=cpw74SGeBNgAVpryqj5/xshSyW5BDW9d1UW0xMZ DxVeoa6RjyA1JRHutZ4SfzfSgSzy2GQJ/2jQIw70IeT5EQEAR8XLGaqlsE5IlNoe9dhyLiPXEPRGq4k/BgUQD YiBg0nU7wRsR8YXrvf+ak8ulX2yGv0Sf8=

10. Now, open the log4j.properties file, stored in the <PRODUCT_HOME>/repository/conf folder and replace the plain text element with the alias of the encrypted value as shown below.

    Code Block
    # LOGEVENT is set to be a LogEventAppender using a PatternLayout to send logs to LOGEVENT .... log4j.appender.LOGEVENT.password=secretAlias:log4j.appender.LOGEVENT.password ....

# register some connection factories
# connectionfactory.[jndiname] = [ConnectionURL]
connectionfactory.QueueConnectionFactory = amqp://admin:admin@clientID/carbon?brokerlist='tcp://localhost:5673'

# register some queues in JNDI using the form
# queue.[jndiName] = [physicalName]
queue.MyQueue = example.MyQueue

# register some topics in JNDI using the form
# topic.[jndiName] = [physicalName]
topic.MyTopic = example.MyTopic

Changing encrypted passwords

To change any password which we have encrypted already, follow the below steps:

1. Be sure to shut down the server.

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

3. Execute the following command for your OS:

   Code Block

   • On Linux: ./ciphertool.sh -Dchange

   • On Windows: ./ciphertool.

   sh -Dchange

   • bat -Dchange

   Note
   If you are using the cipher tool for the first time, this command will first initialize the tool for your product. The tool will then encrypt any plain text passwords that are specified in the cipher-text.properties file for automatic encryption.

4. It will prompt for the primary keystore passwordprimary keystore password. Enter the keystore password the keystore password (which is "wso2carbon" for the default keystoredefault keystore).

5. The alias values of all the passwords that you encrypted will now be shown in a numbered list. 

6. The system will then prompt you to select the alias of the password which you want to change. Enter the list number of the password alias.

7. The system will then prompt you (twice) to enter the new password. Enter your new password.The password should now be changed and encrypted.