Spec-Zone.ru › Ansible

Модуль 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

Содержимое файла CSR.

Необходимо указать path или content, но не оба параметра одновременно.

name_encoding

string

Способ кодирования имён (имён DNS, URI, адресов электронной почты) в возвращаемых значениях.

ignore использует кодировку, возвращаемую серверной частью.

idna преобразует все метки доменных имён в кодировку IDNA. Приоритет отдаётся IDNA2008; если кодирование IDNA2008 завершится ошибкой, будет использована IDNA2003.

unicode преобразует все метки доменных имён в Unicode. Приоритет отдаётся IDNA2008; если декодирование IDNA2008 завершится ошибкой, будет использована IDNA2003.

Примечание: для idna и unicode необходимо установить библиотеку Python idna.

Варианты:

  • "ignore" ← (по умолчанию)
  • "idna"
  • "unicode"

path

path

Абсолютный путь на удалённом узле, откуда загружается файл CSR.

Необходимо указать path или content, но не оба параметра одновременно.

select_crypto_backend

string

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

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

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

Обратите внимание: в community.crypto 3.0.0 все значения работают одинаково. В более поздней версии этот параметр будет объявлен устаревшим. Рекомендуется не задавать его явно.

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

Может выполняться в режиме check_mode и возвращать прогноз статуса изменений, не изменяя целевой узел.

diff_mode

Поддержка: Н/Д

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

В режиме diff будут возвращены сведения о том, что изменилось (или, возможно, должно измениться в check_mode).

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 в виде списка общих имён.

Равно none, если расширение AuthorityKeyIdentifier отсутствует.

Информацию об обработке IDN см. в разделе name_encoding.

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

Пример: ["DNS:www.ansible.com", "IP:1.2.3.4"]

authority_cert_serial_number

integer

Серийный номер сертификата центра сертификации (CA) для CSR.

Равно none, если расширение AuthorityKeyIdentifier отсутствует.

Это возвращаемое значение имеет тип integer. Если вам нужны серийные номера в виде шестнадцатеричной строки с разделителями- двоеточиями, например 11:22:33, преобразуйте значение в этот формат с помощью community.crypto.to_serial.

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

Пример: 12345

authority_key_identifier

string

Идентификатор ключа центра сертификации (CA) для CSR.

Идентификатор возвращается в шестнадцатеричном формате; байты разделяются с помощью :.

Равно none, если расширение AuthorityKeyIdentifier отсутствует.

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

Пример: "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"

basic_constraints

list / elements=string

Записи в расширении basic_constraints или none, если расширение отсутствует.

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

Пример: ["CA:TRUE", "pathlen:1"]

basic_constraints_critical

boolean

Является ли расширение basic_constraints критическим.

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

extended_key_usage

list / elements=string

Записи в расширении extended_key_usage или none, если расширение отсутствует.

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

Пример: ["Biometric Info", "DVCS", "Time Stamping"]

extended_key_usage_critical

boolean

Является ли расширение extended_key_usage критическим.

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

extensions_by_oid

dictionary

Возвращает словарь для каждого OID расширения.

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

Пример: {"1.3.6.1.5.5.7.1.24": {"critical": false, "value": "MAMCAQU="}}

critical

boolean

Является ли расширение критическим.

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

value

string

Значение расширения в формате DER, закодированное в Base64.

Обратите внимание: в зависимости от используемой версии cryptography извлечь содержимое ASN.1 расширения может быть невозможно; в таком случае можно предоставить только повторно закодированное содержимое расширения, если оно было обработано cryptography. Обычно в результате получается точно такое же значение, за исключением случаев, когда исходное значение расширения было некорректным.

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

Пример: "MAMCAQU="

key_usage

string

Записи в расширении key_usage или none, если расширение отсутствует.

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

Пример: "['Key Agreement', 'Data Encipherment']"

key_usage_critical

boolean

Является ли расширение key_usage критическим.

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

name_constraints_critical

boolean

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

Является ли расширение name_constraints критическим.

Равно none, если расширение отсутствует.

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

name_constraints_excluded

list / elements=string

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

Список исключённых поддеревьев, для которых CA не может подписывать сертификаты.

Равно none, если расширение отсутствует.

Информацию об обработке IDN см. в разделе name_encoding.

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

Пример: ["email:.com"]

name_constraints_permitted

list / elements=string

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

Список разрешённых поддеревьев, для которых можно подписывать сертификаты.

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

Пример: ["email:.somedomain.com"]

ocsp_must_staple

boolean

true, если присутствует расширение OCSP Must Staple, и none в противном случае.

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

ocsp_must_staple_critical

boolean

Является ли расширение ocsp_must_staple критическим.

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

public_key

string

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

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

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

public_key_data

dictionary

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

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

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

curve

string

Название эллиптической кривой для ECC.

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

exponent

integer

Открытый показатель степени ключа RSA.

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

exponent_size

integer

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

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

g

integer

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

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

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

modulus

integer

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

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

p

integer

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

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

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

q

integer

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

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

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

size

integer

Разрядность модуля (RSA) или простого числа (DSA).

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

x

integer

Координата x открытой точки на эллиптической кривой.

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

y

integer

Для public_key_type=ECC это координата y открытой точки на эллиптической кривой.

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

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

public_key_fingerprints

dictionary

Отпечатки открытого ключа CSR.

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

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

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

public_key_type

string

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

Тип открытого ключа CSR.

Одно из значений: RSA, DSA, ECC, Ed25519, X25519, Ed448 или X448.

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

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

Пример: "RSA"

signature_valid

boolean

Является ли подпись CSR действительной.

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

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

subject

dictionary

Субъект CSR в виде словаря.

Обратите внимание: для повторяющихся значений возвращается только последнее.

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

Пример: {"commonName": "www.example.com", "emailAddress": "test@example.com"}

subject_alt_name

list / elements=string

Записи в расширении subject_alt_name или none, если расширение отсутствует.

Информацию об обработке IDN см. в разделе name_encoding.

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

Пример: ["DNS:www.ansible.com", "IP:1.2.3.4"]

subject_alt_name_critical

boolean

Является ли расширение subject_alt_name критическим.

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

subject_key_identifier

string

Идентификатор ключа субъекта CSR.

Идентификатор возвращается в шестнадцатеричном формате; байты разделяются с помощью :.

Равно none, если расширение SubjectKeyIdentifier отсутствует.

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

Пример: "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"

subject_ordered

list / elements=list

Субъект CSR в виде упорядоченного списка кортежей.

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

Пример: [["commonName", "www.example.com"], [{"emailAddress": "test@example.com"}]]

Авторы

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

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

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

© 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

Spec-Zone.ru

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