Versions Compared

Key

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

...

Encrypting passwords for synapse configurations

Tip

Before you begin, be sure that your registry database has write-access enabled. Open the registry.xml file (stored in the <EI_HOME>/conf/ directory) and ensure that the <readOnly> element is set to false as shown below.

Code Block
<currentDBConfig>wso2registry</currentDBConfig>
<readOnly>false</readOnly>
<enableCache>true</enableCache>
<registryRoot>/</registryRoot>

This is necessary because the passwords you encrypt using the management console of the ESB profile are written to the registry DB. If the registry does not have write-access enabled, the required functions on the management console will be disabled.

The ESB profile of WSO2 EI provides a UI that can be used for encrypting passwords and other sensitive information in synapse configurations. Follow the steps below.

  1. If you are using the Cipher tool for the first time in your environment, you must first enable the Cipher tool by executing the -Dconfigure command with the cipher tool script: 

    1. Open a terminal and navigate to the <EI_HOME>/bin directory directory.
    2. Execute one of the following commands:
      • On Linux:   ./bin/ciphertool.sh -Dconfigure

      • On Windows:   ./bin/ciphertool.bat -Dconfigure

  2. Start the ESB profile of WSO2 EI and sign in to the management console:
    1. Open a terminal and navigate to the <EI_HOME>/bin directory.
    2. Execute one of the following scripts:
      • On Windows: integrator.bat --run
      • On Linux/Mac OS: sh integrator.sh
    3. Sign in to the management console.
  3. Go to Manage -> Secure Vault Tool and then click Manage Passwords on the Main tab of the management console. The Secure Vault Password Management screen appears.
  4. Click Add New Password to encrypt and store, and then specify values for the given fields as shown below. This creates a new password entry in the registry, which is encrypted with the alias (Vault Key) that you specify.
    • Vault Key: The alias for the password.
    • Password: The actual password.
    • Re-enter password: The password that you specified as the actual password.

...