openssl_privatekey_info – Предоставление информации для закрытых ключей OpenSSL

Новое в версии 2.8.

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

Обзор

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

Требования

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

PyOpenSSL >= 0.15 или cryptography >= 1.2.3

Параметры

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

См. также

openssl_privatekey – Генерация закрытых ключей OpenSSL: Официальная документация модуля openssl_privatekey.

Примеры

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

- name: Get information on generated key
  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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/openssl_privatekey_info_module.html