community / community.crypto / 2.18.0 / module / acme_certificate_revoke Revoke certificates with the ACME protocol Authors: Felix Fontein (@felixfontein)community.crypto.acme_certificate_revoke (2.18.0) — module
Install with ansible-galaxy collection install community.crypto:==2.18.0
collections: - name: community.crypto version: 2.18.0
Allows to revoke certificates issued by a CA supporting the L(ACME protocol,https://tools.ietf.org/html/rfc8555), such as L(Let's Encrypt,https://letsencrypt.org/).
- 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
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 certificate: description: - Path to the certificate to revoke. required: true type: path acme_version: choices: - 1 - 2 description: - The ACME version of the endpoint. - Must be V(1) for the classic Let's Encrypt and Buypass ACME endpoints, or V(2) for standardized ACME v2 endpoints. - The value V(1) is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0. required: true type: int revoke_reason: description: - One of the revocation reasonCodes defined in L(Section 5.3.1 of RFC5280,https://tools.ietf.org/html/rfc5280#section-5.3.1). - Possible values are V(0) (unspecified), V(1) (keyCompromise), V(2) (cACompromise), V(3) (affiliationChanged), V(4) (superseded), V(5) (cessationOfOperation), V(6) (certificateHold), V(8) (removeFromCRL), V(9) (privilegeWithdrawn), V(10) (aACompromise). type: int acme_directory: description: - 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. - '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 B(Let's Encrypt), the production directory URL for ACME v2 is U(https://acme-v02.api.letsencrypt.org/directory). - For B(Buypass), the production directory URL for ACME v2 and v1 is U(https://api.buypass.com/acme/directory). - For B(ZeroSSL), the production directory URL for ACME v2 is U(https://acme.zerossl.com/v2/DV90). - For B(Sectigo), the production directory URL for ACME v2 is U(https://acme-qa.secure.trust-provider.com/v2/DV). - The notes for this module contain a list of ACME services this module has been tested against. required: true type: str validate_certs: default: true description: - Whether calls to the ACME directory will validate TLS certificates. - B(Warning:) Should B(only ever) be set to V(false) 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. - RSA keys can be created with C(openssl rsa ...). 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 O(account_key_content). - Required if O(account_key_content) is not used. type: path private_key_src: description: - Path to the certificate's private key. - Note that exactly one of O(account_key_src), O(account_key_content), O(private_key_src), or O(private_key_content) must be specified. type: path request_timeout: default: 10 description: - The time Ansible should wait for a response from the ACME API. - This timeout is applied to all HTTP(S) requests (HEAD, GET, POST). type: int version_added: 2.3.0 version_added_collection: community.crypto account_key_content: description: - Content of the ACME account RSA or Elliptic Curve key. - Note that exactly one of O(account_key_src), O(account_key_content), O(private_key_src), or O(private_key_content) must be specified. - "I(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 private_key_content: description: - Content of the certificate's private key. - Note that exactly one of O(account_key_src), O(account_key_content), O(private_key_src), or O(private_key_content) must be specified. - "I(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 select_crypto_backend: choices: - auto - cryptography - openssl default: auto description: - Determines which crypto backend to use. - The default choice is V(auto), which tries to use C(cryptography) if available, and falls back to C(openssl). - If set to V(openssl), will try to use the C(openssl) binary. - If set to V(cryptography), will try to use the L(cryptography,https://cryptography.io/) library. type: str account_key_passphrase: description: - Phassphrase to use to decode the account key. - B(Note:) this is not supported by the C(openssl) backend, only by the C(cryptography) backend. type: str version_added: 1.6.0 version_added_collection: community.crypto private_key_passphrase: description: - Phassphrase to use to decode the certificate's private key. - B(Note:) this is not supported by the C(openssl) backend, only by the C(cryptography) backend. type: str version_added: 1.6.0 version_added_collection: community.crypto