Deklarierte Sensibilität, gerendert als Terraforms eigenes `sensitive`
Die Deklaration, dass ein Wert geheimes Material trägt, wird einmal verfasst, im Schema einer Component. Wo das Renderziel ein eigenes passendes Primitiv bietet, wird diese Deklaration darin gerendert. Dieses Beispiel ist der Terraform-Fall: Der Build hängt eine Override-Datei an, die sensitive = true zu der Moduleingabe hinzufügt, in die der deklarierte Wert fließt, und die Engine schwärzt diesen Wert dann überall dort, wo sie ihn sonst anzeigen würde.
Das Beispiel ist bewusst klein, und jeder Teil davon ist einsehbar: eine Komponente, drei Moduleingaben und eine gerenderte Markierung, die genau eine davon benennt.
Was der Build ausgibt
Unter dist/infra/terraform/ die Root-Konfiguration der Boundary:
aggrega.modules.tf— deklariertstoreals Blockmodule, dessensource./modules/storeist und dessen Argumente die aufgelösten Eingabevariablen des Moduls sind, in deterministischer Schlüsselreihenfolge. Jede Boundary vom Typ terraform erhält eine.
Unter dist/infra/terraform/modules/store/ die eigenen Dateien der Komponente store:
- die Moduldateien, Byte für Byte kopiert —
variables.tfundmain.tf, genau so, wie der Modulautor sie geschrieben hat; aggrega_override.tf.json— die Sensibilitätsmarkierung, unten beschrieben. Sie liegt neben den eigenen Dateien des Moduls, weil Terraform ein Override mit der Konfiguration im eigenen Verzeichnis zusammenführt;aggrega.provenance.tf— eine Datei mit Kommentaren in#, die den Build identifiziert (die JSON-Datei kann keinen Kommentar enthalten, daher reist die Herkunftsangabe in einer eigenen Datei).
Die Markierung und die zwei Eingaben, die sie nicht benennt
example/storage/external-object-store deklariert drei Blätter in values. Zwei tragen öffentliche Bezeichner; eines trägt die Zugangsdaten und deklariert sensitive: true:
values: bucket: { type: string, required: true } access_key_id: { type: string, required: true } secret_access_key: { type: string, required: true, sensitive: true }Der Block module bindet alle drei Moduleingaben:
module "store" { source = "./modules/store"
access_key_id = "AKIAEXAMPLE0001" bucket = "app-artifacts" secret_access_key = "example-placeholder-not-a-real-credential"}und das angehängte Override benennt genau eine:
{ "variable": { "secret_access_key": { "sensitive": true } }}Terraform führt eine Datei namens override oder mit der Endung _override mit der Konfiguration im selben Verzeichnis zusammen, daher fügt diese Datei das Attribut zur bestehenden Deklaration secret_access_key des Moduls hinzu und lässt deren Typ, Beschreibung und Standardwert so, wie das Modul sie geschrieben hat. Jedes mitgelieferte Byte bleibt so, wie es verfasst wurde.
Die zwei Eingaben, die das Override nicht benennt, sind der Kern des Beispiels. Die Markierung folgt der Deklaration und nichts anderem — nicht dem Namen einer Variablen, nicht der Form ihres Werts. access_key_id ist ein Bezeichner von Zugangsdaten und kein Zugangsdatenmaterial, daher ist sie nicht als sensibel deklariert und wird nicht markiert, obwohl sie neben dem Geheimnis liegt und ihr Name wie einer klingt. Entfernen Sie sensitive: true aus dem einen Blatt und bauen Sie neu: Die Override-Datei wird überhaupt nicht ausgegeben.
Die Wirkung sehen
main.tf hält die öffentlichen Koordinaten und die Zugangsdaten in getrennten Attributen einer Ressource, sodass ein Plan beide Richtungen zugleich zeigt. Planen Sie die Root-Konfiguration der Boundary — das Verzeichnis, das aggrega.modules.tf enthält, wo die Werte dieses Release liegen:
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", ] }Ihr eigener Plan enthält diese beiden Attribute zwischen den gezeigten Zeilen. Sie sind als weggelassen markiert und fehlen nicht, sodass eine Zeile, die Sie sich nicht erklären können, ein echter Unterschied ist und nicht etwas, das diese Seite weggelassen hat.
Die Zugangsdaten werden geschwärzt; die zwei öffentlichen Werte daneben nicht. Löschen Sie aggrega_override.tf.json und führen Sie den Plan erneut aus, um die Zugangsdaten vollständig ausgegeben zu sehen — dieser Unterschied ist alles, was die Markierung bewirkt. Die Markierung sitzt im eigenen Block variable des Moduls, daher reist sie mit dem Modul und gilt überall, wo dieses Modul verwendet wird.
Führen Sie ihn an der Root aus und nicht innerhalb von modules/store/. Die Eingaben einer Komponente sind die Argumente ihres Blocks module, der eine Ebene höher liegt, daher ist das eigene Verzeichnis der Komponente keine Konfiguration, die Sie wie bereitgestellt planen können. Was die Engine dort tut, hängt von den eigenen Blöcken variable des Moduls ab, und nur eine der beiden Antworten ist deutlich sichtbar:
- Dieses Modul deklariert alle drei Eingaben ohne
default, daher scheitert ein Plan inmodules/store/—No value for required variable, einmal pro Eingabe, jeweils mit Angabe der Zeile und dem Hinweis auf-var/-var-fileals Abhilfe. - Ein Modul, dessen Eingaben alle Standardwerte tragen, würde dort stattdessen erfolgreich planen, aus diesen Standardwerten statt aus den Werten, die die Root-Konfiguration liefert. Nichts warnt. Das ist der Fall, den man kennen sollte, denn ein Plan, der richtig aussieht, beschreibt eine Konfiguration, die niemand angefordert hat.
Was die Markierung nicht tut
sensitive regelt die Anzeige. Es verhindert, dass ein Wert in der Ausgabe von plan und apply ausgegeben wird, und es verhindert, dass Terraform diesen Wert in eine Ausgabe übernimmt, die nicht selbst als sensibel markiert ist. Es verschlüsselt den Wert nicht und ändert nicht, wie der Wert gespeichert wird: Nach einem apply liegt der Wert im Klartext im State. Behandeln Sie den State so, als trage er die Zugangsdaten, was auch immer die Markierung sagt.
Die Markierung erreicht eine gerenderte Eingabe außerdem nur, wenn die Identität der Eingabe aus einer Deklaration stammt. Dieses Recipe deklariert ein source: und kein valuesMapping:, daher sind die Argumentnamen die Pfade der Wertblätter, die die Component deklariert hat, und die Zuordnung ist exakt. Ein Recipe, das ein valuesMapping: deklariert, erfindet seine Ausgabenamen innerhalb einer Vorlage, die keine Deklaration benennt, daher rendert ein solches Recipe dieselben Werte ohne Markierung — die Override-Datei fehlt, statt angenähert zu werden. Einen Namen zu markieren, den keine Deklaration erreicht, würde etwas Unwahres über eine öffentliche Eingabe behaupten, und die eigenen Werkzeuge der Engine würden dann einen Wert verbergen, der nie geheim war.
Warum die Zugangsdaten hier eine Moduleingabe sind
Eine verwaltete Cloud-Datenbank ist meist der andere Fall: Der Anbieter erzeugt und rotiert das Master-Passwort selbst, daher braucht das Modul keine Eingabe für Zugangsdaten, und es gibt nichts zu markieren. Dieser Bucket wird außerhalb des Release betrieben, daher gibt es keinen solchen Anbieter, an den delegiert werden könnte — das Release hält einen Zugriffsschlüssel und muss ihn übergeben. Deshalb deklariert dieses Modul eine Variable für Zugangsdaten und die Module für verwaltete Datenbanken in der Standardbibliothek nicht.
Das Modul deklariert diese Variable ohne Terraforms Attribut sensitive, und das macht das Beispiel nachvollziehbar: Das Attribut, das ein Leser zur Renderzeit angewendet sieht, stammt aus der Deklaration der Component, nicht aus dem Modul.
Dateien
aggregate.yaml— Entwicklerabsicht: eine Komponentestorevom Typexample/storage/external-object-store, mit direkt benanntem Bucket und beiden Hälften des Zugriffsschlüssels als typisierteparametersbereitgestellt.release.yaml— erfüllt diese Parameter für diese Umgebung und setzt denendpointdes Operators. Die Werte hier sind Platzhalter, keine Zugangsdaten für einen realen Dienst.manifest.yaml— bindet den Komponententyp an das Terraform-Recipeterraform/external-object-store, das sein Modul aus einer lokalen Quelle bezieht..aggrega-config.yaml— nennt die Hub-Registry, aus der die Katalogentitäten aufgelöst werden.
Beide Hälften der Zugangsdaten sind parameters statt verfasster Werte, weil es Werte sind, die ein Operator liefert und die sich je Umgebung unterscheiden. Ein Release kann keine values: deklarieren, daher ist ein typisierter Parameter genau dafür die Oberfläche: Der Entwickler deklariert den Variationspunkt, das Release erfüllt ihn.
Das Beispiel generieren
Sie können dieses Beispiel mit den folgenden Befehlen bauen oder es von Ihrem KI-Assistenten für Sie bauen lassen.
Schreiben Sie das Beispiel in einen neuen Ordner, der nach ihm benannt ist:
aggrega scaffold --example terraform-declared-sensitivityDanach gibt er die als Nächstes auszuführenden Befehle aus. Der erste wechselt in den neuen Ordner:
cd terraform-declared-sensitivityBuild
aggrega build --release release.yaml --auto-pull--auto-pull schreibt während des Builds das Lockfile, das einem frischen Klon fehlt.
Mit einem KI-Assistenten
Ein KI-Assistent, der mit den Tools von Aggrega eingerichtet ist, kann dasselbe tun: Fügen Sie ihm diesen Prompt ein.
Verwenden Sie ausschließlich die Aggrega-Werkzeuge und legen Sie selbst keinen Ordner an. Wenn der Ordner des Arbeitsbereichs noch keinen Ordner `terraform-declared-sensitivity` enthält, rufen Sie das Werkzeug `scaffold` einmal auf, mit `example` auf `terraform-declared-sensitivity` gesetzt und ohne `dir`: Es schreibt das Beispiel in einen neuen Ordner `terraform-declared-sensitivity`. Rufen Sie dann das Werkzeug `build` auf, mit `workspace_root` auf `terraform-declared-sensitivity`, `release` auf `release.yaml`, `auto_pull` auf true und `write` auf true gesetzt. Nennen Sie mir die Dateien, die der Build geschrieben hat; sie liegen unter `terraform-declared-sensitivity/dist/`.