You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.crypto.acme_challenge_cert_helper – Prepare certificates required for ACME challenges such as tls-alpn-01

Note

This plugin is part of the community.crypto collection (version 1.9.8).

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.

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

Synopsis

• Prepares certificates for ACME challenges such as tls-alpn-01.

• The raw data is provided by the community.crypto.acme_certificate module, and needs to be converted to a certificate to be used for challenge validation. This module provides a simple way to generate the required certificates.

Requirements

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

• cryptography >= 1.3

Parameters

Parameter	Comments
challenge string / required	The challenge type. Choices: tls-alpn-01
challenge_data dictionary / required	The challenge_data entry provided by community.crypto.acme_certificate for the challenge.
private_key_content string	Content of the private key to use for this challenge certificate. Mutually exclusive with private_key_src.
private_key_passphrase string added in 1.6.0 of community.crypto	Phassphrase to use to decode the private key.
private_key_src path	Path to a file containing the private key file to use for this challenge certificate. Mutually exclusive with private_key_content.

Notes

Note

• Does not support check_mode.

See Also

See also

Automatic Certificate Management Environment (ACME)

The specification of the ACME protocol (RFC 8555).

ACME TLS ALPN Challenge Extension

The specification of the tls-alpn-01 challenge (RFC 8737).

Examples

- name: Create challenges for a given CRT for sample.com
  community.crypto.acme_certificate:
    account_key_src: /etc/pki/cert/private/account.key
    challenge: tls-alpn-01
    csr: /etc/pki/cert/csr/sample.com.csr
    dest: /etc/httpd/ssl/sample.com.crt
  register: sample_com_challenge

- name: Create certificates for challenges
  community.crypto.acme_challenge_cert_helper:
    challenge: tls-alpn-01
    challenge_data: "{{ item.value['tls-alpn-01'] }}"
    private_key_src: /etc/pki/cert/key/sample.com.key
  loop: "{{ sample_com_challenge.challenge_data | dictsort }}"
  register: sample_com_challenge_certs

- name: Install challenge certificates
  # We need to set up HTTPS such that for the domain,
  # regular_certificate is delivered for regular connections,
  # except if ALPN selects the "acme-tls/1"; then, the
  # challenge_certificate must be delivered.
  # This can for example be achieved with very new versions
  # of NGINX; search for ssl_preread and
  # ssl_preread_alpn_protocols for information on how to
  # route by ALPN protocol.
  ...:
    domain: "{{ item.domain }}"
    challenge_certificate: "{{ item.challenge_certificate }}"
    regular_certificate: "{{ item.regular_certificate }}"
    private_key: /etc/pki/cert/key/sample.com.key
  loop: "{{ sample_com_challenge_certs.results }}"

- name: Create certificate for a given CSR for sample.com
  community.crypto.acme_certificate:
    account_key_src: /etc/pki/cert/private/account.key
    challenge: tls-alpn-01
    csr: /etc/pki/cert/csr/sample.com.csr
    dest: /etc/httpd/ssl/sample.com.crt
    data: "{{ sample_com_challenge }}"

Return Values

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

Key	Description
challenge_certificate string	The challenge certificate in PEM format. Returned: always
domain string	The domain the challenge is for. The certificate should be provided if this is specified in the request’s the Host header. Returned: always
identifier string	The identifier for the actual resource. Will be a domain name if the type is dns, or an IP address if the type is ip. Returned: always
identifier_type string	The identifier type for the actual resource identifier. Will be dns or ip. Returned: always
regular_certificate string	A self-signed certificate for the challenge domain. If no existing certificate exists, can be used to set-up https in the first place if that is needed for providing the challenge. Returned: always

Authors

• Felix Fontein (@felixfontein)