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.

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

  • Краткое описание
  • Требования
  • Входные данные
  • Параметры-ключевые слова
  • См. также
  • Примеры
  • Возвращаемое значение

Краткое описание

  • Получение информации из предоставленного запроса на подписание сертификата OpenSSL (CSR).
  • Версия в виде фильтра модуля community.crypto.openssl_csr_info.

Требования

Следующие требования необходимы на локальном управляющем узле, на котором выполняется этот фильтр.

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

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

Здесь описаны входные данные фильтра — значение перед | community.crypto.openssl_csr_info.

Параметр

Комментарии

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

строка / обязательный

Содержимое запроса на подписание сертификата OpenSSL (CSR).

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

Здесь описаны параметры-ключевые слова фильтра. В следующем примере это значения key1=value1, key2=value2 и так далее: input | community.crypto.openssl_csr_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"

См. также

См. также

community.crypto.openssl_csr_info

Предоставление информации о запросах на подписание сертификата OpenSSL (CSR).

community.crypto.to_serial плагин-фильтр

Преобразование целого числа в список шестнадцатеричных чисел, разделенных двоеточиями.

Примеры

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

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

Ключ

Описание

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

dictionary

Информация о сертификате.

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

authority_cert_issuer

list / elements=string

Издатель сертификата центра сертификации (CA) для CSR в виде списка общих имён.

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

См. name_encoding о том, как обрабатываются IDN.

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

Пример: ["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

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

Примечание. В зависимости от используемой версии 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

Указывает, является ли расширение name_constraints критическим.

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

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

name_constraints_excluded

list / elements=string

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

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

См. name_encoding о том, как обрабатываются IDN.

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

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

name_constraints_permitted

list / elements=string

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

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

Пример: ["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

Данные открытого ключа. Их состав зависит от типа открытого ключа.

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

curve

string

Название кривой для ECC.

Возвращается: в случаях _value.public_key_type=ECC

exponent

integer

Открытая экспонента ключа RSA.

Возвращается: в случаях _value.public_key_type=RSA

exponent_size

integer

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

Возвращается: в случаях _value.public_key_type=ECC

g

integer

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

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

Возвращается: в случаях _value.public_key_type=DSA

modulus

integer

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

Возвращается: в случаях _value.public_key_type=RSA

p

integer

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

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

Возвращается: в случаях _value.public_key_type=DSA

q

integer

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

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

Возвращается: в случаях _value.public_key_type=DSA

size

integer

Размер в битах модуля (RSA) или простого числа (DSA).

Возвращается: в случаях _value.public_key_type=RSA или _value.public_key_type=DSA

x

integer

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

Возвращается: в случаях _value.public_key_type=ECC

y

integer

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

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

Возвращается: в случаях _value.public_key_type=DSA или _value.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

Тип открытого ключа 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, если расширение отсутствует.

См. name_encoding о том, как обрабатываются IDN.

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

Пример: ["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)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Запросить помощь (crypto)
  • Запросить помощь (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_filter.html

Spec-Zone.ru

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