community.crypto.openssl_privatekey_info – Предоставление информации для ключей OpenSSL private

Примечание

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

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

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

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

Обзор

Этот модуль позволяет запросить информацию о ключах OpenSSL private.
В случае, если проверки целостности ключа завершатся неудачно, модуль завершится ошибкой, поскольку это указывает на поддельный private ключ. В этом случае все возвращаемые переменные по-прежнему возвращаются. Обратите внимание, что проверки целостности ключа недоступны для всех типов ключей; если ни один из них недоступен, none возвращается для key_is_consistent.
Он использует библиотеку pyOpenSSL или cryptography python для взаимодействия с OpenSSL. Если доступны обе библиотеки cryptography и PyOpenSSL (и соответствуют минимальным требованиям к версии), cryptography будет предпочтительным бэкэндом перед PyOpenSSL (если бэкэнд не принудительно установлен с помощью select_crypto_backend). Обратите внимание, что бэкэнд PyOpenSSL был устаревшим в Ansible 2.9 и будет удален в community.crypto 2.0.0.

Требования

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

PyOpenSSL >= 0.15 или cryptography >= 1.2.3

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
content строка добавлен в 1.0.0 community.crypto		Содержимое файла private ключа. Должен быть указан либо path, либо content, но не оба.
passphrase строка		Пароль к private ключу.
path путь		Абсолютный удаленный путь к файлу private ключа.
return_private_key_data логическое значение	Варианты: нет ← да	Возвращать ли данные private ключа. Устанавливайте значение только в `yes`, если требуется передать частную информацию о данном ключе с удаленного компьютера. ПРЕДУПРЕЖДЕНИЕ: нужно убедиться, что данные private ключа не попадут в лог по ошибке!
select_crypto_backend строка	Варианты: авто ← cryptography pyopenssl	Определяет, какой бэкэнд криптографии использовать. Значение по умолчанию `auto`, которое пытается использовать `cryptography`, если оно доступно, и переходит к `pyopenssl`. Если установлено `pyopenssl`, будет использована библиотека pyOpenSSL. Если установлено `cryptography`, будет использована библиотека cryptography. Обратите внимание, что бэкэнд `pyopenssl` устарел в Ansible 2.9 и будет удален в community.crypto 2.0.0. С этого момента доступен только бэкэнд `cryptography`.

Примечания

Примечание

Поддерживает check_mode.

См. также

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

Примеры

- name: Generate an OpenSSL private key with the default values (4096 bits, RSA)
  community.crypto.openssl_privatekey:
    path: /etc/ssl/private/ansible.com.pem

- name: Get information on generated key
  community.crypto.openssl_privatekey_info:
    path: /etc/ssl/private/ansible.com.pem
  register: result

- name: Dump information
  ansible.builtin.debug:
    var: result

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

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

Ключ	Возвращаемое значение	Описание
can_load_key логическое значение	всегда	Успешно ли загружен private ключ с диска.
can_parse_key логическое значение	всегда	Успешно ли был распарсен private ключ.
key_is_consistent логическое значение	всегда	Соответствует ли ключ требованиям. Также может вернуть `none` вместе с `yes` и `no`, чтобы указать, что проверка целостности не была выполнена. В случае, если проверка возвращает `no`, модуль завершится ошибкой.
private_data словарь	успешно и когда return_private_key_data установлено в `yes`	Данные private ключа. Зависит от типа ключа.
public_data словарь	успешно	Данные public ключа. Зависит от типа ключа.
public_key строка	успешно	Public ключ private ключа в формате PEM. Пример: -----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8A...
public_key_fingerprints словарь	успешно	Отпечатки public ключа private ключа. Для каждого доступного алгоритма хеширования вычисляется отпечаток. Пример: {'sha256': 'd4:b3:aa:6d:c8:04:ce:4e:ba:f6:29:4d:92:a3:94:b0:c2:ff:bd:bf:33:63:11:43:34:0f:51:b0:95:09:2f:63', 'sha512': 'f7:07:4a:f0:b0:f0:e6:8b:95:5f:f9:e6:61:0a:32:68:f1...
type строка	успешно	Тип ключа. Один из `RSA`, `DSA`, `ECC`, `Ed25519`, `X25519`, `Ed448`, или `X448`. Начнётся с `unknown` если тип ключа не может быть определен. Пример: RSA

Авторы

Felix Fontein (@felixfontein)
Yanis Guenane (@Spredzy)

© 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_privatekey_info_module.html