package module

Get desktop application:
View/edit binary Protocol Buffers messages

ModuleRPC - A little RPC service providing methods for module objects, with which they can track and synchronise state between their stack version and the server's. All other elements that the modules will need, per type, will be registered by them. Here, the client is the Wiregost's server Module Manager, and the RPC server is the stack binary with all up-to-date compiled modules.

• rpc GetInfo (InfoRequest, Info)

  module.proto:38

• rpc GetOptions (OptionsRequest, Options)

  module.proto:39

• rpc RunModule (RunRequest, Run)

  module.proto:37

• rpc SetOption (SetOptionRequest, Option)

  module.proto:40

• rpc UseModule (UseRequest, Use)

  module.proto:36

Stack - This RPC service provides client consoles with methods to query, setup and use modules in Wiregost.

• rpc ClearStack (ClearRequest, Clear)

  stack.proto:42

  message ClearRequest

  stack.proto:71

  ClearRequest - Clears all modules from the user's stack

  • optional client.Client Client = 6

    User authentication, needed to dispatch

  message Clear

  stack.proto:76

  • string Err = 1

• rpc EditModule (EditRequest, Edit)

  stack.proto:36

  message EditRequest

  module.proto:124

  EditRequest - Edit one of the module files

  • string Path = 2

  • optional client.Client Client = 6

    User authentication, needed to dispatch

  message Edit

  module.proto:130

  • string Err = 2

• rpc GetInfo (InfoRequest, Info)

  stack.proto:33

• rpc GetOptions (OptionsRequest, Options)

  stack.proto:34

• rpc PopModule (PopRequest, Pop)

  stack.proto:40

  message PopRequest

  stack.proto:47

  PopRequest - Pop one or more modules from the user stack

  • repeated string Path = 3

  • bool All = 4

    Pop all modules from stack

  • optional client.Client Client = 6

    User authentication, needed to dispatch

  message Pop

  stack.proto:54

  • optional Module Next = 1

    Sends next module on stack: empty if none left

  • string Err = 2

• rpc PushModule (PushRequest, Push)

  stack.proto:41

  message PushRequest

  stack.proto:60

  PushRequest - Push one or more modules onto the user stack

  • repeated string Path = 3

  • optional client.Client Client = 6

    User authentication, needed to dispatch

  message Push

  stack.proto:66

  • string Err = 1

• rpc ReloadModule (ReloadRequest, Reload)

  stack.proto:43

  message ReloadRequest

  stack.proto:81

  ReloadRequest - Recompile and reload the module stack.

  • optional client.Client Client = 6

    User authentication, needed to dispatch

  message Reload

  stack.proto:86

  • string Err = 1

• rpc RunModule (RunRequest, Run)

  stack.proto:32

  Module commands

• rpc SetOption (SetOptionRequest, Option)

  stack.proto:35

• rpc UseModule (UseRequest, Use)

  stack.proto:39

  Stack commands

Command - A module may expose various subcommands, for triggering different functions.

Used in: Module, RunRequest

• string Name = 1

  Command name

• string Description = 2

  Description

• bool HasPayload = 3

  Some commands trigger exploits, themselves requiring to action payloads.

Info - This structure is shared by all modules, independently of their type.

Used as response type in: ModuleRPC.GetInfo, Stack.GetInfo

Used as field type in: Module

• string Name = 1

  Base information

  Module Name

• Type Type = 2

  Type of module

• string Path = 3

  Path to module in modules directory

• string Description = 4

  A description for this module

• string Notes = 5

  Additional notes

• repeated Info.Reference References = 6

  Any reference useful to the user

• repeated string Authors = 7

  Module authors

• repeated string Credits = 8

  Other credits

• repeated string Targets = 9

  A list of operating systems on which the module can be run

• string Arch = 10

  Supported architecture

• string Language = 11

  Implementation language of the module

• bool Priviledged = 12

  Does the module requires administrator privileges to be run ?

A CVE,EDB, CWE, etc. reference identifier.

Used in: Info

• repeated string ID = 1

InfoRequest - Request the module's metadata information only

Used as request type in: ModuleRPC.GetInfo, Stack.GetInfo

• string Path = 3

  Module Path

• optional client.Client Client = 6

  User authentication, needed to dispatch

Level - Some components in Wiregost will push to the event system through logger hooks, for more granular output of log information, especially for modules.

Used in: Log, ModuleLog

• TRACE = 0

• DEBUG = 1

• INFO = 2

• WARNING = 3

• ERROR = 4

• SUCCESS = 5

Log - A log message sent by a module back to a console. The Manager will, in-between, log it to files if needed. The ideal would be to pass a logrus.Entry like object.

• Level Level = 1

• string Message = 2

• bool Pending = 3

• optional google.protobuf.Timestamp Time = 38

• string ClientID = 5

  Client passes its ID for mapping the console to modules being used.

Module - A module object, with properties and options

Used in: Pop, Run, Use

• optional Info Info = 1

  Module metadata information

• map<string, Command> Commands = 14

  The module can run different actions, with different commands

• map<string, Option> Options = 13

  All options for this module. Send a list with them, for retrieving order.

ModuleLog - Used by the module event stream client to identify itself during the stream setup

• string ClientID = 1

  Client passes its ID for mapping the console to modules being used.

• Level Level = 2

  What level of logging is desired

Option - An option used by the module

Used as response type in: ModuleRPC.SetOption, Stack.SetOption

Used as field type in: Module, Options

• string Name = 1

  Option name

• string Category = 2

  Options can be classified according to user preferences

• string Value = 3

  Option value, is always a string and converted later if needed

• bool Required = 5

  Is this option required ? If yes it should already have a value

• string Flag = 6

  Sometimes the option value is used as a flag in a command line, so it might have a different form.

• string Description = 7

  A description for this option.

Used as response type in: ModuleRPC.GetOptions, Stack.GetOptions

• string Err = 2

• map<string, Option> Options = 13

  All options for this module. Send a list with them, for retrieving order.

OptionsRequest - Get all options of a module

Used as request type in: ModuleRPC.GetOptions, Stack.GetOptions

• string Path = 2

Used as response type in: ModuleRPC.RunModule, Stack.RunModule

• bool Success = 1

• string Result = 2

• string Err = 3

• optional Module Updated = 5

  used when parsing profiles

RunRequest - Run the one of the functions of the module

Used as request type in: ModuleRPC.RunModule, Stack.RunModule

• uint64 RequestID = 1

  Uniquely identify the request, so that any further module output is redirected to the good console

• uint32 WorkspaceID = 2

• string Path = 3

  Module Path

• optional Command Command = 4

  The precise action to trigger

• string Options = 5

  Any option or argument need, such as profile name

• optional client.Client Client = 6

  User authentication, needed to dispatch

• bool Success = 1

• string Err = 2

• optional client.Client Client = 6

  User authentication, needed to dispatch

SetOptionRequest - Set an option for the module

Used as request type in: ModuleRPC.SetOption, Stack.SetOption

• uint32 WorkspaceID = 1

• string Path = 2

• string Name = 3

• string Value = 4

• optional client.Client Client = 6

  User authentication, needed to dispatch

Module Types

Used in: Info

• UNDEFINED = 0

  Just in case

• PAYLOAD = 1

• EXPLOIT = 2

• POST = 3

• TRANSPORT = 4

Used as response type in: ModuleRPC.UseModule, Stack.UseModule

• optional Module Loaded = 1

• string Err = 2

UseRequest - Load a module onto the stack

Used as request type in: ModuleRPC.UseModule, Stack.UseModule

• string Path = 1

• optional client.Client Client = 6

  User authentication, needed to dispatch