Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Zadeklarowana poufność renderowana jako natywny atrybut `sensitive` Terraform

Deklarację, że wartość zawiera materiał tajny, zapisuje się raz, w schemacie encji Component. Tam, gdzie cel renderowania oferuje własny odpowiadający jej prymityw, ta deklaracja jest w niego renderowana. Ten przykład dotyczy Terraform: kompilacja dołącza plik nadpisania, który dodaje sensitive = true do wejścia modułu, do którego trafia zadeklarowana wartość, a silnik następnie ukrywa tę wartość wszędzie tam, gdzie w przeciwnym razie by ją wyświetlił.

Przykład jest celowo mały, a każdą jego część można prześledzić: jeden komponent, trzy wejścia modułu i wyrenderowane oznaczenie, które wskazuje dokładnie jedno z nich.

Co generuje kompilacja

W dist/infra/terraform/ — konfiguracja główna granicy:

  • aggrega.modules.tf — deklaruje store jako blok module, którego source to ./modules/store, a argumentami są rozwiązane zmienne wejściowe modułu, w deterministycznej kolejności kluczy. Otrzymuje go każda granica terraform.

W dist/infra/terraform/modules/store/ — własne pliki komponentu store:

  • pliki modułu skopiowane bajt w bajt — variables.tf i main.tf, dokładnie tak, jak napisał je autor modułu;
  • aggrega_override.tf.json — oznaczenie poufności, opisane poniżej. Leży obok własnych plików modułu, ponieważ Terraform scala nadpisanie z konfiguracją we własnym katalogu;
  • aggrega.provenance.tf — plik z komentarzem # identyfikujący kompilację (plik JSON nie może zawierać komentarza, więc pochodzenie trafia do osobnego pliku).

Oznaczenie i dwa wejścia, których ono nie wskazuje

example/storage/external-object-store deklaruje trzy liście values. Dwa zawierają publiczne identyfikatory; jeden zawiera dane uwierzytelniające i deklaruje sensitive: true:

values:
bucket: { type: string, required: true }
access_key_id: { type: string, required: true }
secret_access_key: { type: string, required: true, sensitive: true }

Blok module wiąże wszystkie trzy wejścia modułu:

module "store" {
source = "./modules/store"
access_key_id = "AKIAEXAMPLE0001"
bucket = "app-artifacts"
secret_access_key = "example-placeholder-not-a-real-credential"
}

a dołączone nadpisanie wskazuje dokładnie jedno:

{
"variable": {
"secret_access_key": {
"sensitive": true
}
}
}

Terraform scala plik o nazwie override lub kończącej się na _override z konfiguracją w tym samym katalogu, więc ten plik dodaje atrybut do istniejącej deklaracji secret_access_key modułu i pozostawia jej typ, opis i wartość domyślną tak, jak zapisał je moduł. Każdy dołączony bajt pozostaje taki, jak został napisany.

Sednem przykładu są dwa wejścia, których nadpisanie nie wskazuje. Oznaczenie wynika z deklaracji i z niczego więcej — ani z nazwy zmiennej, ani z kształtu jej wartości. access_key_id jest identyfikatorem danych uwierzytelniających, a nie materiałem tajnym, więc nie jest zadeklarowany jako poufny i nie jest oznaczony, choć leży obok sekretu, a jego nazwa brzmi podobnie. Jeśli usunąć sensitive: true z tego jednego liścia i przebudować, plik nadpisania w ogóle nie zostanie wygenerowany.

Jak to działa w praktyce

main.tf przechowuje publiczne współrzędne i dane uwierzytelniające w osobnych atrybutach jednego zasobu, więc plan pokazuje oba przypadki jednocześnie. Plan należy wykonać dla konfiguracji głównej granicy — katalogu zawierającego aggrega.modules.tf, w którym znajdują się wartości tego wdrożenia:

Terminal window
cd dist/infra/terraform
tofu 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",
]
}

Własny plan zawiera te dwa atrybuty między pokazanymi wierszami. Są one oznaczone jako pominięte, a nie brakujące, więc wiersz, którego nie da się wyjaśnić, to rzeczywista różnica, a nie coś, co ta strona pominęła.

Dane uwierzytelniające są ukryte; dwie publiczne wartości obok nich — nie. Po usunięciu aggrega_override.tf.json i ponownym uruchomieniu planu dane uwierzytelniające zostaną wypisane w całości — ta różnica to wszystko, co robi oznaczenie. Oznaczenie znajduje się we własnym bloku variable modułu, więc przemieszcza się razem z modułem i obowiązuje wszędzie, gdzie ten moduł jest używany.

Należy uruchamiać go w katalogu głównym, a nie w modules/store/. Wejścia komponentu to argumenty jego bloku module, który znajduje się poziom wyżej, więc własny katalog komponentu nie jest konfiguracją, którą można zaplanować tak, jak jest wdrażana. To, co silnik tam zrobi, zależy od własnych bloków variable modułu, i tylko jedna z dwóch odpowiedzi jest wyraźnie sygnalizowana:

  • Ten moduł deklaruje wszystkie trzy wejścia bez default, więc plan w modules/store/ kończy się niepowodzeniem — No value for required variable (Brak wartości dla wymaganej zmiennej), raz dla każdego wejścia, z podaniem wiersza i propozycją rozwiązania -var / -var-file.
  • Moduł, którego wszystkie wejścia mają wartości domyślne, zostałby tam natomiast zaplanowany pomyślnie, na podstawie tych wartości domyślnych, a nie wartości dostarczanych przez konfigurację główną. Nic nie ostrzega. To przypadek, o którym trzeba wiedzieć, bo plan, który wygląda poprawnie, opisuje konfigurację, o którą nikt nie prosił.

