community.crypto.openssl_dhparam – Генерация параметров Diffie-Hellman OpenSSL

Примечание

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

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

Для использования в книге задач укажите: community.crypto.openssl_dhparam.

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

Обзор

Этот модуль позволяет (пере)генерировать параметры OpenSSL DH.
Этот модуль использует общие аргументы файла для указания разрешений генерируемого файла.
Обратите внимание, что модуль перегенерирует существующие параметры DH, если они не совпадают с параметрами модуля. Если вы обеспокоены тем, что это может перезаписать ваши существующие параметры DH, рассмотрите использование параметра backup.
Модуль может использовать библиотеку cryptography Python или исполняемый файл openssl. По умолчанию он пытается определить, какой из них доступен. Это можно переопределить с помощью параметра select_crypto_backend.

Требования

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

Cryptography >= 2.0
Или исполняемый файл OpenSSL openssl

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
attributes строка добавлен в версии 2.3 ansible.builtin		Атрибуты, которые должен иметь результирующий файл или каталог. Чтобы получить поддерживаемые флаги, см. страницу справки для chattr на целевой системе. Эта строка должна содержать атрибуты в том же порядке, что и при отображении lsattr. Оператор `=` используется по умолчанию, в противном случае операторы `+` или `-` необходимо включить в строку. псевдонимы: attr
backup логический	Варианты: нет ← да	Создать резервную копию файла, включая отметку времени, чтобы вы могли вернуть исходные параметры DH, если случайно перезаписали их новыми.
force логический	Варианты: нет ← да	Параметры должны быть перегенерированы, даже если они уже существуют?
group строка		Имя группы, которой должен принадлежать файл/каталог, как это передается в chown.
mode сырой		Разрешения, которые должен иметь результирующий файл или каталог. Для тех, кто привык к /usr/bin/chmod, помните, что режимы фактически являются восьмеричными числами. Вы должны либо добавить ведущий ноль, чтобы интерпретатор YAML Ansible понял, что это восьмеричное число (например, `0644` или `01777`), либо заключить его в кавычки (например, `'644'` или `'1777'`), чтобы Ansible получил строку и выполнил собственное преобразование из строки в число. Предоставление Ansible числа без выполнения одного из этих правил приведет к десятичному числу, что приведет к непредвиденным результатам. Начиная с Ansible 1.8, режим может быть указан в символическом формате (например, `u+rwx` или `u=rw,g=r,o=r`).
owner строка		Имя пользователя, которому должен принадлежать файл/каталог, как это передается в chown.
path путь / обязательный		Имя файла, в котором будут сохранены сгенерированные параметры.
return_content логический добавлен в 1.0.0 community.crypto	Варианты: нет ← да	Если установлено значение `yes`, будет возвращено содержимое (текущих или сгенерированных) параметров DH как dhparams.
select_crypto_backend строка добавлен в 1.0.0 community.crypto	Варианты: auto ← cryptography openssl	Определяет, какой криптографический бэкенд использовать. Значение по умолчанию — `auto`, которое пытается использовать `cryptography`, если оно доступно, и переходит на `openssl`. Если установлено значение `openssl`, будет попытка использовать исполняемый файл OpenSSL `openssl`. Если установлено значение `cryptography`, будет попытка использования библиотеки cryptography.
selevel строка		Часть контекста SELinux-файла. Это атрибут MLS/MCS, иногда известный как `range`. Когда установлено значение `_default`, используется часть политики `level`, если она доступна.
serole строка		Часть контекста SELinux-файла. Если установлено значение `_default`, используется часть политики `role`, если она доступна.
setype строка		Часть контекста SELinux-файла. Если установлено значение `_default`, используется часть политики `type`, если она доступна.
seuser строка		Часть контекста SELinux-файла. По умолчанию используется политика `system`, если применимо. Если установлено значение `_default`, используется часть политики `user`, если она доступна.
size целое число	Значение по умолчанию: 4096	Размер (в битах) генерируемых параметров DH.
state строка	Варианты: отсутствует присутствует ←	Должны ли параметры существовать или нет, выполняя действия, если состояние отличается от указанного.
unsafe_writes логический добавлен в 2.2 ansible.builtin	Варианты: нет ← да	Влияет на использование атомарной операции для предотвращения повреждения данных или несогласованного чтения из целевого файла. По умолчанию этот модуль использует атомарные операции для предотвращения повреждения данных или несогласованного чтения из целевых файлов, но иногда системы настроены или просто неисправны таким образом, что это невозможно. Один пример — файлы, смонтированные в Docker, которые не могут быть обновлены атомарно изнутри контейнера и могут быть записаны только небезопасным способом. Этот параметр позволяет Ansible переходить к небезопасным методам обновления файлов, когда атомарные операции завершаются неудачей (однако он не заставляет Ansible выполнять небезопасные записи). ВАЖНО! Небезопасные записи подвержены гонкам и могут привести к повреждению данных.

См. также

community.crypto.x509_certificate: Официальная документация модуля community.crypto.x509_certificate.
community.crypto.openssl_csr: Официальная документация модуля community.crypto.openssl_csr.
community.crypto.openssl_pkcs12: Официальная документация модуля community.crypto.openssl_pkcs12.
community.crypto.openssl_privatekey: Официальная документация модуля community.crypto.openssl_privatekey.
community.crypto.openssl_publickey: Официальная документация модуля community.crypto.openssl_publickey.

Примеры

- name: Generate Diffie-Hellman parameters with the default size (4096 bits)
  community.crypto.openssl_dhparam:
    path: /etc/ssl/dhparams.pem

- name: Generate DH Parameters with a different size (2048 bits)
  community.crypto.openssl_dhparam:
    path: /etc/ssl/dhparams.pem
    size: 2048

- name: Force regenerate an DH parameters if they already exist
  community.crypto.openssl_dhparam:
    path: /etc/ssl/dhparams.pem
    force: yes

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

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

Ключ	Возвращаемое значение	Описание
backup_file строка	изменен и если backup `yes`	Имя созданного файла резервной копии. Пример: /path/to/dhparams.pem.2019-03-09@11:22~
dhparams строка добавлен в 1.0.0 community.crypto	если state `present` и return_content `yes`	Содержимое (текущих или сгенерированных) параметров DH.
filename строка	изменен или успех	Путь к сгенерированным параметрам Diffie-Hellman. Пример: /etc/ssl/dhparams.pem
size целое число	изменен или успех	Размер (в битах) параметров Diffie-Hellman. Пример: 4096

Авторы

Том Виггерс (@thomwiggers)

© 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/openssl_dhparam_module.html