Try SpotterCreate, modify or delete accounts with Let's Encrypt
| "added in version" 2.6 of ansible.builtin"
Authors: Felix Fontein (@felixfontein)
preview | supported by community
pipInstall with pip install ansible==2.6.17
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 U(https://letsencrypt.org).
This module only works with the ACME v2 protocol.
- 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:me@example.com
- mailto:myself@example.org
- 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:me@example.com
- 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
state:
choices:
- present
- absent
- changed_key
description:
- The state of the account, to be identified by its account key.
- If the state is C(absent), the account will either not exist or be deactivated.
- If the state is C(changed_key), the account must exist. The account key will be
changed; no other information will be touched.
required: true
contact:
default: []
description:
- A list of contact URLs.
- Email addresses must be prefixed with C(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 C(present). Will be ignored if state is C(absent)
or C(changed_key).
account_uri:
description:
- 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.
type: str
acme_version:
choices:
- 1
- 2
description:
- 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.
type: int
terms_agreed:
default: false
description:
- Boolean indicating whether you agree to the terms of service document.
- ACME servers can require this to be true.
type: bool
acme_directory:
description:
- 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.
- The default value is U(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.
- 'For Let''s Encrypt, all staging endpoints can be found here: U(https://letsencrypt.org/docs/staging-environment/).
For Buypass, all endpoints can be found here: U(https://community.buypass.com/t/63d4ay/buypass-go-ssl-endpoints)'
- For Let's Encrypt, the production directory URL for ACME v1 is U(https://acme-v01.api.letsencrypt.org/directory),
and the production directory URL for ACME v2 is U(https://acme-v02.api.letsencrypt.org/directory).
- For Buypass, the production directory URL for ACME v2 and v1 is U(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 L(Pebble testing server,https://github.com/letsencrypt/Pebble).'
type: str
allow_creation:
default: true
description:
- Whether account creation is allowed (when state is C(present)).
type: bool
validate_certs:
default: true
description:
- Whether calls to the ACME directory will validate TLS certificates.
- '*Warning:* Should *only ever* be set to C(no) for testing purposes, for example
when testing against a local Pebble server.'
type: bool
account_key_src:
aliases:
- account_key
description:
- Path to a file containing the ACME account RSA or Elliptic Curve key.
- 'Private keys can be created with the M(community.crypto.openssl_privatekey) module.
If the requisites (pyOpenSSL or cryptography) are not available, keys can also be
created directly with the C(openssl) command line tool: RSA keys can be created
with C(openssl genrsa ...). Elliptic curve keys can be created with C(openssl ecparam
-genkey ...). Any other tool creating private keys in PEM format can be used as
well.'
- Mutually exclusive with C(account_key_content).
- Required if C(account_key_content) is not used.
type: path
account_key_content:
description:
- Content of the ACME account RSA or Elliptic Curve key.
- Mutually exclusive with C(account_key_src).
- Required if C(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 \u2014\
\ it can be used to change the account key, or to revoke your certificates without\
\ knowing their private keys \u2014, this might not be acceptable."
- In case C(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.
type: str
new_account_key_src:
description:
- Path to a file containing the Let's Encrypt account RSA or Elliptic Curve key to
change to.
- Same restrictions apply as to C(account_key_src).
- Mutually exclusive with C(new_account_key_content).
- Required if C(new_account_key_content) is not used and state is C(changed_key).
select_crypto_backend:
choices:
- auto
- cryptography
- openssl
default: auto
description:
- Determines which crypto backend to use.
- The default choice is C(auto), which tries to use C(cryptography) if available,
and falls back to C(openssl).
- If set to C(openssl), will try to use the C(openssl) binary.
- If set to C(cryptography), will try to use the L(cryptography,https://cryptography.io/)
library.
type: str
new_account_key_content:
description:
- Content of the Let's Encrypt account RSA or Elliptic Curve key to change to.
- Same restrictions apply as to C(account_key_content).
- Mutually exclusive with C(new_account_key_src).
- Required if C(new_account_key_src) is not used and state is C(changed_key).
account_uri: description: ACME account URI, or None if account does not exist. returned: always type: string