Spec-Zone.ru › Ansible

Модуль community.crypto.x509_certificate_convert – преобразование сертификатов X.509

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.crypto.

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

Новая возможность в community.crypto 2.19.0

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

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

  • Этот модуль позволяет преобразовывать сертификаты X.509 между различными форматами.

Параметры

Параметр

Комментарии

attributes

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

строка

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

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

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

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

backup

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

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

Варианты:

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

dest_path

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

Имя файла, в который будет записан созданный сертификат TLS/SSL X.509.

format

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

Определяет формат, в котором должен быть записан целевой сертификат X.509.

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

Варианты:

  • "pem"
  • "der"

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

строка

Содержимое файла с сертификатом X.509 для преобразования.

Это должен быть текст. Если вы не уверены, что входной файл имеет формат PEM, закодируйте значение в Base64 и задайте src_content_base64=true. Для этого можно использовать плагин фильтра ansible.builtin.b64encode.

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

src_content_base64

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

Если задано значение true при переданном параметре src_content, модуль считает, что значение src_content закодировано в Base64.

Варианты:

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

src_path

путь

Имя файла с сертификатом X.509 для преобразования.

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

strict

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

Если входной файл имеет формат PEM, проверить, что он содержит один объект PEM, заголовок и нижний колонтитул совпадают и имеют тип CERTIFICATE или X509 CERTIFICATE.

См. также параметр verify_cert_parsable, который проверяет, можно ли разобрать сертификат.

Варианты:

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

unsafe_writes

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

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

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

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

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

Варианты:

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

verify_cert_parsable

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

добавлено в community.crypto 2.23.0

Если задано значение true, проверяет, можно ли разобрать сертификат.

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

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

diff_mode

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

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

idempotent

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

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

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

safe_file_operations

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

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

См. также

См. также

ansible.builtin.b64encode — плагин фильтра

Кодирует строку в Base64.

community.crypto.x509_certificate

Создаёт и/или проверяет сертификаты OpenSSL.

community.crypto.x509_certificate_pipe

Создаёт и/или проверяет сертификаты OpenSSL.

community.crypto.x509_certificate_info

Предоставляет сведения о сертификатах OpenSSL X.509.

Примеры

---
- name: Convert PEM X.509 certificate to DER format
  community.crypto.x509_certificate_convert:
    src_path: /etc/ssl/cert/ansible.com.pem
    dest_path: /etc/ssl/cert/ansible.com.der
    format: der

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

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

Ключ

Описание

backup_file

строка

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

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

Пример: "/path/to/cert.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/x509_certificate_convert_module.html

Spec-Zone.ru

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