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

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: community.crypto.openssl_signature.

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

Краткое описание
Требования
Параметры
Атрибуты
См. также
Примеры
Возвращаемые значения

Краткое описание

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

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

cryptography >= 3.3

Параметры

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

Атрибуты

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

См. также

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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/crypto/openssl_signature_module.html