AppSettings.Production.json を暗号化する

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 です。

コマンド リファレンス

パラメーター	説明
--pe	AppSettings.Production.json ファイルを暗号化します。
--de	AppSettings.Production.json ファイルを復号します。
-f / --configfile	AppSettings.Production.json のファイル名とパスを指定します。
-o / --output	暗号化/復号されたファイルは、既存のファイルを上書きせずに、新しいファイルとして保存されます。
--help	使用可能なコマンドに関する情報を表示します。
--version	バージョン情報を表示します。
--signing-settings	ツールの設定に任意の設定セクションを追加できます。 このコマンドはドット表記を使用します。 例: configprotector.exe --pe -f appsettings.Production.json --signing-settings Other.Path.Of.SigningCredentialSettings
--keys / k	ハードコードされていないキーを暗号化/復号できます。 このパラメーターの後にコンマ区切りのキーのリストを続ける必要があります。 例: configprotector.exe --pe -f appsettings.Production.json --keys Path.To.Key1,Path.To.Key2 注: これはまれに発生するケースでのみ使用され、暗号化をサポートするキー (主に接続文字列) にのみ使用されます。たとえば、新しい Ledger サブスクライバーに新しい接続文字列を追加する際に新しいキーを暗号化する場合です。このパラメーターによって、最初に構成全体を復号してから後で暗号化し直すことを避けることができます。ツールで既に暗号化されている既定のパスで十分です。

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 は、証明書のサムプリントを表します。
• Location と NameType に他の値を使用することはお勧めしません。

暗号化

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 は、証明書のサムプリントを表します。
• Location と NameType に他の値を使用することはお勧めしません。

暗号化

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"