# community.crypto.acme_certificate_order_validate module – Validate authorizations of an ACME v2 order — Community.Crypto Collection documentation

# community.crypto.acme_certificate_order_validate module – Validate authorizations of an ACME v2 order

Note

This module is part of the community.crypto collection (version 2.21.0).

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.acme_certificate_order_validate`.

New in community.crypto 2.21.0

## Synopsis

- Validates pending authorizations of an ACME v2 order. This is the second to last step of obtaining a new certificate with the ACME protocol from a Certificate Authority such as Let’s Encrypt or Buypass. This module does not support ACME v1, the original version of the ACME protocol before standardization.

- This module needs to be used in conjunction with the community.crypto.acme_certificate_order_create and community.crypto.acme_certificate_order_finalize modules.

## Requirements

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

- either openssl or cryptography >= 1.5

- ipaddress

## Parameters

Parameter | Comments
--- | ---

account_key_content

string

Content of the ACME account RSA or Elliptic Curve key.

Mutually exclusive with `account_key_src`.

Required if `account_key_src` is not used.

Warning: the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.

In case `cryptography` is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.

account_key_passphrase string added in community.crypto 1.6.0 | Phassphrase to use to decode the account key. Note: this is not supported by the `openssl` backend, only by the `cryptography` backend.

account_key_src

aliases: account_key

path

Path to a file containing the ACME account RSA or Elliptic Curve key.

Private keys can be created with the community.crypto.openssl_privatekey or community.crypto.openssl_privatekey_pipe modules. If the requisite (cryptography) is not available, keys can also be created directly with the `openssl` command line tool: RSA keys can be created with `openssl genrsa ...`. Elliptic curve keys can be created with `openssl ecparam -genkey ...`. Any other tool creating private keys in PEM format can be used as well.

Mutually exclusive with `account_key_content`.

Required if `account_key_content` is not used.

account_uri string | If specified, assumes that the account URI is as given. If the account key does not match this account, or an account with this URI does not exist, the module fails.

acme_directory

string / required

The ACME directory to use. This is the entry point URL to access the ACME CA server API.

For safety reasons the default is set to the Let’s Encrypt staging server (for the ACME v1 protocol). This will create technically correct, but untrusted certificates.

For Let’s Encrypt, all staging endpoints can be found here: https://letsencrypt.org/docs/staging-environment/. For Buypass, all endpoints can be found here: https://community.buypass.com/t/63d4ay/buypass-go-ssl-endpoints

For Let’s Encrypt, the production directory URL for ACME v2 is https://acme-v02.api.letsencrypt.org/directory.

For Buypass, the production directory URL for ACME v2 and v1 is https://api.buypass.com/acme/directory.

For ZeroSSL, the production directory URL for ACME v2 is https://acme.zerossl.com/v2/DV90.

For Sectigo, the production directory URL for ACME v2 is https://acme-qa.secure.trust-provider.com/v2/DV.

The notes for this module contain a list of ACME services this module has been tested against.

acme_version

integer / required

The ACME version of the endpoint.

Must be `1` for the classic Let’s Encrypt and Buypass ACME endpoints, or `2` for standardized ACME v2 endpoints.

The value `1` is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.

Choices:

- `1`

- `2`

challenge

string

The challenge to be performed for every pending authorization.

Must be provided if there is at least one pending authorization.

In case of authorization reuse, or in case of CAs which use External Account Binding and other means of validating certificate assurance, it might not be necessary to provide this option.

Choices:

- `"http-01"`

- `"dns-01"`

- `"tls-alpn-01"`

deactivate_authzs

boolean

Deactivate authentication objects (authz) in case an error happens.

Authentication objects are bound to an account key and remain valid for a certain amount of time, and can be used to issue certificates without having to re-authenticate the domain. This can be a security concern.

Choices:

- `false`

- `true` ← (default)

order_uri string / required | The order URI provided by `order_uri`.
request_timeout integer added in community.crypto 2.3.0 | The time Ansible should wait for a response from the ACME API. This timeout is applied to all HTTP(S) requests (HEAD, GET, POST). Default: `10`

select_crypto_backend

string

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` binary.

If set to `cryptography`, will try to use the cryptography library.

Choices:

- `"auto"` ← (default)

- `"cryptography"`

- `"openssl"`

validate_certs

boolean

Whether calls to the ACME directory will validate TLS certificates.

Warning: Should only ever be set to `false` for testing purposes, for example when testing against a local Pebble server.

Choices:

- `false`

- `true` ← (default)

## Attributes

Attribute | Support | Description
--- | --- | ---
action_group | Action groups: community.crypto.acme, acme | Use `group/acme` or `group/community.crypto.acme` in `module_defaults` to set defaults for this module.
check_mode | Support: none | Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode | Support: none | Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.
safe_file_operations | Support: full | Uses Ansible’s strict file operation functions to ensure proper permissions and avoid data corruption.

## Notes

Note

- Although the defaults are chosen so that the module can be used with the Let’s Encrypt CA, the module can in principle be used with any CA providing an ACME endpoint, such as Buypass Go SSL.

- So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and Pebble testing server. We have got community feedback that they also work with Sectigo ACME Service for InCommon. If you experience problems with another ACME server, please create an issue to help us supporting it. Feedback that an ACME server not mentioned does work is also appreciated.

- If a new enough version of the `cryptography` library is available (see Requirements for details), it will be used instead of the `openssl` binary. This can be explicitly disabled or enabled with the `select_crypto_backend` option. Note that using the `openssl` binary will be slower and less secure, as private key contents always have to be stored on disk (see `account_key_content`).

## See Also

See also

community.crypto.acme_certificate_order_create

  Create an ACME order.

