Back to Checks
Missing description for security group rule.
AWS-0124
Service: ec2Severity: low
OfficialBuilt-inVerified
Security group rules should include a description for auditing purposes.
Simplifies auditing, debugging, and managing security groups.
Run this check with Prowler
Run in Prowler CloudRun
prowler iac --checks AWS-0124Recommendation
Add descriptions for all security groups rules
Check Code
# METADATA
# title: Missing description for security group rule.
# description: |
# Security group rules should include a description for auditing purposes.
#
# Simplifies auditing, debugging, and managing security groups.
# scope: package
# schemas:
# - input: schema["cloud"]
# related_resources:
# - https://www.cloudconformity.com/knowledge-base/aws/EC2/security-group-rules-description.html
# custom:
# id: AWS-0124
# long_id: aws-ec2-add-description-to-security-group-rule
# aliases:
# - AVD-AWS-0124
# - add-description-to-security-group-rule
# - aws-ec2-add-description-to-security-group-rule
# - aws-vpc-add-description-to-security-group-rule
# provider: aws
# service: ec2
# severity: LOW
# recommended_action: Add descriptions for all security groups rules
# input:
# selector:
# - type: cloud
# subtypes:
# - service: ec2
# provider: aws
# examples: checks/cloud/aws/ec2/add_description_to_security_group_rule.yaml
package builtin.aws.ec2.aws0124
import rego.v1
import data.lib.cloud.metadata
import data.lib.cloud.value
rules := [
rule |
some group in input.aws.ec2.securitygroups
some rule in array.concat(
object.get(group, "egressrules", []),
object.get(group, "ingressrules", []),
)
]
deny contains res if {
some rule in rules
isManaged(rule)
without_description(rule)
res := result.new(
"Security group rule does not have a description.",
metadata.obj_by_path(rule, ["description"]),
)
}
deny contains res if {
some rule in rules
isManaged(rule)
rule.description.value == "Managed by Terraform"
res := result.new(
"Security group explicitly uses the default description.",
rule.description,
)
}
without_description(rule) if value.is_empty(rule.description)
without_description(rule) if not rule.description