systems

Documentation

Index

• func PopulateCache(ctx context.Context, asn int, sys System)
• type LocalSystem
  • func NewLocalSystem(c *config.Config) (*LocalSystem, error)
  • func (l *LocalSystem) AddAndStart(srv service.Service) error
  • func (l *LocalSystem) AddSource(src service.Service) error
  • func (l *LocalSystem) Cache() *requests.ASNCache
  • func (l *LocalSystem) Config() *config.Config
  • func (l *LocalSystem) DataSources() []service.Service
  • func (l *LocalSystem) GetAllSourceNames() []string
  • func (l *LocalSystem) GetMemoryUsage() uint64
  • func (l *LocalSystem) GraphDatabases() []*netmap.Graph
  • func (l *LocalSystem) Pool() resolve.Resolver
  • func (l *LocalSystem) SetDataSources(sources []service.Service)
  • func (l *LocalSystem) Shutdown() error
• type System

Functions

func PopulateCache

func PopulateCache(ctx context.Context, asn int, sys System)

PopulateCache updates the provided System cache with ASN information from the System data sources.

Types

type LocalSystem

type LocalSystem struct {
	Cfg *config.Config
	// contains filtered or unexported fields
}

LocalSystem implements a System to be executed within a single process.

func NewLocalSystem

func NewLocalSystem(c *config.Config) (*LocalSystem, error)

NewLocalSystem returns an initialized LocalSystem object.

func (*LocalSystem) AddAndStart

func (l *LocalSystem) AddAndStart(srv service.Service) error

AddAndStart implements the System interface.

func (*LocalSystem) AddSource

func (l *LocalSystem) AddSource(src service.Service) error

AddSource implements the System interface.

func (*LocalSystem) Cache

func (l *LocalSystem) Cache() *requests.ASNCache

Cache implements the System interface.

func (*LocalSystem) Config

func (l *LocalSystem) Config() *config.Config

Config implements the System interface.

func (*LocalSystem) DataSources

func (l *LocalSystem) DataSources() []service.Service

DataSources implements the System interface.

func (*LocalSystem) GetAllSourceNames

func (l *LocalSystem) GetAllSourceNames() []string

GetAllSourceNames returns the names of all the available data sources.

func (*LocalSystem) GetMemoryUsage

func (l *LocalSystem) GetMemoryUsage() uint64

GetMemoryUsage returns the number bytes allocated to heap objects on this system.

func (*LocalSystem) GraphDatabases

func (l *LocalSystem) GraphDatabases() []*netmap.Graph

GraphDatabases implements the System interface.

func (*LocalSystem) Pool

func (l *LocalSystem) Pool() resolve.Resolver

Pool implements the System interface.

func (*LocalSystem) SetDataSources

func (l *LocalSystem) SetDataSources(sources []service.Service)

SetDataSources assigns the data sources that will be used by the system.

func (*LocalSystem) Shutdown

func (l *LocalSystem) Shutdown() error

Shutdown implements the System interface.

type System

type System interface {
	// Returns the configuration for the enumeration this service supports
	Config() *config.Config

	// Returns the resolver pool that handles DNS requests
	Pool() resolve.Resolver

	// Returns the cache populated by the system
	Cache() *requests.ASNCache

	// AddSource appends the provided data source to the slice of sources managed by the System
	AddSource(srv service.Service) error

	// AddAndStart starts the provided data source and then appends it to the slice of sources
	AddAndStart(srv service.Service) error

	// DataSources returns the slice of data sources managed by the System
	DataSources() []service.Service

	// SetDataSources assigns the data sources that will be used by System
	SetDataSources(sources []service.Service)

	// GraphDatabases return the Graphs used by the System
	GraphDatabases() []*netmap.Graph

	// GetMemoryUsage() returns the number bytes allocated to heap objects on this system
	GetMemoryUsage() uint64

	// Shutdown will shutdown the System
	Shutdown() error
}

System is the object type for managing services that perform various reconnaissance activities.