Note
-This plugin was part of the community.crypto collection (version 2.26.1).
+This plugin was part of the community.crypto collection (version 3.0.0-dev0).
This module has been removed in version 2.0.0 of community.crypto. diff --git a/branch/main/acme_account_info_module.html b/branch/main/acme_account_info_module.html index b11f4e1e..11e595dd 100644 --- a/branch/main/acme_account_info_module.html +++ b/branch/main/acme_account_info_module.html @@ -183,7 +183,7 @@
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -282,15 +282,14 @@ see
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.
Must be 2 for standardized ACME v2 endpoints.
The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
1
2
2 ← (default)
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -282,15 +282,14 @@ see
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.
Must be 2 for standardized ACME v2 endpoints.
The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
1
2
2 ← (default)
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -244,15 +244,14 @@ see
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.
Must be 2 for standardized ACME v2 endpoints.
The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
1
2
2 ← (default)
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -282,15 +282,14 @@ see
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.
Must be 2 for standardized ACME v2 endpoints.
The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
1
2
2 ← (default)
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -294,15 +294,14 @@ see
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.
Must be 2 for standardized ACME v2 endpoints.
The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
1
2
2 ← (default)
URI to a terms of service document you agree to when using the ACME v1 service at acme_directory.
Default is latest gathered from acme_directory URL.
This option will only be used when acme_version is 1.
This option has no longer any effect.
Boolean indicating whether you agree to the terms of service document.
ACME servers can require this to be true.
-This option will only be used when acme_version is not 1.
Choices:
false ← (default)
data: "{{ sample_com_challenge }}"
# We use Let's Encrypt's ACME v2 endpoint
acme_directory: https://acme-v02.api.letsencrypt.org/directory
- acme_version: 2
# The following makes sure that if a chain with /CN=DST Root CA X3 in its issuer is provided
# as an alternative, it will be selected. These are the roots cross-signed by IdenTrust.
# As long as Let's Encrypt provides alternate chains with the cross-signed root(s) when
diff --git a/branch/main/acme_certificate_order_create_module.html b/branch/main/acme_certificate_order_create_module.html
index ddf081bd..1b96f747 100644
--- a/branch/main/acme_certificate_order_create_module.html
+++ b/branch/main/acme_certificate_order_create_module.html
@@ -183,7 +183,7 @@
community.crypto.acme_certificate_order_create module – Create an ACME v2 order
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -288,15 +288,14 @@ see
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.
+Must be 2 for standardized ACME v2 endpoints.
+The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
-1
2
2 ← (default)
- name: Create a challenge for sample.com using a account key file.
community.crypto.acme_certificate_order_create:
acme_directory: https://acme-v01.api.letsencrypt.org/directory
- acme_version: 2
account_key_src: /etc/pki/cert/private/account.key
csr: /etc/pki/cert/csr/sample.com.csr
register: sample_com_challenge
@@ -601,7 +599,6 @@ If - name: Let the challenge be validated
community.crypto.acme_certificate_order_validate:
acme_directory: https://acme-v01.api.letsencrypt.org/directory
- acme_version: 2
account_key_src: /etc/pki/cert/private/account.key
order_uri: "{{ sample_com_challenge.order_uri }}"
challenge: dns-01
@@ -609,7 +606,6 @@ If - name: Retrieve the cert and intermediate certificate
community.crypto.acme_certificate_order_finalize:
acme_directory: https://acme-v01.api.letsencrypt.org/directory
- acme_version: 2
account_key_src: /etc/pki/cert/private/account.key
csr: /etc/pki/cert/csr/sample.com.csr
order_uri: "{{ sample_com_challenge.order_uri }}"
diff --git a/branch/main/acme_certificate_order_finalize_module.html b/branch/main/acme_certificate_order_finalize_module.html
index 61963240..e177f0ff 100644
--- a/branch/main/acme_certificate_order_finalize_module.html
+++ b/branch/main/acme_certificate_order_finalize_module.html
@@ -183,7 +183,7 @@
community.crypto.acme_certificate_order_finalize module – Finalize an ACME v2 order
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -283,15 +283,14 @@ see
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.
+Must be 2 for standardized ACME v2 endpoints.
+The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
-1
2
2 ← (default)
community.crypto.acme_certificate_order_info module – Obtain information for an ACME v2 order
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -283,15 +283,14 @@ see
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.
+Must be 2 for standardized ACME v2 endpoints.
+The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
-1
2
2 ← (default)
community.crypto.acme_certificate_order_validate module – Validate authorizations of an ACME v2 order
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -283,15 +283,14 @@ see
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.
+Must be 2 for standardized ACME v2 endpoints.
+The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
-1
2
2 ← (default)
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.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -244,15 +244,14 @@ see
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.
+Must be 2 for standardized ACME v2 endpoints.
+The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
-1
2
2 ← (default)
community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -278,15 +278,14 @@ see
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.
+Must be 2 for standardized ACME v2 endpoints.
+The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
-1
2
2 ← (default)
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.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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 9ecbf207..8ddaeca3 100644
--- a/branch/main/acme_inspect_module.html
+++ b/branch/main/acme_inspect_module.html
@@ -183,7 +183,7 @@
community.crypto.acme_inspect module – Send direct requests to an ACME server
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -283,15 +283,14 @@ see
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.
+Must be 2 for standardized ACME v2 endpoints.
+The value 1 is no longer supported since community.crypto 3.0.0.
Choices:
-1
2
2 ← (default)
The account_uri option must be specified for properly authenticated ACME v2 requests (except a new-account request).
Using the ansible tool, community.crypto.acme_inspect can be used to directly execute ACME requests without the need of writing a playbook. For example, the following command retrieves the ACME account with ID 1 from Let’s Encrypt (assuming /path/to/key is the correct private account key): ansible localhost -m acme_inspect -a "account_key_src=/path/to/key acme_directory=https://acme-v02.api.letsencrypt.org/directory acme_version=2 account_uri=https://acme-v02.api.letsencrypt.org/acme/acct/1 method=get url=https://acme-v02.api.letsencrypt.org/acme/acct/1".
Using the ansible tool, community.crypto.acme_inspect can be used to directly execute ACME requests without the need of writing a playbook. For example, the following command retrieves the ACME account with ID 1 from Let’s Encrypt (assuming /path/to/key is the correct private account key): ansible localhost -m acme_inspect -a "account_key_src=/path/to/key acme_directory=https://acme-v02.api.letsencrypt.org/directory account_uri=https://acme-v02.api.letsencrypt.org/acme/acct/1 method=get url=https://acme-v02.api.letsencrypt.org/acme/acct/1".
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).
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.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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/crypto_info_module.html b/branch/main/crypto_info_module.html
index bf50fe8a..9b464b2a 100644
--- a/branch/main/crypto_info_module.html
+++ b/branch/main/crypto_info_module.html
@@ -179,7 +179,7 @@
community.crypto.crypto_info module – Retrieve cryptographic capabilities
Note
-This module is part of the community.crypto collection (version 2.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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_certificate_module.html b/branch/main/ecs_certificate_module.html
index c369fabe..90fc6d11 100644
--- a/branch/main/ecs_certificate_module.html
+++ b/branch/main/ecs_certificate_module.html
@@ -183,7 +183,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.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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 31688ff2..4a3c2815 100644
--- a/branch/main/ecs_domain_module.html
+++ b/branch/main/ecs_domain_module.html
@@ -183,7 +183,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.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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/get_certificate_module.html b/branch/main/get_certificate_module.html
index bab7b3a9..e7fda94d 100644
--- a/branch/main/get_certificate_module.html
+++ b/branch/main/get_certificate_module.html
@@ -183,7 +183,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.26.1).
+This module is part of the community.crypto collection (version 3.0.0-dev0).
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.
@@ -235,11 +235,11 @@ see Whether to encode the ASN.1 values in the extensions return value with Base64 or not.
The documentation claimed for a long time that the values are Base64 encoded, but they never were. For compatibility this option is set to false.
-The default value false is deprecated and will change to true in community.crypto 3.0.0.
+The default value was changed from false to true incommunity.crypto 3.0.0.
Choices:
false
true
true ← (default)
diff --git a/branch/main/gpg_fingerprint_filter.html b/branch/main/gpg_fingerprint_filter.html
index 38320b1d..720f8764 100644
--- a/branch/main/gpg_fingerprint_filter.html
+++ b/branch/main/gpg_fingerprint_filter.html
@@ -181,7 +181,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.26.1).
+This filter plugin is part of the community.crypto collection (version 3.0.0-dev0).
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 200cb81f..283f173b 100644
--- a/branch/main/gpg_fingerprint_lookup.html
+++ b/branch/main/gpg_fingerprint_lookup.html
@@ -180,7 +180,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.26.1).
+This lookup plugin is part of the community.crypto collection (version 3.0.0-dev0).
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 34edf67f..f235192c 100644
--- a/branch/main/index.html
+++ b/branch/main/index.html
@@ -164,7 +164,7 @@
Community.Crypto
-Collection version 2.26.1
+Collection version 3.0.0-dev0