Class: Rex::Proto::DNS::Server

Inherits:
Object
  • Object
show all
Includes:
IO::GramServer
Defined in:
lib/rex/proto/dns/server.rb

Defined Under Namespace

Classes: MockDnsClient

Constant Summary collapse

Packet = 
Rex::Proto::DNS::Packet

Instance Attribute Summary collapse

Attributes included from IO::GramServer

#dispatch_request_proc, #listener_thread, #send_response_proc

Class Method Summary collapse

Instance Method Summary collapse

Methods included from IO::GramServer

#send_response, #wait

Constructor Details

#initialize(lhost = '0.0.0.0', lport = 53, udp = true, tcp = false, start_cache = true, res = nil, comm = nil, ctx = {}, dblock = nil, sblock = nil) ⇒ Server

Returns a new instance of Server.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/rex/proto/dns/server.rb', line 55

def initialize(lhost = '0.0.0.0', lport = 53, udp = true, tcp = false, start_cache = true, res = nil, comm = nil, ctx = {}, dblock = nil, sblock = nil)

  @serve_udp = udp
  @serve_tcp = tcp
  @sock_options = {
    'LocalHost' => lhost,
    'LocalPort' => lport,
    'Context'   => ctx,
    'Comm'      => comm
  }
  self.fwd_res = res.nil? ? Rex::Proto::DNS::Resolver.new(:comm => comm, :context => ctx) : res
  self.listener_thread = nil
  self.dispatch_request_proc = dblock
  self.send_response_proc = sblock
  self.start_cache = start_cache
  self.cache = Rex::Proto::DNS::Cache.new
  @lock = Mutex.new
end

Instance Attribute Details

#cache ⇒ Rex::Proto::DNS::Server

Create DNS Server

Parameters:

  • lhost (String) —

    Listener address

  • lport (Fixnum) —

    Listener port

  • udp (TrueClass, FalseClass) —

    Listen on UDP socket

  • tcp (TrueClass, FalseClass) —

    Listen on TCP socket

  • res (Rex::Proto::DNS::Resolver) —

    Resolver to use, nil to create a fresh one

  • ctx (Hash) —

    Framework context for sockets

  • dblock (Proc) —

    Handler for :dispatch_request flow control interception

  • sblock (Proc) —

    Handler for :send_response flow control interception

Returns:



53
54
55
 
# File 'lib/rex/proto/dns/server.rb', line 53

def cache
  @cache
end

#fwd_res ⇒ Rex::Proto::DNS::Server

Create DNS Server

Parameters:

  • lhost (String) —

    Listener address

  • lport (Fixnum) —

    Listener port

  • udp (TrueClass, FalseClass) —

    Listen on UDP socket

  • tcp (TrueClass, FalseClass) —

    Listen on TCP socket

  • res (Rex::Proto::DNS::Resolver) —

    Resolver to use, nil to create a fresh one

  • ctx (Hash) —

    Framework context for sockets

  • dblock (Proc) —

    Handler for :dispatch_request flow control interception

  • sblock (Proc) —

    Handler for :send_response flow control interception

Returns:



53
54
55
 
# File 'lib/rex/proto/dns/server.rb', line 53

def fwd_res
  @fwd_res
end

#lock ⇒ Object (readonly)

Returns the value of attribute lock.



54
55
56
 
# File 'lib/rex/proto/dns/server.rb', line 54

def lock
  @lock
end

#serve_tcp ⇒ Rex::Proto::DNS::Server

Create DNS Server

Parameters:

  • lhost (String) —

    Listener address

  • lport (Fixnum) —

    Listener port

  • udp (TrueClass, FalseClass) —

    Listen on UDP socket

  • tcp (TrueClass, FalseClass) —

    Listen on TCP socket

  • res (Rex::Proto::DNS::Resolver) —

    Resolver to use, nil to create a fresh one

  • ctx (Hash) —

    Framework context for sockets

  • dblock (Proc) —

    Handler for :dispatch_request flow control interception

  • sblock (Proc) —

    Handler for :send_response flow control interception

