Skip to content

New Feature: Support for Custom Response Bodies #120

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

New Feature: Support for Custom Response Bodies #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4f0cb7
add an option to add custom response when using block action
xgt001 Jul 4, 2023
e4ba571
add missing custom_response_body
xgt001 Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions examples/alb/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ module "wafv2" {
scope = "REGIONAL"
associate_alb = true
alb_arn = aws_lb.alb.arn

#enable custom response code
custom_block_response_content = {
"test-key" = "Your request has been blocked. Please contact the system administrators"
}
enable_custom_block_response = true

managed_rules = [
{ "name" : "AWSManagedRulesAmazonIpReputationList", "override_action" : "none", "priority" : 1, "vendor_name" : "AWS", "rule_action_override" : [] },
{ "name" : "AWSManagedRulesCommonRuleSet", "override_action" : "none", "priority" : 2, "vendor_name" : "AWS", "rule_action_override" : [{ "name" = "SizeRestrictions_BODY", "action_to_use" = "allow" }] },
Expand All @@ -50,10 +57,14 @@ module "wafv2" {
ip_set_arn = aws_wafv2_ip_set.ipset.arn
},
{
name = "block-all-ips"
priority = 6
action = var.enable_block_all_ips ? "block" : "count"
ip_set_arn = aws_wafv2_ip_set.block_all_ips.arn
name = "block-all-ips"
priority = 6
action = var.enable_block_all_ips ? "block" : "count"
ip_set_arn = aws_wafv2_ip_set.block_all_ips.arn
enable_block_custom_response = true
response_code = 403
block_custom_response_content_key = "test-key"
enable_block_custom_headers = false
}
]

Expand Down
48 changes: 42 additions & 6 deletions main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,18 @@ resource "aws_wafv2_web_acl" "main" {
for_each = rule.value.action == "block" ? [1] : []
content {
dynamic "custom_response" {
for_each = rule.value.response_code != 403 ? [1] : []
for_each = rule.value.enable_block_custom_response == true ? [1] : []
content {
response_code = rule.value.response_code
custom_response_body_key = rule.value.block_custom_response_content_key
response_code = rule.value.response_code

dynamic "response_header" {
for_each = rule.value.enable_block_custom_headers == true ? [1] : []
content {
name = rule.value.response_header_name
value = rule.value.response_header_value
}
}
}
}
}
Expand All @@ -119,6 +128,15 @@ resource "aws_wafv2_web_acl" "main" {
}
}

dynamic "custom_response_body" {
for_each = var.enable_custom_block_response == true ? [1] : []
content {
content = values(var.custom_block_response_content)[0]
content_type = "TEXT_PLAIN"
key = keys(var.custom_block_response_content)[0]
}
}

dynamic "rule" {
for_each = var.ip_rate_based_rule != null ? [var.ip_rate_based_rule] : []
content {
Expand All @@ -135,9 +153,18 @@ resource "aws_wafv2_web_acl" "main" {
for_each = rule.value.action == "block" ? [1] : []
content {
dynamic "custom_response" {
for_each = rule.value.response_code != 403 ? [1] : []
for_each = rule.value.enable_block_custom_response == true ? [1] : []
content {
response_code = rule.value.response_code
custom_response_body_key = rule.value.block_custom_response_content_key
response_code = rule.value.response_code

dynamic "response_header" {
for_each = rule.value.enable_block_custom_headers == true ? [1] : []
content {
name = rule.value.response_header_name
value = rule.value.response_header_value
}
}
}
}
}
Expand Down Expand Up @@ -180,9 +207,18 @@ resource "aws_wafv2_web_acl" "main" {
for_each = rule.value.action == "block" ? [1] : []
content {
dynamic "custom_response" {
for_each = rule.value.response_code != 403 ? [1] : []
for_each = rule.value.enable_block_custom_response == true ? [1] : []
content {
response_code = rule.value.response_code
custom_response_body_key = rule.value.block_custom_response_content_key
response_code = rule.value.response_code

dynamic "response_header" {
for_each = rule.value.enable_block_custom_headers == true ? [1] : []
content {
name = rule.value.response_header_name
value = rule.value.response_header_value
}
}
}
}
}
Expand Down
57 changes: 40 additions & 17 deletions variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,37 +69,46 @@ variable "managed_rules" {

variable "ip_sets_rule" {
type = list(object({
name = string
priority = number
ip_set_arn = string
action = string
response_code = optional(number, 403)
name = string
priority = number
ip_set_arn = string
action = string
response_code = optional(number, 403)
enable_block_custom_response = optional(bool, false)
enable_block_custom_headers = optional(bool, false)
block_custom_response_content_key = optional(string)
}))
description = "A rule to detect web requests coming from particular IP addresses or address ranges."
default = []
}

variable "ip_rate_based_rule" {
type = object({
name = string
priority = number
limit = number
action = string
response_code = optional(number, 403)
name = string
priority = number
limit = number
action = string
response_code = optional(number, 403)
enable_block_custom_response = optional(bool, false)
enable_block_custom_headers = optional(bool, false)
block_custom_response_content_key = optional(string)
})
description = "A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span"
default = null
}

variable "ip_rate_url_based_rules" {
type = list(object({
name = string
priority = number
limit = number
action = string
response_code = optional(number, 403)
search_string = string
positional_constraint = string
name = string
priority = number
limit = number
action = string
response_code = optional(number, 403)
search_string = string
positional_constraint = string
enable_block_custom_response = optional(bool, false)
enable_block_custom_headers = optional(bool, false)
block_custom_response_content_key = optional(string)
}))
description = "A rate and url based rules tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span"
default = []
Expand Down Expand Up @@ -169,3 +178,17 @@ variable "default_action" {
description = "The action to perform if none of the rules contained in the WebACL match."
default = "allow"
}

variable "enable_custom_block_response" {
type = bool
description = "This enables custom responses for the block requests"
default = false
}

variable "custom_block_response_content" {
type = map(string)
description = "This enables custom responses for the block requests"
default = {
"custom-block-response-key" = "This is the response the client will see when they are blocked by WAF"
}
}