Try SpotterGenerate OpenSSL private keys without disk access
| "added in version" 1.3.0 of community.crypto"
Authors: Yanis Guenane (@Spredzy), Felix Fontein (@felixfontein)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install community.crypto:==2.18.0
collections:
- name: community.crypto
version: 2.18.0Keys are generated in PEM format.
Make sure to not write the result of this module into logs or to the console, as it contains private key data! Use the C(no_log) task option to be sure.
Note that this module is implemented as an L(action plugin,https://docs.ansible.com/ansible/latest/plugins/action.html) and will always be executed on the controller.
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.
This allows to read and write keys to vaults without having to write intermediate versions to disk.
This module allows one to (re)generate OpenSSL private keys without disk access.
- name: Generate an OpenSSL private key with the default values (4096 bits, RSA) community.crypto.openssl_privatekey_pipe: register: output no_log: true # make sure that private key data is not accidentally revealed in logs!
- name: Show generated key
ansible.builtin.debug:
msg: "{{ output.privatekey }}"
# DO NOT OUTPUT KEY MATERIAL TO CONSOLE OR LOGS IN PRODUCTION!
- name: Generate or update a Mozilla sops encrypted key
block:
- name: Update sops-encrypted key with the community.sops collection
community.crypto.openssl_privatekey_pipe:
content: "{{ lookup('community.sops.sops', 'private_key.pem.sops') }}"
size: 2048
register: output
no_log: true # make sure that private key data is not accidentally revealed in logs!
- name: Update encrypted key when openssl_privatekey_pipe reported a change
community.sops.sops_encrypt:
path: private_key.pem.sops
content_text: "{{ output.privatekey }}"
when: output is changed
always:
- name: Make sure that output (which contains the private key) is overwritten
ansible.builtin.set_fact:
output: ''
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 V(ECC), V(X25519), V(X448), V(Ed25519), and V(Ed448) require the C(cryptography)
backend. V(X25519) needs cryptography 2.5 or newer, while V(X448), V(Ed25519), and
V(Ed448) require cryptography 2.6 or newer. For V(ECC), the minimal cryptography
version required depends on the O(curve) option.
type: str
curve:
choices:
- secp224r1
- secp256k1
- secp256r1
- secp384r1
- secp521r1
- secp192r1
- brainpoolP256r1
- brainpoolP384r1
- brainpoolP512r1
- sect163k1
- sect163r2
- sect233k1
- sect233r1
- sect283k1
- sect283r1
- sect409k1
- sect409r1
- sect571k1
- sect571r1
description:
- Note that not all curves are supported by all versions of C(cryptography).
- For maximal interoperability, V(secp384r1) or V(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).
- Please note that all curves except V(secp224r1), V(secp256k1), V(secp256r1), V(secp384r1),
and V(secp521r1) are discouraged for new private keys.
type: str
cipher:
description:
- The cipher to encrypt the private key. Must be V(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 V(auto) selects a format based on the key format. The value V(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 B(regenerated)
by default. To change this behavior, use the O(format_mismatch) option.
type: str
content:
description:
- The current private key data.
- Needed for idempotency. If not provided, the module will always return a change,
and all idempotence-related options are ignored.
type: str
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 does not 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 V(full_idempotence)
is specified.
- If set to V(never), the module will fail if the key cannot be read or the passphrase
is not matching, and will never regenerate an existing key.
- If set to V(fail), the module will fail if the key does not correspond to the module's
options.
- If set to V(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 V(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 V(always), the module will always regenerate the key.
- Note that if O(format_mismatch) is set to V(convert) and everything matches except
the format, the key will always be converted, except if O(regenerate) is set to
V(always).
type: str
content_base64:
default: false
description:
- Set to V(true) if the content is base64 encoded.
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 V(regenerate) (default), generates a new private key.
- If set to V(convert), the key will be converted to the new format instead.
- Only supported by the C(cryptography) backend.
type: str
return_current_key:
default: false
description:
- Set to V(true) to return the current private key when the module did not generate
a new one.
- Note that in case of check mode, when this option is not set to V(true), the module
always returns the current key (if it was provided) and Ansible will replace it
by C(VALUE_SPECIFIED_IN_NO_LOG_PARAMETER).
type: bool
select_crypto_backend:
choices:
- auto
- cryptography
default: auto
description:
- Determines which crypto backend to use.
- The default choice is V(auto), which tries to use C(cryptography) if available.
- If set to V(cryptography), will try to use the L(cryptography,https://cryptography.io/)
library.
type: str
curve:
description: Elliptic curve used to generate the TLS/SSL private key.
returned: changed or success, and O(type) is V(ECC)
sample: secp256r1
type: str
fingerprint:
description:
- The fingerprint of the public key. Fingerprint will be generated for each C(hashlib.algorithms)
available.
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 generated private key's content.
- Please note that if the result is not changed, the current private key will only
be returned if the O(return_current_key) option is set to V(true).
- Will be Base64-encoded if the key is in raw format.
returned: changed, or O(return_current_key) is V(true)
type: str
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