test-suite
2022.4
false
- Studio installation
- Robot installation
- Orchestrator installation
- Test Manager installation
Test Manager Config File Encryption
Test Suite Installation Guide
Last updated Oct 9, 2024
Test Manager Config File Encryption
Test Manager runs certificate-based encryption to secure the configuration files. You can manually encrypt and decrypt the
config files using
testmanager.exe
, as part of Test Manager Provisioning Tool. You can find the tool in the default Test Manager installation location, as
follows: C:\Program Files (x86)\UiPath\TestManager\Tools\TestManagerProvisioner
. Alternatively, you can find it in your custom installation folder.
To start using the Test Manager Provisioning Tool to encrypt your configuration files, download and install the UiPath Test Manager installation package on your machine.
Note:
- For Test Manager versions older than 20.10.4, you need to decrypt the configuration file using the obfuscator (deprecated) command, before encrypting it through the new method.
- The commands are case sensitive.
- Once encrypted, the values cannot be changed by editing the
appsettings.production.json
file. You need to decrypt and then re-encrypt.
- The encryption process overwrites current configurations. Ensure you back up the
appsettings.production.json
file before proceeding. You can find the file inC:\Program Files (x86)\UiPath\Test Manager\
-
Open the
appsettings.production.json
file to configure theSigningCredentialSettings
. If this section is missing, you need to add it to the file. Make sure that the private key is accessible by the user that runs the Test Manager instance, either through the Application Pool Identity, or the user you have specified during installation."SigningCredentialSettings": { "StoreLocation": { "Name": "66B6B5A95BD055C8A264E643F9F8B26C7BEAA841", "Location": "LocalMachine", "NameType": "Thumbprint" } }
"SigningCredentialSettings": { "StoreLocation": { "Name": "66B6B5A95BD055C8A264E643F9F8B26C7BEAA841", "Location": "LocalMachine", "NameType": "Thumbprint" } }Name
: The Thumbprint of your certificate. Keep an eye on theName
object when pasting the Thumbprint value, as it is similar toNameType
and it might create confusion.
We recommend using the default values for
Location
and NameType
.
Save the file after you have pasted the value in the
SigningCredentialSettings
object.
Parameter |
Description |
---|---|
|
Encrypts the
appsettings.production.json file.
|
|
Decrypts the
appsettings.production.json file.
|
To encrypt the configuration files, follow this procedure:
- Open the Command Prompt.
- Open the Test Manager Provisioning Tool folder located in your Test Manager installation location.
-
Run the following command:
testmanager.exe encryptor encrypt "C:\)\)Program Files(x86)\)\)UiPath\)\)Test Manager\)\)appsettings.production.json"
testmanager.exe encryptor encrypt "C:\)\)Program Files(x86)\)\)UiPath\)\)Test Manager\)\)appsettings.production.json"
The configuration file is now protected and stored in a newly generated file:
appsettings.protected.json
.
- Open the Command Prompt.
- Open the Test Manager Provisioning Tool folder located in your Test Manager installation location.
-
Run the following command:
testmanager.exe encryptor decrypt "C:\)\)Program Files(x86)\)\)UiPath\)\)Test Manager\)\)appsettings.production.json"
testmanager.exe encryptor decrypt "C:\)\)Program Files(x86)\)\)UiPath\)\)Test Manager\)\)appsettings.production.json"
The
appsettings.protected.json
file that stores the protected configuration file now has its values set to null
.
- Open the Command Prompt.
- Open the Test Manager Provisioning Tool folder located in your Test Manager installation location.
-
Run the following command:
testmanager.exe obfuscator deobfuscate appsettings "C:\)\)Program Files(x86)\)\)UiPath\)\)Test Manager\)\)appsettings.production.json"
testmanager.exe obfuscator deobfuscate appsettings "C:\)\)Program Files(x86)\)\)UiPath\)\)Test Manager\)\)appsettings.production.json"
After deobfuscating
appsettings.production.json
, you can secure Test Manager using encryption.