gomsf

README

gomsf

... I choose you!

gomsf is a go library for interacting with Metasploits msgpack-RPC API.

gomsf exposes methods for all RPC endpoints for the open source edition of Metasploit.

Functions are written using camelCase instead of snake_case like in the MSF API documentation, thus

session.meterpreter_run_single

becomes

sessionMeterpreterRunSingle

which has the signature of

session.meterpreter_run_single( String: SessionID, String: Command )

(from the MSFAPI documentation)

... which means you can run it like....

rpcObject.sessionMeterpreterRunSingle(0, "getuid")

and then you could call sessionMeterpreterRead and read the output.

gomsf also exposes a Call function which you can use to direcly communicate with the connected rpc server.

func (r *RPC) Call(args ...interface{})

*Most of the API calls that don't have any tests HAVE NOT been tested, you have been warned.

LICENSE

See LICENSE file.

Documentation

Index

• type RPC
  • func (r *RPC) AuthLogin(username, password string) (s authTokenGenerateStruct)
  • func (r *RPC) AuthLogout() (s resultStruct)
  • func (r *RPC) AuthTokenAdd(newToken string) (s resultStruct)
  • func (r *RPC) AuthTokenGenerate() (s authTokenGenerateStruct)
  • func (r *RPC) AuthTokenList() (s []string)
  • func (r *RPC) AuthTokenRemove(token string) (s resultStruct)
  • func (r *RPC) Call(args ...interface{}) map[string]interface{}
  • func (r *RPC) ConsoleCreate() (s consoleStruct)
  • func (r *RPC) ConsoleDestroy(consoleId int) (s resultStruct)
  • func (r *RPC) ConsoleList() (s []consoleStruct)
  • func (r *RPC) ConsoleRead(consoleId string) (s consoleStruct)
  • func (r *RPC) ConsoleSessionDetach(consoleId string) (s resultStruct)
  • func (r *RPC) ConsoleSessionKill(consoleId string) (s resultStruct)
  • func (r *RPC) ConsoleTabs(consoleId string, inputLine string) (s []string)
  • func (r *RPC) ConsoleWrite(consoleId string, data string) (s consoleWriteStruct)
  • func (r *RPC) CoreAddModulePath(path string) (s coreModuleStatsStruct)
  • func (r *RPC) CoreModuleStats() (s coreModuleStatsStruct)
  • func (r *RPC) CoreReloadModules() (s coreModuleStatsStruct)
  • func (r *RPC) CoreSave() (s resultStruct)
  • func (r *RPC) CoreSetg(optionName, optionValue string) (s resultStruct)
  • func (r *RPC) CoreStop() (s resultStruct)
  • func (r *RPC) CoreThreadKill(threadId string) (s resultStruct)
  • func (r *RPC) CoreThreadList()
  • func (r *RPC) CoreUnsetg(optionName string) (s resultStruct)
  • func (r RPC) CoreVersion() (s coreVersionStruct)
  • func (r *RPC) JobInfo(jobId string) (s jobStruct)
  • func (r *RPC) JobList() (s map[int]string)
  • func (r *RPC) JobStop(jobId string) (s resultStruct)
  • func (r *RPC) ModuleAuxiliary() (s []string)
  • func (r *RPC) ModuleCompatiblePayloads(moduleName string) (s []string)
  • func (r *RPC) ModuleCompatibleSessions(moduleName string) (s []string)
  • func (r *RPC) ModuleEncode(data, encoderModule string, options map[string]interface{}) (s encodedStruct)
  • func (r *RPC) ModuleEncoders() (s []string)
  • func (r *RPC) ModuleExecute(moduleType, moduleName string, datastore map[string]interface{}) (s int)
  • func (r *RPC) ModuleExploits() (s []string)
  • func (r *RPC) ModuleInfo(moduleType, moduleName string) (s moduleStruct)
  • func (r *RPC) ModuleNops() (s []string)
  • func (r *RPC) ModuleOptions(moduleType, moduleName string) (s map[string]moduleOptionStruct)
  • func (r *RPC) ModulePayloads() (s []string)
  • func (r *RPC) ModulePost() (s []string)
  • func (r *RPC) ModuleTargetCompatiblePayloads(moduleName string, targetIndex int) (s []string)
  • func (r *RPC) PluginLoad(pluginName string, options map[string]interface{}) (s resultStruct)
  • func (r *RPC) PluginLoaded() (s []string)
  • func (r *RPC) PluginUnload(pluginName string) (s resultStruct)
  • func (r *RPC) SessionCompatibleModules(sessionId string) (s []string)
  • func (r *RPC) SessionList() (s map[int]sessionStruct)
  • func (r *RPC) SessionMeterpreterRead(sessionId string) (s dataStruct)
  • func (r *RPC) SessionMeterpreterScript(sessionId, scriptName string) (s resultStruct)
  • func (r *RPC) SessionMeterpreterSessionDetach(sessionId string) (s resultStruct)
  • func (r *RPC) SessionMeterpreterSessionKill(sessionId string) (s resultStruct)
  • func (r *RPC) SessionMeterpreterSingleRun(sessionId, command string) (s resultStruct)
  • func (r *RPC) SessionMeterpreterTabs(sessionId, inputLine string) (s []string)
  • func (r *RPC) SessionMeterpreterWrite(sessionId, data string) (s resultStruct)
  • func (r *RPC) SessionRingClear(sessionId string) (s resultStruct)
  • func (r *RPC) SessionRingLast(sessionId string) (s seqStruct)
  • func (r *RPC) SessionRingPut(sessionId, data string) (s shellWriteStruct)
  • func (r *RPC) SessionRingRead(sessionId string) (s shellReadStruct)
  • func (r *RPC) SessionShellRead(sessionId string) (s shellReadStruct)
  • func (r *RPC) SessionShellUpgrade(sessionId, connectHost, connectPort string) (s resultStruct)
  • func (r *RPC) SessionShellWrite(sessionId, data string) (s shellWriteStruct)
  • func (r *RPC) SessionStop(sessionId string) (s resultStruct)

