acme_account_facts – Retrieves information on ACME accounts
acme_account_facts – Retrieves information on ACME accounts
New in version 2.7.
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.
- python >= 2.6
- either openssl, …
- … or cryptography >= 1.5
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
account_key_content - added in 2.5 |
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 | |
account_key_src - |
Path to a file containing the ACME account RSA or Elliptic Curve key. RSA keys can be created with Mutually exclusive with Required if
| |
account_uri - added in 2.7 |
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 - |
Default: |
The ACME directory to use. This is the entry point URL to access 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 Let's Encrypt, the production directory URL for ACME v1 is https://acme-v01.api.letsencrypt.org/directory, and the production directory URL for ACME v2 is https://acme-v02.api.letsencrypt.org/directory. Warning: So far, the module has only been tested against Let's Encrypt (staging and production) and against the Pebble testing server. |
acme_version - added in 2.5 |
|
The ACME version of the endpoint. Must be 1 for the classic Let's Encrypt ACME endpoint, or 2 for the new standardized ACME v2 endpoint. |
select_crypto_backend string added in 2.7 |
|
Determines which crypto backend to use. The default choice is If set to If set to |
validate_certs boolean added in 2.5 |
|
Whether calls to the ACME directory will validate TLS certificates. Warning: Should only ever be set to |
Notes
Note
- The acme_account module allows to modify, create and delete ACME accounts.
- 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
). - 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.
Examples
- name: Check whether an account with the given account key exists
acme_account_facts:
account_key_src: /etc/pki/cert/private/account.key
register: account_data
- name: Verify that account exists
assert:
that:
- account_data.exists
- name: Print account URI
debug: var=account_data.account_uri
- name: Print account contacts
debug: var=account_data.account.contact
- name: Check whether the account exists and is accessible with the given account key
acme_account_facts:
account_key_content: "{{ acme_account_key }}"
account_uri: "{{ acme_account_uri }}"
register: account_data
- name: Verify that account exists
assert:
that:
- account_data.exists
- name: Print account contacts
debug: var=account_data.account.contact
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
account complex |
if account exists |
The account information, as retrieved from the ACME server.
| |
contact list |
always |
the challenge resource that must be created for validation
Sample: | |
orders string |
always |
a URL where a list of orders can be retrieved for this account
Sample: | |
status string |
always |
the account's status
Sample: valid | |
account_uri string |
always |
ACME account URI, or None if account does not exist.
| |
exists boolean |
always |
Whether the account exists.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Felix Fontein (@felixfontein)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/acme_account_facts_module.html