fortrace.utility.console_applications package

Subpackages

• fortrace.utility.console_applications.text_editor package
  • Submodules
  • fortrace.utility.console_applications.text_editor.nano module
    • Nano
      • Nano.close()
      • Nano.delete_current_line()
      • Nano.go_to_line()
      • Nano.replace()
      • Nano.save_file()
  • fortrace.utility.console_applications.text_editor.text_editor module
    • GenericConsoleTextEditor
      • GenericConsoleTextEditor.delete_current_line()
      • GenericConsoleTextEditor.get_editor_screen()
      • GenericConsoleTextEditor.go_to_line()
      • GenericConsoleTextEditor.replace()
      • GenericConsoleTextEditor.save_file()
      • GenericConsoleTextEditor.send_file()
  • fortrace.utility.console_applications.text_editor.text_editor_factory module
    • get_console_text_editor()
  • fortrace.utility.console_applications.text_editor.vim module
    • VIM
      • VIM.change_mode()
      • VIM.close()
      • VIM.delete_current_line()
      • VIM.go_to_line()
      • VIM.mode
      • VIM.replace()
      • VIM.save_file()
      • VIM.send_command()
      • VIM.send_file()
    • VIMMode
      • VIMMode.INSERT
      • VIMMode.NORMAL
      • VIMMode.VISUAL
      • VIMMode.VISUAL_BLOCK
      • VIMMode.VISUAL_LINE
  • Module contents

Submodules

fortrace.utility.console_applications.console_application module

class fortrace.utility.console_applications.console_application.GenericConsoleApplication(pty: REPLWrapper, name: str)

Bases: ABC

Class to interact with console applications opened through a VirshConsole.

Warning

It is NOT intended to be used in a GUI

abstractmethod close()

Close a console application.

Call this method to return to the command line. Sometimes it might be necessary to clean the buffer by calling self._pty.run_command(“clear”).

Notes

After a call to close refrain from using the object again

property name

send_key_combination(key_combination: KeyCodes | str)

Send a key combination to the console.

Multiple KeyCodes might be chained with ‘+’

Parameters:

key_combination – one or more KeyCodes to be sent

send_text(text: str, new_line: bool = False)

Send regular text to the console application, e.g. type a line in a text editor.

Parameters:

• text – text to be sent

• new_line – should a new line symbol be appended?

class fortrace.utility.console_applications.console_application.KeyCodes(*values)

Bases: StrEnum

KeyCodes determined with pexpect_getch.py script (see utils/scripts)

A = '97'

ALT = '27'

ARROW_DOWN = '27,91,66'

ARROW_LEFT = '27,91,68'

ARROW_RIGHT = '27,91,67'

ARROW_UP = '27,91,65'

CTRL_C = '3'

DEL = '27,91,51,126'

ESC = '27'

F1 = '27,79,80'

F2 = '27,79,81'

F3 = '27,79,82'

G = '103'

R = '114'

RET = '13'

TAB = '9'

class fortrace.utility.console_applications.console_application.Prompt(prompt: str, continuation_prompt: str | None)

Bases: object

Small wrapper for a prompt shell

continuation_prompt: str | None

prompt: str

fortrace.utility.console_applications.console_application_factory module

fortrace.utility.console_applications.console_application_factory.get_console_application(name: str, pty: REPLWrapper) → GenericConsoleApplication

Factory for construction of console applications.

Parameters:

• name – name of the application (must be matched in this function

• pty – handle to pty (used if there is a new prompt in the console application)

Returns:

opened console application

fortrace.utility.console_applications.metasploit_console module

class fortrace.utility.console_applications.metasploit_console.MetasploitConsole(pty: REPLWrapper)

Bases: GenericConsoleApplication

Class to handle a MetasploitConsole opened in a VirshConsole session.

close()

Close a console application.

Call this method to return to the command line. Sometimes it might be necessary to clean the buffer by calling self._pty.run_command(“clear”).

Notes

After a call to close refrain from using the object again

edit(file: PathLike) → GenericConsoleTextEditor

Open/Create a file with the VIM editor from within the Metasploit console

Parameters:

file – path to the file

Returns:

handle to console text editor

open_meterpreter_session(session_id: int) → MeterpreterSession

Start a Meterpreter session.

Parameters:

session_id – ID of already created Meterpreter session

Returns:

opened Meterpreter session

open_shell() → ShellSession

Open a shell in MetasploitConsole.

Use this method if the metasploit run command opens a shell without a prompt.

Returns:

ShellSession object

run_command(command: str, timeout: int | None = None) → str | list[str]

Run a command in the metasploit console.

Parameters:

• command – command to be run

• timeout – optional timeout (useful if command takes longer)

Returns:

If the output is a single line a string is returned, else a list of strings or an empty list

class fortrace.utility.console_applications.metasploit_console.MeterpreterSession(pty: REPLWrapper, session_id: id)

Bases: GenericConsoleApplication

Class to handle an opened Meterpreter session.

PROMPT = '\x1b[4mmeterpreter\x1b[0m > '

close()

Close the Meterpreter session.

edit(file: PathLike) → GenericConsoleTextEditor

Edit a file in the Meterpreter.

Parameters:

file – file to be edited

Returns:

handle to opened text editor

open_shell() → ShellSession

Open a Shell from within MeterpreterSession.

Returns:

handle to opened shell

run_command(command: str, timeout: int | None = None) → str | list[str]

Run a command inside the Meterpreter.

Parameters:

• command – command to be run

• timeout – maximum time to wait for output

Returns:

The output without the entered command.

suspend()

Suspend the Meterpreter session to the background.

Can be opened again later with the same ID.

class fortrace.utility.console_applications.metasploit_console.ShellSession(pty: REPLWrapper)

Bases: GenericConsoleApplication

Class to be used when dealing with an opened shell session without a prompt.

background()

Background the shell session, so it can be used again later.

close()

Close the Shell session

run_command(command: str, sleep: int | None = None, expect: str | None = None) → str | list[str]

Run a command in a shell opened from within a Meterpreter session.

There is no prompt, so we need to read everything or need to know what to expect.

Parameters:

• command – the command to run

• sleep – an estimate by the user how long the command will take. None, if the result is there immediately

• expect – Some string to expect, if the command has finished. None to read until timeout exception

Returns:

a list of strings for multiline outputs, a single string for single line output, an empty list for no output

Module contents