Working with Passwords in the ESB profile

All WSO2 products are shipped with a Secure Vault implementation that allows you to store encrypted passwords that are mapped to aliases. This approach allows you to use the aliases instead of the actual passwords in your configurations for better security. For example, some configurations require the admin username and password. If the admin user's password is "admin", you could use UserManager.AdminUser.Password as the password alias. You will then map that alias to the actual "admin" password using Secure Vault. The WSO2 product will then look up this alias in Secure Vault during runtime, decrypt and use its password.

In all WSO2 products, Secure Vault is commonly used for encrypting passwords and other sensitive information in configuration files. When you use the ESB profile of WSO2 EI, you can encrypt sensitive information contained in synapse configurations in addition to the information in configuration files. See the following topics:

Encrypting passwords in configuration files

To encrypt passwords in configuration files, you simply have to update the cipher-text.properties and cipher-tool.properties files that are stored in the <EI_HOME>/conf/security/ directory and then run the Cipher tool that is shipped with the product. Go to the links given below to see instructions in the WSO2 administration guide:

• Encrypting passwords using the automated process.
• Encrypting passwords using the manual process. This is relevant when the location of the configuration files (that contain the elements to be encrypted) cannot be specified using an xpath in the cipher -tool.properties file.
• Changing already encrypted passwords.
• Resolving already encrypted passwords.

Encrypting passwords for synapse configurations

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

Using the ESB profile

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

Follow the steps given below if you are using the ESB profile.

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.
   2. Execute one of the following commands:

      • On Linux: ./ciphertool.sh -Dconfigure

      • On Windows: ./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.
   

Using the Micro Integrator profile

Follow the steps given below if you are using the micro integrator profile.

1. Open a command terminal and navigate to the <EI_HOME>/wso2/micro-integrator/bin/ directory.

2. Execute the following command to initialize secure vault:

   On Linux/Mac OS	sh securevault.sh
   On Windows	securevault.bat

3. You can then enter the secret alias (vault key) for the password that you want to encrypt. For example, enter 'PasswordAlias'.
4. In the next step, enter the password of the keystore that is used for secure vault in the product. If the default product keystore is used, the password is 'wso2carbon'.
5. Then, specify the plain text password that should be encrypted. 

The encrypted password is stored in the secure-vault.properties file as shown below. This file is stored in the <EI_HOME>/wso2/micro-integrator/registry/config/repository/components/secure-vault/ directory.

#Secure Vault keys for micro integrator
#Thu Sep 27 14:38:33 IST 2018
ProductAlias=hMH3b4S2AhG6l0699uhUVD9O38G04NRygA6TW46/OFMkdNO/0Ucj1ql/x9gCRKrR2TVLFYaM7Sx7E14dJ4IoOaIX9zql9ZxG9bF6ktG2rrktRGoB39BuaLIJ/wPYLoNT26bKr7QXj+NR16eQWlckn1f40Ru2zvE/2wG2smuQL7g67Ptw4DL800IaNYWW8vnhHfaeK+E5CgOKQnTDnwuDDodjiXsJh+2mu2l0KdgDPdxcSjb8uPVC1OubRymygqOJpzKg6Md1R42fGgKGBG9CP9pRj7hW95dVy9h23tHx22ejCrSoxIiEoQjAIIu2wVCBI7fY2HUKBUQOHhb+kenawA\=\=

Using encrypted passwords in synapse configurations

To use the alias of an encrypted password in a synapse configuration, you need to add the {wso2:vault-lookup('alias')}custom path expression when you define the synapse configuration. For example, instead of hard coding the admin user's password as <Password>admin</Password>, you can encrypt and store the password using the AdminUser.Password alias as follows: <Password>{wso2:vault-lookup('AdminUser.Password')}</Password>.

This password in the synapse configuration can now be retrieved by using the  {wso2:vault-lookup('alias')} custom path expression to logically reference the password mapping.

Updating the password validation

The default expression used for password validation is ^[\\S]{5,30}$. This allows the password to have 5 to 30 characters.

If you want to change the expression that is used to validate the password, you need to add the org.wso2.SecureVaultPasswordRegEx system property to the <EI_HOME>/conf/carbon.properties file.
Example:

org.wso2.SecureVaultPasswordRegEx=^[\\S]{5,60}$