community.crypto.acme_challenge_cert_helper – Подготовка сертификатов, необходимых для вызовов ACME, таких как tls-alpn-01
Примечание
Этот плагин входит в коллекцию community.crypto (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install community.crypto.
Для использования в книге задач укажите: community.crypto.acme_challenge_cert_helper.
Обзор
- Подготавливает сертификаты для вызовов ACME, таких как
tls-alpn-01. - Необработанные данные предоставляются модулем community.crypto.acme_certificate и должны быть преобразованы в сертификат для проверки вызова. Этот модуль предоставляет простой способ генерации необходимых сертификатов.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- cryptography >= 1.3
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| challenge строка / обязательно |
| Тип вызова. |
| challenge_data словарь / обязательно | Запись challenge_data предоставленная community.crypto.acme_certificate для вызова. | |
| private_key_content строка | Содержимое закрытого ключа для использования для этого сертификата вызова. Взаимоисключающее с private_key_src. | |
| private_key_src путь | Путь к файлу, содержащему закрытый ключ для использования для этого сертификата вызова. Взаимоисключающее с private_key_content. |
Примечания
Примечание
- Не поддерживает
check_mode.
См. также
См. также
- Automatic Certificate Management Environment (ACME)
-
Спецификация протокола ACME (RFC 8555).
- ACME TLS ALPN Challenge Extension
-
Спецификация вызова
tls-alpn-01(RFC 8737).
Примеры
- name: Create challenges for a given CRT for sample.com
community.crypto.acme_certificate:
account_key_src: /etc/pki/cert/private/account.key
challenge: tls-alpn-01
csr: /etc/pki/cert/csr/sample.com.csr
dest: /etc/httpd/ssl/sample.com.crt
register: sample_com_challenge
- name: Create certificates for challenges
community.crypto.acme_challenge_cert_helper:
challenge: tls-alpn-01
challenge_data: "{{ item.value['tls-alpn-01'] }}"
private_key_src: /etc/pki/cert/key/sample.com.key
loop: "{{ sample_com_challenge.challenge_data | dictsort }}"
register: sample_com_challenge_certs
- name: Install challenge certificates
# We need to set up HTTPS such that for the domain,
# regular_certificate is delivered for regular connections,
# except if ALPN selects the "acme-tls/1"; then, the
# challenge_certificate must be delivered.
# This can for example be achieved with very new versions
# of NGINX; search for ssl_preread and
# ssl_preread_alpn_protocols for information on how to
# route by ALPN protocol.
...:
domain: "{{ item.domain }}"
challenge_certificate: "{{ item.challenge_certificate }}"
regular_certificate: "{{ item.regular_certificate }}"
private_key: /etc/pki/cert/key/sample.com.key
loop: "{{ sample_com_challenge_certs.results }}"
- name: Create certificate for a given CSR for sample.com
community.crypto.acme_certificate:
account_key_src: /etc/pki/cert/private/account.key
challenge: tls-alpn-01
csr: /etc/pki/cert/csr/sample.com.csr
dest: /etc/httpd/ssl/sample.com.crt
data: "{{ sample_com_challenge }}"
Возвращаемые значения
Общие значения возврата задокументированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| challenge_certificate строка | всегда | Сертификат вызова в формате PEM. |
| domain строка | всегда | Домен, для которого предназначен вызов. Сертификат должен быть предоставлен, если это указано в заголовке запроса Host. |
| identifier строка | всегда | Идентификатор фактического ресурса. Будет именем домена, если тип dns, или IP-адресом, если тип ip. |
| identifier_type строка | всегда | Тип идентификатора для фактического идентификатора ресурса. Будет dns или ip. |
| regular_certificate строка | всегда | Самозаверяющий сертификат для домена вызова. Если существующий сертификат отсутствует, может быть использован для настройки https, если это необходимо для предоставления вызова. |
Авторы
- Felix Fontein (@felixfontein)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/crypto/acme_challenge_cert_helper_module.html