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

Примечание

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

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

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

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

Обзор

Этот модуль позволяет получать информацию о закрытых ключах OpenSSL.
В случае, если проверки целостности ключа завершатся неудачно, модуль завершит работу, так как это указывает на поддельный закрытый ключ. В этом случае все переменные возврата всё ещё возвращаются. Обратите внимание, что проверки целостности ключа доступны не для всех типов ключей; если ни один не доступен, то для key_is_consistent возвращается none.
Он использует библиотеку pyOpenSSL или cryptography для взаимодействия с 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		Содержимое файла закрытого ключа. Должен быть указан либо path, либо content, но не оба.
passphrase строка		Пароль для закрытого ключа.
path путь		Абсолютный удалённый путь к файлу закрытого ключа.
return_private_key_data булево	Варианты: нет ← да	Возвращать ли данные закрытого ключа. Установите это значение в `yes`, только если вы хотите сохранить частную информацию об этом ключе на удалённой машине. ВНИМАНИЕ: необходимо убедиться, что данные закрытого ключа не попадут в лог случайно!
select_crypto_backend строка	Варианты: auto ← cryptography pyopenssl	Определяет, какой криптографический бэкенд использовать. По умолчанию используется `auto`, который пытается использовать `cryptography`, если он доступен, и переходит к `pyopenssl`, если нет. Если установлено значение `pyopenssl`, будет использоваться библиотека pyOpenSSL. Если установлено значение `cryptography`, будет использоваться библиотека cryptography. Обратите внимание, что бэкенд `pyopenssl` устарел в Ansible 2.9 и будет удален в community.crypto 2.0.0. После этого будет доступен только бэкенд `cryptography`.

См. также

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
  debug:
    var: result

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

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

Ключ	Возвращаемое значение	Описание
can_load_key булево	всегда	Можно ли загрузить закрытый ключ из файла
can_parse_key булево	всегда	Можно ли разобрать закрытый ключ
key_is_consistent булево	всегда	Соответствует ли ключ требованиям. Может также вернуть `none` вместе с `yes` и `no`, чтобы указать, что проверка целостности не была выполнена. В случае, если проверка возвращает `no`, модуль завершит работу с ошибкой.
private_data словарь	при успехе и когда return_private_key_data установлено в `yes`	Данные закрытого ключа. Зависит от типа ключа.
public_data словарь	при успехе	Данные открытого ключа. Зависит от типа ключа.
public_key строка	при успехе	Открытый ключ закрытого ключа в формате PEM Пример: -----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8A...
public_key_fingerprints словарь	при успехе	Отпечатки пальцев открытого ключа закрытого ключа. Для каждого доступного алгоритма хэширования вычисляется отпечаток пальца. Пример: {'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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/crypto/openssl_privatekey_info_module.html