Modules¶
pwncat has two programmable building blocks: commands and modules. Modules are
specific to an open session. They are intended to retrieve some information or
make a modification to a specific target. By default, modules are loaded from
the pwncat/modules
directory, but more modules can be loaded from a custom
location via the load
command.
Module Contexts¶
You can enter a module “context” which means that any set
commands will
operate specifically on that modules arguments by default. This is useful
when a module takes a large number of arguments or complex arguments. In
this case, the local prompt prefix changes to ([module_name])
vice
the normal (local)
. The context is exited automatically after using the
run
command.
When in a module context, commands like info
and run
no longer
require the module name as a parameter. It is inferred by the current context.
Locating Modules¶
Modules are located using the search
command at the local prompt. You can
also locate modules using tab completion at the local prompt.
search enumerate.*
Viewing Documentation¶
Module documentation can be viewed with the info
command. When within
a module context, the module name is inferred from the current context
if not specified.
info escalate.auto
Running Modules¶
The run
command is used to execute a module. The module name is inferred
from the module context if not specified. Key-value parameters can be specified
in the run
command or with set
within a module context.
run escalate.auto user=root
use escalate.auto
set user root
run