Module: security-hub

Terraform module to deploy AWS Security Hub.

Introduction

This module enables AWS Security Hub in one region of one account and optionally sets up an SNS topic to receive notifications of its findings.

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

Here's how to invoke this module in your projects:

module "securityhub" {
  source = "cloudposse/security-hub/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  create_sns_topic = true
  subscribers = {
    opsgenie = {
      protocol               = "https"
      endpoint               = "https://api.example.com/v1/"
      endpoint_auto_confirms = true
      raw_message_delivery   = false
    }
  }
}

Examples

Here is an example of using this module:

• examples/complete - complete example of using this module

Requirements

Name	Version
terraform	>= 1.0
aws	>= 2

Providers

Name	Version
aws	>= 2

Modules

Name	Source	Version
imported_findings_label	cloudposse/label/null	0.25.0
sns_kms_key	cloudposse/kms-key/aws	0.12.2
sns_kms_key_label	cloudposse/label/null	0.25.0
sns_topic	cloudposse/sns-topic/aws	0.21.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_cloudwatch_event_rule.imported_findings	resource
aws_cloudwatch_event_target.imported_findings	resource
aws_securityhub_account.this	resource
aws_securityhub_finding_aggregator.this	resource
aws_securityhub_standards_subscription.this	resource
aws_caller_identity.this	data source
aws_iam_policy_document.sns_kms_key_policy	data source
aws_partition.this	data source
aws_region.this	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	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.	map(string)	{}	no
attributes	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.	list(string)	[]	no
cloudwatch_event_rule_pattern_detail_type	The detail-type pattern used to match events that will be sent to SNS. For more information, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html	string	"Security Hub Findings - Imported"	no
context	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.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
create_sns_topic	Flag to indicate whether an SNS topic should be created for notifications If you want to send findings to a new SNS topic, set this to true and provide a valid configuration for subscribers	bool	false	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
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 {<br/> format = string<br/> labels = list(string)<br/>} (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).	any	{}	no
enable_default_standards	Flag to indicate whether default standards should be enabled	bool	true	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
enabled_standards	A list of standards/rulesets to enable See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/securityhub_standards_subscription#argument-reference The possible values are: - standards/aws-foundational-security-best-practices/v/1.0.0 - ruleset/cis-aws-foundations-benchmark/v/1.2.0 - standards/pci-dss/v/3.2.1	list(any)	[]	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
finding_aggregator_enabled	Flag to indicate whether a finding aggregator should be created If you want to aggregate findings from one region, set this to true. For more information, see: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/securityhub_finding_aggregator	bool	false	no
finding_aggregator_linking_mode	Linking mode to use for the finding aggregator. The possible values are: - ALL_REGIONS - Aggregate from all regions - ALL_REGIONS_EXCEPT_SPECIFIED - Aggregate from all regions except those specified in var.finding_aggregator_regions - SPECIFIED_REGIONS - Aggregate from regions specified in finding_aggregator_enabled	string	"ALL_REGIONS"	no
finding_aggregator_regions	A list of regions to aggregate findings from. This is only used if finding_aggregator_enabled is true.	list(string)	[]	no
id_length_limit	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.	number	null	no
imported_findings_notification_arn	The ARN for an SNS topic to send findings notifications to. This is only used if create_sns_topic is false. If you want to send findings to an existing SNS topic, set the value of this to the ARN of the existing topic and set create_sns_topic to false.	string	null	no
label_key_case	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.	string	null	no
label_order	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.	list(string)	null	no
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. 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.	string	null	no
labels_as_tags	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.	set(string)	[ "default" ]	no
name	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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
regex_replace_chars	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.	string	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
subscribers	Required configuration for subscibres to SNS topic.	map(object({ protocol = string # The protocol to use. The possible values for this are: sqs, sms, lambda, application. (http or https are partially supported, see below) (email is an option but is unsupported, see below). endpoint = string # The endpoint to send data to, the contents will vary with the protocol. (see below for more information) endpoint_auto_confirms = bool # Boolean indicating whether the end point is capable of auto confirming subscription e.g., PagerDuty (default is false) raw_message_delivery = bool # Boolean indicating whether or not to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property) (default is false) }))	{}	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no

Outputs

Name	Description
enabled_subscriptions	A list of subscriptions that have been enabled
sns_topic	The SNS topic that was created
sns_topic_subscriptions	The SNS topic that was created