From a504113186e051c140400cfa7b67fb893c74d23e Mon Sep 17 00:00:00 2001 From: mmetc <92726601+mmetc@users.noreply.github.com> Date: Wed, 3 Jan 2024 10:55:41 +0100 Subject: [PATCH] lint (wsl) (#2692) --- cmd/crowdsec-cli/completion.go | 4 +-- cmd/crowdsec-cli/config_backup.go | 19 +++++++--- cmd/crowdsec-cli/config_feature_flags.go | 3 ++ cmd/crowdsec-cli/config_restore.go | 16 +++++++-- cmd/crowdsec-cli/config_show.go | 4 +++ cmd/crowdsec-cli/console.go | 4 +++ cmd/crowdsec-cli/console_table.go | 2 ++ cmd/crowdsec-cli/copyfile.go | 10 ++++++ cmd/crowdsec-cli/dashboard.go | 26 ++++++++++++++ cmd/crowdsec-cli/decisions.go | 45 ++++++++++++++++-------- cmd/crowdsec-cli/decisions_import.go | 10 ++++++ cmd/crowdsec-cli/itemcli.go | 8 +++++ cmd/crowdsec-cli/items.go | 7 ++++ pkg/alertcontext/config.go | 3 ++ pkg/csplugin/broker_test.go | 10 ++++++ pkg/hubtest/hubtest_item.go | 8 ++++- test/bats/90_decisions.bats | 4 +-- 17 files changed, 156 insertions(+), 27 deletions(-) diff --git a/cmd/crowdsec-cli/completion.go b/cmd/crowdsec-cli/completion.go index fd76b571d..7b6531f55 100644 --- a/cmd/crowdsec-cli/completion.go +++ b/cmd/crowdsec-cli/completion.go @@ -7,8 +7,7 @@ import ( ) func NewCompletionCmd() *cobra.Command { - - var completionCmd = &cobra.Command{ + completionCmd := &cobra.Command{ Use: "completion [bash|zsh|powershell|fish]", Short: "Generate completion script", Long: `To load completions: @@ -82,5 +81,6 @@ func NewCompletionCmd() *cobra.Command { } }, } + return completionCmd } diff --git a/cmd/crowdsec-cli/config_backup.go b/cmd/crowdsec-cli/config_backup.go index 8ebaa1744..9414fa510 100644 --- a/cmd/crowdsec-cli/config_backup.go +++ b/cmd/crowdsec-cli/config_backup.go @@ -14,9 +14,6 @@ import ( ) func backupHub(dirPath string) error { - var itemDirectory string - var upstreamParsers []string - hub, err := require.Hub(csConfig, nil, nil) if err != nil { return err @@ -26,16 +23,20 @@ func backupHub(dirPath string) error { clog := log.WithFields(log.Fields{ "type": itemType, }) + itemMap := hub.GetItemMap(itemType) if itemMap == nil { clog.Infof("No %s to backup.", itemType) continue } - itemDirectory = fmt.Sprintf("%s/%s/", dirPath, itemType) + + itemDirectory := fmt.Sprintf("%s/%s/", dirPath, itemType) if err = os.MkdirAll(itemDirectory, os.ModePerm); err != nil { return fmt.Errorf("error while creating %s : %s", itemDirectory, err) } - upstreamParsers = []string{} + + upstreamParsers := []string{} + for k, v := range itemMap { clog = clog.WithFields(log.Fields{ "file": v.Name, @@ -54,28 +55,36 @@ func backupHub(dirPath string) error { return fmt.Errorf("error while creating stage dir %s : %s", fstagedir, err) } } + clog.Debugf("[%s]: backing up file (tainted:%t local:%t up-to-date:%t)", k, v.State.Tainted, v.State.IsLocal(), v.State.UpToDate) + tfile := fmt.Sprintf("%s%s/%s", itemDirectory, v.Stage, v.FileName) if err = CopyFile(v.State.LocalPath, tfile); err != nil { return fmt.Errorf("failed copy %s %s to %s : %s", itemType, v.State.LocalPath, tfile, err) } + clog.Infof("local/tainted saved %s to %s", v.State.LocalPath, tfile) + continue } + clog.Debugf("[%s] : from hub, just backup name (up-to-date:%t)", k, v.State.UpToDate) clog.Infof("saving, version:%s, up-to-date:%t", v.Version, v.State.UpToDate) upstreamParsers = append(upstreamParsers, v.Name) } //write the upstream items upstreamParsersFname := fmt.Sprintf("%s/upstream-%s.json", itemDirectory, itemType) + upstreamParsersContent, err := json.MarshalIndent(upstreamParsers, "", " ") if err != nil { return fmt.Errorf("failed marshaling upstream parsers : %s", err) } + err = os.WriteFile(upstreamParsersFname, upstreamParsersContent, 0o644) if err != nil { return fmt.Errorf("unable to write to %s %s : %s", itemType, upstreamParsersFname, err) } + clog.Infof("Wrote %d entries for %s to %s", len(upstreamParsers), itemType, upstreamParsersFname) } diff --git a/cmd/crowdsec-cli/config_feature_flags.go b/cmd/crowdsec-cli/config_feature_flags.go index 838d8a0c1..fbba1f567 100644 --- a/cmd/crowdsec-cli/config_feature_flags.go +++ b/cmd/crowdsec-cli/config_feature_flags.go @@ -44,6 +44,7 @@ func runConfigFeatureFlags(cmd *cobra.Command, args []string) error { if feat.State == fflag.RetiredState { fmt.Printf("\n %s %s", magenta("RETIRED"), feat.DeprecationMsg) } + fmt.Println() } @@ -58,10 +59,12 @@ func runConfigFeatureFlags(cmd *cobra.Command, args []string) error { retired = append(retired, feat) continue } + if feat.IsEnabled() { enabled = append(enabled, feat) continue } + disabled = append(disabled, feat) } diff --git a/cmd/crowdsec-cli/config_restore.go b/cmd/crowdsec-cli/config_restore.go index 1d8414109..e9c2fa9aa 100644 --- a/cmd/crowdsec-cli/config_restore.go +++ b/cmd/crowdsec-cli/config_restore.go @@ -35,21 +35,26 @@ func restoreHub(dirPath string) error { } /*restore the upstream items*/ upstreamListFN := fmt.Sprintf("%s/upstream-%s.json", itemDirectory, itype) + file, err := os.ReadFile(upstreamListFN) if err != nil { return fmt.Errorf("error while opening %s : %s", upstreamListFN, err) } + var upstreamList []string + err = json.Unmarshal(file, &upstreamList) if err != nil { return fmt.Errorf("error unmarshaling %s : %s", upstreamListFN, err) } + for _, toinstall := range upstreamList { item := hub.GetItem(itype, toinstall) if item == nil { log.Errorf("Item %s/%s not found in hub", itype, toinstall) continue } + err := item.Install(false, false) if err != nil { log.Errorf("Error while installing %s : %s", toinstall, err) @@ -61,23 +66,28 @@ func restoreHub(dirPath string) error { if err != nil { return fmt.Errorf("failed enumerating files of %s : %s", itemDirectory, err) } + for _, file := range files { //this was the upstream data if file.Name() == fmt.Sprintf("upstream-%s.json", itype) { continue } + if itype == cwhub.PARSERS || itype == cwhub.POSTOVERFLOWS { //we expect a stage here if !file.IsDir() { continue } + stage := file.Name() stagedir := fmt.Sprintf("%s/%s/%s/", csConfig.ConfigPaths.ConfigDir, itype, stage) log.Debugf("Found stage %s in %s, target directory : %s", stage, itype, stagedir) + if err = os.MkdirAll(stagedir, os.ModePerm); err != nil { return fmt.Errorf("error while creating stage directory %s : %s", stagedir, err) } - /*find items*/ + + // find items ifiles, err := os.ReadDir(itemDirectory + "/" + stage + "/") if err != nil { return fmt.Errorf("failed enumerating files of %s : %s", itemDirectory+"/"+stage, err) @@ -86,10 +96,12 @@ func restoreHub(dirPath string) error { for _, tfile := range ifiles { log.Infof("Going to restore local/tainted [%s]", tfile.Name()) sourceFile := fmt.Sprintf("%s/%s/%s", itemDirectory, stage, tfile.Name()) + destinationFile := fmt.Sprintf("%s%s", stagedir, tfile.Name()) if err = CopyFile(sourceFile, destinationFile); err != nil { return fmt.Errorf("failed copy %s %s to %s : %s", itype, sourceFile, destinationFile, err) } + log.Infof("restored %s to %s", sourceFile, destinationFile) } } else { @@ -101,9 +113,9 @@ func restoreHub(dirPath string) error { } log.Infof("restored %s to %s", sourceFile, destinationFile) } - } } + return nil } diff --git a/cmd/crowdsec-cli/config_show.go b/cmd/crowdsec-cli/config_show.go index 1fd795c87..bab911cc3 100644 --- a/cmd/crowdsec-cli/config_show.go +++ b/cmd/crowdsec-cli/config_show.go @@ -24,6 +24,7 @@ func showConfigKey(key string) error { opts := []expr.Option{} opts = append(opts, exprhelpers.GetExprOptions(map[string]interface{}{})...) opts = append(opts, expr.Env(Env{})) + program, err := expr.Compile(key, opts...) if err != nil { return err @@ -52,6 +53,7 @@ func showConfigKey(key string) error { fmt.Printf("%s\n", string(data)) } + return nil } @@ -211,6 +213,7 @@ func runConfigShow(cmd *cobra.Command, args []string) error { if err != nil { return err } + err = tmp.Execute(os.Stdout, csConfig) if err != nil { return err @@ -230,6 +233,7 @@ func runConfigShow(cmd *cobra.Command, args []string) error { fmt.Printf("%s\n", string(data)) } + return nil } diff --git a/cmd/crowdsec-cli/console.go b/cmd/crowdsec-cli/console.go index adba5305a..ad17a1316 100644 --- a/cmd/crowdsec-cli/console.go +++ b/cmd/crowdsec-cli/console.go @@ -262,6 +262,7 @@ func SetConsoleOpts(args []string, wanted bool) error { log.Infof("%s set to %t", csconfig.CONSOLE_MANAGEMENT, wanted) csConfig.API.Server.ConsoleConfig.ConsoleManagement = ptr.Of(wanted) } + if csConfig.API.Server.OnlineClient.Credentials != nil { changed := false if wanted && csConfig.API.Server.OnlineClient.Credentials.PapiURL == "" { @@ -271,12 +272,15 @@ func SetConsoleOpts(args []string, wanted bool) error { changed = true csConfig.API.Server.OnlineClient.Credentials.PapiURL = "" } + if changed { fileContent, err := yaml.Marshal(csConfig.API.Server.OnlineClient.Credentials) if err != nil { return fmt.Errorf("cannot marshal credentials: %s", err) } + log.Infof("Updating credentials file: %s", csConfig.API.Server.OnlineClient.CredentialsFilePath) + err = os.WriteFile(csConfig.API.Server.OnlineClient.CredentialsFilePath, fileContent, 0o600) if err != nil { return fmt.Errorf("cannot write credentials file: %s", err) diff --git a/cmd/crowdsec-cli/console_table.go b/cmd/crowdsec-cli/console_table.go index f6778d625..fa2559daa 100644 --- a/cmd/crowdsec-cli/console_table.go +++ b/cmd/crowdsec-cli/console_table.go @@ -46,12 +46,14 @@ func cmdConsoleStatusTable(out io.Writer, csConfig csconfig.Config) { if *csConfig.API.Server.ConsoleConfig.ShareContext { activated = string(emoji.CheckMarkButton) } + t.AddRow(option, activated, "Send context with alerts to the console") case csconfig.CONSOLE_MANAGEMENT: activated := string(emoji.CrossMark) if *csConfig.API.Server.ConsoleConfig.ConsoleManagement { activated = string(emoji.CheckMarkButton) } + t.AddRow(option, activated, "Receive decisions from console") } } diff --git a/cmd/crowdsec-cli/copyfile.go b/cmd/crowdsec-cli/copyfile.go index 4de6cd6e2..f6a8513e6 100644 --- a/cmd/crowdsec-cli/copyfile.go +++ b/cmd/crowdsec-cli/copyfile.go @@ -18,20 +18,25 @@ func copyFileContents(src, dst string) (err error) { return } defer in.Close() + out, err := os.Create(dst) if err != nil { return } + defer func() { cerr := out.Close() if err == nil { err = cerr } }() + if _, err = io.Copy(out, in); err != nil { return } + err = out.Sync() + return } @@ -40,6 +45,7 @@ func CopyFile(sourceSymLink, destinationFile string) (err error) { sourceFile, err := filepath.EvalSymlinks(sourceSymLink) if err != nil { log.Infof("Not a symlink : %s", err) + sourceFile = sourceSymLink } @@ -47,11 +53,13 @@ func CopyFile(sourceSymLink, destinationFile string) (err error) { if err != nil { return } + if !sourceFileStat.Mode().IsRegular() { // cannot copy non-regular files (e.g., directories, // symlinks, devices, etc.) return fmt.Errorf("copyFile: non-regular source file %s (%q)", sourceFileStat.Name(), sourceFileStat.Mode().String()) } + destinationFileStat, err := os.Stat(destinationFile) if err != nil { if !os.IsNotExist(err) { @@ -65,9 +73,11 @@ func CopyFile(sourceSymLink, destinationFile string) (err error) { return } } + if err = os.Link(sourceFile, destinationFile); err != nil { err = copyFileContents(sourceFile, destinationFile) } + return } diff --git a/cmd/crowdsec-cli/dashboard.go b/cmd/crowdsec-cli/dashboard.go index bb7596741..a3701c4db 100644 --- a/cmd/crowdsec-cli/dashboard.go +++ b/cmd/crowdsec-cli/dashboard.go @@ -201,6 +201,7 @@ func (cli cliDashboard) NewStartCmd() *cobra.Command { }, } cmd.Flags().BoolVarP(&forceYes, "yes", "y", false, "force yes") + return cmd } @@ -218,6 +219,7 @@ func (cli cliDashboard) NewStopCmd() *cobra.Command { return nil }, } + return cmd } @@ -235,6 +237,7 @@ func (cli cliDashboard) NewShowPasswordCmd() *cobra.Command { return nil }, } + return cmd } @@ -326,6 +329,7 @@ func passwordIsValid(password string) bool { if !hasDigit || len(password) < 6 { return false } + return true } @@ -334,8 +338,10 @@ func checkSystemMemory(forceYes *bool) error { if totMem >= uint64(math.Pow(2, 30)) { return nil } + if !*forceYes { var answer bool + prompt := &survey.Confirm{ Message: "Metabase requires 1-2GB of RAM, your system is below this requirement continue ?", Default: true, @@ -343,12 +349,16 @@ func checkSystemMemory(forceYes *bool) error { if err := survey.AskOne(prompt, &answer); err != nil { return fmt.Errorf("unable to ask about RAM check: %s", err) } + if !answer { return fmt.Errorf("user stated no to continue") } + return nil } + log.Warn("Metabase requires 1-2GB of RAM, your system is below this requirement") + return nil } @@ -356,25 +366,32 @@ func warnIfNotLoopback(addr string) { if addr == "127.0.0.1" || addr == "::1" { return } + log.Warnf("You are potentially exposing your metabase port to the internet (addr: %s), please consider using a reverse proxy", addr) } func disclaimer(forceYes *bool) error { if !*forceYes { var answer bool + prompt := &survey.Confirm{ Message: "CrowdSec takes no responsibility for the security of your metabase instance. Do you accept these responsibilities ?", Default: true, } + if err := survey.AskOne(prompt, &answer); err != nil { return fmt.Errorf("unable to ask to question: %s", err) } + if !answer { return fmt.Errorf("user stated no to responsibilities") } + return nil } + log.Warn("CrowdSec takes no responsibility for the security of your metabase instance. You used force yes, so you accept this disclaimer") + return nil } @@ -383,19 +400,24 @@ func checkGroups(forceYes *bool) (*user.Group, error) { if err == nil { return dockerGroup, nil } + if !*forceYes { var answer bool + prompt := &survey.Confirm{ Message: fmt.Sprintf("For metabase docker to be able to access SQLite file we need to add a new group called '%s' to the system, is it ok for you ?", crowdsecGroup), Default: true, } + if err := survey.AskOne(prompt, &answer); err != nil { return dockerGroup, fmt.Errorf("unable to ask to question: %s", err) } + if !answer { return dockerGroup, fmt.Errorf("unable to continue without creating '%s' group", crowdsecGroup) } } + groupAddCmd, err := exec.LookPath("groupadd") if err != nil { return dockerGroup, fmt.Errorf("unable to find 'groupadd' command, can't continue") @@ -405,6 +427,7 @@ func checkGroups(forceYes *bool) (*user.Group, error) { if err := groupAdd.Run(); err != nil { return dockerGroup, fmt.Errorf("unable to add group '%s': %s", dockerGroup, err) } + return user.LookupGroup(crowdsecGroup) } @@ -413,12 +436,14 @@ func chownDatabase(gid string) error { if err != nil { return fmt.Errorf("unable to convert group ID to int: %s", err) } + if stat, err := os.Stat(csConfig.DbConfig.DbPath); !os.IsNotExist(err) { info := stat.Sys() if err := os.Chown(csConfig.DbConfig.DbPath, int(info.(*syscall.Stat_t).Uid), intID); err != nil { return fmt.Errorf("unable to chown sqlite db file '%s': %s", csConfig.DbConfig.DbPath, err) } } + if csConfig.DbConfig.Type == "sqlite" && csConfig.DbConfig.UseWal != nil && *csConfig.DbConfig.UseWal { for _, ext := range []string{"-wal", "-shm"} { file := csConfig.DbConfig.DbPath + ext @@ -430,5 +455,6 @@ func chownDatabase(gid string) error { } } } + return nil } diff --git a/cmd/crowdsec-cli/decisions.go b/cmd/crowdsec-cli/decisions.go index 05fbf15a5..683f100d4 100644 --- a/cmd/crowdsec-cli/decisions.go +++ b/cmd/crowdsec-cli/decisions.go @@ -33,27 +33,35 @@ func DecisionsToTable(alerts *models.GetAlertsResponse, printMachine bool) error for aIdx := 0; aIdx < len(*alerts); aIdx++ { alertItem := (*alerts)[aIdx] newDecisions := make([]*models.Decision, 0) + for _, decisionItem := range alertItem.Decisions { spamKey := fmt.Sprintf("%t:%s:%s:%s", *decisionItem.Simulated, *decisionItem.Type, *decisionItem.Scope, *decisionItem.Value) if _, ok := spamLimit[spamKey]; ok { skipped++ continue } + spamLimit[spamKey] = true + newDecisions = append(newDecisions, decisionItem) } + alertItem.Decisions = newDecisions } + if csConfig.Cscli.Output == "raw" { csvwriter := csv.NewWriter(os.Stdout) header := []string{"id", "source", "ip", "reason", "action", "country", "as", "events_count", "expiration", "simulated", "alert_id"} + if printMachine { header = append(header, "machine") } + err := csvwriter.Write(header) if err != nil { return err } + for _, alertItem := range *alerts { for _, decisionItem := range alertItem.Decisions { raw := []string{ @@ -79,6 +87,7 @@ func DecisionsToTable(alerts *models.GetAlertsResponse, printMachine bool) error } } } + csvwriter.Flush() } else if csConfig.Cscli.Output == "json" { if *alerts == nil { @@ -99,6 +108,7 @@ func DecisionsToTable(alerts *models.GetAlertsResponse, printMachine bool) error fmt.Printf("%d duplicated entries skipped\n", skipped) } } + return nil } @@ -119,7 +129,7 @@ func (cli cliDecisions) NewCommand() *cobra.Command { /*TBD example*/ Args: cobra.MinimumNArgs(1), DisableAutoGenTag: true, - PersistentPreRunE: func(cmd *cobra.Command, args []string) error { + PersistentPreRunE: func(_ *cobra.Command, _ []string) error { if err := csConfig.LoadAPIClient(); err != nil { return fmt.Errorf("loading api client: %w", err) } @@ -164,8 +174,10 @@ func (cli cliDecisions) NewListCmd() *cobra.Command { IncludeCAPI: new(bool), Limit: new(int), } + NoSimu := new(bool) contained := new(bool) + var printMachine bool cmd := &cobra.Command{ @@ -178,7 +190,7 @@ cscli decisions list -t ban `, Args: cobra.ExactArgs(0), DisableAutoGenTag: true, - RunE: func(cmd *cobra.Command, args []string) error { + RunE: func(cmd *cobra.Command, _ []string) error { var err error /*take care of shorthand options*/ if err = manageCliDecisionAlerts(filter.IPEquals, filter.RangeEquals, filter.ScopeEquals, filter.ValueEquals); err != nil { @@ -299,7 +311,7 @@ cscli decisions add --scope username --value foobar /*TBD : fix long and example*/ Args: cobra.ExactArgs(0), DisableAutoGenTag: true, - RunE: func(cmd *cobra.Command, args []string) error { + RunE: func(cmd *cobra.Command, _ []string) error { var err error alerts := models.AddAlertsRequest{} origin := types.CscliOrigin @@ -325,7 +337,7 @@ cscli decisions add --scope username --value foobar addScope = types.Range } else if addValue == "" { printHelp(cmd) - return fmt.Errorf("Missing arguments, a value is required (--ip, --range or --scope and --value)") + return fmt.Errorf("missing arguments, a value is required (--ip, --range or --scope and --value)") } if addReason == "" { @@ -398,8 +410,11 @@ func (cli cliDecisions) NewDeleteCmd() *cobra.Command { ScenarioEquals: new(string), OriginEquals: new(string), } - var delDecisionId string + + var delDecisionID string + var delDecisionAll bool + contained := new(bool) cmd := &cobra.Command{ @@ -413,21 +428,21 @@ cscli decisions delete --id 42 cscli decisions delete --type captcha `, /*TBD : refaire le Long/Example*/ - PreRunE: func(cmd *cobra.Command, args []string) error { + PreRunE: func(cmd *cobra.Command, _ []string) error { if delDecisionAll { return nil } if *delFilter.ScopeEquals == "" && *delFilter.ValueEquals == "" && *delFilter.TypeEquals == "" && *delFilter.IPEquals == "" && *delFilter.RangeEquals == "" && *delFilter.ScenarioEquals == "" && - *delFilter.OriginEquals == "" && delDecisionId == "" { + *delFilter.OriginEquals == "" && delDecisionID == "" { cmd.Usage() return fmt.Errorf("at least one filter or --all must be specified") } return nil }, - RunE: func(cmd *cobra.Command, args []string) error { + RunE: func(_ *cobra.Command, _ []string) error { var err error var decisions *models.DeleteDecisionResponse @@ -460,18 +475,18 @@ cscli decisions delete --type captcha delFilter.Contains = new(bool) } - if delDecisionId == "" { + if delDecisionID == "" { decisions, _, err = Client.Decisions.Delete(context.Background(), delFilter) if err != nil { - return fmt.Errorf("Unable to delete decisions: %v", err) + return fmt.Errorf("unable to delete decisions: %v", err) } } else { - if _, err = strconv.Atoi(delDecisionId); err != nil { - return fmt.Errorf("id '%s' is not an integer: %v", delDecisionId, err) + if _, err = strconv.Atoi(delDecisionID); err != nil { + return fmt.Errorf("id '%s' is not an integer: %v", delDecisionID, err) } - decisions, _, err = Client.Decisions.DeleteOne(context.Background(), delDecisionId) + decisions, _, err = Client.Decisions.DeleteOne(context.Background(), delDecisionID) if err != nil { - return fmt.Errorf("Unable to delete decision: %v", err) + return fmt.Errorf("unable to delete decision: %v", err) } } log.Infof("%s decision(s) deleted", decisions.NbDeleted) @@ -487,7 +502,7 @@ cscli decisions delete --type captcha cmd.Flags().StringVarP(delFilter.ScenarioEquals, "scenario", "s", "", "the scenario name (ie. crowdsecurity/ssh-bf)") cmd.Flags().StringVar(delFilter.OriginEquals, "origin", "", fmt.Sprintf("the value to match for the specified origin (%s ...)", strings.Join(types.GetOrigins(), ","))) - cmd.Flags().StringVar(&delDecisionId, "id", "", "decision id") + cmd.Flags().StringVar(&delDecisionID, "id", "", "decision id") cmd.Flags().BoolVar(&delDecisionAll, "all", false, "delete all decisions") cmd.Flags().BoolVar(contained, "contained", false, "query decisions contained by range") diff --git a/cmd/crowdsec-cli/decisions_import.go b/cmd/crowdsec-cli/decisions_import.go index 6c9b19d28..fb134c32e 100644 --- a/cmd/crowdsec-cli/decisions_import.go +++ b/cmd/crowdsec-cli/decisions_import.go @@ -37,21 +37,25 @@ func parseDecisionList(content []byte, format string) ([]decisionRaw, error) { switch format { case "values": log.Infof("Parsing values") + scanner := bufio.NewScanner(bytes.NewReader(content)) for scanner.Scan() { value := strings.TrimSpace(scanner.Text()) ret = append(ret, decisionRaw{Value: value}) } + if err := scanner.Err(); err != nil { return nil, fmt.Errorf("unable to parse values: '%s'", err) } case "json": log.Infof("Parsing json") + if err := json.Unmarshal(content, &ret); err != nil { return nil, err } case "csv": log.Infof("Parsing csv") + if err := csvutil.Unmarshal(content, &ret); err != nil { return nil, fmt.Errorf("unable to parse csv: '%s'", err) } @@ -75,6 +79,7 @@ func (cli cliDecisions) runImport(cmd *cobra.Command, args []string) error { if err != nil { return err } + if defaultDuration == "" { return fmt.Errorf("--duration cannot be empty") } @@ -83,6 +88,7 @@ func (cli cliDecisions) runImport(cmd *cobra.Command, args []string) error { if err != nil { return err } + if defaultScope == "" { return fmt.Errorf("--scope cannot be empty") } @@ -91,6 +97,7 @@ func (cli cliDecisions) runImport(cmd *cobra.Command, args []string) error { if err != nil { return err } + if defaultReason == "" { return fmt.Errorf("--reason cannot be empty") } @@ -99,6 +106,7 @@ func (cli cliDecisions) runImport(cmd *cobra.Command, args []string) error { if err != nil { return err } + if defaultType == "" { return fmt.Errorf("--type cannot be empty") } @@ -152,6 +160,7 @@ func (cli cliDecisions) runImport(cmd *cobra.Command, args []string) error { } decisions := make([]*models.Decision, len(decisionsListRaw)) + for i, d := range decisionsListRaw { if d.Value == "" { return fmt.Errorf("item %d: missing 'value'", i) @@ -222,6 +231,7 @@ func (cli cliDecisions) runImport(cmd *cobra.Command, args []string) error { } log.Infof("Imported %d decisions", len(decisions)) + return nil } diff --git a/cmd/crowdsec-cli/itemcli.go b/cmd/crowdsec-cli/itemcli.go index 7e1a2d092..5b0ad13ff 100644 --- a/cmd/crowdsec-cli/itemcli.go +++ b/cmd/crowdsec-cli/itemcli.go @@ -100,11 +100,13 @@ func (cli cliItem) Install(cmd *cobra.Command, args []string) error { if !ignoreError { return fmt.Errorf("error while installing '%s': %w", item.Name, err) } + log.Errorf("Error while installing '%s': %s", item.Name, err) } } log.Infof(ReloadMessage()) + return nil } @@ -184,6 +186,7 @@ func (cli cliItem) Remove(cmd *cobra.Command, args []string) error { if err != nil { return err } + if didRemove { log.Infof("Removed %s", item.Name) removed++ @@ -191,6 +194,7 @@ func (cli cliItem) Remove(cmd *cobra.Command, args []string) error { } log.Infof("Removed %d %s", removed, cli.name) + if removed > 0 { log.Infof(ReloadMessage()) } @@ -231,6 +235,7 @@ func (cli cliItem) Remove(cmd *cobra.Command, args []string) error { } log.Infof("Removed %d %s", removed, cli.name) + if removed > 0 { log.Infof(ReloadMessage()) } @@ -291,6 +296,7 @@ func (cli cliItem) Upgrade(cmd *cobra.Command, args []string) error { if err != nil { return err } + if didUpdate { updated++ } @@ -327,6 +333,7 @@ func (cli cliItem) Upgrade(cmd *cobra.Command, args []string) error { updated++ } } + if updated > 0 { log.Infof(ReloadMessage()) } @@ -523,6 +530,7 @@ func (cli cliItem) itemDiff(item *cwhub.Item, reverse bool) (string, error) { file2 := remoteURL content1 := string(localContent) content2 := string(latestContent) + if reverse { file1, file2 = file2, file1 content1, content2 = content2, content1 diff --git a/cmd/crowdsec-cli/items.go b/cmd/crowdsec-cli/items.go index f28a10dad..560f9dc2a 100644 --- a/cmd/crowdsec-cli/items.go +++ b/cmd/crowdsec-cli/items.go @@ -63,7 +63,9 @@ func listItems(out io.Writer, itemTypes []string, items map[string][]*cwhub.Item if omitIfEmpty && len(items[itemType]) == 0 { continue } + listHubItemTable(out, "\n"+strings.ToUpper(itemType), items[itemType]) + nothingToDisplay = false } @@ -128,11 +130,13 @@ func listItems(out io.Writer, itemTypes []string, items map[string][]*cwhub.Item if len(itemTypes) > 1 { row = append(row, itemType) } + if err := csvwriter.Write(row); err != nil { return fmt.Errorf("failed to write raw output: %s", err) } } } + csvwriter.Flush() default: return fmt.Errorf("unknown output format '%s'", csConfig.Cscli.Output) @@ -146,6 +150,7 @@ func InspectItem(item *cwhub.Item, showMetrics bool) error { case "human", "raw": enc := yaml.NewEncoder(os.Stdout) enc.SetIndent(2) + if err := enc.Encode(item); err != nil { return fmt.Errorf("unable to encode item: %s", err) } @@ -154,6 +159,7 @@ func InspectItem(item *cwhub.Item, showMetrics bool) error { if err != nil { return fmt.Errorf("unable to marshal item: %s", err) } + fmt.Print(string(b)) } @@ -169,6 +175,7 @@ func InspectItem(item *cwhub.Item, showMetrics bool) error { if showMetrics { fmt.Printf("\nCurrent metrics: \n") + if err := ShowMetrics(item); err != nil { return err } diff --git a/pkg/alertcontext/config.go b/pkg/alertcontext/config.go index 1ab61ebca..160804487 100644 --- a/pkg/alertcontext/config.go +++ b/pkg/alertcontext/config.go @@ -32,6 +32,7 @@ func mergeContext(dest map[string][]string, src map[string][]string) error { if _, ok := dest[k]; !ok { dest[k] = make([]string, 0) } + for _, s := range v { if !slices.Contains(dest[k], s) { dest[k] = append(dest[k], s) @@ -46,6 +47,7 @@ func mergeContext(dest map[string][]string, src map[string][]string) error { func addContextFromItem(toSend map[string][]string, item *cwhub.Item) error { filePath := item.State.LocalPath log.Tracef("loading console context from %s", filePath) + content, err := os.ReadFile(filePath) if err != nil { return err @@ -70,6 +72,7 @@ func addContextFromItem(toSend map[string][]string, item *cwhub.Item) error { // addContextFromFile merges the context from a file into the context to send to the console. func addContextFromFile(toSend map[string][]string, filePath string) error { log.Tracef("loading console context from %s", filePath) + content, err := os.ReadFile(filePath) if err != nil { return err diff --git a/pkg/csplugin/broker_test.go b/pkg/csplugin/broker_test.go index 16ea44fee..f41eb8031 100644 --- a/pkg/csplugin/broker_test.go +++ b/pkg/csplugin/broker_test.go @@ -31,6 +31,7 @@ func (s *PluginSuite) permissionSetter(perm os.FileMode) func(*testing.T) { func (s *PluginSuite) readconfig() PluginConfig { var config PluginConfig + t := s.T() orig, err := os.ReadFile(s.pluginConfig) @@ -142,6 +143,7 @@ func (s *PluginSuite) TestBrokerInit() { func (s *PluginSuite) TestBrokerNoThreshold() { var alerts []models.Alert + DefaultEmptyTicker = 50 * time.Millisecond t := s.T() @@ -154,6 +156,7 @@ func (s *PluginSuite) TestBrokerNoThreshold() { // send one item, it should be processed right now pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} + time.Sleep(200 * time.Millisecond) // we expect one now @@ -170,6 +173,7 @@ func (s *PluginSuite) TestBrokerNoThreshold() { // and another one log.Printf("second send") pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} + time.Sleep(200 * time.Millisecond) // we expect one again, as we cleaned the file @@ -204,6 +208,7 @@ func (s *PluginSuite) TestBrokerRunGroupAndTimeThreshold_TimeFirst() { pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} + time.Sleep(500 * time.Millisecond) // because of group threshold, we shouldn't have data yet assert.NoFileExists(t, "./out") @@ -239,11 +244,13 @@ func (s *PluginSuite) TestBrokerRunGroupAndTimeThreshold_CountFirst() { pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} + time.Sleep(100 * time.Millisecond) // because of group threshold, we shouldn't have data yet assert.NoFileExists(t, "./out") pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} + time.Sleep(100 * time.Millisecond) // and now we should @@ -277,6 +284,7 @@ func (s *PluginSuite) TestBrokerRunGroupThreshold() { pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} + time.Sleep(time.Second) // because of group threshold, we shouldn't have data yet @@ -284,6 +292,7 @@ func (s *PluginSuite) TestBrokerRunGroupThreshold() { pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} + time.Sleep(time.Second) // and now we should @@ -326,6 +335,7 @@ func (s *PluginSuite) TestBrokerRunTimeThreshold() { // send data pb.PluginChannel <- ProfileAlert{ProfileID: uint(0), Alert: &models.Alert{}} + time.Sleep(200 * time.Millisecond) // we shouldn't have data yet diff --git a/pkg/hubtest/hubtest_item.go b/pkg/hubtest/hubtest_item.go index b2d5a93f7..c03ade413 100644 --- a/pkg/hubtest/hubtest_item.go +++ b/pkg/hubtest/hubtest_item.go @@ -321,6 +321,7 @@ func (t *HubTestItem) InstallHub() error { // install appsec-rules in runtime environment for _, appsecrule := range t.Config.AppsecRules { log.Debugf("adding rule '%s'", appsecrule) + if appsecrule == "" { continue } @@ -544,7 +545,6 @@ func (t *HubTestItem) Clean() error { } func (t *HubTestItem) RunWithNucleiTemplate() error { - crowdsecLogFile := fmt.Sprintf("%s/log/crowdsec.log", t.RuntimePath) testPath := filepath.Join(t.HubTestPath, t.Name) @@ -595,6 +595,7 @@ func (t *HubTestItem) RunWithNucleiTemplate() error { log.Errorf("crowdsec log file '%s'", crowdsecLogFile) log.Errorf("%s\n", string(crowdsecLog)) } + return fmt.Errorf("appsec is down: %s", err) } @@ -603,6 +604,7 @@ func (t *HubTestItem) RunWithNucleiTemplate() error { if err != nil { return fmt.Errorf("unable to parse target '%s': %s", t.NucleiTargetHost, err) } + nucleiTargetHost := nucleiTargetParsedURL.Host if _, err := IsAlive(nucleiTargetHost); err != nil { return fmt.Errorf("target is down: %s", err) @@ -648,7 +650,9 @@ func (t *HubTestItem) RunWithNucleiTemplate() error { } } } + crowdsecDaemon.Process.Kill() + return nil } @@ -853,6 +857,7 @@ func (t *HubTestItem) RunWithLogFile() error { func (t *HubTestItem) Run() error { var err error + t.Success = false t.ErrorsList = make([]string, 0) @@ -911,6 +916,7 @@ func (t *HubTestItem) Run() error { if len(t.Config.AppsecRules) > 0 { // copy template acquis file to runtime folder log.Debugf("copying %s to %s", t.TemplateAcquisPath, t.RuntimeAcquisFilePath) + if err = Copy(t.TemplateAcquisPath, t.RuntimeAcquisFilePath); err != nil { return fmt.Errorf("unable to copy '%s' to '%s': %v", t.TemplateAcquisPath, t.RuntimeAcquisFilePath, err) } diff --git a/test/bats/90_decisions.bats b/test/bats/90_decisions.bats index f2464084a..5870eb36b 100644 --- a/test/bats/90_decisions.bats +++ b/test/bats/90_decisions.bats @@ -29,11 +29,11 @@ teardown() { @test "'decisions add' requires parameters" { rune -1 cscli decisions add assert_line "Usage:" - assert_stderr --partial "Missing arguments, a value is required (--ip, --range or --scope and --value)" + assert_stderr --partial "missing arguments, a value is required (--ip, --range or --scope and --value)" rune -1 cscli decisions add -o json rune -0 jq -c '[ .level, .msg]' <(stderr | grep "^{") - assert_output '["fatal","Missing arguments, a value is required (--ip, --range or --scope and --value)"]' + assert_output '["fatal","missing arguments, a value is required (--ip, --range or --scope and --value)"]' } @test "cscli decisions list, with and without --machine" {