Step-by-step instructions how to encrypt properties in MuleSoft

1. PROPERTY ENCRYPTION IN MULESOFT
BY: ZAHEER AHMAD
 How to do property encryption

2.  Launch Anypoint Studio.
 Under the Help menu, select Install New Software…
 Mule opens the Install wizard. Click the Add…​ button next to the Work
with field.
 In the Add Repository panel, enter a Name for the repository, such as
AppSecurity, and in the Location field, paste the following link:
 http://security-update-site-1.4.s3.amazonaws.com
 Then click OK.

3.  In the table, check the box to select Premium, then click Next.
 Click Next in the next wizard pane.
 Use the radio button to accept the terms of the license agreement, then
click Finish.
 Anypoint Studio installs Anypoint Enterprise Security, then asks that you
restart the application.
 Upon relaunch, Studio displays a new palette group called Security which
contains six new message processors (see below).
 In Studio, right-click the src/main/resources folder, then select New > File.

4.  In the New File wizard, enter a Filename, including the .properties extension.
For example, test.properties.
 Click Finish. Studio saves the new, blank file in your project and opens a new
window in a Properties File Editor window.
 Click the in the .properties tab to close the Properties File Editor window.
 In the Package Explorer, right-click the .properties file, then select Open
With > Mule Properties Editor.

5.  Click the green icon in the Studio toolbar (see the image below) to open
the Add a new property dialog.
 Add the key-value pair (property) you wish to record in the properties file.
 Repeat steps 6 - 11 to add many properties to your Credentials Vault.
 In Studio, access the src/main/app folder, then double-click the mule-
app.properties file to open it.
 To this system properties file, add the following properties.

6.  production.myproperty=<<Your key>>
 environment=test
 Save your changes to the file, then close.
 How to change the key for property encryption
 In the Package Explorer, right-click the encrypted .properties file, then
select Open With > Mule Properties Editor.

7.  Double click the encrypted property, on the appeared dialogue box click
decrypt
 Repeat step 2 – 4 to decrypt all the value encrypted values.
 Double click the property you want to encrypt in the properties file.
 Repeat steps 1- 3 to encrypt the properties against new key.
 In Studio, access the src/main/app folder, then double-click the mule-
app.properties file to open it
 To this properties file, update your key property.

8.  production.myproperty=<<Your new key>>
 How to secure the key on Cloudhub:
 Save your changes to the file, then close.
 In Studio, access the src/main/app folder, then double-click the mule-
app.properties file to open it.
 Every property(In our case key) that you want to secure on Cloudhub, can be
secure by listing them as “secure.properties”. You can provide as many comma
separated properties as you want to secure. In the example below
production.property is marked as secure

9.  Deploy the Mule application to CloudHub.
 Enter your application properties as you normally would.
 Commit your deployment or update. Once your application is
deployed/updated, navigate to the Properties tab and check the application
properties. The values for all properties that you had marked as secured are
now no longer visible to you or any other user. In the example below,
production.property is secured, but environment is not.

10.  Note that, once the values are committed and the application is uploaded,
the secured properties are never displayed on the console, nor sent and
received between the console and the CloudHub server. There is no way to
retrieve the property, once set. It can, however, be overwritten with a new
value. So, if you need to update a value, type a new value into the field, as
shown below.