Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions internal/commands/asca/asca-engine.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"github.com/checkmarx/ast-cli/internal/commands/util/printer"
commonParams "github.com/checkmarx/ast-cli/internal/params"
"github.com/checkmarx/ast-cli/internal/services"
"github.com/checkmarx/ast-cli/internal/services/realtimeengine"
"github.com/checkmarx/ast-cli/internal/wrappers"
"github.com/checkmarx/ast-cli/internal/wrappers/grpcs"
"github.com/checkmarx/ast-cli/internal/wrappers/utils"
Expand All @@ -30,6 +31,12 @@ func RunScanASCACommand(jwtWrapper wrappers.JWTWrapper) func(cmd *cobra.Command,
return err
}

severityFilterFlag, _ := cmd.Flags().GetString(commonParams.SeverityFilterFlag)
severityFilter, err := realtimeengine.ParseSeverityFilter(severityFilterFlag)
if err != nil {
return err
}

vorpal := strings.TrimSpace(viper.GetString(commonParams.ASCALocationKey))
if vorpal != "" {
vorpalLocation = vorpal
Expand All @@ -55,6 +62,9 @@ func RunScanASCACommand(jwtWrapper wrappers.JWTWrapper) func(cmd *cobra.Command,
if err != nil {
return err
}
if scanResult != nil && scanResult.Error == nil {
scanResult.ScanDetails = services.FilterScanDetailsBySeverity(scanResult.ScanDetails, severityFilter)
}
err = printer.Print(cmd.OutOrStdout(), scanResult, printer.FormatJSON)
if err != nil {
return err
Expand Down
43 changes: 43 additions & 0 deletions internal/commands/asca/severity-filter_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
package asca

import (
"strings"
"testing"

"github.com/checkmarx/ast-cli/internal/commands/util/printer"
commonParams "github.com/checkmarx/ast-cli/internal/params"
"github.com/checkmarx/ast-cli/internal/wrappers/mock"
"github.com/spf13/cobra"
)

func TestRunScanASCACommand_InvalidSeverityFilter_FailsBeforeScan(t *testing.T) {
cmd := &cobra.Command{}
cmd.Flags().String(commonParams.SourcesFlag, "data/python-vul-file.py", "")
cmd.Flags().Bool(commonParams.ASCALatestVersion, false, "")
cmd.Flags().String(commonParams.FormatFlag, printer.FormatJSON, "")
cmd.Flags().String(commonParams.SeverityFilterFlag, "critical,hgh", "")

err := RunScanASCACommand(&mock.JWTMockWrapper{})(cmd, []string{})
if err == nil {
t.Fatal("expected an error for an invalid severity-filter value")
}
if !strings.Contains(err.Error(), "invalid severity-filter value(s): hgh") {
t.Fatalf("unexpected error message: %v", err)
}
if !strings.Contains(err.Error(), "critical, high, medium, low, info") {
t.Fatalf("error should list accepted values: %v", err)
}
}

func TestRunScanASCACommand_EmptySeverityFilter_TreatedAsNoFilter(t *testing.T) {
cmd := &cobra.Command{}
cmd.Flags().String(commonParams.SourcesFlag, "", "")
cmd.Flags().Bool(commonParams.ASCALatestVersion, false, "")
cmd.Flags().String(commonParams.FormatFlag, printer.FormatJSON, "")
cmd.Flags().String(commonParams.SeverityFilterFlag, " ", "")

err := RunScanASCACommand(&mock.JWTMockWrapper{})(cmd, []string{})
if err != nil {
t.Fatalf("whitespace-only severity-filter must not error, got: %v", err)
}
}
9 changes: 9 additions & 0 deletions internal/commands/containers-realtime-engine.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"github.com/checkmarx/ast-cli/internal/commands/util/printer"
errorconstants "github.com/checkmarx/ast-cli/internal/constants/errors"
commonParams "github.com/checkmarx/ast-cli/internal/params"
"github.com/checkmarx/ast-cli/internal/services/realtimeengine"
"github.com/checkmarx/ast-cli/internal/services/realtimeengine/containersrealtime"
"github.com/checkmarx/ast-cli/internal/wrappers"
"github.com/spf13/cobra"
Expand All @@ -22,13 +23,21 @@ func RunScanContainersRealtimeCommand(

ignoredFilePathFlag, _ := cmd.Flags().GetString(commonParams.IgnoredFilePathFlag)

severityFilterFlag, _ := cmd.Flags().GetString(commonParams.SeverityFilterFlag)
severityFilter, err := realtimeengine.ParseSeverityFilter(severityFilterFlag)
if err != nil {
return err
}

containersRealtimeService := containersrealtime.NewContainersRealtimeService(jwtWrapper, featureFlagWrapper, realtimeScannerWrapper)

images, err := containersRealtimeService.RunContainersRealtimeScan(fileSourceFlag, ignoredFilePathFlag)
if err != nil {
return err
}

images.Images = containersrealtime.FilterImagesBySeverity(images.Images, severityFilter)

err = printer.Print(cmd.OutOrStdout(), images, printer.FormatJSON)
if err != nil {
return errorconstants.NewRealtimeEngineError("failed to return images").Error()
Expand Down
9 changes: 9 additions & 0 deletions internal/commands/iac-realtime-engine.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"github.com/checkmarx/ast-cli/internal/commands/util/printer"
errorconstants "github.com/checkmarx/ast-cli/internal/constants/errors"
commonParams "github.com/checkmarx/ast-cli/internal/params"
"github.com/checkmarx/ast-cli/internal/services/realtimeengine"
"github.com/checkmarx/ast-cli/internal/services/realtimeengine/iacrealtime"
"github.com/checkmarx/ast-cli/internal/wrappers"
"github.com/spf13/cobra"
Expand All @@ -22,13 +23,21 @@ func RunScanIacRealtimeCommand(
ignoredFilePathFlag, _ := cmd.Flags().GetString(commonParams.IgnoredFilePathFlag)
engine, _ := cmd.Flags().GetString(commonParams.EngineFlag)

severityFilterFlag, _ := cmd.Flags().GetString(commonParams.SeverityFilterFlag)
severityFilter, err := realtimeengine.ParseSeverityFilter(severityFilterFlag)
if err != nil {
return err
}

iacRealtimeService := iacrealtime.NewIacRealtimeService(jwtWrapper, featureFlagWrapper, iacrealtime.NewContainerManager())

results, err := iacRealtimeService.RunIacRealtimeScan(fileSourceFlag, engine, ignoredFilePathFlag)
if err != nil {
return err
}

results = iacrealtime.FilterResultsBySeverity(results, severityFilter)

err = printer.Print(cmd.OutOrStdout(), results, printer.FormatJSON)
if err != nil {
return errorconstants.NewRealtimeEngineError("failed to return IaC Realtime vulnerabilities").Error()
Expand Down
9 changes: 9 additions & 0 deletions internal/commands/oss-realtime-engine.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"github.com/checkmarx/ast-cli/internal/commands/util/printer"
errorconstants "github.com/checkmarx/ast-cli/internal/constants/errors"
commonParams "github.com/checkmarx/ast-cli/internal/params"
"github.com/checkmarx/ast-cli/internal/services/realtimeengine"
"github.com/checkmarx/ast-cli/internal/services/realtimeengine/ossrealtime"
"github.com/checkmarx/ast-cli/internal/wrappers"
"github.com/spf13/cobra"
Expand All @@ -22,13 +23,21 @@ func RunScanOssRealtimeCommand(

ignoredFilePathFlag, _ := cmd.Flags().GetString(commonParams.IgnoredFilePathFlag)

severityFilterFlag, _ := cmd.Flags().GetString(commonParams.SeverityFilterFlag)
severityFilter, err := realtimeengine.ParseSeverityFilter(severityFilterFlag)
if err != nil {
return err
}

ossRealtimeService := ossrealtime.NewOssRealtimeService(jwtWrapper, featureFlagWrapper, realtimeScannerWrapper)

packages, err := ossRealtimeService.RunOssRealtimeScan(fileSourceFlag, ignoredFilePathFlag)
if err != nil {
return err
}

packages.Packages = ossrealtime.FilterPackagesBySeverity(packages.Packages, severityFilter)

err = printer.Print(cmd.OutOrStdout(), packages, printer.FormatJSON)
if err != nil {
return errorconstants.NewRealtimeEngineError("failed to return packages").Error()
Expand Down
14 changes: 13 additions & 1 deletion internal/commands/scan.go
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,8 @@ func scanASCASubCommand(jwtWrapper wrappers.JWTWrapper, featureFlagsWrapper wrap
Example: heredoc.Doc(
`
$ cx scan asca --file-source <path to a single file> --asca-latest-version
$ cx scan asca --file-source <path to a single file> --ignored-file-path <path to ignored in file>
$ cx scan asca --file-source <path to a single file> --ignored-file-path <path to ignored in file>
$ cx scan asca --file-source <path to a single file> --severity-filter "critical,high"
`,
),
Annotations: map[string]string{
Expand All @@ -503,6 +504,7 @@ func scanASCASubCommand(jwtWrapper wrappers.JWTWrapper, featureFlagsWrapper wrap
)

scanASCACmd.PersistentFlags().String(commonParams.IgnoredFilePathFlag, "", "Path to a JSON file listing ignored ASCA findings")
scanASCACmd.PersistentFlags().String(commonParams.SeverityFilterFlag, "", commonParams.SeverityFilterFlagUsage)
scanASCACmd.PersistentFlags().String(commonParams.ASCALocationFlag, "", "Path to custom location where ASCA engine is installed")
_ = viper.BindPFlag(commonParams.ASCALocationKey, scanASCACmd.PersistentFlags().Lookup(commonParams.ASCALocationFlag))

Expand All @@ -522,6 +524,7 @@ func scanOssRealtimeSubCommand(
Example: heredoc.Doc(
`
$ cx scan oss-realtime -s <path to a manifest file> --ignored-file-path <path to ignored packages JSON>
$ cx scan oss-realtime -s <path to a manifest file> --severity-filter "critical,high"
`,
),
Annotations: map[string]string{
Expand All @@ -547,6 +550,8 @@ func scanOssRealtimeSubCommand(
"Path to a JSON file listing ignored packages",
)

scanOssRealtimeCmd.Flags().String(commonParams.SeverityFilterFlag, "", commonParams.SeverityFilterFlagUsage)

return scanOssRealtimeCmd
}

Expand All @@ -562,6 +567,7 @@ func scanIacRealtimeSubCommand(
Example: heredoc.Doc(
`
$ cx scan iac-realtime -s <path to a manifest file> --ignored-file-path <path to ignored iac vulnerabilities JSON file>
$ cx scan iac-realtime -s <path to a manifest file> --severity-filter "critical,high"
`,
),
Annotations: map[string]string{
Expand Down Expand Up @@ -593,6 +599,8 @@ func scanIacRealtimeSubCommand(
"Name of the container engine to run IaC-Realtime. (ex. docker, podman)",
)

scanIacRealtimeCmd.Flags().String(commonParams.SeverityFilterFlag, "", commonParams.SeverityFilterFlagUsage)

return scanIacRealtimeCmd
}

Expand All @@ -606,6 +614,7 @@ func scanContainersRealtimeSubCommand(realtimeScannerWrapper wrappers.RealtimeSc
`
$ cx scan containers-realtime -s <path to containers file>
$ cx scan containers-realtime -s <path to file> --ignored-file-path <path to ignored containers file>
$ cx scan containers-realtime -s <path to file> --severity-filter "critical,high"
`,
),
Annotations: map[string]string{
Expand All @@ -625,6 +634,7 @@ func scanContainersRealtimeSubCommand(realtimeScannerWrapper wrappers.RealtimeSc
"The file source should be the path to a single containers file (Dockerfile, docker-compose.yml, or Helm template)",
)
scanContainersRealtimeCmd.Flags().String(commonParams.IgnoredFilePathFlag, "", "Path to ignored containers file")
scanContainersRealtimeCmd.Flags().String(commonParams.SeverityFilterFlag, "", commonParams.SeverityFilterFlagUsage)

return scanContainersRealtimeCmd
}
Expand All @@ -641,6 +651,7 @@ func scanSecretsRealtimeSubCommand(
Example: heredoc.Doc(`
$ cx scan secrets-realtime -s <path to file>
$ cx scan secrets-realtime -s <path to file> --ignored-file-path <path to ignored secrets file>
$ cx scan secrets-realtime -s <path to file> --severity-filter "critical,high"
`),
Annotations: map[string]string{
"command:doc": heredoc.Doc(`
Expand All @@ -652,6 +663,7 @@ func scanSecretsRealtimeSubCommand(

scanSecretsRealtimeCmd.Flags().StringP(commonParams.SourcesFlag, "s", "", "Path to the file to scan")
scanSecretsRealtimeCmd.Flags().String(commonParams.IgnoredFilePathFlag, "", "Path to ignored secrets file")
scanSecretsRealtimeCmd.Flags().String(commonParams.SeverityFilterFlag, "", commonParams.SeverityFilterFlagUsage)

return scanSecretsRealtimeCmd
}
Expand Down
9 changes: 9 additions & 0 deletions internal/commands/secrets-realtime.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"github.com/checkmarx/ast-cli/internal/commands/util/printer"
errorconstants "github.com/checkmarx/ast-cli/internal/constants/errors"
commonParams "github.com/checkmarx/ast-cli/internal/params"
"github.com/checkmarx/ast-cli/internal/services/realtimeengine"
"github.com/checkmarx/ast-cli/internal/services/realtimeengine/secretsrealtime"
"github.com/checkmarx/ast-cli/internal/wrappers"
"github.com/spf13/cobra"
Expand All @@ -21,13 +22,21 @@ func RunScanSecretsRealtimeCommand(

ignoredFilePathFlag, _ := cmd.Flags().GetString(commonParams.IgnoredFilePathFlag)

severityFilterFlag, _ := cmd.Flags().GetString(commonParams.SeverityFilterFlag)
severityFilter, err := realtimeengine.ParseSeverityFilter(severityFilterFlag)
if err != nil {
return err
}

secretsRealtimeService := secretsrealtime.NewSecretsRealtimeService(jwtWrapper, featureFlagWrapper)

results, err := secretsRealtimeService.RunSecretsRealtimeScan(fileSourceFlag, ignoredFilePathFlag)
if err != nil {
return err
}

results = secretsrealtime.FilterResultsBySeverity(results, severityFilter)

err = printer.Print(cmd.OutOrStdout(), results, printer.FormatJSON)
if err != nil {
return errorconstants.NewRealtimeEngineError(err.Error()).Error()
Expand Down
Loading
Loading