W3cubDocs

/Ansible

community.crypto.acme_account_info – Retrieves information on ACME accounts

Note

This plugin is part of the community.crypto collection (version 1.9.6).

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.

To use it in a playbook, specify: community.crypto.acme_account_info.

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

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 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 1.6.0 of community.crypto		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 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 requisites (pyOpenSSL or cryptography) are 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. aliases: account_key
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		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. The default value is `https://acme-staging.api.letsencrypt.org/directory`. Note that in community.crypto 2.0.0, this option will be required and will no longer have a default. Note that the default is the Let's Encrypt staging server for the ACME v1 protocol, which is deprecated and will be disabled in May 2021 (see here for details). 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. (The production directory URL for ACME v1 is https://acme-v01.api.letsencrypt.org/directory and will be disabled in July 2021.) 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. Warning: So far, the ACME modules have only been tested against Let's Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and Pebble testing server. 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.
acme_version integer	Choices: 1 2	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 default value is `1`. Note that in community.crypto 2.0.0, this option will be required and will no longer have a default. Please also note that we will deprecate ACME v1 support eventually.
retrieve_orders string	Choices: ignore ← url_list object_list	Whether to retrieve the list of order URLs or order objects, if provided by the ACME server. A value of `ignore` will not fetch the list of orders. If the value is not `ignore` and the ACME server supports orders, the `order_uris` return value is always populated. The `orders` return value currently depends on whether this option is set to `url_list` or `object_list`. In community.crypto 2.0.0, it will only be returned if this option is set to `object_list`. Currently, Let's Encrypt does not return orders, so the `orders` result will always be empty.
select_crypto_backend string	Choices: auto ← cryptography openssl	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.
validate_certs boolean	Choices: no yes ←	Whether calls to the ACME directory will validate TLS certificates. Warning: Should only ever be set to `no` for testing purposes, for example when testing against a local Pebble server.

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

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
  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
  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			Returned	Description
account dictionary			if account exists	The account information, as retrieved from the ACME server.
	contact list / elements=string		always	the challenge resource that must be created for validation Sample: ['mailto:[email protected]', 'tel:00123456789']
	orders string		always	A URL where a list of orders can be retrieved for this account. Use the retrieve_orders option to query this URL and retrieve the complete list of orders. Sample: https://example.ca/account/1/orders
	public_account_key string		always	the public account key as a JSON Web Key. Sample: {"kty":"EC","crv":"P-256","x":"MKBCTNIcKUSDii11ySs3526iDZ8AiTo7Tu6KPAqv7D4","y":"4Etl6SRW2YiLUrN5vfvVHuhp7x8PxltmWWlbbM4IFyM"}
	status string		always	the account's status Can only return: valid, deactivated, revoked Sample: valid
account_uri string			always	ACME account URI, or None if account does not exist.
exists boolean			always	Whether the account exists.
order_uris list / elements=string added in 1.5.0 of community.crypto			if account exists, retrieve_orders is not `ignore`, and server supports order listing	The list of orders. If retrieve_orders is `url_list`, this will be a list of URLs. If retrieve_orders is `object_list`, this will be a list of objects.
orders list / elements=string			if account exists, retrieve_orders is not `ignore`, and server supports order listing	The list of orders. If retrieve_orders is `url_list`, this will be a list of URLs. In community.crypto 2.0.0, this return value will no longer be returned for `url_list`. If retrieve_orders is `object_list`, this will be a list of objects.
	authorizations list / elements=string		success	A list of URLs for authorizations for this order.
	certificate string		when certificate was issued	The URL for retrieving the certificate.
	error dictionary		when an error occurred	In case an error occurred during processing, this contains information about the error. The field is structured as a problem document (RFC7807).
	expires string		when server gives expiry date	When the order expires. Timestamp should be formatted as described in RFC3339. Only required to be included in result when status is `pending` or `valid`.
	finalize string		success	A URL used for finalizing an ACME order.
	identifiers list / elements=dictionary		success	List of identifiers this order is for.
		type string	success	Type of identifier. `dns` or `ip`.
		value string	success	Name of identifier. Hostname or IP address.
		wildcard boolean	required to be included if the identifier is wildcarded	Whether value is actually a wildcard. The wildcard prefix `.` is not included in value* if this is `true`.
	notAfter string		when server returns this	The requested value of the `notAfter` field in the certificate. Date should be formatted as described in RFC3339. Server is not required to return this.
	notBefore string		when server returns this	The requested value of the `notBefore` field in the certificate. Date should be formatted as described in RFC3339. Server is not required to return this.
	status string		success	The order's status. Can only return: pending, ready, processing, valid, invalid

Authors

Felix Fontein (@felixfontein)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/crypto/acme_account_info_module.html