community.crypto.acme_account_info module – Retrieves information on ACME accounts
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_account_info
.
Synopsis
Allows to retrieve information on accounts a CA supporting the ACME protocol, such as Let’s Encrypt.
This module only works with the ACME v2 protocol.
Requirements
The below requirements are needed on the host that executes this module.
either openssl or cryptography >= 1.5
ipaddress
Parameters
Parameter |
Comments |
---|---|
Content of the ACME account RSA or Elliptic Curve key. Mutually exclusive with Required if 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 |
|
Phassphrase to use to decode the account key. Note: this is not supported by the |
|
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 Mutually exclusive with Required if |
|
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. |
|
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:
|
|
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: |
|
Whether to retrieve the list of order URLs or order objects, if provided by the ACME server. A value of If the value is not Currently, Let’s Encrypt does not return orders, so the Choices:
|
|
Determines which crypto backend to use. The default choice is If set to If set to Choices:
|
|
Whether calls to the ACME directory will validate TLS certificates. Warning: Should only ever be set to Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Action groups: community.crypto.acme, acme |
Use |
|
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
The community.crypto.acme_account module allows to modify, create and delete ACME accounts.
This module was called
acme_account_facts
before Ansible 2.8. The usage did not change.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 and less secure, as private key contents always have to be stored on disk (seeaccount_key_content
).
See Also
See also
- community.crypto.acme_account
Allows to create, modify or delete an ACME account.
Examples
- name: Check whether an account with the given account key exists
community.crypto.acme_account_info:
account_key_src: /etc/pki/cert/private/account.key
register: account_data
- name: Verify that account exists
ansible.builtin.assert:
that:
- account_data.exists
- name: Print account URI
ansible.builtin.debug:
var: account_data.account_uri
- name: Print account contacts
ansible.builtin.debug:
var: account_data.account.contact
- name: Check whether the account exists and is accessible with the given account key
acme_account_info:
account_key_content: "{{ acme_account_key }}"
account_uri: "{{ acme_account_uri }}"
register: account_data
- name: Verify that account exists
ansible.builtin.assert:
that:
- account_data.exists
- name: Print account contacts
ansible.builtin.debug:
var: account_data.account.contact
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The account information, as retrieved from the ACME server. Returned: if account exists |
|
the challenge resource that must be created for validation Returned: always Sample: |
|
A URL where a list of orders can be retrieved for this account. Use the Returned: always Sample: |
|
the public account key as a JSON Web Key. Returned: always Sample: |
|
the account’s status Returned: always Can only return:
Sample: |
|
ACME account URI, or None if account does not exist. Returned: always |
|
Whether the account exists. Returned: always |
|
The list of orders. If If Returned: if account exists, |
|
The list of orders. Returned: if account exists, |
|
A list of URLs for authorizations for this order. Returned: success |
|
The URL for retrieving the certificate. Returned: when certificate was issued |
|
In case an error occurred during processing, this contains information about the error. The field is structured as a problem document (RFC7807). Returned: when an error occurred |
|
When the order expires. Timestamp should be formatted as described in RFC3339. Only required to be included in result when Returned: when server gives expiry date |
|
A URL used for finalizing an ACME order. Returned: success |
|
List of identifiers this order is for. Returned: success |
|
Type of identifier. Returned: success Can only return:
|
|
Name of identifier. Hostname or IP address. Returned: success |
|
Whether Returned: required to be included if the identifier is wildcarded |
|
The requested value of the Date should be formatted as described in RFC3339. Server is not required to return this. Returned: when server returns this |
|
The requested value of the Date should be formatted as described in RFC3339. Server is not required to return this. Returned: when server returns this |
|
The order’s status. Returned: success Can only return:
|