Class: Rex::Post::Meterpreter::Client

Inherits:
Object
  • Object
show all
Includes:
ChannelContainer, PacketDispatcher, PivotContainer
Defined in:
lib/rex/post/meterpreter/client.rb

Overview

This class represents a logical meterpreter client class. This class provides an interface that is compatible with the Rex post-exploitation interface in terms of the feature set that it attempts to expose. This class is meant to drive a single meterpreter client session.

Direct Known Subclasses

Msf::Sessions::Meterpreter

Constant Summary collapse

@@ext_hash =

Extension name to class hash.

{}
@@ssl_cached_cert =

Cached auto-generated SSL certificate

nil
@@ssl_mutex =

Mutex to synchronize class-wide operations

::Mutex.new

Constants included from PacketDispatcher

PacketDispatcher::PACKET_TIMEOUT, PacketDispatcher::PING_TIME

Instance Attribute Summary collapse

Attributes included from PivotContainer

#pivot_listeners, #pivot_sessions

Attributes included from ChannelContainer

#channels

Attributes included from PacketDispatcher

#comm_mutex, #dispatcher_thread, #passive_service, #receiver_thread, #recv_queue, #send_queue, #session_guid, #tlv_enc_key, #waiters

Class Method Summary collapse

Instance Method Summary collapse

Methods included from PivotContainer

#add_pivot_listener, #add_pivot_session, #find_pivot_listener, #find_pivot_session, #initialize_pivots, #remove_pivot_listener, #remove_pivot_session

Methods included from ChannelContainer

#add_channel, #find_channel, #initialize_channels, #remove_channel

Methods included from PacketDispatcher

#add_response_waiter, #decrypt_inbound_packet, #deregister_inbound_handler, #dispatch_inbound_packet, #initialize_inbound_handlers, #initialize_passive_dispatcher, #keepalive, #monitor_socket, #monitor_stop, #notify_response_waiter, #on_passive_request, #pivot_keepalive_start, #receive_packet, #register_inbound_handler, #remove_response_waiter, #send_packet, #send_packet_wait_response, #send_request, #shutdown_passive_dispatcher

Constructor Details

#initialize(sock, opts = {}) ⇒ Client

Initializes the client context with the supplied socket through which communication with the server will be performed.


84
85
86
# File 'lib/rex/post/meterpreter/client.rb', line 84

def initialize(sock, opts={})
  init_meterpreter(sock, opts)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(symbol, *args) ⇒ Object

Translates unhandled methods into registered extension aliases if a matching extension alias exists for the supplied symbol.


304
305
306
307
# File 'lib/rex/post/meterpreter/client.rb', line 304

def method_missing(symbol, *args)
  #$stdout.puts("method_missing: #{symbol}")
  self.ext_aliases.aliases[symbol.to_s]
end

Instance Attribute Details

#aliveObject

Whether this session is alive. If the socket is disconnected or broken, this will be false


438
439
440
# File 'lib/rex/post/meterpreter/client.rb', line 438

def alive
  @alive
end

#capabilitiesObject

The libraries available to this meterpreter server


446
447
448
# File 'lib/rex/post/meterpreter/client.rb', line 446

def capabilities
  @capabilities
end

#comm_timeoutObject

The Communication Timeout


470
471
472
# File 'lib/rex/post/meterpreter/client.rb', line 470

def comm_timeout
  @comm_timeout
end

#commandsObject

A list of the commands


494
495
496
# File 'lib/rex/post/meterpreter/client.rb', line 494

def commands
  @commands
end

#conn_idObject

The Connection ID


450
451
452
# File 'lib/rex/post/meterpreter/client.rb', line 450

def conn_id
  @conn_id
end

#encode_unicodeObject

Flag indicating whether to hex-encode UTF-8 file names and other strings


490
491
492
# File 'lib/rex/post/meterpreter/client.rb', line 490

def encode_unicode
  @encode_unicode
end

#expirationObject

The Session Expiration Timeout


466
467
468
# File 'lib/rex/post/meterpreter/client.rb', line 466

def expiration
  @expiration
end

#extObject

The extension alias under which all extensions can be accessed by name. For example:

client.ext.stdapi

421
422
423
# File 'lib/rex/post/meterpreter/client.rb', line 421

def ext
  @ext
end

#ext_aliasesObject (protected)

:nodoc:


501
502
503
# File 'lib/rex/post/meterpreter/client.rb', line 501

def ext_aliases
  @ext_aliases
end

#last_checkinObject

The timestamp of the last received response


