github.com/khulnasoft-lab/defsec@v1.0.5-0.20230827010352-5e9f46893d95/rules/cloud/policies/aws/elasticache/add_description_for_security_group.go (about)

     1  package elasticache
     2  
     3  import (
     4  	"github.com/khulnasoft-lab/defsec/internal/rules"
     5  	"github.com/khulnasoft-lab/defsec/pkg/providers"
     6  	"github.com/khulnasoft-lab/defsec/pkg/scan"
     7  	"github.com/khulnasoft-lab/defsec/pkg/severity"
     8  	"github.com/khulnasoft-lab/defsec/pkg/state"
     9  )
    10  
    11  var CheckAddDescriptionForSecurityGroup = rules.Register(
    12  	scan.Rule{
    13  		AVDID:      "AVD-AWS-0049",
    14  		Provider:   providers.AWSProvider,
    15  		Service:    "elasticache",
    16  		ShortCode:  "add-description-for-security-group",
    17  		Summary:    "Missing description for security group/security group rule.",
    18  		Impact:     "Descriptions provide context for the firewall rule reasons",
    19  		Resolution: "Add descriptions for all security groups and rules",
    20  		Explanation: `Security groups and security group rules should include a description for auditing purposes.
    21  
    22  Simplifies auditing, debugging, and managing security groups.`,
    23  		Links: []string{
    24  			"https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/SecurityGroups.Creating.html",
    25  		},
    26  		Terraform: &scan.EngineMetadata{
    27  			GoodExamples:        terraformAddDescriptionForSecurityGroupGoodExamples,
    28  			BadExamples:         terraformAddDescriptionForSecurityGroupBadExamples,
    29  			Links:               terraformAddDescriptionForSecurityGroupLinks,
    30  			RemediationMarkdown: terraformAddDescriptionForSecurityGroupRemediationMarkdown,
    31  		},
    32  		CloudFormation: &scan.EngineMetadata{
    33  			GoodExamples:        cloudFormationAddDescriptionForSecurityGroupGoodExamples,
    34  			BadExamples:         cloudFormationAddDescriptionForSecurityGroupBadExamples,
    35  			Links:               cloudFormationAddDescriptionForSecurityGroupLinks,
    36  			RemediationMarkdown: cloudFormationAddDescriptionForSecurityGroupRemediationMarkdown,
    37  		},
    38  		Severity: severity.Low,
    39  	},
    40  	func(s *state.State) (results scan.Results) {
    41  		for _, sg := range s.AWS.ElastiCache.SecurityGroups {
    42  			if sg.Description.IsEmpty() {
    43  				results.Add(
    44  					"Security group does not have a description.",
    45  					sg.Description,
    46  				)
    47  			} else {
    48  				results.AddPassed(&sg)
    49  			}
    50  		}
    51  		return
    52  	},
    53  )