nfs

Documentation

Index

• Constants
• func CheckSetup() error
• func Setup(logger utils.Logger) error
• type Result
• type Scanner
  • func NewScanner(logger utils.Logger, target string, crawlDepth int, threads int, ...) (*Scanner, error)
  • func (s *Scanner) Run(timeout time.Duration) (res *Result)

Constants

const Label = "Nfs"

Functions

func CheckSetup

func CheckSetup() error

CheckSetup checks whether Setup() executed accordingly. Scan arguments should be checked by the scanner.

func Setup

func Setup(logger utils.Logger) error

Setup configures the environment accordingly, if the scan module has some special requirements. A successful setup is required before a scan can be started.

Types

type Result

type Result struct {
	filecrawler.Result // nfs result wrapped filecrawler result to allow broker distinguishing smb/nfs results by type
}

type Scanner

type Scanner struct {
	Label    string
	Started  time.Time
	Finished time.Time
	// contains filtered or unexported fields
}

func NewScanner

func NewScanner(
	logger utils.Logger,
	target string,
	crawlDepth int,
	threads int,
	excludedShares []string,
	excludedFolders []string,
	excludedExtensions []string,
	excludedLastModifiedBelow time.Time,
	excludedFileSizeBelow int,
	onlyAccessibleFiles bool,
	mountTimeout time.Duration,
) (*Scanner, error)

func (*Scanner) Run

func (s *Scanner) Run(timeout time.Duration) (res *Result)

Run starts scan execution. This must either be executed as a goroutine, or another thread must be active listening on the scan's result channel, in order to avoid a deadlock situation.