498
499
500
# File 'lib/rex/post/meterpreter/client.rb', line 498

def last_checkin
  @last_checkin
end

#parserObject (protected)

:nodoc:


501
502
503
# File 'lib/rex/post/meterpreter/client.rb', line 501

def parser
  @parser
end

#passive_dispatcherObject

The Passive Dispatcher


482
483
484
# File 'lib/rex/post/meterpreter/client.rb', line 482

def passive_dispatcher
  @passive_dispatcher
end

#pivot_sessionObject

Reference to a session to pivot through


486
487
488
# File 'lib/rex/post/meterpreter/client.rb', line 486

def pivot_session
  @pivot_session
end

#response_timeoutObject

The timeout value to use when waiting for responses.


429
430
431
# File 'lib/rex/post/meterpreter/client.rb', line 429

def response_timeout
  @response_timeout
end

#retry_totalObject

The total time for retrying connections


474
475
476
# File 'lib/rex/post/meterpreter/client.rb', line 474

def retry_total
  @retry_total
end

#retry_waitObject

The time to wait between retry attempts


478
479
480
# File 'lib/rex/post/meterpreter/client.rb', line 478

def retry_wait
  @retry_wait
end

#send_keepalivesObject

Whether to send pings every so often to determine liveness.


433
434
435
# File 'lib/rex/post/meterpreter/client.rb', line 433

def send_keepalives
  @send_keepalives
end

#sockObject

The socket the client is communicating over.


425
426
427
# File 'lib/rex/post/meterpreter/client.rb', line 425

def sock
  @sock
end

#sslObject

Use SSL (HTTPS)


458
459
460
# File 'lib/rex/post/meterpreter/client.rb', line 458

def ssl
  @ssl
end

#ssl_certObject

Use this SSL Certificate (unified PEM)


462
463
464
# File 'lib/rex/post/meterpreter/client.rb', line 462

def ssl_cert
  @ssl_cert
end

#target_idObject

The unique target identifier for this payload


442
443
444
# File 'lib/rex/post/meterpreter/client.rb', line 442

def target_id
  @target_id
end

#urlObject

The Connect URL


454
455
456
# File 'lib/rex/post/meterpreter/client.rb', line 454

def url
  @url
end

Class Method Details

.check_ext_hash(name) ⇒ Object

Checks the extension hash to see if a class has already been associated with the supplied extension name.


69
70
71
# File 'lib/rex/post/meterpreter/client.rb', line 69

def self.check_ext_hash(name)
  @@ext_hash[name]
end

.default_timeoutObject

Returns the default timeout that request packets will use when waiting for a response.


290
291
292
# File 'lib/rex/post/meterpreter/client.rb', line 290

def Client.default_timeout
  return 300
end

.lookup_error(code) ⇒ Object

Lookup the error that occurred


61
62
63
# File 'lib/rex/post/meterpreter/client.rb', line 61

def self.lookup_error(code)
  code
end

.set_ext_hash(name, klass) ⇒ Object

Stores the name to class association for the supplied extension name.


76
77
78
# File 'lib/rex/post/meterpreter/client.rb', line 76

def self.set_ext_hash(name, klass)
  @@ext_hash[name] = klass
end

Instance Method Details

#add_extension(name, commands = []) ⇒ Object

Loads the client half of the supplied extension and initializes it as a registered extension that can be reached through client.ext..


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/rex/post/meterpreter/client.rb', line 319

def add_extension(name, commands=[])
  self.commands |= []
  self.commands.concat(commands)

  # Check to see if this extension has already been loaded.
  if ((klass = self.class.check_ext_hash(name.downcase)) == nil)
    klass = Rex::Post::Meterpreter::ExtensionMapper.get_extension_klass(name)
    # Save the module name to class association now that the code is
    # loaded.
    self.class.set_ext_hash(name.downcase, klass)
  end

  # Create a new instance of the extension
  inst = klass.new(self)

  self.ext.aliases[inst.name] = inst

  return true
end

#cleanup_meterpreterObject

Cleans up the meterpreter instance, terminating the dispatcher thread.


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/rex/post/meterpreter/client.rb', line 91

def cleanup_meterpreter
  if self.pivot_session
    self.pivot_session.remove_pivot_session(self.session_guid)
  end

  self.pivot_sessions.keys.each do |k|
    pivot = self.pivot_sessions[k]
    pivot.pivoted_session.kill('Pivot closed')
    pivot.pivoted_session.shutdown_passive_dispatcher
  end

  unless self.skip_cleanup
    ext.aliases.each_value do | extension |
      extension.cleanup if extension.respond_to?( 'cleanup' )
    end
  end

  dispatcher_thread.kill if dispatcher_thread

  unless self.skip_cleanup
    core.shutdown rescue nil
  end

  shutdown_passive_dispatcher