Returns:



53
54
55
 
# File 'lib/rex/proto/dns/server.rb', line 53

def serve_tcp
  @serve_tcp
end

#serve_udp ⇒ Rex::Proto::DNS::Server

Create DNS Server

Parameters:

  • lhost (String) —

    Listener address

  • lport (Fixnum) —

    Listener port

  • udp (TrueClass, FalseClass) —

    Listen on UDP socket

  • tcp (TrueClass, FalseClass) —

    Listen on TCP socket

  • res (Rex::Proto::DNS::Resolver) —

    Resolver to use, nil to create a fresh one

  • ctx (Hash) —

    Framework context for sockets

  • dblock (Proc) —

    Handler for :dispatch_request flow control interception

  • sblock (Proc) —

    Handler for :send_response flow control interception

Returns:



53
54
55
 
# File 'lib/rex/proto/dns/server.rb', line 53

def serve_udp
  @serve_udp
end

#sock_options ⇒ Object (readonly)

Returns the value of attribute sock_options.



54
55
56
 
# File 'lib/rex/proto/dns/server.rb', line 54

def sock_options
  @sock_options
end

#start_cache ⇒ Rex::Proto::DNS::Server

Create DNS Server

Parameters:

  • lhost (String) —

    Listener address

  • lport (Fixnum) —

    Listener port

  • udp (TrueClass, FalseClass) —

    Listen on UDP socket

  • tcp (TrueClass, FalseClass) —

    Listen on TCP socket

  • res (Rex::Proto::DNS::Resolver) —

    Resolver to use, nil to create a fresh one

  • ctx (Hash) —

    Framework context for sockets

  • dblock (Proc) —

    Handler for :dispatch_request flow control interception

  • sblock (Proc) —

    Handler for :send_response flow control interception

Returns:



53
54
55
 
# File 'lib/rex/proto/dns/server.rb', line 53

def start_cache
  @start_cache
end

#tcp_sock ⇒ Object (readonly)

Returns the value of attribute tcp_sock.



54
55
56
 
# File 'lib/rex/proto/dns/server.rb', line 54

def tcp_sock
  @tcp_sock
end

#udp_sock ⇒ Object (readonly)

Returns the value of attribute udp_sock.



54
55
56
 
# File 'lib/rex/proto/dns/server.rb', line 54

def udp_sock
  @udp_sock
end

Class Method Details

.hardcore_alias(*args) ⇒ Object

Returns the hardcore alias for the DNS service



192
193
194
 
# File 'lib/rex/proto/dns/server.rb', line 192

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

Instance Method Details

#alias ⇒ Object

DNS server.



199
200
201
 
# File 'lib/rex/proto/dns/server.rb', line 199

def alias
  "DNS Server"
end

#default_dispatch_request(cli, data) ⇒ Object

Default DNS request dispatcher, attempts to find response records in cache or forwards request upstream

Parameters:

  • cli (Rex::Socket::Tcp, Rex::Socket::Udp) —

    Client sending the request

  • data (String) —

    raw DNS request data



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
 
# File 'lib/rex/proto/dns/server.rb', line 157

def default_dispatch_request(cli,data)
  return if data.strip.empty?
  req = Packet.encode_drb(data)
  forward = req.dup
  # Find cached items, remove request from forwarded packet
  req.question.each do |ques|
    cached = self.cache.find(ques.qname, ques.qtype)
    if cached.empty?
      next
    else
      req.instance_variable_set(:@answer, (req.answer + cached).uniq)
      forward.question.delete(ques)
    end
  end
  # Forward remaining requests, cache responses
  if forward.question.count > 0 and @fwd_res
    forwarded = self.fwd_res.send(forward)
    req.instance_variable_set(:@answer, (req.answer + forwarded.answer).uniq)
    forwarded.answer.each do |ans|
      self.cache.cache_record(ans)
    end
    req.header.ra = true # Set recursion bit
  end
  # Finalize answers in response
  # Check for empty response prior to sending
  if req.answer.size < 1
    req.header.rCode = Dnsruby::RCode::NOERROR
  end
  req.header.qr = true # Set response bit
  send_response(cli, req.data)