Czego oznaczenie nie robi

sensitive dotyczy wyświetlania. Zapobiega wypisaniu wartości w wyniku plan i apply oraz uniemożliwia Terraform umieszczenie tej wartości w wyjściu, które samo nie jest oznaczone jako poufne. Nie szyfruje wartości i nie zmienia sposobu jej przechowywania: po apply wartość jest obecna w stanie jawnym tekstem. Stan należy traktować jako zawierający dane uwierzytelniające, niezależnie od oznaczenia.

Oznaczenie trafia do wyrenderowanego wejścia tylko wtedy, gdy tożsamość wejścia pochodzi z deklaracji. Ta encja Recipe deklaruje source: i nie deklaruje valuesMapping:, więc nazwy argumentów to ścieżki liści wartości zadeklarowane przez encję Component, a dopasowanie jest dokładne. Encja Recipe, która deklaruje valuesMapping:, tworzy nazwy wyjść wewnątrz szablonu, których nie wskazuje żadna deklaracja, więc taka encja Recipe renderuje te same wartości bez oznaczenia — plik nadpisania nie istnieje, zamiast być przybliżony. Oznaczenie nazwy, do której nie sięga żadna deklaracja, stwierdzałoby coś nieprawdziwego o publicznym wejściu, a własne narzędzia silnika ukrywałyby wartość, która nigdy nie była tajna.

Dlaczego dane uwierzytelniające są tu wejściem modułu

Zarządzana chmurowa baza danych to zwykle przypadek odwrotny: dostawca sam generuje i rotuje hasło główne, więc moduł nie potrzebuje wejścia z danymi uwierzytelniającymi i nie ma czego oznaczać. Ten zasobnik jest obsługiwany poza wdrożeniem, więc nie ma takiego dostawcy, któremu można to powierzyć — wdrożenie posiada klucz dostępu i musi go przekazać. Dlatego ten moduł deklaruje zmienną z danymi uwierzytelniającymi, a moduły zarządzanych baz danych w bibliotece standardowej — nie.

Moduł deklaruje tę zmienną bez atrybutu sensitive Terraform, co czyni przykład czytelnym: atrybut, który czytelnik widzi zastosowany podczas renderowania, pochodzi z deklaracji encji Component, a nie z modułu.

Pliki

  • aggregate.yaml — intencja dewelopera: jeden komponent store typu example/storage/external-object-store, z bezpośrednio nazwanym zasobnikiem i obiema połówkami klucza dostępu udostępnionymi jako typowane parameters.
  • release.yaml — wypełnia te parametry dla tego środowiska i ustawia endpoint operatora. Wartości są tu symbolami zastępczymi, a nie danymi uwierzytelniającymi jakiejkolwiek rzeczywistej usługi.
  • manifest.yaml — wiąże typ komponentu z encją Recipe Terraform terraform/external-object-store, która pobiera swój moduł lokalnie.
  • .aggrega-config.yaml — wskazuje rejestr hub, z którego rozwiązywane są encje katalogu.

Obie połówki danych uwierzytelniających są parameters, a nie zapisanymi wartościami, ponieważ są to wartości dostarczane przez operatora i różne w każdym środowisku. Encja Release nie może deklarować values:, więc typowany parametr jest właśnie do tego przeznaczony: deweloper deklaruje punkt zmienności, a encja Release go wypełnia.

Generowanie przykładu

Ten przykład można zbudować za pomocą poniższych poleceń albo zlecić jego zbudowanie asystentowi AI.

Należy zapisać przykład w nowym folderze nazwanym tak jak on:

Terminal window
aggrega scaffold --example terraform-declared-sensitivity

Następnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:

Terminal window
cd terraform-declared-sensitivity

Kompilacja

Terminal window
aggrega build --release release.yaml --auto-pull

--auto-pull zapisuje podczas budowania plik blokady, którego brakuje świeżemu klonowi.

Z asystentem AI

Asystent AI skonfigurowany z narzędziami Aggrega może zrobić to samo: wystarczy wkleić mu ten prompt.

Używaj wyłącznie narzędzi Aggrega i nie twórz samodzielnie żadnego folderu. Jeśli folder obszaru roboczego nie zawiera jeszcze folderu `terraform-declared-sensitivity`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `terraform-declared-sensitivity` i bez `dir`: zapisze ono przykład w nowym folderze `terraform-declared-sensitivity`. Następnie wywołaj narzędzie `build` z `workspace_root` ustawionym na `terraform-declared-sensitivity`, `release` ustawionym na `release.yaml`, `auto_pull` ustawionym na true i `write` ustawionym na true. Podaj mi, jakie pliki zapisała kompilacja; znajdują się w `terraform-declared-sensitivity/dist/`.