ronin-support 0.5.2 → 1.0.0.beta1

data/lib/ronin/support/network/asn/record.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Support
+    module Network
+      module ASN
+        class Record
+
+          # The ASN number.
+          #
+          # @return [Integer]
+          attr_reader :number
+
+          # The IP range of the ASN record.
+          #
+          # @return [IPRange::CIDR, IPRange::Range]
+          attr_reader :range
+
+          # The country code of the ASN record.
+          #
+          # @return [String, nil]
+          attr_reader :country_code
+
+          # The name of the ASN record.
+          #
+          # @return [String, nil]
+          attr_reader :name
+
+          #
+          # Initializes the record.
+          #
+          # @param [Integer] number
+          #   The ASN number.
+          #
+          # @param [IPRange::CIDR, IPRange::Range] range
+          #   The IP range of the ASN record.
+          #
+          # @param [String, nil] country_code
+          #   The country code of the ASN record.
+          #
+          # @param [String] name
+          #   The name of the ASN record.
+          #
+          def initialize(number,range,country_code,name)
+            @number       = number
+            @range        = range
+            @country_code = country_code
+            @name         = name
+          end
+
+          alias to_i number
+
+          #
+          # Determines if the ASN is routed.
+          #
+          # @return [Boolean]
+          #
+          def routed?
+            @number != 0
+          end
+
+          #
+          # Determines if the ASN is not routed.
+          #
+          # @return [Boolean]
+          #
+          def not_routed?
+            @number == 0
+          end
+
+          #
+          # Determines if the ASN record has an IPv4 IP range.
+          #
+          # @return [Boolean]
+          #
+          def ipv4?
+            @range.ipv4?
+          end
+
+          #
+          # Determines if the ASN record has an IPv6 IP range.
+          #
+          # @return [Boolean]
+          #
+          def ipv6?
+            @range.ipv6?
+          end
+
+          #
+          # Determines if the IP belongs to the ASN range.
+          #
+          # @param [IPAddr, String] ip
+          #
+          # @return [Boolean]
+          #
+          def include?(ip)
+            @range.include?(ip)
+          end
+
+          #
+          # Enumerates over every IP within the ASN range.
+          #
+          # @yield [ip]
+          #
+          # @yieldparam [IP] ip
+          #
+          # @return [Enumerator]
+          #
+          def each(&block)
+            @range.each(&block)
+          end
+
+          #
+          # Compares the record to another object.
+          #
+          # @param [Object] other
+          #   The other object to compare to.
+          #
+          # @return [Boolean]
+          #
+          def ==(other)
+            self.class == other.class &&
+              @number       == other.number &&
+              @range        == other.range &&
+              @country_code == other.country_code &&
+              @name         == other.name
+          end
+
+          #
+          # Converts the record into a humanly readable String.
+          #
+          # @return [String]
+          #   The String including the {#range}, {#number}, {#country_code},
+          #   and {#name}.
+          #
+          def to_s
+            if routed?
+              "#{range} AS#{number} (#{country_code}) #{name}"
+            else
+              "#{range} Not routed"
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/network/asn/record_set.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'set'
+
+module Ronin
+  module Support
+    module Network
+      module ASN
+        class RecordSet
+
+          include Enumerable
+
+          # The records in the record set.
+          #
+          # @return [Array<Record>, Enumerator::Lazy<Record>]
+          attr_reader :records
+
+          #
+          # Initializes the record-set.
+          #
+          # @param [Enumerator::Lazy<Record>] records
+          #   The optional records to initialize the record set with.
+          #
+          # @api private
+          #
+          def initialize(records=[])
+            @records = records
+          end
+
+          #
+          # Adds a record to the record-set.
+          #
+          # @param [Record] record
+          #
+          # @return [self]
+          #
+          # @api private
+          #
+          def <<(record)
+            @records << record
+            return self
+          end
+
+          #
+          # Enumerates over each IP within all of the records.
+          #
+          # @yield [record]
+          #
+          # @yieldparam [Record] record
+          #
+          # @return [Enumerator]
+          #
+          def each(&block)
+            @records.each(&block)
+          end
+
+          #
+          # Returns all AS numbers within the record set.
+          #
+          # @return [Set<Integer>]
+          #
+          def numbers
+            set = Set.new
+            each { |record| set << record.number }
+            set
+          end
+
+          #
+          # Selects all records with the matching AS number.
+          #
+          # @param [Integer] number
+          #   The AS number.
+          #
+          # @return [RecordSet]
+          #   The new sub-set of records.
+          #
+          def number(number)
+            RecordSet.new(
+              lazy.select { |record| record.number == number }
+            )
+          end
+
+          #
+          # Retruns all country codes within the record set.
+          #
+          # @return [Set<String>]
+          #
+          def countries
+            set = Set.new
+            each { |record| set << record.country_code }
+            set
+          end
+
+          #
+          # Selects all records with the matching country code.
+          #
+          # @param [String] country_code
+          #   The two-letter country code.
+          #
+          # @return [RecordSet]
+          #   The new sub-set of records.
+          #
+          def country(country_code)
+            RecordSet.new(
+              lazy.select { |record| record.country_code == country_code }
+            )
+          end
+
+          #
+          # Returns all IP ranges within the record set.
+          #
+          # @return [Array<IPRange::Range>]
+          #
+          def ranges
+            map(&:range)
+          end
+
+          #
+          # Selects only the records with IPv4 ranges.
+          #
+          # @return [RecordSet]
+          #   The new sub-set of records.
+          #
+          def ipv4
+            RecordSet.new(lazy.select(&:ipv4?))
+          end
+
+          #
+          # Selects only the records with IPv6 ranges.
+          #
+          # @return [RecordSet]
+          #   The new sub-set of records.
+          #
+          def ipv6
+            RecordSet.new(lazy.select(&:ipv6?))
+          end
+
+          #
+          # Finds the ASN record for the given IP address.
+          #
+          # @param [IP, IPaddr, String] ip
+          #   The IP address to search for.
+          #
+          # @return [Record, nil]
+          #   The ASN record for the IP address or `nil` if none could be found.
+          #
+          def ip(ip)
+            find { |record| record.range.include?(ip) }
+          end
+
+          #
+          # Determines if the IP belongs to any of the records.
+          #
+          # @param [IPAddr, String] ip
+          #
+          # @return [Boolean]
+          #
+          def include?(ip)
+            !ip(ip).nil?
+          end
+
+          #
+          # Returns all company names within the record-set.
+          #
+          # @return [Set<String>]
+          #
+          def names
+            set = Set.new
+            each { |record| set << record.name }
+            set
+          end
+
+          #
+          # Selects all records with the matching company name.
+          #
+          # @param [String] name
+          #   The company name to search for.
+          #
+          # @return [RecordSet]
+          #   The new sub-set of records.
+          #
+          def name(name)
+            RecordSet.new(
+              lazy.select { |record| record.name == name }
+            )
+          end
+
+          #
+          # The number of records within the record-set.
+          #
+          # @return [Integer]
+          #
+          def length
+            @records.length
+          end
+
+          #
+          # Converts the record-set to an Array of records.
+          #
+          # @return [Array<Range>]
+          #
+          def to_a
+            @records.to_a
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/network/asn.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/network/dns'
+require 'ronin/support/network/ip_range/cidr'
+require 'ronin/support/network/asn/dns_record'
+require 'ronin/support/network/asn/list'
+
+module Ronin
+  module Support
+    module Network
+      #
+      # Handles Autonomous System Numbers (ASN).
+      #
+      # @api public
+      #
+      # @since 1.0.0
+      #
+      module ASN
+        #
+        # Queries the ASN information for the given IP.
+        #
+        # @param [IP, IPAddr, String] ip
+        #   The IP address to query.
+        #
+        # @return [Record, nil]
+        #   The ASN record or `nil` if the IP address is not routed.
+        #
+        # @note
+        #   Performs rDNS queries using `*.nmap.asn.cymru.com` for IPv4
+        #   addresses and `*.nmap6.asn.cymru.com` for IPv6 addresses.
+        #
+        def self.query(ip)
+          ip = IPAddr.new(ip) unless ip.kind_of?(IPAddr)
+
+          if ip.ipv6?
+            zone   = 'nmap6.asn.cymru.com'
+            suffix = 'ip6.arpa'
+          else
+            zone   = 'nmap.asn.cymru.com'
+            suffix = 'in-addr.arpa'
+          end
+
+          name = ip.reverse.sub(suffix,zone)
+
+          unless (string = DNS.get_txt_string(name))
+            return nil
+          end
+
+          asn, cidr_range, country_code, *rest = string.split(' | ',5)
+          asn = asn.to_i
+          cidr_range = IPRange::CIDR.new(cidr_range)
+
+          return DNSRecord.new(asn,cidr_range,country_code)
+        end
+
+        #
+        # Downloads/updates then loads the cached file
+        # (`~/.local/share/ronin/ronin-support/ip2asn-combined.tsv.gz`).
+        #
+        # @return [List]
+        #   The loaded list file.
+        #
+        def self.list
+          @list ||= (
+            List.update
+            List.load_file
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ronin/{binary/hexdump.rb → support/network/core_ext.rb}

@@ -1,7 +1,6 @@
+# frozen_string_literal: true
 #
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -17,4 +16,4 @@
 # along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/binary/hexdump/parser'
+require 'ronin/support/network/http/core_ext'

data/lib/ronin/support/network/dns/idn.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'addressable/idna'
+
+module Ronin
+  module Support
+    module Network
+      module DNS
+        #
+        # Supports [International Domain Names (IDN)][IDN].
+        #
+        # [IDN]: https://en.wikipedia.org/wiki/Internationalized_domain_name
+        #
+        # @api public
+        #
+        # @since 1.0.0
+        #
+        IDN = Addressable::IDNA
+      end
+    end
+  end
+end