11.3. 自定义通知消息


电子邮件通知使用每种消息类型的模板进行构建。这样,信息可以易于可重复使用,并方便自定义。CA 使用模板作为其通知消息。存在独立的模板,适用于 HTML 和纯文本消息。

11.3.1. 自定义 CA 通知消息

每种 CA 通知消息都有一个 HTML 模板,并关联一个纯文本模板。消息构建自文本、令牌,以及 HTML 模板 HTML 标记。令牌是 变量,由消息中的美元符号($)标识,在消息被构造时替换为当前值。有关可用令牌列表,请参阅 表 11.3 “通知变量”
可以通过更改消息模板中的文本和令牌来修改消息类型的内容。可以通过修改 HTML 消息模板中的 HTML 命令来更改 HTML 消息的外观。
证书验证信息的默认文本版本如下:
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 目录中。
可以更改这些消息的名称和位置;在配置通知时进行适当的更改。所有模板名称都可以更改,除了证书被拒绝的模板外,这些名称必须保持相同。与证书关联的模板需要位于同一目录中,且证书拒绝的模板必须位于同一目录中,并且必须使用相同的扩展名。
表 11.1 “通知模板” 列出为创建通知消息提供的默认模板文件。表 11.2 “作业通知电子邮件模板” 列出为创建作业摘要信息而提供的默认模板文件。
表 11.1. 通知模板
文件名 描述
certIssued_CA 发布证书时,纯文本通知电子邮件模板到结束实体。
certIssued_CA.html 签发证书时,基于 HTML 的通知电子邮件模板以结束实体。
certRequestRejected.html 当证书请求被拒绝时,基于 HTML 的通知电子邮件模板到最终实体。
certRequestRevoked_CA 撤销证书时,用于纯文本通知电子邮件到结束实体的模板。
certRequestRevoked_CA.html 撤销证书时,基于 HTML 的通知电子邮件模板以结束实体。
reqInQueue_CA 当请求进入队列时,向代理发出纯文本通知电子邮件的模板。
reqInQueue_CA.html 当请求进入队列时,适用于基于 HTML 的通知电子邮件模板到代理。
表 11.2. 作业通知电子邮件模板
文件名 描述
rnJob1.txt 用于创建发送到最终用户的消息内容的模板,告知他们其证书即将过期,并在证书过期之前被续订或替换。
rnJob1Summary.txt
构建要发送到代理和管理员的摘要报告的模板。使用 rnJob1Item.txt 模板来格式化消息中的项目。
rnJob1Item.txt 用于格式化摘要报告中包含的项目的模板。
riq1Item.html 用于格式化摘要表中所含项目的模板,该模板使用 riq1Summary.html 模板进行构建。
riq1Summary.html
用于公式表示报告或表的模板,用于概述证书管理器的代理队列中的待处理请求数量。
publishCerts
报告或表的模板,用于汇总要发布到该目录的证书。使用 publishCertsItem.html 模板格式化表中的项目。
publishCertsItem.html
用于格式化摘要表中所含项目的模板。
ExpiredUnpublishJob
汇总从目录中过期的证书的报告或表的模板。使用 ExpiredUnpublishJobItem 模板来格式化表中的项目。
ExpiredUnpublishJobItem
用于格式化摘要表中所含项目的模板。
表 11.3 “通知变量” 列出并定义可在通知模板中使用的变量。
表 11.3. 通知变量
令牌 描述
$CertType
指定证书的类型,可以是以下任意一种:
  • TLS 客户端(客户端
  • TLS 服务器(服务器
  • CA 签名证书(ca)
  • 其他(其他)。
$ExecutionTime 给出作业运行的时间。
$HexSerialNumber 为以十六进制格式发布的证书指定序列号。
$HttpHost 授予证书管理器的完全限定主机名,以便最终实体应连接到其证书以检索其证书。
$HttpPort 给出证书管理器的结束日期(非 TLS)端口号。
$InstanceID
提供发送通知的子系统的 ID。
$IssuerDN 提供签发证书的 CA 的 DN。
$NotAfter 提供有效期日期。
$NotBefore 给出有效期限的开始日期。
$RecipientEmail 给出接收者的电子邮件地址。
$RequestId 给出请求 ID。
$RequestorEmail 给出请求者的电子邮件地址。
$RequestType 提出的请求类型。
$RevocationDate 给出证书被撤销的日期。
$SenderEmail 给出发件人的电子邮件地址;这与通知配置中的 Sender 的 E-mail Address 字段中指定的地址 相同。
$SerialNumber 为发出的证书指定序列号 ; 序列号显示为生成的消息中的十六进制值。
$Status 请求状态。
$SubjectDN 提供证书主体的 DN。
$SummaryItemList 列出摘要通知中的项目。每个项目对应作业检测或从发布目录中删除的证书。
$SummaryTotalFailure 指定摘要报告失败的项目总数。
$SummaryTotalNum 指定在队列中待处理的证书请求总数或要从概述报告中的目录中更新或删除的证书总数。
$SummaryTotalSuccess 显示摘要报告中项目总数的数目。
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.