Sensitivitas yang dideklarasikan, dirender sebagai `sensitive` milik Terraform sendiri
Deklarasi bahwa sebuah nilai membawa materi rahasia ditulis satu kali, pada skema sebuah
Component. Jika target render menyediakan primitif padanannya sendiri, deklarasi tersebut dirender ke dalamnya. Contoh ini adalah kasus Terraform: build menambahkan file override yang menambahkan sensitive = true ke input modul yang dialiri nilai yang dideklarasikan, lalu engine menyamarkan nilai tersebut di mana pun ia biasanya akan ditampilkan.
Contoh ini sengaja dibuat kecil dan setiap bagiannya dapat diperiksa: satu komponen, tiga input modul, dan satu penandaan hasil render yang menyebut tepat satu di antaranya.
Apa yang dihasilkan build
Di bawah dist/infra/terraform/, konfigurasi root dari boundary:
aggrega.modules.tf— mendeklarasikanstoresebagai blokmoduleyangsource-nya adalah./modules/storedan yang argumennya adalah variabel input modul yang telah di-resolve, dalam urutan kunci yang deterministik. Setiap boundary terraform mendapatkan satu file ini.
Di bawah dist/infra/terraform/modules/store/, file milik komponen store sendiri:
- file modul yang disalin byte demi byte —
variables.tfdanmain.tf, persis seperti yang ditulis oleh pembuat modul; aggrega_override.tf.json— penandaan sensitivitas, dijelaskan di bawah. File ini berada di samping file milik modul karena Terraform menggabungkan override ke dalam konfigurasi di direktorinya sendiri;aggrega.provenance.tf— file komentar#yang mengidentifikasi build (file JSON tidak dapat memuat komentar, sehingga provenance ditempatkan di file tersendiri).
Penandaan, dan dua input yang tidak disebutnya
example/storage/external-object-store mendeklarasikan tiga leaf values. Dua membawa
identifier publik; satu membawa kredensial dan mendeklarasikan 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 mengikat ketiga input modul:
module "store" { source = "./modules/store"
access_key_id = "AKIAEXAMPLE0001" bucket = "app-artifacts" secret_access_key = "example-placeholder-not-a-real-credential"}dan override yang ditambahkan menyebut tepat satu:
{ "variable": { "secret_access_key": { "sensitive": true } }}Terraform menggabungkan file bernama override atau yang berakhiran _override ke dalam
konfigurasi di direktori yang sama, sehingga file ini menambahkan atribut tersebut ke deklarasi secret_access_key milik modul yang sudah ada dan membiarkan tipe,
deskripsi, dan default-nya seperti yang ditulis modul. Setiap byte yang di-vendor tetap seperti yang ditulis.
Dua input yang tidak disebut oleh override adalah inti dari contoh ini. Penandaan
mengikuti deklarasi dan tidak ada yang lain — bukan nama variabel,
bukan bentuk nilainya. access_key_id adalah identifier kredensial, bukan materi kredensial, sehingga tidak dideklarasikan sensitif dan tidak ditandai,
meskipun ia berada di samping rahasia dan namanya terdengar seperti rahasia. Hapus
sensitive: true dari satu leaf tersebut dan lakukan build ulang: file override sama sekali tidak dihasilkan.
Melihatnya bekerja
main.tf menyimpan koordinat publik dan kredensial dalam atribut terpisah
dari satu resource, sehingga sebuah plan menunjukkan kedua arah sekaligus. Jalankan plan pada konfigurasi root boundary — direktori yang memuat aggrega.modules.tf, yaitu tempat nilai-nilai deployment ini berada:
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", ] }Plan Anda sendiri memuat dua atribut tersebut di antara baris yang ditampilkan. Atribut tersebut ditandai sebagai dihilangkan, bukan hilang, sehingga baris yang tidak dapat Anda jelaskan merupakan perbedaan nyata, bukan sesuatu yang dihapus oleh halaman ini.
Kredensial disamarkan; dua nilai publik di sampingnya tidak. Hapus
aggrega_override.tf.json dan jalankan ulang plan untuk melihat kredensial dicetak secara utuh — perbedaan itulah seluruh fungsi penandaan. Penandaan berada
pada blok variable milik modul, sehingga ikut bersama modul dan berlaku
di mana pun modul tersebut digunakan.
Jalankan di root, bukan di dalam modules/store/. Input sebuah komponen adalah
argumen dari blok module-nya, yang berada satu tingkat di atas, sehingga direktori komponen itu sendiri bukan konfigurasi yang dapat Anda plan seperti saat di-deploy. Apa yang dilakukan engine di sana bergantung pada blok variable milik modul, dan hanya satu dari dua kemungkinan hasilnya yang terlihat jelas:
- Modul ini mendeklarasikan ketiga inputnya tanpa
default, sehingga plan dimodules/store/gagal —No value for required variable(Tidak ada nilai untuk variabel wajib), sekali per input, masing-masing menyebut barisnya dan menawarkan solusi-var/-var-file. - Modul yang semua inputnya memiliki default justru akan menjalankan plan dengan berhasil di sana, dari default tersebut, bukan dari nilai yang diberikan konfigurasi root. Tidak ada peringatan. Itulah kasus yang perlu diketahui, karena plan yang tampak benar menggambarkan konfigurasi yang tidak diminta siapa pun.
Apa yang tidak dilakukan penandaan
sensitive mengatur tampilan. Atribut ini mencegah nilai dicetak dalam output plan dan apply,
dan mencegah Terraform menempatkan nilai tersebut ke dalam output yang tidak
ditandai sensitif. Atribut ini tidak mengenkripsi nilai dan tidak mengubah
cara nilai disimpan: setelah apply, nilai tersebut ada di state dalam bentuk teks biasa. Perlakukan state sebagai pembawa kredensial, apa pun yang dinyatakan penandaan.
Penandaan juga hanya mencapai input hasil render jika identitas input tersebut berasal
dari sebuah deklarasi. Recipe ini mendeklarasikan source: dan tidak ada valuesMapping:, sehingga
nama argumen adalah path leaf nilai yang dideklarasikan Component dan penggabungannya
tepat. Recipe yang mendeklarasikan valuesMapping: menciptakan nama output-nya
di dalam template, yang tidak disebut oleh deklarasi mana pun, sehingga Recipe seperti itu merender nilai yang sama
tanpa penandaan — file override tidak ada, bukan diperkirakan.
Menandai nama yang tidak dicapai deklarasi mana pun berarti menyatakan sesuatu yang tidak benar tentang input publik, dan tooling engine itu sendiri kemudian akan menyembunyikan nilai yang tidak pernah rahasia.
Mengapa kredensial menjadi input modul di sini
Database cloud terkelola biasanya merupakan kasus sebaliknya: provider membuat dan merotasi kata sandi master sendiri, sehingga modul tidak memerlukan input kredensial dan tidak ada yang perlu ditandai. Bucket ini dioperasikan di luar deployment, sehingga tidak ada provider semacam itu untuk didelegasikan — deployment memegang access key dan harus meneruskannya. Itulah sebabnya modul ini mendeklarasikan variabel kredensial sedangkan modul database terkelola di pustaka standar tidak.
Modul mendeklarasikan variabel tersebut tanpa atribut sensitive milik Terraform,
yang membuat contoh ini mudah dipahami: atribut yang dilihat pembaca diterapkan saat
render berasal dari deklarasi Component, bukan dari modul.
Berkas
aggregate.yaml— maksud pengembang: satu komponenstorebertipeexample/storage/external-object-store, dengan bucket dinamai langsung dan kedua bagian access key diekspos sebagaiparametersbertipe.release.yaml— memenuhi parameter tersebut untuk lingkungan ini dan menetapkanendpointmilik operator. Nilai di sini adalah placeholder, bukan kredensial untuk layanan nyata mana pun.manifest.yaml— mengikat tipe komponen ke Recipe Terraformterraform/external-object-store, yang mengambil modulnya secara lokal..aggrega-config.yaml— menyebut registri hub tempat entitas katalog di-resolve.
Kedua bagian kredensial adalah parameters, bukan nilai yang ditulis, karena keduanya
adalah nilai yang diberikan operator dan berbeda per lingkungan. Sebuah Release tidak dapat
mendeklarasikan values:, sehingga parameter bertipe adalah sarana untuk tepat hal ini: pengembang mendeklarasikan titik variasi, Release memenuhinya.
Membuat contoh
Anda dapat mem-build contoh ini dengan perintah di bawah, atau meminta asisten AI Anda mem-build-nya untuk Anda.
Tulis contoh ke folder baru yang dinamai sesuai contoh itu:
aggrega scaffold --example terraform-declared-sensitivityKemudian ia mencetak perintah yang dijalankan berikutnya. Perintah pertama berpindah ke folder baru:
cd terraform-declared-sensitivityBuild
aggrega build --release release.yaml --auto-pull--auto-pull menulis lockfile yang tidak dimiliki oleh clone baru selama build.
Dengan asisten AI
Asisten AI yang disiapkan dengan tool Aggrega dapat melakukan hal yang sama: tempelkan prompt ini ke asisten tersebut.
Gunakan hanya alat Aggrega, dan jangan membuat folder sendiri. Jika folder ruang kerja belum berisi folder `terraform-declared-sensitivity`, panggil alat `scaffold` sekali dengan `example` diatur ke `terraform-declared-sensitivity` dan tanpa `dir`: alat ini menulis contoh ke folder `terraform-declared-sensitivity` yang baru. Lalu panggil alat `build` dengan `workspace_root` diatur ke `terraform-declared-sensitivity`, `release` diatur ke `release.yaml`, `auto_pull` diatur ke true, dan `write` diatur ke true. Beri tahu saya file mana yang ditulis oleh build; file tersebut berada di bawah `terraform-declared-sensitivity/dist/`.