Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to reload all libs when calling run or check on a module #18381

Merged
merged 1 commit into from
Oct 13, 2023
Merged

Add option to reload all libs when calling run or check on a module #18381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions lib/msf/ui/console/command_dispatcher/auxiliary.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,11 @@ def name
#
# Executes an auxiliary module
#
def cmd_run(*args, action: nil)
def cmd_run(*args, action: nil, opts: {})
if (args.include?('-r') || args.include?('--reload-libs')) && !opts[:previously_reloaded]
driver.run_single('reload_lib -a')
end

return false unless (args = parse_run_opts(args, action: action))
jobify = args[:jobify]

Expand Down Expand Up @@ -132,8 +136,14 @@ def cmd_run_help
# Reloads an auxiliary module and executes it
#
def cmd_rerun(*args)
opts = {}
if args.include?('-r') || args.include?('--reload-libs')
driver.run_single('reload_lib -a')
opts[:previously_reloaded] = true
end

if reload(true)
cmd_run(*args)
cmd_run(*args, opts: opts)
end
end

Expand All @@ -146,9 +156,15 @@ def cmd_rerun(*args)
# vulnerable.
#
def cmd_rcheck(*args)
opts = {}
if args.include?('-r') || args.include?('--reload-libs')
driver.run_single('reload_lib -a')
opts[:previously_reloaded] = true
end

reload()

cmd_check(*args)
cmd_check(*args, opts: opts)
end

alias cmd_recheck cmd_rcheck
Expand Down
25 changes: 20 additions & 5 deletions lib/msf/ui/console/command_dispatcher/evasion.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,12 @@ def name
'Evasion'
end

def cmd_run(*args)
opts = {
def cmd_run(*args, opts: {})
if (args.include?('-r') || args.include?('--reload-libs')) && !opts[:previously_reloaded]
driver.run_single('reload_lib -a')
end

module_opts = {
'Encoder' => mod.datastore['ENCODER'],
'Payload' => mod.datastore['PAYLOAD'],
'Nop' => mod.datastore['NOP'],
Expand All @@ -32,7 +36,7 @@ def cmd_run(*args)
}

begin
mod.run_simple(opts)
mod.run_simple(module_opts)
rescue ::Interrupt
print_error('Evasion interrupted by the console user')
rescue ::Exception => e
Expand All @@ -44,8 +48,14 @@ def cmd_run(*args)
alias cmd_exploit cmd_run

def cmd_rerun(*args)
opts = {}
if args.include?('-r') || args.include?('--reload-libs')
driver.run_single('reload_lib -a')
opts[:previously_reloaded] = true
end

if reload(true)
cmd_run(*args)
cmd_run(*args, opts: opts)
end
end

Expand All @@ -64,6 +74,7 @@ def cmd_run_tabs(str, words)
'-n' => [ framework.nops.map { |refname, mod| refname } ],
'-o' => [ true ],
'-p' => [ framework.payloads.map { |refname, mod| refname } ],
'-r' => [ nil ],
'-t' => [ true ],
'-z' => [ nil ]
}
Expand All @@ -77,7 +88,11 @@ def cmd_run_tabs(str, words)
#
alias cmd_exploit_tabs cmd_run_tabs

def cmd_to_handler(*_args)
def cmd_to_handler(*args)
if args.include?('-r') || args.include?('--reload-libs')
driver.run_single('reload_lib -a')
end

handler = framework.modules.create('exploit/multi/handler')

handler_opts = {
Expand Down
26 changes: 22 additions & 4 deletions lib/msf/ui/console/command_dispatcher/exploit.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ def cmd_run_tabs(str, words)
'-n' => [ framework.nops.map { |refname, mod| refname } ],
'-o' => [ true ],
'-p' => [ framework.payloads.map { |refname, mod| refname } ],
'-r' => [ nil ],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not action this just yet, but maybe we could bikeshed on whether reload -a makes sense or not versus reload -r - aligning with the existing convention f reload_lib -a in terms of muscle memory

But I guess it's not got the issue with reload -a potentially indicating to the user that it will reload all modules (which we already have reload_all for) 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @smcintyre-r7 Any preferences here? 👀

'-t' => [ true ],
'-z' => [ nil ]
}
Expand All @@ -90,7 +91,11 @@ def cmd_run_tabs(str, words)
#
# Launches exploitation attempts.
#
def cmd_exploit(*args)
def cmd_exploit(*args, opts: {})
if (args.include?('-r') || args.include?('--reload-libs')) && !opts[:previously_reloaded]
driver.run_single('reload_lib -a')
end

return false unless (args = parse_exploit_opts(args))

any_session = false
Expand Down Expand Up @@ -138,6 +143,7 @@ def cmd_exploit(*args)
return false
end

driver.run_single('reload_lib -a') if args[:reload_libs]
sjanusz-r7 marked this conversation as resolved.
Show resolved Hide resolved

if rhosts && has_rhosts_option
rhosts_walker = Msf::RhostsWalker.new(rhosts, mod_with_opts.datastore)
Expand Down Expand Up @@ -234,9 +240,15 @@ def cmd_exploit_help
# vulnerable.
#
def cmd_rcheck(*args)
opts = {}
if args.include?('-r') || args.include?('--reload-libs')
driver.run_single('reload_lib -a')
opts[:previously_reloaded] = true
end

