community.crypto.acme_certificate_revoke – Revoke certificates with the ACME protocol
community.crypto.acme_certificate_revoke – Revoke certificates with the ACME protocol
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_certificate_revoke
.
Synopsis
- Allows to revoke certificates issued by a CA supporting the ACME protocol, such as Let’s Encrypt.
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 |
Content of the ACME account RSA or Elliptic Curve key. Note that exactly one of 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 | |
account_key_src path |
Path to a file containing the ACME account RSA or Elliptic Curve key. RSA keys can be created with Mutually exclusive with Required if
| |
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.
| |
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 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 | |
private_key_src path |
Path to the certificate's private key. Note that exactly one of | |
revoke_reason integer |
One of the revocation reasonCodes defined in Section 5.3.1 of RFC5280. Possible values are | |
select_crypto_backend string |
|
Determines which crypto backend to use. The default choice is If set to If set to |
validate_certs boolean |
|
Whether calls to the ACME directory will validate TLS certificates.
|
Notes
Note
- Exactly one of
account_key_src
,account_key_content
,private_key_src
orprivate_key_content
must be specified. - Trying to revoke an already revoked certificate should result in an unchanged status, even if the revocation reason was different than the one specified here. Also, depending on the server, it can happen that some other error is returned if the certificate has already been revoked.
- Does not support
check_mode
. - If a new enough version of the
cryptography
library is available (see Requirements for details), it will be used instead of theopenssl
binary. This can be explicitly disabled or enabled with theselect_crypto_backend
option. Note that using theopenssl
binary will be slower and less secure, as private key contents always have to be stored on disk (seeaccount_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
- The Let’s Encrypt documentation
- Documentation for the Let’s Encrypt Certification Authority. Provides useful information for example on rate limits.
- Automatic Certificate Management Environment (ACME)
- The specification of the ACME protocol (RFC 8555).
- community.crypto.acme_inspect
- Allows to debug problems.
Examples
- 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
Authors
- Felix Fontein (@felixfontein)
© 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_certificate_revoke_module.html