Class: Ronin::Support::Network::IP

Inherits:
IPAddr
  • Object
show all
Defined in:
lib/ronin/support/network/ip.rb,
lib/ronin/support/network/ip/mixin.rb

Overview

Represents a single IP address.

Examples

ip = IP.new('192.30.255.113')

Reverse DNS lookup:

ip.get_name
# => "lb-192-30-255-113-sea.github.com"
ip.get_names
# => ["lb-192-30-255-113-sea.github.com"]
ip.get_host
# => #<Ronin::Support::Network::Host: lb-192-30-255-113-sea.github.com>
ip.get_hosts
# => [#<Ronin::Support::Network::Host: lb-192-30-255-113-sea.github.com>]
ip.host
# => #<Ronin::Support::Network::Host: lb-192-30-255-113-sea.github.com>
ip.hosts
# => [#<Ronin::Support::Network::Host: lb-192-30-255-113-sea.github.com>]

Get ASN information:

ip.asn
# => #<Ronin::Support::Network::ASN::DNSRecord:0x00007f34142de598
#     @country_code="US",
#     @name=nil,
#     @number=15133,
#     @range=#<Ronin::Support::Network::IPRange::CIDR: 93.184.216.0/24>>

Since:

  • 1.0.0

Defined Under Namespace

Modules: Mixin

Constant Summary collapse

IPINFO_URI =

The URI for https://ipinfo.io/ip

Since:

  • 1.0.0

URI::HTTPS.build(host: 'ipinfo.io', path: '/ip')

Constants inherited from IPAddr

IPAddr::MASKS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from IPAddr

#each

Methods included from Enumerable

#map_hash

Constructor Details

#initialize(address, family = Socket::AF_UNSPEC) ⇒ IP

Note:

If the IP address has an %iface suffix, it will be removed from the IP address.

Initializes the IP address.

Examples:

ip = IP.new('192.30.255.113')

Parameters:

  • address (String) —

    The address of the IP.

  • family (Integer) (defaults to: Socket::AF_UNSPEC) —

    The address family for the CIDR range. This is mainly for backwards compatibility with IPAddr#initialize.

Raises:

  • (InvalidIP) —

    The given address is not a valid IP address.

Since:

  • 1.0.0



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ronin/support/network/ip.rb', line 94

def initialize(address,family=Socket::AF_UNSPEC)
  # XXX: remove the %iface suffix for ruby < 3.1.0
  if address.kind_of?(String) && address =~ /%.+$/
    address = address.sub(/%.+$/,'')
  end

  begin
    super(address,family)
  rescue IPAddr::InvalidAddressError
    raise(InvalidIP,"invalid IP address: #{address.inspect}")
  end

  @address = case address
             when String then address.to_s
             else             to_s
             end
end

Instance Attribute Details

#address ⇒ String (readonly)

The address of the IP.

Returns:

Since:

  • 1.0.0



72
73
74
 
# File 'lib/ronin/support/network/ip.rb', line 72

def address
  @address
end

Class Method Details

.extract(text, version = nil) {|ip| ... } ⇒ Array<String>

Extracts IP Addresses from text.

Examples:

IPAddr.extract("Host: 127.0.0.1\n\rHost: 10.1.1.1\n\r")
# => ["127.0.0.1", "10.1.1.1"]

Extract only IPv4 addresses from a large amount of text:

IPAddr.extract(text,:v4) do |ip|
  puts ip
end

Parameters:

  • text (String) —

    The text to scan for IP Addresses.

  • version (4, :v4, :ipv4, 6, :v6, :ipv6) (defaults to: nil) —

    The version of IP Address to extract.

Yields:

  • (ip) —

    The given block will be passed each extracted IP Address.

Yield Parameters:

  • ip (String) —

    An IP Address from the text.

Returns:

  • (Array<String>) —

    The IP Addresses found in the text.

Since:

  • 1.0.0



235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/ronin/support/network/ip.rb', line 235

def self.extract(text,version=nil,&block)
  return enum_for(__method__,text,version).to_a unless block_given?

  regexp = case version
           when :ipv4, :v4, 4 then Text::Patterns::IPV4_ADDR
           when :ipv6, :v6, 6 then Text::Patterns::IPV6_ADDR
           else                    Text::Patterns::IP_ADDR
           end

  text.scan(regexp,&block)
  return nil
end

.local_address ⇒ String

Determines the local IP address.

Examples:

IP.local_address
# => "127.0.0.1"

Returns:

Since:

  • 1.0.0



191
192
193
 
# File 'lib/ronin/support/network/ip.rb', line 191

def self.local_address
  Socket.ip_address_list.first.ip_address
end

.local_addresses ⇒ Array<String>

Determines all local IP addresses.

Examples:

IP.local_addresses
# => ["127.0.0.1", "192.168.1.42", "::1", "fe80::4ba:612f:9e2:37e2"]

Returns:

Since:

  • 1.0.0



154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/ronin/support/network/ip.rb', line 154

def self.local_addresses
  Socket.ip_address_list.map do |addrinfo|
    address = addrinfo.ip_address

    if address =~ /%.+$/
      address = address.sub(/%.+$/,'')
    end

    address
  end
