community.crypto.openssl_publickey module – Generate an OpenSSL public key from its private key.
Note
This module is part of the community.crypto collection (version 2.22.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.crypto
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.crypto.openssl_publickey
.
Synopsis
This module allows one to (re)generate public keys from their private keys.
Public keys are generated in PEM or OpenSSH format. Private keys must be OpenSSL PEM keys. OpenSSH private keys are not supported, use the community.crypto.openssh_keypair module to manage these.
The module uses the cryptography Python library.
Requirements
The below requirements are needed on the host that executes this module.
cryptography >= 1.2.3 (older versions might work as well)
Needs cryptography >= 1.4 if
format
isOpenSSH
Parameters
Parameter |
Comments |
---|---|
The attributes the resulting filesystem object should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr. The |
|
Create a backup file including a timestamp so you can get the original public key back if you overwrote it with a different one by accident. Choices:
|
|
Should the key be regenerated even it it already exists. Choices:
|
|
The format of the public key. Choices:
|
|
Name of the group that should own the filesystem object, as would be fed to chown. When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership. |
|
The permissions the resulting filesystem object should have. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must give Ansible enough information to parse them correctly. For consistent results, quote octal numbers (for example, Giving Ansible a number without following either of these rules will end up with a decimal number which will have unexpected results. As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, If If Specifying |
|
Name of the user that should own the filesystem object, as would be fed to chown. When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership. Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion. |
|
Name of the file in which the generated TLS/SSL public key will be written. |
|
The content of the TLS/SSL private key from which to generate the public key. Either |
|
The passphrase for the private key. |
|
Path to the TLS/SSL private key from which to generate the public key. Either |
|
If set to Choices:
|
|
Determines which crypto backend to use. The default choice is If set to Choices:
|
|
The level part of the SELinux filesystem object context. This is the MLS/MCS attribute, sometimes known as the When set to |
|
The role part of the SELinux filesystem object context. When set to |
|
The type part of the SELinux filesystem object context. When set to |
|
The user part of the SELinux filesystem object context. By default it uses the When set to |
|
Whether the public key should exist or not, taking action if the state is different from what is stated. Choices:
|
|
Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object. By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. This option allows Ansible to fall back to unsafe methods of updating filesystem objects when atomic operations fail (however, it doesn’t force Ansible to perform unsafe writes). IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: full |
Will return details on what has changed (or possibly needs changing in |
|
Support: full |
Uses Ansible’s strict file operation functions to ensure proper permissions and avoid data corruption. |
See Also
See also
- community.crypto.x509_certificate
Generate and/or check OpenSSL certificates.
- community.crypto.x509_certificate_pipe
Generate and/or check OpenSSL certificates.
- community.crypto.openssl_csr
Generate OpenSSL Certificate Signing Request (CSR).
- community.crypto.openssl_csr_pipe
Generate OpenSSL Certificate Signing Request (CSR).
- community.crypto.openssl_dhparam
Generate OpenSSL Diffie-Hellman Parameters.
- community.crypto.openssl_pkcs12
Generate OpenSSL PKCS#12 archive.
- community.crypto.openssl_privatekey
Generate OpenSSL private keys.
- community.crypto.openssl_privatekey_pipe
Generate OpenSSL private keys without disk access.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Name of backup file created. Returned: changed and if Sample: |
|
Path to the generated TLS/SSL public key file. Returned: changed or success Sample: |
|
The fingerprint of the public key. Fingerprint will be generated for each hashlib.algorithms available. Returned: changed or success Sample: |
|
The format of the public key (PEM, OpenSSH, …). Returned: changed or success Sample: |
|
Path to the TLS/SSL private key the public key was generated from. Will be Returned: changed or success Sample: |
|
The (current or generated) public key’s content. Returned: if |