systems

Documentation

Index

• type LocalSystem
  • func NewLocalSystem(c *config.Config) (*LocalSystem, error)
  • func (l *LocalSystem) AddAndStart(srv requests.Service) error
  • func (l *LocalSystem) AddSource(srv requests.Service) error
  • func (l *LocalSystem) Config() *config.Config
  • func (l *LocalSystem) DataSources() []requests.Service
  • func (l *LocalSystem) GetAllSourceNames() []string
  • func (l *LocalSystem) GraphDatabases() []*graph.Graph
  • func (l *LocalSystem) Pool() resolvers.Resolver
  • func (l *LocalSystem) SetDataSources(sources []requests.Service)
  • func (l *LocalSystem) Shutdown() error
• type System

Types

type LocalSystem

type LocalSystem struct {
	sync.Mutex
	// 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 requests.Service) error

AddAndStart implements the System interface.

func (*LocalSystem) AddSource

func (l *LocalSystem) AddSource(srv requests.Service) error

AddSource 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() []requests.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) GraphDatabases

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

GraphDatabases implements the System interface.

func (*LocalSystem) Pool

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

Pool implements the System interface.

func (*LocalSystem) SetDataSources

func (l *LocalSystem) SetDataSources(sources []requests.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() resolvers.Resolver

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

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

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

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

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

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

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