capi.go 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  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/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. "github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/require"
  19. )
  20. const CAPIBaseURL string = "https://api.crowdsec.net/"
  21. const CAPIURLPrefix = "v3"
  22. func NewCapiCmd() *cobra.Command {
  23. var cmdCapi = &cobra.Command{
  24. Use: "capi [action]",
  25. Short: "Manage interaction with Central API (CAPI)",
  26. Args: cobra.MinimumNArgs(1),
  27. DisableAutoGenTag: true,
  28. PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
  29. if err := require.LAPI(csConfig); err != nil {
  30. return err
  31. }
  32. if err := require.CAPI(csConfig); err != nil {
  33. return err
  34. }
  35. return nil
  36. },
  37. }
  38. cmdCapi.AddCommand(NewCapiRegisterCmd())
  39. cmdCapi.AddCommand(NewCapiStatusCmd())
  40. return cmdCapi
  41. }
  42. func NewCapiRegisterCmd() *cobra.Command {
  43. var capiUserPrefix string
  44. var outputFile string
  45. var cmdCapiRegister = &cobra.Command{
  46. Use: "register",
  47. Short: "Register to Central API (CAPI)",
  48. Args: cobra.MinimumNArgs(0),
  49. DisableAutoGenTag: true,
  50. RunE: func(cmd *cobra.Command, args []string) error {
  51. var err error
  52. capiUser, err := generateID(capiUserPrefix)
  53. if err != nil {
  54. return fmt.Errorf("unable to generate machine id: %s", err)
  55. }
  56. password := strfmt.Password(generatePassword(passwordLength))
  57. apiurl, err := url.Parse(types.CAPIBaseURL)
  58. if err != nil {
  59. return fmt.Errorf("unable to parse api url %s: %w", types.CAPIBaseURL, err)
  60. }
  61. _, err = apiclient.RegisterClient(&apiclient.Config{
  62. MachineID: capiUser,
  63. Password: password,
  64. UserAgent: fmt.Sprintf("crowdsec/%s", version.String()),
  65. URL: apiurl,
  66. VersionPrefix: CAPIURLPrefix,
  67. }, nil)
  68. if err != nil {
  69. return fmt.Errorf("api client register ('%s'): %w", types.CAPIBaseURL, err)
  70. }
  71. log.Printf("Successfully registered to Central API (CAPI)")
  72. var dumpFile string
  73. if outputFile != "" {
  74. dumpFile = outputFile
  75. } else if csConfig.API.Server.OnlineClient.CredentialsFilePath != "" {
  76. dumpFile = csConfig.API.Server.OnlineClient.CredentialsFilePath
  77. } else {
  78. dumpFile = ""
  79. }
  80. apiCfg := csconfig.ApiCredentialsCfg{
  81. Login: capiUser,
  82. Password: password.String(),
  83. URL: types.CAPIBaseURL,
  84. }
  85. if fflag.PapiClient.IsEnabled() {
  86. apiCfg.PapiURL = types.PAPIBaseURL
  87. }
  88. apiConfigDump, err := yaml.Marshal(apiCfg)
  89. if err != nil {
  90. return fmt.Errorf("unable to marshal api credentials: %w", err)
  91. }
  92. if dumpFile != "" {
  93. err = os.WriteFile(dumpFile, apiConfigDump, 0600)
  94. if err != nil {
  95. return fmt.Errorf("write api credentials in '%s' failed: %w", dumpFile, err)
  96. }
  97. log.Printf("Central API credentials dumped to '%s'", dumpFile)
  98. } else {
  99. fmt.Printf("%s\n", string(apiConfigDump))
  100. }
  101. log.Warning(ReloadMessage())
  102. return nil
  103. },
  104. }
  105. cmdCapiRegister.Flags().StringVarP(&outputFile, "file", "f", "", "output file destination")
  106. cmdCapiRegister.Flags().StringVar(&capiUserPrefix, "schmilblick", "", "set a schmilblick (use in tests only)")
  107. if err := cmdCapiRegister.Flags().MarkHidden("schmilblick"); err != nil {
  108. log.Fatalf("failed to hide flag: %s", err)
  109. }
  110. return cmdCapiRegister
  111. }
  112. func NewCapiStatusCmd() *cobra.Command {
  113. var cmdCapiStatus = &cobra.Command{
  114. Use: "status",
  115. Short: "Check status with the Central API (CAPI)",
  116. Args: cobra.MinimumNArgs(0),
  117. DisableAutoGenTag: true,
  118. RunE: func(cmd *cobra.Command, args []string) error {
  119. if csConfig.API.Server.OnlineClient == nil {
  120. return fmt.Errorf("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. return fmt.Errorf("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. return fmt.Errorf("parsing api url ('%s'): %w", csConfig.API.Server.OnlineClient.Credentials.URL, err)
  129. }
  130. hub, err := require.Hub(csConfig)
  131. if err != nil {
  132. return err
  133. }
  134. scenarios, err := hub.GetInstalledItemsAsString(cwhub.SCENARIOS)
  135. if err != nil {
  136. return fmt.Errorf("failed to get scenarios: %w", err)
  137. }
  138. if len(scenarios) == 0 {
  139. return fmt.Errorf("no scenarios installed, abort")
  140. }
  141. Client, err = apiclient.NewDefaultClient(apiurl, CAPIURLPrefix, fmt.Sprintf("crowdsec/%s", version.String()), nil)
  142. if err != nil {
  143. return fmt.Errorf("init default client: %w", err)
  144. }
  145. t := models.WatcherAuthRequest{
  146. MachineID: &csConfig.API.Server.OnlineClient.Credentials.Login,
  147. Password: &password,
  148. Scenarios: scenarios,
  149. }
  150. log.Infof("Loaded credentials from %s", csConfig.API.Server.OnlineClient.CredentialsFilePath)
  151. log.Infof("Trying to authenticate with username %s on %s", csConfig.API.Server.OnlineClient.Credentials.Login, apiurl)
  152. _, _, err = Client.Auth.AuthenticateWatcher(context.Background(), t)
  153. if err != nil {
  154. return fmt.Errorf("failed to authenticate to Central API (CAPI): %w", err)
  155. }
  156. log.Infof("You can successfully interact with Central API (CAPI)")
  157. return nil
  158. },
  159. }
  160. return cmdCapiStatus
  161. }