12.3. 自定义通知消息
电子邮件通知使用各种类型的消息的模板构建。这样，消息可以被告知、容易重复生成，且易于自定义。CA 使用模板进行通知消息。HTML 和纯文本消息都存在单独的模板。
12.3.1. 自定义 CA 通知消息
每种 CA 通知模板都有一个 HTML 模板和一个与其关联的纯文本模板。消息由文本、令牌和 HTML 模板构建，用于 HTML 标记。令牌是在构建消息时被当前值替换的消息中的数字符号($)标识的变量。有关可用令牌列表，请参阅 表 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 目录中。
可以更改这些消息的名称和位置；在配置通知时进行适当的更改。所有模板名称都可以更改，但证书被拒绝的模板除外；这些名称必须保持不变。与证书颁发和证书拒绝关联的模板必须位于同一目录中，且必须使用相同的扩展。
| filename | 描述 |
|---|---|
| certIssued_CA | 在签发证书时，纯文本通知电子邮件的模板到结束实体。 |
| certIssued_CA.html | 在签发证书时，基于 HTML 的通知电子邮件的模板发送到结束实体。 |
| certRequestRejected.html | 当证书请求被拒绝时，基于 HTML 的通知电子邮件的模板到结束实体。 |
| certRequestRevoked_CA | 当证书被撤销时，用于纯文本通知电子邮件的模板到结束实体。 |
| certRequestRevoked_CA.html | 当证书被撤销时，基于 HTML 的通知电子邮件的模板到结束实体。 |
| reqInQueue_CA | 当请求进入队列时，用于纯文本通知电子邮件的模板。 |
| reqInQueue_CA.html | 当请求进入队列时，基于 HTML 的通知电子邮件的模板到代理。 |
| filename | 描述 |
|---|---|
| rnJob1.txt | 用于公式发送到结束实体的消息内容的模板，以告知它们的证书即将过期，并在证书过期前续订或替换证书。 |
| rnJob1Summary.txt |
用于构建要发送到代理和管理员的摘要报告的模板。使用
rnJob1Item.txt 模板格式化消息中的项目。
|
| rnJob1Item.txt | 用于格式化摘要报告中包含的项目的模板。 |
| riq1Item.html | 用于格式化摘要表中包含的项目的模板，使用 riq1Summary.html 模板构建。 |
| riq1Summary.html |
用于公式报告或表的模板，它总结了证书管理器代理队列中待处理请求数。
|
| publishCerts |
总结了要发布到目录的证书的报告或表模板。使用
publishCertsItem.html 模板格式化表中的项目。
|
| publishCertsItem.html |
用于格式化摘要表中包含的项目的模板。
|
| ExpiredUnpublishJob |
总结了从目录中删除过期证书的报告或表模板。使用
ExpiredUnpublishJobItem 模板格式化表中的项目。
|
| ExpiredUnpublishJobItem |
用于格式化摘要表中包含的项目的模板。
|
表 12.3 “通知变量” 列出并定义通知消息模板中可以使用的变量。
| 令牌 | 描述 |
|---|---|
| $CertType |
指定证书类型；可以是以下任意一种：
|
| $ExecutionTime | 提供作业运行的时间。 |
| $HexSerialNumber | 提供以十六进制格式发布的证书的序列号。 |
| $HttpHost | 提供最终实体应连接到的证书管理器的完全限定主机名，以检索其证书。 |
| $HttpPort | 提供证书管理器的端到端（非 TLS）端口号。 |
| $InstanceID |
提供发送通知的子系统的 ID。
|
| $IssuerDN | 提供签发证书的 CA 的 DN。 |
| $NotAfter | 提供有效期的结束日期。 |
| $NotBefore | 提供有效期的开始日期。 |
| $RecipientEmail | 提供接收者的电子邮件地址。 |
| $RequestId | 给出请求 ID。 |
| $RequestorEmail | 提供请求者的电子邮件地址。 |
| $RequestType | 提供发出的请求类型。 |
| $RevocationDate | 提供证书撤销的日期。 |
| $SenderEmail | 提供发送者的电子邮件地址；这与通知配置中 发送者电子邮件地址字段中指定 的地址相同。 |
| $SerialNumber | 提供发布的证书的序列号；序列号在结果消息中显示为十六进制值。 |
| $Status | 提供请求状态。 |
| $SubjectDN | 提供证书主题的 DN。 |
| $SummaryItemList | 列出概述通知中的项目。每个项目对应于作业检测到续订或从发布目录中删除的证书。 |
| $SummaryTotalFailure | 提供概述报告中失败的项目总数。 |
| $SummaryTotalNum | 提供队列中待处理的证书请求总数，或者从概述报告的目录中更新或删除的证书的总数。 |
| $SummaryTotalSuccess | 显示摘要报告中项目总数的总数。 |
