ansible-role-certmonitor

一个用于监控任何主机上证书过期的角色。

需求

没有特别的要求。

角色变量

可用的变量如下所列，并带有默认值（请参见 defaults/main.yml）：

certmonitor_include_paths_global:
  - /etc/pki
  - /etc/ssl
  - /opt

我们将检查的默认路径。将与 _group 和 _host 变量合并。

certmonitor_include_paths_group: []

可选的组级路径添加。

certmonitor_include_paths_host: []

可选的主机级路径添加。

certmonitor_include_patterns_global:
  - '.*\.crt$'
  - '.*\.pem$'

这些正则表达式模式将用于检查文件名。将与 _group 和 _host 变量合并。

certmonitor_include_patterns_group: []

可选的组级模式添加。

certmonitor_include_patterns_host: []

可选的主机级模式添加。

certmonitor_exclude_patterns_global:
  - '/etc/pki/product-default/.*\.pem$'
  - '/etc/pki/ca-trust/extracted/openssl/ca-bundle.trust.crt'
  - '/etc/pki/ca-trust/extracted/pem/.*\.pem$'
  - '/etc/pki/fwupd.*\.pem$'
  - '/etc/pki/consumer/.*\.pem$'
  - '/etc/pki/entitlement/.*\.pem$'
  - '/etc/pki/nginx/dhparam.pem'
  - '/etc/pki/tls/certs/localhost.crt'
  - '.*-key\.pem$'
  - '.*\.key\.pem$'

我们将排除的正则表达式模式。主要是默认证书和私钥。将与 _group 和 _host 变量合并。

certmonitor_exclude_patterns_group: []

可选的组级排除模式添加。

certmonitor_exclude_patterns_host: []

可选的主机级排除模式添加。

certmonitor_validity_check: "+2w"

检查证书有效性的时间，以周为单位。默认情况下，我们使用 "+2w" 来报告在接下来的两周内到期的证书。

certmonitor_email_enabled: false

默认情况下，电子邮件报告被禁用，设置为 true 可启用。

certmonitor_email_subject: "即将过期的 TLS 证书"

发送电子邮件报告时的主题。

certmonitor_email_subtype: "html"

将电子邮件的 MIME 类型设置为 html。也可以设置为 plain。可以根据需要修改模板以匹配此项。

电子邮件部分还有更多可用变量。请参考剧本中的最后一个任务。如果不存在将省略这些，但这给了你在变量中包括这些值的选项，而不必编辑剧本。

certmonitor_local_reporting: false

如果启用了本地报告，将会在指定的位置写入文件，文件名为证书主题。在该文件中，将写入文件位置。这可以被像 Zabbix 这样的监控系统使用，以便在检测到该文件存在时触发并获取文件位置。

certmonitor_local_reporting_path: /tmp/certmonitor

如果启用了本地报告，文件将被写入的路径。

依赖

对于证书检查，此角色依赖于 community.crypto.x509_certificate_info 模块。
对于电子邮件，此角色依赖于 community.general.mail 模块。

示例剧本

包含一个如何使用此角色的示例（例如，作为参数传递变量）对用户来说总是很有帮助：

- name: 证书监控
  hosts: all
  become: true

  vars:
    certmonitor_email_enabled: true
    certmonitor_email_subject: "即将过期的 TLS 证书"
    certmonitor_email_sender: "[email protected]"
    certmonitor_email_recipient: "[email protected]"
    certmonitor_smtp_server: "smtp.yourdomain.com"
    certmonitor_smtp_port: 25

  roles:
     - role: chrisvanmeer.certmonitor

许可证

BSD

作者信息

• Chris van Meer c.v.meer@atcomputing.nl