scanner

Documentation

Index

• func InitModules() error
• func RegisterFileScanner(s FileScanner)
• func RegisterProcScanner(s ProcScanner)
• func RegisterSystemScanner(s SystemScanner)
• func ScanFile(path string) (err error)
• func ScanProc(proc ps.Process) (err error)
• func ScanSystem() (err error)
• type FileScanner
• type ProcScanner
• type Scanner
• type SystemScanner

Functions

func InitModules

func InitModules() error

func RegisterFileScanner

func RegisterFileScanner(s FileScanner)

RegisterFileScanner is called by a file scanner module's init() function to register the module so that it is called via the ScanFile function

func RegisterProcScanner

func RegisterProcScanner(s ProcScanner)

RegisterProcScanner is called by a proc scanner module's init() function to register the module so that it is called via the ScanProc function

func RegisterSystemScanner

func RegisterSystemScanner(s SystemScanner)

RegisterSystemScanner is called by a system scanner module's init() function to register the module so that it is called via the ScanSystem function

func ScanFile

func ScanFile(path string) (err error)

func ScanProc

func ScanProc(proc ps.Process) (err error)

func ScanSystem

func ScanSystem() (err error)

Types

type FileScanner

type FileScanner interface {
	Scanner
	ScanFile(afero.File) error
}

FileScanner scans are run after SystemScanner scans. The ScanFile method is run for every file.

type ProcScanner

type ProcScanner interface {
	Scanner
	ScanProc(ps.Process) error
}

ProcScanner scans are run after SystemScanner scans. The ScanProc ismethod is run for every process that can be accessed, except for Spyre itself.

type Scanner

type Scanner interface {
	// used in logs
	FriendlyName() string
	// used as config section
	ShortName() string
	Init(*config.ScannerConfig) error
}

type SystemScanner

type SystemScanner interface {
	Scanner
	Scan() error
}

SystemScanner scans are run right after Spyre initialization. They are desgined to check for "simple" queryable facts such as Mutexes etc.