Class: Rex::Proto::Http::Server

Inherits:
Object
  • Object
show all
Includes:
Rex::Proto
Defined in:
lib/rex/proto/http/server.rb

Overview

Acts as an HTTP server, processing requests and dispatching them to registered procs. Some of this server was modeled after webrick.

Constant Summary collapse

ExtensionMimeTypes =

A hash that associated a file extension with a mime type for use as the content type of responses.

{
  "rhtml" => "text/html",
  "html"  => "text/html",
  "htm"   => "text/htm",
  "jpg"   => "image/jpeg",
  "jpeg"  => "image/jpeg",
  "gif"   => "image/gif",
  "png"   => "image/png",
  "bmp"   => "image/bmp",
  "txt"   => "text/plain",
  "css"   => "text/css",
  "ico"   => "image/x-icon",
}
DefaultServer =

The default server name that will be returned in the Server attribute of a response.

"Rex"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(port = 80, listen_host = '0.0.0.0', ssl = false, context = {}, comm = nil, ssl_cert = nil, ssl_compression = false) ⇒ Server

Initializes an HTTP server as listening on the provided port and hostname.



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/rex/proto/http/server.rb', line 102

def initialize(port = 80, listen_host = '0.0.0.0', ssl = false, context = {}, comm = nil, ssl_cert = nil, ssl_compression = false)
  self.listen_host     = listen_host
  self.listen_port     = port
  self.ssl             = ssl
  self.context         = context
  self.comm            = comm
  self.ssl_cert        = ssl_cert
  self.ssl_compression = ssl_compression
  self.listener        = nil
  self.resources       = {}
  self.server_name     = DefaultServer
end

Instance Attribute Details

#comm ⇒ Object

Returns the value of attribute comm.



271
272
273
 
# File 'lib/rex/proto/http/server.rb', line 271

def comm
  @comm
end

#context ⇒ Object

Returns the value of attribute context.



271
272
273
 
# File 'lib/rex/proto/http/server.rb', line 271

def context
  @context
end

#listen_host ⇒ Object

Returns the value of attribute listen_host.



271
272
273
 
# File 'lib/rex/proto/http/server.rb', line 271

def listen_host
  @listen_host
end

#listen_port ⇒ Object

Returns the value of attribute listen_port.



271
272
273
 
# File 'lib/rex/proto/http/server.rb', line 271

def listen_port
  @listen_port
end

#listener ⇒ Object

Returns the value of attribute listener.



273
274
275
 
# File 'lib/rex/proto/http/server.rb', line 273

def listener
  @listener
end

#resources ⇒ Object

Returns the value of attribute resources.



273
274
275
 
# File 'lib/rex/proto/http/server.rb', line 273

def resources
  @resources
end

#server_name ⇒ Object

Returns the value of attribute server_name.



271
272
273
 
# File 'lib/rex/proto/http/server.rb', line 271

def server_name
  @server_name
end

#ssl ⇒ Object

Returns the value of attribute ssl.



272
273
274
 
# File 'lib/rex/proto/http/server.rb', line 272

def ssl
  @ssl
end

#ssl_cert ⇒ Object

Returns the value of attribute ssl_cert.



272
273
274
 
# File 'lib/rex/proto/http/server.rb', line 272

def ssl_cert
  @ssl_cert
end

#ssl_compression ⇒ Object

Returns the value of attribute ssl_compression.



272
273
274
 
# File 'lib/rex/proto/http/server.rb', line 272

def ssl_compression
  @ssl_compression
end

Class Method Details

.hardcore_alias(*args) ⇒ Object

Returns the hardcore alias for the HTTP service



126
127
128
 
# File 'lib/rex/proto/http/server.rb', line 126

def self.hardcore_alias(*args)
  "#{(args[0] || '')}#{(args[1] || '')}"
end

Instance Method Details

#add_resource(name, opts) ⇒ Object

Adds a resource handler, such as one for /, which will be called whenever the resource is requested. The “opts” parameter can have any of the following:

Proc (proc) - The procedure to call when a request comes in for this resource. LongCall (bool) - Hints to the server that this resource may have long

request processing times.



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/rex/proto/http/server.rb', line 209

