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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: 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 строка	Как кодировать имена (доменные имена, URI, адреса электронной почты) в возвращаемых значениях. `ignore` будет использовать кодировку, возвращаемую серверной частью. `idna` преобразует все метки доменных имен в кодировку IDNA. Будет предпочтительнее IDNA2008, а IDNA2003 будет использоваться, если кодировка IDNA2008 не удалась. `unicode` преобразует все метки доменных имен в Юникод. Будет предпочтительнее IDNA2008, а IDNA2003 будет использоваться, если декодирование IDNA2008 не удалось. Примечание, что `idna` и `unicode` требуют установки библиотеки Python idna. Варианты: `"ignore"` ← (по умолчанию) `"idna"` `"unicode"`

Параметр

Комментарии

list_revoked_certificates

логическое

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

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

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

Варианты:

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

name_encoding

строка

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

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

idna преобразует все метки доменных имен в кодировку IDNA. Будет предпочтительнее IDNA2008, а IDNA2003 будет использоваться, если кодировка IDNA2008 не удалась.

unicode преобразует все метки доменных имен в Юникод. Будет предпочтительнее IDNA2008, а IDNA2003 будет использоваться, если декодирование IDNA2008 не удалось.

Примечание, что 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
      }}

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

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

serial_number

integer

Серийный номер сертификата.

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

Возвращено: success

Пример: 1234

Авторы

Felix Fontein (@felixfontein)

Подсказка

Записи конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, которая находится ниже в списке, переопределит переменную, которая находится выше.

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/crypto/x509_crl_info_filter.html