enrichment

Documentation

Index

• func EnrichDevice(ctx context.Context, d EnrichDeviceRequest) (model.Device, error)
• func PortScannerFilter(cfg *PortScanConfig) model.DeviceFilter
• func SetFlags(fs *pflag.FlagSet, cfg *Config)
• type Config
• type DnsConfig
• type EnrichAllDevicesEvent
  • func (e EnrichAllDevicesEvent) String() string
• type EnrichDeviceRequest
  • func (e EnrichDeviceRequest) String() string
• type EnrichmentFields
  • func DefaultEnrichmentFields(cfg *Config) EnrichmentFields
  • func (e EnrichmentFields) String() string
• type OuiConfig
• type PortScanConfig
• type SnmpConfig
• type Worker
  • func NewWorker() *Worker
  • func (w *Worker) Close()
  • func (w *Worker) Run(ctx context.Context, max int)

Functions

func EnrichDevice

func EnrichDevice(ctx context.Context, d EnrichDeviceRequest) (model.Device, error)

func PortScannerFilter

func PortScannerFilter(cfg *PortScanConfig) model.DeviceFilter

func SetFlags

func SetFlags(fs *pflag.FlagSet, cfg *Config)

Types

type Config

type Config struct {
	Enabled    bool
	MaxWorkers int
	Dns        *DnsConfig
	Oui        *OuiConfig
	PortScan   *PortScanConfig
	Snmp       *SnmpConfig
}

type DnsConfig

type DnsConfig struct {
	Enabled bool
}

type EnrichAllDevicesEvent

type EnrichAllDevicesEvent EnrichmentFields

func (EnrichAllDevicesEvent) String

func (e EnrichAllDevicesEvent) String() string

type EnrichDeviceRequest

type EnrichDeviceRequest struct {
	Fields EnrichmentFields
	Device model.Device
}

func (EnrichDeviceRequest) String

func (e EnrichDeviceRequest) String() string

type EnrichmentFields

type EnrichmentFields struct {
	PerformDNSLookup bool
	PerformOUILookup bool
	PerformPortScan  bool
	PerformSNMPScan  bool
	Cfg              *Config
}

TODO: This should probably go away and just use the EnrichmentConfig

func DefaultEnrichmentFields

func DefaultEnrichmentFields(cfg *Config) EnrichmentFields

func (EnrichmentFields) String

func (e EnrichmentFields) String() string

type OuiConfig

type OuiConfig struct {
	Enabled bool
}

type PortScanConfig

type PortScanConfig struct {
	Enabled             bool
	Timeout             time.Duration
	MaxWorkers          int
	DefaultScanInterval time.Duration
	ServerScanInterval  time.Duration
	PortList            string
}

type SnmpConfig

type SnmpConfig struct {
	Enabled   bool
	Timeout   time.Duration
	Community []string
	Ports     []int
}

type Worker

type Worker struct {
	In chan EnrichDeviceRequest
	*workerpool.Pool[EnrichDeviceRequest, model.Device]
}

func NewWorker

func NewWorker() *Worker

func (*Worker) Close

func (w *Worker) Close()

func (*Worker) Run

func (w *Worker) Run(ctx context.Context, max int)