Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

Описание

  • Этот модуль позволяет запросить информацию о закрытых ключах OpenSSL.
  • В случае неудачи проверок целостности ключа, модуль завершится ошибкой, так как это указывает на поддельный закрытый ключ. В этом случае все возвращаемые переменные по-прежнему возвращаются. Обратите внимание, что проверки целостности ключа не доступны для всех типов ключей; если ни одна не доступна, для key_is_consistent возвращается none.
  • Он использует библиотеку cryptography python для взаимодействия с OpenSSL.

Требования

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

  • cryptography >= 1.2.3

Параметры

Параметр

Комментарии

check_consistency

boolean

добавлен в community.crypto 2.0.0

Выполнять ли проверку целостности закрытого ключа.

В community.crypto < 2.0.0, проверка целостности всегда выполнялась.

С community.crypto 2.0.0 проверка целостности отключена по умолчанию, чтобы избежать передачи и вычисления данных закрытого ключа, а выполнять её только при явном запросе. Это потенциально предотвращает атаки по каналам утечки информации.

Обратите внимание, что проверки целостности работают только для определенных типов ключей и могут зависеть от версии библиотеки cryptography. Например, с cryptography 42.0.0 и новее проверку целостности ключей RSA выполнить больше нельзя.

Варианты:

  • false ← (по умолчанию)
  • true

content

string

добавлен в community.crypto 1.0.0

Содержимое файла закрытого ключа.

Должен быть указан либо path, либо content, но не оба.

passphrase

string

Пароль к закрытому ключу.

path

path

Полный путь к удаленному файлу закрытого ключа.

return_private_key_data

boolean

Возвращать ли данные закрытого ключа.

Установите это в true, только если вы хотите передать частную информацию об этом ключе с удалённой машины.

ВНИМАНИЕ: необходимо убедиться, что данные закрытого ключа не попадут в лог!

Варианты:

  • false ← (по умолчанию)
  • true

select_crypto_backend

string

Определяет, какой криптографический бэкенд использовать.

По умолчанию выбран auto, который пытается использовать cryptography при наличии.

Если установлено cryptography, будет использоваться библиотека cryptography.

Варианты:

  • "auto" ← (по умолчанию)
  • "cryptography"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Это действие не изменяет состояние.

Может работать в check_mode и возвращать прогноз о статусе изменения без модификации целевого объекта.

diff_mode

Поддержка: Нет

Это действие не изменяет состояние.

Вернет подробности о том, что изменилось (или, возможно, нуждается в изменении в check_mode), когда режим diff включён.

См. также

См. также

community.crypto.openssl_privatekey

Генерация закрытых ключей OpenSSL.

community.crypto.openssl_privatekey_pipe

Генерация закрытых ключей OpenSSL без доступа к диску.

community.crypto.openssl_privatekey_info плагин фильтра

Вариант фильтра этого модуля.

Примеры

- 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

boolean

Указывает, удалось ли модулю загрузить закрытый ключ с диска.

Возвращается: всегда

can_parse_key

boolean

Указывает, удалось ли модулю разобрать закрытый ключ.

Возвращается: всегда

key_is_consistent

boolean

Указывает, согласован ли ключ. Может также вернуть none рядом с true и false, чтобы указать, что проверка согласованности не удалась.

В случае, если проверка вернула false, модуль завершится с ошибкой.

Возвращается: при check_consistency=true

private_data

dictionary

Данные закрытого ключа. Зависит от типа ключа.

Возвращается: при успехе и когда return_private_key_data установлено в true

public_data

dictionary

Данные открытого ключа. Зависит от типа ключа.

Возвращается: при успехе

curve

string

Имя кривой для ECC.

Возвращается: при type=ECC

exponent

integer

Общедоступный показатель степени ключа RSA.

Возвращается: при type=RSA

exponent_size

integer

Максимальное количество битов закрытого ключа. Это, по сути, размер в битах подгруппы, используемой.

Возвращается: при type=ECC

g

integer

Значение g для DSA.

Это элемент, охватывающий подгруппу мультипликативной группы используемого конечного поля.

Возвращается: при type=DSA

modulus

integer

Модуль ключа RSA.

Возвращается: при type=RSA

p

integer

Значение p для DSA.

Это простое модуль, на котором выполняются арифметические операции.

Возвращается: при type=DSA

q

integer

Значение q для DSA.

Это простое число, которое делит p - 1, а также порядок подгруппы мультипликативной группы используемого конечного поля.

Возвращается: при type=DSA

size

integer

Размер модуля в битах (RSA) или простого числа (DSA).

Возвращается: при type=RSA или type=DSA

x

integer

Координата x для общедоступной точки на эллиптической кривой.

Возвращается: при type=ECC

y

integer

Для type=ECC, это координата y для общедоступной точки на эллиптической кривой.

Для type=DSA, это общеизвестный элемент группы, дискретный логарифм которого по основанию g равен закрытому ключу.

Возвращается: при type=DSA или type=ECC

public_key

string

Открытый ключ закрытого ключа в формате PEM.

Возвращается: при успехе

Пример: "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8A..."

public_key_fingerprints

dictionary

Отпечатки пальцев открытого ключа закрытого ключа.

Для каждого доступного алгоритма хэширования вычисляется отпечаток.

Возвращается: при успехе

Пример: "{'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

string

Тип ключа.

Один из RSA, DSA, ECC, Ed25519, X25519, Ed448, или X448.

Начнётся с unknown , если тип ключа нельзя определить.

Возвращается: при успехе

Пример: "RSA"

Авторы

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

Ссылки на сборник

  • Отслеживание проблем
  • Репозиторий (Исходные коды)
  • Задать вопрос (crypto)
  • Задать вопрос (ACME)
  • Отправить сообщение об ошибке
  • Запросить новую функцию
  • Общение

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/crypto/openssl_privatekey_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API