ronin-support 1.0.0 → 1.0.2

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

@@ -55,10 +55,10 @@ module Ronin
       #
       #     ip.asn
       #     # => #<Ronin::Support::Network::ASN::DNSRecord:0x00007f34142de598
-      #           @country_code="US",
-      #           @name=nil,
-      #           @number=15133,
-      #           @range=#<Ronin::Support::Network::IPRange::CIDR: 93.184.216.0/24>>
+      #     #     @country_code="US",
+      #     #     @name=nil,
+      #     #     @number=15133,
+      #     #     @range=#<Ronin::Support::Network::IPRange::CIDR: 93.184.216.0/24>>
       #
       # @api public
       #
@@ -66,11 +66,6 @@ module Ronin
       #
       class IP < IPAddr
 
-        # The address of the IP.
-        #
-        # @return [String]
-        attr_reader :address
-
         #
         # Initializes the IP address.
         #
@@ -92,23 +87,46 @@ module Ronin
         #   the IP address.
         #
         def initialize(address,family=Socket::AF_UNSPEC)
-          # XXX: remove the %iface suffix for ruby < 3.1.0
-          if address.kind_of?(String) && address =~ /%.+$/
-            address = address.sub(/%.+$/,'')
+          case address
+          when String
+            # XXX: remove the %iface suffix for ruby < 3.1.0
+            if address =~ /%.+$/
+              address = address.sub(/%.+$/,'')
+            end
+
+            # pre-cache the given IP address String
+            @address = address
           end
 
           begin
             super(address,family)
-          rescue IPAddr::InvalidAddressError => error
+          rescue IPAddr::InvalidAddressError
             raise(InvalidIP,"invalid IP address: #{address.inspect}")
           end
+        end
 
-          @address = case address
-                     when String then address.to_s
-                     else             to_s
-                     end
+        protected
+
+        #
+        # Sets the IP address using the numeric IP address value.
+        #
+        # @param [Integer] addr
+        #   The new numeric IP address value.
+        #
+        # @param [Integer] family
+        #   Optional IP address family.
+        #
+        # @api private
+        #
+        def set(addr,*family)
+          super(addr,*family)
+
+          # unset the cached IP address since the numeric address has changed
+          @address = nil
         end
 
+        public
+
         # The URI for https://ipinfo.io/ip
         IPINFO_URI = URI::HTTPS.build(host: 'ipinfo.io', path: '/ip')
 
@@ -122,6 +140,7 @@ module Ronin
           response = begin
                        Net::HTTP.get_response(IPINFO_URI)
                      rescue
+                       # ignore any network failures
                      end
 
           if response && response.code == '200'
@@ -230,7 +249,7 @@ module Ronin
         #   IPAddr.extract(text,:v4) do |ip|
         #     puts ip
         #   end
-        #   
+        #
         def self.extract(text,version=nil,&block)
           return enum_for(__method__,text,version).to_a unless block_given?
 
@@ -240,10 +259,7 @@ module Ronin
                    else                    Text::Patterns::IP_ADDR
                    end
 
-          text.scan(regexp) do |match|
-            yield match
-          end
-
+          text.scan(regexp,&block)
           return nil
         end
 
@@ -288,6 +304,16 @@ module Ronin
           ipv4? && (@addr & 0xff) == 0x00
         end
 
+        #
+        # The IP address.
+        #
+        # @return [String]
+        #   The String version of the IP address.
+        #
+        def address
+          @address ||= to_s
+        end
+
         #
         # The Autonomous System Number (ASN) information for the IP address.
         #
@@ -521,8 +547,8 @@ module Ronin
         end
 
         alias canonical to_string
-        alias to_uint to_i
         alias to_str to_s
+        alias to_uint to_i
 
         #
         # Inspects the IP.

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

@@ -124,10 +124,9 @@ module Ronin
             end
 
             num_bits  = SIZES.fetch(first_ip.family)
-            mask      = MASKS.fetch(first_ip.family)
             diff_bits = first_ip.to_i ^ last_ip.to_i
 
-            if diff_bits != 0
+            if diff_bits > 0
               prefix_length = num_bits - Math.log2(diff_bits).ceil
 
               return new("#{first_ip}/#{prefix_length}")
@@ -191,9 +190,6 @@ module Ronin
             return enum_for(__method__) unless block_given?
 
             family_mask = MASKS[@family]
-            octet_mask  = if ipv6? then 0xffff
-                          else          0xff
-                          end
 
             (0..((~@mask_addr) & family_mask)).each do |i|
               ip_uint = (@addr | i)

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

@@ -265,6 +265,7 @@ module Ronin
           #
           def parse_range(range)
             start, stop = range.split('-',2)
+
             start = start.to_i(@base)
             stop  = stop.to_i(@base)
 

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

@@ -76,7 +76,7 @@ module Ronin
           #
           # @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.
           #

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

@@ -40,7 +40,7 @@ module Ronin
       #
       # Enumerating over a IP-glob range:
       #
-      #     IPRange.each('10.0.1-3.*/24') { |ip| puts ip }
+      #     IPRange.each('10.0.1-3.*') { |ip| puts ip }
       #     # 10.0.1.1
       #     # 10.0.1.2
       #     # ...
@@ -75,7 +75,7 @@ module Ronin
         #   ip_range = IPRange.new('10.0.0.1/24')
         #
         # @example Initializing an IP-glob range:
-        #   ip_range = IPRange.new('10.0.1-3.*/24')
+        #   ip_range = IPRange.new('10.0.1-3.*')
         #
         def initialize(string)
           @range = if self.class.glob?(string) then Glob.new(string)
@@ -125,7 +125,7 @@ module Ronin
         #   # 10.0.0.255
         #
         # @example Enumerating over a IP-glob range:
-        #   IPRange.each('10.0.1-3.*/24') { |ip| puts ip }
+        #   IPRange.each('10.0.1-3.*') { |ip| puts ip }
         #   # 10.0.1.1
         #   # 10.0.1.2
         #   # ...
@@ -173,9 +173,7 @@ module Ronin
         #   Indicates that the IP range is a IP-glob range.
         #
         def self.glob?(string)
-          string.include?('*') ||
-          string.include?(',') ||
-          string.include?('-')
+          string.include?('*') || string.include?(',') || string.include?('-')
         end
 
         #
@@ -230,7 +228,7 @@ module Ronin
         #   # 10.0.0.255
         #
         # @example Enumerating over a IP-glob range:
-        #   ip_range = IPRange.new('10.0.1-3.*/24')
+        #   ip_range = IPRange.new('10.0.1-3.*')
         #   ip_range.each { |ip| puts ip }
         #   # 10.0.1.1
         #   # 10.0.1.2

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

@@ -75,12 +75,12 @@ module Ronin
         attr_reader :port
 
         # The remote port the proxy will relay data to
-        # 
+        #
         # @return [String]
         attr_reader :server_host
 
         # The remote host the proxy will relay data to
-        # 
+        #
         # @return [Integer]
         attr_reader :server_port
 
@@ -130,7 +130,7 @@ module Ronin
           @port = port
 
           @server_host, @server_port = server
-          @server_port ||= @port
+          @server_port             ||= @port
 
           @callbacks = {client_data: [], server_data: []}
 
@@ -240,7 +240,7 @@ module Ronin
         # Closes the proxy.
         #
         # @api public
-        # 
+        #
         def close
           close_connections
           close_proxy

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

@@ -149,6 +149,7 @@ module Ronin
               begin
                 download(url: url, path: path)
               rescue
+                # ignore any network failures
               end
             end
           end
@@ -224,6 +225,7 @@ module Ronin
 
               suffix.name.split('.').reverse_each.each_cons(2) do |parent,child|
                 subtree = tree[parent] ||= {}
+
                 subtree[child] ||= nil
 
                 tree = subtree
@@ -313,14 +315,14 @@ module Ronin
           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
+                                 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

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

@@ -20,6 +20,9 @@ module Ronin
   module Support
     module Network
       module PublicSuffix
+        #
+        # A sub-set of public suffixes.
+        #
         class SuffixSet
 
           include Enumerable

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

@@ -21,6 +21,11 @@ require 'ronin/support/network/public_suffix/list'
 module Ronin
   module Support
     module Network
+      #
+      # Manages the [public suffixes list].
+      #
+      # [public suffix list]: https://publicsuffix.org/
+      #
       module PublicSuffix
         #
         # Downloads/updates then loads the cached file
@@ -30,10 +35,10 @@ module Ronin
         #   The loaded list file.
         #
         def self.list
-          @list ||= (
-            List.update
-            List.load_file
-          )
+          @list ||= begin
+                      List.update
+                      List.load_file
+                    end
         end
       end
     end

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

@@ -137,15 +137,6 @@ module Ronin
           # @api public
           #
           def to_s
-            address = lambda { |info|
-              case info
-              when Array
-                "#{info[0]} <#{info[1]}>"
-              else
-                info
-              end
-            }
-
             message = []
 
             if @from

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

@@ -146,8 +146,8 @@ module Ronin
                                  ssl:  nil,
                                  helo: 'localhost',
                                  auth: :login)
-            host = DNS::IDN.to_ascii(host)
-            user = user.to_s
+            host     = DNS::IDN.to_ascii(host)
+            user     = user.to_s
             password = password.to_s
 
             case ssl

data/lib/ronin/support/network/ssl/local_cert.rb

@@ -53,7 +53,7 @@ module Ronin
               subject: {
                 common_name:         'localhost',
                 organization:        'ronin-rb',
-                organizational_unit: 'ronin-support',
+                organizational_unit: 'ronin-support'
               },
               extensions: {
                 'subjectAltName' => subject_alt_name
@@ -90,8 +90,6 @@ module Ronin
             end
           end
 
-          private
-
           #
           # The value for the `subjectAltName` extension.
           #

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

@@ -116,6 +116,7 @@ module Ronin
           #
           def ssl_socket(socket,**kwargs)
             ssl_socket = OpenSSL::SSL::SSLSocket.new(socket,ssl_context(**kwargs))
+
             ssl_socket.sync_close = true
             return ssl_socket
           end
@@ -182,19 +183,17 @@ module Ronin
           #
           def ssl_open?(host,port, bind_host: nil, bind_port: nil, timeout: 5,
                                                                    **kwargs)
-            begin
-              Timeout.timeout(timeout) do
-                ssl_connect(host,port, bind_host: bind_host,
-                                       bind_port: bind_port,
-                                       **kwargs)
-              end
-
-              return true
-            rescue Timeout::Error
-              return nil
-            rescue SocketError, SystemCallError
-              return false
+            Timeout.timeout(timeout) do
+              ssl_connect(host,port, bind_host: bind_host,
+                                     bind_port: bind_port,
+                                     **kwargs)
             end
+
+            return true
+          rescue Timeout::Error
+            return nil
+          rescue SocketError, SystemCallError
+            return false
           end
 
           #
@@ -392,7 +391,8 @@ module Ronin
           #
           def ssl_cert(host,port,**kwargs)
             socket = ssl_connect(host,port,**kwargs)
-            cert = Crypto::Cert(socket.peer_cert)
+            cert   = Crypto::Cert(socket.peer_cert)
+
             socket.close
             return cert
           end

data/lib/ronin/support/network/ssl/openssl.rb

@@ -18,6 +18,6 @@
 
 begin
   require 'openssl'
-rescue ::LoadError
+rescue LoadError
   warn "WARNING: Ruby was not compiled with OpenSSL support"
 end

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

@@ -28,7 +28,7 @@ module Ronin
         # protocols.
         #
         # ## Example
-        # 
+        #
         #     require 'ronin/support/network/ssl/proxy'
         #     require 'hexdump'
         #
@@ -216,7 +216,7 @@ module Ronin
           #
           # @param [OpenSSL::SSL::SSLSocket] connection
           #   A SSL connection to write data to.
-          # 
+          #
           # @param [String] data
           #   The data to write.
           #
@@ -238,11 +238,9 @@ module Ronin
           # @api public
           #
           def recv(connection)
-            begin
-              connection.readpartial(@buffer_size)
-            rescue Errno::ECONNRESET, EOFError
-              ''
-            end
+            connection.readpartial(@buffer_size)
+          rescue Errno::ECONNRESET, EOFError
+            ''
           end
 
           #
@@ -252,15 +250,15 @@ module Ronin
           #   The new SSL connection.
           #
           def accept_client_connection
-            client  = super
-            context = SSL.context(version:   @version,
-                                  key:       @key,
-                                  key_file:  @key_file,
-                                  cert:      @cert,
-                                  cert_file: @cert_file,
-                                  verify:    @verify)
-
+            client     = super
+            context    = SSL.context(version:   @version,
+                                     key:       @key,
+                                     key_file:  @key_file,
+                                     cert:      @cert,
+                                     cert_file: @cert_file,
+                                     verify:    @verify)
             ssl_socket = OpenSSL::SSL::SSLSocket.new(client,context)
+
             ssl_socket.sync_close = true
 
             begin
@@ -281,8 +279,8 @@ module Ronin
           def open_server_connection
             server_socket = super
             context       = SSL.context(verify: @verify, ca_bundle: @ca_bundle)
+            ssl_socket    = OpenSSL::SSL::SSLSocket.new(server_socket,context)
 
-            ssl_socket = OpenSSL::SSL::SSLSocket.new(server_socket,context)
             ssl_socket.sync_close = true
             ssl_socket.connect
 

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

@@ -24,6 +24,9 @@ require 'ronin/support/network/ssl/proxy'
 module Ronin
   module Support
     module Network
+      #
+      # Top-level SSL methods.
+      #
       module SSL
         # SSL/TLS versions
         VERSIONS = {
@@ -136,7 +139,7 @@ module Ronin
                          cert:      nil,
                          cert_file: nil,
                          ca_bundle: nil)
-          context = OpenSSL::SSL::SSLContext.new()
+          context = OpenSSL::SSL::SSLContext.new
 
           if version
             context.ssl_version = VERSIONS.fetch(version,version)
@@ -166,7 +169,6 @@ module Ronin
 
           return context
         end
-
       end
     end
   end

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

@@ -28,7 +28,7 @@ module Ronin
         # The TCP Proxy allows for inspecting and manipulating TCP protocols.
         #
         # ## Example
-        # 
+        #
         #     require 'ronin/support/network/tcp/proxy'
         #     require 'hexdump'
         #
@@ -152,7 +152,7 @@ module Ronin
           def poll
             sockets = [@socket] + client_connections + server_connections
 
-            readable, writtable, errors = IO.select(sockets,nil,sockets)
+            readable, _writtable, errors = IO.select(sockets,nil,sockets)
 
             (errors & client_connections).each do |client_socket|
               server_socket = server_connection_for(client_socket)
@@ -200,7 +200,7 @@ module Ronin
           #
           # @param [TCPSocket] connection
           #   A TCP connection to write data to.
-          # 
+          #
           # @param [String] data
           #   The data to write.
           #

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

@@ -67,18 +67,16 @@ module Ronin
         # @since 0.5.0
         #
         def self.open?(host,port, timeout: 5, **kwargs)
-          begin
-            Timeout.timeout(timeout) do
-              socket = connect(host,port,**kwargs)
-              socket.close
-            end
-
-            return true
-          rescue Timeout::Error
-            return nil
-          rescue SocketError, SystemCallError
-            return false
+          Timeout.timeout(timeout) do
+            socket = connect(host,port,**kwargs)
+            socket.close
           end
+
+          return true
+        rescue Timeout::Error
+          return nil
+        rescue SocketError, SystemCallError
+          return false
         end
 
         #
@@ -345,7 +343,7 @@ module Ronin
         #
         def self.server_session(**kwargs,&block)
           server = server(**kwargs,&block)
-          server.close()
+          server.close
           return nil
         end
 

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

@@ -103,20 +103,20 @@ module Ronin
           # @api public
           #
           def telnet_connect(host, # connection options
-                             proxy:     Telnet.proxy,
-                             port:      Telnet::DEFAULT_PORT,
-                             binmode:   false,
-                             wait_time: 0,
-                             prompt:    Telnet::DEFAULT_PROMPT,
-                             timeout:   Telnet.default_timeout,
-                             telnet:    nil,
-                             plain:     nil,
-                             # authentication options
-                             user:     nil,
-                             password: nil,
-                             # log options
-                             output_log: nil,
-                             dump_log:   nil)
+                                   proxy:     Telnet.proxy,
+                                   port:      Telnet::DEFAULT_PORT,
+                                   binmode:   false,
+                                   wait_time: 0,
+                                   prompt:    Telnet::DEFAULT_PROMPT,
+                                   timeout:   Telnet.default_timeout,
+                                   telnet:    nil,
+                                   plain:     nil,
+                                   # authentication options
+                                   user:     nil,
+                                   password: nil,
+                                   # log options
+                                   output_log: nil,
+                                   dump_log:   nil)
             host = DNS::IDN.to_ascii(host)
 
             telnet_options = {

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

@@ -152,6 +152,7 @@ module Ronin
               begin
                 download(url: url, path: path)
               rescue
+                # ignore any network failures
               end
             end
           end
@@ -228,7 +229,7 @@ module Ronin
             end
 
             name = host_name[0...index]
-            tld  = host_name[(index+1)..]
+            tld  = host_name[(index + 1)..]
 
             unless @list.include?(tld)
               raise(InvalidHostname,"hostname does not have a valid TLD: #{host_name.inspect}")

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

@@ -21,6 +21,9 @@ require 'ronin/support/network/tld/list'
 module Ronin
   module Support
     module Network
+      #
+      # Manages the list of Top-Level-Domains (TLDs).
+      #
       module TLD
         #
         # Downloads/updates then loads the cached file
@@ -30,10 +33,10 @@ module Ronin
         #   The loaded list file.
         #
         def self.list
-          @list ||= (
-            List.update
-            List.load_file
-          )
+          @list ||= begin
+                      List.update
+                      List.load_file
+                    end
         end
       end
     end