Changing the master user password

All passwords are encrypted using a one-time randomly generated master key. The master key is stored automatically in the root repository of Compose (<product_dir>\data\projects\GlobalRepo.sqlite).

The master key is encrypted by a user key, which in turn, is derived from a master password entered by the user. By default, the Master User Password is randomly generated by Compose. The best practice, however, is to change the Master User Password, as this will allow Compose projects and configuration settings to be imported to another machine without needing to re-enter the project credentials.

It may also be convenient to use the same Master User Password within a trusted environment. In other words, if the same administrators control both the production and the testing environments, using the same Master User Password in both environments will facilitate the transfer of projects with credentials between the testing and production environments.

The user key is stored in the muk.dat file located in <product_dir>\data\.

All of the commands listed below must be run as Admin from:

<product_dir>\bin

To generate a random 32 character password:

Issue the following command:

ComposeCtl.exe utils genpassword

To change the randomly generated master user password:

1. Issue the following command:

   ComposeCtl.exe masterukey set --password <new_master_password>

   Information note

   If you add the --prompt parameter to the command and omit the --password parameter, the CLI will prompt you for the password. When you enter the password, it will be obfuscated. This is especially useful if you do not want passwords to be retained in the command prompt history.

   Syntax:

   ComposeCtl.exe masterukey set --prompt

2. Restart the Compose service.

To change a user-defined master user password:

1. Issue the following command:

   ComposeCtl.exe masterukey set --current-password <current_master_password> --password <new_master_password>

   Information note

   If you add the --prompt parameter to the command and omit the --password and --current-password parameters, the CLI will prompt you for the required passwords. When you enter the passwords, they will be obfuscated. This is especially useful if you do not want passwords to be retained in the command prompt history.

   Syntax:

   ComposeCtl.exe masterukey set --prompt

2. Restart the Compose service.