reload()

cmd_check(*args)
cmd_check(*args, opts: opts)
end

alias cmd_recheck cmd_rcheck
Expand All @@ -245,12 +257,18 @@ def cmd_rcheck(*args)
# Reloads an exploit module and launches an exploit.
#
def cmd_rexploit(*args)
return cmd_rexploit_help if args.include? "-h"
opts = {}
if args.include?('-r') || args.include?('--reload-libs')
driver.run_single('reload_lib -a')
opts[:previously_reloaded] = true
end

return cmd_rexploit_help if args.include?('-h') || args.include?('--help')

# Stop existing job and reload the module
if reload(true)
# Delegate to the exploit command unless the reload failed
cmd_exploit(*args)
cmd_exploit(*args, opts: opts)
end
end

Expand Down
6 changes: 5 additions & 1 deletion lib/msf/ui/console/command_dispatcher/payload.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ def commands
)
end

def cmd_to_handler(*_args)
def cmd_to_handler(*args)
if args.include?('-r') || args.include?('--reload-libs')
driver.run_single('reload_lib -a')
end

handler = framework.modules.create('exploit/multi/handler')

handler_opts = {
Expand Down
14 changes: 12 additions & 2 deletions lib/msf/ui/console/command_dispatcher/post.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,15 @@ def cmd_rexploit(*args)
# Reloads a post module and executes it
#
def cmd_rerun(*args)
opts = {}
if args.include?('-r') || args.include?('--reload-libs')
driver.run_single('reload_lib -a')
opts[:previously_reloaded] = true
end

# Stop existing job and reload the module
if reload(true)
cmd_run(*args)
cmd_run(*args, opts: opts)
end
end

Expand All @@ -65,7 +71,11 @@ def cmd_run_help
#
# Executes a post module
#
def cmd_run(*args, action: nil)
def cmd_run(*args, action: nil, opts: {})
if (args.include?('-r') || args.include?('--reload-libs')) && !opts[:previously_reloaded]
driver.run_single('reload_lib -a')
end

return false unless (args = parse_run_opts(args, action: action))
jobify = args[:jobify]

Expand Down
15 changes: 9 additions & 6 deletions lib/msf/ui/console/module_argument_parsing.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@ module ModuleArgumentParsing

# Options which are standard and predictable across all modules
@@module_opts = Rex::Parser::Arguments.new(
['-h', '--help'] => [ false, 'Help banner.' ],
['-j', '--job'] => [ false, 'Run in the context of a job.' ],
['-J', '--foreground'] => [ false, 'Force running in the foreground, even if passive.' ],
['-o', '--options'] => [ true, 'A comma separated list of options in VAR=VAL format.', '<options>' ],
['-q', '--quiet'] => [ false, 'Run the module in quiet mode with no output' ]
['-h', '--help'] => [ false, 'Help banner.' ],
['-j', '--job'] => [ false, 'Run in the context of a job.' ],
['-J', '--foreground'] => [ false, 'Force running in the foreground, even if passive.' ],
['-o', '--options'] => [ true, 'A comma separated list of options in VAR=VAL format.', '<options>' ],
['-q', '--quiet'] => [ false, 'Run the module in quiet mode with no output' ],
['-r', '--reload-libs'] => [ false, 'Reload all libraries before running.' ]
)

@@module_opts_with_action_support = @@module_opts.merge(
Expand All @@ -41,7 +42,7 @@ def parse_check_opts(args)
help_cmd = proc do |_result|
cmd_check_help
end
parse_opts(@@module_opts_with_action_support, args, help_cmd: help_cmd)&.slice(:datastore_options)
parse_opts(@@module_opts_with_action_support, args, help_cmd: help_cmd)&.slice(:datastore_options, :reload_libs)
end

def parse_run_opts(args, action: nil)
Expand Down Expand Up @@ -127,6 +128,8 @@ def parse_opts(opts, args, help_cmd:, action: nil)
end
when '-p'
result[:payload] = val
when '-r'
result[:reload_libs] = true
when '-t'
result[:target] = val.to_i
when '-z'
Expand Down
12 changes: 11 additions & 1 deletion lib/msf/ui/console/module_command_dispatcher.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,11 @@ def check_multiple(mod)
#
# Checks to see if a target is vulnerable.
#
def cmd_check(*args)
def cmd_check(*args, opts: {})
if (args.include?('-r') || args.include?('--reload-libs')) && !opts[:previously_reloaded]
driver.run_single('reload_lib -a')
end

return false unless (args = parse_check_opts(args))

mod_with_opts = mod.replicant
Expand Down Expand Up @@ -243,6 +247,12 @@ def check_simple(instance=nil)
# Reloads the active module
#
def cmd_reload(*args)
if args.include?('-r') || args.include?('--reload-libs')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update the help menu

msf6 auxiliary(scanner/postgres/postgres_login) > reload -h
Usage: reload [-k]

Reloads the current module.

OPTIONS:

    -h  Help banner.
    -k  Stop the current job before reloading.

driver.run_single('reload_lib -a')
end

return cmd_reload_help if args.include?('-h') || args.include?('--help')

begin
reload
rescue
Expand Down