Spec-Zone.ru › Ansible

Модуль community.crypto.x509_crl_info — получение сведений о списках отзыва сертификатов (CRL)

Примечание

Этот модуль входит в коллекцию 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 1.0.0

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

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

  • Этот модуль позволяет получать сведения о списках отзыва сертификатов (CRL).

Требования

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

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

Параметры

Параметр

Комментарии

content

строка

Содержимое CRL X.509 в формате PEM или CRL X.509, закодированный в Base64.

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

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"

path

путь

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

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

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

diff_mode

Поддержка: не применимо

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

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

idempotent

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

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

При повторном запуске с теми же аргументами вне режима проверки второй вызов сообщает об отсутствии изменений.

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

Примечания

Примечание

  • Все значения временных меток представлены в формате ASN.1 TIME, то есть соответствуют шаблону YYYYMMDDHHMMSSZ. Все значения указаны в формате UTC.

См. также

См. также

community.crypto.x509_crl

Создание списков отзыва сертификатов (CRL).

community.crypto.x509_crl_info — плагин фильтра

Вариант этого модуля в виде фильтра.

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

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

Примеры

---
- name: Get information on CRL
  community.crypto.x509_crl_info:
    path: /etc/ssl/my-ca.crl
  register: result

- name: Print the information
  ansible.builtin.debug:
    msg: "{{ result }}"

- name: Get information on CRL without list of revoked certificates
  community.crypto.x509_crl_info:
    path: /etc/ssl/very-large.crl
    list_revoked_certificates: false
  register: result

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

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

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.

Если такая временная метка отсутствует, значение будет none.

Возвращается: при успешном выполнении

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

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

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

Spec-Zone.ru

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