コンテンツにスキップ
AggregaAggrega
言語の選択: 日本語
このページは機械翻訳されています。英語の原文を読む。

宣言された機密性を Terraform 自身の `sensitive` としてレンダリングする

値が秘密情報を含むという宣言は、Component のスキーマ上で一度だけ記述します。 レンダリング先が対応する独自のプリミティブを備えている場合、その宣言はそこへレンダリングされます。この例は Terraform の場合です。 ビルドは、宣言された値が流れ込むモジュール入力に sensitive = true を追加するオーバーライドファイルを付け加え、 エンジンはその値を表示するはずの箇所すべてでそれを伏せます。

この例は意図的に小さく、すべての部分を確認できます。1 つの コンポーネント、3 つのモジュール入力、そしてそのうちちょうど 1 つを指定する レンダリングされたマーキングです。

ビルドが出力するもの

dist/infra/terraform/ の下には、境界のルート構成があります。

  • aggrega.modules.tf — store を module ブロックとして宣言します。その source は ./modules/store で、引数はモジュールの解決済み入力変数を 決定的なキー順に並べたものです。すべての terraform 境界がこれを 1 つ持ちます。

dist/infra/terraform/modules/store/ の下には、store コンポーネント自身のファイルがあります。

  • バイト単位で同一にコピーされたモジュールファイル — variables.tf と main.tf で、 モジュール作成者が書いたとおりのものです。
  • aggrega_override.tf.json — 後述する機密性のマーキングです。Terraform はオーバーライドを それ自身のディレクトリ内の構成にマージするため、このファイルはモジュール自身のファイルの隣に置かれます。
  • aggrega.provenance.tf — ビルドを識別する # コメントのファイルです(JSON ファイルはコメントを持てないため、来歴は専用のファイルに記載されます)。

マーキングと、それが指定しない 2 つの入力

example/storage/external-object-store は 3 つの values リーフを宣言します。2 つは 公開識別子を持ち、1 つは認証情報を持ち 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 ブロックは 3 つのモジュール入力すべてをバインドします。

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

一方、付け加えられたオーバーライドはちょうど 1 つだけを指定します。

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

Terraform は、override という名前のファイル、または _override で終わる名前のファイルを 同じディレクトリ内の構成にマージします。そのため、このファイルはモジュールの既存の secret_access_key 宣言に属性を追加し、型、説明、デフォルトはモジュールが書いたままにします。 ベンダリングされたバイトはすべて記述されたとおりに残ります。

オーバーライドが指定しない 2 つの入力こそが、この例の要点です。 マーキングは宣言にのみ従い、それ以外には従いません。変数の名前にも、 値の形にも従いません。access_key_id は認証情報そのものではなく認証情報の識別子 であるため、秘密の隣にあり名前が秘密のように見えても、sensitive として宣言されず、 マーキングもされません。その 1 つのリーフから sensitive: true を削除して 再ビルドすると、オーバーライドファイルはまったく出力されません。

動作の確認

main.tf は公開座標と認証情報を 1 つのリソースの別々の属性に保持するため、 plan で両方の挙動を同時に確認できます。境界のルート構成、つまりこのデプロイの値がある aggrega.modules.tf を含むディレクトリで plan を実行します。

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",
]
}

実際の plan では、示した行の間にこれら 2 つの属性が含まれます。それらは欠落しているのではなく 省略として示されているため、説明のつかない行は このページが落としたものではなく、実際の差異です。

認証情報は伏せられ、その隣にある 2 つの公開値は伏せられません。 aggrega_override.tf.json を削除して plan を再実行すると、認証情報が完全に表示されます。 その差異がマーキングの働きのすべてです。マーキングはモジュール自身の variable ブロック上にあるため、 モジュールとともに移動し、そのモジュールが使われるすべての場所に適用されます。

