community.hashi_vault.vault_pki_generate_certificate 模块 – 使用 HashiCorp Vault PKI 生成新的凭据集（私钥和证书）

注意

此模块是 community.hashi_vault 集合 (版本 6.2.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.hashi_vault。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：community.hashi_vault.vault_pki_generate_certificate。

community.hashi_vault 2.3.0 中的新增功能

概要

• 根据 Vault PKI 角色生成新的凭据集（私钥和证书）。

要求

执行此模块的主机需要以下要求。

• hvac (Python 库) 版本 0.9.1 或更高版本

• 有关详细信息，请参阅 集合要求页面。

参数

参数	注释
alt_names 列表 / 元素=字符串	指定请求的主题备用名称。 这些可以是主机名或电子邮件地址；它们将被解析到各自的字段中。 如果任何请求的名称与角色策略不匹配，则整个请求将被拒绝。 默认值： []
auth_method 字符串	要使用的身份验证方法。 none 身份验证方法是在集合版本 1.2.0 中添加的。 cert 身份验证方法是在集合版本 1.4.0 中添加的。 aws_iam_login 在集合版本 2.1.0 中重命名为 aws_iam，并在 3.0.0 中移除。 azure 身份验证方法是在集合版本 3.2.0 中添加的。 选项 "token" ← (默认) "userpass" "ldap" "approle" "aws_iam" "azure" "jwt" "cert" "none"
aws_access_key 别名：aws_access_key_id 字符串	要使用的 AWS 访问密钥。
aws_iam_server_id 字符串 在 community.hashi_vault 0.2.0 中添加	如果指定，则将值设置为用于 X-Vault-AWS-IAM-Server-ID 标头，作为 GetCallerIdentity 请求的一部分。
aws_profile 别名：boto_profile 字符串	AWS 配置文件
aws_secret_key 别名：aws_secret_access_key 字符串	与访问密钥对应的 AWS 密钥。
aws_security_token 字符串	如果使用临时访问密钥和密钥，则为 AWS 安全令牌。
azure_client_id 字符串 在 community.hashi_vault 3.2.0 中添加	Azure AD 服务主体或托管身份的客户端 ID（也称为应用程序 ID）。应为 UUID。 如果未指定，将使用系统分配的托管身份。
azure_client_secret 字符串 在 community.hashi_vault 3.2.0 中添加	Azure AD 服务主体的客户端密钥。
azure_resource 字符串 在 community.hashi_vault 3.2.0 中添加	在 Azure Active Directory 中注册的应用程序的资源 URL。通常不应更改默认值。 默认值： "https://management.azure.com/"
azure_tenant_id 字符串 在 community.hashi_vault 3.2.0 中添加	服务主体的 Azure Active Directory 租户 ID（也称为目录 ID）。应为 UUID。 当使用服务主体对 Vault 进行身份验证时需要，例如，当同时指定 *azure_client_id* 和 *azure_client_secret* 时需要。 当使用托管身份对 Vault 进行身份验证时，可选。
ca_cert 别名：cacert 字符串	用于身份验证的证书的路径。 如果没有通过任何其他方式指定，则将使用 VAULT_CACERT 环境变量。
cert_auth_private_key 路径 在 community.hashi_vault 1.4.0 版本中添加	对于 cert 身份验证，用于身份验证的私钥文件路径，PEM 格式。
cert_auth_public_key 路径 在 community.hashi_vault 1.4.0 版本中添加	对于 cert 身份验证，用于身份验证的证书文件路径，PEM 格式。
common_name 字符串 / 必填	指定证书请求的 CN (通用名称)。 如果角色策略允许该 CN，则将颁发证书。
engine_mount_point 字符串	指定 PKI 引擎使用的挂载点。 默认为 hvac 使用的默认挂载点。
exclude_cn_from_sans 布尔值	如果为真，则给定的 common_name 将不包含在 DNS 或电子邮件主题备用名称 (视情况而定) 中。 如果 CN 不是主机名或电子邮件地址，而是某种人类可读的标识符，则此选项很有用。 选项 false ← (默认) true
format 字符串	指定返回数据的格式。 可以是 pem、der 或 pem_bundle。 如果为 der，则输出为 base64 编码。 如果为 pem_bundle，则 certificate 字段将包含私钥和证书（已连接）。如果颁发 CA 不是 Vault 生成的自签名根证书，则也将包含它。 选项 "pem" ← (默认) "der" "pem_bundle"
ip_sans 列表 / 元素=字符串	指定请求的 IP 主题备用名称。 仅当角色允许 IP SAN（默认为允许）时有效。 默认值： []
jwt 字符串	用于 JWT 身份验证到 Vault 的 JSON Web 令牌 (JWT)。
mount_point 字符串	Vault 挂载点。 如果未指定，则使用给定身份验证方法的默认挂载点。 不适用于令牌身份验证。
namespace 字符串	Vault 中秘密所在的命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。 可选地，这可以通过在身份验证挂载点和/或秘密路径前添加命名空间来实现（例如 mynamespace/secret/mysecret）。 如果设置了环境变量 VAULT_NAMESPACE，则其值将在所有指定 namespace 的方法中最后使用。
other_sans 列表 / 元素=字符串	指定自定义 OID/UTF8 字符串 SAN。 这些必须与角色中 allowed_other_sans 中指定的値匹配。 格式与 OpenSSL 相同：<oid>;<type>:<value>，其中当前唯一有效的类型是 UTF8。 默认值： []
password 字符串	身份验证密码。
private_key_format 字符串	指定编组私钥的格式。 默认为 der，它将返回 base64 编码的 DER 或 PEM 编码的 DER，具体取决于 format 的值。 另一个选项是 pkcs8，它将返回作为 PEM 编码的 PKCS8 编组的密钥。 选项 "der" ← (默认) "pkcs8"
proxies 任意 在 community.hashi_vault 1.1.0 版本中添加	用于访问 Vault 服务的代理的 URL。 它可以是字符串或字典。 如果是字典，请提供方案（例如 http 或 https）作为键，并提供 URL 作为值。 如果是字符串，请提供单个 URL，该 URL 将用作 http 和 https 方案的代理。 可以解释为字典的字符串将转换为字典（参见示例）。 您可以为 HTTP 和 HTTPS 资源指定不同的代理。 如果未指定，则使用 Requests 库的环境变量。
region 字符串	要为此创建连接的 AWS 区域。
retries 任意 在 community.hashi_vault 1.3.0 版本中添加	允许根据 urllib3 库中的 Retry 类 重试错误。 此集合定义了重试与 Vault 建立连接的推荐默认值。 此选项可以指定为正数（整数）或字典。 如果未指定此选项或数字为 0，则禁用重试。 数字设置重试的总数，并使用集合默认值进行其他设置。 字典值直接用于初始化 Retry 类，因此可用于完全自定义重试。 有关重试的详细信息，请参阅集合用户指南。
retry_action 字符串 在 community.hashi_vault 1.3.0 版本中添加	控制是否以及如何显示 retries 的消息。 如果未重试请求，则此选项无效。 选项 "ignore" "warn" ← (默认)
role_id 字符串	Vault 角色 ID 或名称。用于 approle、aws_iam、azure 和 cert 身份验证方法。 对于 cert 身份验证，如果未提供 role_id，则默认行为是尝试所有证书角色并返回任何一个匹配的角色。 对于 azure 身份验证，需要 role_id。
role_name 字符串 / 必填	指定要针对其创建证书的角色的名称。
secret_id 字符串	用于 Vault AppRole 身份验证的密钥 ID。
timeout 整数 在 community.hashi_vault 1.3.0 版本中添加	设置连接超时（以秒为单位）。 如果未设置，则使用 hvac 库的默认值。
token 字符串	Vault 令牌。可以通过列出的 [env] 变量以及 VAULT_TOKEN 环境变量显式指定令牌。 如果没有显式或通过 env 提供令牌，则插件将检查令牌文件，由 token_path 和 token_file 确定。 令牌加载顺序（先找到先使用）为 token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file。
token_file 字符串	如果未指定令牌，则将尝试从 token_path 中的此文件中读取令牌。 默认值： ".vault-token"
token_path 字符串	如果未指定令牌，则将尝试从此路径读取 token_file。
token_validate 布尔值 在 community.hashi_vault 0.2.0 中添加	对于令牌身份验证，将执行 lookup-self 操作以确定令牌的有效性，然后再使用它。 如果您的令牌没有 lookup-self 功能，请禁用此选项。 选项 false ← (默认) true
ttl 字符串	指定请求的生存时间。 不能大于角色的 max_ttl 值。 如果未提供，则将使用角色的 ttl 值。 请注意，如果未显式设置，则角色值默认为系统值。
uri_sans 列表 / 元素=字符串	指定请求的 URI 主题备用名称。 默认值： []
url 字符串	Vault 服务的 URL。 如果未通过任何其他方式指定，则将使用 VAULT_ADDR 环境变量的值。 如果 VAULT_ADDR 也未定义，则将引发错误。
username 字符串	身份验证用户名。
validate_certs 布尔值	控制 SSL 证书的验证和确认，大多数情况下，只有在使用自签名证书时才需要关闭。 如果设置了 VAULT_SKIP_VERIFY 且未显式提供 validate_certs，则将填充 VAULT_SKIP_VERIFY 的反值。 如果未设置 validate_certs 或 VAULT_SKIP_VERIFY，则默认为 true。 选项 false true

属性

属性	支持	描述
action_group	动作组： community.hashi_vault.vault	在 module_defaults 中使用 group/community.hashi_vault.vault 为此模块设置默认值。
check_mode	支持： 部分 在检查模式下，此模块不会联系 Vault，并将返回一个空的 data 字段和 changed 状态。	可以在 check_mode 下运行并返回已更改状态预测，而无需修改目标。

另请参阅

另请参阅

HashiCorp Vault PKI 密钥引擎 API

HashiCorp Vault PKI 密钥引擎的 API 文档。

HVAC 库参考

关于 PKI 引擎的 HVAC 库参考。

示例

- name: Login and use the resulting token
  community.hashi_vault.vault_login:
    url: https://127.0.0.1:8200
    auth_method: ldap
    username: "john.doe"
    password: "{{ user_passwd }}"
  register: login_data

- name: Generate a certificate with an existing token
  community.hashi_vault.vault_pki_generate_certificate:
    role_name: test.example.org
    common_name: test.example.org
    ttl: 8760h
    alt_names:
      - test2.example.org
      - test3.example.org
    url: https://vault:8201
    auth_method: token
    token: "{{ login_data.login.auth.client_token }}"
  register: cert_data

- name: Display generated certificate
  debug:
    msg: "{{ cert_data.data.data.certificate }}"

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
数据 复杂的	有关新生成证书的信息 返回：成功
数据 复杂的	有效负载 返回：成功
ca_chain 列表 / 元素=字符串	CA 证书的链表。 返回：成功 示例： ["-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"]
certificate 字符串	生成的证书。 返回：成功 示例： "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"
issuing_ca 字符串	CA 证书。 返回：成功 示例： "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"
private_key 字符串	用于生成证书的私钥。 返回：成功 示例： "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----"
private_key_type 字符串	私钥算法。 返回：成功 示例： "rsa"
serial_number 字符串	证书的序列号。 返回：成功 示例： "39:dd:2e:90:b7:23:1f:8d:d3:7d:31:c5:1b:da:84:d0:5b:65:31:58"
lease_duration 整数	Vault 租约期限。 返回：成功 示例： 21600
lease_id 字符串	附加到证书的 Vault 租约。 返回：成功 示例： "pki/issue/test/7ad6cfa5-f04f-c62a-d477-f33210475d05"
renewable 布尔值	如果证书可续期则为 True。 返回：成功 示例： false
警告 字符串	Vault 在生成过程中返回的警告。 返回：成功

作者

• Florent David (@Ripolin)

资源链接

• 问题跟踪器
• 代码库 (源代码)
• 讨论、问答、故障排除
• 沟通