Module: Rex::Socket

Included in:
Proto::DHCP::Server, Ip, Tcp, TcpServer, Udp
Defined in:
lib/rex/socket.rb,
lib/rex/socket/comm.rb,
lib/rex/socket/range_walker.rb,
lib/rex/socket/switch_board.rb,
lib/rex/socket/subnet_walker.rb

Overview

Base class for all sockets.

Defined Under Namespace

Modules: Comm, Ip, SslTcp, SslTcpServer, Tcp, TcpServer, Udp Classes: Parameters, Range, RangeWalker, SubnetWalker, SwitchBoard

Constant Summary collapse

MATCH_IPV6 =

Common Regular Expressions

/^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/
MATCH_IPV4 =
/^\s*(?:(?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2}))\s*$/
MATCH_IPV4_PRIVATE =
/^\s*(?:10\.|192\.168|172.(?:1[6-9]|2[0-9]|3[01])\.|169\.254)/
@@support_ipv6 =

Cache our IPv6 support flag

nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#contextObject

Contextual information that describes the source and other instance-specific attributes. This comes from the param.context attribute.


756
757
758
# File 'lib/rex/socket.rb', line 756

def context
  @context
end

#ipvObject

The IP version of the socket


750
751
752
# File 'lib/rex/socket.rb', line 750

def ipv
  @ipv
end

#localhostObject

The local host of the connected socket.


742
743
744
# File 'lib/rex/socket.rb', line 742

def localhost
  @localhost
end

#localportObject

The local port of the connected socket.


746
747
748
# File 'lib/rex/socket.rb', line 746

def localport
  @localport
end

#peerhostObject

The peer host of the connected socket.


734
735
736
# File 'lib/rex/socket.rb', line 734

def peerhost
  @peerhost
end

#peerportObject

The peer port of the connected socket.


738
739
740
# File 'lib/rex/socket.rb', line 738

def peerport
  @peerport
end

Class Method Details

.addr_atoc(mask) ⇒ Object

Converts an ASCII IP address to a CIDR mask. Returns nil if it's not convertable.


284
285
286
287
288
289
290
291
292
293
294
# File 'lib/rex/socket.rb', line 284

def self.addr_atoc(mask)
  mask_i = resolv_nbo_i(mask)
  cidr = nil
  0.upto(32) do |i|
    if ((1 << i)-1) << (32-i) == mask_i
      cidr = i
      break
    end
  end
  return cidr
end

.addr_atoi(addr) ⇒ Object

Converts a ascii address into an integer


315
316
317
# File 'lib/rex/socket.rb', line 315

def self.addr_atoi(addr)
  resolv_nbo_i(addr)
end

.addr_atoi_list(addr) ⇒ Object

Converts a ascii address into a list of addresses


322
323
324
# File 'lib/rex/socket.rb', line 322

def self.addr_atoi_list(addr)
  resolv_nbo_i_list(addr)
end

.addr_aton(addr) ⇒ Object

Converts a ascii address to network byte order


340
341
342
# File 'lib/rex/socket.rb', line 340

def self.addr_aton(addr)
  resolv_nbo(addr)
end

.addr_ctoa(cidr) ⇒ Object

Resolves a CIDR bitmask into a dotted-quad. Returns nil if it's not convertable.


300
301
302
303
# File 'lib/rex/socket.rb', line 300

def self.addr_ctoa(cidr)
  return nil unless (0..32) === cidr.to_i
  addr_itoa(((1 << cidr)-1) << 32-cidr)
end

.addr_itoa(addr, v6 = false) ⇒ Object

Converts an integer address into ascii


331
332
333
334
335
# File 'lib/rex/socket.rb', line 331

def self.addr_itoa(addr, v6=false)
  nboa = addr_iton(addr, v6)

  addr_ntoa(nboa)
end

.addr_iton(addr, v6 = false) ⇒ Object

Converts an integer into a network byte order address


412
413
414
415
416
417
418
419
420
421
422
423
# File 'lib/rex/socket.rb', line 412