def add_resource(name, opts)
  if (resources[name])
    raise RuntimeError,
      "The supplied resource '#{name}' is already added.", caller
  end

  # If a procedure was passed, mount the resource with it.
  if (opts['Proc'])
    mount(name, Handler::Proc, false, opts['Proc'], opts['VirtualDirectory'])
  else
    raise ArgumentError, "You must specify a procedure."
  end
end

#add_response_headers(resp) ⇒ Object

Adds Server headers and stuff.



233
234
235
 
# File 'lib/rex/proto/http/server.rb', line 233

def add_response_headers(resp)
  resp['Server'] = self.server_name if not resp['Server']
end

#alias ⇒ Object

HTTP server.



133
134
135
 
# File 'lib/rex/proto/http/server.rb', line 133

def alias
  super || "HTTP Server"
end

#close_client(cli) ⇒ Object

Closes the supplied client, if valid.



182
183
184
 
# File 'lib/rex/proto/http/server.rb', line 182

def close_client(cli)
  listener.close_client(cli)
end

#inspect ⇒ String

More readable inspect that only shows the url and resources

Returns:

  • (String) 


117
118
119
120
121
 
# File 'lib/rex/proto/http/server.rb', line 117

def inspect
  resources_str = resources.keys.map{|r| r.inspect }.join ", "

  "#<#{self.class} http#{ssl ? "s" : ""}://#{listen_host}:#{listen_port} [ #{resources_str} ]>"
end

#mime_type(file) ⇒ Object

Returns the mime type associated with the supplied file. Right now the set of mime types is fairly limited.



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

def mime_type(file)
  type = nil

  if (file =~ /\.(.+?)$/)
    type = ExtensionMimeTypes[$1.downcase]
  end

  type || "text/plain"
end

#mount(root, handler, long_call = false, *args) ⇒ Object

Mounts a directory or resource as being serviced by the supplied handler.



189
190
191
 
# File 'lib/rex/proto/http/server.rb', line 189

def mount(root, handler, long_call = false, *args)
  resources[root] = [ handler, long_call, args ]
end

#remove_resource(name) ⇒ Object

Removes the supplied resource handler.



226
227
228
 
# File 'lib/rex/proto/http/server.rb', line 226

def remove_resource(name)
  self.resources.delete(name)
end

#send_e404(cli, request) ⇒ Object

Sends a 404 error to the client for a given request.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/rex/proto/http/server.rb', line 254

def send_e404(cli, request)
  resp = Response::E404.new

  resp['Content-Type'] = 'text/html'

  resp.body =
    "<html><head>" +
    "<title>404 Not Found</title>" +
    "</head><body>" +
    "<h1>Not found</h1>" +
    "The requested URL #{html_escape(request.resource)} was not found on this server.<p><hr>" +
    "</body></html>"

  # Send the response to the client like what
  cli.send_response(resp)
end

#start ⇒ Object

Listens on the defined port and host and starts monitoring for clients.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/rex/proto/http/server.rb', line 140

def start

  self.listener = Rex::Socket::TcpServer.create(
    'LocalHost' => self.listen_host,
    'LocalPort' => self.listen_port,
    'Context'   => self.context,
    'SSL'		=> self.ssl,
    'SSLCert'	=> self.ssl_cert,
    'SSLCompression' => self.ssl_compression,
    'Comm'      => self.comm
  )

  # Register callbacks
  self.listener.on_client_connect_proc = Proc.new { |cli|
    on_client_connect(cli)
  }
  self.listener.on_client_data_proc = Proc.new { |cli|
    on_client_data(cli)
  }

  self.listener.start
end

#stop ⇒ Object

Terminates the monitor thread and turns off the listener.



166
167
168
169
 
# File 'lib/rex/proto/http/server.rb', line 166

def stop
  self.listener.stop
  self.listener.close
end

#unmount(root) ⇒ Object

Remove the mount point.



196
197
198
 
# File 'lib/rex/proto/http/server.rb', line 196

def unmount(root)
  resources.delete(root)
end

#wait ⇒ Object

Waits for the HTTP service to terminate



175
176
177
 
# File 'lib/rex/proto/http/server.rb', line 175

def wait
  self.listener.wait if self.listener
end