テーマ別の解説テーマ:Terraform:変更の流れと機密情報
Terraformの機密情報を守る:sensitiveとstate・planの注意点
sensitiveは表示を伏せる指定で、値を保存しない保証ではありません。 state、保存plan、明示的な値の出力、CIの成果物を分けて確認します。秘密を扱うときは「どこから来るか・どこへ残るか・誰が読めるか」を追いましょう。
表示の秘匿と保存の抑制を区別し、state・plan・ログの保護と、ephemeral/write-onlyの適用条件を説明する。
Terraformのplan・apply・stateを知っていると読みやすい教材です。値は架空の説明用で、実際の秘密・state・planを入力する機能はありません。
伏字表示と、ファイルへ保存される内容は別
variable "report_token" {
type = string
sensitive = true
}
output "token_for_reading_example" {
value = var.report_token
sensitive = true
}これは秘密をoutputへ追加する推奨例ではありません。入力変数と、root moduleの出力を両方sensitiveにしても、表示と保存は別問題だと読む反例です。不要な出力は作らず、値を使う必要のある場所を先に絞ります。
| 確認する場所 | 読み方 |
|---|---|
| 通常の表示 | sensitiveで隠れて見えても、値の存在は否定できない。 |
| state | 管理対象の属性や出力等に機密値が含まれ得る。アクセス保護が必要。 |
| 保存plan | 画面で伏せた値でも、保存物に含まれ得る。公開ファイル扱いにしない。 |
| 値の明示出力とログ | 名前指定のoutputや-json/-raw等は値を示し得る。CIへ転載しない。 |
値の経路と、読む権限をたどる
- 値の供給元 → Terraformの処理渡す
- Terraformの処理 → state・保存plan保存経路
- Terraformの処理 → 出力・CIログ表示経路
- 値の供給元
- 必要な場所だけへ渡す
- Terraformの処理
- 入力と参照先を確認
- state・保存plan
- 保存・権限・保持期間
- 出力・CIログ
- 伏字の例外・転載先
remote backendへ移したことだけで保護完了とはしません。暗号化・アクセス権・同時操作の制御・保存期間は、それぞれ確認が必要です。 backendの排他制御は競合対策で、機密性の代わりにはなりません。
ephemeralは、保存を抑えるための別の指定
variable "session_token" {
type = string
sensitive = true
ephemeral = true
}| 確認点 | 条件 |
|---|---|
| Terraformの版 | 変数やchild module出力等のephemeralは1.10以降。 |
| 参照できる場所 | provider設定等のephemeral contextに限定される。通常の永続属性へ自由に流せるわけではない。 |
| 出力の境界 | ephemeralなchild module出力は使えるが、root module出力には指定できない。 |
| 表示の秘匿 | 保存を抑えるephemeralと、表示を伏せるsensitiveを分けて考える。 |
すべての変数へephemeralを足せば終わり、ではありません。値を必要とする引数が対応しているか、参照が許可されるかを確認します。値を別の出力やログへ自分で書き出せば、その経路の保護も必要です。
write-onlyは、対応する資源の引数で使う
| 項目 | 確認すること |
|---|---|
| Terraform | write-only引数は1.11以降が必要。 |
| 資源とprovider | 使いたい資源の、その引数がwrite-onlyとして定義されているか。 |
| 値の経路 | 対応引数へ渡す値が、別の通常属性やoutputに複製されていないか。 |
| 更新方法 | 必要な更新用のversion引数など、資源ごとの仕様を読む。 |
通常の引数へ好きな名前で_woを付けても、write-onlyにはなりません。 対応する資源仕様を確認してから設計します。この教材は特定providerの導入や実資源の作成を行いません。
レビューするのは設定だけでなく、保存物と配布先
- 実値が必要な処理と担当を絞り、不要なoutputや画面への転載を避ける。
- state・保存plan・CI成果物の保管場所、読める主体、暗号化、保持と削除を確認する。
- 版とproviderが対応する場合にephemeral/write-onlyを検討し、実際の値の経路で確認する。
- Gitの追跡済みファイルと履歴、CIログや成果物の複製も調べる。gitignoreだけで既存履歴が消えたとは扱わない。
機密情報の扱いを確かめる
選択すると、正誤と理由が表示されます。
確認して、自分の言葉で説明する
- 反例で、表示の秘匿と保存の違いを読む。
- 経路図と条件表で、保存先・版・参照先を整理する。
- 設問と復習で、保護すべき保存物と主体を説明する。
理解を確かめる: 「sensitiveを付けたから安全」と言われたら、何を追加確認する?
stateと保存plan、明示出力、CIログや成果物、Gitへの混入を確認し、読む権限と保持を整理する。保存を抑える機能は版・参照先・providerの対応を確かめる。
表示、保存、複製先、読む主体はそれぞれ異なる保護対象だから。
出典と確認した条件
説明に用いた公式資料を、確認した内容・条件と本文の参照箇所に分けてまとめています。専門家による監修・実際のAWSとの比較検証は行っていません。
確認した内容・条件sensitive変数は保存を否定しない。ephemeralと参照先の制約を確認。実値は使用しない。
参照した本文伏字表示と、ファイルへ保存される内容は別 ephemeralは、保存を抑えるための別の指定 機密情報の扱いを確かめる
確認した内容・条件root outputの通常表示と名前指定/-json/-rawの差。明示出力の機密値をログへ転載しない。
参照した本文伏字表示と、ファイルへ保存される内容は別 値の経路と、読む権限をたどる ephemeralは、保存を抑えるための別の指定 レビューするのは設定だけでなく、保存物と配布先 機密情報の扱いを確かめる
確認した内容・条件sensitiveは表示の秘匿。保存planとstateの保存内容、ephemeralとwrite-onlyの条件は別に確認。
参照した本文伏字表示と、ファイルへ保存される内容は別 値の経路と、読む権限をたどる ephemeralは、保存を抑えるための別の指定 レビューするのは設定だけでなく、保存物と配布先 機密情報の扱いを確かめる
確認した内容・条件通常planの対象読取・変更提案、保存する場合の境界。計画と適用済みの結果を区別。
参照した本文伏字表示と、ファイルへ保存される内容は別 値の経路と、読む権限をたどる レビューするのは設定だけでなく、保存物と配布先 機密情報の扱いを確かめる
確認した内容・条件backend対応時の排他制御。remoteであるだけでlock対応とはしない。force-unlockを通常手順にしない。
参照した本文値の経路と、読む権限をたどる
確認した内容・条件1.11以降と資源側の対応、値の保存抑制と更新仕様を確認。特定provider例は実行しない。
参照した本文write-onlyは、対応する資源の引数で使う レビューするのは設定だけでなく、保存物と配布先 機密情報の扱いを確かめる
確認した内容・条件既に追跡したファイルはignoreだけで消えない。過去の保存物・履歴を別に確認する。