def self.addr_iton(addr, v6=false)
  if(addr < 0x100000000 && !v6)
    return [addr].pack('N')
  else
    w    = []
    w[0] = (addr >> 96) & 0xffffffff
    w[1] = (addr >> 64) & 0xffffffff
    w[2] = (addr >> 32) & 0xffffffff
    w[3] = addr & 0xffffffff
    return w.pack('N4')
  end
end

.addr_ntoa(addr) ⇒ String

Converts a network byte order address to ascii

Raises:


349
350
351
352
353
354
355
356
357
358
359
360
361
# File 'lib/rex/socket.rb', line 349

def self.addr_ntoa(addr)
  # IPv4
  if (addr.length == 4)
    return addr.unpack('C4').join('.')
  end

  # IPv6
  if (addr.length == 16)
    return compress_address(addr.unpack('n8').map{ |c| "%x" % c }.join(":"))
  end

  raise RuntimeError, "Invalid address format"
end

.addr_ntoi(addr) ⇒ Object

Converts a network byte order address to an integer

Raises:


390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
# File 'lib/rex/socket.rb', line 390

def self.addr_ntoi(addr)

  bits = addr.unpack("N*")

  if (bits.length == 1)
    return bits[0]
  end

  if (bits.length == 4)
    val = 0
    bits.each_index { |i| val += (  bits[i] << (96 - (i * 32)) ) }
    return val
  end

  raise RuntimeError, "Invalid address format"
end

.bit2netmask(bitmask, ipv6 = false) ⇒ Object

Converts a bitmask (28) into a netmask (255.255.255.240)


492
493
494
495
496
497
498
499
500
# File 'lib/rex/socket.rb', line 492

def self.bit2netmask(bitmask, ipv6=false)
  if bitmask > 32 or ipv6
    i = ((~((2 ** (128 - bitmask)) - 1)) & (2**128-1))
    n = Rex::Socket.addr_iton(i, true)
    return Rex::Socket.addr_ntoa(n)
  else
    [ (~((2 ** (32 - bitmask)) - 1)) & 0xffffffff ].pack('N').unpack('CCCC').join('.')
  end
end

.cidr_crack(cidr, v6 = false) ⇒ Object

Converts a CIDR subnet into an array (base, bcast)


442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
# File 'lib/rex/socket.rb', line 442

def self.cidr_crack(cidr, v6=false)
  tmp = cidr.split('/')

  tst,scope = tmp[0].split("%",2)
  scope     = "%" + scope if scope
  scope   ||= ""

  addr = addr_atoi(tst)

  bits = 32
  mask = 0
  use6 = false

  if (addr > 0xffffffff or v6 or cidr =~ /:/)
    use6 = true
    bits = 128
  end

  mask = (2 ** bits) - (2 ** (bits - tmp[1].to_i))
  base = addr & mask

  stop = base + (2 ** (bits - tmp[1].to_i)) - 1
  return [self.addr_itoa(base, use6) + scope, self.addr_itoa(stop, use6) + scope]
end

.compress_address(addr) ⇒ String

Implement zero compression for IPv6 addresses. Uses the compression method from Marco Ceresa's IPAddress GEM


371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
# File 'lib/rex/socket.rb', line 371

def self.compress_address(addr)
  return addr unless is_ipv6?(addr)
  addr = addr.dup
  while true
    break if addr.sub!(/\A0:0:0:0:0:0:0:0\Z/, '::')
    break if addr.sub!(/\b0:0:0:0:0:0:0\b/, ':')
    break if addr.sub!(/\b0:0:0:0:0:0\b/, ':')
    break if addr.sub!(/\b0:0:0:0:0\b/, ':')
    break if addr.sub!(/\b0:0:0:0\b/, ':')
    break if addr.sub!(/\b0:0:0\b/, ':')
    break if addr.sub!(/\b0:0\b/, ':')
    break
  end
  addr.sub(/:{3,}/, '::')
end

.create(opts = {}) ⇒ Object

Create a socket instance using the supplied parameter hash.


