Encrypting AppSettings.Production.json

Learn about encrypting AppSettings.Production.json.

Overview

Identity Server and Webhooks AppSettings.Production.json files contain sensitive information one may want to secure. It is possible to encrypt/decrypt these files using the UiPath.ConfigProtector.exe tool.

Note: Once encrypted, the data cannot be changed by directly editing the AppSettings.Production.json file. It must be decrypted and then re-encrypted.

UiPath.ConfigProtector.exe

UiPath.ConfigProtector.exe is located in Orchestrator's installation directory. Its full path is: C:\Program Files (x86)\UiPath\Orchestrator\Tools\ConfigProtector.

Command Reference

Parameter	Description
--pe	Encrypts the AppSettings.Production.json file.
--de	Decrypts the AppSettings.Production.json file.
-f / --configfile	Indicates the file name and path of AppSettings.Production.json.
-o / --output	The encrypted/decrypted file is saved to a new file instead of overwriting the existing one.
--help	Displays information about the available commands.
--version	Displays version information.

Identity Server

Encryption

To encrypt AppSettings.Production.json, perform the following steps AFTER installing Orchestrator:

1. Open the Command Prompt.
2. Run the following command:

   UiPath.ConfigProtector.exe --pe -f "C:\Program Files (x86)\UiPath\Orchestrator\Identity\appsettings.Production.json"

Decryption

1. Open the Command Prompt.
2. Run the following command:

   UiPath.ConfigProtector.exe --de -f "C:\Program Files (x86)\UiPath\Orchestrator\Identity\appsettings.Production.json"

Webhooks

Prior to encrypting Webhook’s appsettings.Production.json, you need to add the signing certificate settings. You can copy the SigningCredentialSettings section from the Identity Server appsettings.Production.json file if you want to use the same certificate.

"AppSettings": {
    "SigningCredentialSettings": {
        "StoreLocation": {
            "Name": "66B6B5A95BD055C8A264E643F9F8B26C7BEAA841",
            "Location": "LocalMachine",
            "NameType": "Thumbprint"
        }
    }
}

• Name represents the Thumbprint of your certificate.
• We do not recommend using other values for Location and NameType.

Encryption

1. Open the Command Prompt.

2. Run the following command:

   UiPath.ConfigProtector.exe 
   --pe 
   -f "C:\Program Files (x86)\UiPath\Orchestrator\Webhooks\appsettings.Production.json"

Decryption

1. Open the Command Prompt.
2. Run the following command:

   UiPath.ConfigProtector.exe --de -f "C:\Program Files (x86)\UiPath\Orchestrator\Webhooks\appsettings.Production.json"