github.com/khulnasoft-lab/defsec@v1.0.5-0.20230827010352-5e9f46893d95/rules/cloud/policies/google/sql/pg_log_disconnections.go (about)

     1  package sql
     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/providers/google/sql"
     7  	"github.com/khulnasoft-lab/defsec/pkg/scan"
     8  	"github.com/khulnasoft-lab/defsec/pkg/severity"
     9  	"github.com/khulnasoft-lab/defsec/pkg/state"
    10  )
    11  
    12  var CheckPgLogDisconnections = rules.Register(
    13  	scan.Rule{
    14  		AVDID:       "AVD-GCP-0022",
    15  		Provider:    providers.GoogleProvider,
    16  		Service:     "sql",
    17  		ShortCode:   "pg-log-disconnections",
    18  		Summary:     "Ensure that logging of disconnections is enabled.",
    19  		Impact:      "Insufficient diagnostic data.",
    20  		Resolution:  "Enable disconnection logging.",
    21  		Explanation: `Logging disconnections provides useful diagnostic data such as session length, which can identify performance issues in an application and potential DoS vectors.`,
    22  		Links: []string{
    23  			"https://www.postgresql.org/docs/13/runtime-config-logging.html#GUC-LOG-DISCONNECTIONS",
    24  		},
    25  		Terraform: &scan.EngineMetadata{
    26  			GoodExamples:        terraformPgLogDisconnectionsGoodExamples,
    27  			BadExamples:         terraformPgLogDisconnectionsBadExamples,
    28  			Links:               terraformPgLogDisconnectionsLinks,
    29  			RemediationMarkdown: terraformPgLogDisconnectionsRemediationMarkdown,
    30  		},
    31  		Severity: severity.Medium,
    32  	},
    33  	func(s *state.State) (results scan.Results) {
    34  		for _, instance := range s.Google.SQL.Instances {
    35  			if instance.Metadata.IsUnmanaged() {
    36  				continue
    37  			}
    38  			if instance.DatabaseFamily() != sql.DatabaseFamilyPostgres {
    39  				continue
    40  			}
    41  			if instance.Settings.Flags.LogDisconnections.IsFalse() {
    42  				results.Add(
    43  					"Database instance is not configured to log disconnections.",
    44  					instance.Settings.Flags.LogDisconnections,
    45  				)
    46  			} else {
    47  				results.AddPassed(&instance)
    48  			}
    49  
    50  		}
    51  		return
    52  	},
    53  )