summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/crypto/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-18 05:52:22 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-18 05:52:22 +0000
commit38b7c80217c4e72b1d8988eb1e60bb6e77334114 (patch)
tree356e9fd3762877d07cde52d21e77070aeff7e789 /ansible_collections/community/crypto/README.md
parentAdding upstream version 7.7.0+dfsg. (diff)
downloadansible-38b7c80217c4e72b1d8988eb1e60bb6e77334114.tar.xz
ansible-38b7c80217c4e72b1d8988eb1e60bb6e77334114.zip
Adding upstream version 9.4.0+dfsg.upstream/9.4.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/community/crypto/README.md')
-rw-r--r--ansible_collections/community/crypto/README.md82
1 files changed, 46 insertions, 36 deletions
diff --git a/ansible_collections/community/crypto/README.md b/ansible_collections/community/crypto/README.md
index d0ae6489f..64ffd4eae 100644
--- a/ansible_collections/community/crypto/README.md
+++ b/ansible_collections/community/crypto/README.md
@@ -18,7 +18,7 @@ Please note that this collection does **not** support Windows targets.
## Tested with Ansible
-Tested with the current Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12, ansible-core 2.13, and ansible-core 2.14 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.
+Tested with the current Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12, ansible-core 2.13, ansible-core 2.14, ansible-core 2.15, and ansible-core-2.16 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.
## External requirements
@@ -38,39 +38,49 @@ If you use the Ansible package and do not update collections independently, use
## Included content
-- OpenSSL / PKI modules:
- - openssl_csr_info
- - openssl_csr
- - openssl_dhparam
- - openssl_pkcs12
- - openssl_privatekey_info
- - openssl_privatekey
- - openssl_publickey
- - openssl_signature_info
- - openssl_signature
- - x509_certificate_info
- - x509_certificate
- - x509_crl_info
- - x509_crl
- - certificate_complete_chain
-- OpenSSH modules:
- - openssh_cert
- - openssh_keypair
-- ACME modules:
- - acme_account_info
- - acme_account
- - acme_certificate
- - acme_certificate_revoke
- - acme_challenge_cert_helper
- - acme_inspect
-- ECS modules:
- - ecs_certificate
- - ecs_domain
-- Miscellaneous modules:
- - get_certificate
- - luks_device
-
-You can also find a list of all modules with documentation on the [Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/crypto/).
+- OpenSSL / PKI modules and plugins:
+ - certificate_complete_chain module
+ - openssl_csr_info module and filter
+ - openssl_csr_pipe module
+ - openssl_csr module
+ - openssl_dhparam module
+ - openssl_pkcs12 module
+ - openssl_privatekey_convert module
+ - openssl_privatekey_info module and filter
+ - openssl_privatekey_pipe module
+ - openssl_privatekey module
+ - openssl_publickey_info module and filter
+ - openssl_publickey module
+ - openssl_signature_info module
+ - openssl_signature module
+ - split_pem filter
+ - x509_certificate_info module and filter
+ - x509_certificate_pipe module
+ - x509_certificate module
+ - x509_crl_info module and filter
+ - x509_crl module
+- OpenSSH modules and plugins:
+ - openssh_cert module
+ - openssh_keypair module
+- ACME modules and plugins:
+ - acme_account_info module
+ - acme_account module
+ - acme_certificate module
+ - acme_certificate_revoke module
+ - acme_challenge_cert_helper module
+ - acme_inspect module
+- ECS modules and plugins:
+ - ecs_certificate module
+ - ecs_domain module
+- GnuPG modules and plugins:
+ - gpg_fingerprint lookup and filter
+- Miscellaneous modules and plugins:
+ - crypto_info module
+ - get_certificate module
+ - luks_device module
+ - parse_serial and to_serial filters
+
+You can also find a list of all modules and plugins with documentation on the [Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/crypto/), or the [latest commit collection documentation](https://ansible-collections.github.io/community.crypto/branch/main/).
## Using this collection
@@ -102,7 +112,7 @@ See [Ansible's dev guide](https://docs.ansible.com/ansible/devel/dev_guide/devel
## Release notes
-See the [changelog](https://github.com/ansible-collections/community.crypto/blob/main/CHANGELOG.rst).
+See the [changelog](https://github.com/ansible-collections/community.crypto/blob/main/CHANGELOG.md).
## Roadmap
@@ -129,6 +139,6 @@ This collection is primarily licensed and distributed as a whole under the GNU G
See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.crypto/blob/main/COPYING) for the full text.
-Parts of the collection are licensed under the [Apache 2.0 license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/Apache-2.0.txt) (`plugins/module_utils/crypto/_obj2txt.py` and `plugins/module_utils/crypto/_objects_data.py`), the [BSD 2-Clause license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/BSD-2-Clause.txt) (`plugins/module_utils/ecs/api.py`), the [BSD 3-Clause license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/BSD-3-Clause.txt) (`plugins/module_utils/crypto/_obj2txt.py`), and the [PSF 2.0 license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/PSF-2.0.txt) (`plugins/module_utils/_version.py`). This only applies to vendored files in ``plugins/module_utils/`` and to the ECS module utils.
+Parts of the collection are licensed under the [Apache 2.0 license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/Apache-2.0.txt) (`plugins/module_utils/crypto/_obj2txt.py` and `plugins/module_utils/crypto/_objects_data.py`), the [BSD 2-Clause license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/BSD-2-Clause.txt) (`plugins/module_utils/ecs/api.py`), the [BSD 3-Clause license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/BSD-3-Clause.txt) (`plugins/module_utils/crypto/_obj2txt.py`, `tests/integration/targets/prepare_jinja2_compat/filter_plugins/jinja_compatibility.py`), and the [PSF 2.0 license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/PSF-2.0.txt) (`plugins/module_utils/_version.py`). This only applies to vendored files in ``plugins/module_utils/`` and to the ECS module utils.
Almost all files have a machine readable `SDPX-License-Identifier:` comment denoting its respective license(s) or an equivalent entry in an accompanying `.license` file. Only changelog fragments (which will not be part of a release) are covered by a blanket statement in `.reuse/dep5`. Right now a few vendored PEM files do not have licensing information as well. This conforms to the [REUSE specification](https://reuse.software/spec/) up to the aforementioned PEM files.