Фильтр community.crypto.openssl_privatekey_info — получение информации из закрытых ключей OpenSSL

Примечание

Этот плагин-фильтр входит в коллекцию community.crypto (версия 3.2.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.

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

Именованные параметры

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

Параметр	Комментарии
name_encoding строка	Способ кодирования имён (имён DNS, URI, адресов электронной почты) в возвращаемых значениях. `ignore` использует кодировку, возвращаемую серверной частью. `idna` преобразует все метки доменных имён в кодировку IDNA. Предпочтение отдаётся IDNA2008; если кодирование IDNA2008 завершится ошибкой, будет использована IDNA2003. `unicode` преобразует все метки доменных имён в Unicode. Предпочтение отдаётся IDNA2008; если декодирование IDNA2008 завершится ошибкой, будет использована IDNA2003. Примечание. Для `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(', ')
      }}

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

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

Ссылки на коллекцию

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