From 374f91d026f164f325c637158c187f4e0bd2658c Mon Sep 17 00:00:00 2001 From: felixfontein Date: Sat, 11 May 2024 15:07:58 +0000 Subject: [PATCH] deploy: 00d23753caf37308752235c154a5842bf07265d7 --- branch/main/acme_account_facts_module.html | 5 +- branch/main/acme_account_info_module.html | 11 +- branch/main/acme_account_module.html | 7 +- branch/main/acme_ari_info_module.html | 499 ++++++++++++++++ ...e_certificate_deactivate_authz_module.html | 461 +++++++++++++++ branch/main/acme_certificate_module.html | 126 ++-- .../acme_certificate_renewal_info_module.html | 538 ++++++++++++++++++ .../main/acme_certificate_revoke_module.html | 11 +- .../acme_challenge_cert_helper_module.html | 5 +- branch/main/acme_inspect_module.html | 7 +- .../certificate_complete_chain_module.html | 5 +- branch/main/changelog.html | 3 + branch/main/crypto_info_module.html | 5 +- branch/main/docsite/guide_ownca.html | 3 + branch/main/docsite/guide_selfsigned.html | 3 + branch/main/ecs_certificate_module.html | 5 +- branch/main/ecs_domain_module.html | 5 +- branch/main/environment_variables.html | 3 + branch/main/get_certificate_module.html | 5 +- branch/main/gpg_fingerprint_filter.html | 5 +- branch/main/gpg_fingerprint_lookup.html | 5 +- branch/main/index.html | 8 +- branch/main/luks_device_module.html | 5 +- branch/main/objects.inv | Bin 16218 -> 16985 bytes branch/main/openssh_cert_module.html | 5 +- branch/main/openssh_keypair_module.html | 5 +- .../main/openssl_certificate_info_module.html | 5 +- branch/main/openssl_certificate_module.html | 5 +- branch/main/openssl_csr_info_filter.html | 5 +- branch/main/openssl_csr_info_module.html | 5 +- branch/main/openssl_csr_module.html | 5 +- branch/main/openssl_csr_pipe_module.html | 5 +- branch/main/openssl_dhparam_module.html | 5 +- branch/main/openssl_pkcs12_module.html | 5 +- .../openssl_privatekey_convert_module.html | 5 +- .../main/openssl_privatekey_info_filter.html | 5 +- .../main/openssl_privatekey_info_module.html | 5 +- branch/main/openssl_privatekey_module.html | 5 +- .../main/openssl_privatekey_pipe_module.html | 5 +- .../main/openssl_publickey_info_filter.html | 5 +- .../main/openssl_publickey_info_module.html | 5 +- branch/main/openssl_publickey_module.html | 5 +- .../main/openssl_signature_info_module.html | 5 +- branch/main/openssl_signature_module.html | 5 +- branch/main/parse_serial_filter.html | 5 +- branch/main/search.html | 3 + branch/main/searchindex.js | 2 +- branch/main/split_pem_filter.html | 5 +- branch/main/to_serial_filter.html | 5 +- .../main/x509_certificate_convert_module.html | 5 +- branch/main/x509_certificate_info_filter.html | 5 +- branch/main/x509_certificate_info_module.html | 5 +- branch/main/x509_certificate_module.html | 5 +- branch/main/x509_certificate_pipe_module.html | 5 +- branch/main/x509_crl_info_filter.html | 5 +- branch/main/x509_crl_info_module.html | 5 +- branch/main/x509_crl_module.html | 5 +- 57 files changed, 1794 insertions(+), 96 deletions(-) create mode 100644 branch/main/acme_ari_info_module.html create mode 100644 branch/main/acme_certificate_deactivate_authz_module.html create mode 100644 branch/main/acme_certificate_renewal_info_module.html diff --git a/branch/main/acme_account_facts_module.html b/branch/main/acme_account_facts_module.html index d32824fb..fe325f16 100644 --- a/branch/main/acme_account_facts_module.html +++ b/branch/main/acme_account_facts_module.html @@ -83,7 +83,10 @@ +
  • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
  • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
    • +
  • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
    • +
  • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
  • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
  • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
  • community.crypto.acme_inspect module – Send direct requests to an ACME server
    • @@ -178,7 +181,7 @@

    community.crypto.acme_account_info module – Retrieves information on ACME accounts

    Note

    -

    This module is part of the community.crypto collection (version 2.19.1).

    +

    This module is part of the community.crypto collection (version 2.20.0).

    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. @@ -393,9 +396,9 @@ see

  • The community.crypto.acme_account module allows to modify, create and delete ACME accounts.

  • This module was called acme_account_facts before Ansible 2.8. The usage did not change.

    • -

  • If a new enough version of the 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).

  • 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.

  • So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and Pebble testing server. We have got community feedback that they also work with Sectigo ACME Service for InCommon. 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.

    • +

  • If a new enough version of the 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).

    • @@ -681,7 +684,7 @@ see - +
    diff --git a/branch/main/acme_account_module.html b/branch/main/acme_account_module.html index e0d14bff..ac5df3d2 100644 --- a/branch/main/acme_account_module.html +++ b/branch/main/acme_account_module.html @@ -99,7 +99,10 @@
  • community.crypto.acme_account_info module – Retrieves information on ACME accounts
    • +
  • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
  • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
    • +
  • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
    • +
  • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
  • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
  • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
  • community.crypto.acme_inspect module – Send direct requests to an ACME server
    • @@ -178,7 +181,7 @@

    community.crypto.acme_account module – Create, modify or delete ACME accounts

    Note

    -

    This module is part of the community.crypto collection (version 2.19.1).

    +

    This module is part of the community.crypto collection (version 2.20.0).

    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. @@ -493,9 +496,9 @@ see Note

    diff --git a/branch/main/acme_ari_info_module.html b/branch/main/acme_ari_info_module.html new file mode 100644 index 00000000..db4c9b8a --- /dev/null +++ b/branch/main/acme_ari_info_module.html @@ -0,0 +1,499 @@ + + + + + + + + community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate — Community.Crypto Collection documentation + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + + +
    Community.Crypto Collection Docs
    +     +
    + + +
    + +
    +
    +
    +
      +
      • +
    • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
      • +
    • + + Edit on GitHub +
      • +
    +
    +
    +
    + + +
    + +
    +

    community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate

    +
    +

    Note

    +

    This module is part of the community.crypto collection (version 2.20.0).

    +

    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. +You need further requirements to be able to use this module, +see Requirements for details.

    +

    To use it in a playbook, specify: community.crypto.acme_ari_info.

    +
    +

    New in community.crypto 2.20.0

    + +
    +

    Synopsis

    + +
    +
    +

    Requirements

    +

    The below requirements are needed on the host that executes this module.

    + +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    Comments

    +

    acme_directory

    +

    string / required

    +

    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: 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.

    +

    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.

    +

    For Sectigo, the production directory URL for ACME v2 is 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.

    +
    +

    acme_version

    +

    integer / required

    +

    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 value 1 is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.

    +

    Choices:

    +
      +

    • 1

      • +

    • 2

      • +
    +
    +

    certificate_content

    +

    string

    +

    The content of the X.509 certificate to request information for.

    +

    Exactly one of certificate_path and certificate_content must be provided.

    +
    +

    certificate_path

    +

    path

    +

    A path to the X.509 certificate to request information for.

    +

    Exactly one of certificate_path and certificate_content must be provided.

    +
    +

    request_timeout

    +

    integer

    +

    added in community.crypto 2.3.0

    +

    The time Ansible should wait for a response from the ACME API.

    +

    This timeout is applied to all HTTP(S) requests (HEAD, GET, POST).

    +

    Default: 10

    +
    +

    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.

    +

    Choices:

    +
      +

    • "auto" ← (default)

      • +

    • "cryptography"

      • +

    • "openssl"

      • +
    +
    +

    validate_certs

    +

    boolean

    +

    Whether calls to the ACME directory will validate TLS certificates.

    +

    Warning: Should only ever be set to false for testing purposes, for example when testing against a local Pebble server.

    +

    Choices:

    +
      +

    • false

      • +

    • true ← (default)

      • +
    +
    +
    +
    +

    Attributes

    + + + + + + + + + + + + + + + + + +

    Attribute

    Support

    Description

    +

    check_mode

    +

    Support: full

    +

    This action does not modify state.

    +

    Can run in check_mode and return changed status prediction without modifying target.

    +
    +

    diff_mode

    +

    Support: N/A

    +

    This action does not modify state.

    +

    Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

    +
    +
    +
    +

    Notes

    +
    +

    Note

    +
      +

    • 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.

      • +

    • So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and Pebble testing server. We have got community feedback that they also work with Sectigo ACME Service for InCommon. 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.

      • +

    • If a new enough version of the 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.

      • +
    +
    +
    +
    +

    See Also

    +
    +

    See also

    +
    +
    community.crypto.acme_certificate

    Allows to obtain a certificate using the ACME protocol

    +
    +
    community.crypto.acme_certificate_revoke

    Allows to revoke a certificate using the ACME protocol

    +
    +
    +
    +
    +
    +

    Examples

    +
    - name: Retrieve renewal information for a certificate
