community.crypto.openssl_privatekey – Generate OpenSSL private keys¶
Note
This plugin is part of the community.crypto collection (version 1.4.0).
To install it use: ansible-galaxy collection install community.crypto.
To use it in a playbook, specify: community.crypto.openssl_privatekey.
Synopsis¶
Keys are generated in PEM format.
Please note that the module regenerates private keys if they don’t match the module’s options. In particular, if you provide another passphrase (or specify none), change the keysize, etc., the private key will be regenerated. If you are concerned that this could overwrite your private key, consider using the backup option.
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. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in community.crypto 2.0.0.
This module allows one to (re)generate OpenSSL private keys.
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
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
attributes
string
added in 2.3 of ansible.builtin
|
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
|
|
Create a backup file including a timestamp so you can get the original private key back if you overwrote it with a new one by accident.
|
|
cipher
string
|
The cipher to encrypt the private key. (Valid values can be found by running `openssl list -cipher-algorithms` or `openssl list-cipher-algorithms`, depending on your OpenSSL version.)
When using the
cryptography backend, use auto. |
|
|
curve
string
|
|
Note that not all curves are supported by all versions of
cryptography.For maximal interoperability,
secp384r1 or secp256r1 should be used.We use the curve names as defined in the IANA registry for TLS.
Please note that all curves except
secp224r1, secp256k1, secp256r1, secp384r1 and secp521r1 are discouraged for new private keys. |
|
force
boolean
|
|
Should the key be regenerated even if it already exists.
|
|
format
string
added in 1.0.0 of community.crypto
|
|
Determines which format the private key is written in. By default, PKCS1 (traditional OpenSSL format) is used for all keys which support it. Please note that not every key can be exported in any format.
The value
auto selects a fromat based on the key format. The value auto_ignore does the same, but for existing private key files, it will not force a regenerate when its format is not the automatically selected one for generation.Note that if the format for an existing private key mismatches, the key is *regenerated* by default. To change this behavior, use the format_mismatch option.
The format option is only supported by the
cryptography backend. The pyopenssl backend will fail if a value different from auto_ignore is used. |
|
format_mismatch
string
added in 1.0.0 of community.crypto
|
|
Determines behavior of the module if the format of a private key does not match the expected format, but all other parameters are as expected.
If set to
regenerate (default), generates a new private key.If set to
convert, the key will be converted to the new format instead.Only supported by the
cryptography backend. |
|
group
string
|
Name of the group that should own the file/directory, as would be fed to chown.
|
|
|
mode
raw
|
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.
|
|
|
passphrase
string
|
The passphrase for the private key.
|
|
|
path
path
/ required
|
Name of the file in which the generated TLS/SSL private key will be written. It will have
0600 mode if mode is not explicitly set. |
|
|
regenerate
string
added in 1.0.0 of community.crypto
|
|
Allows to configure in which situations the module is allowed to regenerate private keys. The module will always generate a new key if the destination file does not exist.
By default, the key will be regenerated when it doesn't match the module's options, except when the key cannot be read or the passphrase does not match. Please note that this changed for Ansible 2.10. For Ansible 2.9, the behavior was as if
full_idempotence is specified.If set to
never, the module will fail if the key cannot be read or the passphrase isn't matching, and will never regenerate an existing key.If set to
fail, the module will fail if the key does not correspond to the module's options.If set to
partial_idempotence, the key will be regenerated if it does not conform to the module's options. The key is not regenerated if it cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified.If set to
full_idempotence, the key will be regenerated if it does not conform to the module's options. This is also the case if the key cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified. Make sure you have a backup when using this option!If set to
always, the module will always regenerate the key. This is equivalent to setting force to yes.Note that if format_mismatch is set to
convert and everything matches except the format, the key will always be converted, except if regenerate is set to always. |
|
return_content
boolean
added in 1.0.0 of community.crypto
|
|
If set to
yes, will return the (current or generated) private key's content as privatekey.Note that especially if the private key is not encrypted, you have to make sure that the returned value is treated appropriately and not accidentally written to logs etc.! Use with care!
Use Ansible's no_log task option to avoid the output being shown. See also https://docs.ansible.com/ansible/latest/reference_appendices/faq.html#how-do-i-keep-secret-data-in-my-playbook.
|
|
select_crypto_backend
string
|
|
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 pyOpenSSL library.If set to
cryptography, will try to use the cryptography library.Please note that the
pyopenssl backend has been deprecated in Ansible 2.9, and will be removed in community.crypto 2.0.0. From that point on, only the cryptography backend will be available. |
|
selevel
string
|
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. |
|
|
size
integer
|
Default: 4096
|
Size (in bits) of the TLS/SSL key to generate.
|
|
state
string
|
|
Whether the private key should exist or not, taking action if the state is different from what is stated.
|
|
type
string
|
|
The algorithm used to generate the TLS/SSL private key.
Note that
ECC, X25519, X448, Ed25519 and Ed448 require the cryptography backend. X25519 needs cryptography 2.5 or newer, while X448, Ed25519 and Ed448 require cryptography 2.6 or newer. For ECC, the minimal cryptography version required depends on the curve option. |
|
unsafe_writes
boolean
added in 2.2 of ansible.builtin
|
|
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
- community.crypto.openssl_privatekey_pipe
The official documentation on the community.crypto.openssl_privatekey_pipe module.
- community.crypto.openssl_privatekey_info
The official documentation on the community.crypto.openssl_privatekey_info module.
- community.crypto.x509_certificate
The official documentation on the community.crypto.x509_certificate module.
- community.crypto.x509_certificate_pipe
The official documentation on the community.crypto.x509_certificate_pipe module.
- community.crypto.openssl_csr
The official documentation on the community.crypto.openssl_csr module.
- community.crypto.openssl_csr_pipe
The official documentation on the community.crypto.openssl_csr_pipe module.
- community.crypto.openssl_dhparam
The official documentation on the community.crypto.openssl_dhparam module.
- community.crypto.openssl_pkcs12
The official documentation on the community.crypto.openssl_pkcs12 module.
- community.crypto.openssl_publickey
The official documentation on the community.crypto.openssl_publickey module.
Examples¶
- name: Generate an OpenSSL private key with the default values (4096 bits, RSA)
community.crypto.openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
- name: Generate an OpenSSL private key with the default values (4096 bits, RSA) and a passphrase
community.crypto.openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
passphrase: ansible
cipher: aes256
- name: Generate an OpenSSL private key with a different size (2048 bits)
community.crypto.openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
size: 2048
- name: Force regenerate an OpenSSL private key if it already exists
community.crypto.openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
force: yes
- name: Generate an OpenSSL private key with a different algorithm (DSA)
community.crypto.openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
type: DSA
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Yanis Guenane (@Spredzy)
Felix Fontein (@felixfontein)