ronin-support 0.5.1 → 1.0.0.beta1

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

@@ -0,0 +1,249 @@
+# 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/ip'
+
+require 'ipaddr'
+
+module Ronin
+  module Support
+    module Network
+      class IPRange
+        #
+        # Represents an arbitrary range of IP addresses.
+        #
+        # ## Examples
+        #
+        #     range = Network::IPRange::Range.new('128.2.3.4','200.10.1.255')
+        #     range.each { |ip| puts ip }
+        #     # 128.2.3.4
+        #     # 128.2.3.5
+        #     # ...
+        #     # 200.10.1.254
+        #     # 200.10.1.255
+        #
+        # @since 1.0.0
+        #
+        # @api public
+        #
+        class Range
+
+          include Enumerable
+
+          # The first IP address of the ASN IP range.
+          #
+          # @return [IP]
+          attr_reader :begin
+          alias first begin
+
+          # The last IP address of the ASN IP range.
+          #
+          # @return [IP]
+          attr_reader :end
+          alias last end
+
+          # The common prefix shared by the first and last IP addresses in the
+          # ASN IP range.
+          #
+          # @return [String]
+          attr_reader :prefix
+
+          # The address family of the ASN IP range.
+          #
+          # @return [Socket::AF_INET, Socket::AF_INET6]
+          attr_reader :family
+
+          #
+          # Initializes the ASN IP range.
+          #
+          # @param [String] first
+          #   The first IP address in the ASN IP range.
+          #
+          # @param [String] last
+          #   The last IP address in the ASN IP range.
+          # 
+          # @raise [ArgumentError]
+          #   Both IP addresses must be either IPv4 addresses or IPv6 addresses.
+          #
+          # @api private
+          #
+          def initialize(first,last)
+            @begin  = IP.new(first)
+            @end    = IP.new(last)
+
+            if (@begin.ipv4? && !@end.ipv4?) ||
+               (@begin.ipv6? && !@end.ipv6?)
+              raise(ArgumentError,"must specify two IPv4 or IPv6 addresses: #{first.inspect} #{last.inspect}")
+            end
+
+            @prefix = self.class.prefix(first,last)
+            @family = @begin.family
+
+            @begin_uint = @begin.to_i
+            @end_uint   = @end.to_i
+          end
+
+          #
+          # Finds the common prefix of two IP addresses.
+          #
+          # @param [String] first
+          #   The first IP address of the ASN IP range.
+          #
+          # @param [String] last
+          #   The last IP address of the ASN IP range.
+          #
+          # @return [String]
+          #   The common prefix shared by both IPs.
+          #
+          # @api private
+          #
+          def self.prefix(first,last)
+            min_length = [first.length, last.length].min
+
+            min_length.times do |index|
+              if first[index] != last[index]
+                return first[0,index]
+              end
+            end
+
+            return first
+          end
+
+          #
+          # Determines whether the IP range is an IPv4 range.
+          #
+          # @return [Boolean]
+          #
+          def ipv4?
+            @begin.ipv4?
+          end
+
+          #
+          # Determines whether the IP range is an IPv6 range.
+          #
+          # @return [Boolean]
+          #
+          def ipv6?
+            @end.ipv6?
+          end
+
+          #
+          # Determines if the given IP belongs to the ASN IP range.
+          #
+          # @param [IPAddr, String] ip
+          #   The IP to test.
+          #
+          # @return [Boolean]
+          #   Specifies whether the IP is or is not within the ASN IP range.
+          #
+          def include?(ip)
+            ip      = IPAddr.new(ip) unless ip.kind_of?(IPAddr)
+            ip_uint = ip.to_i
+
+            return (ip_uint >= @begin_uint) && (ip_uint <= @end_uint)
+          end
+
+          #
+          # Enumerates over every IP address in the ASN IP range.
+          #
+          # @yield [ip]
+          #   If a block is given, it will be passed every IP within the ASN
+          #   IP range.
+          #
+          # @yieldparam [IP] ip
+          #   An IP within the ASN IP range.
+          #
+          # @return [Enumerator]
+          #   If no block is given, an Enumerator will be returned.
+          #
+          # @note
+          #   This method will skip IPv4 addresses ending in `.0` or `.255`.
+          #
+          # @example
+          #   range = IPRange::Range.new('1.1.1.0','1.1.1.255')
+          #   range.each { |ip| puts ip }
+          #   # 1.1.1.1
+          #   # 1.1.1.2
+          #   # ...
+          #   # 1.1.1.253
+          #   # 1.1.1.254
+          #
+          # @example
+          #   range IPRange::Range.new('1.1.1.100','1.1.3.200')
+          #   range.each { |ip| puts ip }
+          #   # 1.1.1.100
+          #   # 1.1.1.101
+          #   # ...
+          #   # 1.1.3.199
+          #   # 1.1.3.200
+          #
+          def each
+            return enum_for(__method__) unless block_given?
+
+            ipaddr = @begin.clone
+
+            (@begin_uint..@end_uint).each do |ip_uint|
+              # skip IPv4 addresses ending in .0 or .255
+              if (ipv4? && ((ip_uint & 0xff) == 0 || (ip_uint & 0xff) == 0xff))
+                next
+              end
+
+              ipaddr.send(:set,ip_uint)
+              yield ipaddr.to_s
+            end
+
+            return self
+          end
+
+          #
+          # Compares the IP range to another object.
+          #
+          # @param [Object] other
+          #   The other object to compare to.
+          #
+          # @return [Boolean]
+          #
+          def ==(other)
+            self.class == other.class &&
+              self.begin == other.begin &&
+              self.end   == other.end
+          end
+
+          #
+          # Converts the IP range to a String.
+          #
+          # @return [String]
+          #
+          def to_s
+            "#{@begin} - #{@end}"
+          end
+
+          #
+          # Inspects the IP range.
+          #
+          # @return [String]
+          #
+          def inspect
+            "#<#{self.class}: #{self}>"
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,284 @@
+# 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/ip_range/cidr'
+require 'ronin/support/network/ip_range/glob'
+require 'ronin/support/network/ip_range/range'
+
+module Ronin
+  module Support
+    module Network
+      #
+      # Represents an IP range.
+      #
+      # ## Examples
+      #
+      # Enumerating over a CIDR range:
+      #
+      #     IPRange.each('10.0.0.1/24') { |ip| puts ip }
+      #     # 10.0.0.0
+      #     # 10.0.0.1
+      #     # 10.0.0.2
+      #     # ...
+      #     # 10.0.0.254
+      #     # 10.0.0.255
+      #
+      # Enumerating over a IP-glob range:
+      #
+      #     IPRange.each('10.0.1-3.*/24') { |ip| puts ip }
+      #     # 10.0.1.1
+      #     # 10.0.1.2
+      #     # ...
+      #     # 10.0.1.253
+      #     # 10.0.1.254
+      #     # ...
+      #     # 10.0.2.1
+      #     # 10.0.2.2
+      #     # ...
+      #     # 10.0.2.253
+      #     # 10.0.2.254
+      #     # ...
+      #     # 10.0.3.1
+      #     # 10.0.3.2
+      #     # ...
+      #     # 10.0.3.253
+      #     # 10.0.3.254
+      #
+      # @api public
+      #
+      # @since 1.0.0
+      #
+      class IPRange
+
+        #
+        # Initializes the IP range.
+        #
+        # @param [String] string
+        #   The IP range string.
+        #
+        # @example Initializing a CIDR IP range:
+        #   ip_range = IPRange.new('10.0.0.1/24')
+        #
+        # @example Initializing an IP-glob range:
+        #   ip_range = IPRange.new('10.0.1-3.*/24')
+        #
+        def initialize(string)
+          @range = if self.class.glob?(string) then Glob.new(string)
+                   else                             CIDR.new(string)
+                   end
+        end
+
+        #
+        # Alias for {#initialize new}.
+        #
+        # @param [String] string
+        #   The IP range to parse.
+        #
+        # @return [IPRange]
+        #   The parsed IP range.
+        #
+        # @see #initialize
+        #
+        def self.parse(string)
+          new(string)
+        end
+
+        #
+        # Enumerates over each IP address that is included in the addresses
+        # netmask. Supports both IPv4 and IPv6 addresses.
+        #
+        # @param [String] string
+        #   The IP range string to parse and enumerate over.
+        #
+        # @yield [ip]
+        #   The block which will be passed every IP address covered be the
+        #   netmask of the IPAddr object.
+        #
+        # @yieldparam [String] ip
+        #   An IP address.
+        #
+        # @return [Enumerator]
+        #   If no block is given an Enumerator will be returned.
+        #
+        # @example Enumerating over a CIDR range:
+        #   IPRange.each('10.0.0.1/24') { |ip| puts ip }
+        #   # 10.0.0.0
+        #   # 10.0.0.1
+        #   # 10.0.0.2
+        #   # ...
+        #   # 10.0.0.254
+        #   # 10.0.0.255
+        #
+        # @example Enumerating over a IP-glob range:
+        #   IPRange.each('10.0.1-3.*/24') { |ip| puts ip }
+        #   # 10.0.1.1
+        #   # 10.0.1.2
+        #   # ...
+        #   # 10.0.1.253
+        #   # 10.0.1.254
+        #   # ...
+        #   # 10.0.2.1
+        #   # 10.0.2.2
+        #   # ...
+        #   # 10.0.2.253
+        #   # 10.0.2.254
+        #   # ...
+        #   # 10.0.3.1
+        #   # 10.0.3.2
+        #   # ...
+        #   # 10.0.3.253
+        #   # 10.0.3.254
+        #
+        # @see #each
+        #
+        def self.each(string,&block)
+          new(string).each(&block)
+        end
+
+        #
+        # Determines if the IP range is a CIDR range.
+        #
+        # @param [String] string
+        #   The IP range string to inspect.
+        #
+        # @return [Boolean]
+        #   Indicates that the IP range is a CIDR range.
+        #
+        def self.cidr?(string)
+          !glob?(string)
+        end
+
+        #
+        # Determines if the IP range is a IP-glob range.
+        #
+        # @param [String] string
+        #   The IP range string to inspect.
+        #
+        # @return [Boolean]
+        #   Indicates that the IP range is a IP-glob range.
+        #
+        def self.glob?(string)
+          string.include?('*') ||
+          string.include?(',') ||
+          string.include?('-')
+        end
+
+        #
+        # The IP range string.
+        #
+        # @return [String]
+        #
+        def string
+          @range.string
+        end
+
+        #
+        # Determines if the IP range is IPv4.
+        #
+        # @return [Boolean]
+        #
+        def ipv4?
+          @range.ipv4?
+        end
+
+        #
+        # Determines if the IP range is IPv6.
+        #
+        # @return [Boolean]
+        #
+        def ipv6?
+          @range.ipv6?
+        end
+
+        #
+        # Enumerates over each IP address that is included in the addresses
+        # netmask. Supports both IPv4 and IPv6 addresses.
+        #
+        # @yield [ip]
+        #   The block which will be passed every IP address covered be the
+        #   netmask of the IPAddr object.
+        #
+        # @yieldparam [String] ip
+        #   An IP address.
+        #
+        # @return [Enumerator]
+        #   If no block is given an Enumerator will be returned.
+        #
+        # @example Enumerating over a CIDR range:
+        #   ip_range = IPRange.new('10.0.0.1/24')
+        #   ip_range.each { |ip| puts ip }
+        #   # 10.0.0.0
+        #   # 10.0.0.1
+        #   # 10.0.0.2
+        #   # ...
+        #   # 10.0.0.254
+        #   # 10.0.0.255
+        #
+        # @example Enumerating over a IP-glob range:
+        #   ip_range = IPRange.new('10.0.1-3.*/24')
+        #   ip_range.each { |ip| puts ip }
+        #   # 10.0.1.1
+        #   # 10.0.1.2
+        #   # ...
+        #   # 10.0.1.253
+        #   # 10.0.1.254
+        #   # ...
+        #   # 10.0.2.1
+        #   # 10.0.2.2
+        #   # ...
+        #   # 10.0.2.253
+        #   # 10.0.2.254
+        #   # ...
+        #   # 10.0.3.1
+        #   # 10.0.3.2
+        #   # ...
+        #   # 10.0.3.253
+        #   # 10.0.3.254
+        #
+        # @see CIDR#each
+        # @see Glob#each
+        #
+        def each(&block)
+          @range.each(&block)
+        end
+
+        #
+        # Converts the IP range back to a String.
+        #
+        # @return [String]
+        #
+        # @see CIDR#to_s
+        # @see Glob#to_s
+        #
+        def to_s
+          @range.to_s
+        end
+
+        #
+        # Inspects the IP range.
+        #
+        # @return [String]
+        #
+        def inspect
+          "#<#{self.class}: #{@range.string}>"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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/ip/mixin'
+require 'ronin/support/network/dns/mixin'
+require 'ronin/support/network/tcp/mixin'
+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
+    module Network
+      #
+      # Provides helper methods for networking functions.
+      #
+      # @api public
+      #
+      # @since 1.0.0
+      #
+      module Mixin
+        include IP::Mixin
+        include DNS::Mixin
+        include TCP::Mixin
+        include UDP::Mixin
+        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
+end

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

@@ -0,0 +1,27 @@
+# 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/binary/packet'
+
+module Ronin
+  module Support
+    module Network
+      Packet = Binary::Packet
+    end
+  end
+end