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

     1  package apigateway
     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 CheckEnableTracing = rules.Register(
    12  	scan.Rule{
    13  		AVDID:       "AVD-AWS-0003",
    14  		Provider:    providers.AWSProvider,
    15  		Service:     "api-gateway",
    16  		ShortCode:   "enable-tracing",
    17  		Summary:     "API Gateway 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 API Gateway HTTP requests.`,
    21  		Links:       []string{},
    22  		Terraform: &scan.EngineMetadata{
    23  			GoodExamples:        terraformEnableTracingGoodExamples,
    24  			BadExamples:         terraformEnableTracingBadExamples,
    25  			Links:               terraformEnableTracingLinks,
    26  			RemediationMarkdown: terraformEnableTracingRemediationMarkdown,
    27  		},
    28  		Severity: severity.Low,
    29  	},
    30  	func(s *state.State) (results scan.Results) {
    31  		for _, api := range s.AWS.APIGateway.V1.APIs {
    32  			if api.Metadata.IsUnmanaged() {
    33  				continue
    34  			}
    35  			for _, stage := range api.Stages {
    36  				if stage.Metadata.IsUnmanaged() {
    37  					continue
    38  				}
    39  				if stage.XRayTracingEnabled.IsFalse() {
    40  					results.Add(
    41  						"X-Ray tracing is not enabled,",
    42  						stage.XRayTracingEnabled,
    43  					)
    44  				} else {
    45  					results.AddPassed(&stage)
    46  				}
    47  			}
    48  		}
    49  		return
    50  	},
    51  )