マネージド自動化のカスタムアプリケーションをセットアップする

CertCentralのマネージド自動化は、最も一般的なウェブサーバアプリケーションを追加設定なしでサポートします。

CertCentralは、「カスタムアプリケーション」オプションを使用してサードパーティーACMEクライアントを設定できるようにすることで、ネイティブにサポートされていない追加のアプリケーションの証明書管理を提供する柔軟性も提供します。

カスタムアプリケーションのマネージド自動化を有効にするには、以下のステップを実行してください。

Step 1: Install DigiCert agent

Custom automations require an active DigiCert agent on the server. The agent coordinates automation requests received from the Trust Lifecycle Manager web console and calls your custom shell script to handle certificate lifecycle events for the custom application.

For detailed instructions about how to install and activate DigiCert agents on your servers, see Deploy and manage agents.

サードパーティーACMEクライアントをセットアップする

In addition to a DigiCert agent, the server must have Certbot installed. Your custom automation script invokes the Certbot ACME client to request certificates from Trust Lifecycle Manager and install them for your custom Linux or Windows application.

For detailed instructions about how to download and install the Certbot client, refer to the official Certbot instructions.

Step 3: Create shell script

You need a shell script to drive certificate lifecycle events for your custom application. When a new certificate is needed, the DigiCert agent calls this shell script to invoke the Certbot client, which then requests the certificate through the Trust Lifecycle Manager ACME service.

The shell script contains the Certbot command to request and install certificates for your custom application using the parameters expected by the Trust Lifecycle Manager ACME service.

Below are examples of shell scripts to enable Trust Lifecycle Manager managed automation for custom Linux and Windows applications.

例 1. Linux

directoryuri=$1
host=$2
emailaddress=$3
eabkeyidentifier=$5
eabkeyhmac=$6
process_path=/usr/bin/apachectl
server_root=/etc/httpd
config_root=/etc/httpd/config
procCmdLine="/usr/bin/apachectl start"
acmeConfigDirectory="/etc/letsencrypt/"
certbot --server $directoryuri --config-dir $acmeConfigDirectory --eab-kid $eabkeyidentifier  --eab-hmac-key $eabkeyhmac --installer apache -m $emailaddress --force-renew --agree-tos --no-redirect --expand -d $host --no-verify-ssl --no-autorenew --pre-hook "$process_path stop" --post-hook $procCmdLine -n --apache-server-root $server_root --apache-vhost-root $config_root
returnCode=$?
echo "The command exit status : ${returnCode}"
exit $returnCode

例 2. Windows

directoryuri=%1
host=%2
emailaddress=%3
eabkeyidentifier=%5
eabkeyhmac=%6
acmeConfigDirectory="./%eabkeyidentifier%"
certbot --server %directoryuri% --config-dir %acmeConfigDirectory% --eab-kid %eabkeyidentifier%  --eab-hmac-key %eabkeyhmac% -m %emailaddress% --force-renew --agree-tos --no-redirect --expand -d %host% --no-verify-ssl --no-autorenew 
set returnCode=%errorlevel%
EXIT /B %returnCode%

Variable definitions at the top of these shell scripts set the required ACME request parameters:

These must match up with the ACME arguments you configure for the custom application in Trust Lifecycle Manager.
During an automation event, values for these arguments are supplied to the shell script by the local DigiCert agent that calls it.

Commands used in the shell script:

Must include all mandatory parameters.
Must not exceed 512 characters.
Must not include special directives like rm -rf or rmdir

The shell script filename:

Must end with .sh or .bat.
Must not exceed 255 characters.

マネージド自動化を設定する

CertCentralの［自動化の管理］メニューを使用して、カスタムアプリケーションの設定を完了します。

CertCentralアカウントの左側にあるメインメニューで、［自動化］＞［自動化の管理］の順に進みます。
From the More actions dropdown at top, select Add script.
Fill out the Add script form:
1. Name: Enter a user-friendly name to use when referencing the script.
2. Operating system: Select the applicable operating system (Linux or Windows).
3. Script type: Select Custom automation.
4. Script filename: Enter the script's filename in or path relative to the local agent's user-scripts sub-directory.
  - Linux: If your script is named "myscript.sh" and is stored directly in the agent's user-scripts sub-directory, enter myscript.sh here. If you stored the script within an additional sub-directory called "custom-apps" in the user-scripts sub-directory, enter custom-apps/myscript.sh instead.
  - Windows: If your script is named "myscript.bat" and is stored directly in the agent's user-scripts folder, enter myscript.bat here. If you stored the script within an additional sub-folder called "custom-apps" in the user-scripts folder, enter custom-apps\myscript.bat instead.
  警告
  Make sure there are no spaces in the filename for either Linux or Windows. The script will fail if the path or filename has spaces in it.
5. Command-line arguments: Enter a space-separated list of general ACME parameters to use with your custom automation script.
  以下はその例です。
  {acmeDirectoryUrl} {hosts} {email} {key} {extActKid} {extActHmac}
  以下に注意してください。
  - 各引数は、ここに記載されているとおり正確に入力する必要があります。
  - 引数の順序は、シェルスクリプトで使用される順序と一致する必要があります。
  - 自動化イベント中、選択された自動化プロファイルから、これらの引数に必須な値が自動的に取得されます。
  以下は、CertCentralのマネージド自動化でサポートされるACME引数の説明です。
  - {acmeDirectoryUrl} – ACMEディレクトリURL設定。
  - {hosts} – 証明書ホストの詳細。
  - {email} – 通知用のEメールアドレス。
  - {key} – 鍵のアルゴリズム（RSAまたはECC）。
  - {extActKid} – URLで使用される外部アカウントの鍵識別子。
  - {extActHmac} – 応答に署名するためのHMAC鍵。
6. Description (optional): Enter an optional description for the script to help identify it when working with DigiCert agents and agent-based automations in Trust Lifecycle Manager.
［自動化の管理］ビューで、カスタムアプリケーションと同じ証明書ホストで実行されているローカルACMEエージェントの［名前］を選択します。

Step 5: Assign script to the applicable agent IP/port targets

To complete the custom automation configuration, assign the script to any DigiCert agents that will coordinate certificate lifecycle automation events for the custom application:

From the Trust Lifecycle Manager main menu, select Discovery & automation tools > Agents.
Locate the local DigiCert agents on the systems where the custom application is running. Select each agent by name to view the details for it.
Select the pencil (edit) icon on the right of the agent details page to update the agent configuration.
In the IP/port targets section for the agent, locate any IP/port targets where the custom application is running and configure them as follows:
- Application: Select Custom.
- Custom automation script: Select the custom automation script by the name assigned to it in Trust Lifecycle Manager.
Select the Update button at bottom to save your changes.

What's next

After enabling managed automation for your custom application, you can schedule certificate lifecycle automation events for it as you would any other server application in Trust Lifecycle Manager.

このセクションの内容: