ronin-support 1.0.5 → 1.1.0.rc1

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
@@ -41,23 +41,23 @@ module Ronin
       # Enumerating over a IP-glob range:
       #
       #     IPRange.each('10.0.1-3.*') { |ip| puts ip }
+      #     # 10.0.1.0
       #     # 10.0.1.1
-      #     # 10.0.1.2
       #     # ...
-      #     # 10.0.1.253
       #     # 10.0.1.254
+      #     # 10.0.1.255
       #     # ...
+      #     # 10.0.2.0
       #     # 10.0.2.1
-      #     # 10.0.2.2
       #     # ...
-      #     # 10.0.2.253
       #     # 10.0.2.254
+      #     # 10.0.2.255
       #     # ...
+      #     # 10.0.3.0
       #     # 10.0.3.1
-      #     # 10.0.3.2
       #     # ...
-      #     # 10.0.3.253
       #     # 10.0.3.254
+      #     # 10.0.3.255
       #
       # @api public
       #
@@ -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
 
@@ -126,23 +148,23 @@ module Ronin
         #
         # @example Enumerating over a IP-glob range:
         #   IPRange.each('10.0.1-3.*') { |ip| puts ip }
+        #   # 10.0.1.0
         #   # 10.0.1.1
-        #   # 10.0.1.2
         #   # ...
-        #   # 10.0.1.253
         #   # 10.0.1.254
+        #   # 10.0.1.255
         #   # ...
+        #   # 10.0.2.0
         #   # 10.0.2.1
-        #   # 10.0.2.2
         #   # ...
-        #   # 10.0.2.253
         #   # 10.0.2.254
+        #   # 10.0.2.255
         #   # ...
+        #   # 10.0.3.0
         #   # 10.0.3.1
-        #   # 10.0.3.2
         #   # ...
-        #   # 10.0.3.253
         #   # 10.0.3.254
+        #   # 10.0.3.255
         #
         # @see #each
         #
@@ -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
 
         #
@@ -181,6 +203,9 @@ module Ronin
         #
         # @return [String]
         #
+        # @see CIDR#string
+        # @see Glob#string
+        #
         def string
           @range.string
         end
@@ -190,6 +215,9 @@ module Ronin
         #
         # @return [Boolean]
         #
+        # @see CIDR#ipv4?
+        # @see Glob#ipv4?
+        #
         def ipv4?
           @range.ipv4?
         end
@@ -199,10 +227,64 @@ module Ronin
         #
         # @return [Boolean]
         #
+        # @see CIDR#ipv6?
+        # @see Glob#ipv6?
+        #
         def ipv6?
           @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.
@@ -230,23 +312,23 @@ module Ronin
         # @example Enumerating over a IP-glob range:
         #   ip_range = IPRange.new('10.0.1-3.*')
         #   ip_range.each { |ip| puts ip }
+        #   # 10.0.1.0
         #   # 10.0.1.1
-        #   # 10.0.1.2
         #   # ...
-        #   # 10.0.1.253
         #   # 10.0.1.254
+        #   # 10.0.1.255
         #   # ...
+        #   # 10.0.2.0
         #   # 10.0.2.1
-        #   # 10.0.2.2
         #   # ...
-        #   # 10.0.2.253
         #   # 10.0.2.254
+        #   # 10.0.2.255
         #   # ...
+        #   # 10.0.3.0
         #   # 10.0.3.1
-        #   # 10.0.3.2
         #   # ...
-        #   # 10.0.3.253
         #   # 10.0.3.254
+        #   # 10.0.3.255
         #
         # @see CIDR#each
         # @see Glob#each
@@ -255,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
@@ -100,8 +100,11 @@ module Ronin
             pop3.start(user,password)
 
             if block_given?
-              yield pop3
-              pop3.finish
+              begin
+                yield pop3
+              ensure
+                pop3.finish
+              end
             else
               return pop3
             end

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

data/lib/ronin/support/network/smtp/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
@@ -164,8 +164,11 @@ module Ronin
             smtp.start(helo,user,password,auth)
 
             if block_given?
-              yield smtp
-              smtp.finish
+              begin
+                yield smtp
+              ensure
+                smtp.finish
+              end
             else
               return smtp
             end

data/lib/ronin/support/network/smtp.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/ssl/local_cert.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/ssl/local_key.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