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

     1  package sam
     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 CheckEnableStateMachineTracing = rules.Register(
    12  	scan.Rule{
    13  		AVDID:       "AVD-AWS-0117",
    14  		Provider:    providers.AWSProvider,
    15  		Service:     "sam",
    16  		ShortCode:   "enable-state-machine-tracing",
    17  		Summary:     "SAM State machine must have X-Ray tracing enabled",
    18  		Impact:      "Without full tracing enabled it is difficult to trace the flow of logs",
    19  		Resolution:  "Enable tracing",
    20  		Explanation: `X-Ray tracing enables end-to-end debugging and analysis of all state machine activities.`,
    21  		Links: []string{
    22  			"https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html#sam-statemachine-tracing",
    23  		},
    24  		CloudFormation: &scan.EngineMetadata{
    25  			GoodExamples:        cloudFormationEnableStateMachineTracingGoodExamples,
    26  			BadExamples:         cloudFormationEnableStateMachineTracingBadExamples,
    27  			Links:               cloudFormationEnableStateMachineTracingLinks,
    28  			RemediationMarkdown: cloudFormationEnableStateMachineTracingRemediationMarkdown,
    29  		},
    30  		Severity: severity.Low,
    31  	},
    32  	func(s *state.State) (results scan.Results) {
    33  		for _, stateMachine := range s.AWS.SAM.StateMachines {
    34  			if stateMachine.Metadata.IsUnmanaged() {
    35  				continue
    36  			}
    37  
    38  			if stateMachine.Tracing.Enabled.IsFalse() {
    39  				results.Add(
    40  					"X-Ray tracing is not enabled,",
    41  					stateMachine.Tracing.Enabled,
    42  				)
    43  			} else {
    44  				results.AddPassed(&stateMachine)
    45  			}
    46  		}
    47  		return
    48  	},
    49  )