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

Примечание

Этот модуль является частью коллекции community.crypto (версия 2.22.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.crypto. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

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

Добавлен в community.crypto 1.1.0

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

Обзор

Этот модуль позволяет подписывать данные с помощью закрытого ключа.
Модуль использует библиотеку cryptography Python.

Требования

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

cryptography >= 1.4 (некоторые типы ключей требуют более новых версий)

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз состояния изменения без модификации целевого объекта.
diff_mode	Поддержка: нет	Вернёт детали о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), когда режим diff включён.

Примечания

Примечание

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

См. также

community.crypto.openssl_signature_info: Проверка подписей с помощью OpenSSL.
community.crypto.openssl_privatekey: Генерация закрытых ключей OpenSSL.

Примеры

- 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
  ansible.builtin.assert:
    that:
      - verify.valid

Значения возврата

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

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

Авторы

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

Ссылки на коллекцию

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