community.crypto.acme_certificate_order_finalize

  Finalize an ACME order after satisfying the challenges.

community.crypto.acme_certificate_order_info

  Obtain information for an ACME order.

The Let’s Encrypt documentation

  Documentation for the Let’s Encrypt Certification Authority. Provides useful information for example on rate limits.

Buypass Go SSL

  Documentation for the Buypass Certification Authority. Provides useful information for example on rate limits.

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).

community.crypto.acme_challenge_cert_helper

  Helps preparing `tls-alpn-01` challenges.

community.crypto.acme_inspect

  Allows to debug problems.

community.crypto.acme_certificate_deactivate_authz

  Allows to deactivate (invalidate) ACME v2 orders.

## Examples

    ### Example with HTTP-01 challenge ###

    - name: Create a challenge for sample.com using a account key from a variable
      community.crypto.acme_certificate_order_create:
        account_key_content: "{{ account_private_key }}"
        csr: /etc/pki/cert/csr/sample.com.csr
      register: sample_com_challenge

    # Alternative first step:
    - name: Create a challenge for sample.com using a account key from Hashi Vault
      community.crypto.acme_certificate_order_create:
        account_key_content: >-
          {{ lookup('community.hashi_vault.hashi_vault', 'secret=secret/account_private_key:value') }}
        csr: /etc/pki/cert/csr/sample.com.csr
      register: sample_com_challenge

    # Alternative first step:
    - name: Create a challenge for sample.com using a account key file
      community.crypto.acme_certificate_order_create:
        account_key_src: /etc/pki/cert/private/account.key
        csr_content: "{{ lookup('file', '/etc/pki/cert/csr/sample.com.csr') }}"
      register: sample_com_challenge

    # Perform the necessary steps to fulfill the challenge. For example:
    #
    # - name: Copy http-01 challenges
    #   ansible.builtin.copy:
    #     dest: /var/www/{{ item.identifier }}/{{ item.challenges['http-01'].resource }}
    #     content: "{{ item.challenges['http-01'].resource_value }}"
    #   loop: "{{ sample_com_challenge.challenge_data }}"
    #   when: "'http-01' in item.challenges"

    - name: Let the challenge be validated
      community.crypto.acme_certificate_order_validate:
        account_key_src: /etc/pki/cert/private/account.key
        order_uri: "{{ sample_com_challenge.order_uri }}"
        challenge: http-01

    - name: Retrieve the cert and intermediate certificate
      community.crypto.acme_certificate_order_finalize:
        account_key_src: /etc/pki/cert/private/account.key
        csr: /etc/pki/cert/csr/sample.com.csr
        order_uri: "{{ sample_com_challenge.order_uri }}"
        cert_dest: /etc/httpd/ssl/sample.com.crt
        fullchain_dest: /etc/httpd/ssl/sample.com-fullchain.crt
        chain_dest: /etc/httpd/ssl/sample.com-intermediate.crt

    ### Example with DNS challenge against production ACME server ###

    - name: Create a challenge for sample.com using a account key file.
      community.crypto.acme_certificate_order_create:
        acme_directory: https://acme-v01.api.letsencrypt.org/directory
        acme_version: 2
        account_key_src: /etc/pki/cert/private/account.key
        csr: /etc/pki/cert/csr/sample.com.csr
      register: sample_com_challenge

    # Perform the necessary steps to fulfill the challenge. For example:
    #
    # - name: Create DNS records for dns-01 challenges
    #   community.aws.route53:
    #     zone: sample.com
    #     record: "{{ item.key }}"
    #     type: TXT
    #     ttl: 60
    #     state: present
    #     wait: true
    #     # Note: item.value is a list of TXT entries, and route53
    #     # requires every entry to be enclosed in quotes
    #     value: "{{ item.value | map('community.dns.quote_txt', always_quote=true) | list }}"
    #   loop: "{{ sample_com_challenge.challenge_data_dns | dict2items }}"

    - name: Let the challenge be validated
      community.crypto.acme_certificate_order_validate:
        acme_directory: https://acme-v01.api.letsencrypt.org/directory
        acme_version: 2
        account_key_src: /etc/pki/cert/private/account.key
        order_uri: "{{ sample_com_challenge.order_uri }}"
        challenge: dns-01

    - name: Retrieve the cert and intermediate certificate
      community.crypto.acme_certificate_order_finalize:
        acme_directory: https://acme-v01.api.letsencrypt.org/directory
        acme_version: 2
        account_key_src: /etc/pki/cert/private/account.key
        csr: /etc/pki/cert/csr/sample.com.csr
        order_uri: "{{ sample_com_challenge.order_uri }}"
        cert_dest: /etc/httpd/ssl/sample.com.crt
        fullchain_dest: /etc/httpd/ssl/sample.com-fullchain.crt
        chain_dest: /etc/httpd/ssl/sample.com-intermediate.crt

## Return Values

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

Key | Description
--- | ---
account_uri string | ACME account URI. Returned: success
validating_challenges list / elements=dictionary | List of challenges whose validation was triggered. Returned: success
authz_url string | The URL of the authorization object for this challenge. Returned: always

challenge_type

string

The challenge’s type.

Returned: always

Can only return:

- `"http-01"`

- `"dns-01"`

- `"tls-alpn-01"`

challenge_url string | The URL of the challenge object. Returned: always
identifier string | The identifier the challenge is for. Returned: always

identifier_type

string

The identifier’s type for the challenge.

Returned: always

Can only return:

- `"dns"`

- `"ip"`

### Authors

- Felix Fontein (@felixfontein)

### Collection links

- Issue Tracker
- Repository (Sources)
- Submit a bug report
- Request a feature
- Communication