Модуль 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.
Краткое описание
- Этот модуль позволяет получать сведения о закрытых ключах OpenSSL.
- Если проверка целостности ключа завершается неудачей, модуль завершится с ошибкой, поскольку это указывает на поддельный закрытый ключ. В этом случае все переменные результата всё равно будут возвращены. Обратите внимание, что проверка целостности доступна не для всех типов ключей; если такая проверка недоступна, для
key_is_consistentвозвращаетсяnone. - Для взаимодействия с OpenSSL используется библиотека Python cryptography.
Требования
На узле, выполняющем этот модуль, необходимы следующие компоненты.
- cryptography >= 3.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 больше невозможна. Варианты:
|
content string добавлено в community.crypto 1.0.0 | |
passphrase string | Парольная фраза для закрытого ключа. |
path path | Удалённый абсолютный путь, по которому загружается файл закрытого ключа. |
return_private_key_data boolean | Возвращать ли данные закрытого ключа. Устанавливайте значение ПРЕДУПРЕЖДЕНИЕ: убедитесь, что данные закрытого ключа не будут случайно записаны в журнал! Варианты:
|
select_crypto_backend string | Определяет, какой криптографический механизм использовать. По умолчанию используется Если задано значение Обратите внимание, что в community.crypto 3.0.0 все значения работают одинаково. В более поздней версии этот параметр будет объявлен устаревшим. Рекомендуется не задавать его явно. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная Это действие не изменяет состояние. | Может выполняться в режиме |
diff_mode | Поддержка: Н/Д Это действие не изменяет состояние. | В режиме diff возвращает сведения об изменениях (или о том, что, возможно, нужно изменить в |
idempotent | Поддержка: полная Это действие не изменяет состояние. | При повторном запуске с теми же аргументами вне режима check второй вызов сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или сведения о которой он получает, не изменилась существенным образом. |
См. также
См. также
- 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 | Является ли ключ целостным. Может также возвращать Если проверка возвращает Возвращается: когда |
private_data dictionary | Данные закрытого ключа. Зависят от типа ключа. Возвращается: при успешном выполнении, если для |
public_data dictionary | Данные открытого ключа. Зависят от типа ключа. Возвращается: при успешном выполнении |
|
curve string |
Название кривой для ECC. Возвращается: когда |
|
exponent integer |
Открытый показатель степени ключа RSA. Возвращается: когда |
|
exponent_size integer |
Максимальное количество битов закрытого ключа. По сути, это размер в битах используемой подгруппы. Возвращается: когда |
|
g integer |
Значение Это элемент, порождающий используемую подгруппу мультипликативной группы простого поля. Возвращается: когда |
|
modulus integer |
Модуль ключа RSA. Возвращается: когда |
|
p integer |
Значение Это простой модуль, по которому выполняются арифметические операции. Возвращается: когда |
|
q integer |
Значение Это простое число, которое делит Возвращается: когда |
|
size integer | |
|
x integer |
Координата Возвращается: когда |
|
y integer | |
public_key string | Открытый ключ закрытого ключа в формате PEM. Возвращается: при успешном выполнении Пример: |
public_key_fingerprints dictionary | Отпечатки открытого ключа закрытого ключа. Вычисляется отпечаток для каждого доступного алгоритма хеширования. Возвращается: при успешном выполнении Пример: |
type string | Тип ключа. Одно из значений: Если определить тип ключа невозможно, значение будет начинаться с Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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_module.html