Объявленная чувствительность, отрисованная как собственный `sensitive` в Terraform
Объявление о том, что значение содержит секретные данные, пишется один раз, в схеме
сущности Component. Если целевая платформа отрисовки предлагает собственный
соответствующий примитив, это объявление отрисовывается в него. Этот пример — случай Terraform:
сборка добавляет файл переопределения, который добавляет sensitive = true к входу модуля,
в который поступает объявленное значение, а движок затем скрывает это значение везде, где
иначе показал бы его.
Пример намеренно небольшой, и каждую его часть можно проверить: один компонент, три входа модуля и отрисованная пометка, которая называет ровно один из них.
Что выдаёт сборка
В dist/infra/terraform/ — корневая конфигурация границы:
aggrega.modules.tf— объявляетstoreкак блокmodule, у которогоsource—./modules/store, а аргументы — разрешённые входные переменные модуля в детерминированном порядке ключей. Такой файл получает каждая граница terraform.
В dist/infra/terraform/modules/store/ — собственные файлы компонента store:
- файлы модуля, скопированные байт в байт, —
variables.tfиmain.tf, в точности как их написал автор модуля; aggrega_override.tf.json— пометка чувствительности, описанная ниже. Он лежит рядом с собственными файлами модуля, потому что Terraform объединяет переопределение с конфигурацией в его собственном каталоге;aggrega.provenance.tf— файл с комментариями#, идентифицирующий сборку (файл JSON не может содержать комментарий, поэтому сведения о происхождении хранятся в отдельном файле).
Пометка и два входа, которые она не называет
example/storage/external-object-store объявляет три листа values. Два содержат
публичные идентификаторы; один содержит учётные данные и объявляет sensitive: true:
values: bucket: { type: string, required: true } access_key_id: { type: string, required: true } secret_access_key: { type: string, required: true, sensitive: true }Блок module связывает все три входа модуля:
module "store" { source = "./modules/store"
access_key_id = "AKIAEXAMPLE0001" bucket = "app-artifacts" secret_access_key = "example-placeholder-not-a-real-credential"}а добавленное переопределение называет ровно один:
{ "variable": { "secret_access_key": { "sensitive": true } }}Terraform объединяет файл с именем override или оканчивающимся на _override с
конфигурацией в том же каталоге, поэтому этот файл добавляет атрибут к
существующему объявлению secret_access_key в модуле и оставляет его тип,
описание и значение по умолчанию такими, как их написал модуль. Каждый вендорированный байт
остаётся таким, каким был написан.
Два входа, которые переопределение не называет, — главное в этом примере.
Пометка следует за объявлением и ни за чем другим — ни за именем переменной,
ни за формой её значения. access_key_id — это идентификатор учётных данных, а не
секретные данные, поэтому он не объявлен чувствительным и не помечен,
хотя он лежит рядом с секретом и его имя похоже на секрет. Удалите
sensitive: true из этого единственного листа и пересоберите: файл переопределения
вообще не будет выдан.
Проверка в работе
main.tf хранит публичные координаты и учётные данные в разных атрибутах
одного ресурса, поэтому план показывает оба направления сразу. Выполните план для
корневой конфигурации границы — каталога, содержащего aggrega.modules.tf, где
находятся значения этого развёртывания:
cd dist/infra/terraformtofu init && tofu plan # or: terraform init && terraform plan # module.store.terraform_data.reference will be created + resource "terraform_data" "reference" { [… omitted: an id attribute, reported as known only after apply] + input = (sensitive value) [… omitted: an output attribute, reported as known only after apply] + triggers_replace = [ + "app-artifacts", + "AKIAEXAMPLE0001", ] }Ваш собственный план содержит эти два атрибута между показанными строками. Они помечены как пропущенные, а не отсутствуют, поэтому строка, которую вы не можете объяснить, — это реальное различие, а не то, что выбросила эта страница.
Учётные данные скрыты; два публичных значения рядом с ними — нет. Удалите
aggrega_override.tf.json и снова выполните план, чтобы увидеть учётные данные
полностью, — это различие и есть всё, что делает пометка. Пометка находится
в собственном блоке variable модуля, поэтому она переносится вместе с модулем и действует
везде, где этот модуль используется.
Запускайте его в корне, а не внутри modules/store/. Входы компонента — это
аргументы его блока module, который находится уровнем выше, поэтому собственный
каталог компонента — не конфигурация, для которой можно выполнить план как для развёрнутой. Что движок
делает там, зависит от собственных блоков variable модуля, и только один из двух
вариантов заметен:
- Этот модуль объявляет все три своих входа без
default, поэтому план вmodules/store/завершается ошибкой —No value for required variable(Нет значения для обязательной переменной), по разу на каждый вход, с указанием строки и предложением решения через-var/-var-file. - Модуль, у которого все входы имеют значения по умолчанию, напротив, выполнил бы план там успешно — на основе этих значений по умолчанию, а не значений, которые передаёт корневая конфигурация. Никаких предупреждений нет. Об этом случае нужно знать, потому что план, который выглядит верным, описывает конфигурацию, которую никто не запрашивал.
Чего пометка не делает
sensitive управляет отображением. Он не даёт выводить значение в выводе plan и apply
и не даёт Terraform помещать это значение в output, который сам
не помечен как чувствительный. Он не шифрует значение и не меняет
способ его хранения: после apply значение присутствует в state в открытом
виде. Считайте, что state содержит учётные данные, что бы ни говорила пометка.
Кроме того, пометка доходит до отрисованного входа, только когда идентичность входа берётся
из объявления. Этот Recipe объявляет source: и не объявляет valuesMapping:, поэтому
имена аргументов — это пути листов значений, объявленные в Component, и сопоставление
точное. Recipe, который объявляет valuesMapping:, придумывает имена своих выходов
внутри шаблона, и их не называет ни одно объявление, поэтому такой Recipe отрисовывает те же
значения без пометки — файл переопределения отсутствует, а не аппроксимируется.
Пометка имени, до которого не доходит ни одно объявление, утверждала бы что-то ложное о
публичном входе, и собственные инструменты движка тогда скрывали бы значение, которое никогда
не было секретным.
Почему учётные данные здесь — вход модуля
Управляемая облачная база данных — обычно противоположный случай: провайдер сам генерирует и ротирует мастер-пароль, поэтому модулю не нужен вход для учётных данных и помечать нечего. Этот бакет эксплуатируется вне развёртывания, поэтому нет такого провайдера, которому можно это делегировать, — развёртывание хранит ключ доступа и должно передать его. Именно поэтому этот модуль объявляет переменную для учётных данных, а модули управляемых баз данных в стандартной библиотеке — нет.
Модуль объявляет эту переменную без атрибута sensitive Terraform,
и именно это делает пример наглядным: атрибут, который читатель видит применённым при
отрисовке, пришёл из объявления в Component, а не из модуля.
Файлы
aggregate.yaml— намерение разработчика: один компонентstoreтипаexample/storage/external-object-store, у которого бакет назван напрямую, а обе половины ключа доступа вынесены как типизированныеparameters.release.yaml— задаёт эти параметры для данного окружения и устанавливаетendpointоператора. Значения здесь — заполнители, а не учётные данные какого-либо реального сервиса.manifest.yaml— связывает тип компонента с Recipe для Terraformterraform/external-object-store, который берёт свой модуль локально..aggrega-config.yaml— указывает реестр хаба, из которого разрешаются сущности каталога.
Обе половины учётных данных — parameters, а не написанные значения, потому что
их передаёт оператор и они различаются в разных окружениях. Release не может
объявлять values:, поэтому типизированный параметр — именно та поверхность, что для этого нужна:
разработчик объявляет точку вариации, Release её заполняет.
Создание примера
Этот пример можно собрать командами ниже или поручить сборку вашему ИИ-ассистенту.
Запишите пример в новую папку, названную по его имени:
aggrega scaffold --example terraform-declared-sensitivityЗатем она выводит команды, которые нужно выполнить дальше. Первая переходит в новую папку:
cd terraform-declared-sensitivityСборка
aggrega build --release release.yaml --auto-pull--auto-pull во время сборки записывает lock-файл, которого нет в свежем клоне.
С ИИ-ассистентом
ИИ-ассистент, настроенный с инструментами Aggrega, может сделать то же самое: вставьте в него этот промпт.
Используйте только инструменты Aggrega и не создавайте папки самостоятельно. Если папка рабочей области ещё не содержит папку `terraform-declared-sensitivity`, вызовите один раз инструмент `scaffold` с параметром `example` со значением `terraform-declared-sensitivity` и без `dir`: он запишет пример в новую папку `terraform-declared-sensitivity`. Затем вызовите инструмент `build` с параметрами `workspace_root` — `terraform-declared-sensitivity`, `release` — `release.yaml`, `auto_pull` — true и `write` — true. Сообщите мне, какие файлы записала сборка; они находятся в `terraform-declared-sensitivity/dist/`.