Spec-Zone.ru › Ansible

Фильтр community.sops.decrypt — расшифровка данных, зашифрованных SOPS

Примечание

Этот плагин фильтра входит в коллекцию community.sops (версия 2.3.0).

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

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

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

Добавлено в community.sops 1.1.0

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

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

  • Расшифровывает данные, зашифрованные SOPS.
  • Позволяет расшифровывать данные, полученные из произвольного источника.
  • Обратите внимание: поскольку Ansible вычисляет выражения лениво, лучше использовать ansible.builtin.set_fact, чтобы сохранить результат вычисления в переменной-факте и избежать повторного вычисления значения при каждом использовании выражения.

Требования

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

  • Исполняемый двоичный файл sops (https://github.com/getsops/sops) должен находиться в PATH или быть указан в sops_binary.

Входные данные

Здесь описаны входные данные фильтра — значение до | community.sops.decrypt.

Параметр

Комментарии

Входные данные

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

Данные для расшифровки.

Ключевые параметры

Здесь описаны ключевые параметры фильтра. В следующем примере это значения key1=value1, key2=value2 и так далее: input | community.sops.decrypt(key1=value1, key2=value2, ...)

Параметр

Комментарии

age_key

string

добавлено в community.sops 1.4.0

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

При вызове SOPS будет задана переменная окружения SOPS_AGE_KEY.

Требуется SOPS версии 3.7.1 или новее.

age_key_cmd

string

добавлено в community.sops 2.3.0

Команда, которую SOPS выполнит для получения закрытого ключа age, используемого для расшифровки зашифрованных файлов.

При вызове SOPS будет задана переменная окружения SOPS_AGE_KEY_CMD.

Требуется SOPS версии 3.10.0 или новее.

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

age_keyfile

path

добавлено в community.sops 1.4.0

Файл, содержащий закрытые ключи age, которые SOPS может использовать для расшифровки зашифрованных файлов.

При вызове SOPS будет задана переменная окружения SOPS_AGE_KEY_FILE.

По умолчанию SOPS ищет sops/age/keys.txt в каталоге конфигурации пользователя.

Требуется SOPS версии 3.7.0 или новее.

age_ssh_private_key_cmd

string

добавлено в community.sops 2.3.0

Команда, которую SOPS выполнит для получения закрытого ключа SSH, используемого для расшифровки зашифрованных файлов.

При вызове SOPS будет задана переменная окружения SOPS_AGE_SSH_PRIVATE_KEY_CMD.

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

Требуется SOPS версии 3.12.0 или новее.

age_ssh_private_keyfile

path

добавлено в community.sops 1.4.0

Файл, содержащий закрытый ключ SSH, который SOPS может использовать для расшифровки зашифрованных файлов.

При вызове SOPS будет задана переменная окружения SOPS_AGE_SSH_PRIVATE_KEY_FILE.

По умолчанию SOPS ищет ~/.ssh/id_ed25519, а при отсутствии файла использует ~/.ssh/id_rsa.

Требуется SOPS версии 3.10.0 или новее.

aws_access_key_id

string

добавлено в community.sops 1.0.0

Идентификатор ключа доступа AWS для запросов к AWS.

Для вызова SOPS задаёт переменную окружения AWS_ACCESS_KEY_ID.

aws_profile

string

добавлено в community.sops 1.0.0

Профиль AWS для запросов к AWS.

Соответствует параметру SOPS --aws-profile.

aws_secret_access_key

string

добавлено в community.sops 1.0.0

Секретный ключ доступа AWS для запросов к AWS.

Для вызова SOPS задаёт переменную окружения AWS_SECRET_ACCESS_KEY.

aws_session_token

string

добавлено в community.sops 1.0.0

Токен сеанса AWS для запросов к AWS.

Для вызова SOPS задаёт переменную окружения AWS_SESSION_TOKEN.

config_path

path

добавлено в community.sops 1.0.0

Путь к файлу конфигурации SOPS.

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

Соответствует параметру SOPS --config.

decode_output

boolean

Следует ли декодировать вывод в байты.

Если output_type=binary и неизвестно, содержит ли файл текст в кодировке UTF-8, лучше задать значение false, чтобы избежать искажения данных при декодировании UTF-8.

Варианты:

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

enable_local_keyservice

boolean

добавлено в community.sops 1.0.0

Указывает SOPS использовать локальную службу ключей.

Если задано значение false, это соответствует параметру SOPS --enable-local-keyservice=false.

Варианты:

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

gcp_kms_client_type

string

добавлено в community.sops 3.2.0

Определяет, какой клиент использовать для взаимодействия с Google Cloud Services.

При вызове SOPS будет задана переменная окружения SOPS_GCP_KMS_CLIENT_TYPE.

Требуется SOPS версии 3.12.0 или новее.

Варианты:

  • "grpc": использовать клиент gRPC
  • "rest": использовать клиент REST

gcp_oauth_access_token

string

добавлено в community.sops 3.2.0

Предоставляет токен OAuth Google Cloud.

При вызове SOPS будет задана переменная окружения GOOGLE_OAUTH_ACCESS_TOKEN.

Требуется SOPS версии 3.10.0 или новее.

input_type

string

Указывает SOPS, как интерпретировать зашифрованные данные.

Автоматическое определение не выполняется, поскольку имя файла неизвестно. По умолчанию SOPS получает указание считать входные данные YAML. Если это неверно, задайте для этого параметра подходящее значение.

Значение ini доступно начиная с community.sops 1.9.0.

Варианты:

  • "binary"
  • "json"
  • "yaml" ← (по умолчанию)
  • "dotenv"
  • "ini"

keyservice

list / элементы=string

добавлено в community.sops 1.0.0

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

Службу ключей необходимо указать в формате protocol://address, например tcp://myserver.com:5000.

Соответствует параметру SOPS --keyservice.

output_type

string

Указывает SOPS, как интерпретировать расшифрованный файл.

Обратите внимание: вывод всегда является текстом или байтами в зависимости от значения decode_output. Чтобы разобрать полученный JSON или YAML, используйте соответствующие фильтры, например ansible.builtin.from_json и ansible.builtin.from_yaml.

Значение ini доступно начиная с community.sops 1.9.0.

Варианты:

  • "binary"
  • "json"
  • "yaml" ← (по умолчанию)
  • "dotenv"
  • "ini"

rstrip

boolean

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

Варианты:

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

sops_binary

path

добавлено в community.sops 1.0.0

Путь к двоичному файлу SOPS.

По умолчанию используется sops.

См. также

См. также

community.sops.sops — плагин lookup

Чтение содержимого файлов, зашифрованных SOPS.

community.sops.sops — плагин vars

Загрузка файлов переменных, зашифрованных SOPS.

community.sops.load_vars

Динамическая загрузка переменных, зашифрованных SOPS, из файлов в ходе выполнения задачи.

Примеры

---
- name: Decrypt file fetched from URL
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Fetch file from URL
      ansible.builtin.uri:
        url: https://raw.githubusercontent.com/getsops/sops/master/functional-tests/res/comments.enc.yaml
        return_content: true
      register: encrypted_content

    - name: Show encrypted data
      debug:
        msg: "{{ encrypted_content.content | ansible.builtin.from_yaml }}"

    - name: Decrypt data and decode decrypted YAML
      set_fact:
        decrypted_data: "{{ encrypted_content.content | community.sops.decrypt | ansible.builtin.from_yaml }}"

    - name: Show decrypted data
      debug:
        msg: "{{ decrypted_data }}"

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

Ключ

Описание

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

string

Расшифрованные данные в виде текста (decode_output=true, по умолчанию) или двоичной строки (decode_output=false).

Возвращается: при успешном выполнении

Авторы

  • Felix Fontein (@felixfontein)

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

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

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

Spec-Zone.ru

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