ronin-support 0.5.2 → 1.0.0.beta1

data/lib/ronin/support/network/public_suffix/list.rb

@@ -0,0 +1,339 @@
+# 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/public_suffix/suffix_set'
+require 'ronin/support/network/public_suffix/suffix'
+require 'ronin/support/network/exceptions'
+require 'ronin/support/home'
+
+require 'net/https'
+require 'fileutils'
+
+module Ronin
+  module Support
+    module Network
+      module PublicSuffix
+        #
+        # Represents the [public suffix list].
+        #
+        # [public suffix list]: https://publicsuffix.org/
+        #
+        # @api public
+        #
+        # @since 1.0.0
+        #
+        class List < SuffixSet
+
+          include Enumerable
+
+          # File name of the public suffix list.
+          FILE_NAME = 'public_suffix_list.dat'
+
+          # The `https://publicsuffix.org/list/public_suffix_list.dat` URL.
+          URL = "https://publicsuffix.org/list/#{FILE_NAME}"
+
+          # The path to `~/.cache/ronin/ronin-support/public_suffix_list.dat` list file.
+          PATH = File.join(Home::CACHE_DIR,'ronin','ronin-support',FILE_NAME)
+
+          # The path to the list file.
+          #
+          # @return [String]
+          attr_reader :path
+
+          # The tree of all public suffix TLDs.
+          #
+          # @return [Hash{String => Hash}]
+          attr_reader :tree
+
+          #
+          # Initializes the public suffix list.
+          #
+          # @param [String] path
+          #   The path to the list file.
+          #
+          # @api private
+          #
+          def initialize(path=PATH)
+            super()
+
+            @path = path
+            @tree = {}
+          end
+
+          #
+          # Determines whether the list file has been previously downloaded.
+          #
+          # @param [String] path
+          #   An optional alternate path to the list file.
+          #
+          # @return [Boolean]
+          #
+          def self.downloaded?(path=PATH)
+            File.file?(path)
+          end
+
+          # One day in seconds.
+          ONE_DAY = 60 * 60 * 24
+
+          #
+          # Determines if the downloaded list file is older than one day.
+          #
+          # @param [String] path
+          #   An optional alternate path to the list file.
+          #
+          # @return [Boolean]
+          #
+          def self.stale?(path=PATH)
+            !File.file?(path) || File.stat(path).mtime < (Time.now - ONE_DAY)
+          end
+
+          #
+          # Downloads the list file.
+          #
+          # @param [String] url
+          #   An optional alternate URL to download the `ip2asn-combined.tsv.gz`
+          #   file.
+          #
+          # @param [String] path
+          #   An optional alternate path to the list file.
+          #
+          def self.download(url: URL, path: PATH)
+            uri = URI(url)
+
+            Net::HTTP.start(uri.host,uri.port, use_ssl: true) do |http|
+              request  = Net::HTTP::Get.new(uri.path)
+
+              http.request(request) do |response|
+                FileUtils.mkdir_p(File.dirname(path))
+
+                File.open("#{path}.part",'wb') do |file|
+                  response.read_body do |chunk|
+                    file.write(chunk)
+                  end
+                end
+
+                FileUtils.mv("#{path}.part",path)
+              end
+            end
+          end
+
+          #
+          # Optionally update the cached list file if it is older than one day.
+          #
+          # @param [String] url
+          #   An optional alternate URL to download the `ip2asn-combined.tsv.gz`
+          #   file.
+          #
+          # @param [String] path
+          #   An optional alternate path to the list file.
+          #
+          def self.update(url: URL, path: PATH)
+            if !downloaded?(path)
+              download(url: url, path: path)
+            elsif stale?(path)
+              begin
+                download(url: url, path: path)
+              rescue
+              end
+            end
+          end
+
+          #
+          # Parses the contents of the list file.
+          #
+          # @param [String] path
+          #   An optional alternate path to the list file.
+          #
+          # @yield [suffix]
+          #   If a block is given, it will be passed each parsed suffix from the
+          #   list file.
+          #
+          # @yieldparam [Suffix] suffix
+          #   A parsed suffix in the list file.
+          #
+          # @return [Enumerator]
+          #   If no block is given, an Enumerator object will be returned.
+          #
+          def self.parse(path=PATH)
+            return enum_for(__method__,path) unless block_given?
+
+            type = nil
+
+            File.open(path) do |file|
+              file.each_line(chomp: true) do |line|
+                if line == '// ===BEGIN ICANN DOMAINS==='
+                  type = :icann
+                elsif line == '// ===BEGIN PRIVATE DOMAINS==='
+                  type = :private
+                elsif !(line.empty? || line.start_with?('//'))
+                  yield Suffix.new(line, type: type)
+                end
+              end
+            end
+          end
+
+          #
+          # Loads the public suffix list from the given file.
+          #
+          # @param [String] path
+          #   The path to the public suffix list file.
+          #
+          # @return [List]
+          #   The parsed public suffix list file.
+          #
+          def self.load_file(path=PATH)
+            list = new(path)
+
+            parse(path) do |suffix|
+              list << suffix
+            end
+
+            return list
+          end
+
+          #
+          # Adds a public suffix to the list.
+          #
+          # @param [Suffix] suffix
+          #   The suffix String to add.
+          #
+          # @return [self]
+          #
+          # @api private
+          #
+          def <<(suffix)
+            super(suffix)
+
+            if suffix.name.include?('.')
+              tree = @tree
+
+              suffix.name.split('.').reverse_each.each_cons(2) do |parent,child|
+                subtree = tree[parent] ||= {}
+                subtree[child] ||= nil
+
+                tree = subtree
+              end
+            else
+              @tree[suffix.name] ||= nil
+            end
+
+            return self
+          end
+
+          #
+          # Splits a hostname into it's name and public suffix components.
+          #
+          # @param [String] host_name
+          #   The host name to split.
+          #
+          # @return [(String, String)]
+          #   The host name's name and public suffix components.
+          #
+          # @raise [InvalidHostname]
+          #   The given hostname does not end with a valid suffix.
+          #
+          def split(host_name)
+            components = host_name.split('.')
+            suffixes   = []
+
+            tree = @tree
+
+            while tree
+              component = components.last
+
+              tld, subtree = tree.find do |tld,subtree|
+                tld == '*' || component == tld
+              end
+
+              suffixes.prepend(components.pop) if tld
+              tree = subtree
+            end
+
+            if suffixes.empty?
+              raise(InvalidHostname,"hostname does not have a valid suffix: #{host_name.inspect}")
+            end
+
+            return components.join('.'), suffixes.join('.')
+          end
+
+          #
+          # Creates a regular expression that can match every domain suffix in
+          # the list.
+          #
+          # @return [Regexp]
+          #
+          def to_regexp
+            regexp = Regexp.union(@tree.map { |tld,subtree|
+              tld_regexp(tld,subtree)
+            })
+
+            return /(?<=[^a-zA-Z0-9_-]|^)#{regexp}(?=[^\.a-z0-9-]|$)/
+          end
+
+          #
+          # Inspects the public suffix list.
+          #
+          # @return [String]
+          #   The inspected list object.
+          #
+          def inspect
+            "#<#{self.class}: #{@path}>"
+          end
+
+          private
+
+          #
+          # Create a regexp to match the given Top-Level-Domain (TLD) and all
+          # sub-TLDs below it.
+          #
+          # @param [String] tld
+          #   The Top-Level-Domain (TLD).
+          #
+          # @param [Hash{String => Hash}] subtree
+          #   The other TLDs below the given TLD.
+          #
+          # @return [Regexp]
+          #   The compiled regular expression.
+          #
+          def tld_regexp(tld,subtree)
+            if subtree
+              subtree_regexp = if subtree.length == 1
+                                  tld_regexp(subtree.keys[0],subtree.values[0])
+                                else
+                                  Regexp.union(
+                                    subtree.map { |sub_tld,sub_subtree|
+                                      tld_regexp(sub_tld,sub_subtree)
+                                    }
+                                  )
+                                end
+
+              /(?:#{subtree_regexp}\.)?#{tld}/
+            else
+              if tld == '*'
+                /[a-z0-9]+(?:-[a-z0-9]+)*/
+              else
+                tld
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/network/public_suffix/suffix.rb

@@ -0,0 +1,118 @@
+# 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 PublicSuffix
+        #
+        # Represents a suffix from the public suffix list.
+        #
+        # @api private
+        #
+        class Suffix
+
+          # The suffix name.
+          #
+          # @return [String]
+          attr_reader :name
+
+          # The suffix type.
+          #
+          # @return [:icann, :private]
+          attr_reader :type
+
+          #
+          # Initializes the suffix.
+          #
+          # @param [String] name
+          #
+          # @param [:icann, :private] type
+          #   Indictages whether the suffix is an official ICANN domain or a
+          #   private domain suffix.
+          #
+          def initialize(name, type: :icann)
+            @name = name
+            @type = type
+          end
+
+          #
+          # Indicates whether the suffix is an ICANN domain.
+          #
+          # @return [Boolean]
+          #
+          def icann?
+            @type == :icann
+          end
+
+          #
+          # Indicates whether the suffix is a private domain.
+          #
+          # @return [Boolean]
+          #
+          def private?
+            @type == :private
+          end
+
+          #
+          # Determines if the suffix contians a `*` wildcard.
+          #
+          # @return [Boolean]
+          #
+          def wildcard?
+            @name.include?('*')
+          end
+
+          #
+          # Determines if the suffix does not contain a `*` wildcard.
+          #
+          # @return [Boolean]
+          #
+          def non_wildcard?
+            !wildcard?
+          end
+
+          #
+          # Compares the suffix to another object.
+          #
+          # @param [Object] other
+          #   The other object to compare to.
+          #
+          # @return [Boolean]
+          #
+          def ==(other)
+            self.class == other.class &&
+              @name == other.name &&
+              @type == other.type
+          end
+
+          #
+          # Converts the suffix to a String.
+          #
+          # @return [String]
+          #   The suffix name.
+          #
+          def to_s
+            @name
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/network/public_suffix/suffix_set.rb

@@ -0,0 +1,150 @@
+# 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 PublicSuffix
+        class SuffixSet
+
+          include Enumerable
+
+          # The suffixes in the suffix set.
+          #
+          # @return [Array<Suffix>, Enumerator::Lazy<Suffix>]
+          attr_reader :suffixes
+
+          #
+          # Initializes the suffix-set.
+          #
+          # @param [Enumerator::Lazy<Suffix>] suffixes
+          #   The optional suffixes to initialize the suffix set with.
+          #
+          # @api private
+          #
+          def initialize(suffixes=[])
+            @suffixes = suffixes
+          end
+
+          #
+          # Adds a public suffix to the suffix-set.
+          #
+          # @param [Suffix] suffix
+          #   The suffix String to add.
+          #
+          # @return [self]
+          #
+          # @api private
+          #
+          def <<(suffix)
+            @suffixes << suffix
+            return self
+          end
+
+          #
+          # Enumerates over each suffix within the suffix-set.
+          #
+          # @yield [suffix]
+          #   If a block is given, it will be passed each suffix in the list.
+          #
+          # @yieldparam [Suffix] suffix
+          #   A domain suffix in the list.
+          #
+          # @return [Enumerator]
+          #   If no block is given, an Enumerator object will be returned.
+          #
+          def each(&block)
+            @suffixes.each(&block)
+          end
+
+          #
+          # Selects all suffixes with the matching type.
+          #
+          # @param [:icann, :private] type
+          #   The type to filter by.
+          #
+          # @return [SuffixSet]
+          #   The new sub-set of suffixes.
+          #
+          def type(type)
+            SuffixSet.new(lazy.select { |suffix| suffix.type == type })
+          end
+
+          #
+          # Selects all ICANN suffixes.
+          #
+          # @return [SuffixSet]
+          #   The new sub-set of suffixes.
+          #
+          def icann
+            SuffixSet.new(lazy.select(&:icann?))
+          end
+
+          #
+          # Selects all private suffixes.
+          #
+          # @return [SuffixSet]
+          #   The new sub-set of suffixes.
+          #
+          def private
+            SuffixSet.new(lazy.select(&:private?))
+          end
+
+          #
+          # Selects all wildcard suffixes.
+          #
+          # @return [SuffixSet]
+          #   The new sub-set of suffixes.
+          #
+          def wildcards
+            SuffixSet.new(lazy.select(&:wildcard?))
+          end
+
+          #
+          # Selects all non-wildcard suffixes.
+          #
+          # @return [SuffixSet]
+          #   The new sub-set of suffixes.
+          #
+          def non_wildcards
+            SuffixSet.new(lazy.select(&:non_wildcard?))
+          end
+
+          #
+          # The number of suffixes within the suffix-set.
+          #
+          # @return [Integer]
+          #
+          def length
+            @suffixes.length
+          end
+
+          #
+          # Converts the suffix-set to an Array of suffixes.
+          #
+          # @return [Array<Suffix>]
+          #
+          def to_a
+            @suffixes.to_a
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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/public_suffix/list'
+
+module Ronin
+  module Support
+    module Network
+      module PublicSuffix
+        #
+        # Downloads/updates then loads the cached file
+        # (`~/.cache/ronin/ronin-support/public_suffix_list.dat`).
+        #
+        # @return [List]
+        #   The loaded list file.
+        #
+        def self.list
+          @list ||= (
+            List.update
+            List.load_file
+          )
+        end
+      end
+    end
+  end
+end