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.

Добавлена в community.crypto 2.10.0

Обзор
Требования
Входные данные
Параметры ключевых слов
См. также
Примеры
Значение возврата

Обзор

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

Требования

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

Если name_encoding установлено на значение, отличное от ignore, необходимо установить библиотеку Python idna.

Входные данные

Это описывает входные данные фильтра, значение перед | community.crypto.openssl_privatekey_info.

Параметр	Комментарии
Входные данные строка / обязательно	Содержание закрытого ключа OpenSSL.

Параметры ключевых слов

Это описывает параметры ключевых слов фильтра. Это значения key1=value1, key2=value2 и так далее в следующем примере: input | community.crypto.openssl_privatekey_info(key1=value1, key2=value2, ...)

Параметр	Комментарии
name_encoding строка	Способ кодирования имен (имена DNS, URI, адреса электронной почты) в значениях возврата. `ignore` будет использовать кодировку, возвращаемую бэкендом. `idna` будет преобразовывать все метки доменных имён в кодировку IDNA. Будет предпочтительна кодировка IDNA2008, и будет использоваться IDNA2003, если кодирование IDNA2008 не удастся. `unicode` будет преобразовывать все метки доменных имён в Unicode. Будет предпочтительна кодировка IDNA2008, и будет использоваться IDNA2003, если декодирование IDNA2008 не удастся. Обратите внимание, что `idna` и `unicode` требуют установленной библиотеки Python idna. Варианты: `"ignore"` ← (по умолчанию) `"idna"` `"unicode"`
passphrase строка	Пароль для закрытого ключа.
return_private_key_data логическое	Возвращать ли данные закрытого ключа. Установите это значение в `true` только в том случае, если требуется извлечь частную информацию об этом ключе. ПРЕДУПРЕЖДЕНИЕ: необходимо убедиться, что данные закрытого ключа не попадают в логи по ошибке! Варианты: `false` ← (по умолчанию) `true`

См. также

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

Примеры

- name: Show the Subject Alt Names of the CSR
  ansible.builtin.debug:
    msg: >-
      {{
        (
          lookup('ansible.builtin.file', '/path/to/cert.csr')
          | community.crypto.openssl_privatekey_info
        ).subject_alt_name | join(', ')
      }}

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

Ключ	Описание
Возвращаемое значение dictionary	Информация о сертификате. Возвращается: успех
private_data dictionary	Данные закрытого ключа. Зависит от типа ключа. Возвращается: успех и когда `return_private_key_data` установлено в `true`
public_data dictionary	Данные открытого ключа. Зависит от типа ключа. Возвращается: успех
curve string	Название кривой для ECC. Возвращается: Когда `_value.type=ECC`
exponent integer	Открытая экспонента ключа RSA. Возвращается: Когда `_value.type=RSA`
exponent_size integer	Максимальное количество битов закрытого ключа. Это, по сути, размер в битах используемой подгруппы. Возвращается: Когда `_value.type=ECC`
g integer	Значение `g` для DSA. Это элемент, охватывающий подгруппу мультипликативной группы используемого поля простых чисел. Возвращается: Когда `_value.type=DSA`
modulus integer	Модуль ключа RSA. Возвращается: Когда `_value.type=RSA`
p integer	Значение `p` для DSA. Это простой модуль, на котором выполняются арифметические операции. Возвращается: Когда `_value.type=DSA`
q integer	Значение `q` для DSA. Это простое число, которое делит `p - 1`, и одновременно порядок подгруппы мультипликативной группы используемого поля простых чисел. Возвращается: Когда `_value.type=DSA`
size integer	Размер в битах модуля (RSA) или простого числа (DSA). Возвращается: Когда `_value.type=RSA` или `_value.type=DSA`
x integer	Координата `x` для открытой точки на эллиптической кривой. Возвращается: Когда `_value.type=ECC`
y integer	Для `_value.type=ECC`, это координата `y` для открытой точки на эллиптической кривой. Для `_value.type=DSA`, это публично известный групповой элемент, дискретный логарифм которого относительно `g` является закрытым ключом. Возвращается: Когда `_value.type=DSA` или `_value.type=ECC`
public_key string	Открытый ключ закрытого ключа в формате PEM. Возвращается: успех Пример: `"-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8A..."`
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)

Подсказка

Записи конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, которая находится ниже в списке, переопределит переменную, которая находится выше.

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

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