325003bb69
* hub diet; taint tests * cmd/crowdsec-cli: split utils.go, moved cwhub.GetHubStatusForItemType() * cscli: refactor hub list commands, fix edge cases
306 lines
8.1 KiB
Go
306 lines
8.1 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/fatih/color"
|
|
log "github.com/sirupsen/logrus"
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/require"
|
|
"github.com/crowdsecurity/crowdsec/pkg/cwhub"
|
|
)
|
|
|
|
func NewScenariosCmd() *cobra.Command {
|
|
cmdScenarios := &cobra.Command{
|
|
Use: "scenarios <action> [scenario]...",
|
|
Short: "Manage hub scenarios",
|
|
Example: `cscli scenarios list -a
|
|
cscli scenarios install crowdsecurity/ssh-bf crowdsecurity/http-probing
|
|
cscli scenarios inspect crowdsecurity/ssh-bf crowdsecurity/http-probing
|
|
cscli scenarios upgrade crowdsecurity/ssh-bf crowdsecurity/http-probing
|
|
cscli scenarios remove crowdsecurity/ssh-bf crowdsecurity/http-probing
|
|
`,
|
|
Args: cobra.MinimumNArgs(1),
|
|
Aliases: []string{"scenario"},
|
|
DisableAutoGenTag: true,
|
|
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
|
|
if err := require.Hub(csConfig); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
},
|
|
PersistentPostRun: func(cmd *cobra.Command, args []string) {
|
|
if cmd.Name() == "inspect" || cmd.Name() == "list" {
|
|
return
|
|
}
|
|
log.Infof(ReloadMessage())
|
|
},
|
|
}
|
|
|
|
cmdScenarios.AddCommand(NewCmdScenariosInstall())
|
|
cmdScenarios.AddCommand(NewCmdScenariosRemove())
|
|
cmdScenarios.AddCommand(NewCmdScenariosUpgrade())
|
|
cmdScenarios.AddCommand(NewCmdScenariosInspect())
|
|
cmdScenarios.AddCommand(NewCmdScenariosList())
|
|
|
|
return cmdScenarios
|
|
}
|
|
|
|
func runScenariosInstall(cmd *cobra.Command, args []string) error {
|
|
flags := cmd.Flags()
|
|
|
|
downloadOnly, err := flags.GetBool("download-only")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
force, err := flags.GetBool("force")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
ignoreError, err := flags.GetBool("ignore")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, name := range args {
|
|
t := cwhub.GetItem(cwhub.SCENARIOS, name)
|
|
if t == nil {
|
|
nearestItem, score := GetDistance(cwhub.SCENARIOS, name)
|
|
Suggest(cwhub.SCENARIOS, name, nearestItem.Name, score, ignoreError)
|
|
|
|
continue
|
|
}
|
|
|
|
if err := cwhub.InstallItem(csConfig, name, cwhub.SCENARIOS, force, downloadOnly); err != nil {
|
|
if !ignoreError {
|
|
return fmt.Errorf("error while installing '%s': %w", name, err)
|
|
}
|
|
log.Errorf("Error while installing '%s': %s", name, err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func NewCmdScenariosInstall() *cobra.Command {
|
|
cmdScenariosInstall := &cobra.Command{
|
|
Use: "install <scenario>...",
|
|
Short: "Install given scenario(s)",
|
|
Long: `Fetch and install one or more scenarios from the hub`,
|
|
Example: `cscli scenarios install crowdsecurity/ssh-bf crowdsecurity/http-probing`,
|
|
Args: cobra.MinimumNArgs(1),
|
|
DisableAutoGenTag: true,
|
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
return compAllItems(cwhub.SCENARIOS, args, toComplete)
|
|
},
|
|
RunE: runScenariosInstall,
|
|
}
|
|
|
|
flags := cmdScenariosInstall.Flags()
|
|
flags.BoolP("download-only", "d", false, "Only download packages, don't enable")
|
|
flags.Bool("force", false, "Force install: overwrite tainted and outdated files")
|
|
flags.Bool("ignore", false, "Ignore errors when installing multiple scenarios")
|
|
|
|
return cmdScenariosInstall
|
|
}
|
|
|
|
func runScenariosRemove(cmd *cobra.Command, args []string) error {
|
|
flags := cmd.Flags()
|
|
|
|
purge, err := flags.GetBool("purge")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
force, err := flags.GetBool("force")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
all, err := flags.GetBool("all")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if all {
|
|
err := cwhub.RemoveMany(csConfig, cwhub.SCENARIOS, "", all, purge, force)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
if len(args) == 0 {
|
|
return fmt.Errorf("specify at least one scenario to remove or '--all'")
|
|
}
|
|
|
|
for _, name := range args {
|
|
err := cwhub.RemoveMany(csConfig, cwhub.SCENARIOS, name, all, purge, force)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func NewCmdScenariosRemove() *cobra.Command {
|
|
cmdScenariosRemove := &cobra.Command{
|
|
Use: "remove <scenario>...",
|
|
Short: "Remove given scenario(s)",
|
|
Long: `remove one or more scenarios`,
|
|
Example: `cscli scenarios remove crowdsecurity/ssh-bf crowdsecurity/http-probing`,
|
|
Aliases: []string{"delete"},
|
|
DisableAutoGenTag: true,
|
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
return compInstalledItems(cwhub.SCENARIOS, args, toComplete)
|
|
},
|
|
RunE: runScenariosRemove,
|
|
}
|
|
|
|
flags := cmdScenariosRemove.Flags()
|
|
flags.Bool("purge", false, "Delete source file too")
|
|
flags.Bool("force", false, "Force remove: remove tainted and outdated files")
|
|
flags.Bool("all", false, "Remove all the scenarios")
|
|
|
|
return cmdScenariosRemove
|
|
}
|
|
|
|
func runScenariosUpgrade(cmd *cobra.Command, args []string) error {
|
|
flags := cmd.Flags()
|
|
|
|
force, err := flags.GetBool("force")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
all, err := flags.GetBool("all")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if all {
|
|
if err := cwhub.UpgradeConfig(csConfig, cwhub.SCENARIOS, "", force); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
if len(args) == 0 {
|
|
return fmt.Errorf("specify at least one scenario to upgrade or '--all'")
|
|
}
|
|
|
|
for _, name := range args {
|
|
if err := cwhub.UpgradeConfig(csConfig, cwhub.SCENARIOS, name, force); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func NewCmdScenariosUpgrade() *cobra.Command {
|
|
cmdScenariosUpgrade := &cobra.Command{
|
|
Use: "upgrade <scenario>...",
|
|
Short: "Upgrade given scenario(s)",
|
|
Long: `Fetch and upgrade one or more scenarios from the hub`,
|
|
Example: `cscli scenarios upgrade crowdsecurity/ssh-bf crowdsecurity/http-probing`,
|
|
DisableAutoGenTag: true,
|
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
return compInstalledItems(cwhub.SCENARIOS, args, toComplete)
|
|
},
|
|
RunE: runScenariosUpgrade,
|
|
}
|
|
|
|
flags := cmdScenariosUpgrade.Flags()
|
|
flags.BoolP("all", "a", false, "Upgrade all the scenarios")
|
|
flags.Bool("force", false, "Force upgrade: overwrite tainted and outdated files")
|
|
|
|
return cmdScenariosUpgrade
|
|
}
|
|
|
|
func runScenariosInspect(cmd *cobra.Command, args []string) error {
|
|
flags := cmd.Flags()
|
|
|
|
url, err := flags.GetString("url")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if url != "" {
|
|
csConfig.Cscli.PrometheusUrl = url
|
|
}
|
|
|
|
noMetrics, err := flags.GetBool("no-metrics")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, name := range args {
|
|
if err = InspectItem(name, cwhub.SCENARIOS, noMetrics); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func NewCmdScenariosInspect() *cobra.Command {
|
|
cmdScenariosInspect := &cobra.Command{
|
|
Use: "inspect <scenario>",
|
|
Short: "Inspect a scenario",
|
|
Long: `Inspect a scenario`,
|
|
Example: `cscli scenarios inspect crowdsecurity/ssh-bf crowdsecurity/http-probing`,
|
|
Args: cobra.MinimumNArgs(1),
|
|
DisableAutoGenTag: true,
|
|
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
return compInstalledItems(cwhub.SCENARIOS, args, toComplete)
|
|
},
|
|
RunE: runScenariosInspect,
|
|
}
|
|
|
|
flags := cmdScenariosInspect.Flags()
|
|
flags.StringP("url", "u", "", "Prometheus url")
|
|
flags.Bool("no-metrics", false, "Don't show metrics (when cscli.output=human)")
|
|
|
|
return cmdScenariosInspect
|
|
}
|
|
|
|
func runScenariosList(cmd *cobra.Command, args []string) error {
|
|
flags := cmd.Flags()
|
|
|
|
all, err := flags.GetBool("all")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err = ListItems(color.Output, []string{cwhub.SCENARIOS}, args, false, true, all); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func NewCmdScenariosList() *cobra.Command {
|
|
cmdScenariosList := &cobra.Command{
|
|
Use: "list [scenario]...",
|
|
Short: "List scenarios",
|
|
Long: `List of installed/available/specified scenarios`,
|
|
Example: `cscli scenarios list
|
|
cscli scenarios list -a
|
|
cscli scenarios list crowdsecurity/ssh-bf crowdsecurity/http-probing`,
|
|
DisableAutoGenTag: true,
|
|
RunE: runScenariosList,
|
|
}
|
|
|
|
flags := cmdScenariosList.Flags()
|
|
flags.BoolP("all", "a", false, "List disabled items as well")
|
|
|
|
return cmdScenariosList
|
|
}
|