Module: Msf::Payload::Single

Included in:
Windows::Exec, Windows::Exec_x64, Windows::LoadLibrary
Defined in:
lib/msf/core/payload/single.rb

Overview

Base mixin interface for use by single payloads. Single payloads are differentiated from stagers and stages by the fact that they run as part of the first stage and have no subsequent stages.

Instance Method Summary collapse

Instance Method Details

#generate(_opts = {}) ⇒ Object

Conditional generation depending on whether or not this single payload is used in conjunction with a stager. When a stager is used, generate will return the stager. When a stager is not used, generate will return the single payload



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/msf/core/payload/single.rb', line 26

def generate(_opts = {})
  # If we're staged, then we call the super to generate the STAGER
  if staged?
    super
  # Otherwise, we'll be generating the stage, let's do that now
  else
    # If they defined a custom method that will return the payload, then
    # call it
    if self.class.method_defined?(:generate_stage)
      # this can safely be ignored for adapters
      unless self.class.include?(Msf::Payload::Adapter)
        wlog("Single payload '#{self.fullname}' has #generate_stage defined when it should be using #generate")
      end
    end

    super
  end
end

#payload_type ⇒ Object

Sets the payload type to that of a single payload.



16
17
18
 
# File 'lib/msf/core/payload/single.rb', line 16

def payload_type
  return Msf::Payload::Type::Single
end