-
Notifications
You must be signed in to change notification settings - Fork 29
Expand file tree
/
Copy pathscan.go
More file actions
2761 lines (2518 loc) · 90.2 KB
/
scan.go
File metadata and controls
2761 lines (2518 loc) · 90.2 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
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
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package commands
import (
"archive/zip"
"encoding/json"
"fmt"
"io"
"io/fs"
"io/ioutil"
"log"
"math"
"os"
"os/exec"
"path"
"path/filepath"
"reflect"
"regexp"
"slices"
"strconv"
"strings"
"time"
"github.com/checkmarx/ast-cli/internal/commands/asca"
"github.com/checkmarx/ast-cli/internal/commands/scarealtime"
"github.com/checkmarx/ast-cli/internal/commands/util"
"github.com/checkmarx/ast-cli/internal/commands/util/printer"
"github.com/checkmarx/ast-cli/internal/constants"
exitCodes "github.com/checkmarx/ast-cli/internal/constants/exit-codes"
"github.com/checkmarx/ast-cli/internal/logger"
"github.com/checkmarx/ast-cli/internal/services"
"github.com/google/shlex"
"github.com/google/uuid"
"github.com/pkg/errors"
"github.com/MakeNowJust/heredoc"
commonParams "github.com/checkmarx/ast-cli/internal/params"
"github.com/checkmarx/ast-cli/internal/wrappers"
"github.com/mssola/user_agent"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
const (
failedCreating = "Failed creating a scan"
failedGetting = "Failed showing a scan"
failedGettingTags = "Failed getting tags"
failedDeleting = "Failed deleting a scan"
failedCanceling = "Failed canceling a scan"
failedGettingAll = "Failed listing"
thresholdLog = "%s: Limit = %d, Current = %v"
thresholdMsgLog = "Threshold check finished with status %s : %s"
mbBytes = 1024.0 * 1024.0
notExploitable = "NOT_EXPLOITABLE"
ignored = "IGNORED"
git = "git"
invalidSSHSource = "provided source does not need a key. Make sure you are defining the right source or remove the flag --ssh-key"
errorUnzippingFile = "an error occurred while unzipping file. Reason: "
containerRun = "run"
containerVolumeFlag = "-v"
containerNameFlag = "--name"
containerRemove = "--rm"
containerImage = "checkmarx/kics:v2.1.3"
containerScan = "scan"
containerScanPathFlag = "-p"
containerScanPath = "/path"
containerScanOutputFlag = "-o"
containerScanOutput = "/path"
containerScanFormatFlag = "--report-formats"
containerScanFormatOutput = "json"
containerStarting = "Starting kics container"
containerFormatInfo = "The report format and output path cannot be overridden."
containerFolderRemoving = "Removing folder in temp"
containerCreateFolderError = "Error creating temporary directory"
containerWriteFolderError = " Error writing file to temporary directory"
containerFileSourceMissing = "--file is required for kics-realtime command"
containerFileSourceIncompatible = ". Provided file is not supported by kics"
containerFileSourceError = " Error reading file"
containerResultsFileFormat = "%s/results.json"
containerVolumeFormat = "%s:/path"
containerTempDirPattern = "kics"
kicsContainerPrefixName = "cli-kics-realtime-"
cleanupMaxRetries = 3
cleanupRetryWaitSeconds = 15
DanglingSymlinkError = "Skipping dangling symbolic link"
configFilterKey = "filter"
configFilterPlatforms = "platforms"
configIncremental = "incremental"
configFastScan = "fastScanMode"
configPresetName = "presetName"
configEngineVerbose = "engineVerbose"
configLanguageMode = "languageMode"
resultsMapValue = "value"
resultsMapType = "type"
trueString = "true"
configTwoms = "2ms"
falseString = "false"
maxPollingWaitTime = 60
engineNotAllowed = "It looks like the \"%s\" scan type does not exist or you are trying to run a scan without the \"%s\" package license." +
"\nTo use this feature, you would need to purchase a license." +
"\nPlease contact our support team for assistance if you believe you have already purchased a license." +
"\nLicensed packages: %s"
containerResolutionFileName = "containers-resolution.json"
directoryCreationPrefix = "cx-"
ScsScoreCardType = "scorecard"
ScsSecretDetectionType = "secret-detection"
ScsRepoRequiredMsg = "SCS scan failed to start: Scorecard scan is missing required flags, please include in the ast-cli arguments: " +
"--scs-repo-url your_repo_url --scs-repo-token your_repo_token"
ScsRepoWarningMsg = "SCS scan warning: Unable to start Scorecard scan due to missing required flags, please include in the ast-cli arguments: " +
"--scs-repo-url your_repo_url --scs-repo-token your_repo_token"
ScsScorecardUnsupportedHostWarningMsg = "SCS scan warning: Unable to run Scorecard scanner due to unsupported repo host. Currently, Scorecard can only run on GitHub Cloud repos."
)
var (
scaResolverResultsFile = ""
actualScanTypes = "sast,kics,sca,scs"
filterScanListFlagUsage = fmt.Sprintf(
"Filter the list of scans. Use ';' as the delimeter for arrays. Available filters are: %s",
strings.Join(
[]string{
commonParams.LimitQueryParam,
commonParams.OffsetQueryParam,
commonParams.ScanIDsQueryParam,
commonParams.TagsKeyQueryParam,
commonParams.TagsValueQueryParam,
commonParams.StatusesQueryParam,
commonParams.ProjectIDQueryParam,
commonParams.FromDateQueryParam,
commonParams.ToDateQueryParam,
}, ",",
),
)
aditionalParameters []string
kicsErrorCodes = []string{"50", "40", "30", "20"}
containerResolver wrappers.ContainerResolverWrapper
)
func NewScanCommand(
applicationsWrapper wrappers.ApplicationsWrapper,
scansWrapper wrappers.ScansWrapper,
exportWrapper wrappers.ExportWrapper,
resultsPdfReportsWrapper wrappers.ResultsPdfWrapper,
uploadsWrapper wrappers.UploadsWrapper,
resultsWrapper wrappers.ResultsWrapper,
projectsWrapper wrappers.ProjectsWrapper,
logsWrapper wrappers.LogsWrapper,
groupsWrapper wrappers.GroupsWrapper,
riskOverviewWrapper wrappers.RisksOverviewWrapper,
scsScanOverviewWrapper wrappers.ScanOverviewWrapper,
jwtWrapper wrappers.JWTWrapper,
scaRealTimeWrapper wrappers.ScaRealTimeWrapper,
policyWrapper wrappers.PolicyWrapper,
sastMetadataWrapper wrappers.SastMetadataWrapper,
accessManagementWrapper wrappers.AccessManagementWrapper,
featureFlagsWrapper wrappers.FeatureFlagsWrapper,
containerResolverWrapper wrappers.ContainerResolverWrapper,
) *cobra.Command {
scanCmd := &cobra.Command{
Use: "scan",
Short: "Manage scans",
Long: "The scan command enables the ability to manage scans in Checkmarx One.",
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://checkmarx.com/resource/documents/en/34965-68643-scan.html
`,
),
},
}
createScanCmd := scanCreateSubCommand(
scansWrapper,
exportWrapper,
resultsPdfReportsWrapper,
uploadsWrapper,
resultsWrapper,
projectsWrapper,
groupsWrapper,
riskOverviewWrapper,
scsScanOverviewWrapper,
jwtWrapper,
policyWrapper,
accessManagementWrapper,
applicationsWrapper,
featureFlagsWrapper,
)
containerResolver = containerResolverWrapper
listScansCmd := scanListSubCommand(scansWrapper, sastMetadataWrapper)
showScanCmd := scanShowSubCommand(scansWrapper)
scanASCACmd := scanASCASubCommand(jwtWrapper, featureFlagsWrapper)
workflowScanCmd := scanWorkflowSubCommand(scansWrapper)
deleteScanCmd := scanDeleteSubCommand(scansWrapper)
cancelScanCmd := scanCancelSubCommand(scansWrapper)
tagsCmd := scanTagsSubCommand(scansWrapper)
logsCmd := scanLogsSubCommand(logsWrapper)
kicsRealtimeCmd := scanRealtimeSubCommand()
scaRealtimeCmd := scarealtime.NewScaRealtimeCommand(scaRealTimeWrapper)
addFormatFlagToMultipleCommands(
[]*cobra.Command{listScansCmd, showScanCmd, workflowScanCmd},
printer.FormatTable, printer.FormatList, printer.FormatJSON,
)
addScanInfoFormatFlag(
createScanCmd, printer.FormatList, printer.FormatTable, printer.FormatJSON,
)
scanCmd.AddCommand(
createScanCmd,
scanASCACmd,
showScanCmd,
workflowScanCmd,
listScansCmd,
deleteScanCmd,
cancelScanCmd,
tagsCmd,
logsCmd,
kicsRealtimeCmd,
scaRealtimeCmd,
)
return scanCmd
}
func scanRealtimeSubCommand() *cobra.Command {
kicsContainerID := uuid.New()
viper.Set(commonParams.KicsContainerNameKey, kicsContainerPrefixName+kicsContainerID.String())
realtimeScanCmd := &cobra.Command{
Use: "kics-realtime",
Short: "Create and run kics scan",
Long: "The kics-realtime command enables the ability to create, run and retrieve results from a kics scan using a docker image.",
Example: heredoc.Doc(
`
$ cx scan kics-realtime --file <file> --additional-params <additional-params> --engine <engine>
`,
),
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-350af120-85fa-9f20-7051-6d605524b4fc
`,
),
},
RunE: runKicksRealtime(),
}
realtimeScanCmd.PersistentFlags().
StringSliceVar(
&aditionalParameters, commonParams.KicsRealtimeAdditionalParams, []string{},
"Additional scan options supported by kics. "+
"Should follow comma separated format. For example : --additional-params -v, --exclude-results,fec62a97d569662093dbb9739360942f",
)
realtimeScanCmd.PersistentFlags().String(
commonParams.KicsRealtimeFile,
"",
"Path to input file for kics realtime scanner",
)
realtimeScanCmd.PersistentFlags().String(
commonParams.KicsRealtimeEngine,
"docker",
"Name in the $PATH for the container engine to run kics. Example:podman.",
)
markFlagAsRequired(realtimeScanCmd, commonParams.KicsRealtimeFile)
return realtimeScanCmd
}
func scanLogsSubCommand(logsWrapper wrappers.LogsWrapper) *cobra.Command {
logsCmd := &cobra.Command{
Use: "logs",
Short: "Download scan log for selected scan type",
Long: "Accepts a scan-id and scan type (sast, iac-security) and downloads the related scan log",
Example: heredoc.Doc(
`
$ cx scan logs --scan-id <scan Id> --scan-type <sast | iac-security>
`,
),
RunE: runDownloadLogs(logsWrapper),
}
logsCmd.PersistentFlags().String(commonParams.ScanIDFlag, "", "Scan ID to retrieve log for.")
logsCmd.PersistentFlags().String(commonParams.ScanTypeFlag, "", "Scan type to pull log for, ex: sast, iac-security.")
markFlagAsRequired(logsCmd, commonParams.ScanIDFlag)
markFlagAsRequired(logsCmd, commonParams.ScanTypeFlag)
return logsCmd
}
func scanTagsSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
tagsCmd := &cobra.Command{
Use: "tags",
Short: "Get a list of all available tags to filter by",
Long: "The tags command enables the ability to provide a list of all the available tags in Checkmarx One.",
Example: heredoc.Doc(
`
$ cx scan tags
`,
),
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-d1d53a56-197a-6a16-95e5-c437e6dc060a
`,
),
},
RunE: runGetTagsCommand(scansWrapper),
}
return tagsCmd
}
func scanCancelSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
cancelScanCmd := &cobra.Command{
Use: "cancel",
Short: "Cancel one or more scans from running",
Long: "The cancel command enables the ability to cancel one or more running scans in Checkmarx One.",
Example: heredoc.Doc(
`
$ cx scan cancel --scan-id <scan ID>
`,
),
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-800f2022-3609-3f40-6f77-9371e54f8b71
`,
),
},
RunE: runCancelScanCommand(scansWrapper),
}
addScanIDFlag(cancelScanCmd, "One or more scan IDs to cancel, ex: <scan-id>,<scan-id>,...")
return cancelScanCmd
}
func scanDeleteSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
deleteScanCmd := &cobra.Command{
Use: "delete",
Short: "Deletes one or more scans",
Example: heredoc.Doc(
`
$ cx scan delete --scan-id <scan Id>
`,
),
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-851aa940-0454-ec17-4d29-42a2fa1352e0
`,
),
},
RunE: runDeleteScanCommand(scansWrapper),
}
addScanIDFlag(deleteScanCmd, "One or more scan IDs to delete, ex: <scan-id>,<scan-id>,...")
return deleteScanCmd
}
func scanWorkflowSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
workflowScanCmd := &cobra.Command{
Use: "workflow <scan id>",
Short: "Show information about a scan workflow",
Long: "The workflow command enables the ability to provide information about a requested scan workflow in Checkmarx One.",
Example: heredoc.Doc(
`
$ cx scan workflow --scan-id <scan Id>
`,
),
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-9a524fb7-0dba-314d-9068-ccea184bc8d9
`,
),
},
RunE: runScanWorkflowByIDCommand(scansWrapper),
}
addScanIDFlag(workflowScanCmd, "Scan ID to workflow.")
return workflowScanCmd
}
func scanShowSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
showScanCmd := &cobra.Command{
Use: "show",
Short: "Show information about a scan",
Long: "The show command enables the ability to show information about a requested scan in Checkmarx One.",
Example: heredoc.Doc(
`
$ cx scan show --scan-id <scan Id>
`,
),
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-c073d85b-7605-0c89-909c-7d5b9caaec16
`,
),
},
RunE: runGetScanByIDCommand(scansWrapper),
}
addScanIDFlag(showScanCmd, "Scan ID to show.")
return showScanCmd
}
func scanASCASubCommand(jwtWrapper wrappers.JWTWrapper, featureFlagsWrapper wrappers.FeatureFlagsWrapper) *cobra.Command {
scanASCACmd := &cobra.Command{
Hidden: true,
Use: "asca",
Short: "Run a ASCA scan",
Long: "Running a ASCA scan is a fast and efficient way to identify vulnerabilities in a specific file.",
Example: heredoc.Doc(
`
$ cx scan asca --file-source <path to a single file> --asca-latest-version
`,
),
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://docs.checkmarx.com/en/34965-68625-checkmarx-one-cli-commands.html
`,
),
},
RunE: asca.RunScanASCACommand(jwtWrapper),
}
scanASCACmd.PersistentFlags().Bool(commonParams.ASCALatestVersion, false,
"Use this flag to update to the latest version of the ASCA scanner."+
"Otherwise, we will check if there is an existing installation that can be used.")
scanASCACmd.PersistentFlags().StringP(
commonParams.SourcesFlag,
commonParams.SourcesFlagSh,
"",
"The file source should be the path to a single file",
)
return scanASCACmd
}
func scanListSubCommand(scansWrapper wrappers.ScansWrapper, sastMetadataWrapper wrappers.SastMetadataWrapper) *cobra.Command {
listScansCmd := &cobra.Command{
Use: "list",
Short: "List all scans in Checkmarx One",
Long: "The list command provides a list of all the scans in Checkmarx One.",
Example: heredoc.Doc(
`
$ cx scan list
`,
),
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-f92335a6-5b1c-e158-7914-2a4e72a2ada5
`,
),
},
RunE: runListScansCommand(scansWrapper, sastMetadataWrapper),
}
listScansCmd.PersistentFlags().StringSlice(commonParams.FilterFlag, []string{}, filterScanListFlagUsage)
return listScansCmd
}
func scanCreateSubCommand(
scansWrapper wrappers.ScansWrapper,
exportWrapper wrappers.ExportWrapper,
resultsPdfReportsWrapper wrappers.ResultsPdfWrapper,
uploadsWrapper wrappers.UploadsWrapper,
resultsWrapper wrappers.ResultsWrapper,
projectsWrapper wrappers.ProjectsWrapper,
groupsWrapper wrappers.GroupsWrapper,
risksOverviewWrapper wrappers.RisksOverviewWrapper,
scsScanOverviewWrapper wrappers.ScanOverviewWrapper,
jwtWrapper wrappers.JWTWrapper,
policyWrapper wrappers.PolicyWrapper,
accessManagementWrapper wrappers.AccessManagementWrapper,
applicationsWrapper wrappers.ApplicationsWrapper,
featureFlagsWrapper wrappers.FeatureFlagsWrapper,
) *cobra.Command {
createScanCmd := &cobra.Command{
Use: "create",
Short: "Create and run a new scan",
Long: "The create command enables the ability to create and run a new scan in Checkmarx One.",
Example: heredoc.Doc(
`
$ cx scan create --project-name <Project Name> -s <path or repository url>
`,
),
Annotations: map[string]string{
"command:doc": heredoc.Doc(
`
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-a0bb20d5-5182-3fb4-3da0-0e263344ffe7
`,
),
},
RunE: runCreateScanCommand(
scansWrapper,
exportWrapper,
resultsPdfReportsWrapper,
uploadsWrapper,
resultsWrapper,
projectsWrapper,
groupsWrapper,
risksOverviewWrapper,
scsScanOverviewWrapper,
jwtWrapper,
policyWrapper,
accessManagementWrapper,
applicationsWrapper,
featureFlagsWrapper,
),
}
createScanCmd.PersistentFlags().Bool(commonParams.AsyncFlag, false, "Do not wait for scan completion")
createScanCmd.PersistentFlags().IntP(
commonParams.WaitDelayFlag,
"",
commonParams.WaitDelayDefault,
"Polling wait time in seconds",
)
createScanCmd.PersistentFlags().Int(
commonParams.ScanTimeoutFlag,
0,
"Cancel the scan and fail after the timeout in minutes",
)
createScanCmd.PersistentFlags().StringP(
commonParams.SourcesFlag,
commonParams.SourcesFlagSh,
"",
"Sources like: directory, zip file or git URL.",
)
createScanCmd.PersistentFlags().StringP(
commonParams.SourceDirFilterFlag,
commonParams.SourceDirFilterFlagSh,
"",
"Source file filtering pattern",
)
createScanCmd.PersistentFlags().StringP(
commonParams.IncludeFilterFlag,
commonParams.IncludeFilterFlagSh,
"",
"Only files scannable by AST are included by default."+
" Add a comma separated list of extra inclusions, ex: *zip,file.txt",
)
createScanCmd.PersistentFlags().String(commonParams.ProjectName, "", "Name of the project")
err := createScanCmd.MarkPersistentFlagRequired(commonParams.ProjectName)
if err != nil {
log.Fatal(err)
}
createScanCmd.PersistentFlags().Bool(
commonParams.IncrementalSast,
false,
"Incremental SAST scan should be performed.",
)
createScanCmd.PersistentFlags().String(commonParams.PresetName, "", "The name of the Checkmarx preset to use.")
createScanCmd.PersistentFlags().String(
commonParams.ScaResolverFlag,
"",
"Resolve SCA project dependencies (path to SCA Resolver executable).",
)
createScanCmd.PersistentFlags().String(
commonParams.ScaResolverParamsFlag,
"",
fmt.Sprintf("Parameters to use in SCA resolver (requires --%s).", commonParams.ScaResolverFlag),
)
createScanCmd.PersistentFlags().String(commonParams.ContainerImagesFlag, "", "List of container images to scan, ex: manuelbcd/vulnapp:latest,debian:10. (Not supported yet)")
createScanCmd.PersistentFlags().String(commonParams.ScanTypes, "", "Scan types, ex: (sast,iac-security,sca,api-security)")
createScanCmd.PersistentFlags().String(commonParams.TagList, "", "List of tags, ex: (tagA,tagB:val,etc)")
createScanCmd.PersistentFlags().StringP(
commonParams.BranchFlag, commonParams.BranchFlagSh,
commonParams.Branch, commonParams.BranchFlagUsage,
)
createScanCmd.PersistentFlags().String(commonParams.SastFilterFlag, "", commonParams.SastFilterUsage)
createScanCmd.PersistentFlags().String(commonParams.IacsFilterFlag, "", commonParams.IacsFilterUsage)
createScanCmd.PersistentFlags().String(commonParams.KicsFilterFlag, "", commonParams.KicsFilterUsage)
err = createScanCmd.PersistentFlags().MarkDeprecated(commonParams.KicsFilterFlag, "please use the replacement flag --iac-security-filter")
if err != nil {
return nil
}
createScanCmd.PersistentFlags().StringSlice(
commonParams.KicsPlatformsFlag,
[]string{},
commonParams.KicsPlatformsFlagUsage,
)
createScanCmd.PersistentFlags().Bool(
commonParams.SastFastScanFlag,
false,
"Enable SAST Fast Scan configuration",
)
createScanCmd.PersistentFlags().StringSlice(
commonParams.IacsPlatformsFlag,
[]string{},
commonParams.IacsPlatformsFlagUsage,
)
err = createScanCmd.PersistentFlags().MarkDeprecated(commonParams.KicsPlatformsFlag, "please use the replacement flag --iac-security-platforms")
if err != nil {
return nil
}
createScanCmd.PersistentFlags().String(commonParams.ScaFilterFlag, "", commonParams.ScaFilterUsage)
createScanCmd.PersistentFlags().Bool(commonParams.SastRedundancyFlag, false, fmt.Sprintf(
"Populate SAST results 'data.redundancy' with values '%s' (to fix) or '%s' (no need to fix)", fixLabel, redundantLabel))
addResultFormatFlag(
createScanCmd,
printer.FormatSummaryConsole,
printer.FormatJSON,
printer.FormatSummary,
printer.FormatSarif,
printer.FormatSbom,
printer.FormatPDF,
printer.FormatSummaryMarkdown,
printer.FormatGLSast,
printer.FormatGLSca,
)
createScanCmd.PersistentFlags().String(commonParams.APIDocumentationFlag, "", apiDocumentationFlagDescription)
createScanCmd.PersistentFlags().String(commonParams.ExploitablePathFlag, "", exploitablePathFlagDescription)
createScanCmd.PersistentFlags().String(commonParams.LastSastScanTime, "", scaLastScanTimeFlagDescription)
createScanCmd.PersistentFlags().String(commonParams.ProjecPrivatePackageFlag, "", projectPrivatePackageFlagDescription)
createScanCmd.PersistentFlags().String(commonParams.ScaPrivatePackageVersionFlag, "", scaPrivatePackageVersionFlagDescription)
createScanCmd.PersistentFlags().String(commonParams.ReportFormatPdfToEmailFlag, "", pdfToEmailFlagDescription)
createScanCmd.PersistentFlags().String(commonParams.ReportSbomFormatFlag, services.DefaultSbomOption, sbomReportFlagDescription)
createScanCmd.PersistentFlags().String(commonParams.ReportFormatPdfOptionsFlag, defaultPdfOptionsDataSections, pdfOptionsFlagDescription)
createScanCmd.PersistentFlags().String(commonParams.TargetFlag, "cx_result", "Output file")
createScanCmd.PersistentFlags().String(commonParams.TargetPathFlag, ".", "Output Path")
createScanCmd.PersistentFlags().StringSlice(commonParams.FilterFlag, []string{}, filterResultsListFlagUsage)
createScanCmd.PersistentFlags().String(commonParams.ProjectGroupList, "", "List of groups to associate to project")
createScanCmd.PersistentFlags().String(commonParams.ProjectTagList, "", "List of tags to associate to project")
createScanCmd.PersistentFlags().String(
commonParams.Threshold,
"",
commonParams.ThresholdFlagUsage,
)
createScanCmd.PersistentFlags().Bool(
commonParams.ScanResubmit,
false,
"Create a scan with the configurations used in the most recent scan in the project",
)
createScanCmd.PersistentFlags().Int(
commonParams.PolicyTimeoutFlag,
commonParams.ScanPolicyDefaultTimeout,
"Cancel the policy evaluation and fail after the timeout in minutes",
)
createScanCmd.PersistentFlags().Bool(commonParams.IgnorePolicyFlag, false, "Do not evaluate policies")
createScanCmd.PersistentFlags().String(commonParams.ApplicationName, "", "Name of the application to assign with the project")
// Link the environment variables to the CLI argument(s).
err = viper.BindPFlag(commonParams.BranchKey, createScanCmd.PersistentFlags().Lookup(commonParams.BranchFlag))
if err != nil {
log.Fatal(err)
}
createScanCmd.PersistentFlags().String(commonParams.SSHKeyFlag, "", "Path to ssh private key")
createScanCmd.PersistentFlags().String(commonParams.SCSRepoTokenFlag, "", "Provide a token with read permission for the repo that you are scanning (for scorecard scans)")
createScanCmd.PersistentFlags().String(commonParams.SCSRepoURLFlag, "", "The URL of the repo that you are scanning with scs (for scorecard scans)")
createScanCmd.PersistentFlags().String(commonParams.SCSEnginesFlag, "", "Specify which scs engines will run (default: all licensed engines)")
createScanCmd.PersistentFlags().Bool(commonParams.ScaHideDevAndTestDepFlag, false, scaHideDevAndTestDepFlagDescription)
return createScanCmd
}
func setupScanTags(input *[]byte, cmd *cobra.Command) {
tagListStr, _ := cmd.Flags().GetString(commonParams.TagList)
tags := strings.Split(tagListStr, ",")
var info map[string]interface{}
_ = json.Unmarshal(*input, &info)
if _, ok := info["tags"]; !ok {
var tagMap map[string]interface{}
_ = json.Unmarshal([]byte("{}"), &tagMap)
info["tags"] = tagMap
}
for _, tag := range tags {
if len(tag) > 0 {
value := ""
keyValuePair := strings.Split(tag, ":")
if len(keyValuePair) > 1 {
value = keyValuePair[1]
}
info["tags"].(map[string]interface{})[keyValuePair[0]] = value
}
}
*input, _ = json.Marshal(info)
}
func setupScanTypeProjectAndConfig(
input *[]byte,
cmd *cobra.Command,
projectsWrapper wrappers.ProjectsWrapper,
groupsWrapper wrappers.GroupsWrapper,
scansWrapper wrappers.ScansWrapper,
applicationsWrapper wrappers.ApplicationsWrapper,
accessManagementWrapper wrappers.AccessManagementWrapper,
featureFlagsWrapper wrappers.FeatureFlagsWrapper,
jwtWrapper wrappers.JWTWrapper,
) error {
userAllowedEngines, _ := jwtWrapper.GetAllowedEngines(featureFlagsWrapper)
var info map[string]interface{}
newProjectName, _ := cmd.Flags().GetString(commonParams.ProjectName)
_ = json.Unmarshal(*input, &info)
info[resultsMapType] = getUploadType(cmd)
// Handle the project settings
if _, ok := info["project"]; !ok {
var projectMap map[string]interface{}
_ = json.Unmarshal([]byte("{}"), &projectMap)
info["project"] = projectMap
}
if newProjectName != "" {
info["project"].(map[string]interface{})["id"] = newProjectName
} else {
return errors.Errorf("Project name is required")
}
// We need to convert the project name into an ID
projectID, findProjectErr := services.FindProject(
info["project"].(map[string]interface{})["id"].(string),
cmd,
projectsWrapper,
groupsWrapper,
accessManagementWrapper,
applicationsWrapper,
featureFlagsWrapper,
)
if findProjectErr != nil {
return findProjectErr
}
info["project"].(map[string]interface{})["id"] = projectID
// Handle the scan configuration
var configArr []interface{}
resubmit, _ := cmd.Flags().GetBool(commonParams.ScanResubmit)
var resubmitConfig []wrappers.Config
if resubmit {
logger.PrintIfVerbose(
fmt.Sprintf(
"using latest scan configuration due to --%s flag",
commonParams.ScanResubmit,
),
)
userScanTypes, _ := cmd.Flags().GetString(commonParams.ScanTypes)
// Get the latest scan configuration
resubmitConfig, _ = getResubmitConfiguration(scansWrapper, projectID, userScanTypes)
} else if _, ok := info["config"]; !ok {
err := json.Unmarshal([]byte("[]"), &configArr)
if err != nil {
return err
}
}
containerEngineCLIEnabled, _ := wrappers.GetSpecificFeatureFlag(featureFlagsWrapper, wrappers.ContainerEngineCLIEnabled)
sastConfig := addSastScan(cmd, resubmitConfig)
if sastConfig != nil {
configArr = append(configArr, sastConfig)
}
var kicsConfig = addKicsScan(cmd, resubmitConfig)
if kicsConfig != nil {
configArr = append(configArr, kicsConfig)
}
var scaConfig = addScaScan(cmd, resubmitConfig, userAllowedEngines[commonParams.ContainersType])
if scaConfig != nil {
configArr = append(configArr, scaConfig)
}
var apiSecConfig = addAPISecScan(cmd)
if apiSecConfig != nil {
configArr = append(configArr, apiSecConfig)
}
var containersConfig = addContainersScan(containerEngineCLIEnabled.Status)
if containersConfig != nil {
configArr = append(configArr, containersConfig)
}
var SCSConfig, scsErr = addSCSScan(cmd, resubmitConfig, userAllowedEngines[commonParams.EnterpriseSecretsType])
if scsErr != nil {
return scsErr
} else if SCSConfig != nil {
configArr = append(configArr, SCSConfig)
}
info["config"] = configArr
var err2 error
*input, err2 = json.Marshal(info)
if err2 != nil {
return err2
}
return nil
}
func getResubmitConfiguration(scansWrapper wrappers.ScansWrapper, projectID, userScanTypes string) (
[]wrappers.Config,
error,
) {
var allScansModel *wrappers.ScansCollectionResponseModel
var errorModel *wrappers.ErrorModel
var err error
var config []wrappers.Config
params := make(map[string]string)
params["project-id"] = projectID
allScansModel, errorModel, err = scansWrapper.Get(params)
if err != nil {
return nil, errors.Wrapf(err, "get %s\n", failedGettingAll)
}
// Checking the response for errors
if errorModel != nil {
return nil, errors.Errorf(services.ErrorCodeFormat, failedGettingAll, errorModel.Code, errorModel.Message)
}
if len(allScansModel.Scans) > 0 {
scanModelResponse := allScansModel.Scans[0]
config = scanModelResponse.Metadata.Configs
engines := scanModelResponse.Engines
// Check if there are no scan types sent using the flags, and use the latest scan engine types
if userScanTypes == "" {
actualScanTypes = strings.Join(engines, ",")
}
}
return config, nil
}
func addSastScan(cmd *cobra.Command, resubmitConfig []wrappers.Config) map[string]interface{} {
// Check if SAST is enabled
if !scanTypeEnabled(commonParams.SastType) {
return nil
}
sastMapConfig := make(map[string]interface{})
sastConfig := wrappers.SastConfig{}
sastMapConfig[resultsMapType] = commonParams.SastType
sastFastScanChanged := cmd.Flags().Changed(commonParams.SastFastScanFlag)
sastIncrementalChanged := cmd.Flags().Changed(commonParams.IncrementalSast)
if sastFastScanChanged {
fastScan, _ := cmd.Flags().GetBool(commonParams.SastFastScanFlag)
sastConfig.FastScanMode = strconv.FormatBool(fastScan)
}
if sastIncrementalChanged {
incrementalVal, _ := cmd.Flags().GetBool(commonParams.IncrementalSast)
sastConfig.Incremental = strconv.FormatBool(incrementalVal)
}
sastConfig.PresetName, _ = cmd.Flags().GetString(commonParams.PresetName)
sastConfig.Filter, _ = cmd.Flags().GetString(commonParams.SastFilterFlag)
for _, config := range resubmitConfig {
if config.Type != commonParams.SastType {
continue
}
overrideSastConfigValue(sastFastScanChanged, sastIncrementalChanged, &sastConfig, config)
}
sastMapConfig[resultsMapValue] = &sastConfig
return sastMapConfig
}
func overrideSastConfigValue(sastFastScanChanged, sastIncrementalChanged bool, sastConfig *wrappers.SastConfig, config wrappers.Config) {
setIfEmpty := func(configValue *string, resubmitValue interface{}) {
if *configValue == "" && resubmitValue != nil {
*configValue = resubmitValue.(string)
}
}
if resubmitIncremental := config.Value[configIncremental]; resubmitIncremental != nil && !sastIncrementalChanged {
sastConfig.Incremental = resubmitIncremental.(string)
}
if resubmitFastScan := config.Value[configFastScan]; resubmitFastScan != nil && !sastFastScanChanged {
sastConfig.FastScanMode = resubmitFastScan.(string)
}
setIfEmpty(&sastConfig.PresetName, config.Value[configPresetName])
setIfEmpty(&sastConfig.Filter, config.Value[configFilterKey])
if resubmitEngineVerbose := config.Value[configEngineVerbose]; resubmitEngineVerbose != nil {
sastConfig.EngineVerbose = resubmitEngineVerbose.(string)
}
if resubmitLanguageMode := config.Value[configLanguageMode]; resubmitLanguageMode != nil {
sastConfig.LanguageMode = resubmitLanguageMode.(string)
}
}
func addKicsScan(cmd *cobra.Command, resubmitConfig []wrappers.Config) map[string]interface{} {
if scanTypeEnabled(commonParams.KicsType) {
kicsMapConfig := make(map[string]interface{})
kicsConfig := wrappers.KicsConfig{}
kicsMapConfig[resultsMapType] = commonParams.KicsType
kicsConfig.Filter = deprecatedFlagValue(cmd, commonParams.KicsFilterFlag, commonParams.IacsFilterFlag)
kicsConfig.Platforms = deprecatedFlagValue(cmd, commonParams.KicsPlatformsFlag, commonParams.IacsPlatformsFlag)
for _, config := range resubmitConfig {
if config.Type == commonParams.KicsType {
resubmitFilter := config.Value[configFilterKey]
if resubmitFilter != nil && kicsConfig.Filter == "" {
kicsConfig.Filter = resubmitFilter.(string)
}
resubmitPlatforms := config.Value[configFilterPlatforms]
if resubmitPlatforms != nil && kicsConfig.Platforms == "" {
kicsConfig.Platforms = resubmitPlatforms.(string)
}
}
}
kicsMapConfig[resultsMapValue] = &kicsConfig
return kicsMapConfig
}
return nil
}
func addScaScan(cmd *cobra.Command, resubmitConfig []wrappers.Config, hasContainerLicense bool) map[string]interface{} {
if scanTypeEnabled(commonParams.ScaType) {
scaMapConfig := make(map[string]interface{})
scaConfig := wrappers.ScaConfig{}
scaMapConfig[resultsMapType] = commonParams.ScaType
scaConfig.Filter, _ = cmd.Flags().GetString(commonParams.ScaFilterFlag)
scaConfig.LastSastScanTime, _ = cmd.Flags().GetString(commonParams.LastSastScanTime)
scaConfig.PrivatePackageVersion, _ = cmd.Flags().GetString(commonParams.ScaPrivatePackageVersionFlag)
if hasContainerLicense {
scaConfig.EnableContainersScan = false
}
exploitablePath, _ := cmd.Flags().GetString(commonParams.ExploitablePathFlag)
if exploitablePath != "" {
scaConfig.ExploitablePath = strings.ToLower(exploitablePath)
}
for _, config := range resubmitConfig {
if config.Type == commonParams.ScaType {
resubmitFilter := config.Value[configFilterKey]
if resubmitFilter != nil && scaConfig.Filter == "" {
scaConfig.Filter = resubmitFilter.(string)
}
}
}
scaMapConfig[resultsMapValue] = &scaConfig
return scaMapConfig
}
return nil
}
func addContainersScan(containerEngineCLIEnabled bool) map[string]interface{} {
if !scanTypeEnabled(commonParams.ContainersType) || !containerEngineCLIEnabled {
return nil
}
containerMapConfig := make(map[string]interface{})
containerMapConfig[resultsMapType] = commonParams.ContainersType
containerConfig := wrappers.ContainerConfig{}
containerMapConfig[resultsMapValue] = &containerConfig
return containerMapConfig
}
func addAPISecScan(cmd *cobra.Command) map[string]interface{} {
if scanTypeEnabled(commonParams.APISecurityType) {
apiSecMapConfig := make(map[string]interface{})
apiSecConfig := wrappers.APISecConfig{}
apiSecMapConfig[resultsMapType] = commonParams.APISecType
apiDocumentation, _ := cmd.Flags().GetString(commonParams.APIDocumentationFlag)
if apiDocumentation != "" {
apiSecConfig.SwaggerFilter = strings.ToLower(apiDocumentation)
}
apiSecMapConfig[resultsMapValue] = &apiSecConfig
return apiSecMapConfig
}
return nil
}
func createResubmitConfig(resubmitConfig []wrappers.Config, scsRepoToken, scsRepoURL string, hasEnterpriseSecretsLicense bool) wrappers.SCSConfig {
scsConfig := wrappers.SCSConfig{}
for _, config := range resubmitConfig {
resubmitTwoms := config.Value[configTwoms]
if resubmitTwoms != nil && hasEnterpriseSecretsLicense {
scsConfig.Twoms = resubmitTwoms.(string)
}
scsConfig.RepoURL = scsRepoURL
scsConfig.RepoToken = scsRepoToken
resubmitScoreCard := config.Value[ScsScoreCardType]
if resubmitScoreCard == trueString && scsRepoToken != "" && scsRepoURL != "" {
scsConfig.Scorecard = trueString
} else {
scsConfig.Scorecard = falseString
}
}
return scsConfig
}
func getSCSEnginesSelected(scsEngines string) (isScorecardSelected, isSecretDetectionSelected bool) {
if scsEngines == "" {
return true, true
}
scsEnginesTypes := strings.Split(scsEngines, ",")
for _, engineType := range scsEnginesTypes {
engineType = strings.TrimSpace(engineType)
switch engineType {
case ScsSecretDetectionType:
isSecretDetectionSelected = true
case ScsScoreCardType:
isScorecardSelected = true
}
}
return isScorecardSelected, isSecretDetectionSelected
}