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

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

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

Обзор

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

Требования

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

PyOpenSSL >= 0.15 или cryptography >= 1.2.3

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
passphrase строка		Пароль для закрытого ключа.
path путь / обязательно		Абсолютный удаленный путь, откуда загружается файл закрытого ключа.
return_private_key_data булево	Варианты: нет ← да	Указывает, нужно ли возвращать данные закрытого ключа. Устанавливайте это значение в `yes`, только если вам нужна частная информация об этом ключе, которая должна покинуть удаленный компьютер. ВНИМАНИЕ: необходимо убедиться, что данные закрытого ключа случайно не попадут в лог!
select_crypto_backend строка	Варианты: авто ← cryptography pyopenssl	Определяет, какой криптографический бэкенд использовать. Значение по умолчанию — `auto`, которое пытается использовать `cryptography`, если оно доступно, и переключается на `pyopenssl`. Если установлено `pyopenssl`, будет использоваться библиотека pyOpenSSL. Если установлено `cryptography`, будет использоваться библиотека 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. [сообщество]

Авторы

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