acme_account_info – Retrieves information on ACME accounts — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# acme_account_info – Retrieves information on ACME accounts

New in version 2.7.

- Synopsis
- Requirements
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## 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.

Aliases: acme_account_facts

## 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 added in 2.5 |  | 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_src path |  | Path to a file containing the ACME account RSA or Elliptic Curve key. 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 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 string | Default: "https://acme-staging.api.letsencrypt.org/directory" | 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 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 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. For Buypass, the production directory URL for ACME v2 and v1 is https://api.buypass.com/acme/directory. Warning: So far, the module has only been tested against Let's Encrypt (staging and production), Buypass (staging and production), and Pebble testing server.
acme_version integer added in 2.5 | 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.
retrieve_orders string added in 2.9 | 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. Currently, Let's Encrypt does not return orders, so the `orders` result will always be empty.
select_crypto_backend string added in 2.7 | 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 added in 2.5 | 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 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.
- 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.

## See Also

See also

acme_account – Create, modify or delete ACME accounts
  Allows to create, modify or delete an ACME account.

## Examples

    - name: Check whether an account with the given account key exists
      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
      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_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
      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:me@example.com', '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 Sample: valid
account_uri string | always | ACME account URI, or None if account does not exist.
exists boolean | always | Whether the account exists.
orders list | 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.
| authorizations list / elements=string |  | 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 |  | A URL used for finalizing an ACME order.
| identifiers list / elements=dictionary |  | List of identifiers this order is for.
|  | type string |  | Type of identifier. `dns` or `ip`.
|  | value string |  | 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 |  | The order's status.

## 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)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.