Модуль community.crypto.openssl_csr_info — получение информации о запросах на подпись сертификата OpenSSL (CSR)
Примечание
Этот модуль входит в коллекцию community.crypto (версия 3.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.crypto. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.crypto.openssl_csr_info.
Обзор
- Этот модуль позволяет запрашивать информацию о запросах на подпись сертификата OpenSSL (CSR).
- Если подпись CSR не удаётся проверить, модуль завершится с ошибкой. При этом будут возвращены все переменные результата.
- Для взаимодействия с OpenSSL используется библиотека Python cryptography.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- Если для
name_encodingзадано значение, отличное отignore, необходимо установить библиотеку Python idna. - cryptography >= 3.3
Параметры
Параметр | Комментарии |
|---|---|
content string добавлено в community.crypto 1.0.0 | |
name_encoding string | Способ кодирования имён (имён DNS, URI, адресов электронной почты) в возвращаемых значениях.
Примечание: для Варианты:
|
path path | |
select_crypto_backend string | Определяет, какую криптографическую серверную часть использовать. По умолчанию используется Если задано значение Обратите внимание: в community.crypto 3.0.0 все значения работают одинаково. В более поздней версии этот параметр будет объявлен устаревшим. Рекомендуется не задавать его явно. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная Это действие не изменяет состояние. | Может выполняться в режиме |
diff_mode | Поддержка: Н/Д Это действие не изменяет состояние. | В режиме diff будут возвращены сведения о том, что изменилось (или, возможно, должно измениться в |
idempotent | Поддержка: полная Это действие не изменяет состояние. | При повторном запуске с теми же аргументами вне режима check вторая операция не сообщает об изменениях. Предполагается, что система, состояние которой контролирует или запрашивает модуль, не изменилась значимым образом. |
См. также
См. также
- community.crypto.openssl_csr
-
Создание запроса на подпись сертификата OpenSSL (CSR).
- community.crypto.openssl_csr_pipe
-
Создание запроса на подпись сертификата OpenSSL (CSR).
- community.crypto.openssl_csr_info — плагин-фильтр
-
Вариант этого модуля в виде фильтра.
- community.crypto.to_serial — плагин-фильтр
-
Преобразование целого числа в список шестнадцатеричных чисел, разделённых двоеточиями.
Примеры
---
- name: Generate an OpenSSL Certificate Signing Request
community.crypto.openssl_csr:
path: /etc/ssl/csr/www.ansible.com.csr
privatekey_path: /etc/ssl/private/ansible.com.pem
common_name: www.ansible.com
- name: Get information on the CSR
community.crypto.openssl_csr_info:
path: /etc/ssl/csr/www.ansible.com.csr
register: result
- name: Dump information
ansible.builtin.debug:
var: result
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
authority_cert_issuer list / elements=string | Издатель сертификата центра сертификации (CA) для CSR в виде списка общих имён. Равно Информацию об обработке IDN см. в разделе Возвращается: при успехе Пример: |
authority_cert_serial_number integer | Серийный номер сертификата центра сертификации (CA) для CSR. Равно Это возвращаемое значение имеет тип integer. Если вам нужны серийные номера в виде шестнадцатеричной строки с разделителями- двоеточиями, например Возвращается: при успехе Пример: |
authority_key_identifier string | Идентификатор ключа центра сертификации (CA) для CSR. Идентификатор возвращается в шестнадцатеричном формате; байты разделяются с помощью Равно Возвращается: при успехе Пример: |
basic_constraints list / elements=string | Записи в расширении Возвращается: при успехе Пример: |
basic_constraints_critical boolean | Является ли расширение Возвращается: при успехе |
extended_key_usage list / elements=string | Записи в расширении Возвращается: при успехе Пример: |
extended_key_usage_critical boolean | Является ли расширение Возвращается: при успехе |
extensions_by_oid dictionary | Возвращает словарь для каждого OID расширения. Возвращается: при успехе Пример: |
|
critical boolean |
Является ли расширение критическим. Возвращается: при успехе |
|
value string |
Значение расширения в формате DER, закодированное в Base64. Обратите внимание: в зависимости от используемой версии Возвращается: при успехе Пример: |
key_usage string | Записи в расширении Возвращается: при успехе Пример: |
key_usage_critical boolean | Является ли расширение Возвращается: при успехе |
name_constraints_critical boolean добавлено в community.crypto 1.1.0 | Является ли расширение Равно Возвращается: при успехе |
name_constraints_excluded list / elements=string добавлено в community.crypto 1.1.0 | Список исключённых поддеревьев, для которых CA не может подписывать сертификаты. Равно Информацию об обработке IDN см. в разделе Возвращается: при успехе Пример: |
name_constraints_permitted list / elements=string добавлено в community.crypto 1.1.0 | Список разрешённых поддеревьев, для которых можно подписывать сертификаты. Возвращается: при успехе Пример: |
ocsp_must_staple boolean |
Возвращается: при успехе |
ocsp_must_staple_critical boolean | Является ли расширение Возвращается: при успехе |
public_key string | Открытый ключ CSR в формате PEM. Возвращается: при успехе Пример: |
public_key_data dictionary добавлено в community.crypto 1.7.0 | Данные открытого ключа. Зависят от типа открытого ключа. Возвращается: при успехе |
|
curve string |
Название эллиптической кривой для ECC. Возвращается: если |
|
exponent integer |
Открытый показатель степени ключа RSA. Возвращается: если |
|
exponent_size integer |
Максимальное количество бит закрытого ключа. По сути, это разрядность используемой подгруппы. Возвращается: если |
|
g integer |
Значение Это элемент, порождающий подгруппу мультипликативной группы используемого простого поля. Возвращается: если |
|
modulus integer |
Модуль ключа RSA. Возвращается: если |
|
p integer |
Значение Это простой модуль, по которому выполняются вычисления. Возвращается: если |
|
q integer |
Значение Это простое число, которое делит Возвращается: если |
|
size integer |
Разрядность модуля (RSA) или простого числа (DSA). Возвращается: если |
|
x integer |
Координата Возвращается: если |
|
y integer |
Для Для Возвращается: если |
public_key_fingerprints dictionary | Отпечатки открытого ключа CSR. Вычисляется отпечаток для каждого доступного алгоритма хеширования. Возвращается: при успехе Пример: |
public_key_type string добавлено в community.crypto 1.7.0 | Тип открытого ключа CSR. Одно из значений: Если тип ключа определить не удаётся, значение начинается с Возвращается: при успехе Пример: |
signature_valid boolean | Является ли подпись CSR действительной. Если проверка возвращает Возвращается: при успехе |
subject dictionary | Субъект CSR в виде словаря. Обратите внимание: для повторяющихся значений возвращается только последнее. Возвращается: при успехе Пример: |
subject_alt_name list / elements=string | Записи в расширении Информацию об обработке IDN см. в разделе Возвращается: при успехе Пример: |
subject_alt_name_critical boolean | Является ли расширение Возвращается: при успехе |
subject_key_identifier string | Идентификатор ключа субъекта CSR. Идентификатор возвращается в шестнадцатеричном формате; байты разделяются с помощью Равно Возвращается: при успехе Пример: |
subject_ordered list / elements=list | Субъект CSR в виде упорядоченного списка кортежей. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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_csr_info_module.html