-
Notifications
You must be signed in to change notification settings - Fork 117
/
rule.go
executable file
·142 lines (124 loc) · 2.99 KB
/
rule.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
package scan
import (
"fmt"
"regexp"
"strings"
"golang.org/x/text/language"
"golang.org/x/text/cases"
"github.com/aquasecurity/defsec/pkg/terraform"
"github.com/aquasecurity/defsec/pkg/severity"
"github.com/aquasecurity/defsec/pkg/state"
"github.com/aquasecurity/defsec/pkg/providers"
)
type CheckFunc func(s *state.State) (results Results)
type EngineMetadata struct {
GoodExamples []string `json:"good_examples,omitempty"`
BadExamples []string `json:"bad_examples,omitempty"`
RemediationMarkdown string `json:"remediation_markdown,omitempty"`
Links []string `json:"links,omitempty"`
}
type CustomChecks struct {
Terraform *TerraformCustomCheck
}
type TerraformCustomCheck struct {
RequiredTypes []string
RequiredLabels []string
RequiredSources []string
Check func(*terraform.Block, *terraform.Module) Results
}
type Rule struct {
AVDID string `json:"avd_id"`
LegacyID string `json:"id"`
ShortCode string `json:"short_code"`
Summary string `json:"summary"`
Explanation string `json:"explanation"`
Impact string `json:"impact"`
Resolution string `json:"resolution"`
Provider providers.Provider `json:"provider"`
Service string `json:"service"`
Links []string `json:"links"`
Severity severity.Severity `json:"severity"`
Terraform *EngineMetadata `json:"terraform,omitempty"`
CloudFormation *EngineMetadata `json:"cloud_formation,omitempty"`
CustomChecks CustomChecks `json:"-"`
RegoPackage string `json:"-"`
}
func (r Rule) LongID() string {
return strings.ToLower(fmt.Sprintf("%s-%s-%s", r.Provider, r.Service, r.ShortCode))
}
func (r Rule) ServiceDisplayName() string {
return nicify(r.Service)
}
func (r Rule) ShortCodeDisplayName() string {
return nicify(r.ShortCode)
}
var acronyms = []string{
"acl",
"alb",
"api",
"arn",
"aws",
"cidr",
"db",
"dns",
"ebs",
"ec2",
"ecr",
"ecs",
"efs",
"eks",
"elb",
"gke",
"http",
"http2",
"https",
"iam",
"im",
"imds",
"ip",
"ips",
"kms",
"lb",
"md5",
"mfa",
"mq",
"msk",
"rbac",
"rdp",
"rds",
"rsa",
"sam",
"sgr",
"sha1",
"sha256",
"sns",
"sql",
"sqs",
"ssh",
"ssm",
"tls",
"ubla",
"vm",
"vpc",
"vtpm",
"waf",
}
var specials = map[string]string{
"dynamodb": "DynamoDB",
"documentdb": "DocumentDB",
"mysql": "MySQL",
"postgresql": "PostgreSQL",
"acls": "ACLs",
"ips": "IPs",
"bigquery": "BigQuery",
}
func nicify(input string) string {
input = strings.ToLower(input)
for replace, with := range specials {
input = regexp.MustCompile(fmt.Sprintf("\\b%s\\b", replace)).ReplaceAllString(input, with)
}
for _, acronym := range acronyms {
input = regexp.MustCompile(fmt.Sprintf("\\b%s\\b", acronym)).ReplaceAllString(input, strings.ToUpper(acronym))
}
return cases.Title(language.English).String(strings.ReplaceAll(input, "-", " "))
}