end

#deregister_extension(name) ⇒ Object

Deregisters an extension alias of the supplied name.


342
343
344
# File 'lib/rex/post/meterpreter/client.rb', line 342

def deregister_extension(name)
  self.ext.aliases.delete(name)
end

#deregister_extension_alias(name) ⇒ Object

Deregisters a previously registered extension alias.


385
386
387
# File 'lib/rex/post/meterpreter/client.rb', line 385

def deregister_extension_alias(name)
  self.ext_aliases.aliases.delete(name)
end

#dump_extension_treeObject

Dumps the extension tree.


392
393
394
395
396
397
398
# File 'lib/rex/post/meterpreter/client.rb', line 392

def dump_extension_tree()
  items = []
  items.concat(self.ext.dump_alias_tree('client.ext'))
  items.concat(self.ext_aliases.dump_alias_tree('client'))

  return items.sort
end

#each_extension(&block) ⇒ Object

Enumerates all of the loaded extensions.


349
350
351
# File 'lib/rex/post/meterpreter/client.rb', line 349

def each_extension(&block)
  self.ext.aliases.each(block)
end

#generate_ssl_contextObject


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/rex/post/meterpreter/client.rb', line 240

def generate_ssl_context

  ctx = nil
  ssl_cert_info = nil

  loop do

    # Load a custom SSL certificate if one has been specified
    if self.ssl_cert
      wlog("Loading custom SSL certificate for Meterpreter session")
      ssl_cert_info = Rex::Socket::SslTcpServer.ssl_parse_pem(self.ssl_cert)
      wlog("Loaded custom SSL certificate for Meterpreter session")
      break
    end

    # Generate a certificate if necessary and cache it
    if ! @@ssl_cached_cert
      @@ssl_mutex.synchronize do
        wlog("Generating SSL certificate for Meterpreter sessions")
        @@ssl_cached_cert = Rex::Socket::SslTcpServer.ssl_generate_certificate
        wlog("Generated SSL certificate for Meterpreter sessions")
      end
    end

    # Use the cached certificate
    ssl_cert_info = @@ssl_cached_cert
    break
  end

  # Create a new context for each session
  ctx = OpenSSL::SSL::SSLContext.new()
  ctx.key = ssl_cert_info[0]
  ctx.cert = ssl_cert_info[1]
  ctx.extra_chain_cert = ssl_cert_info[2]
  ctx.options = 0
  ctx.session_id_context = Rex::Text.rand_text(16)

  ctx
end

#init_meterpreter(sock, opts = {}) ⇒ Object

Initializes the meterpreter client instance


120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/rex/post/meterpreter/client.rb', line 120

def init_meterpreter(sock,opts={})
  self.sock         = sock
  self.parser       = PacketParser.new
  self.ext          = ObjectAliases.new
  self.ext_aliases  = ObjectAliases.new
  self.alive        = true
  self.target_id    = opts[:target_id]
  self.capabilities = opts[:capabilities] || {}
  self.commands     = []
  self.last_checkin = Time.now

  self.conn_id      = opts[:conn_id]
  self.url          = opts[:url]
  self.ssl          = opts[:ssl]

  self.pivot_session = opts[:pivot_session]
  if self.pivot_session
    self.expiration   = self.pivot_session.expiration
    self.comm_timeout = self.pivot_session.comm_timeout
    self.retry_total  = self.pivot_session.retry_total
    self.retry_wait   = self.pivot_session.retry_wait
  else
    self.expiration   = opts[:expiration]
    self.comm_timeout = opts[:comm_timeout]
    self.retry_total  = opts[:retry_total]
    self.retry_wait   = opts[:retry_wait]
    self.passive_dispatcher = opts[:passive_dispatcher]
  end

  self.response_timeout = opts[:timeout] || self.class.default_timeout
  self.send_keepalives  = true

  # TODO: Clarify why we don't allow unicode to be set in initial options
  # self.encode_unicode   = opts.has_key?(:encode_unicode) ? opts[:encode_unicode] : true
  self.encode_unicode = false

  self.aes_key      = nil
  self.session_guid = opts[:session_guid] || "\x00" * 16

  # The SSL certificate is being passed down as a file path
  if opts[:ssl_cert]
    if ! ::File.exist? opts[:ssl_cert]
      elog("SSL certificate at #{opts[:ssl_cert]} does not exist and will be ignored")
    else
      # Load the certificate the same way that SslTcpServer does it
      self.ssl_cert = ::File.read(opts[:ssl_cert])
    end
  end

  # Protocol specific dispatch mixins go here, this may be neader with explicit Client classes
  opts[:dispatch_ext].each {|dx| self.extend(dx)} if opts[:dispatch_ext]
  initialize_passive_dispatcher if opts[:passive_dispatcher]

  register_extension_alias('core', ClientCore.new(self))

  initialize_inbound_handlers
  initialize_channels
  initialize_pivots

  # Register the channel and pivot inbound packet handlers
  register_inbound_handler(Rex::Post::Meterpreter::Channel)
  register_inbound_handler(Rex::Post::Meterpreter::Pivot)

  monitor_socket
