console

Documentation

Index

• func Run() error
• func RunWith(mod sdk.Exploit) error
• type ClearOutputMsg
• type Console
  • func New() *Console
  • func (c *Console) ApplyFuzzyResult(context, selected string)
  • func (c *Console) BuildPrompt() string
  • func (c *Console) Exec(line string) bool
  • func (c *Console) Mod() sdk.Exploit
  • func (c *Console) OptionNames() []string
  • func (c *Console) Options() []Option
  • func (c *Console) Program() MsgSender
  • func (c *Console) SendClear()
  • func (c *Console) SessionHandler() c2.SessionHandler
  • func (c *Console) SetMod(mod sdk.Exploit)
  • func (c *Console) SetOpt(name, value string) bool
  • func (c *Console) SetProgram(p MsgSender)
  • func (c *Console) ShutdownBackend()
  • func (c *Console) UseByName(name string)
• type FuzzyItem
• type FuzzySelectMsg
• type MsgSender
• type Option
• type SessionInteractMsg

Functions

func Run

func Run() error

Run starts the readline-based interactive console.

func RunWith

func RunWith(mod sdk.Exploit) error

RunWith starts the readline-based console with an optional pre-selected module.

Types

type ClearOutputMsg

type ClearOutputMsg = types.ClearOutputMsg

Shared message type aliases (from pkg/types to break import cycles).

type Console

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

Console holds the state for the interactive REPL.

func New

func New() *Console

New creates a Console with registered commands.

func (*Console) ApplyFuzzyResult

func (c *Console) ApplyFuzzyResult(context, selected string)

ApplyFuzzyResult handles the result of a fuzzy selection.

func (*Console) BuildPrompt

func (c *Console) BuildPrompt() string

BuildPrompt returns the styled prompt string.

func (*Console) Exec

func (c *Console) Exec(line string) bool

Exec runs a console command line. Returns true if the console should exit.

func (*Console) Mod

func (c *Console) Mod() sdk.Exploit

Mod returns the currently selected module.

func (*Console) OptionNames

func (c *Console) OptionNames() []string

OptionNames returns option names for completion.

func (*Console) Options

func (c *Console) Options() []Option

Options returns the current module options.

func (*Console) Program

func (c *Console) Program() MsgSender

Program returns the message sender.

func (*Console) SendClear

func (c *Console) SendClear()

SendClear sends a clear message to the TUI.

func (*Console) SessionHandler

func (c *Console) SessionHandler() c2.SessionHandler

SessionHandler returns the C2 session handler, or nil.

func (*Console) SetMod

func (c *Console) SetMod(mod sdk.Exploit)

SetMod sets the current module and initializes options.

func (*Console) SetOpt

func (c *Console) SetOpt(name, value string) bool

SetOpt sets a module option value.

func (*Console) SetProgram

func (c *Console) SetProgram(p MsgSender)

SetProgram sets the message sender (TUI program) for async communication.

func (*Console) ShutdownBackend

func (c *Console) ShutdownBackend()

ShutdownBackend shuts down the C2 backend.

func (*Console) UseByName

func (c *Console) UseByName(name string)

UseByName selects a module by name or numeric index.

type FuzzyItem

type FuzzyItem = types.FuzzyItem

type FuzzySelectMsg

type FuzzySelectMsg = types.FuzzySelectMsg

type MsgSender

type MsgSender interface {
	Send(msg any)
}

MsgSender is an interface for sending messages to the TUI program. Avoids importing bubbletea in console package.

type Option

type Option = types.Option

Option is the shared option type.

type SessionInteractMsg

type SessionInteractMsg = types.SessionInteractMsg