community.crypto.openssl_dhparam – Generate OpenSSL Diffie-Hellman Parameters

Note

This plugin is part of the community.crypto collection.

To install it use: ansible-galaxy collection install community.crypto.

To use it in a playbook, specify: community.crypto.openssl_dhparam.

Synopsis

  • This module allows one to (re)generate OpenSSL DH-params.

  • This module uses file common arguments to specify generated file permissions.

  • Please note that the module regenerates existing DH params if they don’t match the module’s options. If you are concerned that this could overwrite your existing DH params, consider using the backup option.

  • The module can use the cryptography Python library, or the openssl executable. By default, it tries to detect which one is available. This can be overridden with the select_crypto_backend option.

Requirements

The below requirements are needed on the host that executes this module.

  • Either cryptography >= 2.0

  • Or OpenSSL binary openssl

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
    Choices:
  • no ←
  • yes
Create a backup file including a timestamp so you can get the original DH params back if you overwrote them with new ones by accident.
force
boolean
    Choices:
  • no ←
  • yes
Should the parameters be regenerated even it it already exists.
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.
path
path / required
Name of the file in which the generated parameters will be saved.
return_content
boolean
added in 1.0.0 of community.crypto
    Choices:
  • no ←
  • yes
If set to yes, will return the (current or generated) DH params' content as dhparams.
select_crypto_backend
string
added in 1.0.0 of community.crypto
    Choices:
  • auto ←
  • cryptography
  • openssl
Determines which crypto backend to use.
The default choice is auto, which tries to use cryptography if available, and falls back to openssl.
If set to openssl, will try to use the OpenSSL openssl executable.
If set to cryptography, will try to use the cryptography library.
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 generated DH-params.
state
string
    Choices:
  • absent
  • present ←
Whether the parameters should exist or not, taking action if the state is different from what is stated.
unsafe_writes
boolean
added in 2.2 of ansible.builtin
    Choices:
  • no ←
  • yes
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.x509_certificate

The official documentation on the community.crypto.x509_certificate module.

community.crypto.openssl_csr

The official documentation on the community.crypto.openssl_csr module.

community.crypto.openssl_pkcs12

The official documentation on the community.crypto.openssl_pkcs12 module.

community.crypto.openssl_privatekey

The official documentation on the community.crypto.openssl_privatekey module.

community.crypto.openssl_publickey

The official documentation on the community.crypto.openssl_publickey module.

Examples

- name: Generate Diffie-Hellman parameters with the default size (4096 bits)
  community.crypto.openssl_dhparam:
    path: /etc/ssl/dhparams.pem

- name: Generate DH Parameters with a different size (2048 bits)
  community.crypto.openssl_dhparam:
    path: /etc/ssl/dhparams.pem
    size: 2048

- name: Force regenerate an DH parameters if they already exist
  community.crypto.openssl_dhparam:
    path: /etc/ssl/dhparams.pem
    force: yes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
backup_file
string
changed and if backup is yes
Name of backup file created.

Sample:
/path/to/[email protected]:22~
dhparams
string
added in 1.0.0 of community.crypto
if state is present and return_content is yes
The (current or generated) DH params' content.

filename
string
changed or success
Path to the generated Diffie-Hellman parameters.

Sample:
/etc/ssl/dhparams.pem
size
integer
changed or success
Size (in bits) of the Diffie-Hellman parameters.

Sample:
4096


Authors

  • Thom Wiggers (@thomwiggers)