39
40
41
# File 'lib/rex/socket.rb', line 39

def self.create(opts = {})
  return create_param(Rex::Socket::Parameters.from_hash(opts))
end

.create_ip(opts = {}) ⇒ Object

Create a IP socket using the supplied parameter hash.


74
75
76
# File 'lib/rex/socket.rb', line 74

def self.create_ip(opts = {})
  return create_param(Rex::Socket::Parameters.from_hash(opts.merge('Proto' => 'ip')))
end

.create_param(param) ⇒ Object

Create a socket using the supplied Rex::Socket::Parameter instance.


46
47
48
# File 'lib/rex/socket.rb', line 46

def self.create_param(param)
  return param.comm.create(param)
end

.create_tcp(opts = {}) ⇒ Object

Create a TCP socket using the supplied parameter hash.


53
54
55
# File 'lib/rex/socket.rb', line 53

def self.create_tcp(opts = {})
  return create_param(Rex::Socket::Parameters.from_hash(opts.merge('Proto' => 'tcp')))
end

.create_tcp_server(opts = {}) ⇒ Object

Create a TCP server socket using the supplied parameter hash.


60
61
62
# File 'lib/rex/socket.rb', line 60

def self.create_tcp_server(opts = {})
  return create_tcp(opts.merge('Server' => true))
end

.create_udp(opts = {}) ⇒ Object

Create a UDP socket using the supplied parameter hash.


67
68
69
# File 'lib/rex/socket.rb', line 67

def self.create_udp(opts = {})
  return create_param(Rex::Socket::Parameters.from_hash(opts.merge('Proto' => 'udp')))
end

.dotted_ip?(addr) ⇒ Boolean

Checks to see if the supplied address is in “dotted” form


136
137
138
139
140
141
142
143
144
# File 'lib/rex/socket.rb', line 136

def self.dotted_ip?(addr)
  # Match IPv6
  return true if (support_ipv6? and addr =~ MATCH_IPV6)

  # Match IPv4
  return true if (addr =~ MATCH_IPV4)

  false
end

.eth_aton(mac) ⇒ Object

Converts a colon-delimited MAC address into a 6-byte binary string


428
429
430
# File 'lib/rex/socket.rb', line 428

def self.eth_aton(mac)
  mac.split(":").map{|c| c.to_i(16) }.pack("C*")
end

.eth_ntoa(bin) ⇒ Object

Converts a 6-byte binary string into a colon-delimited MAC address


435
436
437
# File 'lib/rex/socket.rb', line 435

def self.eth_ntoa(bin)
  bin.unpack("C6").map{|x| "%.2x" % x }.join(":").upcase
end

.from_sockaddr(saddr) ⇒ Object

Returns the address family, host, and port of the supplied sockaddr as

af, host, port

243
244
245
246
247
248
249
250
# File 'lib/rex/socket.rb', line 243

def self.from_sockaddr(saddr)
  port, host = ::Socket::unpack_sockaddr_in(saddr)
  af = ::Socket::AF_INET
  if (support_ipv6?() and is_ipv6?(host))
    af = ::Socket::AF_INET6
  end
  return [ af, host, port ]
end

.getaddress(hostname, accept_ipv6 = true) ⇒ String

Get the first address returned by a DNS lookup for hostname.

See Also:


164
165
166
# File 'lib/rex/socket.rb', line 164

def self.getaddress(hostname, accept_ipv6 = true)
  getaddresses(hostname, accept_ipv6).first
end

.getaddresses(hostname, accept_ipv6 = true) ⇒ Array<String>

Wrapper for ::Socket.gethostbyname that takes special care to see if the supplied address is already an ASCII IP address. This is necessary to prevent blocking while waiting on a DNS reverse lookup when we already have what we need.


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
# File 'lib/rex/socket.rb', line 176