end

#register_extension_alias(name, ext) ⇒ Object

Registers an aliased extension that can be referenced through client.name.


357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
# File 'lib/rex/post/meterpreter/client.rb', line 357

def register_extension_alias(name, ext)
  self.ext_aliases.aliases[name] = ext
  # Whee!  Syntactic sugar, where art thou?
  #
  # Create an instance method on this object called +name+ that returns
  # +ext+.  We have to do it this way instead of simply
  # self.class.class_eval so that other meterpreter sessions don't get
  # extension methods when this one does
  (class << self; self; end).class_eval do
    define_method(name.to_sym) do
      ext
    end
  end
  ext
end

#register_extension_aliases(aliases) ⇒ Object

Registers zero or more aliases that are provided in an array.


376
377
378
379
380
# File 'lib/rex/post/meterpreter/client.rb', line 376

def register_extension_aliases(aliases)
  aliases.each { |a|
    register_extension_alias(a['name'], a['ext'])
  }
end

#swap_sock_plain_to_sslObject


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/rex/post/meterpreter/client.rb', line 186

def swap_sock_plain_to_ssl
  # Create a new SSL session on the existing socket
  ctx = generate_ssl_context()
  ssl = OpenSSL::SSL::SSLSocket.new(sock, ctx)

  # Use non-blocking OpenSSL operations on Windows
  if !( ssl.respond_to?(:accept_nonblock) and Rex::Compat.is_windows )
    ssl.accept
  else
    begin
      ssl.accept_nonblock

    # Ruby 1.8.7 and 1.9.0/1.9.1 uses a standard Errno
    rescue ::Errno::EAGAIN, ::Errno::EWOULDBLOCK
        IO::select(nil, nil, nil, 0.10)
        retry

    # Ruby 1.9.2+ uses IO::WaitReadable/IO::WaitWritable
    rescue ::Exception => e
      if ::IO.const_defined?('WaitReadable') and e.kind_of?(::IO::WaitReadable)
        IO::select( [ ssl ], nil, nil, 0.10 )
        retry
      end

      if ::IO.const_defined?('WaitWritable') and e.kind_of?(::IO::WaitWritable)
        IO::select( nil, [ ssl ], nil, 0.10 )
        retry
      end

      raise e
    end
  end

  self.sock.extend(Rex::Socket::SslTcp)
  self.sock.sslsock = ssl
  self.sock.sslctx  = ctx
  self.sock.sslhash = Rex::Text.sha1_raw(ctx.cert.to_der)

  tag = self.sock.get_once(-1, 30)
  if(not tag or tag !~ /^GET \//)
    raise RuntimeError, "Could not read the HTTP hello token"
  end
end

#swap_sock_ssl_to_plainObject


230
231
232
233
234
235
236
237
238
# File 'lib/rex/post/meterpreter/client.rb', line 230

def swap_sock_ssl_to_plain
  # Remove references to the SSLSocket and Context
  self.sock.sslsock.close
  self.sock.sslsock = nil
  self.sock.sslctx  = nil
  self.sock.sslhash = nil
  self.sock = self.sock.fd
  self.sock.extend(::Rex::Socket::Tcp)
end

#unicode_filter_decode(str) ⇒ Object

Decodes (or not) a UTF-8 string


410
411
412
# File 'lib/rex/post/meterpreter/client.rb', line 410

def unicode_filter_decode(str)
  self.encode_unicode ? Rex::Text.unicode_filter_decode(str) : str
end

#unicode_filter_encode(str) ⇒ Object

Encodes (or not) a UTF-8 string


403
404
405
# File 'lib/rex/post/meterpreter/client.rb', line 403

def unicode_filter_encode(str)
  self.encode_unicode ? Rex::Text.unicode_filter_encode(str) : str
end