Фильтр community.crypto.x509_crl_info — получение информации из списков отзыва сертификатов X.509 в формате PEM

Примечание

Этот фильтр является частью коллекции community.crypto (версия 3.2.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.crypto. Для использования этого фильтра необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать фильтр в плейбуке, укажите: community.crypto.x509_crl_info.

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

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

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

Получение информации из списка отзыва сертификатов X.509 в формате PEM.
Это вариант фильтра модуля community.crypto.x509_crl_info.

Требования

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

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

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

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

Параметр	Комментарии
Входные данные строка / обязательный	Содержимое списка отзыва сертификатов X.509 в формате PEM.

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

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

Параметр	Комментарии
list_revoked_certificates логическое значение добавлено в community.crypto 1.7.0	Если задано значение `false`, список отозванных сертификатов не включается в результат. Это полезно при получении информации из больших файлов CRL. Перечисление всех отозванных сертификатов может занять некоторое время, включая сериализацию результата в JSON, его отправку на контроллер Ansible и последующее декодирование. Варианты: `false` `true` ← (по умолчанию)
name_encoding строка	Способ кодирования имён (имён DNS, URI, адресов электронной почты) в возвращаемых значениях. `ignore` использует кодирование, возвращённое внутренним компонентом. `idna` преобразует все метки доменных имён в кодировку IDNA. Приоритет отдаётся IDNA2008; если кодирование IDNA2008 завершится ошибкой, будет использована IDNA2003. `unicode` преобразует все метки доменных имён в Unicode. Приоритет отдаётся IDNA2008; если декодирование IDNA2008 завершится ошибкой, будет использована IDNA2003. Примечание. Для `idna` и `unicode` необходимо установить библиотеку Python idna. Варианты: `"ignore"` ← (по умолчанию) `"idna"` `"unicode"`

Параметр

Комментарии

list_revoked_certificates

логическое значение

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

Если задано значение false, список отозванных сертификатов не включается в результат.

Это полезно при получении информации из больших файлов CRL. Перечисление всех отозванных сертификатов может занять некоторое время, включая сериализацию результата в JSON, его отправку на контроллер Ansible и последующее декодирование.

Варианты:

false
true ← (по умолчанию)

name_encoding

строка

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

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

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

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

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

Варианты:

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

См. также

community.crypto.x509_crl_info: Получение информации о списках отзыва сертификатов (CRL).
community.crypto.to_serial — плагин-фильтр: Преобразование целого числа в список шестнадцатеричных чисел, разделённых двоеточиями.

Примеры

---
- name: Show the Organization Name of the CRL's subject
  ansible.builtin.debug:
    msg: >-
      {{
        (
          lookup('ansible.builtin.file', '/path/to/cert.pem')
          | community.crypto.x509_crl_info
        ).issuer.organizationName
      }}

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

Ключ	Описание
Возвращаемое значение словарь	Информация о CRL. Возвращается: при успехе
digest строка	Алгоритм подписи, использованный для подписания CRL. Возвращается: при успехе Пример: `"sha256WithRSAEncryption"`
format строка	Формат CRL: PEM (`pem`) или DER (`der`). Возвращается: при успехе Возможные возвращаемые значения: `"pem"` `"der"` Пример: `"pem"`
issuer словарь	Издатель CRL. Обратите внимание: для повторяющихся значений возвращается только последнее. Информацию об обработке IDN см. в `name_encoding`. Возвращается: при успехе Пример: `{"commonName": "ca.example.com", "organizationName": "Ansible"}`
issuer_ordered список / элементы=список	Издатель CRL в виде упорядоченного списка кортежей. Возвращается: при успехе Пример: `[["organizationName", "Ansible"], [{"commonName": "ca.example.com"}]]`
last_update строка	Момент времени, начиная с которого этому CRL можно доверять, в формате ASN.1 TIME. Возвращается: при успехе Пример: `"20190413202428Z"`
next_update строка	Момент времени, начиная с которого будет выпущен новый CRL и клиент должен проверить его наличие, в формате ASN.1 TIME. Возвращается: при успехе Пример: `"20190413202428Z"`
revoked_certificates список / элементы=словарь	Список сертификатов, подлежащих отзыву. Возвращается: при успехе, если `list_revoked_certificates=true`
invalidity_date строка	Момент времени, когда стало известно или предполагалось, что закрытый ключ скомпрометирован либо сертификат по иной причине стал недействительным, в формате ASN.1 TIME. Возвращается: при успехе Пример: `"20190413202428Z"`
invalidity_date_critical логическое значение	Указывает, является ли расширение даты недействительности критическим. Возвращается: при успехе Пример: `false`
issuer список / элементы=строка	Издатель сертификата. Информацию об обработке IDN см. в `name_encoding`. Возвращается: при успехе Пример: `["DNS:ca.example.org"]`
issuer_critical логическое значение	Указывает, является ли расширение издателя сертификата критическим. Возвращается: при успехе Пример: `false`
reason строка	Значение расширения причины отзыва. Возвращается: при успехе Возможные возвращаемые значения: `"unspecified"` `"key_compromise"` `"ca_compromise"` `"affiliation_changed"` `"superseded"` `"cessation_of_operation"` `"certificate_hold"` `"privilege_withdrawn"` `"aa_compromise"` `"remove_from_crl"` Пример: `"key_compromise"`
reason_critical логическое значение	Указывает, является ли расширение причины отзыва критическим. Возвращается: при успехе Пример: `false`
revocation_date строка	Момент времени отзыва сертификата в формате ASN.1 TIME. Возвращается: при успехе Пример: `"20190413202428Z"`
serial_number целое число	Серийный номер сертификата. Это значение возвращается как целое число. Если серийные номера нужны в виде шестнадцатеричной строки с разделителями-двоеточиями, например `11:22:33`, преобразуйте его в этот формат с помощью community.crypto.to_serial. Возвращается: при успехе Пример: `1234`

Авторы

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/x509_crl_info_filter.html