end

#dispatch_request(cli, data) ⇒ Object

Process client request, handled with dispatch_request_proc if set

Parameters:

  • cli (Rex::Socket::Tcp, Rex::Socket::Udp) —

    Client sending the request

  • data (String) —

    raw DNS request data



143
144
145
146
147
148
149
 
# File 'lib/rex/proto/dns/server.rb', line 143

def dispatch_request(cli, data)
  if self.dispatch_request_proc
    self.dispatch_request_proc.call(cli,data)
  else
    default_dispatch_request(cli,data)
  end
end

#monitor_listener ⇒ Object (protected)

This method monitors the listener socket for new connections and calls the on_client_connect callback routine.



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

def monitor_listener
  while true
    rds = [self.udp_sock]
    wds = []
    eds = [self.udp_sock]

    r,_,_ = ::IO.select(rds,wds,eds,1)

    if (r != nil and r[0] == self.udp_sock)
      buf,host,port = self.udp_sock.recvfrom(65535)
      # Mock up a client object for sending back data
      cli = MockDnsClient.new(host, port, r[0])
      dispatch_request(cli, buf)
    end
  end
end

#on_client_data(cli) ⇒ Object (protected)

Processes request coming from client

Parameters:

  • cli (Rex::Socket::Tcp) —

    Client sending request



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/rex/proto/dns/server.rb', line 230

def on_client_data(cli)
  begin
    data = cli.read(65535)

    raise ::EOFError if not data
    raise ::EOFError if data.empty?
    dispatch_request(cli, data)
  rescue EOFError => e
    self.tcp_socket.close_client(cli) if cli
    raise e
  end
end

#running? ⇒ Boolean

Check if server is running

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/rex/proto/dns/server.rb', line 90

def running?
  self.listener_thread and self.listener_thread.alive?
end

#start ⇒ Object

Start the DNS server and cache

Parameters:

  • start_cache (TrueClass, FalseClass) —

    stop the cache



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/rex/proto/dns/server.rb', line 97

def start

  if self.serve_udp
    @udp_sock = Rex::Socket::Udp.create(self.sock_options)
    self.listener_thread = Rex::ThreadFactory.spawn("UDPDNSServerListener", false) {
      monitor_listener
    }
  end

  if self.serve_tcp
    @tcp_sock = Rex::Socket::TcpServer.create(self.sock_options)
    self.tcp_sock.on_client_data_proc = Proc.new { |cli|
      on_client_data(cli)
    }
    self.tcp_sock.start
    if !self.serve_udp
      self.listener_thread = tcp_sock.listener_thread
    end
  end

  self.cache.start if self.start_cache
end

#stop(flush_cache = false) ⇒ Object

Stop the DNS server and cache

Parameters:

  • flush_cache (TrueClass, FalseClass) (defaults to: false) —

    Flush eDNS cache on stop



124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/rex/proto/dns/server.rb', line 124

def stop(flush_cache = false)
  ensure_close = [self.udp_sock, self.tcp_sock].compact
  begin
    self.listener_thread.kill if self.listener_thread.respond_to?(:kill)
    self.listener_thread = nil
  ensure
    while csock = ensure_close.shift
      csock.stop if csock.respond_to?(:stop)
      csock.close unless csock.respond_to?(:close) and csock.closed?
    end
  end
  self.cache.stop(flush_cache)
end

#switchns(ns = []) ⇒ Object

Switch DNS forwarders in resolver with thread safety

Parameters:

  • ns (Array, String) (defaults to: []) —

    List of (or single) nameservers to use



78
79
80
81
82
83
84
85
 
# File 'lib/rex/proto/dns/server.rb', line 78

def switchns(ns = [])
  if ns.respond_to?(:split)
    ns = [ns]
  end
  self.lock.synchronize do
    self.fwd_res.nameserver = ns
  end
end