Land #4918, Rework how payload prepends work

lib/msf/core/encoded_payload.rb

@@ -94,7 +94,7 @@ class EncodedPayload
   #
   # @return [String] The raw, unencoded payload.
   def generate_raw
-    self.raw = (reqs['Prepend'] || '') + pinst.generate + (reqs['Append'] || '')
+    self.raw = (reqs['Prepend'] || '') + pinst.generate_complete + (reqs['Append'] || '')
 
     # If an encapsulation routine was supplied, then we should call it so
     # that we can get the real raw payload.

lib/msf/core/payload.rb

@@ -311,6 +311,13 @@ class Payload < Msf::Module
     internal_generate
   end
 
+  #
+  # Generates the payload and returns the raw buffer to the caller,
+  # handling any post-processing tasks, such as prepended code stubs.
+  def generate_complete
+    apply_prepends(generate)
+  end
+
   #
   # Substitutes variables with values from the module's datastore in the
   # supplied raw buffer for a given set of named offsets.  For instance,
@@ -465,6 +472,13 @@ class Payload < Msf::Module
     return nops
   end
 
+  #
+  # A placeholder stub, to be overriden by mixins
+  #
+  def apply_prepends(raw)
+    raw
+  end
+
   ##
   #
   # Event notifications.

lib/msf/core/payload/linux.rb

@@ -91,9 +91,7 @@ module Msf::Payload::Linux
   #
   # Overload the generate() call to prefix our stubs
   #
-  def generate(*args)
-    # Call the real generator to get the payload
-    buf = super(*args)
+  def apply_prepends(buf)
     pre = ''
     app = ''
 

lib/msf/core/payload/windows.rb

@@ -38,9 +38,11 @@ module Msf::Payload::Windows
       'none'    => 0x5DE2C5AA, # GetLastError
     }
 
-
-  def generate
-    return prepends(super)
+  #
+  # Implement payload prepends for Windows payloads
+  #
+  def apply_prepends(raw)
+    apply_prepend_migrate(raw)
   end
 
   #

lib/msf/core/payload/windows/prepend_migrate.rb

@@ -34,7 +34,7 @@ module Msf::Payload::Windows::PrependMigrate
   #
   # Overload the generate() call to prefix our stubs
   #
-  def prepends(buf)
+  def apply_prepend_migrate(buf)
     pre = ''
 
     test_arch = [ *(self.arch) ]

lib/msf/core/payload/windows/reverse_http.rb

@@ -16,6 +16,7 @@ module Msf
 
 module Payload::Windows::ReverseHttp
 
+  include Msf::Payload::Windows
   include Msf::Payload::Windows::BlockApi
   include Msf::Payload::Windows::Exitfunk
 

modules/payloads/singles/linux/x64/exec.rb

@@ -8,7 +8,7 @@ require 'msf/core'
 
 module Metasploit3
 
-  CachedSize = 209
+  CachedSize = 40
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x64/shell_bind_tcp.rb

@@ -11,7 +11,7 @@ require 'msf/base/sessions/command_shell_options'
 
 module Metasploit3
 
-  CachedSize = 255
+  CachedSize = 86
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x64/shell_bind_tcp_random_port.rb

@@ -7,7 +7,7 @@ require 'msf/core'
 
 module Metasploit3
 
-  CachedSize = 226
+  CachedSize = 57
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x64/shell_reverse_tcp.rb

@@ -11,7 +11,7 @@ require 'msf/base/sessions/command_shell_options'
 
 module Metasploit3
 
-  CachedSize = 243
+  CachedSize = 74
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/adduser.rb

@@ -17,7 +17,7 @@ require 'msf/core'
 ###
 module Metasploit3
 
-  CachedSize = 219
+  CachedSize = 97
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/chmod.rb

@@ -12,7 +12,7 @@ require 'msf/core'
 ###
 module Metasploit3
 
-  CachedSize = 158
+  CachedSize = 36
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/exec.rb

@@ -15,7 +15,7 @@ require 'msf/core'
 ###
 module Metasploit3
 
-  CachedSize = 158
+  CachedSize = 36
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/metsvc_bind_tcp.rb

@@ -11,7 +11,7 @@ require 'msf/base/sessions/meterpreter_options'
 
 module Metasploit3
 
-  CachedSize = 122
+  CachedSize = 0
 
   include Msf::Payload::Linux
   include Msf::Payload::Single

modules/payloads/singles/linux/x86/metsvc_reverse_tcp.rb

@@ -11,7 +11,7 @@ require 'msf/base/sessions/meterpreter_options'
 
 module Metasploit3
 
-  CachedSize = 122
+  CachedSize = 0
 
   include Msf::Payload::Linux
   include Msf::Payload::Single

