instance

Documentation

Index

• Variables
• type Instance
  • func NewInstance(targetpath string, outputformat string, outputPath string, orionRuntime string, ...) (Instance, error)
  • func (i Instance) CloseLogger() error
  • func (i Instance) ForensicMode() bool
  • func (i Instance) GetOrionConfig() configs.Config
  • func (i Instance) GetOrionMode() string
  • func (i Instance) GetOrionModules() ([]string, error)
  • func (i Instance) GetOrionOutputFilepath() string
  • func (i Instance) GetOrionOutputFormat() string
  • func (i Instance) GetOrionRuntime() string
  • func (i Instance) GetTargetPath() string
  • func (i Instance) NoMultithreading() bool
• type InstanceInterface

Variables

var TargetPath string

TargetPath specifies the root target path to reference artifacts from - i.e. <target>/pathToPlist.plist

Types

type Instance

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

func NewInstance

func NewInstance(targetpath string, outputformat string, outputPath string, orionRuntime string, loglevel string, configpath string, mode string, noMultithreading bool, forensicMode bool) (Instance, error)

NewInstance returns a new instance struct based on arguments, should only be called once per run

func (Instance) CloseLogger

func (i Instance) CloseLogger() error

func (Instance) ForensicMode

func (i Instance) ForensicMode() bool

ForensicMode exposes argument flag for running Orion with forensic mode active for each module

func (Instance) GetOrionConfig

func (i Instance) GetOrionConfig() configs.Config

GetOrionConfig returns the Config for this Instance of Orion

func (Instance) GetOrionMode

func (i Instance) GetOrionMode() string

func (Instance) GetOrionModules

func (i Instance) GetOrionModules() ([]string, error)

GetOrionModules returns string slice of modules to run from config file

func (Instance) GetOrionOutputFilepath

func (i Instance) GetOrionOutputFilepath() string

GetOrionOutputFilepath returns the string filepath where output is written, relative to Orion

func (Instance) GetOrionOutputFormat

func (i Instance) GetOrionOutputFormat() string

GetOrionOutputFormat returns the name of the output file type (csv, xlsx, etc.)

func (Instance) GetOrionRuntime

func (i Instance) GetOrionRuntime() string

GetOrionRuntime returns the name of the Orion runtime

func (Instance) GetTargetPath

func (i Instance) GetTargetPath() string

GetTargetPath returns the string representing the path to the target for modules

func (Instance) NoMultithreading

func (i Instance) NoMultithreading() bool

NoMultithreading exposes argument flag for running Orion with goroutines for each module

type InstanceInterface

type InstanceInterface interface {
	// GetOrionWriter() datawriter.OrionWriter
	GetOrionConfig() configs.Config
	GetOrionRuntime() string
	GetOrionModules() []string
	Logger() *zap.Logger
	NoMultithreading() bool
}