backend

Documentation

Index

• Variables
• type MetaEngine
  • func OpenMetaEngine(prefix string) (*MetaEngine, error)
  • func (m *MetaEngine) Close()
  • func (m *MetaEngine) LookupCity(h *data.Host) (string, error)
  • func (m *MetaEngine) LookupCountry(h *data.Host) (string, error)
  • func (m *MetaEngine) LookupOperatingSystem(h *data.HostWithPorts) string
  • func (m *MetaEngine) UpdateMetadata() error
• type Nexus
  • func CreateNexus(gen *generator.HostGenerator, scanner *Scanner, xfr *xfr.Client) (*Nexus, error)
  • func (nx *Nexus) GetGeneratorCount() int
  • func (nx *Nexus) GetScannerCount() int
  • func (nx *Nexus) GetXFRCount() int
  • func (nx *Nexus) SpawnWorker(f facility.Facility, n int)
  • func (nx *Nexus) StopWorker(f facility.Facility, n int)
  • func (nx *Nexus) UpdateMetadata()
  • func (nx *Nexus) WorkerCount(f facility.Facility) int
• type Scanner
  • func CreateScanner(workerCnt int) (*Scanner, error)
  • func (sc *Scanner) Count() int
  • func (sc *Scanner) IsRunning() bool
  • func (sc *Scanner) Loop()
  • func (sc *Scanner) PrintStatus()
  • func (sc *Scanner) Start()
  • func (sc *Scanner) Stop()

Variables

var Ports []uint16 = []uint16{
	21,
	22,
	23,
	25,
	53,
	79,
	80,
	110,
	143,
	161,
	443,
	631,
	1024,
	4444,
	2525,
	5353,
	5800,
	5900,
	8000,
	8080,
	8081,
}

Ports is the list of ports (TCP and UDP) we consider interesting.

Types

type MetaEngine

type MetaEngine struct {
	// contains filtered or unexported fields

} // type MetaEngine struct

MetaEngine processes metadata on Hosts.

func OpenMetaEngine

func OpenMetaEngine(prefix string) (*MetaEngine, error)

OpenMetaEngine creates a new MetaEngine.

func (*MetaEngine) Close

func (m *MetaEngine) Close()

Close closes the MetaEngine.

func (*MetaEngine) LookupCity

func (m *MetaEngine) LookupCity(h *data.Host) (string, error)

LookupCity attempts to determine what city a Host is located in.

func (*MetaEngine) LookupCountry

func (m *MetaEngine) LookupCountry(h *data.Host) (string, error)

LookupCountry attempts to determine what county a Host is located in.

func (*MetaEngine) LookupOperatingSystem

func (m *MetaEngine) LookupOperatingSystem(h *data.HostWithPorts) string

LookupOperatingSystem attempts to determine what OS a Host is running.

func (*MetaEngine) UpdateMetadata

func (m *MetaEngine) UpdateMetadata() error

UpdateMetadata refreshes the location and OS metadata for all hosts.

type Nexus

type Nexus struct {
	// contains filtered or unexported fields
}

Nexus aggregates the various pieces that comprise the backend.

func CreateNexus

func CreateNexus(gen *generator.HostGenerator, scanner *Scanner, xfr *xfr.Client) (*Nexus, error)

CreateNexus creates a new Nexus instance with the given components.

func (*Nexus) GetGeneratorCount

func (nx *Nexus) GetGeneratorCount() int

GetGeneratorCount returns the number of workers in the Generator.

func (*Nexus) GetScannerCount

func (nx *Nexus) GetScannerCount() int

GetScannerCount returns the number of workers in the Scanner

func (*Nexus) GetXFRCount

func (nx *Nexus) GetXFRCount() int

GetXFRCount returns the number of XFR workers.

func (*Nexus) SpawnWorker

func (nx *Nexus) SpawnWorker(f facility.Facility, n int)

SpawnWorker spawns <n> new workers in the specified facility.

func (*Nexus) StopWorker

func (nx *Nexus) StopWorker(f facility.Facility, n int)

StopWorker stops <n> workers in the specified facility.

func (*Nexus) UpdateMetadata

func (nx *Nexus) UpdateMetadata()

UpdateMetadata triggers an update of the metadata for all hosts.

func (*Nexus) WorkerCount

func (nx *Nexus) WorkerCount(f facility.Facility) int

WorkerCount returns the number of active workers in the given facility.

type Scanner

type Scanner struct {
	RC chan data.ControlMessage
	// contains filtered or unexported fields
}

Scanner is a port scanner. Kind of.

func CreateScanner

func CreateScanner(workerCnt int) (*Scanner, error)

CreateScanner creates a new Scanner.

func (*Scanner) Count

func (sc *Scanner) Count() int

Count returns the number of active workers

func (*Scanner) IsRunning

func (sc *Scanner) IsRunning() bool

IsRunning returns true if the Scanner is running.

func (*Scanner) Loop

func (sc *Scanner) Loop()

Loop is the Scanner's main loop.

func (*Scanner) PrintStatus

func (sc *Scanner) PrintStatus()

PrintStatus emits the Scanner's status.

func (*Scanner) Start

func (sc *Scanner) Start()

Start starts the Scanner. If it is already running, this method does nothing.

func (*Scanner) Stop

func (sc *Scanner) Stop()

Stop tells the Scanner to stop.