acme_account - Создание, изменение или удаление учетных записей с Let’s Encrypt
Новая в версии 2.6.
Обзор
- Позволяет создавать, изменять или удалять учетные записи с Let’s Encrypt. Let’s Encrypt — это бесплатный, автоматизированный и открытый центр сертификации (CA), работающий на благо общественности. Подробнее см. https://letsencrypt.org.
- Этот модуль работает только с протоколом ACME v2.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- openssl
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account_key_content (добавлено в 2.5) | Содержимое ключа учетной записи ACME RSA или эллиптической кривой. Взаимоисключающие с account_key_src.Требуется, если account_key_src не используется.Предупреждение: содержимое будет записано во временный файл, который будет удалён Ansible по завершении модуля. Поскольку это важный закрытый ключ — его можно использовать для изменения ключа учетной записи или для аннулирования сертификатов без знания их закрытых ключей —, это может быть неприемлемо. | |
| account_key_src | Путь к файлу, содержащему ключ учетной записи ACME RSA или эллиптической кривой. Ключи RSA можно создать с помощью openssl rsa .... Ключи эллиптической кривой можно создать с помощью openssl ecparam -genkey ....Взаимоисключающие с account_key_content.Требуется, если account_key_content не используется.Псевдонимы: account_key | |
| acme_directory | По умолчанию: "https://acme-staging.api.letsencrypt.org/directory" | Используемый каталог ACME. Это URL-адрес точки входа для доступа к API сервера CA. В целях безопасности значение по умолчанию установлено для тестового сервера Let's Encrypt (для протокола ACME v1). Это создаст технически корректные, но недоверенные сертификаты. Для Let's Encrypt все тестовые конечные точки можно найти здесь: https://letsencrypt.org/docs/staging-environment/
Для Let's Encrypt URL каталога производства для ACME v1 — https://acme-v01.api.letsencrypt.org/directory, а для ACME v2 — https://acme-v02.api.letsencrypt.org/directory.
Предупреждение: До сих пор модуль тестировался только с Let's Encrypt (тестовый и производственный серверы) и с тестовым сервером Pebble (https://github.com/letsencrypt/Pebble). |
| acme_version (добавлено в 2.5) |
| Версия ACME конечной точки. Должно быть 1 для классической конечной точки ACME Let's Encrypt или 2 для новой стандартизированной конечной точки ACME v2. |
| allow_creation bool |
| Разрешить создание учетной записи (когда состояние равно present). |
| contact | По умолчанию: [] | Список URL-адресов контактов. Электронные адреса должны быть префиксрованы с mailto:.См. https://tools.ietf.org/html/draft-ietf-acme-acme-10#section-7.1.2 для разрешенных значений. Обязательно указать, когда состояние равно present. Будет проигнорировано, если состояние равно absent или changed_key. |
| new_account_key_content | Содержимое ключа RSA или эллиптической кривой учетной записи Let's Encrypt для изменения. Применимы те же ограничения, что и для account_key_content.Взаимоисключающие с new_account_key_src.Требуется, если new_account_key_src не используется и состояние равно changed_key. | |
| new_account_key_src | Путь к файлу, содержащему ключ RSA или эллиптической кривой учетной записи Let's Encrypt для изменения. Применимы те же ограничения, что и для account_key_src.Взаимоисключающие с new_account_key_content.Требуется, если new_account_key_content не используется и состояние равно changed_key. | |
| state обязательно |
| Состояние учетной записи, определяемое её ключом. Если состояние равно absent, учетная запись либо не существует, либо деактивирована.Если состояние равно changed_key, учетная запись должна существовать. Ключ учетной записи будет изменён; никакая другая информация не будет изменена. |
| terms_agreed bool |
| Булево значение, указывающее, согласны ли вы с условиями обслуживания. Серверы ACME могут потребовать, чтобы это значение было истинным. |
| validate_certs bool (добавлено в 2.5) |
| Указывает, будут ли проверены сертификаты TLS при обращениях к каталогу ACME.
Предупреждение: Должно только устанавливаться в no для целей тестирования, например, при тестировании с локальным сервером Pebble. |
Примеры
- name: Make sure account exists and has given contacts. We agree to TOS.
acme_account:
account_key_src: /etc/pki/cert/private/account.key
state: present
terms_agreed: yes
contact:
- mailto:me@example.com
- mailto:myself@example.org
- name: Make sure account has given email address. Don't create account if it doesn't exist
acme_account:
account_key_src: /etc/pki/cert/private/account.key
state: present
allow_creation: no
contact:
- mailto:me@example.com
- name: Change account's key to the one stored in the variable new_account_key
acme_account:
account_key_src: /etc/pki/cert/private/account.key
new_account_key_content: '{{ new_account_key }}'
state: changed_key
- name: Delete account (we have to use the new key)
acme_account:
account_key_content: '{{ new_account_key }}'
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account_uri строка | всегда | URI учетной записи ACME или None, если учетная запись не существует. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратный.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом Ansible, см. в здесь.
Автор
- Felix Fontein (@felixfontein)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/acme_account_module.html