Types

type RPC

type RPC struct {
	Host  string
	Port  int
	Token string
}

func (*RPC) AuthLogin

func (r *RPC) AuthLogin(username, password string) (s authTokenGenerateStruct)

func (*RPC) AuthLogout

func (r *RPC) AuthLogout() (s resultStruct)

func (*RPC) AuthTokenAdd

func (r *RPC) AuthTokenAdd(newToken string) (s resultStruct)

func (*RPC) AuthTokenGenerate

func (r *RPC) AuthTokenGenerate() (s authTokenGenerateStruct)

func (*RPC) AuthTokenList

func (r *RPC) AuthTokenList() (s []string)

func (*RPC) AuthTokenRemove

func (r *RPC) AuthTokenRemove(token string) (s resultStruct)

func (*RPC) Call

func (r *RPC) Call(args ...interface{}) map[string]interface{}

func (*RPC) ConsoleCreate

func (r *RPC) ConsoleCreate() (s consoleStruct)

func (*RPC) ConsoleDestroy

func (r *RPC) ConsoleDestroy(consoleId int) (s resultStruct)

func (*RPC) ConsoleList

func (r *RPC) ConsoleList() (s []consoleStruct)

func (*RPC) ConsoleRead

func (r *RPC) ConsoleRead(consoleId string) (s consoleStruct)

func (*RPC) ConsoleSessionDetach

func (r *RPC) ConsoleSessionDetach(consoleId string) (s resultStruct)

func (*RPC) ConsoleSessionKill

func (r *RPC) ConsoleSessionKill(consoleId string) (s resultStruct)

func (*RPC) ConsoleTabs

func (r *RPC) ConsoleTabs(consoleId string, inputLine string) (s []string)

func (*RPC) ConsoleWrite

func (r *RPC) ConsoleWrite(consoleId string, data string) (s consoleWriteStruct)

func (*RPC) CoreAddModulePath

func (r *RPC) CoreAddModulePath(path string) (s coreModuleStatsStruct)

func (*RPC) CoreModuleStats

func (r *RPC) CoreModuleStats() (s coreModuleStatsStruct)

func (*RPC) CoreReloadModules

func (r *RPC) CoreReloadModules() (s coreModuleStatsStruct)

func (*RPC) CoreSave

func (r *RPC) CoreSave() (s resultStruct)

func (*RPC) CoreSetg

func (r *RPC) CoreSetg(optionName, optionValue string) (s resultStruct)

func (*RPC) CoreStop

func (r *RPC) CoreStop() (s resultStruct)

func (*RPC) CoreThreadKill

func (r *RPC) CoreThreadKill(threadId string) (s resultStruct)

func (*RPC) CoreThreadList

func (r *RPC) CoreThreadList()

func (*RPC) CoreUnsetg

func (r *RPC) CoreUnsetg(optionName string) (s resultStruct)

func (RPC) CoreVersion

