-
Notifications
You must be signed in to change notification settings - Fork 0
feat: tf ephemeral value and encrypted state examples #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
resource "aws_kms_key" "tf_state" { | ||
description = "KMS key for Terraform/OpenTofu state encryption" | ||
} | ||
|
||
output "kms_key_id" { | ||
value = aws_kms_key.tf_state.key_id | ||
description = "KMS key id" | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Generate a random password | ||
resource "random_password" "main_password" { | ||
length = 128 | ||
special = false | ||
upper = true | ||
lower = true | ||
numeric = true | ||
} | ||
|
||
# Create AWS Secrets Manager secret | ||
resource "aws_secretsmanager_secret" "main_password" { | ||
name = "main-application-password" | ||
description = "Main application password" | ||
} | ||
|
||
# Store the password in the secret | ||
resource "aws_secretsmanager_secret_version" "main_password" { | ||
secret_id = aws_secretsmanager_secret.main_password.id | ||
secret_string = random_password.main_password.result | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
provider "aws" { | ||
region = "us-east-1" | ||
} |
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,36 @@ | ||||||||||||||||||||||||||||
terraform { | ||||||||||||||||||||||||||||
required_version = ">= 1.7" # Encrypted state available in OpenTofu 1.7 and later | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
required_providers { | ||||||||||||||||||||||||||||
aws = { | ||||||||||||||||||||||||||||
source = "hashicorp/aws" | ||||||||||||||||||||||||||||
version = ">= 6.0.0" | ||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||
random = { | ||||||||||||||||||||||||||||
source = "hashicorp/random" | ||||||||||||||||||||||||||||
version = ">= 3.0.0" | ||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
encryption { | ||||||||||||||||||||||||||||
method "unencrypted" "migrate" {} # to support the current unencrypted state | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
key_provider "aws_kms" "kms_key" { | ||||||||||||||||||||||||||||
kms_key_id = "INSERT_KMS_KEY_ID_HERE" | ||||||||||||||||||||||||||||
region = "us-east-1" | ||||||||||||||||||||||||||||
key_spec = "AES_256" | ||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||
Comment on lines
+18
to
+22
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid committing placeholder KMS key IDs
- kms_key_id = "INSERT_KMS_KEY_ID_HERE"
+ # If defined in the same workspace:
+ # kms_key_id = aws_kms_key.tf_state.key_id
+ # Otherwise pass it through a variable:
+ # kms_key_id = var.kms_key_id 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents
|
||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
method "aes_gcm" "kms" { | ||||||||||||||||||||||||||||
keys = key_provider.aws_kms.kms_key | ||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||
Comment on lines
+24
to
+26
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
OpenTofu/TF 1.7 expects a list for - keys = key_provider.aws_kms.kms_key
+ keys = [key_provider.aws_kms.kms_key] 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents
|
||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
state { | ||||||||||||||||||||||||||||
method = method.aes_gcm.kms | ||||||||||||||||||||||||||||
fallback { | ||||||||||||||||||||||||||||
method = method.unencrypted.migrate | ||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,15 @@ | ||||||||||||||||||||||||||
ephemeral "random_password" "random_password_ephemeral" { | ||||||||||||||||||||||||||
length = 16 | ||||||||||||||||||||||||||
special = true | ||||||||||||||||||||||||||
override_special = "!#$%&*()-_=+[]{}<>:?" | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
resource "aws_secretsmanager_secret" "random_password_ephemeral_secret" { | ||||||||||||||||||||||||||
name = "random_password_ephemeral_secret" | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
resource "aws_secretsmanager_secret_version" "random_password_ephemeral_secret_version" { | ||||||||||||||||||||||||||
secret_id = aws_secretsmanager_secret.random_password_ephemeral_secret.id | ||||||||||||||||||||||||||
secret_string_wo = ephemeral.random_password.random_password_ephemeral.result | ||||||||||||||||||||||||||
secret_string_wo_version = 1 | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
Comment on lines
+11
to
+15
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Invalid attribute names on
-resource "aws_secretsmanager_secret_version" "random_password_ephemeral_secret_version" {
- secret_id = aws_secretsmanager_secret.random_password_ephemeral_secret.id
- secret_string_wo = ephemeral.random_password.random_password_ephemeral.result
- secret_string_wo_version = 1
-}
+resource "aws_secretsmanager_secret_version" "random_password_ephemeral_secret_version" {
+ secret_id = aws_secretsmanager_secret.random_password_ephemeral_secret.id
+ secret_string = jsonencode({
+ password = ephemeral.random_password.random_password_ephemeral.result
+ })
+ version_stages = ["AWSCURRENT"]
+} 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents
|
Original file line number | Diff line number | Diff line change | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,28 @@ | ||||||||||||||||||||
variable "api_key" { | ||||||||||||||||||||
sensitive = true # Still stored in state! | ||||||||||||||||||||
default = "xK9#mP2$vL@4qR7!nT6&wZ8*bY3^fH5j-EXAMPLE_SECRET_IN_PLAINTEXT" | ||||||||||||||||||||
} | ||||||||||||||||||||
Comment on lines
+1
to
+4
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hard-coded secret should be removed from VCS Storing an actual API key in the -variable "api_key" {
- sensitive = true # Still stored in state!
- default = "xK9#mP2$vL@4qR7!nT6&wZ8*bY3^fH5j-EXAMPLE_SECRET_IN_PLAINTEXT"
-}
+variable "api_key" {
+ type = string
+ sensitive = true # Still stored in state!
+ description = "API key to be provided at apply time (e.g. TF_VAR_api_key)."
+} 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents
|
||||||||||||||||||||
|
||||||||||||||||||||
# Before - using sensitive (stored in state) | ||||||||||||||||||||
resource "aws_secretsmanager_secret_version" "sensitive_secret" { | ||||||||||||||||||||
secret_id = aws_secretsmanager_secret.sensitive_secret.id | ||||||||||||||||||||
secret_string = var.api_key # ❌ Regular attribute - stored in state! | ||||||||||||||||||||
} | ||||||||||||||||||||
|
||||||||||||||||||||
output "sensitive_secret" { | ||||||||||||||||||||
value = aws_secretsmanager_secret_version.sensitive_secret.secret_string | ||||||||||||||||||||
sensitive = true | ||||||||||||||||||||
} | ||||||||||||||||||||
|
||||||||||||||||||||
|
||||||||||||||||||||
variable "api_key_ephemeral" { | ||||||||||||||||||||
ephemeral = true # Never stored! | ||||||||||||||||||||
default = "wJalrXUtnFEMI/K7MDENG/bPxRfiCY-EXAMPLE_SECRET_WONT_BE_STORED" | ||||||||||||||||||||
} | ||||||||||||||||||||
Comment on lines
+18
to
+21
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ephemeral variable example also leaks secret through VCS Even though -variable "api_key_ephemeral" {
- ephemeral = true # Never stored!
- default = "wJalrXUtnFEMI/K7MDENG/bPxRfiCY-EXAMPLE_SECRET_WONT_BE_STORED"
-}
+variable "api_key_ephemeral" {
+ type = string
+ ephemeral = true # Never stored!
+ description = "API key supplied at apply time; never persisted to state."
+} 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents
|
||||||||||||||||||||
|
||||||||||||||||||||
# After - using ephemeral (✅ never stored) | ||||||||||||||||||||
resource "aws_secretsmanager_secret_version" "ephemeral_secret" { | ||||||||||||||||||||
secret_id = aws_secretsmanager_secret.ephemeral_secret.id | ||||||||||||||||||||
secret_string_wo = var.api_key_ephemeral # ✅ Write only attribute - NOT stored! | ||||||||||||||||||||
secret_string_wo_version = 1 | ||||||||||||||||||||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
######################################################################################## | ||
# Create the secrets in AWS Secrets Manager | ||
# There is no secret stored in these resources. The actual secret is managed by the `aws_secretsmanager_secret_version` resource. | ||
######################################################################################## | ||
resource "aws_secretsmanager_secret" "sensitive_secret" { | ||
name = "demo-sensitive-secret" | ||
} | ||
|
||
resource "aws_secretsmanager_secret" "ephemeral_secret" { | ||
name = "demo-ephemeral-secret" | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
provider "aws" { | ||
region = "us-east-1" | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
terraform { | ||
required_version = ">= 1.11.0" # Ephemeral resources and variables are only available in Terraform 1.11 and later | ||
|
||
required_providers { | ||
aws = { | ||
source = "hashicorp/aws" | ||
version = ">= 6.0.0" | ||
} | ||
random = { | ||
source = "hashicorp/random" | ||
version = ">= 3.0.0" | ||
} | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add an explicit key policy – default policy is not recommended
Static analysis (CKV2_AWS_64) flagged the absence of a
policy
block. Relying on the implicit default KMS key policy can break least-privilege and cross-account access scenarios.📝 Committable suggestion
🧰 Tools
🪛 Checkov (3.2.334)
[MEDIUM] 1-3: Ensure KMS key Policy is defined
(CKV2_AWS_64)
🤖 Prompt for AI Agents