community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
Note
This module is part of the community.crypto collection (version 2.22.3).
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
.
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_renewal_info
.
New in community.crypto 2.20.0
Synopsis
Uses various information to determine whether a certificate should be renewed or not.
If available, the ARI extension (ACME Renewal Information, https://datatracker.ietf.org/doc/draft-ietf-acme-ari/) is used. This module implements version 3 of the ARI draft.”
Requirements
The below requirements are needed on the host that executes this module.
either openssl or cryptography >= 1.5
ipaddress
Parameters
Parameter |
Comments |
---|---|
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. |
|
The ACME version of the endpoint. Must be The value Choices:
|
|
If ARI information is used, selects which algorithm is used to determine whether to renew now.
Choices:
|
|
The content of the X.509 certificate to determine renewal of.
|
|
A path to the X.509 certificate to determine renewal of. In case the certificate does not exist, the module will always return
|
|
Use this timestamp instead of the current timestamp to determine whether a certificate should be renewed. Time can be specified either as relative time or as absolute timestamp. Time will always be interpreted as UTC. Valid format is |
|
The number of days the certificate must have left being valid. For example, if |
|
The percentage of the certificate’s validity period that should be left. For example, if Must be a value between 0 and 1. |
|
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: |
|
Determines which crypto backend to use. The default choice is If set to If set to Choices:
|
|
Whether to use ARI information, if available. Set this to Choices:
|
|
Whether calls to the ACME directory will validate TLS certificates. Warning: Should only ever be set to Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 theopenssl
binary. This can be explicitly disabled or enabled with theselect_crypto_backend
option. Note that using theopenssl
binary will be slower.
See Also
See also
- community.crypto.acme_certificate
Allows to obtain a certificate using the ACME protocol
- community.crypto.acme_ari_info
Obtain renewal information for a certificate
Examples
- name: Retrieve renewal information for a certificate
community.crypto.acme_certificate_renewal_info:
certificate_path: /etc/httpd/ssl/sample.com.crt
register: cert_data
- name: Should the certificate be renewed?
ansible.builtin.debug:
var: cert_data.should_renew
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The certificate ID according to the ARI specification. Returned: success, the certificate exists, and has an Authority Key Identifier X.509 extension Sample: |
|
Information on the reason for renewal. Should be shown to the user, as in case of ARI triggered renewal it can contain important information, for example on forced revocations for misissued certificates. Returned: success Sample: |
|
Whether the certificate should be renewed. If no certificate is provided, or the certificate is expired, will always be Returned: success Sample: |
|
Whether ARI information was used to determine renewal. This can be used to determine whether to specify If Returned: success Sample: |