github.com/khulnasoft-lab/defsec@v1.0.5-0.20230827010352-5e9f46893d95/rules/cloud/policies/google/sql/enable_backup.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/scan"
     7  	"github.com/khulnasoft-lab/defsec/pkg/severity"
     8  	"github.com/khulnasoft-lab/defsec/pkg/state"
     9  )
    10  
    11  var CheckEnableBackup = rules.Register(
    12  	scan.Rule{
    13  		AVDID:       "AVD-GCP-0024",
    14  		Provider:    providers.GoogleProvider,
    15  		Service:     "sql",
    16  		ShortCode:   "enable-backup",
    17  		Summary:     "Enable automated backups to recover from data-loss",
    18  		Impact:      "No recovery of lost or corrupted data",
    19  		Resolution:  "Enable automated backups",
    20  		Explanation: `Automated backups are not enabled by default. Backups are an easy way to restore data in a corruption or data-loss scenario.`,
    21  		Links: []string{
    22  			"https://cloud.google.com/sql/docs/mysql/backup-recovery/backups",
    23  		},
    24  		Terraform: &scan.EngineMetadata{
    25  			GoodExamples:        terraformEnableBackupGoodExamples,
    26  			BadExamples:         terraformEnableBackupBadExamples,
    27  			Links:               terraformEnableBackupLinks,
    28  			RemediationMarkdown: terraformEnableBackupRemediationMarkdown,
    29  		},
    30  		Severity: severity.Medium,
    31  	},
    32  	func(s *state.State) (results scan.Results) {
    33  		for _, instance := range s.Google.SQL.Instances {
    34  			if instance.Metadata.IsUnmanaged() || instance.IsReplica.IsTrue() {
    35  				continue
    36  			}
    37  			if instance.Settings.Backups.Enabled.IsFalse() {
    38  				results.Add(
    39  					"Database instance does not have backups enabled.",
    40  					instance.Settings.Backups.Enabled,
    41  				)
    42  			} else {
    43  				results.AddPassed(&instance)
    44  			}
    45  
    46  		}
    47  		return
    48  	},
    49  )