Spec-Zone.ru › Ansible

Модуль community.crypto.openssl_privatekey_convert – преобразование закрытых ключей OpenSSL

Примечание

Этот модуль входит в коллекцию community.crypto (версия 3.2.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.crypto. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.crypto.openssl_privatekey_convert.

Добавлено в community.crypto 2.1.0

  • Краткое описание
  • Требования
  • Параметры
  • Атрибуты
  • См. также
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет преобразовывать закрытые ключи OpenSSL.
  • Если mode явно не задан, для файла закрытого ключа будет использоваться режим 0600 по умолчанию.

Требования

Следующие требования необходимы на узле, на котором выполняется этот модуль.

  • cryptography >= 3.3

Параметры

Параметр

Комментарии

attributes

псевдонимы: attr

строка

Атрибуты, которые должен иметь результирующий объект файловой системы.

Список поддерживаемых флагов см. на странице руководства для chattr в целевой системе.

Эта строка должна содержать атрибуты в том же порядке, в каком они отображаются командой lsattr.

По умолчанию предполагается оператор =; в противном случае в строку необходимо включить операторы + или -.

backup

логическое значение

Создать резервную копию с отметкой времени, чтобы можно было восстановить исходный закрытый ключ, если вы случайно перезаписали его новым.

Варианты:

  • false ← (по умолчанию)
  • true

dest_passphrase

строка

Парольная фраза для сохраняемого закрытого ключа.

dest_path

путь / обязательный

Имя файла, в который будет записан сгенерированный закрытый ключ TLS/SSL. Если mode явно не задан, для файла будет использоваться режим 0600.

format

строка / обязательный

Определяет формат записи целевого закрытого ключа.

Обратите внимание, что не каждый ключ можно экспортировать в любом формате и не каждый формат поддерживает шифрование.

Варианты:

  • "pkcs1"
  • "pkcs8"
  • "raw"

group

строка

Имя группы, которой должен принадлежать объект файловой системы; оно передавалось бы команде chown.

Если значение не указано, используется текущая группа текущего пользователя, если только вы не root; в этом случае может быть сохранена прежняя принадлежность.

mode

любое значение

Права доступа, которые должен иметь результирующий объект файловой системы.

Если вы привыкли к /usr/bin/chmod, помните, что режимы на самом деле являются восьмеричными числами. Необходимо предоставить Ansible достаточно сведений для их правильной интерпретации. Для единообразия заключайте восьмеричные числа в кавычки (например, '644' или '1777'), чтобы Ansible получил строку и самостоятельно преобразовал её в число. Добавление ведущего нуля (например, 0755) иногда работает, но может привести к сбою в циклах и некоторых других случаях.

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

Начиная с Ansible 1.8 режим можно указывать в символьном формате (например, u+rwx или u=rw,g=r,o=r).

Если mode не указано и целевой объект файловой системы не существует, при задании режима для вновь созданного объекта файловой системы будет использоваться системное значение по умолчанию umask.

Если mode не указано и целевой объект файловой системы существует, будет использоваться режим существующего объекта файловой системы.

Указание mode — лучший способ обеспечить создание объектов файловой системы с правильными правами доступа. Подробности см. в CVE-2020-1736.

owner

строка

Имя пользователя, которому должен принадлежать объект файловой системы; оно передавалось бы команде chown.

Если значение не указано, используется текущий пользователь, если только вы не root; в этом случае может быть сохранена прежняя принадлежность.

Числовое имя пользователя будет считаться идентификатором пользователя, а не его именем. Во избежание путаницы не используйте числовые имена пользователей.

selevel

строка

Часть уровня в контексте объекта файловой системы SELinux.

Это атрибут MLS/MCS, иногда называемый range.

Если задано значение _default, будет использоваться часть level политики, если она доступна.

serole

строка

Часть роли в контексте объекта файловой системы SELinux.

Если задано значение _default, будет использоваться часть role политики, если она доступна.

setype

строка

Часть типа в контексте объекта файловой системы SELinux.

Если задано значение _default, будет использоваться часть type политики, если она доступна.

seuser

строка

Часть пользователя в контексте объекта файловой системы SELinux.

По умолчанию используется политика system, если она применима.

Если задано значение _default, будет использоваться часть user политики, если она доступна.

src_content

строка

Содержимое файла, в котором находится преобразуемый закрытый ключ OpenSSL.

Необходимо указать ровно один из параметров: src_path или src_content.

src_passphrase

строка

Парольная фраза для загружаемого закрытого ключа.

src_path

путь

Имя файла, в котором находится преобразуемый закрытый ключ OpenSSL.

Необходимо указать ровно один из параметров: src_path или src_content.

unsafe_writes

логическое значение

Определяет, когда использовать атомарную операцию для предотвращения повреждения данных или несогласованного чтения целевого объекта файловой системы.

По умолчанию этот модуль использует атомарные операции для предотвращения повреждения данных или несогласованного чтения целевых объектов файловой системы, однако иногда настройки систем или их неисправности препятствуют этому. Например, объекты файловой системы, смонтированные Docker, нельзя атомарно обновить изнутри контейнера: их можно записывать только небезопасным способом.

Этот параметр позволяет Ansible при сбое атомарных операций использовать небезопасные методы обновления объектов файловой системы (однако он не заставляет Ansible выполнять небезопасную запись).

ВАЖНО! Небезопасная запись подвержена состояниям гонки и может привести к повреждению данных.

Варианты:

  • false ← (по умолчанию)
  • true

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: нет

В режиме diff возвращает сведения о том, что изменилось (или, возможно, должно измениться в check_mode).

idempotent

Поддержка: полная

При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений.

Предполагается, что система, которой управляет модуль или которую он запрашивает, не изменилась существенным образом.

safe_file_operations

Поддержка: полная

Использует строгие функции Ansible для работы с файлами, чтобы обеспечить правильные права доступа и предотвратить повреждение данных.

См. также

См. также

community.crypto.openssl_privatekey

Создание закрытых ключей OpenSSL.

community.crypto.openssl_privatekey_pipe

Создание закрытых ключей OpenSSL без доступа к диску.

community.crypto.openssl_publickey

Создание открытого ключа OpenSSL на основе закрытого ключа.

Примеры

---
- name: Convert private key to PKCS8 format with passphrase
  community.crypto.openssl_privatekey_convert:
    src_path: /etc/ssl/private/ansible.com.pem
    dest_path: /etc/ssl/private/ansible.com.key
    dest_passphrase: '{{ private_key_passphrase }}'
    format: pkcs8

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

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

Ключ

Описание

backup_file

строка

Имя созданного файла резервной копии.

Возвращается: при изменении и если backup равно true

Пример: "/path/to/privatekey.pem.2019-03-09@11:22~"

Авторы

  • Felix Fontein (@felixfontein)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Обратиться за помощью (crypto)
  • Обратиться за помощью (ACME)
  • Сообщить об ошибке
  • Предложить новую функцию
  • Общение

© 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_privatekey_convert_module.html

Spec-Zone.ru

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