модуль community.crypto.acme_ari_info — получение информации о продлении ACME (ARI) для сертификата

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.crypto.acme_ari_info.

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

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

Обзор

Позволяет получить информацию о продлении сертификата, полученного с помощью протокола ACME.
Этот модуль работает только с протоколом ACME v2 и требует, чтобы сервер ACME поддерживал расширение ARI (RFC 9773).

Требования

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

либо openssl
либо cryptography >= 3.3

Параметры

Параметр	Комментарии
acme_directory string / обязательный	Каталог ACME, который следует использовать. Это URL точки входа для доступа к API сервера центра сертификации (CA) ACME. В целях безопасности по умолчанию используется тестовый сервер Let’s Encrypt (для протокола ACME v1). Он создаёт технически корректные, но недоверенные сертификаты. Все тестовые конечные точки Let’s Encrypt доступны здесь: https://letsencrypt.org/docs/staging-environment/. Для Let’s Encrypt URL производственного каталога ACME v2: https://acme-v02.api.letsencrypt.org/directory. Для ZeroSSL URL производственного каталога ACME v2: https://acme.zerossl.com/v2/DV90. Для Sectigo URL производственного каталога ACME v2: https://acme-qa.secure.trust-provider.com/v2/DV. Для HARICA URL производственного каталога ACME v2: https://acme.harica.gr/XXX/directory, где XXX зависит от вашей учётной записи. В примечаниях к этому модулю приведён список служб ACME, с которыми он прошёл тестирование.
acme_version integer	Версия ACME конечной точки. Для стандартизированных конечных точек ACME v2 должно быть указано `2`. Значение `1` больше не поддерживается начиная с community.crypto 3.0.0. Варианты: `2` ← (по умолчанию)
certificate_content string	Содержимое сертификата X.509, для которого запрашивается информация. Необходимо указать ровно один из параметров `certificate_path` и `certificate_content`.
certificate_path path	Путь к сертификату X.509, для которого запрашивается информация. Необходимо указать ровно один из параметров `certificate_path` и `certificate_content`.
request_timeout integer добавлено в community.crypto 2.3.0	Время, в течение которого Ansible ожидает ответ от API ACME. Это время ожидания применяется ко всем HTTP(S)-запросам (HEAD, GET, POST). По умолчанию: `10`
select_crypto_backend string	Определяет, какую криптографическую подсистему использовать. По умолчанию выбирается `auto`: сначала модуль пытается использовать `cryptography`, если оно доступно, а при его отсутствии переключается на `openssl`. Если задано значение `openssl`, модуль попытается использовать двоичный файл `openssl`. Если задано значение `cryptography`, модуль попытается использовать библиотеку cryptography. Варианты: `"auto"` ← (по умолчанию) `"cryptography"` `"openssl"`
validate_certs boolean	Проверять ли сертификаты TLS при обращении к каталогу ACME. Предупреждение: Значение `false` следует указывать только для тестирования, например при тестировании с локальным сервером Pebble. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме различий будут возвращены сведения об изменениях (или о возможных изменениях в `check_mode`).
idempotent	Поддержка: полная Это действие не изменяет состояние.	При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений. Предполагается, что система, управляемая модулем или к которой он обращается, не изменилась существенным образом.

Примечания

Примечание

Хотя значения по умолчанию выбраны таким образом, чтобы модуль можно было использовать с CA Let’s Encrypt, в принципе модуль совместим с любым CA, предоставляющим конечную точку ACME.
На данный момент разработчики тестировали модули ACME только с Let’s Encrypt (тестовый и производственный серверы), ZeroSSL (производственный сервер) и тестовым сервером Pebble. Сообщество сообщало, что они также работают с Sectigo ACME Service for InCommon и HARICA. Если у вас возникли проблемы с другим сервером ACME, пожалуйста, создайте задачу, чтобы помочь нам обеспечить его поддержку. Мы также будем благодарны за информацию о том, что сервер ACME, не упомянутый здесь, работает.
Если доступна достаточно новая версия библиотеки cryptography (подробности см. в разделе «Требования»), она будет использоваться вместо двоичного файла openssl. Это можно явно отключить или включить с помощью параметра select_crypto_backend. Учтите, что использование двоичного файла openssl будет медленнее.

См. также

community.crypto.acme_certificate: Позволяет получить сертификат с помощью протокола ACME.
community.crypto.acme_certificate_revoke: Позволяет отозвать сертификат с помощью протокола ACME.

Примеры

---
- name: Retrieve renewal information for a certificate
  community.crypto.acme_ari_info:
    certificate_path: /etc/httpd/ssl/sample.com.crt
  register: cert_data

- name: Show the certificate renewal information
  ansible.builtin.debug:
    var: cert_data.renewal_info

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

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

Ключ	Описание
renewal_info dictionary	Объект информации о продлении ARI (https://www.rfc-editor.org/rfc/rfc9773.html#section-4.2). Возвращается: при успешном выполнении
explanationURL string	URL-адрес страницы с возможным объяснением того, почему рекомендованное окно продления выбрано именно таким. Например, это может быть страница с описанием стратегии динамической балансировки нагрузки CA или страница с документированием сертификатов, затронутых массовым отзывом. Эту информацию следует показывать пользователю. Возвращается: зависит от сервера ACME Пример: `"https://example.com/docs/ari"`
retryAfter string	Метка времени, до которой не следует повторно запрашивать эту информацию. Возвращается: зависит от сервера ACME Пример: `"2024-04-29T01:17:10.236921+00:00"`
suggestedWindow dictionary	Описывает период, в течение которого следует продлить сертификат. Возвращается: всегда
end string	Конец периода, в течение которого следует продлить сертификат. Формат определён в RFC 3339. Возвращается: всегда Пример: `"2021-01-03T00:00:00Z"`
start string	Начало периода, в течение которого следует продлить сертификат. Формат определён в RFC 3339. Возвращается: всегда Пример: `"2021-01-03T00:00:00Z"`

Авторы

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