modules/payloads/singles/linux/x86/read_file.rb

@@ -7,7 +7,7 @@ require 'msf/core'
 
 module Metasploit3
 
-  CachedSize = 184
+  CachedSize = 62
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/shell_bind_ipv6_tcp.rb

@@ -10,7 +10,7 @@ require 'msf/base/sessions/command_shell_options'
 
 module Metasploit3
 
-  CachedSize = 212
+  CachedSize = 90
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/shell_bind_tcp.rb

@@ -10,7 +10,7 @@ require 'msf/base/sessions/command_shell_options'
 
 module Metasploit3
 
-  CachedSize = 200
+  CachedSize = 78
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/shell_bind_tcp_random_port.rb

@@ -7,7 +7,7 @@ require 'msf/core'
 
 module Metasploit3
 
-  CachedSize = 179
+  CachedSize = 57
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/shell_find_port.rb

@@ -10,7 +10,7 @@ require 'msf/base/sessions/command_shell_options'
 
 module Metasploit3
 
-  CachedSize = 184
+  CachedSize = 62
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/shell_find_tag.rb

@@ -10,7 +10,7 @@ require 'msf/base/sessions/command_shell_options'
 
 module Metasploit3
 
-  CachedSize = 191
+  CachedSize = 69
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/singles/linux/x86/shell_reverse_tcp.rb

@@ -10,7 +10,7 @@ require 'msf/base/sessions/command_shell_options'
 
 module Metasploit3
 
-  CachedSize = 190
+  CachedSize = 68
 
   include Msf::Payload::Single
   include Msf::Payload::Linux

modules/payloads/stagers/linux/x64/bind_tcp.rb

@@ -9,7 +9,7 @@ require 'msf/core/handler/bind_tcp'
 
 module Metasploit3
 
-  CachedSize = 247
+  CachedSize = 78
 
   include Msf::Payload::Stager
   include Msf::Payload::Linux

modules/payloads/stagers/linux/x64/reverse_tcp.rb

@@ -9,7 +9,7 @@ require 'msf/core/handler/reverse_tcp'
 
 module Metasploit3
 
-  CachedSize = 237
+  CachedSize = 68
 
   include Msf::Payload::Stager
   include Msf::Payload::Linux

modules/payloads/stagers/linux/x86/bind_ipv6_tcp.rb

@@ -9,7 +9,7 @@ require 'msf/core/handler/bind_tcp'
 # Linux Bind TCP/IPv6 Stager
 module Metasploit3
 
-  CachedSize = 207
+  CachedSize = 85
 
   include Msf::Payload::Stager
   include Msf::Payload::Linux

modules/payloads/stagers/linux/x86/bind_nonx_tcp.rb

@@ -18,7 +18,7 @@ require 'msf/core/handler/bind_tcp'
 ###
 module Metasploit3
 
-  CachedSize = 185
+  CachedSize = 63
 
   include Msf::Payload::Stager
   include Msf::Payload::Linux

modules/payloads/stagers/linux/x86/bind_tcp.rb

@@ -18,7 +18,7 @@ require 'msf/core/handler/bind_tcp'
 ###
 module Metasploit3
 
-  CachedSize = 201
+  CachedSize = 79
 
   include Msf::Payload::Stager
   include Msf::Payload::Linux

modules/payloads/stagers/linux/x86/find_tag.rb

@@ -18,7 +18,7 @@ require 'msf/core/handler/find_tag'
 ###
 module Metasploit3
 
-  CachedSize = 159
+  CachedSize = 37
 
   include Msf::Payload::Stager
   include Msf::Payload::Linux

modules/payloads/stagers/linux/x86/reverse_ipv6_tcp.rb

@@ -9,7 +9,7 @@ require 'msf/core/handler/reverse_tcp'
 # Linux Reverse TCP/IPv6 Stager
 module Metasploit3
 
-  CachedSize = 199
+  CachedSize = 77
 
   include Msf::Payload::Stager
   include Msf::Payload::Linux

modules/payloads/stagers/linux/x86/reverse_nonx_tcp.rb

@@ -18,7 +18,7 @@ require 'msf/core/handler/reverse_tcp'
 ###
 module Metasploit3
 
-  CachedSize = 172
+  CachedSize = 50
 
   include Msf::Payload::Stager
   include Msf::Payload::Linux

modules/payloads/stagers/linux/x86/reverse_tcp.rb

@@ -18,7 +18,7 @@ require 'msf/core/handler/reverse_tcp'
 ###
 module Metasploit3
 
-  CachedSize = 193
+  CachedSize = 71
 
   include Msf::Payload::Stager
   include Msf::Payload::Linux