capi.go 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. "net/url"
  6. "os"
  7. "github.com/crowdsecurity/crowdsec/pkg/apiclient"
  8. "github.com/crowdsecurity/crowdsec/pkg/csconfig"
  9. "github.com/crowdsecurity/crowdsec/pkg/cwhub"
  10. "github.com/crowdsecurity/crowdsec/pkg/cwversion"
  11. "github.com/crowdsecurity/crowdsec/pkg/models"
  12. "github.com/crowdsecurity/crowdsec/pkg/types"
  13. "github.com/go-openapi/strfmt"
  14. "github.com/pkg/errors"
  15. log "github.com/sirupsen/logrus"
  16. "github.com/spf13/cobra"
  17. "gopkg.in/yaml.v2"
  18. )
  19. const CAPIBaseURL string = "https://api.crowdsec.net/"
  20. const CAPIURLPrefix = "v3"
  21. func NewCapiCmd() *cobra.Command {
  22. var cmdCapi = &cobra.Command{
  23. Use: "capi [action]",
  24. Short: "Manage interaction with Central API (CAPI)",
  25. Args: cobra.MinimumNArgs(1),
  26. DisableAutoGenTag: true,
  27. PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
  28. if err := csConfig.LoadAPIServer(); err != nil || csConfig.DisableAPI {
  29. return errors.Wrap(err, "Local API is disabled, please run this command on the local API machine")
  30. }
  31. if csConfig.API.Server.OnlineClient == nil {
  32. log.Fatalf("no configuration for Central API in '%s'", *csConfig.FilePath)
  33. }
  34. return nil
  35. },
  36. }
  37. cmdCapi.AddCommand(NewCapiRegisterCmd())
  38. cmdCapi.AddCommand(NewCapiStatusCmd())
  39. return cmdCapi
  40. }
  41. func NewCapiRegisterCmd() *cobra.Command {
  42. var capiUserPrefix string
  43. var outputFile string
  44. var cmdCapiRegister = &cobra.Command{
  45. Use: "register",
  46. Short: "Register to Central API (CAPI)",
  47. Args: cobra.MinimumNArgs(0),
  48. DisableAutoGenTag: true,
  49. Run: func(cmd *cobra.Command, args []string) {
  50. var err error
  51. capiUser, err := generateID(capiUserPrefix)
  52. if err != nil {
  53. log.Fatalf("unable to generate machine id: %s", err)
  54. }
  55. password := strfmt.Password(generatePassword(passwordLength))
  56. apiurl, err := url.Parse(types.CAPIBaseURL)
  57. if err != nil {
  58. log.Fatalf("unable to parse api url %s : %s", types.CAPIBaseURL, err)
  59. }
  60. _, err = apiclient.RegisterClient(&apiclient.Config{
  61. MachineID: capiUser,
  62. Password: password,
  63. UserAgent: fmt.Sprintf("crowdsec/%s", cwversion.VersionStr()),
  64. URL: apiurl,
  65. VersionPrefix: CAPIURLPrefix,
  66. }, nil)
  67. if err != nil {
  68. log.Fatalf("api client register ('%s'): %s", types.CAPIBaseURL, err)
  69. }
  70. log.Printf("Successfully registered to Central API (CAPI)")
  71. var dumpFile string
  72. if outputFile != "" {
  73. dumpFile = outputFile
  74. } else if csConfig.API.Server.OnlineClient.CredentialsFilePath != "" {
  75. dumpFile = csConfig.API.Server.OnlineClient.CredentialsFilePath
  76. } else {
  77. dumpFile = ""
  78. }
  79. apiCfg := csconfig.ApiCredentialsCfg{
  80. Login: capiUser,
  81. Password: password.String(),
  82. URL: types.CAPIBaseURL,
  83. PapiURL: types.PAPIBaseURL,
  84. }
  85. apiConfigDump, err := yaml.Marshal(apiCfg)
  86. if err != nil {
  87. log.Fatalf("unable to marshal api credentials: %s", err)
  88. }
  89. if dumpFile != "" {
  90. err = os.WriteFile(dumpFile, apiConfigDump, 0600)
  91. if err != nil {
  92. log.Fatalf("write api credentials in '%s' failed: %s", dumpFile, err)
  93. }
  94. log.Printf("Central API credentials dumped to '%s'", dumpFile)
  95. } else {
  96. fmt.Printf("%s\n", string(apiConfigDump))
  97. }
  98. log.Warning(ReloadMessage())
  99. },
  100. }
  101. cmdCapiRegister.Flags().StringVarP(&outputFile, "file", "f", "", "output file destination")
  102. cmdCapiRegister.Flags().StringVar(&capiUserPrefix, "schmilblick", "", "set a schmilblick (use in tests only)")
  103. if err := cmdCapiRegister.Flags().MarkHidden("schmilblick"); err != nil {
  104. log.Fatalf("failed to hide flag: %s", err)
  105. }
  106. return cmdCapiRegister
  107. }
  108. func NewCapiStatusCmd() *cobra.Command {
  109. var cmdCapiStatus = &cobra.Command{
  110. Use: "status",
  111. Short: "Check status with the Central API (CAPI)",
  112. Args: cobra.MinimumNArgs(0),
  113. DisableAutoGenTag: true,
  114. Run: func(cmd *cobra.Command, args []string) {
  115. var err error
  116. if csConfig.API.Server == nil {
  117. log.Fatalln("There is no configuration on 'api.server:'")
  118. }
  119. if csConfig.API.Server.OnlineClient == nil {
  120. log.Fatalf("Please provide credentials for the Central API (CAPI) in '%s'", csConfig.API.Server.OnlineClient.CredentialsFilePath)
  121. }
  122. if csConfig.API.Server.OnlineClient.Credentials == nil {
  123. log.Fatalf("no credentials for Central API (CAPI) in '%s'", csConfig.API.Server.OnlineClient.CredentialsFilePath)
  124. }
  125. password := strfmt.Password(csConfig.API.Server.OnlineClient.Credentials.Password)
  126. apiurl, err := url.Parse(csConfig.API.Server.OnlineClient.Credentials.URL)
  127. if err != nil {
  128. log.Fatalf("parsing api url ('%s'): %s", csConfig.API.Server.OnlineClient.Credentials.URL, err)
  129. }
  130. if err := csConfig.LoadHub(); err != nil {
  131. log.Fatal(err)
  132. }
  133. if err := cwhub.GetHubIdx(csConfig.Hub); err != nil {
  134. log.Info("Run 'sudo cscli hub update' to get the hub index")
  135. log.Fatalf("Failed to load hub index : %s", err)
  136. }
  137. scenarios, err := cwhub.GetInstalledScenariosAsString()
  138. if err != nil {
  139. log.Fatalf("failed to get scenarios : %s", err)
  140. }
  141. if len(scenarios) == 0 {
  142. log.Fatalf("no scenarios installed, abort")
  143. }
  144. Client, err = apiclient.NewDefaultClient(apiurl, CAPIURLPrefix, fmt.Sprintf("crowdsec/%s", cwversion.VersionStr()), nil)
  145. if err != nil {
  146. log.Fatalf("init default client: %s", err)
  147. }
  148. t := models.WatcherAuthRequest{
  149. MachineID: &csConfig.API.Server.OnlineClient.Credentials.Login,
  150. Password: &password,
  151. Scenarios: scenarios,
  152. }
  153. log.Infof("Loaded credentials from %s", csConfig.API.Server.OnlineClient.CredentialsFilePath)
  154. log.Infof("Trying to authenticate with username %s on %s", csConfig.API.Server.OnlineClient.Credentials.Login, apiurl)
  155. _, _, err = Client.Auth.AuthenticateWatcher(context.Background(), t)
  156. if err != nil {
  157. log.Fatalf("Failed to authenticate to Central API (CAPI) : %s", err)
  158. }
  159. log.Infof("You can successfully interact with Central API (CAPI)")
  160. },
  161. }
  162. return cmdCapiStatus
  163. }