func (r RPC) CoreVersion() (s coreVersionStruct)

func (*RPC) JobInfo

func (r *RPC) JobInfo(jobId string) (s jobStruct)

func (*RPC) JobList

func (r *RPC) JobList() (s map[int]string)

func (*RPC) JobStop

func (r *RPC) JobStop(jobId string) (s resultStruct)

func (*RPC) ModuleAuxiliary

func (r *RPC) ModuleAuxiliary() (s []string)

func (*RPC) ModuleCompatiblePayloads

func (r *RPC) ModuleCompatiblePayloads(moduleName string) (s []string)

func (*RPC) ModuleCompatibleSessions

func (r *RPC) ModuleCompatibleSessions(moduleName string) (s []string)

func (*RPC) ModuleEncode

func (r *RPC) ModuleEncode(data, encoderModule string, options map[string]interface{}) (s encodedStruct)

func (*RPC) ModuleEncoders

func (r *RPC) ModuleEncoders() (s []string)

func (*RPC) ModuleExecute

func (r *RPC) ModuleExecute(moduleType, moduleName string, datastore map[string]interface{}) (s int)

func (*RPC) ModuleExploits

func (r *RPC) ModuleExploits() (s []string)

func (*RPC) ModuleInfo

func (r *RPC) ModuleInfo(moduleType, moduleName string) (s moduleStruct)

func (*RPC) ModuleNops

func (r *RPC) ModuleNops() (s []string)

func (*RPC) ModuleOptions

func (r *RPC) ModuleOptions(moduleType, moduleName string) (s map[string]moduleOptionStruct)

func (*RPC) ModulePayloads

func (r *RPC) ModulePayloads() (s []string)

func (*RPC) ModulePost

func (r *RPC) ModulePost() (s []string)

func (*RPC) ModuleTargetCompatiblePayloads

func (r *RPC) ModuleTargetCompatiblePayloads(moduleName string, targetIndex int) (s []string)

func (*RPC) PluginLoad

func (r *RPC) PluginLoad(pluginName string, options map[string]interface{}) (s resultStruct)

func (*RPC) PluginLoaded

func (r *RPC) PluginLoaded() (s []string)

func (*RPC) PluginUnload

func (r *RPC) PluginUnload(pluginName string) (s resultStruct)

func (*RPC) SessionCompatibleModules

func (r *RPC) SessionCompatibleModules(sessionId string) (s []string)

func (*RPC) SessionList

func (r *RPC) SessionList() (s map[int]sessionStruct)

func (*RPC) SessionMeterpreterRead

func (r *RPC) SessionMeterpreterRead(sessionId string) (s dataStruct)

func (*RPC) SessionMeterpreterScript

func (r *RPC) SessionMeterpreterScript(sessionId, scriptName string) (s resultStruct)

func (*RPC) SessionMeterpreterSessionDetach

func (r *RPC) SessionMeterpreterSessionDetach(sessionId string) (s resultStruct)

func (*RPC) SessionMeterpreterSessionKill

func (r *RPC) SessionMeterpreterSessionKill(sessionId string) (s resultStruct)

func (*RPC) SessionMeterpreterSingleRun

func (r *RPC) SessionMeterpreterSingleRun(sessionId, command string) (s resultStruct)

func (*RPC) SessionMeterpreterTabs

func (r *RPC) SessionMeterpreterTabs(sessionId, inputLine string) (s []string)

func (*RPC) SessionMeterpreterWrite

func (r *RPC) SessionMeterpreterWrite(sessionId, data string) (s resultStruct)

func (*RPC) SessionRingClear

func (r *RPC) SessionRingClear(sessionId string) (s resultStruct)

func (*RPC) SessionRingLast

func (r *RPC) SessionRingLast(sessionId string) (s seqStruct)

func (*RPC) SessionRingPut

func (r *RPC) SessionRingPut(sessionId, data string) (s shellWriteStruct)

func (*RPC) SessionRingRead

func (r *RPC) SessionRingRead(sessionId string) (s shellReadStruct)

func (*RPC) SessionShellRead

func (r *RPC) SessionShellRead(sessionId string) (s shellReadStruct)

func (*RPC) SessionShellUpgrade

func (r *RPC) SessionShellUpgrade(sessionId, connectHost, connectPort string) (s resultStruct)

func (*RPC) SessionShellWrite

func (r *RPC) SessionShellWrite(sessionId, data string) (s shellWriteStruct)

func (*RPC) SessionStop

func (r *RPC) SessionStop(sessionId string) (s resultStruct)