class Rex::Proto::Http::Response

HTTP response class.

Attributes

code[RW]
count_100[RW]
message[RW]
proto[RW]
request[RW]

Used to store a copy of the original request

Public Class Methods

new(code = 200, message = 'OK', proto = DefaultProtocol) click to toggle source

Constructage of the HTTP response with the supplied code, message, and protocol.

Calls superclass method Rex::Proto::Http::Packet::new
# File lib/rex/proto/http/response.rb, line 43
def initialize(code = 200, message = 'OK', proto = DefaultProtocol)
  super()

  self.code    = code.to_i
  self.message = message
  self.proto   = proto

  # Default responses to auto content length on
  self.auto_cl = true

  # default chunk sizes (if chunked is used)
  self.chunk_min_size = 1
  self.chunk_max_size = 10

  # 100 continue counter
  self.count_100 = 0
end

Public Instance Methods

check_100() click to toggle source

Allow 100 Continues to be ignored by the caller

# File lib/rex/proto/http/response.rb, line 102
def check_100
  # If this was a 100 continue with no data, reset
  if self.code == 100 and (self.body_bytes_left == -1 or self.body_bytes_left == 0) and self.count_100 < 5
    self.reset_except_queue
    self.count_100 += 1
  end
end
cmd_string() click to toggle source

Returns the response based command string.

# File lib/rex/proto/http/response.rb, line 132
def cmd_string
  "HTTP\/#{proto} #{code}#{(message and message.length > 0) ? ' ' + message : ''}\r\n"
end
get_cookies() click to toggle source

Gets cookies from the Set-Cookie header in a format to be used in the ‘cookie’ send_request field

# File lib/rex/proto/http/response.rb, line 65
def get_cookies
  cookies = ""
  if (self.headers.include?('Set-Cookie'))
    set_cookies = self.headers['Set-Cookie']
    key_vals = set_cookies.scan(/\s?([^, ;]+?)=([^, ;]*?)[;,]/)
    key_vals.each do |k, v|
      # Dont downcase actual cookie name as may be case sensitive
      name = k.downcase
      next if name == 'path'
      next if name == 'expires'
      next if name == 'domain'
      next if name == 'max-age'
      cookies << "#{k}=#{v}; "
    end
  end

  return cookies.strip
end
redirect?() click to toggle source

Answers if the response is a redirection one.

@return [Boolean] true if the response is a redirection, false otherwise.

# File lib/rex/proto/http/response.rb, line 113
def redirect?
  [301, 302, 303, 307, 308].include?(code)
end
redirection() click to toggle source

Provides the uri of the redirection location.

@return [URI] the uri of the redirection location. @return [nil] if the response hasn’t a Location header or it isn’t a valid uri.

# File lib/rex/proto/http/response.rb, line 121
def redirection
  begin
    URI(headers['Location'])
  rescue ::URI::InvalidURIError
    nil
  end
end
update_cmd_parts(str) click to toggle source

Updates the various parts of the HTTP response command string.

# File lib/rex/proto/http/response.rb, line 87
def update_cmd_parts(str)
  if (md = str.match(/HTTP\/(.+?)\s+(\d+)\s?(.+?)\r?\n?$/))
    self.message = md[3].gsub(/\r/, '')
    self.code    = md[2].to_i
    self.proto   = md[1]
  else
    raise RuntimeError, "Invalid response command string", caller
  end

  check_100()
end