/
process.go
816 lines (725 loc) · 28.3 KB
/
process.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
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
package internal
import (
"encoding/json"
"encoding/xml"
"fmt"
"net/http"
"os"
"path"
"strconv"
"time"
"github.com/checkmarxDev/ast-sast-export/internal/app/resultsmapping"
"github.com/hashicorp/go-retryablehttp"
"github.com/hashicorp/go-cleanhttp"
"github.com/checkmarxDev/ast-sast-export/internal/persistence/installation"
"github.com/checkmarxDev/ast-sast-export/internal/app/astquery"
export2 "github.com/checkmarxDev/ast-sast-export/internal/app/export"
"github.com/checkmarxDev/ast-sast-export/internal/app/interfaces"
"github.com/checkmarxDev/ast-sast-export/internal/app/metadata"
"github.com/checkmarxDev/ast-sast-export/internal/app/permissions"
"github.com/checkmarxDev/ast-sast-export/internal/app/preset"
"github.com/checkmarxDev/ast-sast-export/internal/app/querymapping"
"github.com/checkmarxDev/ast-sast-export/internal/app/report"
"github.com/checkmarxDev/ast-sast-export/internal/app/worker"
"github.com/checkmarxDev/ast-sast-export/internal/integration/rest"
"github.com/checkmarxDev/ast-sast-export/internal/integration/similarity"
"github.com/checkmarxDev/ast-sast-export/internal/integration/soap"
"github.com/checkmarxDev/ast-sast-export/internal/persistence/methodline"
presetrepo "github.com/checkmarxDev/ast-sast-export/internal/persistence/preset"
"github.com/checkmarxDev/ast-sast-export/internal/persistence/queries"
"github.com/checkmarxDev/ast-sast-export/internal/persistence/sourcefile"
"github.com/checkmarxDev/ast-sast-export/pkg/sliceutils"
"github.com/golang-jwt/jwt"
"github.com/pkg/errors"
"github.com/rs/zerolog/log"
)
const (
scansFileName = "%d.xml"
scansMetadataFileName = "%d.json"
resultsPageLimit = 10000
httpRetryWaitMin = 1 * time.Second //nolint:revive
httpRetryWaitMax = 30 * time.Second
httpRetryMax = 4
scanReportCreateAttempts = 10
scanReportCreateMinSleep = 1 * time.Second
scanReportCreateMaxSleep = 5 * time.Minute
destQueryMappingFile = "query_mapping.json"
)
type ReportConsumeOutput struct {
Err error
ProjectID int
ScanID int
Record *metadata.Record
}
//nolint:gocyclo,funlen
func RunExport(args *Args) error {
consumerCount := worker.GetNumCPU()
log.Debug().
Str("url", args.URL).
Str("export", fmt.Sprintf("%v", args.Export)).
Str("queryMapping", args.QueryMappingFile).
Int("projectsActiveSince", args.ProjectsActiveSince).
Str("projectId", args.ProjectsIds).
Str("projectTeam", args.TeamName).
Bool("nestedTeams", args.NestedTeams).
Bool("debug", args.Debug).
Int("consumers", consumerCount).
Msg("starting export")
retryHTTPClient := getRetryHTTPClient()
// create api client
client, err := rest.NewSASTClient(args.URL, retryHTTPClient)
if err != nil {
return errors.Wrap(err, "could not create REST client")
}
// authenticate
log.Info().Msg("connecting to SAST")
if authErr := client.Authenticate(args.Username, args.Password); authErr != nil {
return errors.Wrap(authErr, "could not authenticate with SAST API")
}
// validate permissions
jwtClaims := jwt.MapClaims{}
_, _, jwtErr := new(jwt.Parser).ParseUnverified(client.Token.AccessToken, jwtClaims)
if jwtErr != nil {
return errors.Wrap(jwtErr, "permissions error - could not parse token")
}
permissionsValidateErr := validatePermissions(jwtClaims, args.Export)
if permissionsValidateErr != nil {
panic(fmt.Errorf("permissions error - %s", permissionsValidateErr.Error()))
}
// collect export data
log.Info().Msg("collecting data from SAST")
exportValues, exportCreateErr := export2.CreateExport(args.ProductName, args.RunTime)
if exportCreateErr != nil {
return errors.Wrap(exportCreateErr, "could not create export package")
}
if !args.Debug {
defer func(exportValues export2.Exporter) {
cleanErr := exportValues.Clean()
if cleanErr != nil {
log.Error().Err(cleanErr).Msg("error cleaning export temporary folder")
}
}(&exportValues)
}
soapClient := soap.NewClient(args.URL, client.Token, retryHTTPClient)
sourceRepo := sourcefile.NewRepo(soapClient)
methodLineRepo := methodline.NewRepo(soapClient)
queriesRepo := queries.NewRepo(soapClient)
presetRepo := presetrepo.NewRepo(soapClient)
installationRepo := installation.NewRepo(soapClient)
fetchInstallationErr := fetchInstallationData(client, installationRepo, &exportValues)
if fetchInstallationErr != nil {
return errors.Wrap(fetchInstallationErr, "could not fetch installation data")
}
astQueryMappingProvider, astQueryMappingProviderErr := querymapping.NewProvider(args.QueryMappingFile, retryHTTPClient)
if astQueryMappingProviderErr != nil {
return errors.Wrap(astQueryMappingProviderErr, "could not create AST query mapping provider")
}
astQueryProvider, astQueryProviderErr := astquery.NewProvider(queriesRepo, astQueryMappingProvider)
if astQueryProviderErr != nil {
return errors.Wrap(astQueryProviderErr, "could not create AST query provider")
}
presetProvider := preset.NewProvider(presetRepo)
similarityIDCalculator, similarityIDCalculatorErr := similarity.NewSimilarityIDCalculator()
if similarityIDCalculatorErr != nil {
return errors.Wrap(similarityIDCalculatorErr, "could not create similarity id calculator")
}
metadataTempDir, metadataTempDirErr := os.MkdirTemp("", args.ProductName)
if metadataTempDirErr != nil {
return errors.Wrap(metadataTempDirErr, "could not create metadata temporary folder")
}
defer func() {
metadataTempDirRemoveErr := os.RemoveAll(metadataTempDir)
if metadataTempDirRemoveErr != nil {
log.Error().Err(metadataTempDirRemoveErr)
}
}()
metadataSource := metadata.NewMetadataFactory(astQueryProvider, similarityIDCalculator, sourceRepo, methodLineRepo, metadataTempDir)
addErr := addCustomQueryIDs(astQueryProvider, astQueryMappingProvider)
if addErr != nil {
return errors.Wrap(addErr, "could not add custom query ids to mapping")
}
addFileErr := addQueryMappingFile(astQueryMappingProvider, &exportValues)
if addFileErr != nil {
return errors.Wrap(addFileErr, "could not add query mapping file")
}
fetchErr := fetchSelectedData(client, &exportValues, args, scanReportCreateAttempts, scanReportCreateMinSleep,
scanReportCreateMaxSleep, metadataSource, astQueryProvider, presetProvider)
if fetchErr != nil {
return errors.Wrap(fetchErr, "could not fetch selected data")
}
// export data to file
log.Info().Msg("exporting collected data")
exportFileName, exportErr := exportResultsToFile(args, &exportValues)
if exportErr != nil {
log.Error().Err(exportErr).Msg("error exporting collected data")
}
log.Info().Msgf("export completed to %s", exportFileName)
return nil
}
func exportResultsToFile(args *Args, exportValues export2.Exporter) (string, error) {
// create export package
tmpDir := exportValues.GetTmpDir()
if args.Debug {
if err := OpenPathInExplorer(tmpDir); err != nil {
log.Debug().Err(err)
}
return tmpDir, nil
}
exportFileName, _, exportErr := exportValues.CreateExportPackage(args.ProductName, args.OutputPath)
if exportErr != nil {
return exportFileName, exportErr
}
return exportFileName, exportErr
}
func validatePermissions(jwtClaims jwt.MapClaims, selectedExportOptions []string) error {
claimKeys := []string{"sast-permissions", "access-control-permissions"}
available, availableErr := permissions.GetFromJwtClaims(jwtClaims, claimKeys)
if availableErr != nil {
return availableErr
}
required := permissions.GetFromExportOptions(selectedExportOptions)
missing := permissions.GetMissing(required, available)
if len(missing) > 0 {
for _, permission := range missing {
description, descriptionErr := permissions.GetDescription(permission)
if descriptionErr != nil {
description = permission.(string)
log.Debug().Err(descriptionErr).Msg("could not get permission description")
}
log.Error().Msgf("missing permission %s", description)
}
return fmt.Errorf("please add missing permissions to your SAST user")
}
return nil
}
func fetchSelectedData(client rest.Client, exporter export2.Exporter, args *Args, retryAttempts int,
retryMinSleep, retryMaxSleep time.Duration, metadataProvider metadata.Provider,
astQueryProvider interfaces.ASTQueryProvider, presetProvider interfaces.PresetProvider,
) error {
var errProjects error
var projects []*rest.Project
options := sliceutils.ConvertStringToInterface(args.Export)
if sliceutils.Contains(export2.ProjectsOption, options) {
projects, errProjects = fetchProjectsData(client, exporter, args.ProjectsActiveSince, args.TeamName, args.ProjectsIds,
args.IsDefaultProjectActiveSince)
if errProjects != nil {
return errProjects
}
}
for _, exportOption := range export2.GetOptions() {
if sliceutils.Contains(exportOption, options) {
switch exportOption {
case export2.UsersOption:
if err := fetchUsersData(client, exporter, args); err != nil {
return err
}
case export2.TeamsOption:
if err := fetchTeamsData(client, exporter, args); err != nil {
return err
}
case export2.QueriesOption:
if err := fetchQueriesData(astQueryProvider, exporter); err != nil {
return err
}
case export2.PresetsOption:
if err := fetchPresetsData(client, presetProvider, exporter, projects, args.ProjectsIds); err != nil {
return err
}
case export2.ResultsOption:
if err := fetchResultsData(client, exporter, args.ProjectsActiveSince, retryAttempts, retryMinSleep,
retryMaxSleep, metadataProvider, args.TeamName, args.ProjectsIds, args); err != nil {
return err
}
}
}
}
return nil
}
func fetchUsersData(client rest.Client, exporter export2.Exporter, args *Args) error {
log.Info().Msg("collecting users")
users, usersErr := client.GetUsers()
if usersErr != nil {
return errors.Wrap(usersErr, "failed getting users")
}
teams, teamsErr := client.GetTeams()
if teamsErr != nil {
return errors.Wrap(teamsErr, "failed getting teams")
}
usersDataSource := export2.NewJSONDataSource(
export2.TransformUsers(users, teams, export2.TransformOptions{NestedTeams: args.NestedTeams}),
)
if err := exporter.AddFileWithDataSource(export2.UsersFileName, usersDataSource); err != nil {
return err
}
if err := exporter.AddFileWithDataSource(export2.RolesFileName, client.GetRoles); err != nil {
return err
}
if err := exporter.AddFileWithDataSource(export2.LdapRoleMappingsFileName, client.GetLdapRoleMappings); err != nil {
return err
}
if err := exporter.AddFileWithDataSource(export2.SamlRoleMappingsFileName, client.GetSamlRoleMappings); err != nil {
return err
}
if _, fileErr := os.Stat(export2.LdapServersFileName); os.IsNotExist(fileErr) {
if err := exporter.AddFileWithDataSource(export2.LdapServersFileName, client.GetLdapServers); err != nil {
return err
}
}
if _, fileErr := os.Stat(export2.SamlIdpFileName); os.IsNotExist(fileErr) {
if err := exporter.AddFileWithDataSource(export2.SamlIdpFileName, client.GetSamlIdentityProviders); err != nil {
return err
}
}
return nil
}
func fetchTeamsData(client rest.Client, exporter export2.Exporter, args *Args) error {
log.Info().Msg("collecting teams")
teams, teamsErr := client.GetTeams()
if teamsErr != nil {
return errors.Wrap(teamsErr, "failed getting teams")
}
transformOptions := export2.TransformOptions{NestedTeams: args.NestedTeams}
teamsDataSource := export2.NewJSONDataSource(export2.TransformTeams(teams, transformOptions))
if err := exporter.AddFileWithDataSource(export2.TeamsFileName, teamsDataSource); err != nil {
return err
}
if err := exporter.AddFileWithDataSource(export2.LdapTeamMappingsFileName, client.GetLdapTeamMappings); err != nil {
return err
}
samlTeamMappings, samlTeamMappingsErr := client.GetSamlTeamMappings()
if samlTeamMappingsErr != nil {
return errors.Wrap(samlTeamMappingsErr, "failed getting saml team mappings")
}
samlTeamMappingsDataSource := export2.NewJSONDataSource(export2.TransformSamlTeamMappings(samlTeamMappings, transformOptions))
if err := exporter.AddFileWithDataSource(export2.SamlTeamMappingsFileName, samlTeamMappingsDataSource); err != nil {
return err
}
if _, fileErr := os.Stat(export2.LdapServersFileName); os.IsNotExist(fileErr) {
if err := exporter.AddFileWithDataSource(export2.LdapServersFileName, client.GetLdapServers); err != nil {
return err
}
}
if _, fileErr := os.Stat(export2.SamlIdpFileName); os.IsNotExist(fileErr) {
if err := exporter.AddFileWithDataSource(export2.SamlIdpFileName, client.GetSamlIdentityProviders); err != nil {
return err
}
}
return nil
}
func fetchProjectsData(client rest.Client, exporter export2.Exporter, resultsProjectActiveSince int,
teamName, projectsIds string, isDefaultProjectActiveSince bool) ([]*rest.Project, error) {
log.Info().Msg("collecting projects")
projects := []*rest.Project{}
projectOffset := 0
projectLimit := resultsPageLimit
fromDate := getDateFrom(resultsProjectActiveSince, isDefaultProjectActiveSince, projectsIds)
for {
log.Debug().
Str("fromDate", fromDate).
Int("offset", projectOffset).
Int("limit", projectLimit).
Msg("fetching projects with custom fields")
log.Info().Msg("searching for projects...")
projectsItems, projectsErr := client.GetProjects(fromDate, teamName, projectsIds, projectOffset, projectLimit)
if projectsErr != nil {
return nil, errors.Wrap(projectsErr, "failed getting projects")
}
if len(projectsItems) == 0 {
break
}
projects = append(projects, projectsItems...)
// prepare to fetch next page
projectOffset += projectLimit
}
if err := exporter.AddFileWithDataSource(export2.ProjectsFileName,
export2.NewJSONDataSource(projects)); err != nil {
return nil, err
}
return projects, nil
}
func fetchInstallationData(restClient rest.Client, soapClient interfaces.InstallationProvider, exporter export2.Exporter) error {
log.Info().Msg("collecting installation details")
installationResp, errInstallations := soapClient.GetInstallationSettings()
if errInstallations != nil {
return errors.Wrap(errInstallations, "error with getting installation details")
}
installations := export2.TransformXMLInstallationMappings(installationResp)
if !export2.ContainsEngine(export2.InstallationEngineServiceName, installations) {
engineServersResp, errEngineServers := restClient.GetEngineServers()
if errEngineServers != nil {
return errors.Wrap(errEngineServers, "error with getting engine servers details")
}
engineServerInstallation := export2.TransformEngineServers(engineServersResp)
installations = append(installations, engineServerInstallation...)
}
installationMappingsDataSource := export2.NewJSONDataSource(installations)
return exporter.AddFileWithDataSource(export2.InstallationFileName, installationMappingsDataSource)
}
func fetchQueriesData(client interfaces.ASTQueryProvider, exporter export2.Exporter) error {
log.Info().Msg("collecting custom queries")
queryResp, err := client.GetCustomQueriesList()
if err != nil {
return errors.Wrap(err, "error with getting custom queries list")
}
queriesData, marshalErr := xml.MarshalIndent(queryResp, " ", " ")
if marshalErr != nil {
return errors.Wrap(marshalErr, "marshal error with getting custom queries list")
}
if errExp := exporter.AddFile(export2.QueriesFileName, queriesData); errExp != nil {
return errors.Wrap(errExp, "error with exporting custom queries list to file")
}
return nil
}
func fetchPresetsData(
client rest.Client,
soapClient interfaces.PresetProvider,
exporter export2.Exporter,
projects []*rest.Project, projectsIds string) error {
log.Info().Msg("collecting presets")
consumerCount := worker.GetNumCPU()
presetJobs := make(chan PresetJob)
presetList, listErr := client.GetPresets()
if listErr != nil {
return errors.Wrap(listErr, "error with getting preset list")
}
if projectsIds != "" {
presetList = filterPresetByProjectList(presetList, projects)
log.Info().Msgf("%d associated presets found", len(presetList))
}
if err := exporter.CreateDir(export2.PresetsDirName); err != nil {
return err
}
if err := exporter.AddFileWithDataSource(export2.PresetsFileName,
export2.NewJSONDataSource(presetList)); err != nil {
return err
}
// create and fetch preset by the list
go producePresets(presetList, presetJobs)
presetCount := len(presetList)
presetConsumeOutputs := make(chan PresetConsumeOutput, presetCount)
for consumerID := 1; consumerID <= consumerCount; consumerID++ {
go consumePresets(soapClient, exporter, consumerID, presetJobs, presetConsumeOutputs)
}
presetConsumeErrorCount := 0
for i := 0; i < presetCount; i++ {
presetOutput := <-presetConsumeOutputs
presetIndex := i + 1
if presetOutput.Err == nil {
log.Info().
Int("presetID", presetOutput.PresetID).
Msgf("collected preset %d/%d", presetIndex, presetCount)
} else {
presetConsumeErrorCount++
log.Warn().
Int("presetID", presetOutput.PresetID).
Msgf("failed collecting preset %d/%d", presetIndex, presetCount)
}
}
if presetConsumeErrorCount > 0 {
log.Warn().Msgf("failed collecting %d/%d presets", presetConsumeErrorCount, presetCount)
}
return nil
}
func fetchResultsData(client rest.Client, exporter export2.Exporter, resultsProjectActiveSince int,
retryAttempts int, retryMinSleep, retryMaxSleep time.Duration, metadataProvider metadata.Provider,
teamName, projectsIds string, args *Args,
) error {
consumerCount := worker.GetNumCPU()
reportJobs := make(chan ReportJob)
fromDate := getDateFrom(resultsProjectActiveSince, args.IsDefaultProjectActiveSince, projectsIds)
triagedScans, triagedScanErr := getTriagedScans(client, fromDate, teamName, projectsIds)
if triagedScanErr != nil {
return triagedScanErr
}
log.Debug().
Int("count", len(triagedScans)).
Str("scans", fmt.Sprintf("%v", triagedScans)).
Msg("last scans by project")
log.Info().Msgf("%d results found", len(triagedScans))
// create and fetch report for each scan
go produceReports(triagedScans, reportJobs)
reportCount := len(triagedScans)
reportConsumeOutputs := make(chan ReportConsumeOutput, reportCount)
for consumerID := 1; consumerID <= consumerCount; consumerID++ {
go consumeReports(client, exporter, consumerID, reportJobs, reportConsumeOutputs,
retryAttempts, retryMinSleep, retryMaxSleep, metadataProvider, args)
}
reportConsumeErrorCount := 0
for i := 0; i < reportCount; i++ {
consumeOutput := <-reportConsumeOutputs
reportIndex := i + 1
if consumeOutput.Err == nil {
log.Info().
Int("projectID", consumeOutput.ProjectID).
Int("scanID", consumeOutput.ScanID).
Msgf("collected result %d/%d", reportIndex, reportCount)
} else {
reportConsumeErrorCount++
log.Warn().
Int("projectID", consumeOutput.ProjectID).
Int("scanID", consumeOutput.ScanID).
Msgf("failed collecting result %d/%d", reportIndex, reportCount)
}
}
if reportConsumeErrorCount > 0 {
log.Warn().Msgf("failed collecting %d/%d results", reportConsumeErrorCount, reportCount)
}
return nil
}
func addAllResultsMappingToFile(metadataRecord []*metadata.Record, exporter export2.Exporter) error {
metadataResultsCSV := resultsmapping.GenerateCSV(metadataRecord)
metadataResultsCSVByte := resultsmapping.WriteAllToSanitizedCsv(metadataResultsCSV)
exportResultsErr := exporter.AddFile(export2.ResultsMappingFileName, metadataResultsCSVByte)
if exportResultsErr != nil {
return exportResultsErr
}
log.Info().Msg("collected results mapping")
return nil
}
func getTriagedScans(client rest.Client, fromDate, teamName, projectsIds string) ([]TriagedScan, error) {
var output []TriagedScan
projectOffset := 0
projectLimit := resultsPageLimit
for {
log.Debug().
Str("fromDate", fromDate).
Int("offset", projectOffset).
Int("limit", projectLimit).
Msg("fetching project last scans")
log.Info().Msg("searching for results...")
// fetch current page
projects, fetchErr := client.GetProjectsWithLastScanID(fromDate, teamName, projectsIds, projectOffset,
projectLimit)
if fetchErr != nil {
log.Debug().Err(fetchErr).Msg("failed fetching project last scans")
return output, fmt.Errorf("error searching for results")
}
if len(*projects) == 0 {
// all pages fetched
break
}
// process current page
log.Debug().
Int("count", len(*projects)).
Msg("processing project last scans")
for _, project := range *projects {
// get triaged results
triagedResults, triagedResultsErr := client.GetTriagedResultsByScanID(project.LastScanID)
if triagedResultsErr != nil {
log.Debug().Err(triagedResultsErr).
Int("projectID", project.ID).
Int("scanID", project.LastScanID).
Msg("failed fetching triaged results")
return output, triagedResultsErr
}
if len(*triagedResults) > 0 {
output = append(output, TriagedScan{project.ID, project.LastScanID})
}
}
// prepare to fetch next page
projectOffset += projectLimit
}
return output, nil
}
func produceReports(triagedScans []TriagedScan, reportJobs chan<- ReportJob) {
for _, scan := range triagedScans {
reportJobs <- ReportJob{
ProjectID: scan.ProjectID,
ScanID: scan.ScanID,
ReportType: rest.ScanReportTypeXML,
}
}
close(reportJobs)
}
func consumeReports(client rest.Client, exporter export2.Exporter, workerID int,
reportJobs <-chan ReportJob, done chan<- ReportConsumeOutput, maxAttempts int,
attemptMinSleep, attemptMaxSleep time.Duration, metadataProvider metadata.Provider, args *Args,
) {
for reportJob := range reportJobs {
l := log.With().
Int("ProjectID", reportJob.ProjectID).
Int("ScanID", reportJob.ScanID).
Int("worker", workerID).
Logger()
// create scan report
var reportData []byte
var reportCreateErr error
retry := rest.Retry{
Attempts: 10,
MinSleep: 1 * time.Second,
MaxSleep: 5 * time.Minute,
}
for i := 1; i <= maxAttempts; i++ {
reportData, reportCreateErr = client.CreateScanReport(reportJob.ScanID, reportJob.ReportType, retry)
if reportCreateErr != nil {
l.Debug().Err(reportCreateErr).
Int("attempt", i).
Msg("failed creating scan report")
time.Sleep(retryablehttp.DefaultBackoff(attemptMinSleep, attemptMaxSleep, i, nil))
} else {
break
}
}
if len(reportData) == 0 {
l.Debug().Err(reportCreateErr).Msgf("failed creating scan report after %d attempts", scanReportCreateAttempts)
done <- ReportConsumeOutput{Err: reportCreateErr, ProjectID: reportJob.ProjectID, ScanID: reportJob.ScanID}
continue
}
// generate metadata json
var reportReader report.CxXMLResults
unmarshalErr := xml.Unmarshal(reportData, &reportReader)
if unmarshalErr != nil {
done <- ReportConsumeOutput{Err: unmarshalErr, ProjectID: reportJob.ProjectID, ScanID: reportJob.ScanID}
continue
}
metadataQueries := metadata.GetQueriesFromReport(&reportReader)
metadataRecord, metadataRecordErr := metadataProvider.GetMetadataRecord(reportReader.ScanID, metadataQueries)
if metadataRecordErr != nil {
l.Debug().Err(metadataRecordErr).Msg("failed creating metadata")
done <- ReportConsumeOutput{Err: metadataRecordErr, ProjectID: reportJob.ProjectID, ScanID: reportJob.ScanID}
continue
}
metadataRecordJSON, metadataRecordJSONErr := json.Marshal(metadataRecord)
if metadataRecordJSONErr != nil {
l.Debug().Err(metadataRecordJSONErr).Msg("failed marshaling metadata")
done <- ReportConsumeOutput{Err: metadataRecordJSONErr, ProjectID: reportJob.ProjectID, ScanID: reportJob.ScanID}
continue
}
exportMetadataErr := exporter.AddFile(fmt.Sprintf(scansMetadataFileName, reportJob.ProjectID), metadataRecordJSON)
if exportMetadataErr != nil {
l.Debug().Err(metadataRecordJSONErr).Msg("failed saving metadata")
done <- ReportConsumeOutput{Err: metadataRecordJSONErr, ProjectID: reportJob.ProjectID, ScanID: reportJob.ScanID}
continue
}
// export report
transformedReportData, transformErr := export2.TransformScanReport(
reportData, export2.TransformOptions{NestedTeams: args.NestedTeams},
)
if transformErr != nil {
l.Debug().Err(transformErr).Msg("failed transforming report data")
done <- ReportConsumeOutput{Err: transformErr, ProjectID: reportJob.ProjectID, ScanID: reportJob.ScanID}
continue
}
exportErr := exporter.AddFile(fmt.Sprintf(scansFileName, reportJob.ProjectID), transformedReportData)
if exportErr != nil {
l.Debug().Err(exportErr).Msg("failed saving result")
done <- ReportConsumeOutput{Err: exportErr, ProjectID: reportJob.ProjectID, ScanID: reportJob.ScanID, Record: metadataRecord}
} else {
done <- ReportConsumeOutput{Err: nil, ProjectID: reportJob.ProjectID, ScanID: reportJob.ScanID, Record: metadataRecord}
}
}
}
func filterPresetByProjectList(presets []*rest.PresetShort, projects []*rest.Project) []*rest.PresetShort {
out := make([]*rest.PresetShort, 0)
for _, item := range presets {
if isIncludedPreset(projects, item) {
out = append(out, item)
}
}
return out
}
func isIncludedPreset(projects []*rest.Project, value *rest.PresetShort) bool {
for _, project := range projects {
if project.PresetID == value.ID {
return true
}
}
return false
}
func getPresetFileName(fileName string) string {
return path.Join(export2.PresetsDirName, fileName)
}
func producePresets(presetList []*rest.PresetShort, presetJobs chan<- PresetJob) {
for _, v := range presetList {
presetJobs <- PresetJob{
PresetID: v.ID,
}
}
close(presetJobs)
}
func consumePresets(soapClient interfaces.PresetProvider, exporter export2.Exporter, workerID int,
presetJobs <-chan PresetJob, done chan<- PresetConsumeOutput) {
for presetJob := range presetJobs {
l := log.With().
Int("PresetID", presetJob.PresetID).
Int("worker", workerID).
Logger()
presetData, presetErr := getPresetData(soapClient, presetJob.PresetID)
if presetErr != nil {
l.Debug().Err(presetErr).Msgf("failed creating preset %d", presetJob.PresetID)
done <- PresetConsumeOutput{Err: presetErr, PresetID: presetJob.PresetID}
continue
}
if errExp := exporter.AddFile(getPresetFileName(fmt.Sprintf("%d.xml", presetJob.PresetID)), presetData); errExp != nil {
err := errors.Wrapf(errExp, "error with exporting preset %d list to file", presetJob.PresetID)
done <- PresetConsumeOutput{Err: err, PresetID: presetJob.PresetID}
continue
}
done <- PresetConsumeOutput{Err: nil, PresetID: presetJob.PresetID}
}
}
func getPresetData(soapClient interfaces.PresetProvider, presetID int) ([]byte, error) {
presetResponse, err := soapClient.GetPresetDetails(presetID)
if err != nil {
return nil, errors.Wrap(err, "error with getting getPresetDetails")
}
presetData, marshalErr := xml.MarshalIndent(presetResponse, " ", " ")
if marshalErr != nil {
return nil, errors.Wrapf(marshalErr, "marshal error with getting preset %d", presetID)
}
return presetData, nil
}
func getRetryHTTPClient() *retryablehttp.Client {
return &retryablehttp.Client{
HTTPClient: cleanhttp.DefaultPooledClient(),
Logger: nil,
RetryWaitMin: httpRetryWaitMin,
RetryWaitMax: httpRetryWaitMax,
RetryMax: httpRetryMax,
CheckRetry: retryablehttp.DefaultRetryPolicy,
Backoff: retryablehttp.DefaultBackoff,
RequestLogHook: func(logger retryablehttp.Logger, request *http.Request, i int) {
log.Debug().
Str("method", request.Method).
Str("url", request.URL.String()).
Int("attempt", i+1).
Msg("request")
},
ResponseLogHook: func(logger retryablehttp.Logger, response *http.Response) {
log.Debug().
Str("method", response.Request.Method).
Str("url", response.Request.URL.String()).
Int("status", response.StatusCode).
Msg("response")
},
}
}
func addQueryMappingFile(queryMappingProvider interfaces.QueryMappingRepo, exporter export2.Exporter) error {
mapping := querymapping.MapSource{
Mappings: queryMappingProvider.GetMapping(),
}
return exporter.AddFileWithDataSource(destQueryMappingFile, export2.NewJSONDataSource(mapping))
}
func addCustomQueryIDs(astQueryProvider interfaces.ASTQueryProvider, astQueryMappingProvider interfaces.QueryMappingRepo) error {
customQueryResp, errResp := astQueryProvider.GetCustomQueriesList()
if errResp != nil {
return errResp
}
for i := range customQueryResp.GetQueryCollectionResult.QueryGroups.CxWSQueryGroup {
queryGroup := customQueryResp.GetQueryCollectionResult.QueryGroups.CxWSQueryGroup[i]
for j := range queryGroup.Queries.CxWSQuery {
query := queryGroup.Queries.CxWSQuery[j]
if err := astQueryMappingProvider.AddQueryMapping(queryGroup.LanguageName, query.Name,
queryGroup.Name, strconv.Itoa(query.QueryID)); err != nil {
return err
}
}
}
return nil
}
func getDateFrom(resultsProjectActiveSince int, isDefaultProjectActiveSince bool, projectIds string) string {
if isDefaultProjectActiveSince && projectIds != "" {
return ""
}
return GetDateFromDays(resultsProjectActiveSince, time.Now())
}