community.crypto.openssl_publickey 模块 – 从私钥生成 OpenSSL 公钥。

注意

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

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

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

要在 playbook 中使用它，请指定： community.crypto.openssl_publickey。

概要

• 此模块允许您从私钥（重新）生成公钥。

• 公钥以 PEM 或 OpenSSH 格式生成。私钥必须是 OpenSSL PEM 密钥。不支持 OpenSSH 私钥，请使用 community.crypto.openssh_keypair 模块来管理这些密钥。

• 该模块使用 cryptography Python 库。

要求

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

• cryptography >= 1.2.3（较旧的版本也可能有效）

• 如果 format 为 OpenSSH，则需要 cryptography >= 1.4

参数

参数	注释
attributes 别名：attr 字符串	生成的 filesystem 对象应具有的属性。 要获取支持的标志，请查看目标系统上 chattr 的手册页。 此字符串应按 lsattr 显示的顺序包含属性。 默认情况下假定使用 = 运算符，否则需要在字符串中包含 + 或 - 运算符。
backup 布尔值	创建一个包含时间戳的备份文件，以便您可以意外地用不同的公钥覆盖它后找回原始公钥。 选项 false ← (默认) true
force 布尔值	即使密钥已存在，是否也应重新生成密钥。 选项 false ← (默认) true
format 字符串	公钥的格式。 选项 "OpenSSH" "PEM" ← (默认)
group 字符串	应拥有 filesystem 对象的组的名称，如同提供给 chown 一样。 如果未指定，则除非您是 root 用户，否则它将使用当前用户的当前组，在这种情况下，它可以保留之前的拥有者。
mode 任意	生成的 filesystem 对象应具有的权限。 对于习惯使用 /usr/bin/chmod 的用户，请记住模式实际上是八进制数。您必须向 Ansible 提供足够的信息才能正确解析它们。为了获得一致的结果，请引用八进制数（例如，'644' 或 '1777'），以便 Ansible 接收字符串并可以自行将字符串转换为数字。添加前导零（例如，0755）有时有效，但在循环和其他一些情况下可能会失败。 如果不遵循上述任何规则，则向 Ansible 提供数字将导致十进制数字，这将产生意外的结果。 从 Ansible 1.8 开始，模式可以指定为符号模式（例如，u+rwx 或 u=rw,g=r,o=r）。 如果未指定 mode 并且目标 filesystem 对象不存在，则在设置新创建的 filesystem 对象的模式时，将使用系统上的默认 umask。 如果未指定 mode 并且目标 filesystem 对象存在，则将使用现有 filesystem 对象的模式。 指定 mode 是确保以正确的权限创建 filesystem 对象的最佳方法。有关更多详细信息，请参阅 CVE-2020-1736。
owner 字符串	应拥有 filesystem 对象的用户名称，如同提供给 chown 一样。 如果未指定，则除非您是 root 用户，否则它将使用当前用户，在这种情况下，它可以保留之前的拥有者。 指定数字用户名将被假定为用户 ID 而不是用户名。避免使用数字用户名以避免这种混淆。
path 路径 / 必需	将生成的 TLS/SSL 公钥写入的文件名。
privatekey_content 字符串 在 community.crypto 1.0.0 中添加	从中生成公钥的 TLS/SSL 私钥的内容。 必须指定 privatekey_path 或 privatekey_content 之一，但不能同时指定两者。如果 state 为 present，则必须指定其中一个。
privatekey_passphrase 字符串	私钥的密码短语。
privatekey_path path	用于生成公钥的 TLS/SSL 私钥路径。 必须指定 privatekey_path 或 privatekey_content 之一，但不能同时指定两者。如果 state 为 present，则必须指定其中一个。
return_content 布尔值 在 community.crypto 1.0.0 中添加	如果设置为 true，则将返回（当前或生成的）公钥内容作为 publickey。 选项 false ← (默认) true
select_crypto_backend 字符串	确定要使用的加密后端。 默认选择为 auto，如果可用，则尝试使用 cryptography。 如果设置为 cryptography，则将尝试使用 cryptography 库。 选项 "auto" ← (默认) "cryptography"
selevel 字符串	SELinux 文件系统对象上下文中的级别部分。 这是 MLS/MCS 属性，有时称为 range。 设置为 _default 时，如果可用，它将使用策略的 level 部分。
serole 字符串	SELinux 文件系统对象上下文中的角色部分。 设置为 _default 时，如果可用，它将使用策略的 role 部分。
setype 字符串	SELinux 文件系统对象上下文中的类型部分。 设置为 _default 时，如果可用，它将使用策略的 type 部分。
seuser 字符串	SELinux 文件系统对象上下文中的用户部分。 默认情况下，它使用 system 策略（如果适用）。 设置为 _default 时，如果可用，它将使用策略的 user 部分。
state 字符串	公钥是否应该存在，如果状态与声明的状态不同，则采取行动。 选项 "absent" "present" ← (默认)
unsafe_writes 布尔值	影响何时使用原子操作来防止目标文件系统对象的数据损坏或不一致读取。 默认情况下，此模块使用原子操作来防止目标文件系统对象的数据损坏或不一致读取，但有时系统配置方式或损坏方式会阻止此操作。一个例子是 docker 挂载的文件系统对象，无法从容器内部以原子方式更新，只能以不安全的方式写入。 此选项允许 Ansible 在原子操作失败时回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全写入）。 重要！不安全写入容易出现竞争条件，并可能导致数据损坏。 选项 false ← (默认) true