modules/store/ の中ではなく、ルートで実行してください。 コンポーネントの入力は 1 つ上の階層にあるその module ブロックの引数であるため、コンポーネント自身のディレクトリは デプロイされたとおりに plan できる構成ではありません。そこでエンジンが何をするかはモジュール自身の variable ブロックによって決まり、2 つの結果のうち目立つのは一方だけです。

  • このモジュールは 3 つの入力すべてを default なしで宣言しているため、 modules/store/ での plan は失敗します。入力ごとに No value for required variable が出力され、 それぞれが該当行を示し、-var / -var-file による対処を提示します。
  • 入力がすべてデフォルトを持つモジュールでは、そこでの plan は代わりに成功します。 ルート構成が与える値ではなく、それらのデフォルトから plan されます。 何も警告されません。これが知っておくべきケースです。正しく見える plan が、 誰も求めていない構成を記述しているからです。

マーキングが行わないこと

sensitive が制御するのは表示です。plan と apply の出力に値が表示されるのを防ぎ、 Terraform がその値を、それ自体 sensitive としてマークされていない output に入れるのを防ぎます。 値を暗号化することはなく、値の保存方法も変えません。apply の後、値は state に 平文で存在します。マーキングの内容にかかわらず、state は認証情報を含むものとして扱ってください。

また、マーキングがレンダリングされた入力に届くのは、その入力の識別が宣言に由来する場合のみです。 この Recipe は source: を宣言し valuesMapping: を宣言しないため、 引数名は Component が宣言した値リーフのパスであり、対応付けは正確です。 valuesMapping: を宣言する Recipe は、どの宣言も指定しないテンプレート内で出力名を作り出すため、 そのような Recipe は同じ値をマーキングなしでレンダリングします。オーバーライドファイルは近似されるのではなく、存在しません。 どの宣言も届かない名前をマークすれば、公開入力について誤ったことを主張することになり、 エンジン自身のツールが秘密ではなかった値を隠すことになります。

ここで認証情報がモジュール入力である理由

マネージドクラウドデータベースは通常もう一方のケースです。プロバイダーがマスターパスワードを自ら生成し ローテーションするため、モジュールは認証情報の入力を必要とせず、マークするものはありません。 このバケットはデプロイの外部で運用されているため、委任できるそのようなプロバイダーはありません。 デプロイはアクセスキーを保持し、それを渡す必要があります。そのため、このモジュールは認証情報の変数を宣言し、 標準ライブラリのマネージドデータベースのモジュールは宣言しません。

モジュールはその変数を Terraform の sensitive 属性なしで宣言しており、 それがこの例をわかりやすくしています。レンダリング時に適用される属性は、 モジュールではなく Component の宣言に由来します。

ファイル

  • aggregate.yaml — 開発者の意図です。型 example/storage/external-object-store の store コンポーネントを 1 つ持ち、 バケット名を直接指定し、アクセスキーの両方を型付きの parameters として公開します。
  • release.yaml — この環境向けにそれらのパラメーターを満たし、オペレーターの endpoint を設定します。ここでの値はプレースホルダーであり、実在するサービスの認証情報ではありません。
  • manifest.yaml — コンポーネントの型を、モジュールをローカルから取得する Terraform Recipe terraform/external-object-store にバインドします。
  • .aggrega-config.yaml — カタログのエンティティの解決元となるハブレジストリを指定します。

認証情報の両方が記述された値ではなく parameters であるのは、それらが オペレーターが与え、環境ごとに異なる値だからです。Release は values: を宣言できないため、 型付きパラメーターがまさにこのための仕組みです。開発者が変化点を宣言し、Release がそれを満たします。

サンプルを生成する

このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。

例の名前を付けた新しいフォルダーに例を書き出します。

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

その後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。

Terminal window
cd terraform-declared-sensitivity

ビルド

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

--auto-pull は、新しいクローンにはない lockfile をビルド中に書き出します。

AI アシスタントを使う

Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。

Aggrega のツールのみを使用し、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `terraform-declared-sensitivity` フォルダーがない場合は、`example` を `terraform-declared-sensitivity` に設定し、`dir` を指定せずに `scaffold` ツールを 1 回呼び出してください。これにより、新しい `terraform-declared-sensitivity` フォルダーに例が書き込まれます。次に、`workspace_root` を `terraform-declared-sensitivity`、`release` を `release.yaml`、`auto_pull` を true、`write` を true に設定して `build` ツールを呼び出してください。ビルドが書き込んだファイルを教えてください。ファイルは `terraform-declared-sensitivity/dist/` の下にあります。