scanner

Documentation

Index

• func InitModules() error
• func RegisterFileScanner(s FileScanner)
• func RegisterSystemScanner(s SystemScanner)
• func ScanFile(f afero.File) (err error)
• func ScanSystem() (err error)
• type FileScanner
• 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 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(f afero.File) (err error)

func ScanSystem

func ScanSystem() (err error)

Types

type FileScanner

type FileScanner interface {
	Name() string
	Init() error
	ScanFile(afero.File) error
}

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

type SystemScanner

type SystemScanner interface {
	Name() string
	Init() error
	Scan() error
}

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