12.3. 通知メッセージのカスタマイズ
メール通知は、各タイプのメッセージに対してテンプレートを使用して構築されます。これにより、メッセージは通知、簡単に再現でき、カスタマイズが簡単に行えます。CA は通知メッセージにテンプレートを使用します。HTML とプレーンテキストメッセージには別々のテンプレートがあります。
12.3.1. CA 通知メッセージのカスタマイズ
それぞれの種類の CA 通知メッセージには、HTML テンプレートとそれに関連するプレーンテキストテンプレートがあります。メッセージは、HTML テンプレート、HTML マークアップ用のテキスト、トークンから構築されます。Tokens は、メッセージの作成時に現在の値で置き換えられるメッセージで、ドル記号 ($) で識別される変数です。利用可能なトークンのリストについては、表12.3「通知変数」 を参照してください。
メッセージタイプの内容は、メッセージテンプレートのテキストおよびトークンを変更することで変更できます。HTML メッセージの外観は、HTML メッセージテンプレートの HTML コマンドを変更することで変更できます。
certificate-issuance-notification メッセージのデフォルトのテキストバージョンは以下の通りです。
Your certificate request has been processed successfully. SubjectDN= $SubjectDN IssuerDN= $IssuerDN notAfter= $NotAfter notBefore= $NotBefore Serial Number= 0x$HexSerialNumber To get your certificate, please follow this URL: https://$HttpHost:$HttpPort/displayBySerial?op=displayBySerial& serialNumber=$SerialNumber Please contact your admin if there is any problem. And, of course, this is just a \$SAMPLE\$ email notification form.
このテンプレートは、次のように、トークンとテキストを再配置、追加、または削除することにより、必要に応じてカスタマイズできます。
THE EXAMPLE COMPANY CERTIFICATE ISSUANCE CENTER Your certificate has been issued! You can pick up your new certificate at the following website: https://$HttpHost:$HttpPort/displayBySerial?op=displayBySerial& serialNumber=$SerialNumber This certificate has been issued with the following information: Serial Number= 0x$HexSerialNumber Name of Certificate Holder = $SubjectDN Name of Issuer = $IssuerDN Certificate Expiration Date = $NotAfter Certificate Validity Date = $NotBefore Contact IT by calling X1234, or going to the IT website http://IT if you have any problems.
通知メッセージテンプレートは
/var/lib/pki/instance_name/ca/emails ディレクトリーにあります。
これらのメッセージの名前と場所を変更することができます。通知の設定時に適切な変更を加えます。証明書が拒否されたテンプレートを除いて、すべてのテンプレート名を変更できます。これらの名前は同じままにする必要があります。証明書の発行と拒否に関連するテンプレートは、同じディレクトリーに配置し、同じ拡張子を使用する必要があります。
表12.1「通知テンプレート」 には、通知メッセージの作成に提供されたデフォルトのテンプレートファイルをリスト表示します。表12.2「ジョブ通知のメールテンプレート」 は、ジョブ概要メッセージの作成に提供されたデフォルトのテンプレートファイルをリスト表示します。
| ファイル名 | 説明 |
|---|---|
| certIssued_CA | 証明書の発行時のプレーンテキスト通知メールのテンプレート。 |
| certIssued_CA.html | 証明書が発行されたときにエンドエンティティーに送信される HTML ベースの通知メールのテンプレート。 |
| certRequestRejected.html | 証明書リクエストが拒否される際に、エンドエンティティーに対する HTML ベースの通知メールのテンプレート。 |
| certRequestRevoked_CA | 証明書が取り消されたときにエンドエンティティーに送信されるプレーンテキストの通知メールのテンプレート。 |
| certRequestRevoked_CA.html | 証明書が取り消されたときにエンドエンティティーに送信される HTML ベースの通知メールのテンプレート。 |
| reqInQueue_CA | リクエストがキューに入ったときのエージェントへのプレーンテキスト通知メールのテンプレート。 |
| reqInQueue_CA.html | リクエストがキューに入ったときのエージェントへの HTML ベースの通知メールのテンプレート。 |
| ファイル名 | 説明 |
|---|---|
| rnJob1.txt | エンドエンティティーに送信されるメッセージコンテンツを作成して、証明書の有効期限が近づいていること、および証明書の有効期限が切れる前に証明書を更新または置換する必要があることを通知するためのテンプレート。 |
| rnJob1Summary.txt |
サマリーレポートをエージェントおよび管理者に送信するためのテンプレート。
rnJob1Item.txt テンプレートを使用してメッセージ内のアイテムをフォーマットします。
|
| rnJob1Item.txt | サマリーレポートに含まれるアイテムをフォーマットするためのテンプレート。 |
| riq1Item.html | サマリーテーブルに含まれる項目をフォーマットするためのテンプレート。これは、riq1Summary.html テンプレートを使用して構築されます。 |
| riq1Summary.html |
Certificate Manager のエージェントキューで保留中の要求数を報告するレポートまたはテーブルを計算するテンプレート。
|
| publishCerts |
ディレクトリーに公開される証明書を要約したレポートまたはテーブルのテンプレート。
publishCertsItem.html テンプレートを使用して、テーブルのアイテムをフォーマットします。
|
| publishCertsItem.html |
サマリーテーブルに含まれるアイテムをフォーマットするためのテンプレート。
|
| ExpiredUnpublishJob |
ディレクトリーに公開される証明書を要約したレポートまたはテーブルのテンプレート。
ExpiredUnpublishJobItem テンプレートを使用して、テーブルのアイテムをフォーマットします。
|
| ExpiredUnpublishJobItem |
サマリーテーブルに含まれるアイテムをフォーマットするためのテンプレート。
|
表12.3「通知変数」 通知メッセージテンプレートで使用できる変数のリスト表示および定義します。
| トークン | 説明 |
|---|---|
| $CertType |
証明書のタイプを指定します。次のいずれかになります。
|
| $ExecutionTime | ジョブが実行された時間を指定します。 |
| $HexSerialNumber | 16 進形式で発行された証明書のシリアル番号を指定します。 |
| $HttpHost | Certificate Manager の完全修飾ホスト名を指定して、証明書を取得するエンドエンティティーが接続します。 |
| $HttpPort | Certificate Manager のエンドエンティティー (TLS 以外の) ポート番号を指定します。 |
| $InstanceID |
通知を送信するサブシステムの ID を指定します。
|
| $IssuerDN | 証明書を発行した CA の DN を指定します。 |
| $NotAfter | 有効期間の終了日を指定します。 |
| $NotBefore | 有効期間の開始日を指定します。 |
| $RecipientEmail | 受信者のアドレスを指定します。 |
| $RequestId | 要求 ID を指定します。 |
| $RequestorEmail | リクエスターのメールアドレスを指定します。 |
| $RequestType | 作成されたリクエストのタイプを指定します。 |
| $RevocationDate | 証明書が取り消された日付を指定します。 |
| $SenderEmail | 送信者のメールアドレスを指定します。これは、通知設定の Sender の E-mail Address フィールドで指定されるアドレスと同じです。 |
| $SerialNumber | 発行した証明書のシリアル番号を指定します。シリアル番号は、メッセージで 16 進数で表示されます。 |
| $Status | 要求のステータスを指定します。 |
| $SubjectDN | 証明書サブジェクトの DN を指定します。 |
| $SummaryItemList | 概要通知のアイテムを表示します。各項目は、ジョブがパブリッシュディレクトリーから更新または削除を検出する証明書に対応します。 |
| $SummaryTotalFailure | 失敗したサマリーレポートの合計項目数を指定します。 |
| $SummaryTotalNum | キューで保留中の証明書要求の総数、または要約レポートのディレクトリーから更新または削除される証明書の総数を示します。 |
| $SummaryTotalSuccess | サマリーレポートのアイテムの合計数を表示します。 |
