community.crypto.openssl_privatekey module – Generate OpenSSL private keys
Note
This module is part of the community.crypto collection (version 2.22.1).
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_privatekey
.
Synopsis
Keys are generated in PEM format.
Please note that the module regenerates private keys if they do not 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 default mode for the private key file will be
0600
ifmode
is not explicitly set.This module allows one to (re)generate OpenSSL private keys.
Requirements
The below requirements are needed on the host that executes this module.
cryptography >= 1.2.3 (older versions might work as well)
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 private key back if you overwrote it with a new one by accident. Choices:
|
|
The cipher to encrypt the private key. This is only used when Must be Default: |
|
Note that not all curves are supported by all versions of For maximal interoperability, We use the curve names as defined in the IANA registry for TLS. Please note that all curves except Choices:
|
|
Should the key be regenerated even if it already exists. Choices:
|
|
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 Note that if the format for an existing private key mismatches, the key is regenerated by default. To change this behavior, use the Choices:
|
|
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 If set to Only supported by the 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. |
|
The passphrase for the private key. |
|
Name of the file in which the generated TLS/SSL private key will be written. It will have |
|
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 changed for Ansible 2.10. For Ansible 2.9, the behavior was as if If set to If set to If set to If set to If set to Note that if Choices:
|
|
If set to 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 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 |
|
Size (in bits) of the TLS/SSL key to generate. Default: |
|
Whether the private key should exist or not, taking action if the state is different from what is stated. Choices:
|
|
The algorithm used to generate the TLS/SSL private key. Note that 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.openssl_privatekey_pipe
Generate OpenSSL private keys without disk access.
- community.crypto.openssl_privatekey_info
Provide information for OpenSSL private keys.
- 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_publickey
Generate an OpenSSL public key from its private key.
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: auto
- 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: true
- name: Generate an OpenSSL private key with a different algorithm (DSA)
community.crypto.openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
type: DSA
- name: Generate an OpenSSL private key with elliptic curve cryptography (ECC)
community.crypto.openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
type: ECC
curve: secp256r1
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: |
|
Elliptic curve used to generate the TLS/SSL private key. Returned: changed or success, and Sample: |
|
Path to the generated TLS/SSL private key file. Returned: changed or success Sample: |
|
The fingerprint of the public key. Fingerprint will be generated for each Returned: changed or success Sample: |
|
The (current or generated) private key’s content. Will be Base64-encoded if the key is in raw format. Returned: if |
|
Size (in bits) of the TLS/SSL private key. Returned: changed or success Sample: |
|
Algorithm used to generate the TLS/SSL private key. Returned: changed or success Sample: |