-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathenumerate.go
More file actions
373 lines (322 loc) · 12.6 KB
/
enumerate.go
File metadata and controls
373 lines (322 loc) · 12.6 KB
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
package securitygroup
import (
// Standard
"context"
"fmt"
// Generated
common "github.com/Method-Security/methodaws/generated/go/common"
fernsecuritygroup "github.com/Method-Security/methodaws/generated/go/securitygroup"
// External
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/ec2"
ec2types "github.com/aws/aws-sdk-go-v2/service/ec2/types"
"github.com/aws/aws-sdk-go-v2/service/rds"
rdstypes "github.com/aws/aws-sdk-go-v2/service/rds/types"
svc1log "github.com/palantir/witchcraft-go-logging/wlog/svclog/svc1log"
)
// fetchSecurityGroupRules retrieves detailed rules for a specific security group
func fetchSecurityGroupRules(ctx context.Context, cfg aws.Config, groupID string) ([]ec2types.SecurityGroupRule, error) {
svc := ec2.NewFromConfig(cfg)
input := &ec2.DescribeSecurityGroupRulesInput{
Filters: []ec2types.Filter{
{
Name: aws.String("group-id"),
Values: []string{groupID},
},
},
}
var allRules []ec2types.SecurityGroupRule
paginator := ec2.NewDescribeSecurityGroupRulesPaginator(svc, input)
for paginator.HasMorePages() {
output, err := paginator.NextPage(ctx)
if err != nil {
return nil, err
}
allRules = append(allRules, output.SecurityGroupRules...)
}
return allRules, nil
}
// EnumerateSecurityGroups lists all of the security groups available to the caller across multiple regions
// alongside any non-fatal errors that occurred during the execution of the `methodaws securitygroup enumerate` subcommand.
// This includes both EC2/VPC security groups and RDS DB security groups.
// If vpcID is not nil, it will only return EC2 security groups associated with that VPC.
func EnumerateSecurityGroups(ctx context.Context, cfg aws.Config, config fernsecuritygroup.SecurityGroupsEnumerateConfig) *fernsecuritygroup.SecurityGroupsEnumerateReport {
log := svc1log.FromContext(ctx)
log.Info("Starting SecurityGroup enumeration",
svc1log.SafeParam("regionsCount", len(config.Regions)))
report := fernsecuritygroup.SecurityGroupsEnumerateReport{
Config: &config,
Result: &fernsecuritygroup.SecurityGroupsEnumerateResult{},
}
var allSecurityGroups []*fernsecuritygroup.SecurityGroup
var allErrors []string
for _, region := range config.Regions {
log.Info("Processing SecurityGroups in region", svc1log.SafeParam("region", region))
// Enumerate EC2 security groups
ec2SecurityGroups, ec2Errors := enumerateEC2SecurityGroupForRegion(ctx, cfg, region)
// Enumerate RDS DB security groups
rdsSecurityGroups, rdsErrors := enumerateRDSSecurityGroupForRegion(ctx, cfg, region)
totalErrors := append(ec2Errors, rdsErrors...)
if len(totalErrors) > 0 {
log.Warn("Errors occurred while enumerating SecurityGroups in region",
svc1log.SafeParam("region", region),
svc1log.SafeParam("errorCount", len(totalErrors)))
}
// Convert AWS SDK EC2 SecurityGroups to Fern SecurityGroups
for _, sg := range ec2SecurityGroups {
if sg.GroupId == nil {
log.Warn("EC2 SecurityGroup ID is nil", svc1log.SafeParam("sg", sg))
allErrors = append(allErrors, "EC2 SecurityGroup ID is nil")
continue
}
fernSG, errors := convertAWSEC2SecurityGroupToFern(ctx, cfg, sg, region)
allErrors = append(allErrors, errors...)
allSecurityGroups = append(allSecurityGroups, fernSG)
}
// Convert AWS SDK RDS DB SecurityGroups to Fern SecurityGroups
for _, sg := range rdsSecurityGroups {
if sg.DBSecurityGroupName == nil {
log.Warn("RDS DB SecurityGroup Name is nil", svc1log.SafeParam("sg", sg))
allErrors = append(allErrors, "RDS DB SecurityGroup Name is nil")
continue
}
fernSG := convertAWSRDSSecurityGroupToFern(sg, region)
allSecurityGroups = append(allSecurityGroups, fernSG)
}
log.Info("Successfully processed SecurityGroups in region",
svc1log.SafeParam("region", region),
svc1log.SafeParam("ec2SecurityGroupCount", len(ec2SecurityGroups)),
svc1log.SafeParam("rdsSecurityGroupCount", len(rdsSecurityGroups)))
allErrors = append(allErrors, totalErrors...)
}
if len(allSecurityGroups) > 0 {
report.Result.SecurityGroups = allSecurityGroups
}
report.Errors = allErrors
return &report
}
// enumerateEC2SecurityGroupForRegion lists all of the EC2 security groups available to the caller for a specific region.
// If vpcID is not nil, it will only return security groups associated with that VPC.
func enumerateEC2SecurityGroupForRegion(ctx context.Context, cfg aws.Config, region string) ([]ec2types.SecurityGroup, []string) {
log := svc1log.FromContext(ctx)
log.Info("Enumerating EC2 SecurityGroups for region",
svc1log.SafeParam("region", region),
svc1log.SafeParam("vpcId", nil))
cfg.Region = region
svc := ec2.NewFromConfig(cfg)
var securityGroups []ec2types.SecurityGroup
var errors []string
paginator := ec2.NewDescribeSecurityGroupsPaginator(svc, &ec2.DescribeSecurityGroupsInput{})
for paginator.HasMorePages() {
output, err := paginator.NextPage(ctx)
if err != nil {
log.Warn("Failed to retrieve EC2 SecurityGroups page",
svc1log.SafeParam("region", region),
svc1log.Stacktrace(err))
errors = append(errors, fmt.Sprintf("Error in region %s: %v", region, err))
break
}
securityGroups = append(securityGroups, output.SecurityGroups...)
}
if len(securityGroups) > 0 {
log.Info("Successfully enumerated EC2 SecurityGroups",
svc1log.SafeParam("region", region),
svc1log.SafeParam("securityGroupCount", len(securityGroups)))
} else {
log.Info("No EC2 SecurityGroups found in region", svc1log.SafeParam("region", region))
}
return securityGroups, errors
}
// enumerateRDSSecurityGroupForRegion lists all of the RDS DB security groups available to the caller for a specific region.
// Note: RDS DB security groups are mostly legacy for EC2-Classic which was retired August 15, 2022.
func enumerateRDSSecurityGroupForRegion(ctx context.Context, cfg aws.Config, region string) ([]rdstypes.DBSecurityGroup, []string) {
log := svc1log.FromContext(ctx)
log.Info("Enumerating RDS DB SecurityGroups for region",
svc1log.SafeParam("region", region))
cfg.Region = region
svc := rds.NewFromConfig(cfg)
var securityGroups []rdstypes.DBSecurityGroup
var errors []string
paginator := rds.NewDescribeDBSecurityGroupsPaginator(svc, &rds.DescribeDBSecurityGroupsInput{})
for paginator.HasMorePages() {
output, err := paginator.NextPage(ctx)
if err != nil {
log.Warn("Failed to retrieve RDS DB SecurityGroups page",
svc1log.SafeParam("region", region),
svc1log.Stacktrace(err))
errors = append(errors, fmt.Sprintf("Error in region %s: %v", region, err))
break
}
securityGroups = append(securityGroups, output.DBSecurityGroups...)
}
if len(securityGroups) > 0 {
log.Info("Successfully enumerated RDS DB SecurityGroups",
svc1log.SafeParam("region", region),
svc1log.SafeParam("securityGroupCount", len(securityGroups)))
} else {
log.Info("No RDS DB SecurityGroups found in region", svc1log.SafeParam("region", region))
}
return securityGroups, errors
}
// convertAWSEC2SecurityGroupToFern converts an AWS SDK EC2 SecurityGroup to a Fern SecurityGroup
func convertAWSEC2SecurityGroupToFern(ctx context.Context, cfg aws.Config, awsSG ec2types.SecurityGroup, region string) (*fernsecuritygroup.SecurityGroup, []string) {
log := svc1log.FromContext(ctx)
var errors []string
// Fetch detailed security group rules to get rule IDs
var detailedRules []ec2types.SecurityGroupRule
if awsSG.GroupId != nil {
cfg.Region = region
rules, err := fetchSecurityGroupRules(ctx, cfg, *awsSG.GroupId)
if err != nil {
log.Warn("Failed to fetch detailed security group rules",
svc1log.SafeParam("groupId", *awsSG.GroupId),
svc1log.SafeParam("region", region),
svc1log.Stacktrace(err))
} else {
detailedRules = rules
}
}
// Convert SecurityGroupRules directly to fernsecuritygroup.IpPermission
var fernPermissions []*fernsecuritygroup.RuleDetails
for _, rule := range detailedRules {
if rule.SecurityGroupRuleId == nil {
log.Warn("SecurityGroupRule missing ID", svc1log.SafeParam("rule", rule))
continue
}
// Determine direction
var direction fernsecuritygroup.PermissionDirection
if rule.IsEgress != nil && *rule.IsEgress {
direction = fernsecuritygroup.PermissionDirectionEgress
} else {
direction = fernsecuritygroup.PermissionDirectionIngress
}
fernPerm := &fernsecuritygroup.RuleDetails{
Identification: &fernsecuritygroup.RuleIdentificationInfo{
Id: *rule.SecurityGroupRuleId,
},
Configuration: &fernsecuritygroup.RuleConfigurationInfo{
Direction: direction,
IpProtocol: rule.IpProtocol,
Peer: &fernsecuritygroup.RulePeerInfo{},
},
}
// Convert ports from int32 to int
if rule.FromPort != nil {
fromPort := int(*rule.FromPort)
fernPerm.Configuration.FromPort = &fromPort
}
if rule.ToPort != nil {
toPort := int(*rule.ToPort)
fernPerm.Configuration.ToPort = &toPort
}
// Extract description
if rule.Description != nil {
fernPerm.Configuration.Description = rule.Description
}
// Extract CIDR blocks - combine IPv4 and IPv6 into single list
var cidrs []string
if rule.CidrIpv4 != nil {
cidrs = append(cidrs, *rule.CidrIpv4)
}
if rule.CidrIpv6 != nil {
cidrs = append(cidrs, *rule.CidrIpv6)
}
if len(cidrs) > 0 {
fernPerm.Configuration.Peer.Cidrs = cidrs
}
// Extract referenced security group (missing bidirectional connection!)
if rule.ReferencedGroupInfo != nil && rule.ReferencedGroupInfo.GroupId != nil {
refSG := &fernsecuritygroup.ReferencedSecurityGroup{
GroupId: *rule.ReferencedGroupInfo.GroupId,
}
if rule.ReferencedGroupInfo.UserId != nil {
refSG.UserId = *rule.ReferencedGroupInfo.UserId
}
fernPerm.Configuration.Peer.ReferencedSecurityGroup = refSG
}
if len(cidrs) == 0 && fernPerm.Configuration.Peer.ReferencedSecurityGroup == nil {
log.Warn("SecurityGroupRule missing CIDR or referenced security group", svc1log.SafeParam("rule", fernPerm))
errors = append(errors, fmt.Sprintf("SecurityGroupRule missing CIDR or referenced security group: %v", fernPerm))
continue
}
fernPermissions = append(fernPermissions, fernPerm)
}
// Convert Tags
var fernTags []*common.Tag
if awsSG.Tags != nil {
for _, tag := range awsSG.Tags {
fernTag := &common.Tag{
Key: tag.Key,
Value: tag.Value,
}
fernTags = append(fernTags, fernTag)
}
}
// Create VPC reference if VPC ID exists
var vpcReference *common.VpcReference
if awsSG.VpcId != nil {
vpcReference = &common.VpcReference{
Id: *awsSG.VpcId,
Region: region,
}
}
// Create the SecurityGroup with nested structure
fernSG := &fernsecuritygroup.SecurityGroup{
Identification: &fernsecuritygroup.SecurityGroupIdentificationInfo{
Id: *awsSG.GroupId,
Region: region,
Name: awsSG.GroupName,
},
Configuration: &fernsecuritygroup.SecurityGroupConfigurationInfo{
Description: awsSG.Description,
SecurityGroupType: fernsecuritygroup.SecurityGroupTypeEc2,
OwnerId: awsSG.OwnerId,
Tags: fernTags,
},
}
// Add resources if we have VPC or permissions
if vpcReference != nil || len(fernPermissions) > 0 {
resourceInfo := &fernsecuritygroup.SecurityGroupResourceInfo{
Vpc: vpcReference,
Rules: fernPermissions,
}
fernSG.Resources = resourceInfo
}
return fernSG, errors
}
// convertAWSRDSSecurityGroupToFern converts an AWS SDK RDS DB SecurityGroup to a Fern SecurityGroup
func convertAWSRDSSecurityGroupToFern(awsSG rdstypes.DBSecurityGroup, region string) *fernsecuritygroup.SecurityGroup {
// Create VPC reference if VPC ID exists
var vpcReference *common.VpcReference
if awsSG.VpcId != nil {
vpcReference = &common.VpcReference{
Id: *awsSG.VpcId,
Region: region,
}
}
// Create the SecurityGroup with nested structure
fernSG := &fernsecuritygroup.SecurityGroup{
Identification: &fernsecuritygroup.SecurityGroupIdentificationInfo{
Id: *awsSG.DBSecurityGroupName,
Arn: awsSG.DBSecurityGroupArn,
Name: awsSG.DBSecurityGroupName,
Region: region,
},
Configuration: &fernsecuritygroup.SecurityGroupConfigurationInfo{
Description: awsSG.DBSecurityGroupDescription,
SecurityGroupType: fernsecuritygroup.SecurityGroupTypeRds,
OwnerId: awsSG.OwnerId,
},
}
// Add resources if we have VPC
if vpcReference != nil {
resourceInfo := &fernsecuritygroup.SecurityGroupResourceInfo{
Vpc: vpcReference,
Rules: nil, // RDS DB security group rules are not mapped in the unified schema
}
fernSG.Resources = resourceInfo
}
// Note: EC2SecurityGroups and IPRanges are not included in the Fern SecurityGroup definition
// These fields exist in the RDS DB SecurityGroup but are not mapped to the unified SecurityGroup schema
return fernSG
}