Add YARD docu for execute_cmdstager

bug/bundler_fix
jvazquez-r7 2014-02-08 17:49:13 -06:00 committed by Spencer McIntyre
parent e8f9dde50f
commit 35d035fa4e
1 changed files with 15 additions and 7 deletions

View File

@ -38,9 +38,11 @@ module Exploit::CmdStager
attr_accessor :decoder_stub
attr_accessor :exe
# Creates an instance of an exploit that uses an CMD Stager and register the
# datastore options provided by the mixin.
#
# Creates an instance of an exploit that uses an CmdStager overwrite.
#
# @param info [Hash] Hash containing information to initialize the exploit.
# @return [Msf::Module::Exploit] the exploit module.
def initialize(info = {})
super
@ -52,11 +54,18 @@ module Exploit::CmdStager
end
# Executes the command stager while showing the progress
#
# Execute the command stager while showing the progress
#
# @param opts [Hash] Hash containing configuration options. Also allow to
# send opts to the Rex::Exploitation::CmdStagerBase constructor.
# @option opts :flavor [Symbol] The CMD Stager to use.
# @option opts :decoder [Symbol] The decoder stub to use.
# @option opts :delay [Float] Delay between command executions.
# @option opts :code [String] Payload to embed into the resultant executable.
# @return [void]
# @raise [ArgumentError] raised if a valid CMD Stager can not be found or
# it isn't compatible with the target.
def execute_cmdstager(opts = {})
# Select the correct flavor
select_flavor(opts)
raise ArgumentError, "Unable to select CMD Stager" if flavor.nil?
@ -101,9 +110,8 @@ module Exploit::CmdStager
end
#
# Generates a cmd stub based on the current target's architecture
# and operating system.
# and platform.
#
def generate_cmdstager(opts = {}, pl = nil)