2023-10-17 14:17:37 +00:00
|
|
|
package cwhub
|
|
|
|
|
|
|
|
import (
|
|
|
|
"encoding/json"
|
|
|
|
"fmt"
|
2023-10-20 12:32:35 +00:00
|
|
|
"os"
|
2023-10-17 14:17:37 +00:00
|
|
|
"strings"
|
|
|
|
|
|
|
|
log "github.com/sirupsen/logrus"
|
|
|
|
|
2023-10-19 10:04:29 +00:00
|
|
|
"github.com/crowdsecurity/crowdsec/pkg/csconfig"
|
|
|
|
)
|
2023-10-17 14:17:37 +00:00
|
|
|
|
2023-10-19 10:04:29 +00:00
|
|
|
type Hub struct {
|
|
|
|
Items HubItems
|
2023-10-30 16:23:50 +00:00
|
|
|
local *csconfig.LocalHubCfg
|
|
|
|
remote *RemoteHubCfg
|
2023-10-17 14:17:37 +00:00
|
|
|
skippedLocal int
|
|
|
|
skippedTainted int
|
2023-11-09 11:07:09 +00:00
|
|
|
Warnings []string
|
2023-10-17 14:17:37 +00:00
|
|
|
}
|
|
|
|
|
2023-11-07 09:27:33 +00:00
|
|
|
var theHub *Hub
|
2023-10-19 10:04:29 +00:00
|
|
|
|
|
|
|
// GetHub returns the hub singleton
|
|
|
|
// it returns an error if it's not initialized to avoid nil dereference
|
2023-10-30 16:23:50 +00:00
|
|
|
// XXX: convenience function that we should get rid of at some point
|
2023-10-19 10:04:29 +00:00
|
|
|
func GetHub() (*Hub, error) {
|
|
|
|
if theHub == nil {
|
|
|
|
return nil, fmt.Errorf("hub not initialized")
|
|
|
|
}
|
|
|
|
|
|
|
|
return theHub, nil
|
|
|
|
}
|
|
|
|
|
2023-10-31 11:47:39 +00:00
|
|
|
// NewHub returns a new Hub instance with local and (optionally) remote configuration, and syncs the local state
|
|
|
|
// It also downloads the index if downloadIndex is true
|
|
|
|
func NewHub(local *csconfig.LocalHubCfg, remote *RemoteHubCfg, downloadIndex bool) (*Hub, error) {
|
2023-10-30 16:23:50 +00:00
|
|
|
if local == nil {
|
|
|
|
return nil, fmt.Errorf("no hub configuration found")
|
2023-10-17 14:17:37 +00:00
|
|
|
}
|
|
|
|
|
2023-10-31 11:47:39 +00:00
|
|
|
if downloadIndex {
|
2023-11-07 09:27:33 +00:00
|
|
|
if err := remote.downloadIndex(local.HubIndexFile); err != nil {
|
2023-10-31 11:47:39 +00:00
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-10-30 16:23:50 +00:00
|
|
|
log.Debugf("loading hub idx %s", local.HubIndexFile)
|
2023-10-20 12:32:35 +00:00
|
|
|
|
|
|
|
theHub = &Hub{
|
2023-10-30 16:23:50 +00:00
|
|
|
local: local,
|
|
|
|
remote: remote,
|
2023-10-17 14:17:37 +00:00
|
|
|
}
|
2023-10-20 12:32:35 +00:00
|
|
|
|
2023-11-07 09:27:33 +00:00
|
|
|
if err := theHub.parseIndex(); err != nil {
|
|
|
|
return nil, fmt.Errorf("failed to load index: %w", err)
|
|
|
|
}
|
|
|
|
|
2023-11-09 11:07:09 +00:00
|
|
|
if err := theHub.localSync(); err != nil {
|
2023-11-08 12:21:59 +00:00
|
|
|
return nil, fmt.Errorf("failed to sync items: %w", err)
|
2023-10-20 12:32:35 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return theHub, nil
|
2023-10-17 14:17:37 +00:00
|
|
|
}
|
|
|
|
|
2023-11-07 09:27:33 +00:00
|
|
|
// parseIndex takes the content of an index file and fills the map of associated parsers/scenarios/collections
|
|
|
|
func (h *Hub) parseIndex() error {
|
|
|
|
bidx, err := os.ReadFile(h.local.HubIndexFile)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("unable to read index file: %w", err)
|
|
|
|
}
|
2023-10-17 14:17:37 +00:00
|
|
|
|
2023-11-07 09:27:33 +00:00
|
|
|
if err := json.Unmarshal(bidx, &h.Items); err != nil {
|
|
|
|
return fmt.Errorf("failed to unmarshal index: %w", err)
|
2023-10-17 14:17:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
log.Debugf("%d item types in hub index", len(ItemTypes))
|
|
|
|
|
|
|
|
// Iterate over the different types to complete the struct
|
|
|
|
for _, itemType := range ItemTypes {
|
2023-11-07 09:27:33 +00:00
|
|
|
log.Tracef("%s: %d items", itemType, len(h.Items[itemType]))
|
2023-10-17 14:17:37 +00:00
|
|
|
|
2023-11-07 09:27:33 +00:00
|
|
|
for name, item := range h.Items[itemType] {
|
2023-11-09 14:19:38 +00:00
|
|
|
item.hub = h
|
2023-10-17 14:17:37 +00:00
|
|
|
item.Name = name
|
2023-11-06 16:35:33 +00:00
|
|
|
|
|
|
|
// if the item has no (redundant) author, take it from the json key
|
|
|
|
if item.Author == "" && strings.Contains(name, "/") {
|
|
|
|
item.Author = strings.Split(name, "/")[0]
|
|
|
|
}
|
|
|
|
|
2023-10-17 14:17:37 +00:00
|
|
|
item.Type = itemType
|
|
|
|
x := strings.Split(item.RemotePath, "/")
|
|
|
|
item.FileName = x[len(x)-1]
|
|
|
|
|
2023-11-10 09:25:29 +00:00
|
|
|
item.logMissingSubItems()
|
2023-10-17 14:17:37 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-11-07 09:27:33 +00:00
|
|
|
return nil
|
2023-10-17 14:17:37 +00:00
|
|
|
}
|
2023-10-20 12:32:35 +00:00
|
|
|
|
|
|
|
// ItemStats returns total counts of the hub items
|
2023-10-27 08:25:29 +00:00
|
|
|
func (h *Hub) ItemStats() []string {
|
2023-10-20 12:32:35 +00:00
|
|
|
loaded := ""
|
2023-10-30 16:23:50 +00:00
|
|
|
|
2023-10-20 12:32:35 +00:00
|
|
|
for _, itemType := range ItemTypes {
|
|
|
|
if len(h.Items[itemType]) == 0 {
|
|
|
|
continue
|
|
|
|
}
|
2023-10-30 16:23:50 +00:00
|
|
|
|
2023-10-20 12:32:35 +00:00
|
|
|
loaded += fmt.Sprintf("%d %s, ", len(h.Items[itemType]), itemType)
|
|
|
|
}
|
|
|
|
|
|
|
|
loaded = strings.Trim(loaded, ", ")
|
|
|
|
if loaded == "" {
|
|
|
|
// empty hub
|
|
|
|
loaded = "0 items"
|
|
|
|
}
|
|
|
|
|
|
|
|
ret := []string{
|
|
|
|
fmt.Sprintf("Loaded: %s", loaded),
|
|
|
|
}
|
|
|
|
|
|
|
|
if h.skippedLocal > 0 || h.skippedTainted > 0 {
|
|
|
|
ret = append(ret, fmt.Sprintf("Unmanaged items: %d local, %d tainted", h.skippedLocal, h.skippedTainted))
|
|
|
|
}
|
|
|
|
|
|
|
|
return ret
|
|
|
|
}
|