/
scans.go
583 lines (489 loc) · 22.2 KB
/
scans.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
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
package model
import (
"github.com/deepfence/ThreatMapper/deepfence_server/reporters"
)
type VulnerabilityScanConfigLanguage struct {
Language string `json:"language" validate:"required,oneof=base ruby python javascript php golang golang-binary java rust rust-binary dotnet" required:"true" enum:"base,ruby,python,javascript,php,golang,golang-binary,java,rust,rust-binary,dotnet"`
}
type VulnerabilityScanConfig struct {
ScanConfigLanguages []VulnerabilityScanConfigLanguage `json:"scan_config" validate:"required,min=1" required:"true"`
}
type VulnerabilityScanTriggerReq struct {
ScanTriggerCommon
VulnerabilityScanConfig
}
type SecretScanTriggerReq struct {
ScanTriggerCommon
}
type MalwareScanTriggerReq struct {
ScanTriggerCommon
}
type ComplianceScanTriggerReq struct {
ScanTriggerCommon
ComplianceBenchmarkTypes
}
type ScanCompareReq struct {
BaseScanID string `json:"base_scan_id" required:"true"`
ToScanID string `json:"to_scan_id" required:"true"`
FieldsFilter reporters.FieldsFilters `json:"fields_filter" required:"true"`
Window FetchWindow `json:"window" required:"true"`
}
type ScanCompareRes[T any] struct {
New []T `json:"new" required:"true"`
}
type ScanCompareResVulnerability = ScanCompareRes[Vulnerability]
type ScanCompareResSecret = ScanCompareRes[Secret]
type ScanCompareResMalware = ScanCompareRes[Malware]
type ScanCompareResCompliance = ScanCompareRes[Compliance]
type ScanCompareResCloudCompliance = ScanCompareRes[CloudCompliance]
type ScanFilter struct {
ImageScanFilter reporters.ContainsFilter `json:"image_scan_filter" required:"true"`
ContainerScanFilter reporters.ContainsFilter `json:"container_scan_filter" required:"true"`
HostScanFilter reporters.ContainsFilter `json:"host_scan_filter" required:"true"`
CloudAccountScanFilter reporters.ContainsFilter `json:"cloud_account_scan_filter" required:"true"`
KubernetesClusterScanFilter reporters.ContainsFilter `json:"kubernetes_cluster_scan_filter" required:"true"`
}
type ScanTriggerCommon struct {
NodeIDs []NodeIdentifier `json:"node_ids" required:"true"`
Filters ScanFilter `json:"filters" required:"true"`
IsPriority bool `json:"is_priority"`
DeepfenceSystemScan bool `json:"deepfence_system_scan"` // Scan Deepfence images/containers/pods if present in NodeIDs
}
type NodeIdentifier struct {
NodeID string `json:"node_id" required:"true"`
NodeType string `json:"node_type" required:"true" enum:"image,host,container,cloud_account,cluster,registry,pod"`
}
type ComplianceBenchmarkTypes struct {
BenchmarkTypes []string `json:"benchmark_types" required:"true"`
}
type ScanStatus string
type ScanInfo struct {
ScanID string `json:"scan_id" required:"true"`
Status string `json:"status" required:"true"`
StatusMessage string `json:"status_message" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true" format:"int64"`
CreatedAt int64 `json:"created_at" required:"true" format:"int64"`
NodeID string `json:"node_id" required:"true"`
NodeType string `json:"node_type" required:"true"`
SeverityCounts map[string]int32 `json:"severity_counts" required:"true"`
NodeName string `json:"node_name" required:"true"`
}
type ComplianceScanInfo struct {
ScanInfo
BenchmarkTypes []string `json:"benchmark_types" required:"true"`
}
type ScanTriggerResp struct {
ScanIds []string `json:"scan_ids" required:"true"`
BulkScanID string `json:"bulk_scan_id" required:"true"`
}
type ScanStatusReq struct {
ScanIds []string `json:"scan_ids" required:"true"`
BulkScanID string `json:"bulk_scan_id" required:"true"`
}
type ScanStatusResp struct {
Statuses map[string]ScanInfo `json:"statuses" required:"true"`
}
type ComplianceScanStatusResp struct {
Statuses []ComplianceScanInfo `json:"statuses" required:"true"`
}
type ScanListReq struct {
NodeIds []NodeIdentifier `json:"node_ids" required:"true"`
FieldsFilter reporters.FieldsFilters `json:"fields_filter" required:"true"`
Window FetchWindow `json:"window" required:"true"`
}
type ScanListResp struct {
ScansInfo []ScanInfo `json:"scans_info" required:"true"`
}
type CloudComplianceScanListResp struct {
ScansInfo []ComplianceScanInfo `json:"scans_info" required:"true"`
}
type ScanResultsMaskRequest struct {
ScanID string `json:"scan_id" validate:"required" required:"true"`
ResultIDs []string `json:"result_ids" validate:"required,gt=0,dive,min=1" required:"true"`
ScanType string `json:"scan_type" validate:"required,oneof=SecretScan VulnerabilityScan MalwareScan ComplianceScan CloudComplianceScan" required:"true" enum:"SecretScan,VulnerabilityScan,MalwareScan,ComplianceScan,CloudComplianceScan"`
MaskAction string `json:"mask_action" validate:"required,oneof=mask_global mask_all_image_tag mask_entity mask_image_tag" required:"true" enum:"mask_global,mask_all_image_tag,mask_entity,mask_image_tag"`
}
type ScanResultsActionRequest struct {
ScanID string `json:"scan_id" validate:"required" required:"true"`
ResultIDs []string `json:"result_ids" validate:"required,gt=0,dive,min=1" required:"true"`
ScanType string `json:"scan_type" validate:"required,oneof=SecretScan VulnerabilityScan MalwareScan ComplianceScan CloudComplianceScan" required:"true" enum:"SecretScan,VulnerabilityScan,MalwareScan,ComplianceScan,CloudComplianceScan"`
NotifyIndividual bool `json:"notify_individual"`
IntegrationIDs []int32 `json:"integration_ids"`
}
type DownloadReportResponse struct {
URLLink string `json:"url_link"`
}
type DownloadScanResultsResponse struct {
ScanInfo ScanResultsCommon `json:"scan_info"`
ScanResults []interface{} `json:"scan_results"`
}
type BulkDeleteScansRequest struct {
ScanType string `json:"scan_type" validate:"required,oneof=Secret Vulnerability Malware Compliance CloudCompliance" required:"true" enum:"Secret,Vulnerability,Malware,Compliance,CloudCompliance"`
Filters reporters.FieldsFilters `json:"filters" required:"true"`
}
type StopScanRequest struct {
ScanIds []string `json:"scan_ids" validate:"required" required:"true"`
ScanType string `json:"scan_type" validate:"required,oneof=SecretScan VulnerabilityScan MalwareScan ComplianceScan CloudComplianceScan" required:"true" enum:"SecretScan,VulnerabilityScan,MalwareScan,ComplianceScan,CloudComplianceScan"`
}
type ScanActionRequest struct {
ScanID string `path:"scan_id" validate:"required" required:"true"`
ScanType string `path:"scan_type" validate:"required,oneof=SecretScan VulnerabilityScan MalwareScan ComplianceScan CloudComplianceScan" required:"true" enum:"SecretScan,VulnerabilityScan,MalwareScan,ComplianceScan,CloudComplianceScan"`
// utils.Neo4jScanType
}
type NodesInScanResultRequest struct {
ResultIDs []string `json:"result_ids" validate:"required,dive,min=1" required:"true"`
ScanType string `json:"scan_type" validate:"required,oneof=SecretScan VulnerabilityScan MalwareScan ComplianceScan CloudComplianceScan" required:"true" enum:"SecretScan,VulnerabilityScan,MalwareScan,ComplianceScan,CloudComplianceScan"`
}
type ScanResultBasicNode struct {
ResultID string `json:"result_id" required:"true"`
BasicNodes []BasicNode `json:"basic_nodes" required:"true"`
}
type SbomRequest struct {
// either scan_id or node_id+node_type is required
ScanID string `json:"scan_id" validate:"required" required:"true"`
// NodeID string `json:"node_id"`
// NodeType string `json:"node_type"`
}
type SbomResponse struct {
PackageName string `json:"package_name,omitempty"`
Version string `json:"version,omitempty"`
Locations []string `json:"locations,omitempty"`
Licenses []string `json:"licenses,omitempty"`
CveID string `json:"cve_id,omitempty"`
Severity string `json:"severity,omitempty"`
CveNodeID string `json:"cve_node_id,omitempty"`
}
type ScanResultsReq struct {
ScanID string `json:"scan_id" required:"true"`
FieldsFilter reporters.FieldsFilters `json:"fields_filter" required:"true"`
Window FetchWindow `json:"window" required:"true"`
}
type ScanResultsCommon struct {
ContainerName string `json:"docker_container_name" required:"true"`
ImageName string `json:"docker_image_name" required:"true"`
HostName string `json:"host_name" required:"true"`
KubernetesClusterName string `json:"kubernetes_cluster_name" required:"true"`
NodeID string `json:"node_id" required:"true"`
NodeName string `json:"node_name" required:"true"`
NodeType string `json:"node_type" required:"true"`
ScanID string `json:"scan_id" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true" format:"int64"`
CreatedAt int64 `json:"created_at" required:"true" format:"int64"`
CloudAccountID string `json:"cloud_account_id" required:"true"`
}
type FiltersReq struct {
RequiredFilters []string `json:"filters" required:"true"`
Having map[string]interface{} `json:"having"`
}
type FiltersResult struct {
Filters map[string][]string `json:"filters" required:"true"`
}
type SecretScanResult struct {
ScanResultsCommon
Secrets []Secret `json:"secrets" required:"true"`
SeverityCounts map[string]int32 `json:"severity_counts" required:"true"`
}
type SecretScanResultRules struct {
Rules []string `json:"rules" required:"true"`
}
type VulnerabilityScanResult struct {
ScanResultsCommon
Vulnerabilities []Vulnerability `json:"vulnerabilities" required:"true"`
SeverityCounts map[string]int32 `json:"severity_counts" required:"true"`
}
type MalwareScanResult struct {
ScanResultsCommon
Malwares []Malware `json:"malwares" required:"true"`
SeverityCounts map[string]int32 `json:"severity_counts" required:"true"`
}
type MalwareScanResultRules struct {
Rules []string `json:"rules" required:"true"`
}
type MalwareScanResultClass struct {
Class []string `json:"class" required:"true"`
}
type ComplianceScanResult struct {
ScanResultsCommon
ComplianceAdditionalInfo
Compliances []Compliance `json:"compliances" required:"true"`
}
type ComplianceAdditionalInfo struct {
BenchmarkTypes []string `json:"benchmark_type" required:"true"`
StatusCounts map[string]int32 `json:"status_counts" required:"true"`
CompliancePercentage float64 `json:"compliance_percentage" required:"true"`
}
type CloudComplianceScanResult struct {
ScanResultsCommon
ComplianceAdditionalInfo
Compliances []CloudCompliance `json:"compliances" required:"true"`
}
type Secret struct {
// Secret + Rule neo4j node
NodeID string `json:"node_id" required:"true"`
StartingIndex int32 `json:"starting_index" required:"true"`
RelativeStartingIndex int32 `json:"relative_starting_index" required:"true"`
RelativeEndingIndex int32 `json:"relative_ending_index" required:"true"`
FullFilename string `json:"full_filename" required:"true"`
MatchedContent string `json:"matched_content" required:"true"`
Masked bool `json:"masked" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true"`
Level string `json:"level" required:"true"`
Score float64 `json:"score" required:"true"`
RuleID int32 `json:"rule_id" required:"true"`
Name string `json:"name" required:"true"`
Part string `json:"part" required:"true"`
SignatureToMatch string `json:"signature_to_match" required:"true"`
Resources []BasicNode `json:"resources" required:"false"`
}
func (Secret) NodeType() string {
return "Secret"
}
func (Secret) ExtendedField() string {
return "rule_id"
}
func (v Secret) GetCategory() string {
return v.Level
}
func (Secret) GetJSONCategory() string {
return "level"
}
type SecretRule struct {
ID int `json:"id"`
Name string `json:"name"`
Part string `json:"part"`
SignatureToMatch string `json:"signature_to_match"`
Level string `json:"level" required:"true"`
Masked bool `json:"masked" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true"`
}
func (SecretRule) NodeType() string {
return "SecretRule"
}
func (SecretRule) ExtendedField() string {
return ""
}
func (v SecretRule) GetCategory() string {
return v.Level
}
func (SecretRule) GetJSONCategory() string {
return "level"
}
type Vulnerability struct {
NodeID string `json:"node_id" required:"true"`
CveID string `json:"cve_id" required:"true"`
CveSeverity string `json:"cve_severity" required:"true"`
CveCausedByPackage string `json:"cve_caused_by_package" required:"true"`
CveCausedByPackagePath string `json:"cve_caused_by_package_path" required:"true"`
CveContainerLayer string `json:"cve_container_layer" required:"true"`
CveLink string `json:"cve_link" required:"true"`
Masked bool `json:"masked" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true"`
HasLiveConnection bool `json:"has_live_connection" required:"true"`
CveType string `json:"cve_type" required:"true"`
CveFixedIn string `json:"cve_fixed_in" required:"true"`
CveDescription string `json:"cve_description" required:"true"`
CveCVSSScore float64 `json:"cve_cvss_score" required:"true"`
CveOverallScore float64 `json:"cve_overall_score" required:"true"`
CveAttackVector string `json:"cve_attack_vector" required:"true"`
URLs []interface{} `json:"urls" required:"true"`
ExploitPOC string `json:"exploit_poc" required:"true"`
ParsedAttackVector string `json:"parsed_attack_vector" required:"true"`
Resources []BasicNode `json:"resources" required:"false"`
RuleID string `json:"rule_id" required:"true"`
}
func (Vulnerability) NodeType() string {
return "Vulnerability"
}
func (Vulnerability) ExtendedField() string {
return "rule_id"
}
func (v Vulnerability) GetCategory() string {
return v.CveSeverity
}
func (Vulnerability) GetJSONCategory() string {
return "cve_severity"
}
type VulnerabilityRule struct {
NodeID string `json:"node_id" required:"true"`
CveID string `json:"cve_id" required:"true"`
CveType string `json:"cve_type" required:"true"`
CveSeverity string `json:"cve_severity" required:"true"`
CveFixedIn string `json:"cve_fixed_in" required:"true"`
CveLink string `json:"cve_link" required:"true"`
CveDescription string `json:"cve_description" required:"true"`
CveCVSSScore float64 `json:"cve_cvss_score" required:"true"`
CveOverallScore float64 `json:"cve_overall_score" required:"true"`
CveAttackVector string `json:"cve_attack_vector" required:"true"`
URLs []interface{} `json:"urls" required:"true"`
ExploitPOC string `json:"exploit_poc" required:"true"`
Masked bool `json:"masked" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true"`
ParsedAttackVector string `json:"parsed_attack_vector" required:"true"`
Resources []BasicNode `json:"resources" required:"false"`
}
func (VulnerabilityRule) NodeType() string {
return "VulnerabilityStub"
}
func (VulnerabilityRule) ExtendedField() string {
return ""
}
func (v VulnerabilityRule) GetCategory() string {
return v.CveSeverity
}
func (VulnerabilityRule) GetJSONCategory() string {
return "cve_severity"
}
type Malware struct {
// Malware + MalwareRule node in neo4j
Class string `json:"class" required:"true"`
CompleteFilename string `json:"complete_filename" required:"true"`
FileSevScore int `json:"file_sev_score" required:"true"`
FileSeverity string `json:"file_severity" required:"true"`
ImageLayerID string `json:"image_layer_id" required:"true"`
NodeID string `json:"node_id" required:"true"`
RuleID string `json:"rule_id" required:"true"`
RuleName string `json:"rule_name" required:"true"`
Author string `json:"author"`
Date string `json:"date"`
Description string `json:"description"`
Filetype string `json:"filetype"`
Info string `json:"info"`
Version string `json:"version"`
SeverityScore int `json:"severity_score"`
StringsToMatch []interface{} `json:"strings_to_match"`
Summary string `json:"summary"`
Masked bool `json:"masked" required:"true"`
Resources []BasicNode `json:"resources" required:"false"`
}
func (Malware) NodeType() string {
return "Malware"
}
func (Malware) ExtendedField() string {
return "rule_id"
}
func (v Malware) GetCategory() string {
return v.FileSeverity
}
func (Malware) GetJSONCategory() string {
return "file_severity"
}
type MalwareRule struct {
RuleID string `json:"rule_id"`
RuleName string `json:"rule_name"`
Author string `json:"author"`
Date string `json:"date"`
Description string `json:"description"`
Filetype string `json:"filetype"`
Info string `json:"info"`
Version string `json:"version"`
Reference string `json:"reference"`
FileSeverity string `json:"file_severity"`
Masked bool `json:"masked" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true"`
}
func (MalwareRule) NodeType() string {
return "MalwareRule"
}
func (MalwareRule) ExtendedField() string {
return ""
}
func (v MalwareRule) GetCategory() string {
return v.FileSeverity
}
func (MalwareRule) GetJSONCategory() string {
return "file_severity"
}
type Compliance struct {
TestCategory string `json:"test_category" required:"true"`
TestNumber string `json:"test_number" required:"true"`
TestInfo string `json:"description" required:"true"`
RemediationScript string `json:"remediation_script,omitempty" required:"true"`
RemediationAnsible string `json:"remediation_ansible,omitempty" required:"true"`
RemediationPuppet string `json:"remediation_puppet,omitempty" required:"true"`
Resource string `json:"resource" required:"true"`
TestRationale string `json:"test_rationale" required:"true"`
TestSeverity string `json:"test_severity" required:"true"`
TestDesc string `json:"test_desc" required:"true"`
Status string `json:"status" required:"true"`
ComplianceCheckType string `json:"compliance_check_type" required:"true"`
ComplianceNodeID string `json:"node_id" required:"true"`
ComplianceNodeType string `json:"node_type" required:"true"`
Masked bool `json:"masked" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true"`
Resources []BasicNode `json:"resources" required:"false"`
RuleID string `json:"rule_id" required:"true"`
}
func (Compliance) NodeType() string {
return "Compliance"
}
func (Compliance) ExtendedField() string {
return "rule_id"
}
func (v Compliance) GetCategory() string {
return v.TestSeverity
}
func (Compliance) GetJSONCategory() string {
return "test_severity"
}
type ComplianceRule struct {
TestCategory string `json:"test_category" required:"true"`
TestNumber string `json:"test_number" required:"true"`
TestInfo string `json:"description" required:"true"`
TestRationale string `json:"test_rationale" required:"true"`
TestSeverity string `json:"test_severity" required:"true"`
TestDesc string `json:"test_desc" required:"true"`
Masked bool `json:"masked" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true"`
}
func (ComplianceRule) NodeType() string {
return "ComplianceRule"
}
func (ComplianceRule) ExtendedField() string {
return ""
}
func (v ComplianceRule) GetCategory() string {
return v.TestSeverity
}
func (ComplianceRule) GetJSONCategory() string {
return "test_severity"
}
type CloudCompliance struct {
Count int32 `json:"count,omitempty" required:"true"`
Reason string `json:"reason" required:"true"`
Resource string `json:"resource" required:"true"`
Status string `json:"status" required:"true"`
Region string `json:"region" required:"true"`
AccountID string `json:"account_id" required:"true"`
Group string `json:"group" required:"true"`
Service string `json:"service" required:"true"`
Title string `json:"title" required:"true"`
ComplianceCheckType string `json:"compliance_check_type" required:"true"`
CloudProvider string `json:"cloud_provider" required:"true"`
NodeName string `json:"node_name" required:"true"`
NodeID string `json:"node_id" required:"true"`
Masked bool `json:"masked" required:"true"`
UpdatedAt int64 `json:"updated_at" required:"true"`
Type string `json:"type" required:"true"`
ControlID string `json:"control_id" required:"true"`
Description string `json:"description" required:"true"`
Severity string `json:"severity" required:"true"`
Resources []BasicNode `json:"resources" required:"false"`
}
func (CloudCompliance) NodeType() string {
return "CloudCompliance"
}
func (CloudCompliance) ExtendedField() string {
return ""
}
func (v CloudCompliance) GetCategory() string {
return v.Severity
}
func (CloudCompliance) GetJSONCategory() string {
return "severity"
}
type ScanReportFieldsResponse struct {
Vulnerability []string `json:"vulnerability"`
Secret []string `json:"secret"`
Malware []string `json:"malware"`
Compliance []string `json:"compliance"`
}