From 213e7fb0e9c9a3a8745e1405b6d46a41274d6109 Mon Sep 17 00:00:00 2001 From: piravinth Date: Mon, 11 May 2026 14:29:13 +0100 Subject: [PATCH 1/4] Intro GD module --- infrastructure/modules/guardduty/main.tf | 148 ++++++++++++++++++ infrastructure/modules/guardduty/outputs.tf | 14 ++ infrastructure/modules/guardduty/readme.md | 61 ++++++++ infrastructure/modules/guardduty/variables.tf | 104 ++++++++++++ 4 files changed, 327 insertions(+) create mode 100644 infrastructure/modules/guardduty/main.tf create mode 100644 infrastructure/modules/guardduty/outputs.tf create mode 100644 infrastructure/modules/guardduty/readme.md create mode 100644 infrastructure/modules/guardduty/variables.tf diff --git a/infrastructure/modules/guardduty/main.tf b/infrastructure/modules/guardduty/main.tf new file mode 100644 index 0000000..e4f5559 --- /dev/null +++ b/infrastructure/modules/guardduty/main.tf @@ -0,0 +1,148 @@ +################################################################ +# GuardDuty Detector +################################################################ + +resource "aws_guardduty_detector" "this" { + enable = var.enabled + finding_publishing_frequency = var.finding_publishing_frequency + + tags = merge( + var.tags, + { + Name = "${var.name_prefix}-guardduty" + Environment = var.environment + }, + ) +} + +################################################################ +# Detector Features +# +# All feature toggles use the newer aws_guardduty_detector_feature +# resource +################################################################ + +resource "aws_guardduty_detector_feature" "s3_data_events" { + count = var.enabled ? 1 : 0 + + detector_id = aws_guardduty_detector.this.id + name = "S3_DATA_EVENTS" + status = var.s3_protection_enabled ? "ENABLED" : "DISABLED" +} + +resource "aws_guardduty_detector_feature" "eks_audit_logs" { + count = var.enabled ? 1 : 0 + + detector_id = aws_guardduty_detector.this.id + name = "EKS_AUDIT_LOGS" + status = var.kubernetes_audit_logs_enabled ? "ENABLED" : "DISABLED" +} + +resource "aws_guardduty_detector_feature" "ebs_malware_protection" { + count = var.enabled ? 1 : 0 + + detector_id = aws_guardduty_detector.this.id + name = "EBS_MALWARE_PROTECTION" + status = var.malware_protection_scan_ec2_ebs_volumes_enabled ? "ENABLED" : "DISABLED" +} + +resource "aws_guardduty_detector_feature" "lambda_network_logs" { + count = var.enabled ? 1 : 0 + + detector_id = aws_guardduty_detector.this.id + name = "LAMBDA_NETWORK_LOGS" + status = var.lambda_network_logs_enabled ? "ENABLED" : "DISABLED" +} + +# Runtime Monitoring (EC2 + ECS + EKS). Mutually exclusive with +# eks_runtime_monitoring_enabled — guarded by the precondition below. +resource "aws_guardduty_detector_feature" "runtime_monitoring" { + count = var.enabled ? 1 : 0 + + detector_id = aws_guardduty_detector.this.id + name = "RUNTIME_MONITORING" + status = var.runtime_monitoring_enabled ? "ENABLED" : "DISABLED" + + dynamic "additional_configuration" { + for_each = var.runtime_monitoring_enabled ? [1] : [] + content { + name = "EKS_ADDON_MANAGEMENT" + status = var.runtime_monitoring_additional_config.eks_addon_management_enabled ? "ENABLED" : "DISABLED" + } + } + + dynamic "additional_configuration" { + for_each = var.runtime_monitoring_enabled ? [1] : [] + content { + name = "ECS_FARGATE_AGENT_MANAGEMENT" + status = var.runtime_monitoring_additional_config.ecs_fargate_agent_management_enabled ? "ENABLED" : "DISABLED" + } + } + + dynamic "additional_configuration" { + for_each = var.runtime_monitoring_enabled ? [1] : [] + content { + name = "EC2_AGENT_MANAGEMENT" + status = var.runtime_monitoring_additional_config.ec2_agent_management_enabled ? "ENABLED" : "DISABLED" + } + } + + lifecycle { + precondition { + condition = !(var.runtime_monitoring_enabled && var.eks_runtime_monitoring_enabled) + error_message = "runtime_monitoring_enabled and eks_runtime_monitoring_enabled are mutually exclusive. RUNTIME_MONITORING already covers EKS." + } + } +} + +# Standalone EKS Runtime Monitoring (only enable when RUNTIME_MONITORING is off). +resource "aws_guardduty_detector_feature" "eks_runtime_monitoring" { + count = var.enabled ? 1 : 0 + + detector_id = aws_guardduty_detector.this.id + name = "EKS_RUNTIME_MONITORING" + status = var.eks_runtime_monitoring_enabled ? "ENABLED" : "DISABLED" + + dynamic "additional_configuration" { + for_each = var.eks_runtime_monitoring_enabled ? [1] : [] + content { + name = "EKS_ADDON_MANAGEMENT" + status = var.runtime_monitoring_additional_config.eks_addon_management_enabled ? "ENABLED" : "DISABLED" + } + } +} + +################################################################ +# CloudWatch Event Rule -> SNS forwarding for findings +# +# The SNS topic itself is created by the separate alerting module. +# Pass the topic ARN via `findings_notification_arn` to wire findings into it. +################################################################ + +resource "aws_cloudwatch_event_rule" "findings" { + count = var.enabled && var.enable_cloudwatch ? 1 : 0 + + name = "${var.name_prefix}-guardduty-findings" + description = "Forward GuardDuty findings to SNS for alerting." + + event_pattern = jsonencode({ + source = ["aws.guardduty"] + detail-type = [var.cloudwatch_event_rule_pattern_detail_type] + }) + + tags = merge( + var.tags, + { + Name = "${var.name_prefix}-guardduty-findings" + Environment = var.environment + }, + ) +} + +resource "aws_cloudwatch_event_target" "findings" { + count = var.enabled && var.enable_cloudwatch && var.findings_notification_arn != null ? 1 : 0 + + rule = aws_cloudwatch_event_rule.findings[0].name + target_id = "${var.name_prefix}-guardduty-findings-sns" + arn = var.findings_notification_arn +} diff --git a/infrastructure/modules/guardduty/outputs.tf b/infrastructure/modules/guardduty/outputs.tf new file mode 100644 index 0000000..ec89660 --- /dev/null +++ b/infrastructure/modules/guardduty/outputs.tf @@ -0,0 +1,14 @@ +output "detector_id" { + description = "The ID of the GuardDuty detector." + value = aws_guardduty_detector.this.id +} + +output "detector_arn" { + description = "The ARN of the GuardDuty detector." + value = aws_guardduty_detector.this.arn +} + +output "cloudwatch_event_rule_arn" { + description = "ARN of the CloudWatch (EventBridge) rule forwarding GuardDuty findings, if created." + value = try(aws_cloudwatch_event_rule.findings[0].arn, null) +} diff --git a/infrastructure/modules/guardduty/readme.md b/infrastructure/modules/guardduty/readme.md new file mode 100644 index 0000000..c0fb03c --- /dev/null +++ b/infrastructure/modules/guardduty/readme.md @@ -0,0 +1,61 @@ +# GuardDuty + + + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider_aws) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_cloudwatch_event_rule.findings](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_rule) | resource | +| [aws_cloudwatch_event_target.findings](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_target) | resource | +| [aws_guardduty_detector.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_detector) | resource | +| [aws_guardduty_detector_feature.ebs_malware_protection](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_detector_feature) | resource | +| [aws_guardduty_detector_feature.eks_audit_logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_detector_feature) | resource | +| [aws_guardduty_detector_feature.eks_runtime_monitoring](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_detector_feature) | resource | +| [aws_guardduty_detector_feature.lambda_network_logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_detector_feature) | resource | +| [aws_guardduty_detector_feature.runtime_monitoring](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_detector_feature) | resource | +| [aws_guardduty_detector_feature.s3_data_events](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_detector_feature) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [cloudwatch_event_rule_pattern_detail_type](#input_cloudwatch_event_rule_pattern_detail_type) | The detail-type pattern used to match GuardDuty events for the CloudWatch rule. | `string` | `"GuardDuty Finding"` | no | +| [eks_runtime_monitoring_enabled](#input_eks_runtime_monitoring_enabled) | Enable standalone EKS Runtime Monitoring (EKS_RUNTIME_MONITORING). Do not enable alongside runtime_monitoring_enabled. | `bool` | `false` | no | +| [enable_cloudwatch](#input_enable_cloudwatch) | Create a CloudWatch (EventBridge) rule that forwards GuardDuty findings. The SNS topic itself is created by the separate alerting module. | `bool` | `true` | no | +| [enabled](#input_enabled) | Master switch for the GuardDuty detector. Set to false to disable the detector and all features. | `bool` | `true` | no | +| [environment](#input_environment) | The name of the Environment this is deployed into, for example CICD, NFT, UAT or PROD. | `string` | n/a | yes | +| [finding_publishing_frequency](#input_finding_publishing_frequency) | Frequency of finding notifications. Valid values: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. Only meaningful for standalone/master accounts. | `string` | `"FIFTEEN_MINUTES"` | no | +| [findings_notification_arn](#input_findings_notification_arn) | ARN of an existing SNS topic that GuardDuty findings should be forwarded to. Leave null to skip target wiring. | `string` | `null` | no | +| [kubernetes_audit_logs_enabled](#input_kubernetes_audit_logs_enabled) | Enable EKS audit log monitoring (EKS_AUDIT_LOGS). | `bool` | `false` | no | +| [lambda_network_logs_enabled](#input_lambda_network_logs_enabled) | Enable Lambda network log monitoring (LAMBDA_NETWORK_LOGS). | `bool` | `false` | no | +| [malware_protection_scan_ec2_ebs_volumes_enabled](#input_malware_protection_scan_ec2_ebs_volumes_enabled) | Enable EBS Malware Protection scanning of EC2 instance volumes (EBS_MALWARE_PROTECTION). | `bool` | `true` | no | +| [name_prefix](#input_name_prefix) | Prefix used to name GuardDuty resources (e.g. account/environment identifier). | `string` | n/a | yes | +| [runtime_monitoring_additional_config](#input_runtime_monitoring_additional_config) | Additional configuration for runtime monitoring agent management. | 
object({
    eks_addon_management_enabled         = optional(bool, false)
    ecs_fargate_agent_management_enabled = optional(bool, false)
    ec2_agent_management_enabled         = optional(bool, false)
  })