end

.local_ip ⇒ IP

Determines the local IP.

Examples:

IP.local_ip
# => #<Ronin::Support::Network::IP: 127.0.0.1>

Returns:

Since:

  • 1.0.0



204
205
206
 
# File 'lib/ronin/support/network/ip.rb', line 204

def self.local_ip
  new(local_address)
end

.local_ips ⇒ Array<IP>

Determines all local IPs.

Examples:

IP.local_ips
# => [#<Ronin::Support::Network::IP: 127.0.0.1>,
      #<Ronin::Support::Network::IP: 192.168.1.42>,
      #<Ronin::Support::Network::IP: ::1>,
      #<Ronin::Support::Network::IP: fe80::04ba:612f:09e2:37e2>]

Returns:

Since:

  • 1.0.0



178
179
180
 
# File 'lib/ronin/support/network/ip.rb', line 178

def self.local_ips
  local_addresses.map(&method(:new))
end

.public_address ⇒ String?

Determines the current public IP address.

Returns:

Since:

  • 1.0.0



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/ronin/support/network/ip.rb', line 121

def self.public_address
  response = begin
               Net::HTTP.get_response(IPINFO_URI)
             rescue
               # ignore any network failures
             end

  if response && response.code == '200'
    return response.body
  end
end

.public_ip ⇒ IP?

Determines the current public IP.

Returns:

Since:

  • 1.0.0



139
140
141
142
143
 
# File 'lib/ronin/support/network/ip.rb', line 139

def self.public_ip
  if (address = public_address)
    new(address)
  end
end

Instance Method Details

#asn ⇒ ASN::Record

The Autonomous System Number (ASN) information for the IP address.

Examples:

ip = IP.new('93.184.216.34')
ip.asn
# => #<Ronin::Support::Network::ASN::DNSRecord:0x00007f34142de598
      @country_code="US",
      @name=nil,
      @number=15133,
      @range=#<Ronin::Support::Network::IPRange::CIDR: 93.184.216.0/24>>

Returns:

Since:

  • 1.0.0



303
304
305
 
# File 'lib/ronin/support/network/ip.rb', line 303

def asn
  @asn ||= ASN.query(self)
end

#broadcast? ⇒ Boolean

Determines if the address is a IPv4 broadcast addresses.

Examples:

ip = IPAddr.new('255.255.255.255')
ip.broadcast?
# => true
ip = IPAddr.new('192.168.1.255')
ip.broadcast?
# => true
ip = IPAddr.new('1.1.1.1')
ip.broadcast?
# => false

Returns:

  • (Boolean)

Since:

  • 1.0.0



264
265
266
267
 
# File 'lib/ronin/support/network/ip.rb', line 264

def broadcast?
  # NOTE: IPv6 does not have broadcast addresses
  ipv4? && (@addr & 0xff) == 0xff
end

#get_host(**kwargs) ⇒ Host?

Looks up the host for the IP.

Examples:

ip = IP.new('192.30.255.113')
ip.get_host
# => #<Ronin::Support::Network::Host: lb-192-30-255-113-sea.github.com>

