通知を受け取る

UiPath 製品のインストールとアップグレード

UiPath 製品のインストールとアップグレード ガイド

AppSettings.Production.json を暗号化する

概要


Identity Server、Webhook、Resource Catalog Service の AppSettings.Production.json ファイルには、保護することが推奨される機密情報が含まれます。これらのファイルは、UiPath.ConfigProtector.exe ツールによる暗号化/復号が可能です。

📘

重要

暗号化すると、AppSettings.Production.json ファイルを直接編集してデータを変更することができなくなります。編集するには、復号して、再度暗号化する必要があります。

UiPath.ConfigProtector.exe


UiPath.ConfigProtector.exe は Orchestrator のインストール ディレクトリにあります。フル パスは C:\Program Files (x86)\UiPath\Orchestrator\Tools\ConfigProtector です。

コマンド リファレンス

ParameterDescription
--peEncrypts the AppSettings.Production.json file.
--deDecrypts the AppSettings.Production.json file.
-f / --configfileIndicates the file name and path of AppSettings.Production.json.
-o / --outputThe encrypted/decrypted file is saved to a new file instead of overwriting the existing one.
--helpDisplays information about the available commands.
--versionDisplays version information.
--signing-settingsAllows you to add a configuration section of your choice to the tool's settings.
This command uses the dot notation.

Example: configprotector.exe --pe -f appsettings.Production.json --signing-settings Other.Path.Of.SigningCredentialSettings
--keys / kAllows you to encrypt/decrypt keys that are not hardcoded.
This parameter need to be followed by a list of comma separated keys.

Example: configprotector.exe --pe -f appsettings.Production.json --keys Path.To.Key1,Path.To.Key2

Note: This should only be used in rare cases, and for keys that support encryption (which are mostly connection strings). An example of this is adding a new ledger subscriber with a new connection string, where you want to encrypt the new key without having to first decrypt the whole configuration, and encrypt it afterwards. The default paths that the tool already encrypts should suffice.

Identity Server

暗号化

AppSettings.Production.json を暗号化するには、Orchestrator のインストール後に、次の手順を実行します。

  1. コマンド プロンプトを開きます。
  2. 次のコマンドを実行します。
UiPath.ConfigProtector.exe 
--pe 
-f "C:\Program Files (x86)\UiPath\Orchestrator\Identity\appsettings.Production.json"

復号

  1. コマンド プロンプトを開きます。
  2. 次のコマンドを実行します。
UiPath.ConfigProtector.exe 
--de 
-f "C:\Program Files (x86)\UiPath\Orchestrator\Identity\appsettings.Production.json"

Webhook

Webhook の appsettings.Production.json を暗号化する前に、証明書への署名の設定を追加する必要があります。同じ証明書を使用する場合は、Identity Server の appsettings.Production.json ファイルの SigningCredentialSettings セクションをコピーしても構いません。

"AppSettings": {
    "SigningCredentialSettings": {
        "StoreLocation": {
            "Name": "66B6B5A95BD055C8A264E643F9F8B26C7BEAA841",
            "Location": "LocalMachine",
            "NameType": "Thumbprint"
        }
    }
}
  • Name は、証明書のサムプリントを表します。
  • LocationNameType に他の値を使用することはお勧めしません。

暗号化

  1. コマンド プロンプトを開きます。
  2. 次のコマンドを実行します。
UiPath.ConfigProtector.exe 
--pe 
-f "C:\Program Files (x86)\UiPath\Orchestrator\Webhooks\appsettings.Production.json"

復号

  1. コマンド プロンプトを開きます。
  2. 次のコマンドを実行します。
UiPath.ConfigProtector.exe 
--de 
-f "C:\Program Files (x86)\UiPath\Orchestrator\Webhooks\appsettings.Production.json"

リソース カタログ サービス

Resource Catalog Service の appsettings.Production.json を暗号化する前に、証明書への署名の設定を追加する必要があります。同じ証明書を使用する場合は、Identity Server の appsettings.Production.json ファイルの SigningCredentialSettings セクションをコピーしても構いません。

"AppSettings": {
    "SigningCredentialSettings": {
        "StoreLocation": {
            "Name": "66B6B5A95BD055C8A264E643F9F8B26C7BEAA841",
            "Location": "LocalMachine",
            "NameType": "Thumbprint"
        }
    }
}
  • Name は、証明書のサムプリントを表します。
  • LocationNameType に他の値を使用することはお勧めしません。

暗号化

  1. コマンド プロンプトを開きます。
  2. 次のコマンドを実行します。
UiPath.ConfigProtector.exe 
--pe 
-f "C:\Program Files (x86)\UiPath\Orchestrator\ResourceCatalog\appsettings.Production.json"

復号

  1. コマンド プロンプトを開きます。
  2. 次のコマンドを実行します。
UiPath.ConfigProtector.exe 
--de 
-f "C:\Program Files (x86)\UiPath\Orchestrator\ResourceCatalog\appsettings.Production.json"

約 1 か月前に更新


AppSettings.Production.json を暗号化する


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。