| `{}` | no | +| [runtime_monitoring_enabled](#input_runtime_monitoring_enabled) | Enable Runtime Monitoring for EC2, ECS and EKS resources (RUNTIME_MONITORING). Mutually exclusive with eks_runtime_monitoring_enabled. | `bool` | `false` | no | +| [s3_protection_enabled](#input_s3_protection_enabled) | Enable S3 Data Events Protection (S3_DATA_EVENTS). | `bool` | `true` | no | +| [tags](#input_tags) | Additional tags to apply to all resources created by this module. | `map(string)` | `{}` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [cloudwatch_event_rule_arn](#output_cloudwatch_event_rule_arn) | ARN of the CloudWatch (EventBridge) rule forwarding GuardDuty findings, if created. | +| [detector_arn](#output_detector_arn) | The ARN of the GuardDuty detector. | +| [detector_id](#output_detector_id) | The ID of the GuardDuty detector. | + + diff --git a/infrastructure/modules/guardduty/variables.tf b/infrastructure/modules/guardduty/variables.tf new file mode 100644 index 0000000..6535627 --- /dev/null +++ b/infrastructure/modules/guardduty/variables.tf @@ -0,0 +1,104 @@ +variable "name_prefix" { + description = "Prefix used to name GuardDuty resources (e.g. account/environment identifier)." + type = string +} + +variable "environment" { + description = "The name of the Environment this is deployed into, for example CICD, NFT, UAT or PROD." + type = string +} + +variable "tags" { + description = "Additional tags to apply to all resources created by this module." + type = map(string) + default = {} +} + +variable "enabled" { + description = "Master switch for the GuardDuty detector. Set to false to disable the detector and all features." + type = bool + default = true +} + +variable "finding_publishing_frequency" { + description = "Frequency of finding notifications. Valid values: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. Only meaningful for standalone/master accounts." + type = string + default = "FIFTEEN_MINUTES" + + validation { + condition = var.finding_publishing_frequency == null || contains(["FIFTEEN_MINUTES", "ONE_HOUR", "SIX_HOURS"], coalesce(var.finding_publishing_frequency, "SIX_HOURS")) + error_message = "finding_publishing_frequency must be one of FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS." + } +} + +################################################################ +# Detector feature toggles +################################################################ + +variable "s3_protection_enabled" { + description = "Enable S3 Data Events Protection (S3_DATA_EVENTS)." + type = bool + default = true +} + +variable "kubernetes_audit_logs_enabled" { + description = "Enable EKS audit log monitoring (EKS_AUDIT_LOGS)." + type = bool + default = false +} + +variable "malware_protection_scan_ec2_ebs_volumes_enabled" { + description = "Enable EBS Malware Protection scanning of EC2 instance volumes (EBS_MALWARE_PROTECTION)." + type = bool + default = true +} + +variable "lambda_network_logs_enabled" { + description = "Enable Lambda network log monitoring (LAMBDA_NETWORK_LOGS)." + type = bool + default = false +} + +variable "runtime_monitoring_enabled" { + description = "Enable Runtime Monitoring for EC2, ECS and EKS resources (RUNTIME_MONITORING). Mutually exclusive with eks_runtime_monitoring_enabled." + type = bool + default = false +} + +variable "eks_runtime_monitoring_enabled" { + description = "Enable standalone EKS Runtime Monitoring (EKS_RUNTIME_MONITORING). Do not enable alongside runtime_monitoring_enabled." + type = bool + default = false +} + +variable "runtime_monitoring_additional_config" { + description = "Additional configuration for runtime monitoring agent management." + type = object({ + eks_addon_management_enabled = optional(bool, false) + ecs_fargate_agent_management_enabled = optional(bool, false) + ec2_agent_management_enabled = optional(bool, false) + }) + default = {} +} + +################################################################ +# CloudWatch Event -> SNS forwarding +################################################################ + +variable "enable_cloudwatch" { + description = "Create a CloudWatch (EventBridge) rule that forwards GuardDuty findings. The SNS topic itself is created by the separate alerting module." + type = bool + default = true +} + +variable "cloudwatch_event_rule_pattern_detail_type" { + description = "The detail-type pattern used to match GuardDuty events for the CloudWatch rule." + type = string + default = "GuardDuty Finding" +} + +variable "findings_notification_arn" { + description = "ARN of an existing SNS topic that GuardDuty findings should be forwarded to. Leave null to skip target wiring." + type = string + default = null +} From 6652960ed7ddca58592db6325ca56e0bbbaebd54 Mon Sep 17 00:00:00 2001 From: piravinth Date: Mon, 11 May 2026 16:57:40 +0100 Subject: [PATCH 2/4] consume context.tf --- infrastructure/modules/guardduty/context.tf | 365 ++++++++++++++++++ infrastructure/modules/guardduty/main.tf | 66 ++-- infrastructure/modules/guardduty/outputs.tf | 4 +- infrastructure/modules/guardduty/readme.md | 39 +- infrastructure/modules/guardduty/variables.tf | 29 +- 5 files changed, 442 insertions(+), 61 deletions(-) create mode 100644 infrastructure/modules/guardduty/context.tf diff --git a/infrastructure/modules/guardduty/context.tf b/infrastructure/modules/guardduty/context.tf new file mode 100644 index 0000000..018aaaa --- /dev/null +++ b/infrastructure/modules/guardduty/context.tf @@ -0,0 +1,365 @@ +# +# ONLY EDIT THIS FILE IN github.com/NHSDigital/screening-terraform-modules-aws/infrastructure/modules/tags +# All other instances of this file should be a copy of that one +# +# +# Copy this file from https://github.com/NHSDigital/screening-terraform-modules-aws/blob/master/infrastructure/modules/tags/exports/context.tf +# and then place it in your Terraform module to automatically get +# tag module standard configuration inputs suitable for passing +# to other modules. +# +# curl -sL https://raw.githubusercontent.com/NHSDigital/screening-terraform-modules-aws/master/infrastructure/modules/tags/exports/context.tf -o context.tf +# +# Modules should access the whole context as `module.this.context` +# to get the input variables with nulls for defaults, +# for example `context = module.this.context`, +# and access individual variables as `module.this.`, +# with final values filled in. +# +# For example, when using defaults, `module.this.context.delimiter` +# will be null, and `module.this.delimiter` will be `-` (hyphen). +# + +module "this" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags?ref=feature/BCSS-23189-add-new-modules-to-suppport-bcss" + + service = var.service + project = var.project + region = var.region + environment = var.environment + stack = var.stack + workspace = var.workspace + name = var.name + delimiter = var.delimiter + attributes = var.attributes + tags = var.tags + additional_tag_map = var.additional_tag_map + label_order = var.label_order + regex_replace_chars = var.regex_replace_chars + id_length_limit = var.id_length_limit + label_key_case = var.label_key_case + label_value_case = var.label_value_case + descriptor_formats = var.descriptor_formats + labels_as_tags = var.labels_as_tags + + context = var.context +} + +# Copy contents of screening-terraform-modules-aws/tags/variables.tf here +# tflint-ignore: terraform_unused_declarations +variable "aws_region" { + type = string + description = "The AWS region" + default = "eu-west-2" + validation { + condition = contains(["eu-west-1", "eu-west-2", "us-east-1"], var.aws_region) + error_message = "AWS Region must be one of eu-west-1, eu-west-2, us-east-1" + } +} + +variable "context" { + type = any + default = { + enabled = true + service = null + project = null + region = null + environment = null + stack = null + workspace = null + delimiter = null + attributes = [] + tags = {} + additional_tag_map = {} + regex_replace_chars = null + label_order = [] + id_length_limit = null + label_key_case = null + label_value_case = null + descriptor_formats = {} + # Note: we have to use [] instead of null for unset lists due to + # https://github.com/hashicorp/terraform/issues/28137 + # which was not fixed until Terraform 1.0.0, + # but we want the default to be all the labels in `label_order` + # and we want users to be able to prevent all tag generation + # by setting `labels_as_tags` to `[]`, so we need + # a different sentinel to indicate "default" + labels_as_tags = ["unset"] + } + description = <<-EOT + Single object for setting entire context at once. + See description of individual variables for details. + Leave string and numeric variables as `null` to use default value. + Individual variable settings (non-null) override settings in context object, + except for attributes, tags, and additional_tag_map, which are merged. + EOT + + validation { + condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"]) + error_message = "Allowed values: `lower`, `title`, `upper`." + } + + validation { + condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"]) + error_message = "Allowed values: `lower`, `title`, `upper`, `none`." + } +} + +variable "enabled" { + type = bool + default = null + description = "Set to false to prevent the module from creating any resources" +} + +variable "service" { + type = string + default = null + description = "ID element. Usually an abbreviation of your service directorate name, e.g. 'bcss' or 'csms', to help ensure generated IDs are globally unique" +} + +variable "region" { + type = string + default = null + description = "ID element _(Rarely used, not included by default)_. Usually an abbreviation of the selected AWS region e.g. 'uw2', 'ew2' or 'gbl' for resources like IAM roles that have no region" +} + +variable "project" { + type = string + default = null + description = "ID element. A project identifier, indicating the name or role of the project the resource is for, such as `website` or `api`" +} +variable "stack" { + type = string + default = null + description = "ID element. The name of the stack/component, e.g. `database`, `web`, `waf`, `eks`" +} +variable "workspace" { + type = string + default = null + description = "ID element. The Terraform workspace, to help ensure generated IDs are unique across workspaces" +} +variable "environment" { + type = string + default = null + description = "ID element. Usually used to indicate role, e.g. 'prd', 'dev', 'test', 'preprod', 'prod', 'uat'" +} + +variable "name" { + type = string + default = null + description = <<-EOT + ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. + This is the only ID element not also included as a `tag`. + The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. + EOT +} + +variable "delimiter" { + type = string + default = null + description = <<-EOT + Delimiter to be used between ID elements. + Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. + EOT +} + +variable "attributes" { + type = list(string) + default = [] + description = <<-EOT + ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, + in the order they appear in the list. New attributes are appended to the + end of the list. The elements of the list are joined by the `delimiter` + and treated as a single ID element. + EOT +} + +variable "labels_as_tags" { + type = set(string) + default = ["default"] + description = <<-EOT + Set of labels (ID elements) to include as tags in the `tags` output. + Default is to include all labels. + Tags with empty values will not be included in the `tags` output. + Set to `[]` to suppress all generated tags. + **Notes:** + The value of the `name` tag, if included, will be the `id`, not the `name`. + Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be + changed in later chained modules. Attempts to change it will be silently ignored. + EOT +} + +variable "tags" { + type = map(string) + default = {} + description = <<-EOT + Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). + Neither the tag keys nor the tag values will be modified by this module. + EOT +} + +variable "additional_tag_map" { + type = map(string) + default = {} + description = <<-EOT + Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. + This is for some rare cases where resources want additional configuration of tags + and therefore take a list of maps with tag key, value, and additional configuration. + EOT +} + +variable "label_order" { + type = list(string) + default = null + description = <<-EOT + The order in which the labels (ID elements) appear in the `id`. + Defaults to ["namespace", "environment", "stage", "name", "attributes"]. + You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. + EOT +} + +variable "regex_replace_chars" { + type = string + default = null + description = <<-EOT + Terraform regular expression (regex) string. + Characters matching the regex will be removed from the ID elements. + If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. + EOT +} + +variable "id_length_limit" { + type = number + default = null + description = <<-EOT + Limit `id` to this many characters (minimum 6). + Set to `0` for unlimited length. + Set to `null` for keep the existing setting, which defaults to `0`. + Does not affect `id_full`. + EOT + validation { + condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0 + error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length." + } +} + +variable "label_key_case" { + type = string + default = null + description = <<-EOT + Controls the letter case of the `tags` keys (label names) for tags generated by this module. + Does not affect keys of tags passed in via the `tags` input. + Possible values: `lower`, `title`, `upper`. + Default value: `title`. + EOT + + validation { + condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case) + error_message = "Allowed values: `lower`, `title`, `upper`." + } +} + +variable "label_value_case" { + type = string + default = null + description = <<-EOT + Controls the letter case of ID elements (labels) as included in `id`, + set as tag values, and output by this module individually. + Does not affect values of tags passed in via the `tags` input. + Possible values: `lower`, `title`, `upper` and `none` (no transformation). + Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. + Default value: `lower`. + EOT + + validation { + condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case) + error_message = "Allowed values: `lower`, `title`, `upper`, `none`." + } +} + +variable "descriptor_formats" { + type = any + default = {} + description = <<-EOT + Describe additional descriptors to be output in the `descriptors` output map. + Map of maps. Keys are names of descriptors. Values are maps of the form + `{ + format = string + labels = list(string) + }` + (Type is `any` so the map values can later be enhanced to provide additional options.) + `format` is a Terraform format string to be passed to the `format()` function. + `labels` is a list of labels, in order, to pass to `format()` function. + Label values will be normalized before being passed to `format()` so they will be + identical to how they appear in `id`. + Default is `{}` (`descriptors` output will be empty). + EOT +} + +variable "owner" { + type = string + description = "The name and or NHS.net email address of the service owner" + default = "None" +} + +variable "tag_version" { + type = string + description = "Used to identify the tagging version in use" + default = "1.0" +} + +variable "data_classification" { + type = string + description = "Used to identify the data classification of the resource, e.g 1-5" + default = "n/a" + validation { + condition = contains(["n/a", "1", "2", "3", "4", "5"], var.data_classification) + error_message = "Data Classification must be \"n/a\" or between 1-5" + } +} + +variable "data_type" { + type = string + description = "The tag data_type" + default = "None" + validation { + condition = contains(["None", "PCD", "PID", "Anonymised", "UserAccount", "Audit"], var.data_type) + error_message = "Data Type must be one of None, PCD, PID, Anonymised, UserAccount, Audit" + } +} + + +variable "public_facing" { + type = bool + description = "Whether this resource is public facing" + default = false +} + +variable "service_category" { + type = string + description = "The tag service_category" + default = "n/a" + validation { + condition = contains(["n/a", "Bronze", "Silver", "Gold", "Platinum"], var.service_category) + error_message = "The Service Category must be one of n/a, Bronze, Silver, Gold, Platinum" + } +} +variable "on_off_pattern" { + type = string + description = "Used to turn resources on and off based on a time pattern" + default = "n/a" +} + +variable "application_role" { + type = string + description = "The role the application is performing" + default = "General" +} + +variable "tool" { + type = string + description = "The tool used to deploy the resource" + default = "Terraform" +} + +#### End of copy of screening-terraform-modules-aws/tags/variables.tf \ No newline at end of file diff --git a/infrastructure/modules/guardduty/main.tf b/infrastructure/modules/guardduty/main.tf index e4f5559..3204a93 100644 --- a/infrastructure/modules/guardduty/main.tf +++ b/infrastructure/modules/guardduty/main.tf @@ -3,53 +3,49 @@ ################################################################ resource "aws_guardduty_detector" "this" { - enable = var.enabled + count = module.this.enabled ? 1 : 0 + + enable = true finding_publishing_frequency = var.finding_publishing_frequency - tags = merge( - var.tags, - { - Name = "${var.name_prefix}-guardduty" - Environment = var.environment - }, - ) + tags = module.this.tags } ################################################################ # Detector Features # # All feature toggles use the newer aws_guardduty_detector_feature -# resource +# resource ################################################################ resource "aws_guardduty_detector_feature" "s3_data_events" { - count = var.enabled ? 1 : 0 + count = module.this.enabled ? 1 : 0 - detector_id = aws_guardduty_detector.this.id + detector_id = aws_guardduty_detector.this[0].id name = "S3_DATA_EVENTS" status = var.s3_protection_enabled ? "ENABLED" : "DISABLED" } resource "aws_guardduty_detector_feature" "eks_audit_logs" { - count = var.enabled ? 1 : 0 + count = module.this.enabled ? 1 : 0 - detector_id = aws_guardduty_detector.this.id + detector_id = aws_guardduty_detector.this[0].id name = "EKS_AUDIT_LOGS" status = var.kubernetes_audit_logs_enabled ? "ENABLED" : "DISABLED" } resource "aws_guardduty_detector_feature" "ebs_malware_protection" { - count = var.enabled ? 1 : 0 + count = module.this.enabled ? 1 : 0 - detector_id = aws_guardduty_detector.this.id + detector_id = aws_guardduty_detector.this[0].id name = "EBS_MALWARE_PROTECTION" status = var.malware_protection_scan_ec2_ebs_volumes_enabled ? "ENABLED" : "DISABLED" } resource "aws_guardduty_detector_feature" "lambda_network_logs" { - count = var.enabled ? 1 : 0 + count = module.this.enabled ? 1 : 0 - detector_id = aws_guardduty_detector.this.id + detector_id = aws_guardduty_detector.this[0].id name = "LAMBDA_NETWORK_LOGS" status = var.lambda_network_logs_enabled ? "ENABLED" : "DISABLED" } @@ -57,9 +53,9 @@ resource "aws_guardduty_detector_feature" "lambda_network_logs" { # Runtime Monitoring (EC2 + ECS + EKS). Mutually exclusive with # eks_runtime_monitoring_enabled — guarded by the precondition below. resource "aws_guardduty_detector_feature" "runtime_monitoring" { - count = var.enabled ? 1 : 0 + count = module.this.enabled ? 1 : 0 - detector_id = aws_guardduty_detector.this.id + detector_id = aws_guardduty_detector.this[0].id name = "RUNTIME_MONITORING" status = var.runtime_monitoring_enabled ? "ENABLED" : "DISABLED" @@ -97,9 +93,9 @@ resource "aws_guardduty_detector_feature" "runtime_monitoring" { # Standalone EKS Runtime Monitoring (only enable when RUNTIME_MONITORING is off). resource "aws_guardduty_detector_feature" "eks_runtime_monitoring" { - count = var.enabled ? 1 : 0 + count = module.this.enabled ? 1 : 0 - detector_id = aws_guardduty_detector.this.id + detector_id = aws_guardduty_detector.this[0].id name = "EKS_RUNTIME_MONITORING" status = var.eks_runtime_monitoring_enabled ? "ENABLED" : "DISABLED" @@ -115,14 +111,24 @@ resource "aws_guardduty_detector_feature" "eks_runtime_monitoring" { ################################################################ # CloudWatch Event Rule -> SNS forwarding for findings # -# The SNS topic itself is created by the separate alerting module. +# The SNS topic itself is created by the separate alerting module. # Pass the topic ARN via `findings_notification_arn` to wire findings into it. ################################################################ +# Sub-label for the findings EventBridge rule so its name/tags +# are derived from the same context but disambiguated from the +# detector. +module "findings_label" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags?ref=feature/BCSS-23189-add-new-modules-to-suppport-bcss" + context = module.this.context + + attributes = concat(module.this.attributes, ["findings"]) +} + resource "aws_cloudwatch_event_rule" "findings" { - count = var.enabled && var.enable_cloudwatch ? 1 : 0 + count = module.this.enabled && var.enable_cloudwatch ? 1 : 0 - name = "${var.name_prefix}-guardduty-findings" + name = module.findings_label.id description = "Forward GuardDuty findings to SNS for alerting." event_pattern = jsonencode({ @@ -130,19 +136,13 @@ resource "aws_cloudwatch_event_rule" "findings" { detail-type = [var.cloudwatch_event_rule_pattern_detail_type] }) - tags = merge( - var.tags, - { - Name = "${var.name_prefix}-guardduty-findings" - Environment = var.environment - }, - ) + tags = module.findings_label.tags } resource "aws_cloudwatch_event_target" "findings" { - count = var.enabled && var.enable_cloudwatch && var.findings_notification_arn != null ? 1 : 0 + count = module.this.enabled && var.enable_cloudwatch && var.findings_notification_arn != null ? 1 : 0 rule = aws_cloudwatch_event_rule.findings[0].name - target_id = "${var.name_prefix}-guardduty-findings-sns" + target_id = module.findings_label.id arn = var.findings_notification_arn } diff --git a/infrastructure/modules/guardduty/outputs.tf b/infrastructure/modules/guardduty/outputs.tf index ec89660..1e35ccd 100644 --- a/infrastructure/modules/guardduty/outputs.tf +++ b/infrastructure/modules/guardduty/outputs.tf @@ -1,11 +1,11 @@ output "detector_id" { description = "The ID of the GuardDuty detector." - value = aws_guardduty_detector.this.id + value = try(aws_guardduty_detector.this[0].id, null) } output "detector_arn" { description = "The ARN of the GuardDuty detector." - value = aws_guardduty_detector.this.arn + value = try(aws_guardduty_detector.this[0].arn, null) } output "cloudwatch_event_rule_arn" { diff --git a/infrastructure/modules/guardduty/readme.md b/infrastructure/modules/guardduty/readme.md index c0fb03c..be222f1 100644 --- a/infrastructure/modules/guardduty/readme.md +++ b/infrastructure/modules/guardduty/readme.md @@ -14,7 +14,10 @@ No requirements. ## Modules -No modules. +| Name | Source | Version | +|------|--------|---------| +| [findings_label](#module_findings_label) | git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags | feature/BCSS-23189-add-new-modules-to-suppport-bcss | +| [this](#module_this) | git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags | feature/BCSS-23189-add-new-modules-to-suppport-bcss | ## Resources @@ -34,21 +37,47 @@ No modules. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| +| [additional_tag_map](#input_additional_tag_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. | `map(string)` | `{}` | no | +| [application_role](#input_application_role) | The role the application is performing | `string` | `"General"` | no | +| [attributes](#input_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, in the order they appear in the list. | `list(string)` | `[]` | no | +| [aws_region](#input_aws_region) | The AWS region | `string` | `"eu-west-2"` | no | | [cloudwatch_event_rule_pattern_detail_type](#input_cloudwatch_event_rule_pattern_detail_type) | The detail-type pattern used to match GuardDuty events for the CloudWatch rule. | `string` | `"GuardDuty Finding"` | no | +| [context](#input_context) | Single object for setting entire context at once. See description of individual variables for details. | `any` | see `context.tf` | no | +| [data_classification](#input_data_classification) | Used to identify the data classification of the resource, e.g 1-5 | `string` | `"n/a"` | no | +| [data_type](#input_data_type) | The tag data_type | `string` | `"None"` | no | +| [delimiter](#input_delimiter) | Delimiter to be used between ID elements. Defaults to `-` (hyphen). | `string` | `null` | no | +| [descriptor_formats](#input_descriptor_formats) | Describe additional descriptors to be output in the `descriptors` output map. | `any` | `{}` | no | | [eks_runtime_monitoring_enabled](#input_eks_runtime_monitoring_enabled) | Enable standalone EKS Runtime Monitoring (EKS_RUNTIME_MONITORING). Do not enable alongside runtime_monitoring_enabled. | `bool` | `false` | no | | [enable_cloudwatch](#input_enable_cloudwatch) | Create a CloudWatch (EventBridge) rule that forwards GuardDuty findings. The SNS topic itself is created by the separate alerting module. | `bool` | `true` | no | -| [enabled](#input_enabled) | Master switch for the GuardDuty detector. Set to false to disable the detector and all features. | `bool` | `true` | no | -| [environment](#input_environment) | The name of the Environment this is deployed into, for example CICD, NFT, UAT or PROD. | `string` | n/a | yes | +| [enabled](#input_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no | +| [environment](#input_environment) | ID element. Usually used to indicate role, e.g. 'prd', 'dev', 'test', 'preprod', 'prod', 'uat' | `string` | `null` | no | | [finding_publishing_frequency](#input_finding_publishing_frequency) | Frequency of finding notifications. Valid values: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. Only meaningful for standalone/master accounts. | `string` | `"FIFTEEN_MINUTES"` | no | | [findings_notification_arn](#input_findings_notification_arn) | ARN of an existing SNS topic that GuardDuty findings should be forwarded to. Leave null to skip target wiring. | `string` | `null` | no | +| [id_length_limit](#input_id_length_limit) | Limit `id` to this many characters (minimum 6). | `number` | `null` | no | | [kubernetes_audit_logs_enabled](#input_kubernetes_audit_logs_enabled) | Enable EKS audit log monitoring (EKS_AUDIT_LOGS). | `bool` | `false` | no | +| [label_key_case](#input_label_key_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module. | `string` | `null` | no | +| [label_order](#input_label_order) | The order in which the labels (ID elements) appear in the `id`. | `list(string)` | `null` | no | +| [label_value_case](#input_label_value_case) | Controls the letter case of ID elements (labels) as included in `id`, set as tag values, and output by this module individually. | `string` | `null` | no | +| [labels_as_tags](#input_labels_as_tags) | Set of labels (ID elements) to include as tags in the `tags` output. | `set(string)` | `["default"]` | no | | [lambda_network_logs_enabled](#input_lambda_network_logs_enabled) | Enable Lambda network log monitoring (LAMBDA_NETWORK_LOGS). | `bool` | `false` | no | | [malware_protection_scan_ec2_ebs_volumes_enabled](#input_malware_protection_scan_ec2_ebs_volumes_enabled) | Enable EBS Malware Protection scanning of EC2 instance volumes (EBS_MALWARE_PROTECTION). | `bool` | `true` | no | -| [name_prefix](#input_name_prefix) | Prefix used to name GuardDuty resources (e.g. account/environment identifier). | `string` | n/a | yes | +| [name](#input_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. | `string` | `null` | no | +| [on_off_pattern](#input_on_off_pattern) | Used to turn resources on and off based on a time pattern | `string` | `"n/a"` | no | +| [owner](#input_owner) | The name and or NHS.net email address of the service owner | `string` | `"None"` | no | +| [project](#input_project) | ID element. A project identifier, indicating the name or role of the project the resource is for. | `string` | `null` | no | +| [public_facing](#input_public_facing) | Whether this resource is public facing | `bool` | `false` | no | +| [regex_replace_chars](#input_regex_replace_chars) | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. | `string` | `null` | no | +| [region](#input_region) | ID element. Short region abbreviation e.g. 'uw2', 'ew2'. | `string` | `null` | no | | [runtime_monitoring_additional_config](#input_runtime_monitoring_additional_config) | Additional configuration for runtime monitoring agent management. | 
object({
    eks_addon_management_enabled         = optional(bool, false)
    ecs_fargate_agent_management_enabled = optional(bool, false)
    ec2_agent_management_enabled         = optional(bool, false)
  })
| `{}` | no | | [runtime_monitoring_enabled](#input_runtime_monitoring_enabled) | Enable Runtime Monitoring for EC2, ECS and EKS resources (RUNTIME_MONITORING). Mutually exclusive with eks_runtime_monitoring_enabled. | `bool` | `false` | no | | [s3_protection_enabled](#input_s3_protection_enabled) | Enable S3 Data Events Protection (S3_DATA_EVENTS). | `bool` | `true` | no | -| [tags](#input_tags) | Additional tags to apply to all resources created by this module. | `map(string)` | `{}` | no | +| [service](#input_service) | ID element. Service directorate abbreviation, e.g. 'bcss'. | `string` | `null` | no | +| [service_category](#input_service_category) | The tag service_category | `string` | `"n/a"` | no | +| [stack](#input_stack) | ID element. The name of the stack/component, e.g. `database`, `web`, `waf`, `eks`. | `string` | `null` | no | +| [tag_version](#input_tag_version) | Used to identify the tagging version in use | `string` | `"1.0"` | no | +| [tags](#input_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). | `map(string)` | `{}` | no | +| [tool](#input_tool) | The tool used to deploy the resource | `string` | `"Terraform"` | no | +| [workspace](#input_workspace) | ID element. The Terraform workspace, to help ensure generated IDs are unique across workspaces. | `string` | `null` | no | ## Outputs diff --git a/infrastructure/modules/guardduty/variables.tf b/infrastructure/modules/guardduty/variables.tf index 6535627..a7cdbb6 100644 --- a/infrastructure/modules/guardduty/variables.tf +++ b/infrastructure/modules/guardduty/variables.tf @@ -1,24 +1,11 @@ -variable "name_prefix" { - description = "Prefix used to name GuardDuty resources (e.g. account/environment identifier)." - type = string -} - -variable "environment" { - description = "The name of the Environment this is deployed into, for example CICD, NFT, UAT or PROD." - type = string -} - -variable "tags" { - description = "Additional tags to apply to all resources created by this module." - type = map(string) - default = {} -} - -variable "enabled" { - description = "Master switch for the GuardDuty detector. Set to false to disable the detector and all features." - type = bool - default = true -} +################################################################ +# GuardDuty-specific inputs. +# +# Naming, tagging and the master `enabled` switch come from +# `context.tf` via `module.this` — see that file for the full +# list of inherited inputs (service, project, environment, +# stack, name, owner, data_classification, tags, etc.). +################################################################ variable "finding_publishing_frequency" { description = "Frequency of finding notifications. Valid values: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. Only meaningful for standalone/master accounts." From b1a8c6e8085fcb49bcd06780cbd24040cb729b08 Mon Sep 17 00:00:00 2001 From: piravinth Date: Tue, 12 May 2026 09:14:32 +0100 Subject: [PATCH 3/4] file fmt --- infrastructure/modules/guardduty/context.tf | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/infrastructure/modules/guardduty/context.tf b/infrastructure/modules/guardduty/context.tf index 018aaaa..5eb0bc6 100644 --- a/infrastructure/modules/guardduty/context.tf +++ b/infrastructure/modules/guardduty/context.tf @@ -32,7 +32,7 @@ module "this" { name = var.name delimiter = var.delimiter attributes = var.attributes - tags = var.tags + tags = var.tags additional_tag_map = var.additional_tag_map label_order = var.label_order regex_replace_chars = var.regex_replace_chars @@ -284,8 +284,8 @@ variable "descriptor_formats" { Describe additional descriptors to be output in the `descriptors` output map. Map of maps. Keys are names of descriptors. Values are maps of the form `{ - format = string - labels = list(string) + format = string + labels = list(string) }` (Type is `any` so the map values can later be enhanced to provide additional options.) `format` is a Terraform format string to be passed to the `format()` function. @@ -362,4 +362,4 @@ variable "tool" { default = "Terraform" } -#### End of copy of screening-terraform-modules-aws/tags/variables.tf \ No newline at end of file +#### End of copy of screening-terraform-modules-aws/tags/variables.tf From b3fd33a3c0946ed6027e809e3192f2ceae0062a6 Mon Sep 17 00:00:00 2001 From: piravinth Date: Tue, 12 May 2026 09:15:52 +0100 Subject: [PATCH 4/4] MD fmt --- infrastructure/modules/guardduty/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/infrastructure/modules/guardduty/readme.md b/infrastructure/modules/guardduty/readme.md index be222f1..572455d 100644 --- a/infrastructure/modules/guardduty/readme.md +++ b/infrastructure/modules/guardduty/readme.md @@ -16,8 +16,8 @@ No requirements. | Name | Source | Version | |------|--------|---------| -| [findings_label](#module_findings_label) | git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags | feature/BCSS-23189-add-new-modules-to-suppport-bcss | -| [this](#module_this) | git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags | feature/BCSS-23189-add-new-modules-to-suppport-bcss | +| [findings_label](#module_findings_label) | `git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags` | feature/BCSS-23189-add-new-modules-to-suppport-bcss | +| [this](#module_this) | `git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags` | feature/BCSS-23189-add-new-modules-to-suppport-bcss | ## Resources