scanners

Documentation

Index

• type APIScanner
• type FSScanner
• type WriteFileFS

Types

type APIScanner

type APIScanner interface {
	// Name provides the human-readable name of the scanner e.g. "AWS API"
	Name() string

	// Scan scans an API and returns results
	Scan(ctx context.Context) (scan.Results, error)
}

type FSScanner

type FSScanner interface {
	// Name provides the human-readable name of the scanner e.g. "CloudFormation"
	Name() string
	// ScanFS scans the given filesystem for issues, starting at the provided directory.
	// Use '.' to scan an entire filesystem.
	ScanFS(ctx context.Context, fs fs.FS, dir string) (scan.Results, error)
}

type WriteFileFS

type WriteFileFS interface {
	WriteFile(name string, data []byte, perm os.FileMode) error
}