ronin-support 1.0.7 → 1.1.0.rc1

data/lib/ronin/support/network/ip_range/cidr.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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
@@ -43,6 +43,49 @@ module Ronin
 
           include Enumerable
 
+          ipv4_octet = /(?:\d{1,2}|1\d{2}|2[1-4]\d|25[0-5])/
+          ipv4_addr  = /#{ipv4_octet}(?:\.#{ipv4_octet}){3}/
+
+          # Regular expression that matches IPv4 CIDR ranges.
+          #
+          # @api private
+          #
+          # @since 1.1.0
+          IPV4_REGEX = %r{\A#{ipv4_addr}(?:/(?:\d|[12]\d|3[0-2]))?\z}
+
+          # Regular expression that matches IPv6 CIDR ranges.
+          #
+          # @api private
+          #
+          # @since 1.1.0
+          IPV6_REGEX = %r{\A(?:
+            (?:[0-9a-fA-F]{1,4}:){6}#{ipv4_addr}|
+            (?:[0-9a-fA-F]{1,4}:){5}[0-9a-fA-F]{1,4}:#{ipv4_addr}|
+            (?:[0-9a-fA-F]{1,4}:){5}:[0-9a-fA-F]{1,4}:#{ipv4_addr}|
+            (?:[0-9a-fA-F]{1,4}:){1,1}(?::[0-9a-fA-F]{1,4}){1,4}:#{ipv4_addr}|
+            (?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,3}:#{ipv4_addr}|
+            (?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,2}:#{ipv4_addr}|
+            (?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,1}:#{ipv4_addr}|
+            :(?::[0-9a-fA-F]{1,4}){1,5}:#{ipv4_addr}|
+            (?:(?:[0-9a-fA-F]{1,4}:){1,5}|:):#{ipv4_addr}|
+            (?:[0-9a-fA-F]{1,4}:){1,1}(?::[0-9a-fA-F]{1,4}){1,6}|
+            (?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|
+            (?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|
+            (?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|
+            (?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|
+            (?:[0-9a-fA-F]{1,4}:){1,6}(?::[0-9a-fA-F]{1,4}){1,1}|
+            [0-9a-fA-F]{1,4}(?::[0-9a-fA-F]{1,4}){7}|
+            :(?::[0-9a-fA-F]{1,4}){1,7}|
+            (?:(?:[0-9a-fA-F]{1,4}:){1,7}|:):
+          )(?:/(?:\d{1,2}|1[0-1]\d+|12[0-8]))?\z}x
+
+          # Regular expression to match IP-glob ranges.
+          #
+          # @api private
+          #
+          # @since 1.1.0
+          REGEX = /#{IPV4_REGEX}|#{IPV6_REGEX}/
+
           # The CIDR IP range string.
           #
           # @return [String]
@@ -58,12 +101,21 @@ module Ronin
           #   The address family for the CIDR range. This is mainly for
           #   backwards compatibility with `IPAddr#initialize`.
           #
+          # @raise [ArgumentError]
+          #   The CIDR range string was not a valid IPv4 or IPv6 CIDR range.
+          #
           def initialize(string,family=Socket::AF_UNSPEC)
+            unless (string =~ IPV4_REGEX || string =~ IPV6_REGEX)
+              raise(ArgumentError,"invalid CIDR range: #{string.inspect}")
+            end
+
             super(string,family)
 
             @string = string
           end
 
+          alias prefix_address to_string
+
           #
           # Alias for {#initialize new}.
           #
@@ -160,6 +212,65 @@ module Ronin
             new(string).each(&block)
           end
 
+          #
+          # Determines if the given IP belongs to the IP CIDR range.
+          #
+          # @param [IP, IPAddr, String] ip
+          #   The IP to test.
+          #
+          # @return [Boolean]
+          #   Specifies whether the IP is or is not within the IP CIDR range.
+          #
+          # @since 1.1.0
+          #
+          def include?(ip)
+            ip = IPAddr.new(ip) unless ip.kind_of?(IPAddr)
+
+            family_mask = MASKS[@family]
+            start_addr  = @addr
+            end_addr    = @addr | (~@mask_addr & family_mask)
+            ip_addr     = ip.to_i
+
+            return (ip_addr >= start_addr) && (ip_addr <= end_addr)
+          end
+
+          #
+          # Compares the CIDR range to another IP range.
+          #
+          # @param [Object] other
+          #   The other IP range.
+          #
+          # @return [Boolean]
+          #
+          # @since 1.1.0
+          #
+          def ==(other)
+            other.kind_of?(self.class) &&
+              family == other.family &&
+              to_i   == other.to_i
+          end
+
+          #
+          # Determines if the given IP range is a sub-set of the IP CIDR range.
+          #
+          # @param [CIDR, Glob, Enumerable<String>] other
+          #   The other IP range.
+          #
+          # @return [Boolean]
+          #
+          # @since 1.1.0
+          #
+          def ===(other)
+            case other
+            when CIDR
+              include?(other.first) && include?(other.last)
+            when Enumerable
+              other.all? { |ip| include?(ip) }
+            else
+              false
+            end
+          end
+
           #
           # Iterates over each IP address that is included in the addresses
           # netmask. Supports both IPv4 and IPv6 addresses.
@@ -212,6 +323,17 @@ module Ronin
             _to_string(@addr | ~@mask_addr)
           end
 
+          #
+          # Calculates the size of the CIDR range.
+          #
+          # @return [Integer]
+          #
+          # @since 1.1.0
+          #
+          def size
+            2**(SIZES.fetch(family) - prefix)
+          end
+
           #
           # Converts the CIDR range back into a String.
           #

data/lib/ronin/support/network/ip_range/glob.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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
@@ -55,6 +55,55 @@ module Ronin
 
           include Enumerable
 
+          ipv4_octet       = /(?:\d{1,2}|1\d{2}|2[1-4]\d|25[0-5])/
+          ipv4_octet_range = /#{ipv4_octet}(?:-#{ipv4_octet})?/
+          ipv4_octet_list  = /(?:#{ipv4_octet_range}(?:,#{ipv4_octet_range})*|\*)/
+          ipv4_addr        = /#{ipv4_octet_list}(?:\.#{ipv4_octet_list}){3}/
+
+          # Regular expression that matches IPv4-glob ranges.
+          #
+          # @api private
+          #
+          # @since 1.1.0
+          IPV4_REGEX = /\A#{ipv4_addr}\z/
+
+          ipv6_octet       = /[0-9a-fA-F]{1,4}/
+          ipv6_octet_range = /#{ipv6_octet}(?:-#{ipv6_octet})?/
+          ipv6_octet_list  = /(?:#{ipv6_octet_range}(?:,#{ipv6_octet_range})*|\*)/
+
+          # Regular expression that matches IPv6-glob ranges.
+          #
+          # @api private
+          #
+          # @since 1.1.0
+          IPV6_REGEX = /\A(?:
+            (?:#{ipv6_octet_list}:){6}#{ipv4_addr}|
+            (?:#{ipv6_octet_list}:){5}#{ipv6_octet_list}:#{ipv4_addr}|
+            (?:#{ipv6_octet_list}:){5}:#{ipv6_octet_list}:#{ipv4_addr}|
+            (?:#{ipv6_octet_list}:){1,1}(?::#{ipv6_octet_list}){1,4}:#{ipv4_addr}|
+            (?:#{ipv6_octet_list}:){1,2}(?::#{ipv6_octet_list}){1,3}:#{ipv4_addr}|
+            (?:#{ipv6_octet_list}:){1,3}(?::#{ipv6_octet_list}){1,2}:#{ipv4_addr}|
+            (?:#{ipv6_octet_list}:){1,4}(?::#{ipv6_octet_list}){1,1}:#{ipv4_addr}|
+            :(?::#{ipv6_octet_list}){1,5}:#{ipv4_addr}|
+            (?:(?:#{ipv6_octet_list}:){1,5}|:):#{ipv4_addr}|
+            (?:#{ipv6_octet_list}:){1,1}(?::#{ipv6_octet_list}){1,6}|
+            (?:#{ipv6_octet_list}:){1,2}(?::#{ipv6_octet_list}){1,5}|
+            (?:#{ipv6_octet_list}:){1,3}(?::#{ipv6_octet_list}){1,4}|
+            (?:#{ipv6_octet_list}:){1,4}(?::#{ipv6_octet_list}){1,3}|
+            (?:#{ipv6_octet_list}:){1,5}(?::#{ipv6_octet_list}){1,2}|
+            (?:#{ipv6_octet_list}:){1,6}(?::#{ipv6_octet_list}){1,1}|
+            #{ipv6_octet_list}(?::#{ipv6_octet_list}){7}|
+            :(?::#{ipv6_octet_list}){1,7}|
+            (?:(?:#{ipv6_octet_list}:){1,7}|:):
+          )\z/x
+
+          # Regular expression to match IP-glob ranges.
+          #
+          # @api private
+          #
+          # @since 1.1.0
+          REGEX = /#{IPV4_REGEX}|#{IPV6_REGEX}/
+
           # The IP glob string.
           #
           # @return [String]
@@ -66,26 +115,32 @@ module Ronin
           # @param [String] string
           #   The IP-glob string to parse.
           #
+          # @raise [ArgumentError]
+          #   The IP-glob string was neither a valid IPv4 or IPv6 glob address.
+          #
           def initialize(string)
             @string = string
 
-            if @string.include?(':') # IPv6
-              @version   = 6
-              @base      = 16
-              @formatter = method(:format_ipv6_address)
-
-              separator   = ':'
-              octet_range = (0..0xffff)
-            else # IPv4
+            case string
+            when IPV4_REGEX
               @version   = 4
               @base      = 10
               @formatter = method(:format_ipv4_address)
 
               separator   = '.'
               octet_range = (0..255)
+            when IPV6_REGEX
+              @version   = 6
+              @base      = 16
+              @formatter = method(:format_ipv6_address)
+
+              separator   = ':'
+              octet_range = (0..0xffff)
+            else
+              raise(ArgumentError,"invalid IP-glob range: #{string.inspect}")
             end
 
-            @ranges = @string.split(separator).map do |segment|
+            @ranges = string.split(separator).map do |segment|
               if    segment == '*'        then octet_range
               elsif segment.include?(',') then parse_list(segment)
               elsif segment.include?('-') then parse_range(segment)
@@ -169,6 +224,54 @@ module Ronin
             @version == 6
           end
 
+          #
+          # Determines whether the IP address exists within the IP range.
+          #
+          # @param [IP, IPAddr, String] ip
+          #   The IP address to check.
+          #
+          # @return [Boolean]
+          #   Indicates whether the IP address exists within the IP range.
+          #
+          # @since 1.1.0
+          #
+          def include?(ip)
+            super(ip.to_s)
+          end
+
+          #
+          # Compares the IP glob range to another IP range.
+          #
+          # @param [Object] other
+          #   The other IP range.
+          #
+          # @return [Boolean]
+          #
+          # @since 1.1.0
+          #
+          def ==(other)
+            other.kind_of?(self.class) && @string == other.string
+          end
+
+          #
+          # Determines if the given IP range is a sub-set of the IP CIDR range.
+          #
+          # @param [Glob, CIDR, Enumerable<String>] other
+          #   The other IP range.
+          #
+          # @return [Boolean]
+          #
+          # @since 1.1.0
+          #
+          def ===(other)
+            case other
+            when Enumerable
+              other.all? { |ip| include?(ip) }
+            else
+              false
+            end
+          end
+
           #
           # Enumerates over the IP-glob range.
           #
@@ -217,6 +320,43 @@ module Ronin
             return self
           end
 
+          #
+          # The first address in the IP glob range.
+          #
+          # @return [String]
+          #   The first IP address in the IP glob range.
+          #
+          # @since 1.1.0
+          #
+          def first
+            @formatter.call(@ranges.map(&:first))
+          end
+
+          #
+          # The last address in the IP glob range.
+          #
+          # @return [String]
+          #   The last IP address in the IP glob range.
+          #
+          # @since 1.1.0
+          #
+          def last
+            @formatter.call(@ranges.map(&:last))
+          end
+
+          #
+          # Calculates the size of the IP glob range.
+          #
+          # @return [Integer]
+          #
+          # @since 1.1.0
+          #
+          def size
+            @ranges.reduce(1) do |total,parts|
+              total * parts.size
+            end
+          end
+
           #
           # Converts the IP-glob range back into a String.
           #

data/lib/ronin/support/network/ip_range/range.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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
@@ -145,7 +145,7 @@ module Ronin
           #
           # Determines if the given IP belongs to the ASN IP range.
           #
-          # @param [IPAddr, String] ip
+          # @param [IP, IPAddr, String] ip
           #   The IP to test.
           #
           # @return [Boolean]
@@ -207,6 +207,38 @@ module Ronin
               self.end   == other.end
           end
 
+          #
+          # Determines if the given IP range is a sub-set of the IP range.
+          #
+          # @param [IPRange::Range, CIDR, Glob, Enumerable<String>] other
+          #   The other IP range.
+          #
+          # @return [Boolean]
+          #
+          # @since 1.1.0
+          #
+          def ===(other)
+            case other
+            when IPRange::Range
+              self.begin <= other.begin && self.end >= other.end
+            when Enumerable
+              other.all? { |ip| include?(ip) }
+            else
+              false
+            end
+          end
+
+          #
+          # Calculates the size of the IP range.
+          #
+          # @return [Integer]
+          #
+          # @since 1.1.0
+          #
+          def size
+            (@end_uint - @begin_uint) + 1
+          end
+
           #
           # Converts the IP range to a String.
           #

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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
@@ -65,6 +65,22 @@ module Ronin
       #
       class IPRange
 
+        # Regular expression to match CIDR ranges or IP-glob ranges.
+        #
+        # @api private
+        #
+        # @since 1.1.0
+        REGEX = /#{CIDR::REGEX}|#{Glob::REGEX}/
+
+        # The parsed IP range.
+        #
+        # @return [CIDR, Glob]
+        #
+        # @api private
+        #
+        # @since 1.1.0
+        attr_reader :range
+
         #
         # Initializes the IP range.
         #
@@ -77,9 +93,15 @@ module Ronin
         # @example Initializing an IP-glob range:
         #   ip_range = IPRange.new('10.0.1-3.*')
         #
+        # @raise [ArgumentError]
+        #   The IP range was neither a CIDR range or a IP-glob range.
+        #
         def initialize(string)
-          @range = if self.class.glob?(string) then Glob.new(string)
-                   else                             CIDR.new(string)
+          @range = case string
+                   when CIDR::REGEX then CIDR.new(string)
+                   when Glob::REGEX then Glob.new(string)
+                   else
+                     raise(ArgumentError,"invalid IP range: #{string.inspect}")
                    end
         end
 
@@ -160,7 +182,7 @@ module Ronin
         #   Indicates that the IP range is a CIDR range.
         #
         def self.cidr?(string)
-          !glob?(string)
+          string =~ CIDR::REGEX
         end
 
         #
@@ -173,7 +195,7 @@ module Ronin
         #   Indicates that the IP range is a IP-glob range.
         #
         def self.glob?(string)
-          string.include?('*') || string.include?(',') || string.include?('-')
+          string =~ Glob::REGEX
         end
 
         #
@@ -212,6 +234,57 @@ module Ronin
           @range.ipv6?
         end
 
+        #
+        # Determines whether the IP address exists within the IP range.
+        #
+        # @param [IP, IPAddr, String] ip
+        #   The IP address to check.
+        #
+        # @return [Boolean]
+        #   Indicates whether the IP address exists within the IP range.
+        #
+        # @since 1.1.0
+        #
+        def include?(ip)
+          @range.include?(ip)
+        end
+
+        #
+        # Compares the IP range to another IP range.
+        #
+        # @param [Object] other
+        #   The other IP range.
+        #
+        # @return [Boolean]
+        #
+        # @since 1.1.0
+        #
+        def ==(other)
+          other.kind_of?(self.class) && @range == other.range
+        end
+
+        #
+        # Determines if the given IP range is a sub-set of the IP range.
+        #
+        # @param [IPRange, Enumerable<String>] other
+        #   The other IP range.
+        #
+        # @return [Boolean]
+        #
+        # @see CIDR#===
+        # @see Glob#===
+        #
+        # @since 1.1.0
+        #
+        def ===(other)
+          case other
+          when IPRange
+            @range === other.range
+          else
+            @range === other
+          end
+        end
+
         #
         # Enumerates over each IP address that is included in the addresses
         # netmask. Supports both IPv4 and IPv6 addresses.
@@ -264,6 +337,48 @@ module Ronin
           @range.each(&block)
         end
 
+        #
+        # The first IP address in the IP range.
+        #
+        # @return [String]
+        #
+        # @see CIDR#first
+        # @see Glob#last
+        #
+        # @since 1.1.0
+        #
+        def first
+          @range.first
+        end
+
+        #
+        # The last IP address in the IP range.
+        #
+        # @return [String]
+        #
+        # @see CIDR#first
+        # @see Glob#last
+        #
+        # @since 1.1.0
+        #
+        def last
+          @range.last
+        end
+
+        #
+        # Calculates the size of the IP range.
+        #
+        # @return [Integer]
+        #
+        # @see CIDR#size
+        # @see Glob#size
+        #
+        # @since 1.1.0
+        #
+        def size
+          @range.size
+        end
+
         #
         # Converts the IP range back to a String.
         #

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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
@@ -23,11 +23,6 @@ require 'ronin/support/network/udp/mixin'
 require 'ronin/support/network/ssl/mixin'
 require 'ronin/support/network/unix/mixin'
 require 'ronin/support/network/http/mixin'
-require 'ronin/support/network/ftp/mixin'
-require 'ronin/support/network/smtp/mixin'
-require 'ronin/support/network/esmtp/mixin'
-require 'ronin/support/network/pop3/mixin'
-require 'ronin/support/network/imap/mixin'
 
 module Ronin
   module Support
@@ -47,11 +42,6 @@ module Ronin
         include SSL::Mixin
         include UNIX::Mixin
         include HTTP::Mixin
-        include FTP::Mixin
-        include SMTP::Mixin
-        include ESMTP::Mixin
-        include POP3::Mixin
-        include IMAP::Mixin
       end
     end
   end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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

data/lib/ronin/support/network/pop3/mixin.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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

data/lib/ronin/support/network/smtp/email.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 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