From 055738375dc4c2e6b763af87032e0851b4fd3ed8 Mon Sep 17 00:00:00 2001 From: David Roe Date: Tue, 24 Oct 2023 11:34:00 +0100 Subject: [PATCH 1/5] feat: add fail-on-severity flag --- internal/flag/options.go | 17 +++ internal/flag/report_flags.go | 55 +++++----- internal/report/output/security/security.go | 50 ++++----- .../report/output/security/security_test.go | 100 +++++++++++------- internal/types/severity.go | 3 + 5 files changed, 131 insertions(+), 94 deletions(-) diff --git a/internal/flag/options.go b/internal/flag/options.go index fa95fce18..40c047683 100644 --- a/internal/flag/options.go +++ b/internal/flag/options.go @@ -10,6 +10,9 @@ import ( "github.com/spf13/cobra" "github.com/spf13/pflag" "github.com/spf13/viper" + + "github.com/bearer/bearer/internal/types" + "github.com/bearer/bearer/internal/util/set" ) var ErrInvalidScannerReportCombination = errors.New("invalid scanner argument; privacy report requires sast scanner") @@ -177,6 +180,20 @@ func getInteger(flag *Flag) int { return viper.GetInt(flag.ConfigName) } +func getSeverities(flag *Flag) set.Set[string] { + result := set.New[string]() + + for _, value := range getStringSlice(flag) { + if !slices.Contains(types.Severities, value) { + return nil + } + + result.Add(value) + } + + return result +} + func (f *Flags) groups() []FlagGroup { var groups []FlagGroup // This order affects the usage message, so they are sorted by frequency of use. diff --git a/internal/flag/report_flags.go b/internal/flag/report_flags.go index e6e402e59..678c0ccc9 100644 --- a/internal/flag/report_flags.go +++ b/internal/flag/report_flags.go @@ -3,7 +3,7 @@ package flag import ( "errors" - "github.com/bearer/bearer/internal/types" + "github.com/bearer/bearer/internal/util/set" ) var ( @@ -26,11 +26,14 @@ var ( DefaultSeverity = "critical,high,medium,low,warning" ) -var ErrInvalidFormatSecurity = errors.New("invalid format argument for security report; supported values: json, yaml, sarif, gitlab-sast, rdjson, html") -var ErrInvalidFormatPrivacy = errors.New("invalid format argument for privacy report; supported values: csv, json, yaml, html") -var ErrInvalidFormatDefault = errors.New("invalid format argument; supported values: json, yaml") -var ErrInvalidReport = errors.New("invalid report argument; supported values: security, privacy") -var ErrInvalidSeverity = errors.New("invalid severity argument; supported values: critical, high, medium, low, warning") +var ( + ErrInvalidFormatSecurity = errors.New("invalid format argument for security report; supported values: json, yaml, sarif, gitlab-sast, rdjson, html") + ErrInvalidFormatPrivacy = errors.New("invalid format argument for privacy report; supported values: csv, json, yaml, html") + ErrInvalidFormatDefault = errors.New("invalid format argument; supported values: json, yaml") + ErrInvalidReport = errors.New("invalid report argument; supported values: security, privacy") + ErrInvalidSeverity = errors.New("invalid severity argument; supported values: critical, high, medium, low, warning") + ErrInvalidFailOnSeverity = errors.New("invalid fail-on-severity argument; supported values: critical, high, medium, low, warning") +) var ( FormatFlag = Flag{ @@ -58,6 +61,12 @@ var ( Value: DefaultSeverity, Usage: "Specify which severities are included in the report.", } + FailOnSeverityFlag = Flag{ + Name: "fail-on-severity", + ConfigName: "report.fail-on-severity", + Value: "critical,high,medium,low", + Usage: "Specify which severities cause the report to fail. Works in conjunction with --exit-code.", + } ExcludeFingerprintFlag = Flag{ Name: "exclude-fingerprint", ConfigName: "report.exclude-fingerprint", @@ -74,6 +83,7 @@ type ReportFlagGroup struct { Report *Flag Output *Flag Severity *Flag + FailOnSeverity *Flag ExcludeFingerprint *Flag } @@ -81,7 +91,8 @@ type ReportOptions struct { Format string `mapstructure:"format" json:"format" yaml:"format"` Report string `mapstructure:"report" json:"report" yaml:"report"` Output string `mapstructure:"output" json:"output" yaml:"output"` - Severity map[string]bool `mapstructure:"severity" json:"severity" yaml:"severity"` + Severity set.Set[string] `mapstructure:"severity" json:"severity" yaml:"severity"` + FailOnSeverity set.Set[string] `mapstructure:"fail-on-severity" json:"fail-on-severity" yaml:"fail-on-severity"` ExcludeFingerprint map[string]bool `mapstructure:"exclude_fingerprints" json:"exclude_fingerprints" yaml:"exclude_fingerprints"` } @@ -91,6 +102,7 @@ func NewReportFlagGroup() *ReportFlagGroup { Report: &ReportFlag, Output: &OutputFlag, Severity: &SeverityFlag, + FailOnSeverity: &FailOnSeverityFlag, ExcludeFingerprint: &ExcludeFingerprintFlag, } } @@ -105,6 +117,7 @@ func (f *ReportFlagGroup) Flags() []*Flag { f.Report, f.Output, f.Severity, + f.FailOnSeverity, f.ExcludeFingerprint, } } @@ -147,24 +160,13 @@ func (f *ReportFlagGroup) ToOptions() (ReportOptions, error) { return ReportOptions{}, invalidFormat } - severity := getStringSlice(f.Severity) - severityMapping := make(map[string]bool) - - for _, severityLevel := range severity { - switch severityLevel { - case types.LevelCritical: - severityMapping[types.LevelCritical] = true - case types.LevelHigh: - severityMapping[types.LevelHigh] = true - case types.LevelMedium: - severityMapping[types.LevelMedium] = true - case types.LevelLow: - severityMapping[types.LevelLow] = true - case types.LevelWarning: - severityMapping[types.LevelWarning] = true - default: - return ReportOptions{}, ErrInvalidSeverity - } + severity := getSeverities(f.Severity) + if severity == nil { + return ReportOptions{}, ErrInvalidSeverity + } + failOnSeverity := getSeverities(f.FailOnSeverity) + if failOnSeverity == nil { + return ReportOptions{}, ErrInvalidFailOnSeverity } // turn string slice into map for ease of access @@ -178,7 +180,8 @@ func (f *ReportFlagGroup) ToOptions() (ReportOptions, error) { Format: format, Report: report, Output: getString(f.Output), - Severity: severityMapping, + Severity: severity, + FailOnSeverity: failOnSeverity, ExcludeFingerprint: excludeFingerprintsMapping, }, nil } diff --git a/internal/report/output/security/security.go b/internal/report/output/security/security.go index bc9701ee4..4927f73bd 100644 --- a/internal/report/output/security/security.go +++ b/internal/report/output/security/security.go @@ -41,13 +41,6 @@ var severityColorFns = map[string]func(x ...interface{}) string{ globaltypes.LevelLow: color.New(color.FgBlue).SprintFunc(), globaltypes.LevelWarning: color.New(color.FgCyan).SprintFunc(), } -var orderedSeverityLevels = []string{ - globaltypes.LevelCritical, - globaltypes.LevelHigh, - globaltypes.LevelMedium, - globaltypes.LevelLow, - globaltypes.LevelWarning, -} type Findings = map[string][]types.Finding type IgnoredFindings = map[string][]types.IgnoredFinding @@ -89,11 +82,11 @@ func AddReportData( output.StdErrLog("Evaluating rules") } - builtInFingerprints, err := evaluateRules(summaryFindings, ignoredSummaryFindings, config.BuiltInRules, config, dataflow, baseBranchFindings, true) + builtInFingerprints, builtInFailed, err := evaluateRules(summaryFindings, ignoredSummaryFindings, config.BuiltInRules, config, dataflow, baseBranchFindings, true) if err != nil { return err } - fingerprints, err := evaluateRules(summaryFindings, ignoredSummaryFindings, config.Rules, config, dataflow, baseBranchFindings, false) + fingerprints, failed, err := evaluateRules(summaryFindings, ignoredSummaryFindings, config.Rules, config, dataflow, baseBranchFindings, false) if err != nil { return err } @@ -109,17 +102,9 @@ func AddReportData( ) } - // fail the report if we have failures above the severity threshold - reportFailed := false - for severityLevel, findings := range summaryFindings { - if severityLevel != globaltypes.LevelWarning && len(findings) != 0 { - reportFailed = true - } - } - reportData.FindingsBySeverity = summaryFindings reportData.IgnoredFindingsBySeverity = ignoredSummaryFindings - reportData.ReportFailed = reportFailed + reportData.ReportFailed = builtInFailed || failed return nil } @@ -131,7 +116,7 @@ func evaluateRules( dataflow *outputtypes.DataFlow, baseBranchFindings *basebranchfindings.Findings, builtIn bool, -) ([]string, error) { +) ([]string, bool, error) { outputFindings := map[string][]types.Finding{} ignoredOutputFindings := map[string][]types.IgnoredFinding{} @@ -141,6 +126,7 @@ func evaluateRules( } var fingerprints []string + failed := false for _, rule := range maputil.ToSortedSlice(rules) { if !builtIn { @@ -166,19 +152,19 @@ func evaluateRules( // TODO: perf question: can we do this once? policy.Modules.ToRegoModules()) if err != nil { - return fingerprints, err + return fingerprints, false, err } if len(rs) > 0 { jsonRes, err := json.Marshal(rs) if err != nil { - return fingerprints, err + return fingerprints, false, err } var results map[string][]Output err = json.Unmarshal(jsonRes, &results) if err != nil { - return fingerprints, err + return fingerprints, false, err } ruleSummary := &types.Rule{ @@ -236,7 +222,7 @@ func evaluateRules( severityMeta := CalculateSeverity(finding.CategoryGroups, rule.GetSeverity(), output.IsLocal != nil && *output.IsLocal) severity := severityMeta.DisplaySeverity - if config.Report.Severity[severity] { + if config.Report.Severity.Has(severity) { finding.SeverityMeta = severityMeta if ignored { ignoredOutputFindings[severity] = append(ignoredOutputFindings[severity], types.IgnoredFinding{Finding: finding, IgnoreMeta: ignoredFingerprint}) @@ -244,6 +230,10 @@ func evaluateRules( outputFindings[severity] = append(outputFindings[severity], finding) } } + + if config.Report.FailOnSeverity.Has(severity) && !ignored { + failed = true + } } } } @@ -251,7 +241,7 @@ func evaluateRules( sortFindingsBySeverity(summaryFindings, outputFindings) sortFindingsBySeverity(ignoredSummaryFindings, ignoredOutputFindings) - return fingerprints, nil + return fingerprints, failed, nil } func sortFindingsBySeverity[F types.GenericFinding](findingsBySeverity map[string][]F, outputFindings map[string][]F) { @@ -400,7 +390,7 @@ func BuildReportString(reportData *outputtypes.ReportData, config settings.Confi globaltypes.LevelWarning: make(map[string]bool), } - for _, severityLevel := range orderedSeverityLevels { + for _, severityLevel := range globaltypes.Severities { for _, failure := range reportData.FindingsBySeverity[severityLevel] { for i := 0; i < len(failure.CWEIDs); i++ { failures[severityLevel]["CWE-"+failure.CWEIDs[i]] = true @@ -661,7 +651,7 @@ func checkAndWriteFailureSummaryToString( findings Findings, ruleCount int, failures map[string]map[string]bool, - severityForFailure map[string]bool, + reportedSeverity set.Set[string], ) bool { reportStr.WriteString("\n=====================================") @@ -672,7 +662,7 @@ func checkAndWriteFailureSummaryToString( // give summary including counts failureCount := 0 warningCount := 0 - for _, severityLevel := range maps.Keys(severityForFailure) { + for _, severityLevel := range globaltypes.Severities { if severityLevel == globaltypes.LevelWarning { warningCount += len(findings[severityLevel]) continue @@ -687,8 +677,8 @@ func checkAndWriteFailureSummaryToString( reportStr.WriteString("\n\n") reportStr.WriteString(color.RedString(fmt.Sprint(ruleCount) + " checks, " + fmt.Sprint(failureCount+warningCount) + " findings\n")) - for _, severityLevel := range orderedSeverityLevels { - if !severityForFailure[severityLevel] { + for _, severityLevel := range globaltypes.Severities { + if !reportedSeverity.Has(severityLevel) { continue } reportStr.WriteString("\n" + formatSeverity(severityLevel) + fmt.Sprint(len(findings[severityLevel]))) @@ -756,7 +746,7 @@ func removeDuplicates[F types.GenericFinding](data map[string][]F) map[string][] reportedDetections := set.Set[key]{} // filter duplicates - for _, severity := range orderedSeverityLevels { + for _, severity := range globaltypes.Severities { findingsSlice, hasSeverity := data[severity] if !hasSeverity { continue diff --git a/internal/report/output/security/security_test.go b/internal/report/output/security/security_test.go index 8ed876153..fe5276a0e 100644 --- a/internal/report/output/security/security_test.go +++ b/internal/report/output/security/security_test.go @@ -10,6 +10,8 @@ import ( "github.com/bearer/bearer/internal/commands/process/settings" "github.com/bearer/bearer/internal/flag" "github.com/bearer/bearer/internal/report/schema" + globaltypes "github.com/bearer/bearer/internal/types" + "github.com/bearer/bearer/internal/util/set" "github.com/bearer/bearer/internal/version_check" dataflowtypes "github.com/bearer/bearer/internal/report/output/dataflow/types" @@ -20,16 +22,7 @@ import ( ) func TestBuildReportString(t *testing.T) { - config, err := generateConfig(flag.ReportOptions{ - Report: "security", - Severity: map[string]bool{ - "critical": true, - "high": true, - "medium": true, - "low": true, - "warning": true, - }, - }) + config, err := generateConfig(flag.ReportOptions{Report: "security"}) // set rule version config.BearerRulesVersion = "TEST" @@ -63,16 +56,7 @@ func TestBuildReportString(t *testing.T) { } func TestNoRulesBuildReportString(t *testing.T) { - config, err := generateConfig(flag.ReportOptions{ - Report: "security", - Severity: map[string]bool{ - "critical": true, - "high": true, - "medium": true, - "low": true, - "warning": true, - }, - }) + config, err := generateConfig(flag.ReportOptions{Report: "security"}) // set rule version config.BearerRulesVersion = "TEST" config.Rules = map[string]*settings.Rule{} @@ -101,16 +85,7 @@ func TestNoRulesBuildReportString(t *testing.T) { } func TestAddReportData(t *testing.T) { - config, err := generateConfig(flag.ReportOptions{ - Report: "security", - Severity: map[string]bool{ - "critical": true, - "high": true, - "medium": true, - "low": true, - "warning": true, - }, - }) + config, err := generateConfig(flag.ReportOptions{Report: "security"}) config.Rules = map[string]*settings.Rule{ "ruby_lang_ssl_verification": testhelper.RubyLangSSLVerificationRule(), @@ -132,15 +107,12 @@ func TestAddReportData(t *testing.T) { } func TestAddReportDataWithSeverity(t *testing.T) { + severity := set.New[string]() + severity.Add(globaltypes.LevelCritical) + config, err := generateConfig(flag.ReportOptions{ - Report: "security", - Severity: map[string]bool{ - "critical": true, - "high": false, - "medium": false, - "low": false, - "warning": false, - }, + Report: "security", + Severity: severity, }) if err != nil { @@ -159,6 +131,45 @@ func TestAddReportDataWithSeverity(t *testing.T) { cupaloy.SnapshotT(t, data.FindingsBySeverity) } +func TestAddReportDataWithFailOnSeverity(t *testing.T) { + for _, test := range []struct { + Severity string + Expected bool + }{ + {Severity: globaltypes.LevelCritical, Expected: true}, + {Severity: globaltypes.LevelHigh, Expected: true}, + {Severity: globaltypes.LevelMedium, Expected: false}, + {Severity: globaltypes.LevelLow, Expected: false}, + {Severity: globaltypes.LevelWarning, Expected: false}, + } { + t.Run(test.Severity, func(tt *testing.T) { + failOnSeverity := set.New[string]() + failOnSeverity.Add(test.Severity) + + config, err := generateConfig(flag.ReportOptions{ + Report: "security", + FailOnSeverity: failOnSeverity, + }) + + if err != nil { + tt.Fatalf("failed to generate config:%s", err) + } + + config.Rules = map[string]*settings.Rule{ + "ruby_rails_logger": testhelper.RubyRailsLoggerRule(), + "ruby_lang_ssl_verification": testhelper.RubyLangSSLVerificationRule(), + } + + data := dummyDataflowData() + if err = security.AddReportData(data, config, nil); err != nil { + tt.Fatalf("failed to generate security output err:%s", err) + } + + assert.Equal(tt, test.Expected, data.ReportFailed) + }) + } +} + func TestCalculateSeverity(t *testing.T) { res := []securitytypes.SeverityMeta{ security.CalculateSeverity([]string{"PHI", "Personal Data"}, "low", true), @@ -172,6 +183,19 @@ func TestCalculateSeverity(t *testing.T) { } func generateConfig(reportOptions flag.ReportOptions) (settings.Config, error) { + if reportOptions.Severity == nil { + reportOptions.Severity = set.New[string]() + reportOptions.Severity.AddAll(globaltypes.Severities) + } + + if reportOptions.FailOnSeverity == nil { + reportOptions.FailOnSeverity = set.New[string]() + reportOptions.FailOnSeverity.Add(globaltypes.LevelCritical) + reportOptions.FailOnSeverity.Add(globaltypes.LevelHigh) + reportOptions.FailOnSeverity.Add(globaltypes.LevelMedium) + reportOptions.FailOnSeverity.Add(globaltypes.LevelLow) + } + opts := flag.Options{ ScanOptions: flag.ScanOptions{ Scanner: []string{"sast"}, diff --git a/internal/types/severity.go b/internal/types/severity.go index ab8e2256a..5fcb366c1 100644 --- a/internal/types/severity.go +++ b/internal/types/severity.go @@ -5,3 +5,6 @@ var LevelHigh = "high" var LevelMedium = "medium" var LevelLow = "low" var LevelWarning = "warning" + +// these must be kept in order +var Severities = []string{LevelCritical, LevelHigh, LevelMedium, LevelLow, LevelWarning} From b8ac8b9bb52e83700a0b222afcdc04c08bfe93d6 Mon Sep 17 00:00:00 2001 From: David Roe Date: Tue, 24 Oct 2023 12:44:18 +0100 Subject: [PATCH 2/5] refactor: use single source of truth for severity levels --- internal/flag/report_flags.go | 13 ++++---- internal/util/slices/slices.go | 14 +++++++++ internal/util/slices/slices_suite_test.go | 13 ++++++++ internal/util/slices/slices_test.go | 36 +++++++++++++++++++++++ 4 files changed, 70 insertions(+), 6 deletions(-) create mode 100644 internal/util/slices/slices.go create mode 100644 internal/util/slices/slices_suite_test.go create mode 100644 internal/util/slices/slices_test.go diff --git a/internal/flag/report_flags.go b/internal/flag/report_flags.go index 678c0ccc9..9a1007a9c 100644 --- a/internal/flag/report_flags.go +++ b/internal/flag/report_flags.go @@ -2,8 +2,11 @@ package flag import ( "errors" + "strings" + globaltypes "github.com/bearer/bearer/internal/types" "github.com/bearer/bearer/internal/util/set" + sliceutil "github.com/bearer/bearer/internal/util/slices" ) var ( @@ -22,8 +25,6 @@ var ( ReportDetectors = "detectors" // nodoc: internal report type ReportSaaS = "saas" // nodoc: internal report type ReportStats = "stats" // nodoc: internal report type - - DefaultSeverity = "critical,high,medium,low,warning" ) var ( @@ -31,8 +32,8 @@ var ( ErrInvalidFormatPrivacy = errors.New("invalid format argument for privacy report; supported values: csv, json, yaml, html") ErrInvalidFormatDefault = errors.New("invalid format argument; supported values: json, yaml") ErrInvalidReport = errors.New("invalid report argument; supported values: security, privacy") - ErrInvalidSeverity = errors.New("invalid severity argument; supported values: critical, high, medium, low, warning") - ErrInvalidFailOnSeverity = errors.New("invalid fail-on-severity argument; supported values: critical, high, medium, low, warning") + ErrInvalidSeverity = errors.New("invalid severity argument; supported values: " + strings.Join(globaltypes.Severities, ", ")) + ErrInvalidFailOnSeverity = errors.New("invalid fail-on-severity argument; supported values: " + strings.Join(globaltypes.Severities, ", ")) ) var ( @@ -58,13 +59,13 @@ var ( SeverityFlag = Flag{ Name: "severity", ConfigName: "report.severity", - Value: DefaultSeverity, + Value: strings.Join(globaltypes.Severities, ","), Usage: "Specify which severities are included in the report.", } FailOnSeverityFlag = Flag{ Name: "fail-on-severity", ConfigName: "report.fail-on-severity", - Value: "critical,high,medium,low", + Value: strings.Join(sliceutil.Except(globaltypes.Severities, globaltypes.LevelWarning), ","), Usage: "Specify which severities cause the report to fail. Works in conjunction with --exit-code.", } ExcludeFingerprintFlag = Flag{ diff --git a/internal/util/slices/slices.go b/internal/util/slices/slices.go new file mode 100644 index 000000000..c4ceaf7fc --- /dev/null +++ b/internal/util/slices/slices.go @@ -0,0 +1,14 @@ +package slices + +// Except returns a copy of the slice with the specified value removed +func Except[T comparable](slice []T, value T) []T { + var result []T + + for _, candidate := range slice { + if candidate != value { + result = append(result, candidate) + } + } + + return result +} diff --git a/internal/util/slices/slices_suite_test.go b/internal/util/slices/slices_suite_test.go new file mode 100644 index 000000000..5465b3172 --- /dev/null +++ b/internal/util/slices/slices_suite_test.go @@ -0,0 +1,13 @@ +package slices_test + +import ( + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestSlices(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Slices Suite") +} diff --git a/internal/util/slices/slices_test.go b/internal/util/slices/slices_test.go new file mode 100644 index 000000000..e996ac345 --- /dev/null +++ b/internal/util/slices/slices_test.go @@ -0,0 +1,36 @@ +package slices_test + +import ( + "slices" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + + sliceutil "github.com/bearer/bearer/internal/util/slices" +) + +var _ = Describe("Except", func() { + slice := []string{"a", "b", "b"} + + When("the slice contains the value", func() { + It("returns a slice without any occurances of the value", func() { + Expect(sliceutil.Except(slice, "b")).To(Equal([]string{"a"})) + }) + + It("leaves the original slice unchanged", func() { + sliceutil.Except(slice, "b") + + Expect(slice).To(Equal([]string{"a", "b", "b"})) + }) + }) + + When("the slice does NOT contain the value", func() { + It("returns a copy of the original slice", func() { + new := sliceutil.Except(slice, "not-there") + Expect(new).To(Equal(slice)) + + new = slices.Delete(new, 0, 1) + Expect(new).NotTo(Equal(slice)) + }) + }) +}) From e45f1d37ac35e7a115e70bdee80b87181bb6083b Mon Sep 17 00:00:00 2001 From: David Roe Date: Tue, 24 Oct 2023 12:46:30 +0100 Subject: [PATCH 3/5] test: update help snapshot --- e2e/flags/.snapshots/TestMetadataFlags-help-scan | 9 +++++---- e2e/flags/.snapshots/TestMetadataFlags-scan-help | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/e2e/flags/.snapshots/TestMetadataFlags-help-scan b/e2e/flags/.snapshots/TestMetadataFlags-help-scan index e3e1a685f..ef1822a6f 100644 --- a/e2e/flags/.snapshots/TestMetadataFlags-help-scan +++ b/e2e/flags/.snapshots/TestMetadataFlags-help-scan @@ -10,10 +10,11 @@ Examples: Report Flags - -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) - --output string Specify the output path for the report. - --report string Specify the type of report (security, privacy, dataflow). (default "security") - --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") + --fail-on-severity string Specify which severities cause the report to fail. Works in conjunction with --exit-code. (default "critical,high,medium,low") + -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) + --output string Specify the output path for the report. + --report string Specify the type of report (security, privacy, dataflow). (default "security") + --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") Rule Flags --disable-default-rules Disables all default and built-in rules. diff --git a/e2e/flags/.snapshots/TestMetadataFlags-scan-help b/e2e/flags/.snapshots/TestMetadataFlags-scan-help index e3e1a685f..ef1822a6f 100644 --- a/e2e/flags/.snapshots/TestMetadataFlags-scan-help +++ b/e2e/flags/.snapshots/TestMetadataFlags-scan-help @@ -10,10 +10,11 @@ Examples: Report Flags - -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) - --output string Specify the output path for the report. - --report string Specify the type of report (security, privacy, dataflow). (default "security") - --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") + --fail-on-severity string Specify which severities cause the report to fail. Works in conjunction with --exit-code. (default "critical,high,medium,low") + -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) + --output string Specify the output path for the report. + --report string Specify the type of report (security, privacy, dataflow). (default "security") + --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") Rule Flags --disable-default-rules Disables all default and built-in rules. From b25f2504b94f231f23b5da4cd2748c6b6d4ac635 Mon Sep 17 00:00:00 2001 From: David Roe Date: Tue, 24 Oct 2023 12:47:46 +0100 Subject: [PATCH 4/5] docs: regenerate scan flags documentation --- docs/_data/bearer_scan.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/_data/bearer_scan.yaml b/docs/_data/bearer_scan.yaml index 13183751f..aa7bd5e49 100644 --- a/docs/_data/bearer_scan.yaml +++ b/docs/_data/bearer_scan.yaml @@ -45,6 +45,10 @@ options: default_value: '[]' usage: | Specify directories paths that contain .yaml files with external rules configuration + - name: fail-on-severity + default_value: critical,high,medium,low + usage: | + Specify which severities cause the report to fail. Works in conjunction with --exit-code. - name: force default_value: "false" usage: Disable the cache and runs the detections again From 1c777d2da680d78a74f00db1b84c3cb5017905a4 Mon Sep 17 00:00:00 2001 From: David Roe Date: Tue, 24 Oct 2023 12:54:10 +0100 Subject: [PATCH 5/5] test: update remaining snapshots --- e2e/flags/.snapshots/TestInitCommand | 1 + .../TestReportFlagsShouldFail-invalid-context-flag | 9 +++++---- ...TestReportFlagsShouldFail-invalid-format-flag-privacy | 9 +++++---- ...estReportFlagsShouldFail-invalid-format-flag-security | 9 +++++---- .../TestReportFlagsShouldFail-invalid-report-flag | 9 +++++---- 5 files changed, 21 insertions(+), 16 deletions(-) diff --git a/e2e/flags/.snapshots/TestInitCommand b/e2e/flags/.snapshots/TestInitCommand index 2f065aa79..a9eabefb7 100644 --- a/e2e/flags/.snapshots/TestInitCommand +++ b/e2e/flags/.snapshots/TestInitCommand @@ -1,6 +1,7 @@ disable-version-check: false log-level: info report: + fail-on-severity: critical,high,medium,low format: "" no-color: false output: "" diff --git a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-context-flag b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-context-flag index ed7a96957..ad0a7480b 100644 --- a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-context-flag +++ b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-context-flag @@ -11,10 +11,11 @@ Examples: Report Flags - -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) - --output string Specify the output path for the report. - --report string Specify the type of report (security, privacy, dataflow). (default "security") - --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") + --fail-on-severity string Specify which severities cause the report to fail. Works in conjunction with --exit-code. (default "critical,high,medium,low") + -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) + --output string Specify the output path for the report. + --report string Specify the type of report (security, privacy, dataflow). (default "security") + --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") Rule Flags --disable-default-rules Disables all default and built-in rules. diff --git a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-privacy b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-privacy index 199aa18d5..976a3f7bc 100644 --- a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-privacy +++ b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-privacy @@ -11,10 +11,11 @@ Examples: Report Flags - -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) - --output string Specify the output path for the report. - --report string Specify the type of report (security, privacy, dataflow). (default "security") - --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") + --fail-on-severity string Specify which severities cause the report to fail. Works in conjunction with --exit-code. (default "critical,high,medium,low") + -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) + --output string Specify the output path for the report. + --report string Specify the type of report (security, privacy, dataflow). (default "security") + --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") Rule Flags --disable-default-rules Disables all default and built-in rules. diff --git a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-security b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-security index bc5b25375..b3a1ea636 100644 --- a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-security +++ b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-security @@ -11,10 +11,11 @@ Examples: Report Flags - -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) - --output string Specify the output path for the report. - --report string Specify the type of report (security, privacy, dataflow). (default "security") - --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") + --fail-on-severity string Specify which severities cause the report to fail. Works in conjunction with --exit-code. (default "critical,high,medium,low") + -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) + --output string Specify the output path for the report. + --report string Specify the type of report (security, privacy, dataflow). (default "security") + --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") Rule Flags --disable-default-rules Disables all default and built-in rules. diff --git a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-report-flag b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-report-flag index 071e15d91..209752de7 100644 --- a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-report-flag +++ b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-report-flag @@ -11,10 +11,11 @@ Examples: Report Flags - -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) - --output string Specify the output path for the report. - --report string Specify the type of report (security, privacy, dataflow). (default "security") - --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") + --fail-on-severity string Specify which severities cause the report to fail. Works in conjunction with --exit-code. (default "critical,high,medium,low") + -f, --format string Specify report format (json, yaml, sarif, gitlab-sast, rdjson, html) + --output string Specify the output path for the report. + --report string Specify the type of report (security, privacy, dataflow). (default "security") + --severity string Specify which severities are included in the report. (default "critical,high,medium,low,warning") Rule Flags --disable-default-rules Disables all default and built-in rules.