Documentation

openssl_dhparam - Generate OpenSSL Diffie-Hellman Parameters

New in version 2.5.

Synopsis

  • This module allows one to (re)generate OpenSSL DH-params. This module uses file common arguments to specify generated file permissions.

Requirements

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

  • OpenSSL

Parameters

Parameter Choices/Defaults Comments
attributes
(added in 2.3)
Default:
None
Attributes the 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.

aliases: attr
force
    Choices:
  • yes
  • no ←
Default:
no
Should the parameters be regenerated even it it already exists
group Default:
None
Name of the group that should own the file/directory, as would be fed to chown.
mode Default:
None
Mode the file or directory should be. For those used to /usr/bin/chmod remember that modes are actually octal numbers (like 0644 or 01777). Leaving off the leading zero will likely have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r).
owner Default:
None
Name of the user that should own the file/directory, as would be fed to chown.
path
required
Name of the file in which the generated parameters will be saved.
selevel Default:
s0
Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the range. _default feature works as for seuser.
serole Default:
None
Role part of SELinux file context, _default feature works as for seuser.
setype Default:
None
Type part of SELinux file context, _default feature works as for seuser.
seuser Default:
None
User part of SELinux file context. Will default to system policy, if applicable. If set to _default, it will use the user portion of the policy if available.
size Default:
4096
Size (in bits) of the generated DH-params
state
    Choices:
  • present ←
  • absent
Whether the parameters should exist or not, taking action if the state is different from what is stated.
unsafe_writes
(added in 2.2)
    Choices:
  • no ←
  • yes
Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, sometimes systems are configured or just broken in ways that prevent this. One example are docker mounted files, they cannot be updated atomically and can only be done in an unsafe manner.
This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption.

Examples

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

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

# Force regenerate an DH parameters if they already exist
- openssl_dhparam:
    path: /etc/ssl/dhparams.pem
    force: True

Return Values

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

Key Returned Description
filename
string
changed or success
Path to the generated Diffie-Hellman parameters

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

Sample:
4096


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Thom Wiggers (@thomwiggers)

Hint

If you notice any issues in this documentation you can edit this document to improve it.