Provides modules for Ansible for various cryptographic operations.
You can find documentation for this collection on the Ansible docs site.
Please note that this collection does not support Windows targets.
We follow Ansible Code of Conduct in all our interactions within this project.
If you encounter abusive behavior violating the Ansible Code of Conduct, please refer to the policy violations section of the Code of Conduct for information on how to raise a complaint.
-
Join the Ansible forum:
- Get Help: get help or help others. Please add appropriate tags if you start new discussions, for example the
cryptooracmetags. - Posts tagged with 'crypto': subscribe to participate in cryptography related conversations.
- Posts tagged with 'acme': subscribe to participate in ACME (RFC 8555) related conversations.
- Social Spaces: gather and interact with fellow enthusiasts.
- News & Announcements: track project-wide announcements including social events.
- Get Help: get help or help others. Please add appropriate tags if you start new discussions, for example the
-
The Ansible Bullhorn newsletter: used to announce releases and important changes.
For more information about communication, see the Ansible communication guide.
Tested with the current ansible-core-2.17, ansible-core 2.18, and ansible-core 2.19 releases and the current development version of ansible-core. Ansible-core versions before 2.17 are not supported; please use community.crypto 2.x.y with these.
The exact requirements for every module are listed in the module documentation.
Most modules require a recent enough version of the Python cryptography library; the minimum supported version by this collection is 3.3. See the module documentations for the minimal version supported for each module.
Browsing the latest collection documentation will show docs for the latest version released in the Ansible package, not the latest version of the collection released on Galaxy.
Browsing the devel collection documentation shows docs for the latest version released on Galaxy.
We also separately publish latest commit collection documentation which shows docs for the latest commit in the main branch.
If you use the Ansible package and do not update collections independently, use latest. If you install or update this collection directly from Galaxy, use devel. If you are looking to contribute, use latest commit.
Before using the crypto community collection, you need to install the collection with the ansible-galaxy CLI:
ansible-galaxy collection install community.crypto
You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml using the format:
collections:
- name: community.cryptoSee Ansible Using collections for more details.
We're following the general Ansible contributor guidelines; see Ansible Community Guide.
If you want to clone this repositority (or a fork of it) to improve it, you can proceed as follows:
- Create a directory
ansible_collections/community; - In there, checkout this repository (or a fork) as
crypto; - Add the directory containing
ansible_collectionsto your ANSIBLE_COLLECTIONS_PATH.
See Ansible's dev guide for more information.
See the changelog.
We plan to regularly release minor and patch versions, whenever new features are added or bugs fixed. Our collection follows semantic versioning, so breaking changes will only happen in major releases.
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Community code of conduct
This collection is primarily licensed and distributed as a whole under the GNU General Public License v3.0 or later.
See LICENSES/GPL-3.0-or-later.txt for the full text.
Parts of the collection are licensed under the Apache 2.0 license (plugins/module_utils/_crypto/_obj2txt.py and plugins/module_utils/_crypto/_objects_data.py) and the BSD 3-Clause license (plugins/module_utils/_crypto/_obj2txt.py). This only applies to vendored files in plugins/module_utils/.
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.toml. This conforms to the REUSE specification.