Try SpotterGenerate OpenSSL private keys
Authors: Yanis Guenane (@Spredzy), Felix Fontein (@felixfontein)
preview | supported by community
Install with ansible-galaxy collection install community.crypto:==0.1.0
collections:
- name: community.crypto
version: 0.1.0This module allows one to (re)generate OpenSSL private keys.
One can generate L(RSA,https://en.wikipedia.org/wiki/RSA_%28cryptosystem%29), L(DSA,https://en.wikipedia.org/wiki/Digital_Signature_Algorithm), L(ECC,https://en.wikipedia.org/wiki/Elliptic-curve_cryptography) or L(EdDSA,https://en.wikipedia.org/wiki/EdDSA) private keys.
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 I(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 I(select_crypto_backend) option. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13."
- name: Generate an OpenSSL private key with the default values (4096 bits, RSA)
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
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)
openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
size: 2048
- name: Force regenerate an OpenSSL private key if it already exists
openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
force: yes
- name: Generate an OpenSSL private key with a different algorithm (DSA)
openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
type: DSA
mode:
description:
- The permissions the resulting filesystem object should have.
- For those used to I(/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, V('644') or V('1777')) so Ansible receives
a string and can do its own conversion from string into number. Adding a leading
zero (for example, V(0755)) works sometimes, but can fail in loops and some other
circumstances.
- 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, V(u+rwx)
or V(u=rw,g=r,o=r)).
- If O(mode) is not specified and the destination filesystem object B(does not) exist,
the default C(umask) on the system will be used when setting the mode for the newly
created filesystem object.
- If O(mode) is not specified and the destination filesystem object B(does) exist,
the mode of the existing filesystem object will be used.
- Specifying O(mode) is the best way to ensure filesystem objects are created with
the correct permissions. See CVE-2020-1736 for further details.
type: raw
path:
description:
- Name of the file in which the generated TLS/SSL private key will be written. It
will have 0600 mode.
required: true
type: path
size:
default: 4096
description:
- Size (in bits) of the TLS/SSL key to generate.
type: int
type:
choices:
- DSA
- ECC
- Ed25519
- Ed448
- RSA
- X25519
- X448
default: RSA
description:
- The algorithm used to generate the TLS/SSL private key.
- Note that C(ECC), C(X25519), C(X448), C(Ed25519) and C(Ed448) require the C(cryptography)
backend. C(X25519) needs cryptography 2.5 or newer, while C(X448), C(Ed25519) and
C(Ed448) require cryptography 2.6 or newer. For C(ECC), the minimal cryptography
version required depends on the I(curve) option.
type: str
curve:
choices:
- secp384r1
- secp521r1
- secp224r1
- secp192r1
- secp256r1
- secp256k1
- brainpoolP256r1
- brainpoolP384r1
- brainpoolP512r1
- sect571k1
- sect409k1
- sect283k1
- sect233k1
- sect163k1
- sect571r1
- sect409r1
- sect283r1
- sect233r1
- sect163r2
description:
- Note that not all curves are supported by all versions of C(cryptography).
- For maximal interoperability, C(secp384r1) or C(secp256r1) should be used.
- We use the curve names as defined in the L(IANA registry for TLS,https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-8).
type: str
force:
default: false
description:
- Should the key be regenerated even if it already exists.
type: bool
group:
description:
- Name of the group that should own the filesystem object, as would be fed to I(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.
type: str
owner:
description:
- Name of the user that should own the filesystem object, as would be fed to I(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.
type: str
state:
choices:
- absent
- present
default: present
description:
- Whether the private key should exist or not, taking action if the state is different
from what is stated.
type: str
backup:
default: false
description:
- 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.
type: bool
cipher:
description:
- 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 C(cryptography) backend, use C(auto).
type: str
format:
choices:
- pkcs1
- pkcs8
- raw
- auto
- auto_ignore
default: auto_ignore
description:
- 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 C(auto) selects a fromat based on the key format. The value C(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 I(format_mismatch) option.
- The I(format) option is only supported by the C(cryptography) backend. The C(pyopenssl)
backend will fail if a value different from C(auto_ignore) is used.
type: str
serole:
description:
- The role part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(role) portion of the policy if available.
type: str
setype:
description:
- The type part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(type) portion of the policy if available.
type: str
seuser:
description:
- The user part of the SELinux filesystem object context.
- By default it uses the V(system) policy, where applicable.
- When set to V(_default), it will use the C(user) portion of the policy if available.
type: str
selevel:
description:
- The level part of the SELinux filesystem object context.
- This is the MLS/MCS attribute, sometimes known as the C(range).
- When set to V(_default), it will use the C(level) portion of the policy if available.
type: str
attributes:
aliases:
- attr
description:
- The attributes the resulting filesystem object should have.
- To get supported flags look at the man page for I(chattr) on the target system.
- This string should contain the attributes in the same order as the one displayed
by I(lsattr).
- The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to
be included in the string.
type: str
version_added: '2.3'
version_added_collection: ansible.builtin
passphrase:
description:
- The passphrase for the private key.
type: str
regenerate:
choices:
- never
- fail
- partial_idempotence
- full_idempotence
- always
default: full_idempotence
description:
- 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 B(changed) for Ansible 2.10. For Ansible 2.9, the behavior was as if C(full_idempotence)
is specified.
- If set to C(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 C(fail), the module will fail if the key does not correspond to the module's
options.
- If set to C(partial_idempotence), the key will be regenerated if it does not conform
to the module's options. The key is B(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 C(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 B(backup) when
using this option!
- If set to C(always), the module will always regenerate the key. This is equivalent
to setting I(force) to C(yes).
- Note that if I(format_mismatch) is set to C(convert) and everything matches except
the format, the key will always be converted, except if I(regenerate) is set to
C(always).
type: str
unsafe_writes:
default: false
description:
- 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.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
return_content:
default: false
description:
- If set to C(yes), will return the (current or generated) private key's content as
I(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!
type: bool
format_mismatch:
choices:
- regenerate
- convert
default: regenerate
description:
- 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 C(regenerate) (default), generates a new private key.
- If set to C(convert), the key will be converted to the new format instead.
- Only supported by the C(cryptography) backend.
type: str
select_crypto_backend:
choices:
- auto
- cryptography
- pyopenssl
default: auto
description:
- Determines which crypto backend to use.
- The default choice is C(auto), which tries to use C(cryptography) if available,
and falls back to C(pyopenssl).
- If set to C(pyopenssl), will try to use the L(pyOpenSSL,https://pypi.org/project/pyOpenSSL/)
library.
- If set to C(cryptography), will try to use the L(cryptography,https://cryptography.io/)
library.
- Please note that the C(pyopenssl) backend has been deprecated in Ansible 2.9, and
will be removed in Ansible 2.13. From that point on, only the C(cryptography) backend
will be available.
type: str
backup_file:
description: Name of backup file created.
returned: changed and if I(backup) is C(yes)
sample: /path/to/privatekey.pem.2019-03-09@11:22~
type: str
curve:
description: Elliptic curve used to generate the TLS/SSL private key.
returned: changed or success, and I(type) is C(ECC)
sample: secp256r1
type: str
filename:
description: Path to the generated TLS/SSL private key file.
returned: changed or success
sample: /etc/ssl/private/ansible.com.pem
type: str
fingerprint:
description:
- The fingerprint of the public key. Fingerprint will be generated for each C(hashlib.algorithms)
available.
- The PyOpenSSL backend requires PyOpenSSL >= 16.0 for meaningful output.
returned: changed or success
sample:
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
type: dict
privatekey:
description:
- The (current or generated) private key's content.
- Will be Base64-encoded if the key is in raw format.
returned: if I(state) is C(present) and I(return_content) is C(yes)
type: str
version_added: '2.10'
version_added_collection: community.crypto
size:
description: Size (in bits) of the TLS/SSL private key.
returned: changed or success
sample: 4096
type: int
type:
description: Algorithm used to generate the TLS/SSL private key.
returned: changed or success
sample: RSA
type: str