Parameters:

  • kwargs (Hash{Symbol => Object}) —

    Additional keyword arguments.

  • [Array<String>, (Hash) —

    a customizable set of options

  • [String, (Hash) —

    a customizable set of options

Returns:

  • (Host, nil) —

    The host for the IP.

Since:

  • 1.0.0



377
378
379
380
381
 
# File 'lib/ronin/support/network/ip.rb', line 377

def get_host(**kwargs)
  if (name = get_name(**kwargs))
    Host.new(name)
  end
end

#get_hosts(**kwargs) ⇒ Array<Host>

Looks up all hosts associated with the IP.

Examples:

ip = IP.new('192.30.255.113')
ip.get_hosts
# => [#<Ronin::Support::Network::Host: lb-192-30-255-113-sea.github.com>]

Parameters:

  • kwargs (Hash{Symbol => Object}) —

    Additional keyword arguments.

  • [Array<String>, (Hash) —

    a customizable set of options

  • [String, (Hash) —

    a customizable set of options

Returns:

Since:

  • 1.0.0



403
404
405
 
# File 'lib/ronin/support/network/ip.rb', line 403

def get_hosts(**kwargs)
  get_names(**kwargs).map { |name| Host.new(name) }
end

#get_name(**kwargs) ⇒ String? Also known as: reverse_lookup

Looks up the hostname of the address.

Examples:

ip = IP.new('192.30.255.113')
ip.get_name
# => "lb-192-30-255-113-sea.github.com"

Parameters:

  • kwargs (Hash{Symbol => Object}) —

    Additional keyword arguments.

  • [Array<String>, (Hash) —

    a customizable set of options

  • [String, (Hash) —

    a customizable set of options

Returns:

  • (String, nil) —

    The hostname of the address.

Since:

  • 1.0.0



327
328
329
 
# File 'lib/ronin/support/network/ip.rb', line 327

def get_name(**kwargs)
  DNS.get_name(@address,**kwargs)
end

#get_names(**kwargs) ⇒ Array<String>

Looks up all hostnames associated with the IP.

Examples:

ip = IP.new('192.30.255.113')
ip.get_names
# => ["lb-192-30-255-113-sea.github.com"]

Parameters:

  • kwargs (Hash{Symbol => Object}) —

    Additional keyword arguments.

  • [Array<String>, (Hash) —

    a customizable set of options

  • [String, (Hash) —

    a customizable set of options

Returns:

Since:

  • 1.0.0



353
354
355
 
# File 'lib/ronin/support/network/ip.rb', line 353

def get_names(**kwargs)
  DNS.get_names(@address,**kwargs)
end

#get_ptr_name(**kwargs) ⇒ String?

Queries the PTR host name for the IP address.

Parameters:

  • kwargs (Hash{Symbol => Object}) —

    Additional keyword arguments.

  • [Array<String>, (Hash) —

    a customizable set of options

  • [String, (Hash) —

    a customizable set of options

Returns:

  • (String, nil) —

    The host name that points to the given IP.

Since:

  • 1.0.0



477
478
479
 
# File 'lib/ronin/support/network/ip.rb', line 477

def get_ptr_name(**kwargs)
  DNS.get_ptr_name(@address,**kwargs)
end

#get_ptr_names(**kwargs) ⇒ Array<String>

Queries all PTR names for the IP address.

Parameters:

  • kwargs (Hash{Symbol => Object}) —

    Additional keyword arguments.

  • [Array<String>, (Hash) —

    a customizable set of options

  • [String, (Hash) —

    a customizable set of options

Returns:

Since:

  • 1.0.0



517
518
519
 
# File 'lib/ronin/support/network/ip.rb', line 517

def get_ptr_names(**kwargs)
  DNS.get_ptr_names(@address,**kwargs)
end

#get_ptr_record(**kwargs) ⇒ Resolv::DNS::Resource::PTR?

Queries the first PTR DNS record for the IP address.

Parameters:

  • kwargs (Hash{Symbol => Object}) —

    Additional keyword arguments.

  • [Array<String>, (Hash) —

    a customizable set of options

  • [String, (Hash) —

    a customizable set of options

Returns:

  • (Resolv::DNS::Resource::PTR, nil) —

    The first PTR DNS record of the host name or nil if the host name has no PTR records.

See Also:

Since:

  • 1.0.0



458
459
460
 
# File 'lib/ronin/support/network/ip.rb', line 458

def get_ptr_record(**kwargs)
  DNS.get_ptr_record(@address,**kwargs)
end

#get_ptr_records(**kwargs) ⇒ Array<Resolv::DNS::Resource::PTR>

Queries all PTR DNS records for the IP address.

Parameters:

  • kwargs (Hash{Symbol => Object}) —

    Additional keyword arguments.

  • [Array<String>, (Hash) —

    a customizable set of options

  • [String, (Hash) —

    a customizable set of options

Returns:

  • (Array<Resolv::DNS::Resource::PTR>) —

    All PTR DNS records for the given IP.

See Also:

Since:

  • 1.0.0



498
499
500
 
# File 'lib/ronin/support/network/ip.rb', line 498

def get_ptr_records(**kwargs)
  DNS.get_ptr_records(@address,**kwargs)
end

#host ⇒ Host?

The primary host name of the address.

Examples:

ip = IP.new('192.30.255.113')
ip.host
# => #<Ronin::Support::Network::Host: lb-192-30-255-113-sea.github.com>

Returns:

  • (Host, nil) —

    The host name or nil if the IP address has no host names.

Since:

  • 1.0.0



436
437
438
 
# File 'lib/ronin/support/network/ip.rb', line 436

def host
  hosts.first
end

#hosts ⇒ Array<Host>

Note:

This method returns memoized data.

The host names of the address.

Examples:

ip = IP.new('192.30.255.113')
ip.hosts
# => [#<Ronin::Support::Network::Host: lb-192-30-255-113-sea.github.com>]

Returns:

  • (Array<Host>) —

    The host names of the address or an empty Array if the IP address has no host names.

Since:

  • 1.0.0



421
422
423
 
# File 'lib/ronin/support/network/ip.rb', line 421

def hosts
  @hosts ||= get_hosts
end

#inspect ⇒ String

Inspects the IP.

Returns:

  • (String) —

    The inspected IP object.

Since:

  • 1.0.0



531
532
533
 
# File 'lib/ronin/support/network/ip.rb', line 531

def inspect
  "#<#{self.class}: #{@address}>"
end

#logical? ⇒ Boolean

Determines if the address is a "logical" IPv4 address.

Examples:

ip = IPAddr.new('0.0.0.0')
ip.logical?
# => true
ip = IPAddr.new('192.168.1.0')
ip.logical?
# => true
ip = IPAddr.new('1.1.1.1')
ip.logical?
# => false

Returns:

  • (Boolean)

Since:

  • 1.0.0



285
286
287
 
# File 'lib/ronin/support/network/ip.rb', line 285

def logical?
  ipv4? && (@addr & 0xff) == 0x00
end