属性

属性	支持	描述
check_mode	支持：完全支持	可以在 check_mode 下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：完全支持	在差异模式下，将返回有关更改内容（或可能需要在 check_mode 中进行更改）的详细信息。
safe_file_operations	支持：完全支持	使用 Ansible 的严格文件操作功能来确保正确的权限并避免数据损坏。

另请参阅

另请参阅

community.crypto.x509_certificate

生成和/或检查 OpenSSL 证书。

community.crypto.x509_certificate_pipe

生成和/或检查 OpenSSL 证书。

community.crypto.openssl_csr

生成 OpenSSL 证书签名请求 (CSR)。

community.crypto.openssl_csr_pipe

生成 OpenSSL 证书签名请求 (CSR)。

community.crypto.openssl_dhparam

生成 OpenSSL Diffie-Hellman 参数。

community.crypto.openssl_pkcs12

生成 OpenSSL PKCS#12 归档文件。

community.crypto.openssl_privatekey

生成 OpenSSL 私钥。

community.crypto.openssl_privatekey_pipe

无需磁盘访问即可生成 OpenSSL 私钥。

示例

- name: Generate an OpenSSL public key in PEM format
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_path: /etc/ssl/private/ansible.com.pem

- name: Generate an OpenSSL public key in PEM format from an inline key
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_content: "{{ private_key_content }}"

- name: Generate an OpenSSL public key in OpenSSH v2 format
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_path: /etc/ssl/private/ansible.com.pem
    format: OpenSSH

- name: Generate an OpenSSL public key with a passphrase protected private key
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_path: /etc/ssl/private/ansible.com.pem
    privatekey_passphrase: ansible

- name: Force regenerate an OpenSSL public key if it already exists
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_path: /etc/ssl/private/ansible.com.pem
    force: true

- name: Remove an OpenSSL public key
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    state: absent

返回值

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

键	描述
backup_file 字符串	创建的备份文件的名称。 返回：changed 和如果 backup 为 true 示例："/path/to/publickey.pem.2019-03-09@11:22~"
filename 字符串	生成的 TLS/SSL 公钥文件的路径。 返回：changed 或 success 示例："/etc/ssl/public/ansible.com.pem"
fingerprint 字典	公钥的指纹。将为每个可用的 hashlib.algorithms 生成指纹。 返回：changed 或 success 示例：{"md5": "84:75:71:72:8d:04:b5:6c:4d:37:6d:66:83:f5:4c:29", "sha1": "51:cc:7c:68:5d:eb:41:43:88:7e:1a:ae:c7:f8:24:72:ee:71:f6:10", "sha224": "b1:19:a6:6c:14:ac:33:1d:ed:18:50:d3:06:5c:b2:32:91:f1:f1:52:8c:cb:d5:75:e9:f5:9b:46", "sha256": "41:ab:c7:cb:d5:5f:30:60:46:99:ac:d4:00:70:cf:a1:76:4f:24:5d:10:24:57:5d:51:6e:09:97:df:2f:de:c7", "sha384": "85:39:50:4e:de:d9:19:33:40:70:ae:10:ab:59:24:19:51:c3:a2:e4:0b:1c:b1:6e:dd:b3:0c:d9:9e:6a:46:af:da:18:f8:ef:ae:2e:c0:9a:75:2c:9b:b3:0f:3a:5f:3d", "sha512": "fd:ed:5e:39:48:5f:9f:fe:7f:25:06:3f:79:08:cd:ee:a5:e7:b3:3d:13:82:87:1f:84:e1:f5:c7:28:77:53:94:86:56:38:69:f0:d9:35:22:01:1e:a6:60:...:0f:9b"}
format 字符串	公钥的格式 (PEM、OpenSSH 等)。 返回：changed 或 success 示例："PEM"
privatekey 字符串	生成公钥的 TLS/SSL 私钥的路径。 如果私钥已在 privatekey_content 中提供，则将为 none。 返回：changed 或 success 示例："/etc/ssl/private/ansible.com.pem"
publickey 字符串 在 community.crypto 1.0.0 中添加	（当前或生成的）公钥的内容。 返回：如果 state 为 present 且 return_content 为 true

作者

• Yanis Guenane (@Spredzy)

• Felix Fontein (@felixfontein)

集合链接

• 问题追踪器
• 代码库（源码）
• 寻求帮助（加密）
• 寻求帮助（ACME）
• 提交错误报告
• 请求功能
• 沟通