Модуль community.crypto.openssl_dhparam — создание параметров Диффи — Хеллмана OpenSSL
Примечание
Этот модуль входит в коллекцию community.crypto (версия 3.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.crypto. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.crypto.openssl_dhparam.
Краткое описание
- Этот модуль позволяет создавать или повторно генерировать параметры DH OpenSSL.
- Для указания прав доступа к создаваемому файлу модуль использует общие аргументы файла.
- Обратите внимание: модуль повторно генерирует существующие параметры DH, если они не соответствуют параметрам модуля. Если вы опасаетесь, что это может привести к перезаписи существующих параметров DH, рассмотрите возможность использования параметра
backup. - Модуль может использовать библиотеку Python cryptography или исполняемый файл
openssl. По умолчанию он пытается определить, что из этого доступно. Это поведение можно изменить с помощью параметраselect_crypto_backend.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- Либо cryptography >= 3.3
- Либо исполняемый файл OpenSSL
openssl
Параметры
Параметр | Комментарии |
|---|---|
attributes псевдонимы: attr string | Атрибуты, которыми должен обладать результирующий объект файловой системы. Список поддерживаемых флагов см. на странице руководства Эта строка должна содержать атрибуты в том же порядке, в каком они отображаются командой По умолчанию предполагается оператор |
backup boolean | Создать резервную копию с временной меткой, чтобы можно было восстановить исходные параметры DH, если вы случайно перезаписали их новыми. Варианты:
|
force boolean | Следует ли повторно генерировать параметры, даже если они уже существуют. Варианты:
|
group string | Имя группы, которой должен принадлежать объект файловой системы; это значение передается команде Если значение не указано, используется текущая группа текущего пользователя, если только вы не root; в этом случае может быть сохранен прежний владелец. |
mode any | Права доступа, которыми должен обладать результирующий объект файловой системы. Если вы привыкли к Если передать Ansible число, не соблюдая ни одно из этих правил, оно будет интерпретировано как десятичное, что приведет к неожиданным результатам. Начиная с Ansible 1.8, режим можно задавать в символьной форме (например, Если параметр Если параметр Указание |
owner string | Имя пользователя, которому должен принадлежать объект файловой системы; это значение передается команде Если значение не указано, используется текущий пользователь, если только вы не root; в этом случае может быть сохранен прежний владелец. Числовое имя пользователя будет считаться идентификатором пользователя, а не именем пользователя. Во избежание неоднозначности не используйте числовые имена пользователей. |
path path / обязательный | Имя файла, в который будут сохранены созданные параметры. |
return_content boolean добавлено в community.crypto 1.0.0 | Если задано значение Варианты:
|
select_crypto_backend string добавлено в community.crypto 1.0.0 | Определяет, какую криптографическую среду использовать. По умолчанию выбирается Если задано значение Если задано значение Варианты:
|
selevel string | Уровень в контексте объекта файловой системы SELinux. Это атрибут MLS/MCS, иногда называемый Если задано значение |
serole string | Роль в контексте объекта файловой системы SELinux. Если задано значение |
setype string | Тип в контексте объекта файловой системы SELinux. Если задано значение |
seuser string | Пользователь в контексте объекта файловой системы SELinux. По умолчанию, если применимо, используется политика Если задано значение |
size integer | Размер создаваемых параметров DH (в битах). По умолчанию: |
state string | Должны ли параметры существовать; модуль выполняет действие, если фактическое состояние отличается от указанного. Варианты:
|
unsafe_writes boolean | Определяет, когда использовать атомарные операции для предотвращения повреждения данных или несогласованного чтения целевого объекта файловой системы. По умолчанию этот модуль использует атомарные операции для предотвращения повреждения данных или несогласованного чтения целевых объектов файловой системы, однако иногда настройки системы или ее неисправности делают это невозможным. Например, объекты файловой системы, смонтированные в Docker, нельзя атомарно обновить из контейнера — их можно записать только небезопасным способом. Этот параметр позволяет Ansible при сбое атомарных операций перейти к небезопасным методам обновления объектов файловой системы (однако он не заставляет Ansible выполнять небезопасную запись). ВАЖНО! Небезопасная запись подвержена гонкам и может привести к повреждению данных. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Может работать в режиме |
diff_mode | Поддержка: нет | В режиме diff возвращает сведения о том, что изменилось (или, возможно, должно измениться в |
idempotent | Поддержка: частичная Модуль не является идемпотентным, если | При повторном запуске с теми же аргументами вне режима проверки второй вызов не сообщает об изменениях. Предполагается, что система, состояние которой контролирует или запрашивает модуль, не изменилась существенным образом. |
safe_file_operations | Поддержка: полная | Использует строгие функции Ansible для работы с файлами, чтобы обеспечивать правильные права доступа и предотвращать повреждение данных. |
См. также
См. также
- community.crypto.x509_certificate
-
Создание и/или проверка сертификатов OpenSSL.
- community.crypto.openssl_csr
-
Создание запроса на подпись сертификата (CSR) OpenSSL.
- community.crypto.openssl_pkcs12
-
Создание архива PKCS#12 OpenSSL.
- community.crypto.openssl_privatekey
-
Создание закрытых ключей OpenSSL.
- community.crypto.openssl_publickey
-
Создание открытого ключа OpenSSL на основе закрытого ключа.
Примеры
---
- 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: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
backup_file string | Имя созданного файла резервной копии. Возвращается: при изменении и если Пример: |
dhparams string добавлено в community.crypto 1.0.0 | Содержимое параметров DH (текущих или созданных). Возвращается: если |
filename string | Путь к созданным параметрам Диффи — Хеллмана. Возвращается: при изменении или успешном выполнении Пример: |
size integer | Размер параметров Диффи — Хеллмана (в битах). Возвращается: при изменении или успешном выполнении Пример: |
Ссылки на коллекцию
© 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/openssl_dhparam_module.html