def self.getaddresses(hostname, accept_ipv6 = true)
  if hostname =~ MATCH_IPV4 or (accept_ipv6 and hostname =~ MATCH_IPV6)
    return [hostname]
  end

  res = ::Socket.gethostbyname(hostname)
  return [] if not res

  # Shift the first three elements out, leaving just the list of
  # addresses
  res.shift # name
  res.shift # alias hostnames
  res.shift # address_family

  # Rubinius has a bug where gethostbyname returns dotted quads instead of
  # NBO, but that's what we want anyway, so just short-circuit here.
  if res[0] =~ MATCH_IPV4 || res[0] =~ MATCH_IPV6
    unless accept_ipv6
      res.reject!{ |ascii| ascii =~ MATCH_IPV6 }
    end
  else
    unless accept_ipv6
      res.reject!{ |nbo| nbo.length != 4 }
    end
    res.map!{ |nbo| self.addr_ntoa(nbo) }
  end

  res
end

.gethostbyname(host) ⇒ Object

Wrapper for Socket.gethostbyname which takes into account whether or not an IP address is supplied. If it is, then reverse DNS resolution does not occur. This is done in order to prevent delays, such as would occur on Windows.


212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/rex/socket.rb', line 212

def self.gethostbyname(host)
  if (is_ipv4?(host))
    return [ host, [], 2, host.split('.').map{ |c| c.to_i }.pack("C4") ]
  end

  if is_ipv6?(host)
    # pop off the scopeid since gethostbyname isn't smart enough to
    # deal with it.
    host, _ = host.split('%', 2)
  end

  ::Socket.gethostbyname(host)
end

Identifies the link-local address of a given interface (if IPv6 is enabled)


594
595
596
597
598
# File 'lib/rex/socket.rb', line 594

def self.ipv6_link_address(intf)
  r = source_address("FF02::1%#{intf}")
  return nil if r.nil? || r !~ /^fe80/i
  r
end

.ipv6_mac(intf) ⇒ Object

Identifies the mac address of a given interface (if IPv6 is enabled)


603
604
605
606
607
608
# File 'lib/rex/socket.rb', line 603

def self.ipv6_mac(intf)
  r = ipv6_link_address(intf)
  return if not r
  raw = addr_aton(r)[-8, 8]
  (raw[0,3] + raw[5,3]).unpack("C*").map{|c| "%.2x" % c}.join(":")
end

.is_internal?(addr) ⇒ Boolean

Return true if addr is within the ranges specified in RFC1918, or RFC5735/RFC3927


150
151
152
153
154
155
156
# File 'lib/rex/socket.rb', line 150

def self.is_internal?(addr)
  if self.dotted_ip?(addr)
    addr =~ MATCH_IPV4_PRIVATE
  else
    false
  end
end

.is_ipv4?(addr) ⇒ Boolean

Determine whether this is an IPv4 address


122
123
124
# File 'lib/rex/socket.rb', line 122

def self.is_ipv4?(addr)
  ( addr =~ MATCH_IPV4 ) ? true : false
end

.is_ipv6?(addr) ⇒ Boolean

Determine whether this is an IPv6 address


129
130
131
# File 'lib/rex/socket.rb', line 129

def self.is_ipv6?(addr)
  ( addr =~ MATCH_IPV6 ) ? true : false
end

.net2bitmask(netmask) ⇒ Object

Converts a netmask (255.255.255.240) into a bitmask (28). This is the lame kid way of doing it.


471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
# File 'lib/rex/socket.rb', line 471

def self.net2bitmask(netmask)

  nmask = resolv_nbo(netmask)
  imask = addr_ntoi(nmask)
  bits  = 32

  if (imask > 0xffffffff)
    bits = 128
  end

  0.upto(bits-1) do |bit|
    p = 2 ** bit
    return (bits - bit) if ((imask & p) == p)
  end

  0
end

.portlist_to_portspec(parr) ⇒ Object

Converts a port list like [1,2,3,4,5,100] into a range specification like “1-5,100”


534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
# File 'lib/rex/socket.rb', line 534

