openssl_publickey – Generate an OpenSSL public key from its private key¶
Synopsis¶
This module allows one to (re)generate OpenSSL public keys from their private keys.
Keys are generated in PEM or OpenSSH format.
The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available. This can be overridden with the select_crypto_backend option. When format is
OpenSSH, thecryptographybackend has to be used. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13.”
Requirements¶
The below requirements are needed on the host that executes this module.
Either cryptography >= 1.2.3 (older versions might work as well)
Or pyOpenSSL >= 16.0.0
Needs cryptography >= 1.4 if format is
OpenSSH
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
attributes
string
|
The attributes the resulting file or directory 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
= operator is assumed as default, otherwise + or - operators need to be included in the string.aliases: attr |
|
|
backup
boolean
added in 2.8 |
|
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.
|
|
force
boolean
|
|
Should the key be regenerated even it it already exists.
|
|
format
string
added in 2.4 |
|
The format of the public key.
|
|
group
string
|
Name of the group that should own the file/directory, as would be fed to chown.
|
|
|
mode
string
|
The permissions the resulting file or directory should have.
For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like
0644 or 01777) or quote it (like '644' or '1777') so Ansible receives a string and can do its own conversion from string into number.Giving Ansible a number without following one 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,
u+rwx or u=rw,g=r,o=r). |
|
|
owner
string
|
Name of the user that should own the file/directory, as would be fed to chown.
|
|
|
path
path
/ required
|
Name of the file in which the generated TLS/SSL public key will be written.
|
|
|
privatekey_passphrase
string
added in 2.4 |
The passphrase for the private key.
|
|
|
privatekey_path
path
|
Path to the TLS/SSL private key from which to generate the public key.
Required if state is
present. |
|
|
select_crypto_backend
string
added in 2.9 |
|
Determines which crypto backend to use.
The default choice is
auto, which tries to use cryptography if available, and falls back to pyopenssl.If set to
pyopenssl, will try to use the cryptography library. |
|
selevel
string
|
Default: "s0"
|
The level part of the SELinux file context.
This is the MLS/MCS attribute, sometimes known as the
range.When set to
_default, it will use the level portion of the policy if available. |
|
serole
string
|
The role part of the SELinux file context.
When set to
_default, it will use the role portion of the policy if available. |
|
|
setype
string
|
The type part of the SELinux file context.
When set to
_default, it will use the type portion of the policy if available. |
|
|
seuser
string
|
The user part of the SELinux file context.
By default it uses the
system policy, where applicable.When set to
_default, it will use the user portion of the policy if available. |
|
|
state
string
|
|
Whether the public key should exist or not, taking action if the state is different from what is stated.
|
|
unsafe_writes
boolean
|
|
Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file.
By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, 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 files 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.
|
See Also¶
See also
- openssl_certificate – Generate and/or check OpenSSL certificates
The official documentation on the openssl_certificate module.
- openssl_csr – Generate OpenSSL Certificate Signing Request (CSR)
The official documentation on the openssl_csr module.
- openssl_dhparam – Generate OpenSSL Diffie-Hellman Parameters
The official documentation on the openssl_dhparam module.
- openssl_pkcs12 – Generate OpenSSL PKCS#12 archive
The official documentation on the openssl_pkcs12 module.
- openssl_privatekey – Generate OpenSSL private keys
The official documentation on the openssl_privatekey module.
Examples¶
- name: Generate an OpenSSL public key in PEM format
openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
- name: Generate an OpenSSL public key in OpenSSH v2 format
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
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
openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
force: yes
- name: Remove an OpenSSL public key
openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
Yanis Guenane (@Spredzy)
Felix Fontein (@felixfontein)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.