All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated docs as per:


By default, the ESB instance's primary key store (<ESB_HOME>/repository/resources/security/wso2carbon.jks) is used as the secure vault. If you want to use another key store or cipher text ciphertext properties file, or if you want to use a custom callback class to handle decryption, modify the <ESB_HOME>/repository/conf/security/ file. For more information on configuring the secure vault and creating custom callback classes, see WSO2 Carbon Secure Vault in the Carbon documentation.


  1. Run the cipher script as specified above to setup set up the secure vault environment.
  2. Click the Main tab on the Management Console, go to Manage -> Secure Vault Tool and then click Manage Passwords. The Secure Vault Password Management screen appears.
  3. Click Add New Password to encrypt and store, and then specify values for the following fields:
    Vault Key - The alias for the password.
    Password -  The actual password.
    Re-enter password - The password that you specified as the actual password. 

    This creates a new password entry in the registry encrypted with the alias that you specified.


Using aliases in your configurations

To use an alias in your synapse configuration, you add {wso2:vault-lookup('xx')} to your configuration, where xx is the alias.
For example, instead of hard-coding the admin user's password as follows: <Password>admin</Password>

You can encrypt and store the password with the alias AdminUser.Password, and retrieve this password in your ESB synapse configuration as follows:


This configuration only encrypts the password within the synapse configuration.