/terraform-aws-firewall-manager

Terraform module to configure AWS Firewall Manager

Primary LanguageHCLApache License 2.0Apache-2.0

terraform-aws-firewall-manager Latest Release Slack Community Discourse Forum

README Header

Cloud Posse

Terraform module to create and manage AWS Firewall Manager policies.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

Terraform Open Source Modules

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Security & Compliance

Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.

Benchmark Description
Infrastructure Security Infrastructure Security Compliance
CIS KUBERNETES Center for Internet Security, KUBERNETES Compliance
CIS AWS Center for Internet Security, AWS Compliance
CIS AZURE Center for Internet Security, AZURE Compliance
PCI-DSS Payment Card Industry Data Security Standards Compliance
NIST-800-53 National Institute of Standards and Technology Compliance
ISO27001 Information Security Management System, ISO/IEC 27001 Compliance
SOC2 Service Organization Control 2 Compliance
CIS GCP Center for Internet Security, GCP Compliance
HIPAA Health Insurance Portability and Accountability Compliance

Usage

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

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.

  module "label" {
    source = "cloudposse/label/null"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    namespace = "eg"
    stage     = "prod"
    name      = "fms"
    delimiter = "-"

    tags = {
      "BusinessUnit" = "XYZ",
    }
  }

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

    cidr_block = "10.0.0.0/16"

    context = module.label.context
  }

  module "fms" {
    source = "cloudposse/firewall-manager/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    security_groups_usage_audit_policies = [
      {
        name               = "unused-sg"
        resource_type_list = ["AWS::EC2::SecurityGroup"]

        policy_data = {
          delete_unused_security_groups      = false
          coalesce_redundant_security_groups = false
        }
      }
    ]

    security_groups_content_audit_policies = [
      {
        name               = "maxmimum-allowed"
        resource_type_list = ["AWS::EC2::SecurityGroup"]

        policy_data = {
          security_group_action = "allow"
          security_groups       = [module.vpc.security_group_id]
        }
      }
    ]

    security_groups_common_policies = [
      {
        name               = "disabled-all"
        resource_type_list = ["AWS::EC2::SecurityGroup"]

        policy_data = {
          revert_manual_security_group_changes         = false
          exclusive_resource_security_group_management = false
          apply_to_all_ec2_instance_enis               = false
          security_groups                              = [module.vpc.security_group_id]
        }
      }
    ]

    waf_v2_policies = [
      {
        name               = "linux-policy"
        resource_type_list = ["AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ApiGateway::Stage"]

        policy_data = {
          default_action                        = "allow"
          override_customer_web_acl_association = false
          pre_process_rule_groups = [
            {
              "managedRuleGroupIdentifier" : {
                "vendorName" : "AWS",
                "managedRuleGroupName" : "AWSManagedRulesLinuxRuleSet",
                "version" : null
              },
              "overrideAction" : { "type" : "NONE" },
              "ruleGroupArn" : null,
              "excludeRules" : [],
              "ruleGroupType" : "ManagedRuleGroup"
            }
          ]
        }
      }
    ]

    context = module.label.context
  }

Examples

Here is an example of using this module:

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name Version
terraform >= 0.15.0
aws >= 2.0

Providers

Name Version
aws >= 2.0
aws.admin >= 2.0

Modules

Name Source Version
dns_firewall_label cloudposse/label/null 0.24.1
firehose_label cloudposse/label/null 0.24.1
firehose_s3_bucket cloudposse/s3-bucket/aws 0.38.0
network_firewall_label cloudposse/label/null 0.24.1
security_groups_common_label cloudposse/label/null 0.24.1
security_groups_content_audit_label cloudposse/label/null 0.24.1
security_groups_usage_audit_label cloudposse/label/null 0.24.1
shiled_advanced_label cloudposse/label/null 0.24.1
this cloudposse/label/null 0.24.1
waf_label cloudposse/label/null 0.24.1
waf_v2_label cloudposse/label/null 0.24.1

Resources

Name Type
aws_fms_admin_account.default resource
aws_fms_policy.dns_firewall resource
aws_fms_policy.network_firewall resource
aws_fms_policy.security_groups_common resource
aws_fms_policy.security_groups_content_audit resource
aws_fms_policy.security_groups_usage_audit resource
aws_fms_policy.shiled_advanced resource
aws_fms_policy.waf resource
aws_fms_policy.waf_v2 resource
aws_iam_role.firehose_role resource
aws_kinesis_firehose_delivery_stream.firehose_stream resource
aws_iam_policy_document.assume_role data source

Inputs

Name Description Type Default Required
additional_tag_map Additional tags for appending to tags_as_list_of_maps. Not added to tags. map(string) {} no
admin_account_enabled Resource for aws_fms_admin_account is enabled and will be created or destroyed bool true no
admin_account_id The AWS account ID to associate to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. Defaults to the current account. string null no
attributes Additional attributes (e.g. 1) list(string) [] 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,
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {}
}
 no
