capi.go 6.0 KB

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