Class: Rex::Proto::Http::ClientRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/rex/proto/http/client_request.rb

Constant Summary collapse

DefaultUserAgent =
"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)"
DefaultConfig =
{
  #
  # Regular HTTP stuff
  #
  'agent'                  => DefaultUserAgent,
  'cgi'                    => true,
  'cookie'                 => nil,
  'data'                   => '',
  'headers'                => nil,
  'raw_headers'            => '',
  'method'                 => 'GET',
  'partial'                => false,
  'path_info'              => '',
  'port'                   => 80,
  'proto'                  => 'HTTP',
  'query'                  => '',
  'ssl'                    => false,
  'uri'                    => '/',
  'vars_get'               => {},
  'vars_post'              => {},
  'version'                => '1.1',
  'vhost'                  => nil,

  #
  # Evasion options
  #
  'encode_params'          => true,
  'encode'                 => false,
  'uri_encode_mode'        => 'hex-normal', # hex-normal, hex-all, hex-noslashes, hex-random, u-normal, u-all, u-noslashes, u-random
  'uri_encode_count'       => 1,       # integer
  'uri_full_url'           => false,   # bool
  'pad_method_uri_count'   => 1,       # integer
  'pad_uri_version_count'  => 1,       # integer
  'pad_method_uri_type'    => 'space', # space, tab, apache
  'pad_uri_version_type'   => 'space', # space, tab, apache
  'method_random_valid'    => false,   # bool
  'method_random_invalid'  => false,   # bool
  'method_random_case'     => false,   # bool
  'version_random_valid'   => false,   # bool
  'version_random_invalid' => false,   # bool
  'uri_dir_self_reference' => false,   # bool
  'uri_dir_fake_relative'  => false,   # bool
  'uri_use_backslashes'    => false,   # bool
  'pad_fake_headers'       => false,   # bool
  'pad_fake_headers_count' => 16,      # integer
  'pad_get_params'         => false,   # bool
  'pad_get_params_count'   => 8,       # integer
  'pad_post_params'        => false,   # bool
  'pad_post_params_count'  => 8,       # integer
  'uri_fake_end'           => false,   # bool
  'uri_fake_params_start'  => false,   # bool
  'header_folding'         => false,   # bool
  'chunked_size'           => 0,        # integer

  #
  # NTLM Options
  #
  'usentlm2_session' => true,
  'use_ntlmv2'       => true,
  'send_lm'         => true,
  'send_ntlm'       => true,
  'SendSPN'  => true,
  'UseLMKey' => false,
  'domain' => 'WORKSTATION',
  #
  # Digest Options
  #
  'DigestAuthIIS' => true
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ ClientRequest

Returns a new instance of ClientRequest.


88
89
90
91
# File 'lib/rex/proto/http/client_request.rb', line 88

def initialize(opts={})
  @opts = DefaultConfig.merge(opts)
  @opts['headers'] ||= {}
end

Instance Attribute Details

#optsObject (readonly)

Returns the value of attribute opts


86
87
88
# File 'lib/rex/proto/http/client_request.rb', line 86

def opts
  @opts
end

Instance Method Details

#set_agent_headerObject (protected)

Return the HTTP agent header


373
374
375
# File 'lib/rex/proto/http/client_request.rb', line 373

def set_agent_header
  opts['agent'] ? set_formatted_header("User-Agent", opts['agent']) : ""
end

#set_auth_headerObject (protected)


377
378
379
# File 'lib/rex/proto/http/client_request.rb', line 377

def set_auth_header
  opts['authorization'] ? set_formatted_header("Authorization", opts['authorization']) : ""
end

#set_body(bdata) ⇒ Object (protected)

Return the HTTP seperator and body string


470
471
472
473
474
475
476
477
478
479
# File 'lib/rex/proto/http/client_request.rb', line 470

def set_body(bdata)
  return "\r\n" + bdata if opts['chunked_size'] == 0
  str = bdata.dup
  chunked = ''
  while str.size > 0
    chunk = str.slice!(0,rand(opts['chunked_size']) + 1)
    chunked << sprintf("%x", chunk.size) + "\r\n" + chunk + "\r\n"
  end
  "\r\n" + chunked + "0\r\n\r\n"
end

#set_chunked_headerObject (protected)


462
463
464
465
# File 'lib/rex/proto/http/client_request.rb', line 462

def set_chunked_header
  return "" if opts['chunked_size'] == 0
  set_formatted_header('Transfer-Encoding', 'chunked')
end

#set_connection_headerObject (protected)

Return the HTTP connection header


391
392
393
# File 'lib/rex/proto/http/client_request.rb', line 391

def set_connection_header
  opts['connection'] ? set_formatted_header("Connection", opts['connection']) : ""
end

#set_content_len_header(clen) ⇒ Object (protected)

Return the content length header


405
406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'lib/rex/proto/http/client_request.rb', line 405

def set_content_len_header(clen)
  if opts['method'] == 'GET' && (clen == 0 || opts['chunked_size'] > 0)
    # This condition only applies to GET because of the specs.
    # RFC-7230:
    # A Content-Length header field is normally sent in a POST
    # request even when the value is 0 (indicating an empty payload body)
    return ''
  elsif opts['headers'] && opts['headers']['Content-Length']
    # If the module has a modified content-length header, respect that by
    # not setting another one.
    return ''
  end
  set_formatted_header("Content-Length", clen)
end

#set_content_type_headerObject (protected)

Return the content type header


398
399
400
# File 'lib/rex/proto/http/client_request.rb', line 398

def set_content_type_header
  opts['ctype'] ? set_formatted_header("Content-Type", opts['ctype']) : ""
end

Return the HTTP cookie header


384
385
386
# File 'lib/rex/proto/http/client_request.rb', line 384

def set_cookie_header
  opts['cookie'] ? set_formatted_header("Cookie", opts['cookie']) : ""
end

#set_encode_uri(str) ⇒ Object (protected)


241
242
243
244
245
246
247
# File 'lib/rex/proto/http/client_request.rb', line 241

def set_encode_uri(str)
  a = str.to_s.dup
  opts['uri_encode_count'].times {
    a = Rex::Text.uri_encode(a, opts['uri_encode_mode'])
  }
  return a
end

#set_extra_headersObject (protected)

Return a string of formatted extra headers


443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
# File 'lib/rex/proto/http/client_request.rb', line 443

def set_extra_headers
  buf = ''

  if (opts['pad_fake_headers'])
    1.upto(opts['pad_fake_headers_count'].to_i) do |i|
      buf << set_formatted_header(
        Rex::Text.rand_text_alphanumeric(rand(32)+1),
        Rex::Text.rand_text_alphanumeric(rand(32)+1)
      )
    end
  end

  opts['headers'].each_pair do |var,val|
    buf << set_formatted_header(var, val)
  end

  buf
end

#set_formatted_header(var, val) ⇒ Object (protected)

Return a formatted header string


362
363
364
365
366
367
368
# File 'lib/rex/proto/http/client_request.rb', line 362

def set_formatted_header(var, val)
  if (self.opts['header_folding'])
    "#{var}:\r\n\t#{val}\r\n"
  else
    "#{var}: #{val}\r\n"
  end
end

#set_host_headerObject (protected)

Return the HTTP Host header


423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'lib/rex/proto/http/client_request.rb', line 423

def set_host_header
  return "" if opts['uri_full_url']
  host = opts['vhost']

  # IPv6 addresses must be placed in brackets
  if Rex::Socket.is_ipv6?(host)
    host = "[#{host}]"
  end

  # The port should be appended if non-standard
  if not [80,443].include?(opts['port'])
    host = host + ":#{opts['port']}"
  end

  set_formatted_header("Host", host)
end

#set_methodObject (protected)


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/rex/proto/http/client_request.rb', line 249

def set_method
  ret = opts['method'].dup

  if (opts['method_random_valid'])
    ret = ['GET', 'POST', 'HEAD'][rand(3)]
  end

  if (opts['method_random_invalid'])
    ret = Rex::Text.rand_text_alpha(rand(20)+1)
  end

  if (opts['method_random_case'])
    ret = Rex::Text.to_rand_case(ret)
  end

  ret
end

#set_method_uri_spacerObject (protected)


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'lib/rex/proto/http/client_request.rb', line 267

def set_method_uri_spacer
  len = opts['pad_method_uri_count'].to_i
  set = " "
  buf = ""

  case opts['pad_method_uri_type']
  when 'tab'
    set = "\t"
  when 'apache'
    set = "\t \x0b\x0c\x0d"
  end

  while(buf.length < len)
    buf << set[ rand(set.length) ]
  end

  return buf
end

#set_path_infoObject (protected)

Return the HTTP path info TODO:

* Encode path information

307
308
309
# File 'lib/rex/proto/http/client_request.rb', line 307

def set_path_info
  opts['path_info'] ? opts['path_info'] : ''
end

#set_uriObject (protected)


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/rex/proto/http/client_request.rb', line 211

def set_uri
  uri_str = opts['uri'].dup
  if (opts['uri_dir_self_reference'])
    uri_str.gsub!('/', '/./')
  end

  if (opts['uri_dir_fake_relative'])
    buf = ""
    uri_str.split('/',-1).each do |part|
      cnt = rand(8)+2
      1.upto(cnt) { |idx|
        buf << "/" + Rex::Text.rand_text_alphanumeric(rand(32)+1)
      }
      buf << ("/.." * cnt)
      buf << "/" + part
    end
    uri_str = buf
  end

  if (opts['uri_full_url'])
    url = opts['ssl'] ? "https://" : "http://"
    url << opts['vhost']
    url << ((opts['port'] == 80) ? "" : ":#{opts['port']}")
    url << uri_str
    url
  else
    uri_str
  end
end

#set_uri_appendObject (protected)

Return the padding to place before the uri


314
315
316
317
318
# File 'lib/rex/proto/http/client_request.rb', line 314

def set_uri_append
  # TODO:
  #  * Support different padding types
  ""
end

#set_uri_prependObject (protected)

Return the padding to place before the uri


289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/rex/proto/http/client_request.rb', line 289

def set_uri_prepend
  prefix = ""

  if (opts['uri_fake_params_start'])
    prefix << '/%3fa=b/../'
  end

  if (opts['uri_fake_end'])
    prefix << '/%20HTTP/1.0/../../'
  end

  prefix
end

#set_uri_version_spacerObject (protected)

Return the spacing between the uri and the version


323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/rex/proto/http/client_request.rb', line 323

def set_uri_version_spacer
  len = opts['pad_uri_version_count'].to_i
  set = " "
  buf = ""

  case opts['pad_uri_version_type']
  when 'tab'
    set = "\t"
  when 'apache'
    set = "\t \x0b\x0c\x0d"
  end

  while(buf.length < len)
    buf << set[ rand(set.length) ]
  end

  return buf
end

#set_versionObject (protected)

Return the HTTP version string


345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'lib/rex/proto/http/client_request.rb', line 345

def set_version
  ret = opts['proto'] + "/" + opts['version']

  if (opts['version_random_valid'])
    ret = opts['proto'] + "/" +  ['1.0', '1.1'][rand(2)]
  end

  if (opts['version_random_invalid'])
    ret = Rex::Text.rand_text_alphanumeric(rand(20)+1)
  end

  ret << "\r\n"
end

#to_s(headers_only: false) ⇒ Object


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/rex/proto/http/client_request.rb', line 93

def to_s(headers_only: false)
  # Start GET query string
  qstr = opts['query'] ? opts['query'].dup : ""

  # Start POST data string
  pstr = opts['data'] ? opts['data'].dup : ""

  if opts['cgi']
    uri_str = set_uri

    if (opts['pad_get_params'])
      1.upto(opts['pad_get_params_count'].to_i) do |i|
        qstr << '&' if qstr.length > 0
        qstr << set_encode_uri(Rex::Text.rand_text_alphanumeric(rand(32)+1))
        qstr << '='
        qstr << set_encode_uri(Rex::Text.rand_text_alphanumeric(rand(32)+1))
      end
    end
    if opts.key?("vars_get") && opts['vars_get']
      opts['vars_get'].each_pair do |var,val|
        var = var.to_s

        qstr << '&' if qstr.length > 0
        qstr << (opts['encode_params'] ? set_encode_uri(var) : var)
        # support get parameter without value
        # Example: uri?parameter
        if val
          val = val.to_s
          qstr << '='
          qstr << (opts['encode_params'] ? set_encode_uri(val) : val)
        end
      end
    end
    if (opts['pad_post_params'])
      1.upto(opts['pad_post_params_count'].to_i) do |i|
        rand_var = Rex::Text.rand_text_alphanumeric(rand(32)+1)
        rand_val = Rex::Text.rand_text_alphanumeric(rand(32)+1)
        pstr << '&' if pstr.length > 0
        pstr << (opts['encode_params'] ? set_encode_uri(rand_var) : rand_var)
        pstr << '='
        pstr << (opts['encode_params'] ? set_encode_uri(rand_val) : rand_val)
      end
    end

    opts['vars_post'].each_pair do |var,val|
      var = var.to_s
      unless val.is_a?(Array)
        val = [val]
      end
      val.each do |v|
        v = v.to_s
        pstr << '&' if pstr.length > 0
        pstr << (opts['encode_params'] ? set_encode_uri(var) : var)
        pstr << '='
        pstr << (opts['encode_params'] ? set_encode_uri(v) : v)
      end
    end
  else
    if opts['encode']
      qstr = set_encode_uri(qstr)
    end
    uri_str = set_uri
  end

  req = ''
  req << set_method
  req << set_method_uri_spacer()
  req << set_uri_prepend()

  if opts['encode']
    req << set_encode_uri(uri_str)
  else
    req << uri_str
  end


  if (qstr.length > 0)
    req << '?'
    req << qstr
  end

  req << set_path_info
  req << set_uri_append()
  req << set_uri_version_spacer()
  req << set_version

  # Set a default Host header if one wasn't passed in
  unless opts['headers'] && opts['headers'].keys.map(&:downcase).include?('host')
    req << set_host_header
  end

  # If an explicit User-Agent header is set, then use that instead of
  # the default
  unless opts['headers'] && opts['headers'].keys.map(&:downcase).include?('user-agent')
    req << set_agent_header
  end

  # Similar to user-agent, only add an automatic auth header if a
  # manual one hasn't been provided
  unless opts['headers'] && opts['headers'].keys.map(&:downcase).include?('authorization')
    req << set_auth_header
  end

  req << set_cookie_header
  req << set_connection_header
  req << set_extra_headers

  req << set_content_type_header
  req << set_content_len_header(pstr.length)
  req << set_chunked_header
  req << opts['raw_headers']
  req << set_body(pstr) unless headers_only

  req
end