Облачная платформаEvolution

Обработка чувствительных данных Terraform-провайдером

Эта статья полезна?

В статье описано, как провайдер Terraform Cloud.ru обрабатывает чувствительные данные и маскирует их в gRPC-логах.

Обработка чувствительных данных в Terraform

Секреты ключей доступа IAM (access key и API key), а также пароли пользователей Kafka, PostgreSQL, ClickHouse и Bare Metal помечены как Sensitive в схеме провайдера. При обычном выводе terraform plan и terraform apply их значения скрыты. Чтобы вывести секрет через Terraform output, укажите sensitive = true.

Внимание

Пометка Sensitive не шифрует данные. Значение секрета остается в файле состояния (state) и сохраненном файле плана, а JSON-вывод Terraform может его раскрыть. Ограничьте доступ к файлу состояния в бэкенде и к артефактам плана.

Одноразовые секреты IAM

API возвращает значение secret только при создании ключа. Провайдер обрабатывает значение следующим образом:

  • При обновлении состояния (refresh) и ресурса (update) провайдер сохраняет полученное ранее значение, даже если API больше его не возвращает.

  • При пересоздании ключа в файл состояния записывается новый секрет.

  • При импорте ключа значение остается null, так как восстановить его через API невозможно.

Если секрет уже утрачен из файла состояния, используйте его сохраненную версию или перевыпустите ключ.

Маскирование чувствительных данных в gRPC-логах

DEBUG-лог содержит запрос и ответ, имя метода, идентификатор запроса (request ID), время выполнения и код ответа. В отдельном представлении лога чувствительные значения заменяются на ***. Реальные protobuf-сообщения и значения для файла состояния не изменяются. Остальные поля, вложенность, списки и map-структуры сохраняются. Если чувствительным объявлен весь объект, его содержимое скрывается целиком.

Правила маскирования

Единый источник правил — YAML-файлы кодогенератора в каталоге internal/fieldpolicy/config. Кодогенератор создает файл redact/policy_generated.go, а команда generate.sh -copy-tf копирует его в internal/clients/redact/policy_generated.go провайдера. Файл содержит все настроенные правила, даже если генерируется только один продукт.

Примечание

Не изменяйте файл policy_generated.go вручную. После изменения YAML-файлов пересоберите генератор и провайдер.

Обработка protobuf-полей

Для каждого protobuf-поля санитайзер проверяет field.FullName(), например cloudru.iam.v2.AccessKey.secret. В логе ключ остается коротким: secret. Благодаря полному имени санитайзер различает поля из разных сообщений с одинаковыми короткими именами.

Если нестандартный секрет присутствует и в Create-запросе, и в модели ответа, добавьте правила для обоих полных имен. Общие sensitive_field_names применяются ко всем сообщениям. log_sensitive_field_names дополняет их для логов, например полями authorization и token, но не изменяет схемы Terraform. Динамические ключи map-структур и Struct проверяются по этим спискам с поддержкой snake_case и camelCase.

Маскирование ошибок

В ошибках сохраняются код, request ID, сообщение и поддерживаемые структурированные типы details — причины, нарушения полей, метаданные, квоты, повторные попытки и другие стандартные детали. Из них удаляются чувствительные поля и известные значения секретов. Описания ошибок валидации чувствительных полей скрываются полностью.

Для неизвестных типов details и неразбираемых Any сохраняется тип с отметкой о скрытом содержимом. Ошибки асинхронных операций обрабатываются таким же образом, полный необработанный результат операции в диагностике не выводится.

Ограничения маскирования

Известные секреты из авторизации, запроса, ответа и структурированных details маскируются также при повторении в свободном тексте, JSON или кодировке Base64. Набор значений существует только в рамках вызова. Механизм не гарантирует распознавание неизвестного или произвольно преобразованного секрета в тексте сервера. Неструктурированные ошибки транспорта выводятся без исходного содержимого.