community.crypto.openssl_signature – Подписание данных с помощью openssl

Примечание

Этот плагин является частью коллекции community.crypto (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install community.crypto.

Для использования в книге задач укажите: community.crypto.openssl_signature.

Новый в версии 1.1.0: коллекции community.crypto

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет подписать данные с помощью закрытого ключа.
Модуль может использовать библиотеку cryptography Python или pyOpenSSL Python. По умолчанию он пытается определить, какая из них доступна. Это можно переопределить с помощью параметра select_crypto_backend. Обратите внимание, что backend PyOpenSSL был устаревшим в Ansible 2.9 и будет удален в community.crypto 2.0.0.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

Или cryptography >= 1.4 (некоторые типы ключей требуют более новых версий)
Или pyOpenSSL >= 0.11 (ключи Ed25519 и Ed448 не поддерживаются с этим бэкендом)

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
path path / обязательно		Файл для подписи. Этот файл будет только прочитан и не будет изменён.
privatekey_content строка		Содержимое закрытого ключа для использования при подписи запроса на подпись сертификата. Должен быть указан либо privatekey_path, либо privatekey_content, но не оба.
privatekey_passphrase строка		Пароль для закрытого ключа. Требуется, если закрытый ключ защищён паролем.
privatekey_path путь		Путь к закрытому ключу для использования при подписи. Должен быть указан либо privatekey_path, либо privatekey_content, но не оба.
select_crypto_backend строка	Варианты: auto ← cryptography pyopenssl	Определяет, какой бэкенд криптографии использовать. По умолчанию выбрано `auto`, которое пытается использовать `cryptography` , если оно доступно, и переходит к `pyopenssl`. Если установлено на `pyopenssl`, попытается использовать библиотеку pyOpenSSL. Если установлено на `cryptography`, попытается использовать библиотеку cryptography.

Примечания

Примечание

При использовании бэкенда cryptography, для следующих типов ключей требуется как минимум следующая версия cryptography: ключи RSA: cryptography >= 1.4 ключи DSA и ECDSA: cryptography >= 1.5 ключи ed448 и ed25519: cryptography >= 2.6

См. также

community.crypto.openssl_signature_info: Официальная документация по модулю community.crypto.openssl_signature_info.
community.crypto.openssl_privatekey: Официальная документация по модулю community.crypto.openssl_privatekey.

Примеры

- name: Sign example file
  community.crypto.openssl_signature:
    privatekey_path: private.key
    path: /tmp/example_file
  register: sig

- name: Verify signature of example file
  community.crypto.openssl_signature_info:
    certificate_path: cert.pem
    path: /tmp/example_file
    signature: "{{ sig.signature }}"
  register: verify

- name: Make sure the signature is valid
  assert:
    that:
      - verify.valid

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Возвращаемое значение	Описание
signature строка	успех	Подпись в кодировке Base64.

Авторы

Patrick Pichler (@aveexy)
Markus Teufelberger (@MarkusTeufelberger)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/crypto/openssl_signature_module.html