acme_account - Create, modify or delete accounts with Let’s Encrypt

New in version 2.6.

Synopsis

  • Allows to create, modify or delete accounts with Let’s Encrypt. Let’s Encrypt is a free, automated, and open certificate authority (CA), run for the public’s benefit. For details see https://letsencrypt.org.
  • 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
  • openssl

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 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.
account_key_src
Path to a file containing the ACME account RSA or Elliptic Curve key.
RSA keys can be created with openssl rsa .... Elliptic curve keys can be created with openssl ecparam -genkey ....
Mutually exclusive with account_key_content.
Required if account_key_content is not used.

aliases: account_key
acme_directory 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 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 (https://github.com/letsencrypt/Pebble).
acme_version
(added in 2.5)
    Choices:
  • 1 ←
  • 2
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.
allow_creation
bool
    Choices:
  • no
  • yes ←
Whether account creation is allowed (when state is present).
contact Default:
[]
A list of contact URLs.
Email addresses must be prefixed with mailto:.
See https://tools.ietf.org/html/draft-ietf-acme-acme-10#section-7.1.2 for what is allowed.
Must be specified when state is present. Will be ignored if state is absent or changed_key.
new_account_key_content
Content of the Let's Encrypt account RSA or Elliptic Curve key to change to.
Same restrictions apply as to account_key_content.
Mutually exclusive with new_account_key_src.
Required if new_account_key_src is not used and state is changed_key.
new_account_key_src
Path to a file containing the Let's Encrypt account RSA or Elliptic Curve key to change to.
Same restrictions apply as to account_key_src.
Mutually exclusive with new_account_key_content.
Required if new_account_key_content is not used and state is changed_key.
state
required
    Choices:
  • present
  • absent
  • changed_key
The state of the account, to be identified by its account key.
If the state is absent, the account will either not exist or be deactivated.
If the state is changed_key, the account must exist. The account key will be changed; no other information will be touched.
terms_agreed
bool
    Choices:
  • no ←
  • yes
Boolean indicating whether you agree to the terms of service document.
ACME servers can require this to be true.
validate_certs
bool

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

Examples

- name: Make sure account exists and has given contacts. We agree to TOS.
  acme_account:
    account_key_src: /etc/pki/cert/private/account.key
    state: present
    terms_agreed: yes
    contact:
    - mailto:[email protected]
    - mailto:[email protected]

- name: Make sure account has given email address. Don't create account if it doesn't exist
  acme_account:
    account_key_src: /etc/pki/cert/private/account.key
    state: present
    allow_creation: no
    contact:
    - mailto:[email protected]

- name: Change account's key to the one stored in the variable new_account_key
  acme_account:
    account_key_src: /etc/pki/cert/private/account.key
    new_account_key_content: '{{ new_account_key }}'
    state: changed_key

- name: Delete account (we have to use the new key)
  acme_account:
    account_key_content: '{{ new_account_key }}'
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
account_uri
string
 always
ACME account URI, or None if account does not exist.


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Felix Fontein (@felixfontein)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/acme_account_module.html