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

     1  package ec2
     2  
     3  import (
     4  	"fmt"
     5  
     6  	"github.com/khulnasoft-lab/defsec/pkg/severity"
     7  
     8  	"github.com/khulnasoft-lab/defsec/pkg/state"
     9  
    10  	"github.com/khulnasoft-lab/defsec/pkg/scan"
    11  
    12  	"github.com/khulnasoft-lab/defsec/internal/rules"
    13  
    14  	"github.com/khulnasoft-lab/defsec/pkg/providers"
    15  )
    16  
    17  var CheckNoSecretsInUserData = rules.Register(
    18  	scan.Rule{
    19  		AVDID:       "AVD-AWS-0029",
    20  		Provider:    providers.AWSProvider,
    21  		Service:     "ec2",
    22  		ShortCode:   "no-secrets-in-user-data",
    23  		Summary:     "User data for EC2 instances must not contain sensitive AWS keys",
    24  		Impact:      "User data is visible through the AWS Management console",
    25  		Resolution:  "Remove sensitive data from the EC2 instance user-data",
    26  		Explanation: `EC2 instance data is used to pass start up information into the EC2 instance. This userdata must not contain access key credentials. Instead use an IAM Instance Profile assigned to the instance to grant access to other AWS Services.`,
    27  		Links: []string{
    28  			"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html",
    29  		},
    30  		Terraform: &scan.EngineMetadata{
    31  			GoodExamples:        terraformNoSecretsInUserDataGoodExamples,
    32  			BadExamples:         terraformNoSecretsInUserDataBadExamples,
    33  			Links:               terraformNoSecretsInUserDataLinks,
    34  			RemediationMarkdown: terraformNoSecretsInUserDataRemediationMarkdown,
    35  		},
    36  		CloudFormation: &scan.EngineMetadata{
    37  			GoodExamples:        cloudFormationNoSecretsInUserDataGoodExamples,
    38  			BadExamples:         cloudFormationNoSecretsInUserDataBadExamples,
    39  			Links:               cloudFormationNoSecretsInUserDataLinks,
    40  			RemediationMarkdown: cloudFormationNoSecretsInUserDataRemediationMarkdown,
    41  		},
    42  		Severity: severity.Critical,
    43  	},
    44  	func(s *state.State) (results scan.Results) {
    45  		for _, instance := range s.AWS.EC2.Instances {
    46  			if instance.Metadata.IsUnmanaged() {
    47  				continue
    48  			}
    49  			if result := scanner.Scan(instance.UserData.Value()); result.TransgressionFound {
    50  				results.Add(
    51  					fmt.Sprintf("Sensitive data found in instance user data: %s", result.Description),
    52  					instance.UserData,
    53  				)
    54  			} else {
    55  				results.AddPassed(&instance)
    56  			}
    57  		}
    58  		return
    59  	},
    60  )