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_certificate_revoke.
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. Note that exactly one of account_key_src, account_key_content, private_key_src or private_key_content must be specified.
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. RSA keys can be created with openssl rsa .... 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 |
| 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. |
| certificate path / required | Path to the certificate to revoke. | |
| private_key_content string | Content of the certificate's private key. Note that exactly one of account_key_src, account_key_content, private_key_src or private_key_content must be specified.
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. | |
| private_key_passphrase string added in 1.6.0 of community.crypto | Phassphrase to use to decode the certificate's private key.
Note: this is not supported by the openssl backend, only by the cryptography backend. | |
| private_key_src path | Path to the certificate's private key. Note that exactly one of account_key_src, account_key_content, private_key_src or private_key_content must be specified. | |
| revoke_reason integer | One of the revocation reasonCodes defined in Section 5.3.1 of RFC5280. Possible values are 0 (unspecified), 1 (keyCompromise), 2 (cACompromise), 3 (affiliationChanged), 4 (superseded), 5 (cessationOfOperation), 6 (certificateHold), 8 (removeFromCRL), 9 (privilegeWithdrawn), 10 (aACompromise). | |
| 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. |
| 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
account_key_src, account_key_content, private_key_src or private_key_content must be specified.check_mode.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
Documentation for the Let’s Encrypt Certification Authority. Provides useful information for example on rate limits.
The specification of the ACME protocol (RFC 8555).
Allows to debug problems.
- name: Revoke certificate with account key
community.crypto.acme_certificate_revoke:
account_key_src: /etc/pki/cert/private/account.key
certificate: /etc/httpd/ssl/sample.com.crt
- name: Revoke certificate with certificate's private key
community.crypto.acme_certificate_revoke:
private_key_src: /etc/httpd/ssl/sample.com.key
certificate: /etc/httpd/ssl/sample.com.crt
© 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_certificate_revoke_module.html