def self.portlist_to_portspec(parr)
  ranges = []
  range  = []
  lastp  = nil

  parr.uniq.sort{|a,b| a<=>b}.map{|a| a.to_i}.each do |n|
    next if (n < 1 or n > 65535)
    if not lastp
      range = [n]
      lastp = n
      next
    end

    if lastp == n - 1
      range << n
    else
      ranges << range
      range = [n]
    end
    lastp = n
  end

  ranges << range
  ranges.delete(nil)
  ranges.uniq.map{|x| x.length == 1 ? "#{x[0]}" : "#{x[0]}-#{x[-1]}"}.join(",")
end

.portspec_crack(pspec) ⇒ Object


503
504
505
# File 'lib/rex/socket.rb', line 503

def self.portspec_crack(pspec)
  portspec_to_portlist(pspec)
end

.portspec_to_portlist(pspec) ⇒ Object

Converts a port specification like “80,21-23,443” into a sorted, unique array of valid port numbers like [21,22,23,80,443]


511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'lib/rex/socket.rb', line 511

def self.portspec_to_portlist(pspec)
  ports = []

  # Build ports array from port specification
  pspec.split(/,/).each do |item|
    start, stop = item.split(/-/).map { |p| p.to_i }

    start ||= 0
    stop ||= item.match(/-/) ? 65535 : start

    start, stop = stop, start if stop < start

    start.upto(stop) { |p| ports << p }
  end

  # Sort, and remove dups and invalid ports
  ports.sort.uniq.delete_if { |p| p < 1 or p > 65535 }
end

.resolv_nbo(host) ⇒ Object

Resolves a host to raw network-byte order.


255
256
257
# File 'lib/rex/socket.rb', line 255

def self.resolv_nbo(host)
  self.gethostbyname( Rex::Socket.getaddress(host, true) )[3]
end

.resolv_nbo_i(host) ⇒ Object

Resolves a host to a network-byte order ruby integer.


269
270
271
# File 'lib/rex/socket.rb', line 269

def self.resolv_nbo_i(host)
  addr_ntoi(resolv_nbo(host))
end

.resolv_nbo_i_list(host) ⇒ Object

Resolves a host to a list of network-byte order ruby integers.


276
277
278
# File 'lib/rex/socket.rb', line 276

def self.resolv_nbo_i_list(host)
  resolv_nbo_list(host).map{|addr| addr_ntoi(addr) }
end

.resolv_nbo_list(host) ⇒ Object

Resolves a host to raw network-byte order.


262
263
264
# File 'lib/rex/socket.rb', line 262

def self.resolv_nbo_list(host)
  Rex::Socket.getaddresses(host).map{|addr| self.gethostbyname(addr)[3] }
end

.resolv_to_dotted(host) ⇒ Object

Resolves a host to a dotted address.


308
309
310
# File 'lib/rex/socket.rb', line 308

def self.resolv_to_dotted(host)
  addr_ntoa(addr_aton(host))
end

.source_address(dest = '8.8.8.8', comm = ::Rex::Socket::Comm::Local) ⇒ Object

This method does NOT send any traffic to the destination, instead, it uses a “bound” UDP socket to determine what source address we would use to communicate with the specified destination. The destination defaults to Google's DNS server to make the standard behavior determine which IP we would use to communicate with the internet.


574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'lib/rex/socket.rb', line 574

def self.source_address(dest='8.8.8.8', comm = ::Rex::Socket::Comm::Local)
  begin
    s = self.create_udp(
      'PeerHost' => dest,
      'PeerPort' => 31337,
      'Comm'     => comm
    )
    r = s.getsockname[1]
    s.close

    # Trim off the trailing interface ID for link-local IPv6
    return r.split('%').first
  rescue ::Exception
    return '127.0.0.1'
  end
end

.support_ipv6?Boolean

Determine whether we support IPv6


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/rex/socket.rb', line 102

def self.support_ipv6?
  return @@support_ipv6 if not @@support_ipv6.nil?

  @@support_ipv6 = false

  if (::Socket.const_defined?('AF_INET6'))
    begin
      s = ::Socket.new(::Socket::AF_INET6, ::Socket::SOCK_DGRAM, ::Socket::IPPROTO_UDP)
      s.close
      @@support_ipv6 = true
    rescue
    end
  end

  return @@support_ipv6
