Spec-Zone.ru › Ansible 2.10

community.crypto.ecs_domain – Запрос валидации домена с помощью API Entrust Certificate Services (ECS)

Примечание

Этот плагин входит в коллекцию community.crypto (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.crypto.

Для использования в плейбуке укажите: community.crypto.ecs_domain.

Новое в версии 1.0.0: из community.crypto

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

Обзор

  • Запрос валидации или повторной валидации домена с помощью API Entrust Certificate Services (ECS).
  • Требуются учетные данные для API Entrust Certificate Services (ECS).
  • Если домен уже находится в процессе валидации, новый запрос на валидацию не будет отправлен, но данные валидации (при наличии) будут возвращены.
  • Если домен уже находится в процессе валидации, но указанный verification_method отличается от текущего verification_method, verification_method будет обновлен, и данные валидации (при наличии) будут возвращены.
  • Если домен является активным, валидированным доменом, возвращаемое значение changed будет false, за исключением случаев domain_status=EXPIRED, в этом случае будет выполнена повторная валидация.
  • Если verification_method=dns, сведения о необходимом записей DNS будут указаны в возвращаемых параметрах dns_contents, dns_location и dns_resource_type.
  • Если verification_method=web_server, сведения о необходимых файлах будут указаны в возвращаемых параметрах file_contents и file_location.
  • Если verification_method=email, адреса электронной почты, которым были отправлены электронные письма с валидацией, будут содержаться в параметре возврата emails. Это исключительно информационные данные. Для доменов, запрошенных с помощью этого модуля, это всегда будет список размером 1.

Требования

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

  • PyYAML >= 3.11

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
client_id
целое число
Значение по умолчанию:
1
Идентификатор клиента, с которым будет связан домен.
Если идентификатор клиента не указан, домен будет добавлен под основного клиента с идентификатором 1.
domain_name
строка / обязательно
Имя домена, который нужно проверить или перепроверить.
entrust_api_client_cert_key_path
путь / обязательно
Путь к ключу для сертификата клиента, используемого для аутентификации в API Entrust Certificate Services (ECS).
entrust_api_client_cert_path
путь / обязательно
Путь к сертификату клиента, используемому для аутентификации в API Entrust Certificate Services (ECS).
entrust_api_key
строка / обязательно
Ключ (пароль) для аутентификации в API Entrust Certificate Services (ECS).
entrust_api_specification_path
путь
Значение по умолчанию:
"https://cloud.entrust.net/EntrustCloud/documentation/cms-api-2.1.0.yaml"
Путь к файлу спецификации, определяющему конфигурацию API Entrust Certificate Services (ECS).
Вы можете использовать его для сохранения локальной копии спецификации, чтобы избежать загрузки каждый раз, когда используется модуль.
entrust_api_user
строка / обязательно
Имя пользователя для аутентификации в API Entrust Certificate Services (ECS).
verification_email
строка
Адрес электронной почты, который будет использоваться для проверки владения доменом.
Адрес электронной почты должен быть либо адресом электронной почты, присутствующим в данных WHOIS для domain_name, либо одним из следующих сгенерированных адресов: admin@domain_name, administrator@domain_name, webmaster@domain_name, hostmaster@domain_name, postmaster@domain_name
Обратите внимание, что если domain_name включает поддомены, должен использоваться домен верхнего уровня. Например, при запросе валидации example1.ansible.com или test.example2.ansible.com, и вы хотите использовать предварительно сгенерированное имя "admin", адрес электронной почты должен быть admin@ansible.com.
Если используются значения электронной почты из данных WHOIS для домена или его домена верхнего уровня, они должны быть точным совпадением.
Если verification_method=email, но verification_email не указан, будет использован первый адрес электронной почты, найденный в данных WHOIS для домена.
Для проверки владения доменом владелец домена должен следовать инструкциям в полученном письме.
Разрешено только если verification_method=email
verification_method
строка / обязательно
    Варианты:
  • dns
  • email
  • manual
  • web_server
Метод проверки, используемый для подтверждения управления доменом.
Если verification_method=email и указано значение verification_email, это значение используется для валидации электронной почты. Если verification_email не указан, будет использовано первое значение, присутствующее в данных WHOIS. На указанный в verification_email адрес будет отправлено письмо с инструкциями по проверке управления доменом.
Если verification_method=dns, значение dns_contents должно быть сохранено в местоположении dns_location с типом записи DNS verification_dns_record_type. Для подтверждения владения доменом обновите записи DNS, чтобы текстовая строка, возвращённая dns_contents, была доступна по адресу dns_location.
Если verification_method=web_server, содержимое возвращаемого значения file_contents должно быть доступно на веб-сервере по адресу file_location.
Если verification_method=manual, домен будет валидирован с помощью ручного процесса. Это не рекомендуется.

Примечания

Примечание

  • Существует небольшая задержка (обычно около 5 секунд, но может составлять до 60 секунд) перед получением случайных значений при запросе валидации, если verification_method=dns или verification_method=web_server. Учитывайте это, если выполняете много запросов на валидацию доменов.

См. также

См. также

community.crypto.x509_certificate

Может использоваться для запроса сертификатов из ECS, с provider=entrust.

community.crypto.ecs_certificate

Может использоваться для запроса сертификата из ECS с использованием валидированного домена.

Примеры

- name: Request domain validation using email validation for client ID of 2.
  community.crypto.ecs_domain:
    domain_name: ansible.com
    client_id: 2
    verification_method: email
    verification_email: admin@ansible.com
    entrust_api_user: apiusername
    entrust_api_key: a^lv*32!cd9LnT
    entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
    entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key

- name: Request domain validation using DNS. If domain is already valid,
        request revalidation if expires within 90 days
  community.crypto.ecs_domain:
    domain_name: ansible.com
    verification_method: dns
    entrust_api_user: apiusername
    entrust_api_key: a^lv*32!cd9LnT
    entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
    entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key

- name: Request domain validation using web server validation, and revalidate
        if fewer than 60 days remaining of EV eligibility.
  community.crypto.ecs_domain:
    domain_name: ansible.com
    verification_method: web_server
    entrust_api_user: apiusername
    entrust_api_key: a^lv*32!cd9LnT
    entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
    entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key

- name: Request domain validation using manual validation.
  community.crypto.ecs_domain:
    domain_name: ansible.com
    verification_method: manual
    entrust_api_user: apiusername
    entrust_api_key: a^lv*32!cd9LnT
    entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
    entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key

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

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

Ключ Возвращаемое значение Описание
client_id
целое число
изменено или успешно
Идентификатор клиента, которому принадлежит домен. Если значение client_id указано в качестве входного параметра, оно всегда будет совпадать со значением client_id.

Пример:
1
dns_contents
строка
изменено и если verification_method — dns
Значение, которое ECS ожидает найти в записи DNS по адресу dns_location.

Пример:
AB23CD41432522FF2526920393982FAB
dns_location
строка
изменено и если verification_method — dns
Расположение, где ECS ожидает найти запись DNS для проверки домена, содержащую содержимое dns_contents.

Пример:
_pki-validation.ansible.com
dns_resource_type
строка
изменено и если verification_method — dns
Тип записи ресурса, который ECS ожидает найти в записи DNS по адресу dns_location.

Пример:
TXT
domain_status
строка
изменено или успешно
Статус текущего домена. Будет одним из значений APPROVED, DECLINED, CANCELLED, INITIAL_VERIFICATION, DECLINED, CANCELLED, RE_VERIFICATION, EXPIRED, EXPIRING.

Пример:
APPROVED
emails
список / элементы=строка
verification_method — email
Список электронных адресов, используемых для запроса проверки этого домена.
Домены, запрошенные с помощью этого модуля, будут иметь список размером 1.

Пример:
['admin@ansible.com', 'administrator@ansible.com']
ev_days_remaining
целое число
успешно и ev_eligible — true и domain_status — APPROVED, RE_VERIFICATION или EXPIRING.
Количество дней, в течение которых домен остается подходящим для отправки сертификатов «EV». Никогда не будет больше значения ov_days_remaining

Пример:
94
ev_eligible
логическое значение
успешно и domain_status — APPROVED, RE_VERIFICATION или EXPIRING, или EXPIRED.
Подходит ли домен для отправки сертификатов «EV». Никогда не будет true если ov_eligible — false

Пример:
True
file_contents
строка
verification_method — web_server
Содержимое файла, которое ECS ожидает найти по адресу file_location.

Пример:
AB23CD41432522FF2526920393982FAB
file_location
строка
verification_method — web_server
Расположение, где ECS ожидает найти файл для проверки домена, содержащий содержимое file_contents.

Пример:
http://ansible.com/.well-known/pki-validation/abcd.txt
ov_days_remaining
целое число
успешно и ov_eligible — true и domain_status — APPROVED, RE_VERIFICATION или EXPIRING.
Количество дней, в течение которых домен остается подходящим для отправки сертификатов «OV». Никогда не будет меньше значения ev_days_remaining

Пример:
129
ov_eligible
логическое значение
успешно и domain_status — APPROVED, RE_VERIFICATION, EXPIRING, или EXPIRED.
Подходит ли домен для отправки сертификатов «OV». Никогда не будет false если ov_eligible — true

Пример:
True
verification_method
строка
изменено или успешно
Метод проверки, используемый для запроса проверки домена. Если changed, будет совпадать с входным параметром verification_method.

Пример:
dns


Авторы

  • Chris Trufan (@ctrufan)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/crypto/ecs_domain_module.html

Spec-Zone.ru

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