Note
This plugin is part of the community.crypto collection (version 1.4.0).
To install it use: ansible-galaxy collection install community.crypto.
To use it in a playbook, specify: community.crypto.acme_account.
The below requirements are needed on the host that executes this module.
| 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_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 module. 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 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. 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 |
| 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. | |
| allow_creation boolean |
| Whether account creation is allowed (when state is present). | |
| contact list / elements=string | Default: [] | A list of contact URLs. Email addresses must be prefixed with mailto:.See https://tools.ietf.org/html/rfc8555#section-7.3 for what is allowed. Must be specified when state is present. Will be ignored if state is absent or changed_key. | |
| external_account_binding dictionary added in 1.1.0 of community.crypto | Allows to provide external account binding data during account creation. This is used by CAs like Sectigo to bind a new ACME account to an existing CA-specific account, to be able to properly identify a customer. Only used when creating a new account. Can not be specified for ACME v1. | ||
| alg string / required |
| The MAC algorithm provided by the CA. If not specified by the CA, this is probably HS256. | |
| key string / required | Base64 URL encoded value of the MAC key provided by the CA. Padding ( = symbols at the end) can be omitted. | ||
| kid string / required | The key identifier provided by the CA. | ||
| new_account_key_content string | Content of the ACME 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 | Path to a file containing the ACME 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. | ||
| select_crypto_backend string |
| 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. | |
| state string / required |
| 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 boolean |
| Boolean indicating whether you agree to the terms of service document. ACME servers can require this to be true. | |
| validate_certs boolean |
| 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. | |
Note
modify_account option of community.crypto.acme_certificate.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).See also
The specification of the ACME protocol (RFC 8555).
Retrieves facts about an ACME account.
Can be used to create a private account key.
Allows to debug problems.
- name: Make sure account exists and has given contacts. We agree to TOS.
community.crypto.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
community.crypto.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
community.crypto.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)
community.crypto.acme_account:
account_key_content: '{{ new_account_key }}'
state: absent
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. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/crypto/acme_account_module.html