delimiter Delimiter to be used between namespace, environment, stage, name and attributes.
Defaults to - (hyphen). Set to "" to use no delimiter at all.		 string null no
dns_firewall_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
pre_process_rule_groups:
A list of maps of pre-proccess rule groups in the format { "ruleGroupId": "rslvr-frg-1", "priority": 10 }.
post_process_rule_groups:
A list of maps post-proccess rule groups in the format { "ruleGroupId": "rslvr-frg-1", "priority": 10 }.		 list(any) [] no
enabled Set to false to prevent the module from creating any resources bool null no
environment Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' string null no
firehose_arn Kinesis Firehose ARN used to create a Kinesis Firehose destination for WAF_V2 Rules. Conflicts with firehose_enabled string null no
firehose_enabled Create a Kinesis Firehose destination for WAF_V2 Rules. Conflicts with firehose_arn bool false no
id_length_limit Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for default, which is 0.
Does not affect id_full.		 number null no
label_key_case The letter case of label keys (tag names) (i.e. name, namespace, environment, stage, attributes) to use in tags.
Possible values: lower, title, upper.
Default value: title.		 string null no
label_order The naming order of the id output and Name tag.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 5 elements, but at least one must be present.		 list(string) null no
label_value_case The letter case of output label values (also used in tags and id).
Possible values: lower, title, upper and none (no transformation).
Default value: lower.		 string null no
name Solution name, e.g. 'app' or 'jenkins' string null no
namespace Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' string null no
network_firewall_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
stateless_rule_group_references:
A list of maps of configuration blocks containing references to the stateful rule groups that are used in the policy.
Format: { "resourceARN": "arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2", "priority": 10 }
stateless_default_actions:
A list of actions to take on a packet if it does not match any of the stateless rules in the policy.
You must specify one of the standard actions including: aws:drop, aws:pass, or aws:forward_to_sfe.
In addition, you can specify custom actions that are compatible with your standard action choice.
If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
stateless_fragment_default_actions:
A list of actions to take on a fragmented packet if it does not match any of the stateless rules in the policy.
You must specify one of the standard actions including: aws:drop, aws:pass, or aws:forward_to_sfe.
In addition, you can specify custom actions that are compatible with your standard action choice.
If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
stateless_custom_actions:
A list of maps describing the custom action definitions that are available for use in the firewall policy's stateless_default_actions.
Format: { "actionName": "custom1", "actionDefinition": { "publishMetricAction": { "dimensions": [ { "value": "dimension1" } ] } } }
stateful_rule_group_references_arns:
A list of ARNs of the stateful rule groups.
orchestration_config:
single_firewall_endpoint_per_vpc:
Whether to use single Firewall Endpoint per VPC.
Defaults to false.
allowed_ipv4_cidrs:
A list of allowed ipv4 cidrs.		 list(any) [] no
regex_replace_chars Regex to replace chars with empty string in namespace, environment, stage and name.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.		 string null no
security_groups_common_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
revert_manual_security_group_changes:
Whether to revert manual Security Group changes.
Defaults to false.
exclusive_resource_security_group_management:
Wheter to exclusive resource Security Group management.
Defaults to false.
apply_to_all_ec2_instance_enis:
Whether to apply to all EC2 instance ENIs.
Defaults to false.
security_groups:
A list of Security Group IDs.		 list(any) [] no
security_groups_content_audit_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
security_group_action:
For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules.
For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
Possible values: ALLOW, DENY.
security_groups:
A list of Security Group IDs.		 list(any) [] no
security_groups_usage_audit_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
delete_unused_security_groups:
Whether to delete unused Security Groups.
Defaults to false.
coalesce_redundant_security_groups:
Whether to coalesce redundant Security Groups.
Defaults to false.		 list(any) n/a yes
shiled_advanced_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.		 list(any) [] no
stage Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' string null no
tags Additional tags (e.g. map('BusinessUnit','XYZ') map(string) {} no
waf_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
default_action:
The action that you want AWS WAF to take.
Possible values: ALLOW, BLOCK or COUNT.
rule_groups:
A list of rule groups.		 list(any) [] no
waf_v2_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
default_action:
The action that you want AWS WAF to take.
Possible values: ALLOW, BLOCK or COUNT.
override_customer_web_acl_association:
Wheter to override customer Web ACL association
logging_configuration:
The WAFv2 Web ACL logging configuration.
pre_process_rule_groups:
A list of pre-proccess rule groups.
post_process_rule_groups:
A list of post-proccess rule groups.		 list(any) [] no

Outputs

Name Description
admin_account n/a

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

  • terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.

References

For additional context, refer to some of these links.

  • Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
  • Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
  • Terraform random_integer Resource - The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource.
  • Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

README Commercial Support

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Learn More

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
  • Site Reliability Engineering. You'll have total visibility into your apps and microservices.
  • Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
  • GitOps. You'll be able to operate your infrastructure via Pull Requests.
  • Training. You'll receive hands-on training so your team can operate what we build.
  • Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
  • Troubleshooting. You'll get help to triage when things aren't working.
  • Code Reviews. You'll receive constructive feedback on Pull Requests.
  • Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

zoom

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyrights

Copyright © 2021-2021 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Vladimir Syromyatnikov
Vladimir Syromyatnikov

README Footer Beacon