Фильтр community.sops.decrypt – Расшифровка данных, зашифрованных с помощью SOPS

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.

Параметр	Комментарии
Входные данные строка / обязательно	Данные для расшифровки.

Параметры ключевых слов

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

Параметр	Комментарии
age_key строка добавлен в community.sops 1.4.0	Один или несколько закрытых ключей age, которые можно использовать для расшифровки зашифрованных файлов. Будет задан как переменная среды `SOPS_AGE_KEY` при вызове SOPS. Требуется SOPS 3.7.1+.
age_keyfile путь добавлен в community.sops 1.4.0	Файл, содержащий закрытые ключи age, которые SOPS может использовать для расшифровки зашифрованных файлов. Будет задан как переменная среды `SOPS_AGE_KEY_FILE` при вызове SOPS. По умолчанию SOPS ищет `sops/age/keys.txt` в вашем каталоге пользовательской конфигурации. Требуется SOPS 3.7.0+.
aws_access_key_id строка добавлен в community.sops 1.0.0	Идентификатор ключа доступа AWS, используемый для запросов к AWS. Устанавливает переменную среды `AWS_ACCESS_KEY_ID` для вызова SOPS.
aws_profile строка добавлен в community.sops 1.0.0	Профиль AWS, используемый для запросов к AWS. Это соответствует опции SOPS `--aws-profile`.
aws_secret_access_key строка добавлен в community.sops 1.0.0	Секретный ключ доступа AWS, используемый для запросов к AWS. Устанавливает переменную среды `AWS_SECRET_ACCESS_KEY` для вызова SOPS.
aws_session_token строка добавлен в community.sops 1.0.0	Токен сессии AWS, используемый для запросов к AWS. Устанавливает переменную среды `AWS_SESSION_TOKEN` для вызова SOPS.
config_path путь добавлен в community.sops 1.0.0	Путь к файлу конфигурации SOPS. Если не задано, SOPS будет рекурсивно искать файл конфигурации, начиная с файла, который зашифрован или расшифрован. Это соответствует опции SOPS `--config`.
decode_output логическое	Необходимо ли декодировать вывод в байты. Когда `output_type=binary`, и файл не известен как содержащий текст в кодировке UTF-8, это лучше установить в `false`, чтобы предотвратить искажение данных с помощью декодирования UTF-8. Варианты: `false` `true` ← (по умолчанию)
enable_local_keyservice логическое добавлен в community.sops 1.0.0	Указать SOPS использовать локальную службу ключей. Это соответствует опции SOPS `--enable-local-keyservice`. Варианты: `false` ← (по умолчанию) `true`
input_type строка	Указать SOPS, как интерпретировать зашифрованные данные. Автообнаружения нет, так как у нас нет имени файла. По умолчанию SOPS интерпретирует ввод как YAML. Если это неверно, пожалуйста, установите это значение. Значение `ini` доступно с версии community.sops 1.9.0. Варианты: `"binary"` `"json"` `"yaml"` ← (по умолчанию) `"dotenv"` `"ini"`
keyservice список / элементы=строка добавлен в community.sops 1.0.0	Указать службы ключей, используемые помимо локальной. Служба ключей должна быть указана в формате `protocol://address`, например `tcp://myserver.com:5000`. Это соответствует опции SOPS `--keyservice`.
output_type строка	Указать 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 логическое	Удалить ли завершающие символы новой строки и пробелы. Варианты: `false` `true` ← (по умолчанию)
sops_binary путь добавлен в community.sops 1.0.0	Путь к исполняемому файлу SOPS. По умолчанию используется `sops`.

См. также

community.sops.sops плагин поиска: Чтение содержимого файла, зашифрованного с помощью SOPS.
community.sops.sops плагин переменных: Загрузка файлов переменных, зашифрованных с помощью 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 }}"

Значение возврата

Ключ	Описание
Значение возврата строка	Расшифрованные данные в виде текста (`decode_output=true`, по умолчанию) или двоичной строки (`decode_output=false`). Возвращаемое значение: успех

Авторы

Felix Fontein (@felixfontein)

Подсказка

Параметры конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/sops/decrypt_filter.html