Spec-Zone.ru › Ansible

Модуль community.crypto.x509_crl_info – Получение информации о списках отзыва сертификатов (CRLs)

Примечание

Этот модуль является частью коллекции community.crypto (версия 2.22.1).

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

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

Чтобы использовать его в книге задач, укажите: community.crypto.x509_crl_info.

Новый в community.crypto 1.0.0

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

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • Если name_encoding установлено не равным ignore, необходимо установить библиотеку Python idna.
  • cryptography >= 1.2

Параметры

Параметр

Комментарии

content

строка

Содержимое CRL X.509 в формате PEM или Base64-кодированное содержимое CRL X.509.

Должен быть указан либо 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

Поддержка: Отсутствует

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

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

Примечания

Примечание

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

См. также

См. также

community.crypto.x509_crl

Генерация списков отзыва сертификатов (CRLs).

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"

формат

строка

Формат CRL (в формате PEM (pem) или DER (der)).

Возвращаемое значение: успех

Возможные значения:

  • "pem"
  • "der"

Пример: "pem"

эмитент

словарь

Эмитент CRL.

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

См. name_encoding, чтобы узнать, как обрабатываются IDN.

Возвращаемое значение: успех

Пример: {"commonName": "ca.example.com", "organizationName": "Ansible"}

упорядоченный_эмитент

список / элементы=список

Эмитент CRL в виде упорядоченного списка кортежей.

Возвращаемое значение: успех

Пример: [["organizationName", "Ansible"], [{"commonName": "ca.example.com"}]]

последнее_обновление

строка

Время, с которого данный CRL считается надёжным, в формате ASN.1 TIME.

Возвращаемое значение: успех

Пример: "20190413202428Z"

следующее_обновление

строка

Время, с которого будет выпущен новый CRL, и клиент должен проверить его, в формате ASN.1 TIME.

Возвращаемое значение: успех

Пример: "20190413202428Z"

отменённые_сертификаты

список / элементы=словарь

Список сертификатов, подлежащих отмене.

Возвращаемое значение: успех, если list_revoked_certificates=true

дата_недействительности

строка

Время, когда стало известно/подозревалось, что закрытый ключ был скомпрометирован или сертификат стал недействительным, в формате ASN.1 TIME.

Возвращаемое значение: успех

Пример: "20190413202428Z"

критичная_дата_недействительности

булево

Является ли расширение даты недействительности критическим.

Возвращаемое значение: успех

Пример: false

эмитент

список / элементы=строка

Эмитент сертификата.

См. name_encoding, чтобы узнать, как обрабатываются IDN.

Возвращаемое значение: успех

Пример: ["DNS:ca.example.org"]

критичный_эмитент

булево

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

Возвращаемое значение: успех

Пример: false

причина

строка

Значение расширения причины отмены.

Возвращаемое значение: успех

Возможные значения:

  • "unspecified"
  • "key_compromise"
  • "ca_compromise"
  • "affiliation_changed"
  • "superseded"
  • "cessation_of_operation"
  • "certificate_hold"
  • "privilege_withdrawn"
  • "aa_compromise"
  • "remove_from_crl"

Пример: "key_compromise"

критичная_причина

булево

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

Возвращаемое значение: успех

Пример: false

дата_отмены

строка

Время отмены сертификата в формате ASN.1 TIME.

Возвращаемое значение: успех

Пример: "20190413202428Z"

номера_порядка

целое

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

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

Возвращаемое значение: успех

Пример: 1234

Авторы

  • Felix Fontein (@felixfontein)

Ссылки на сборники

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

© 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_module.html

Spec-Zone.ru

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