modules

Documentation

Index

• func GetModuleList() []string
• type Module
  • func NewModule(modulePath string) (Module, error)
• type Option
• type PowerShell

Functions

func GetModuleList

func GetModuleList() []string

GetModuleList generates and returns a list of all modules in Merlin's "module" directory folder. Used with tab completion

Types

type Module

type Module struct {
	Agent        uuid.UUID // The Agent that will later be associated with this module prior to execution
	Name         string    `json:"name"`        // Name of the module
	Type         string    `json:"type"`        // Type of module (i.e., standard or extended)
	Author       []string  `json:"author"`      // A list of module authors
	Credits      []string  `json:"credits"`     // A list of people to credit for underlying tool or techniques
	Path         []string  `json:"path"`        // Path to the module (i.e., data/modules/powershell/powerview)
	Platform     string    `json:"platform"`    // Platform that the module can run on (i.e., Windows, Linux, Darwin, or ALL)
	Arch         string    `json:"arch"`        // The Architecture the module can run on (i.e., x86, x64, MIPS, ARM, or ALL)
	Lang         string    `json:"lang"`        // What language does the module execute in (i.e., PowerShell, Python, or Perl)
	Priv         bool      `json:"privilege"`   // Does this module require a privileged level account like root or SYSTEM?
	Description  string    `json:"description"` // A description of what the module does
	Notes        string    `json:"notes"`       // Additional information or notes about the module
	Commands     []string  `json:"commands"`    // A list of commands to be run on the agent
	SourceRemote string    `json:"remote"`      // Online or remote source code for a module
	SourceLocal  []string  `json:"local"`       // The local file path to the script or payload
	Options      []Option  `json:"options"`     // A list of configurable options/arguments for the module

	Powershell interface{} `json:"powershell,omitempty"` // An option json object containing commands and configuration items specific to PowerShell
	IsExtended bool        // Is this an extended module?
	// contains filtered or unexported fields
}

Module is a structure containing the base information or template for modules

func NewModule

func NewModule(modulePath string) (Module, error)

NewModule is a factory to instantiate a module object using the provided file path to a module's json file

type Option

type Option struct {
	Name        string `json:"name"`        // Name of the option
	Value       string `json:"value"`       // Value of the option
	Required    bool   `json:"required"`    // Is this a required option?
	Flag        string `json:"flag"`        // The command line flag used for the option
	Description string `json:"description"` // A description of the option
}

Option is a structure containing the keys for the object

type PowerShell

type PowerShell struct {
	DisableAV   bool // Disable Windows Real Time "Set-MpPreference -DisableRealtimeMonitoring $true"
	Obfuscation bool // Unimplemented command to obfuscated powershell
	Base64      bool // Base64 encode the powershell command?
}

PowerShell structure is used to describe additional PowerShell features for modules that leverage PowerShell