end

.tcp_socket_pairObject

Create a TCP socket pair.

sf: This create a socket pair using native ruby sockets and will work on Windows where ::Socket.pair is not implemented. Note: OpenSSL requires native ruby sockets for its io.

Note: Even though sub-threads are smashing the parent threads local, there

is no concurrent use of the same locals and this is safe.

619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
# File 'lib/rex/socket.rb', line 619

def self.tcp_socket_pair
  lsock   = nil
  rsock   = nil
  laddr   = '127.0.0.1'
  lport   = 0
  threads = []
  mutex   = ::Mutex.new

  threads << Rex::ThreadFactory.spawn('TcpSocketPair', false) {
    server = nil
    mutex.synchronize {
      threads << Rex::ThreadFactory.spawn('TcpSocketPairClient', false) {
        mutex.synchronize {
          rsock = ::TCPSocket.new( laddr, lport )
        }
      }
      server = ::TCPServer.new(laddr, 0)
      if (server.getsockname =~ /127\.0\.0\.1:/)
        # JRuby ridiculousness
        caddr, lport = server.getsockname.split(":")
        caddr = caddr[1,caddr.length]
        lport = lport.to_i
      else
        # Sane implementations where Socket#getsockname returns a
        # sockaddr
        lport, caddr = ::Socket.unpack_sockaddr_in( server.getsockname )
      end
    }
    lsock, _ = server.accept
    server.close
  }

  threads.each { |t| t.join }

  return [lsock, rsock]
end

.to_sockaddr(ip, port) ⇒ Object

Create a sockaddr structure using the supplied IP address, port, and address family


230
231
232
233
234
235
236
237
# File 'lib/rex/socket.rb', line 230

def self.to_sockaddr(ip, port)

  if (ip == '::ffff:0.0.0.0')
    ip = support_ipv6?() ? '::' : '0.0.0.0'
  end

  return ::Socket.pack_sockaddr_in(port, ip)
end

.udp_socket_pairObject

Create a UDP socket pair using native ruby UDP sockets.


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'lib/rex/socket.rb', line 659

def self.udp_socket_pair
  laddr = '127.0.0.1'

  lsock = ::UDPSocket.new
  lsock.bind( laddr, 0 )

  rsock = ::UDPSocket.new
  rsock.bind( laddr, 0 )

  rsock.connect( *lsock.addr.values_at(3,1) )

  lsock.connect( *rsock.addr.values_at(3,1) )

  return [lsock, rsock]
end

Instance Method Details

#fdObject

By default, all sockets are themselves selectable file descriptors.


699
700
701
# File 'lib/rex/socket.rb', line 699

def fd
  self
end

#getlocalnameObject

Wrapper around getsockname


713
714
715
# File 'lib/rex/socket.rb', line 713

def getlocalname
  getsockname
end

#getpeernameObject

Return peer connection information.


720
721
722
# File 'lib/rex/socket.rb', line 720

def getpeername
  return Socket.from_sockaddr(super)
end

#getsocknameObject

Returns local connection information.


706
707
708
# File 'lib/rex/socket.rb', line 706

def getsockname
  Socket.from_sockaddr(super)
end

#initsock(params = nil) ⇒ Object

Initialize general socket parameters.


685
686
687
688
689
690
691
692
693
694
# File 'lib/rex/socket.rb', line 685

def initsock(params = nil)
  if (params)
    self.peerhost  = params.peerhost
    self.peerport  = params.peerport
    self.localhost = params.localhost
    self.localport = params.localport
    self.context   = params.context || {}
    self.ipv       = params.v6 ? 6 : 4
  end
end

#type?Boolean

Returns a string that indicates the type of the socket, such as 'tcp'.


727
728
729
# File 'lib/rex/socket.rb', line 727

def type?
  raise NotImplementedError, "Socket type is not supported."
end