Spec-Zone.ru › Ansible

Модуль community.crypto.acme_certificate_deactivate_authz — деактивация всех объектов authz для заказа ACME v2

Примечание

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

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

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

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

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

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

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

  • Деактивирует все объекты авторизации (authz) для заказа ACME v2, что фактически деактивирует (аннулирует) сам заказ.
  • Объекты авторизации привязаны к ключу учётной записи и остаются действительными в течение определённого времени. Их можно использовать для выпуска сертификатов без повторной проверки домена. Это может представлять угрозу безопасности.
  • Ещё одна причина использовать этот модуль — деактивировать заказ, обработка которого завершилась с ошибкой при использовании include_renewal_cert_id.

Требования

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

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

Параметры

Параметр

Описание

account_key_content

string

Содержимое ключа учётной записи ACME RSA или ключа на эллиптических кривых.

Для ключей на эллиптических кривых поддерживаются только следующие кривые: secp256r1, secp384r1 и secp521r1.

Взаимоисключающий параметр с account_key_src.

Обязателен, если не используется account_key_src.

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

Если используется cryptography, содержимое не записывается во временный файл. Однако Ansible может записать его на диск при переносе модуля вместе с аргументом на узел, где он выполняется.

account_key_passphrase

string

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

Парольная фраза для расшифровки ключа учётной записи.

Примечание: это не поддерживается бэкендом openssl, только бэкендом cryptography.

account_key_src

псевдонимы: account_key

path

Путь к файлу, содержащему ключ учётной записи ACME RSA или ключ на эллиптических кривых.

Для ключей на эллиптических кривых поддерживаются только следующие кривые: secp256r1, secp384r1 и secp521r1.

Закрытые ключи можно создать с помощью модулей community.crypto.openssl_privatekey или community.crypto.openssl_privatekey_pipe. Если необходимый компонент (cryptography) недоступен, ключи также можно создать непосредственно с помощью инструмента командной строки openssl: ключи RSA можно создать командой openssl genrsa .... Ключи на эллиптических кривых можно создать командой openssl ecparam -genkey .... Можно использовать и любые другие инструменты, создающие закрытые ключи в формате PEM.

Взаимоисключающий параметр с account_key_content.

Обязателен, если не используется account_key_content.

account_uri

string

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

acme_directory

string / обязательный

Каталог ACME, который нужно использовать. Это URL точки входа для доступа к API сервера центра сертификации 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 ← (по умолчанию)

order_uri

string / обязательный

Заказ ACME v2, который нужно деактивировать.

Можно получить из order_uri.

request_timeout

integer

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

Время ожидания ответа от API ACME для Ansible.

Этот тайм-аут применяется ко всем 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 ← (по умолчанию)

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группы действий: community.crypto.acme, acme

Используйте group/acme или group/community.crypto.acme в module_defaults, чтобы задать значения по умолчанию для этого модуля.

check_mode

Поддержка: full

Модуль можно запустить в режиме check_mode и получить прогноз изменения статуса, не изменяя целевой объект.

diff_mode

Поддержка: none

В режиме сравнения изменений будут возвращены сведения о том, что изменилось (или, возможно, должно измениться в check_mode).

idempotent

Поддержка: full

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

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

Примечания

Примечание

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

См. также

См. также

community.crypto.acme_certificate

Создание сертификатов SSL/TLS с помощью протокола ACME.

Примеры

---
- name: Deactivate all authzs for an order
  community.crypto.acme_certificate_deactivate_authz:
    account_key_content: "{{ account_private_key }}"
    order_uri: "{{ certificate_result.order_uri }}"

Авторы

  • Felix Fontein (@felixfontein)

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

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

Spec-Zone.ru

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