+ + +
+ +
+

community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate

+
+

Note

+

This module is part of the community.crypto collection (version 2.20.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_ari_info.

+
+

New in community.crypto 2.20.0

+ +
+

Synopsis

+ +
+
+

Requirements

+

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

+ +
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+

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

    • +
+
+

certificate_content

+

string

+

The content of the X.509 certificate to request information for.

+

Exactly one of certificate_path and certificate_content must be provided.

+
+

certificate_path

+

path

+

A path to the X.509 certificate to request information for.

+

Exactly one of certificate_path and certificate_content must be provided.

+
+

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

+

check_mode

+

Support: full

+

This action does not modify state.

+

Can run in check_mode and return changed status prediction without modifying target.

+
+

diff_mode

+

Support: N/A

+

This action does not modify state.

+

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

+
+
+
+

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.

    • +
+
+
+
+

See Also

+
+

See also

+
+
community.crypto.acme_certificate

Allows to obtain a certificate using the ACME protocol

+
+
community.crypto.acme_certificate_revoke

Allows to revoke a certificate using the ACME protocol

+
+
+
+
+
+

Examples

+
- name: Retrieve renewal information for a certificate
+  community.crypto.acme_ari_info:
+    certificate_path: /etc/httpd/ssl/sample.com.crt
+  register: cert_data
+
+- name: Show the certificate renewal information
+  ansible.builtin.debug:
+    var: cert_data.renewal_info
+
+
+
+
+

Return Values

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Description

+

renewal_info

+

dictionary

+

The ARI renewal info object (https://www.ietf.org/archive/id/draft-ietf-acme-ari-03.html#section-4.2).

+

Returned: success

+
+

explanationURL

+

string

+

A URL pointing to a page which may explain why the suggested renewal window is what it is.

+

For example, it may be a page explaining the CA’s dynamic load-balancing strategy, or a page documenting which certificates are affected by a mass revocation event. Should be shown to the user.

+

Returned: depends on the ACME server

+

Sample: "https://example.com/docs/ari"

+
+

retryAfter

+

string

+

A timestamp before the next retry to ask for this information should not be made.

+

Returned: depends on the ACME server

+

Sample: "2024-04-29T01:17:10.236921+00:00"

+
+

suggestedWindow

+

dictionary

+

Describes the window during which the certificate should be renewed.

+

Returned: always

+
+

end

+

string

+

The end of the window during which the certificate should be renewed.

+

The format is specified in RFC 3339.

+

Returned: always

+

Sample: "2021-01-03T00:00:00Z"

+
+

start

+

string

+

The start of the window during which the certificate should be renewed.

+

The format is specified in RFC 3339.

+

Returned: always

+

Sample: "2021-01-03T00:00:00Z"

+
+
+

Authors

+
    +

  • Felix Fontein (@felixfontein)

    • +
+
+ +
+
+ + +
+