+  community.crypto.acme_ari_info:
+    certificate_path: /etc/httpd/ssl/sample.com.crt
+  register: cert_data
+
+- name: Show the certificate renewal information
+  ansible.builtin.debug:
+    var: cert_data.renewal_info
+
    +
    +
    +
    +

    Return Values

    +

    Common return values are documented here, the following are the fields unique to this module:

    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Key

    Description

    +

    renewal_info

    +

    dictionary

    +

    The ARI renewal info object (https://www.ietf.org/archive/id/draft-ietf-acme-ari-03.html#section-4.2).

    +

    Returned: success

    +
    +

    explanationURL

    +

    string

    +

    A URL pointing to a page which may explain why the suggested renewal window is what it is.

    +

    For example, it may be a page explaining the CA’s dynamic load-balancing strategy, or a page documenting which certificates are affected by a mass revocation event. Should be shown to the user.

    +

    Returned: depends on the ACME server

    +

    Sample: "https://example.com/docs/ari"

    +
    +

    retryAfter

    +

    string

    +

    A timestamp before the next retry to ask for this information should not be made.

    +

    Returned: depends on the ACME server

    +

    Sample: "2024-04-29T01:17:10.236921+00:00"

    +
    +

    suggestedWindow

    +

    dictionary

    +

    Describes the window during which the certificate should be renewed.

    +

    Returned: always

    +
    +

    end

    +

    string

    +

    The end of the window during which the certificate should be renewed.

    +

    The format is specified in RFC 3339.

    +

    Returned: always

    +

    Sample: "2021-01-03T00:00:00Z"

    +
    +

    start

    +

    string

    +

    The start of the window during which the certificate should be renewed.

    +

    The format is specified in RFC 3339.

    +

    Returned: always

    +

    Sample: "2021-01-03T00:00:00Z"

    +
    +
    +

    Authors

    +
      +

    • Felix Fontein (@felixfontein)

      • +
    +
    + +
    +
    + + +
    +
    + + +
    + +
    + +
    +

    © Copyright Community.Crypto Contributors.

    +
    + + + + +
    +
    +
    +
    +
    + + + + \ No newline at end of file diff --git a/branch/main/acme_certificate_deactivate_authz_module.html b/branch/main/acme_certificate_deactivate_authz_module.html new file mode 100644 index 00000000..54c826b2 --- /dev/null +++ b/branch/main/acme_certificate_deactivate_authz_module.html @@ -0,0 +1,461 @@ + + + + + + + + community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order — Community.Crypto Collection documentation + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + + +
    Community.Crypto Collection Docs
    +     +
    + + +
    + +
    +
    +
    +
      +
      • +
    • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
      • +
    • + + Edit on GitHub +
      • +
    +
    +
    +
    + + +
    + +
    +

    community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order

    +
    +

    Note

    +

    This module is part of the community.crypto collection (version 2.20.0).

    +

    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. +You need further requirements to be able to use this module, +see Requirements for details.

    +

    To use it in a playbook, specify: community.crypto.acme_certificate_deactivate_authz.

    +
    +

    New in community.crypto 2.20.0

    + +
    +

    Synopsis

    +
      +

    • Deactivate all authentication objects (authz) for an ACME v2 order, which effectively deactivates (invalidates) the order itself.

      • +

    • Authentication objects are bound to an account key and remain valid for a certain amount of time, and can be used to issue certificates without having to re-authenticate the domain. This can be a security concern.

      • +

    • Another reason to use this module is to deactivate an order whose processing failed when using include_renewal_cert_id.

      • +
    +
    +
    +

    Requirements

    +

    The below requirements are needed on the host that executes this module.

    + +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    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_passphrase

    +

    string

    +

    added in community.crypto 1.6.0

    +

    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

    +

    aliases: account_key

    +

    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 or community.crypto.openssl_privatekey_pipe modules. If the requisite (cryptography) is 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.

    +
    +

    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 / required

    +

    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: 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.

    +

    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.

    +

    For Sectigo, the production directory URL for ACME v2 is 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.

    +
    +

    acme_version

    +

    integer / required

    +

    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 value 1 is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.

    +

    Choices:

    +
      +

    • 1

      • +

    • 2

      • +
    +
    +

    order_uri

    +

    string / required

    +

    The ACME v2 order to deactivate.

    +

    Can be obtained from order_uri.

    +
    +

    request_timeout

    +

    integer

    +

    added in community.crypto 2.3.0

    +

    The time Ansible should wait for a response from the ACME API.

    +

    This timeout is applied to all HTTP(S) requests (HEAD, GET, POST).

    +

    Default: 10

    +
    +

    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.

    +

    Choices:

    +
      +

    • "auto" ← (default)

      • +

    • "cryptography"

      • +

    • "openssl"

      • +
    +
    +

    validate_certs

    +

    boolean

    +

    Whether calls to the ACME directory will validate TLS certificates.

    +

    Warning: Should only ever be set to false for testing purposes, for example when testing against a local Pebble server.

    +

    Choices:

    +
      +

    • false

      • +

    • true ← (default)

      • +
    +
    +
    +
    +

    Attributes

    + + + + + + + + + + + + + + + + + + + + + +

    Attribute

    Support

    Description

    +

    action_group

    +

    Action groups: community.crypto.acme, acme

    +

    Use group/acme or group/community.crypto.acme in module_defaults to set defaults for this module.

    +
    +

    check_mode

    +

    Support: full

    +

    Can run in check_mode and return changed status prediction without modifying target.

    +
    +

    diff_mode

    +

    Support: none

    +

    Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

    +
    +
    +
    +

    Notes

    +
    +

    Note

    +
      +

    • 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.

      • +

    • So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and Pebble testing server. We have got community feedback that they also work with Sectigo ACME Service for InCommon. 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.

      • +

    • If a new enough version of the 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

    +
    +

    See also

    +
    +
    community.crypto.acme_certificate

    Create SSL/TLS certificates with the ACME protocol.

    +
    +
    +
    +
    +
    +

    Examples

    +
    - name: Deactivate all authzs for an order
+  community.crypto.acme_certificate_deactivate_authz:
+    account_key_content: "{{ account_private_key }}"
+    order_uri: "{{ certificate_result.order_uri }}"
+
    +
    +
    +

    Authors

    +
      +

    • Felix Fontein (@felixfontein)

      • +
    +
    + +
    +
    + + +
    +
    + + +
    + +
    + +
    +

    © Copyright Community.Crypto Contributors.

    +
    + + + + +
    +
    +
    +
    +
    + + + + \ No newline at end of file diff --git a/branch/main/acme_certificate_module.html b/branch/main/acme_certificate_module.html index d9c1aef0..ce0e0957 100644 --- a/branch/main/acme_certificate_module.html +++ b/branch/main/acme_certificate_module.html @@ -24,8 +24,8 @@ - - + + @@ -85,6 +85,7 @@ @@ -638,7 +660,7 @@ see Automatic Certificate Management Environment (ACME)

    The specification of the ACME protocol (RFC 8555).

    -
    ACME TLS ALPN Challenge Extension

    The specification of the tls-alpn-01 challenge (RFC 8737).

    +
    ACME TLS ALPN Challenge Extension

    The specification of the tls-alpn-01 challenge (RFC 8737).

    community.crypto.acme_challenge_cert_helper

    Helps preparing tls-alpn-01 challenges.

    @@ -658,6 +680,8 @@ see community.crypto.acme_inspect

    Allows to debug problems.

    +
    community.crypto.acme_certificate_deactivate_authz

    Allows to deactivate (invalidate) ACME v2 orders.

    +
    @@ -743,7 +767,7 @@ see # state: present # wait: true # # Note: route53 requires TXT entries to be enclosed in quotes -# value: "{{ sample_com_challenge.challenge_data['sample.com']['dns-01'].resource_value | regex_replace('^(.*)$', '\"\\1\"') }}" +# value: "{{ sample_com_challenge.challenge_data['sample.com']['dns-01'].resource_value | community.dns.quote_txt(always_quote=true) }}" # when: sample_com_challenge is changed and 'sample.com' in sample_com_challenge.challenge_data # # Alternative way: @@ -758,7 +782,7 @@ see # wait: true # # Note: item.value is a list of TXT entries, and route53 # # requires every entry to be enclosed in quotes -# value: "{{ item.value | map('regex_replace', '^(.*)$', '\"\\1\"' ) | list }}" +# value: "{{ item.value | map('community.dns.quote_txt', always_quote=true) | list }}" # loop: "{{ sample_com_challenge.challenge_data_dns | dict2items }}" # when: sample_com_challenge is changed @@ -876,7 +900,7 @@ see

    challenge_data

    -

    list / elements=dictionary

    +

    dictionary

    Per identifier / challenge type challenge data.

    Since Ansible 2.8.5, only challenges which are not yet valid are returned.

    @@ -884,37 +908,57 @@ see
    -

    record

    -

    string

    +

    identifier

    +

    dictionary

    -

    The full DNS record’s name for the challenge.

    +

    For every identifier, provides a dictionary of challenge types mapping to challenge data.

    +

    The keys in this dictionary are the identifiers. identifier is a placeholder used in the documentation.

    +

    Note that the keys are not valid Jinja2 identifiers.

    +

    Returned: changed

    +
    + +
    +

    challenge-type

    +

    dictionary

    +
    +

    Data for every challenge type.

    +

    The keys in this dictionary are the challenge types. challenge-type is a placeholder used in the documentation. Possible keys are http-01, dns-01, and tls-alpn-01.

    +

    Note that the keys are not valid Jinja2 identifiers.

    +

    Returned: changed

    +
    + +
    +

    record

    +

    string

    +
    +

    The full DNS record’s name for the challenge.

    Returned: changed and challenge is dns-01

    Sample: "_acme-challenge.example.com"

    -
    -

    resource

    -

    string

    +
    +

    resource

    +

    string

    -

    The challenge resource that must be created for validation.

    +

    The challenge resource that must be created for validation.

    Returned: changed

    Sample: ".well-known/acme-challenge/evaGxfADs6pSRb2LAv9IZf17Dt3juxGJ-PCt92wr-oA"

    -
    -

    resource_original

    -

    string

    +
    +

    resource_original

    +

    string

    -

    The original challenge resource including type identifier for tls-alpn-01 challenges.

    +

    The original challenge resource including type identifier for tls-alpn-01 challenges.

    Returned: changed and challenge is tls-alpn-01

    Sample: "DNS:example.com"

    -
    -

    resource_value

    -

    string

    +
    +

    resource_value

    +

    string

    -

    The value the resource has to produce for the validation.

    +

    The value the resource has to produce for the validation.

    For http-01 and dns-01 challenges, the value can be used as-is.

    For tls-alpn-01 challenges, note that this return value contains a Base64 encoded version of the correct binary blob which has to be put into the acmeValidation x509 extension; see https://www.rfc-editor.org/rfc/rfc8737.html#section-3 for details. To do this, you might need the ansible.builtin.b64decode Jinja filter to extract the binary blob from this return value.

    Returned: changed

    @@ -973,8 +1017,8 @@ see - - + +
    diff --git a/branch/main/acme_certificate_renewal_info_module.html b/branch/main/acme_certificate_renewal_info_module.html new file mode 100644 index 00000000..18142c8d --- /dev/null +++ b/branch/main/acme_certificate_renewal_info_module.html @@ -0,0 +1,538 @@ + + + + + + + + community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not — Community.Crypto Collection documentation + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + + +
    Community.Crypto Collection Docs
    +     +
    + + +
    + +
    +
    +
    +
      +
      • +
    • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
      • +
    • + + Edit on GitHub +
      • +
    +
    +
    +
    + + +
    + +
    +

    community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not

    +
    +

    Note

    +

    This module is part of the community.crypto collection (version 2.20.0).

    +

    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. +You need further requirements to be able to use this module, +see Requirements for details.

    +

    To use it in a playbook, specify: community.crypto.acme_certificate_renewal_info.

    +
    +

    New in community.crypto 2.20.0

    + +
    +

    Synopsis

    +
      +

    • Uses various information to determine whether a certificate should be renewed or not.

      • +

    • If available, the ARI extension (ACME Renewal Information, https://datatracker.ietf.org/doc/draft-ietf-acme-ari/) is used. This module implements version 3 of the ARI draft.”

      • +
    +
    +
    +

    Requirements

    +

    The below requirements are needed on the host that executes this module.

    + +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    Comments

    +

    acme_directory

    +

    string / required

    +

    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: 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.

    +

    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.

    +

    For Sectigo, the production directory URL for ACME v2 is 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.

    +
    +

    acme_version

    +

    integer / required

    +

    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 value 1 is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.

    +

    Choices:

    +
      +

    • 1

      • +

    • 2

      • +
    +
    +

    ari_algorithm

    +

    string

    +

    If ARI information is used, selects which algorithm is used to determine whether to renew now.

    +

    standard selects the algorithm provided in the the ARI specification.

    +

    start returns should_renew=true once the start of the renewal interval has been reached.

    +

    Choices:

    +
      +

    • "standard" ← (default)

      • +

    • "start"

      • +
    +
    +

    certificate_content

    +

    string

    +

    The content of the X.509 certificate to determine renewal of.

    +

    certificate_path and certificate_content are mutually exclusive.

    +
    +

    certificate_path

    +

    path

    +

    A path to the X.509 certificate to determine renewal of.

    +

    In case the certificate does not exist, the module will always return should_renew=true.

    +

    certificate_path and certificate_content are mutually exclusive.

    +
    +

    now

    +

    string

    +

    Use this timestamp instead of the current timestamp to determine whether a certificate should be renewed.

    +

    Time can be specified either as relative time or as absolute timestamp.

    +

    Time will always be interpreted as UTC.

    +

    Valid format is [+-]timespec | ASN.1 TIME where timespec can be an integer + [w | d | h | m | s] (for example +32w1d2h).

    +
    +

    remaining_days

    +

    integer

    +

    The number of days the certificate must have left being valid.

    +

    For example, if remaining_days=20, this check causes should_renew=true if the certificate is valid for less than 20 days.

    +
    +

    remaining_percentage

    +

    float

    +

    The percentage of the certificate’s validity period that should be left.

    +

    For example, if remaining_percentage=0.1, and the certificate’s validity period is 90 days, this check causes should_renew=true if the certificate is valid for less than 9 days.

    +

    Must be a value between 0 and 1.

    +
    +

    request_timeout

    +

    integer

    +

    added in community.crypto 2.3.0

    +

    The time Ansible should wait for a response from the ACME API.

    +

    This timeout is applied to all HTTP(S) requests (HEAD, GET, POST).

    +

    Default: 10

    +
    +

    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.

    +

    Choices:

    +
      +

    • "auto" ← (default)

      • +

    • "cryptography"

      • +

    • "openssl"

      • +
    +
    +

    use_ari

    +

    boolean

    +

    Whether to use ARI information, if available.

    +

    Set this to false if the ACME server implements ARI in a way that is incompatible with this module.

    +

    Choices:

    +
      +

    • false

      • +

    • true ← (default)

      • +
    +
    +

    validate_certs

    +

    boolean

    +

    Whether calls to the ACME directory will validate TLS certificates.

    +

    Warning: Should only ever be set to false for testing purposes, for example when testing against a local Pebble server.

    +

    Choices:

    +
      +

    • false

      • +

    • true ← (default)

      • +
    +
    +
    +
    +

    Attributes

    + + + + + + + + + + + + + + + + + +

    Attribute

    Support

    Description

    +

    check_mode

    +

    Support: full

    +

    This action does not modify state.

    +

    Can run in check_mode and return changed status prediction without modifying target.

    +
    +

    diff_mode

    +

    Support: N/A

    +

    This action does not modify state.

    +

    Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

    +
    +
    +
    +

    Notes

    +
    +

    Note

    +
      +

    • 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.

      • +

    • So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and Pebble testing server. We have got community feedback that they also work with Sectigo ACME Service for InCommon. 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.

      • +

    • If a new enough version of the 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.

      • +
    +
    +
    +
    +

    See Also

    +
    +

    See also

    +
    +
    community.crypto.acme_certificate

    Allows to obtain a certificate using the ACME protocol

    +
    +
    community.crypto.acme_ari_info

    Obtain renewal information for a certificate

    +
    +
    +
    +
    +
    +

    Examples

    +
    - name: Retrieve renewal information for a certificate
+  community.crypto.acme_certificate_renewal_info:
+    certificate_path: /etc/httpd/ssl/sample.com.crt
+  register: cert_data
+
+- name: Should the certificate be renewed?
+  ansible.builtin.debug:
+    var: cert_data.should_renew
+
    +
    +
    +
    +

    Return Values

    +

    Common return values are documented here, the following are the fields unique to this module:

    + + + + + + + + + + + + + + + + + + + + +

    Key

    Description

    +

    cert_id

    +

    string

    +

    The certificate ID according to the ARI specification.

    +

    Returned: success, the certificate exists, and has an Authority Key Identifier X.509 extension

    +

    Sample: "aYhba4dGQEHhs3uEe6CuLN4ByNQ.AIdlQyE"

    +
    +

    msg

    +

    string

    +

    Information on the reason for renewal.

    +

    Should be shown to the user, as in case of ARI triggered renewal it can contain important information, for example on forced revocations for misissued certificates.

    +

    Returned: success

    +

    Sample: "The certificate does not exist."

    +
    +

    should_renew

    +

    boolean

    +

    Whether the certificate should be renewed.

    +

    If no certificate is provided, or the certificate is expired, will always be true.

    +

    Returned: success

    +

    Sample: true

    +
    +

    supports_ari

    +

    boolean

    +

    Whether ARI information was used to determine renewal. This can be used to determine whether to specify include_renewal_cert_id=when_ari_supported for the community.crypto.acme_certificate module.

    +

    If use_ari=false, this will always be false.

    +

    Returned: success

    +

    Sample: true

    +
    +
    +

    Authors

    +
      +

    • Felix Fontein (@felixfontein)

      • +
    +
    + +
    +
    + + +
    +
    + + +
    + +
    + +
    +

    © Copyright Community.Crypto Contributors.

    +
    + + + + +
    +
    +
    +
    +
    + + + + \ No newline at end of file diff --git a/branch/main/acme_certificate_revoke_module.html b/branch/main/acme_certificate_revoke_module.html index 00d859a6..ddd86132 100644 --- a/branch/main/acme_certificate_revoke_module.html +++ b/branch/main/acme_certificate_revoke_module.html @@ -25,7 +25,7 @@ - + @@ -85,7 +85,10 @@
    @@ -471,7 +474,7 @@ see - +
    diff --git a/branch/main/acme_challenge_cert_helper_module.html b/branch/main/acme_challenge_cert_helper_module.html index fac91b5c..c9c161b4 100644 --- a/branch/main/acme_challenge_cert_helper_module.html +++ b/branch/main/acme_challenge_cert_helper_module.html @@ -85,7 +85,10 @@
    • community.crypto.acme_account module – Create, modify or delete ACME accounts
    • community.crypto.acme_account_info module – Retrieves information on ACME accounts
      • +
    • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
    • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
      • +
    • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
      • +
    • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
    • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
    • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
      • Synopsis
        • @@ -177,7 +180,7 @@

        community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01

        Note

        -

        This module is part of the community.crypto collection (version 2.19.1).

        +

        This module is part of the community.crypto collection (version 2.20.0).

        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. diff --git a/branch/main/acme_inspect_module.html b/branch/main/acme_inspect_module.html index 24537b85..ecb0c46e 100644 --- a/branch/main/acme_inspect_module.html +++ b/branch/main/acme_inspect_module.html @@ -85,7 +85,10 @@

        diff --git a/branch/main/certificate_complete_chain_module.html b/branch/main/certificate_complete_chain_module.html index 6949467d..dbc194ac 100644 --- a/branch/main/certificate_complete_chain_module.html +++ b/branch/main/certificate_complete_chain_module.html @@ -85,7 +85,10 @@
        • community.crypto.acme_account module – Create, modify or delete ACME accounts
        • community.crypto.acme_account_info module – Retrieves information on ACME accounts
          • +
        • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
        • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
          • +
        • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
          • +
        • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
        • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
        • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
        • community.crypto.acme_inspect module – Send direct requests to an ACME server
          • @@ -176,7 +179,7 @@

          community.crypto.certificate_complete_chain module – Complete certificate chain given a set of untrusted and root certificates

          Note

          -

          This module is part of the community.crypto collection (version 2.19.1).

          +

          This module is part of the community.crypto collection (version 2.20.0).

          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. diff --git a/branch/main/changelog.html b/branch/main/changelog.html index 3b3aae73..1657fd08 100644 --- a/branch/main/changelog.html +++ b/branch/main/changelog.html @@ -425,7 +425,10 @@

          • community.crypto.acme_account module – Create, modify or delete ACME accounts
          • community.crypto.acme_account_info module – Retrieves information on ACME accounts
            • +
          • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
          • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
            • +
          • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
            • +
          • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
          • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
          • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
          • community.crypto.acme_inspect module – Send direct requests to an ACME server
            • diff --git a/branch/main/crypto_info_module.html b/branch/main/crypto_info_module.html index 408d2207..915d1704 100644 --- a/branch/main/crypto_info_module.html +++ b/branch/main/crypto_info_module.html @@ -85,7 +85,10 @@
            • community.crypto.acme_account module – Create, modify or delete ACME accounts
            • community.crypto.acme_account_info module – Retrieves information on ACME accounts
              • +
            • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
            • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
              • +
            • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
              • +
            • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
            • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
            • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
            • community.crypto.acme_inspect module – Send direct requests to an ACME server
              • @@ -174,7 +177,7 @@

              community.crypto.crypto_info module – Retrieve cryptographic capabilities

              Note

              -

              This module is part of the community.crypto collection (version 2.19.1).

              +

              This module is part of the community.crypto collection (version 2.20.0).

              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.

              diff --git a/branch/main/docsite/guide_ownca.html b/branch/main/docsite/guide_ownca.html index d2c6fe3a..224c3b83 100644 --- a/branch/main/docsite/guide_ownca.html +++ b/branch/main/docsite/guide_ownca.html @@ -88,7 +88,10 @@
              • community.crypto.acme_account module – Create, modify or delete ACME accounts
              • community.crypto.acme_account_info module – Retrieves information on ACME accounts
                • +
              • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
              • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
                • +
              • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
                • +
              • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
              • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
              • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
              • community.crypto.acme_inspect module – Send direct requests to an ACME server
                • diff --git a/branch/main/docsite/guide_selfsigned.html b/branch/main/docsite/guide_selfsigned.html index 5fa254ab..d5ed1bde 100644 --- a/branch/main/docsite/guide_selfsigned.html +++ b/branch/main/docsite/guide_selfsigned.html @@ -84,7 +84,10 @@
                • community.crypto.acme_account module – Create, modify or delete ACME accounts
                • community.crypto.acme_account_info module – Retrieves information on ACME accounts
                  • +
                • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
                • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
                  • +
                • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
                  • +
                • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
                • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
                • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
                • community.crypto.acme_inspect module – Send direct requests to an ACME server
                  • diff --git a/branch/main/ecs_certificate_module.html b/branch/main/ecs_certificate_module.html index 3360446e..ef66016c 100644 --- a/branch/main/ecs_certificate_module.html +++ b/branch/main/ecs_certificate_module.html @@ -85,7 +85,10 @@
                  • community.crypto.acme_account module – Create, modify or delete ACME accounts
                  • community.crypto.acme_account_info module – Retrieves information on ACME accounts
                    • +
                  • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
                  • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
                    • +
                  • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
                    • +
                  • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
                  • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
                  • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
                  • community.crypto.acme_inspect module – Send direct requests to an ACME server
                    • @@ -178,7 +181,7 @@

                    community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API

                    Note

                    -

                    This module is part of the community.crypto collection (version 2.19.1).

                    +

                    This module is part of the community.crypto collection (version 2.20.0).

                    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. diff --git a/branch/main/ecs_domain_module.html b/branch/main/ecs_domain_module.html index 3df8689b..8d9a63bb 100644 --- a/branch/main/ecs_domain_module.html +++ b/branch/main/ecs_domain_module.html @@ -85,7 +85,10 @@

                    • community.crypto.acme_account module – Create, modify or delete ACME accounts
                    • community.crypto.acme_account_info module – Retrieves information on ACME accounts
                      • +
                    • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
                    • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
                      • +
                    • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
                      • +
                    • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
                    • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
                    • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
                    • community.crypto.acme_inspect module – Send direct requests to an ACME server
                      • @@ -178,7 +181,7 @@

                      community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API

                      Note

                      -

                      This module is part of the community.crypto collection (version 2.19.1).

                      +

                      This module is part of the community.crypto collection (version 2.20.0).

                      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. diff --git a/branch/main/environment_variables.html b/branch/main/environment_variables.html index 8d6c5da0..90a60311 100644 --- a/branch/main/environment_variables.html +++ b/branch/main/environment_variables.html @@ -83,7 +83,10 @@

                      • community.crypto.acme_account module – Create, modify or delete ACME accounts
                      • community.crypto.acme_account_info module – Retrieves information on ACME accounts
                        • +
                      • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
                      • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
                        • +
                      • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
                        • +
                      • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
                      • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
                      • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
                      • community.crypto.acme_inspect module – Send direct requests to an ACME server
                        • diff --git a/branch/main/get_certificate_module.html b/branch/main/get_certificate_module.html index 46ebc687..0ca66b85 100644 --- a/branch/main/get_certificate_module.html +++ b/branch/main/get_certificate_module.html @@ -85,7 +85,10 @@
                        • community.crypto.acme_account module – Create, modify or delete ACME accounts
                        • community.crypto.acme_account_info module – Retrieves information on ACME accounts
                          • +
                        • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
                        • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
                          • +
                        • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
                          • +
                        • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
                        • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
                        • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
                        • community.crypto.acme_inspect module – Send direct requests to an ACME server
                          • @@ -178,7 +181,7 @@

                          community.crypto.get_certificate module – Get a certificate from a host:port

                          Note

                          -

                          This module is part of the community.crypto collection (version 2.19.1).

                          +

                          This module is part of the community.crypto collection (version 2.20.0).

                          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. diff --git a/branch/main/gpg_fingerprint_filter.html b/branch/main/gpg_fingerprint_filter.html index 37011e76..08a21e29 100644 --- a/branch/main/gpg_fingerprint_filter.html +++ b/branch/main/gpg_fingerprint_filter.html @@ -85,7 +85,10 @@

                          • community.crypto.acme_account module – Create, modify or delete ACME accounts
                          • community.crypto.acme_account_info module – Retrieves information on ACME accounts
                            • +
                          • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
                          • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
                            • +
                          • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
                            • +
                          • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
                          • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
                          • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
                          • community.crypto.acme_inspect module – Send direct requests to an ACME server
                            • @@ -176,7 +179,7 @@

                            community.crypto.gpg_fingerprint filter – Retrieve a GPG fingerprint from a GPG public or private key

                            Note

                            -

                            This filter plugin is part of the community.crypto collection (version 2.19.1).

                            +

                            This filter plugin is part of the community.crypto collection (version 2.20.0).

                            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. diff --git a/branch/main/gpg_fingerprint_lookup.html b/branch/main/gpg_fingerprint_lookup.html index f170c26a..ac5bb6a9 100644 --- a/branch/main/gpg_fingerprint_lookup.html +++ b/branch/main/gpg_fingerprint_lookup.html @@ -84,7 +84,10 @@

                            • community.crypto.acme_account module – Create, modify or delete ACME accounts
                            • community.crypto.acme_account_info module – Retrieves information on ACME accounts
                              • +
                            • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
                            • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
                              • +
                            • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
                              • +
                            • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
                            • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
                            • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
                            • community.crypto.acme_inspect module – Send direct requests to an ACME server
                              • @@ -175,7 +178,7 @@

                              community.crypto.gpg_fingerprint lookup – Retrieve a GPG fingerprint from a GPG public or private key file

                              Note

                              -

                              This lookup plugin is part of the community.crypto collection (version 2.19.1).

                              +

                              This lookup plugin is part of the community.crypto collection (version 2.20.0).

                              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. diff --git a/branch/main/index.html b/branch/main/index.html index edbb7a1c..deb8954a 100644 --- a/branch/main/index.html +++ b/branch/main/index.html @@ -84,7 +84,10 @@

                              • community.crypto.acme_account module – Create, modify or delete ACME accounts
                              • community.crypto.acme_account_info module – Retrieves information on ACME accounts
                                • +
                              • community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate
                              • community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol
                                • +
                              • community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order
                                • +
                              • community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not
                              • community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
                              • community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as tls-alpn-01
                              • community.crypto.acme_inspect module – Send direct requests to an ACME server
                                • @@ -159,7 +162,7 @@

                                Community.Crypto

                                -

                                Collection version 2.19.1

                                +

                                Collection version 2.20.0