ronin-support 1.0.0 → 1.0.1

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

@@ -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
 
         #

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

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

@@ -27,7 +27,7 @@ module Ronin
         # protocols.
         #
         # ## Example
-        # 
+        #
         #     require 'ronin/support/network/tls/proxy'
         #     require 'hexdump'
         #

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

@@ -16,7 +16,6 @@
 # along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-
 require 'ronin/support/network/tls/proxy'
 require 'ronin/support/network/ssl'
 
@@ -46,7 +45,6 @@ module Ronin
         def self.context(version: 1.2, **kwargs)
           SSL.context(version: version, **kwargs)
         end
-
       end
     end
   end

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

@@ -44,7 +44,7 @@ module Ronin
         #         puts "#{host}:#{port} <- #{proxy}"
         #         hex.dump(data)
         #       end
-        #     
+        #
         #     end
         #
         # @since 0.5.0
@@ -70,7 +70,7 @@ module Ronin
           def poll
             sockets = [@socket] + server_connections
 
-            readable, writtable, errors = IO.select(sockets,nil,sockets)
+            readable, _writtable, errors = IO.select(sockets,nil,sockets)
 
             (errors & server_connections).each do |server_socket|
               client_socket = client_connection_for(server_socket)
@@ -79,8 +79,8 @@ module Ronin
             end
 
             (readable & server_connections).each do |server_socket|
-              client_socket  = client_connection_for(server_socket)
-              data, addrinfo = recv(server_socket)
+              client_socket   = client_connection_for(server_socket)
+              data, _addrinfo = recv(server_socket)
 
               server_data(client_socket,server_socket,data)
             end
@@ -133,7 +133,7 @@ module Ronin
           def recv(connection)
             case connection
             when Array
-              socket, (host, port) = connection
+              socket, _host_and_port = connection
 
               socket.recvfrom(@buffer_size)
             when UDPSocket

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

@@ -67,24 +67,22 @@ module Ronin
         # @since 0.5.0
         #
         def self.open?(host,port, timeout: 5, **kwargs)
-          begin
-            Timeout.timeout(timeout) do
-              connect(host,port,**kwargs) do |socket|
-                # send an empty UDP packet, just like nmap
-                socket.syswrite('')
+          Timeout.timeout(timeout) do
+            connect(host,port,**kwargs) do |socket|
+              # send an empty UDP packet, just like nmap
+              socket.syswrite('')
 
-                # send an empty UDP packet again, to elicit an
-                # Errno::ECONNREFUSED
-                socket.syswrite('')
-              end
+              # send an empty UDP packet again, to elicit an
+              # Errno::ECONNREFUSED
+              socket.syswrite('')
             end
-
-            return true
-          rescue Timeout::Error
-            return nil
-          rescue SocketError, SystemCallError
-            return false
           end
+
+          return true
+        rescue Timeout::Error
+          return nil
+        rescue SocketError, SystemCallError
+          return false
         end
 
         #
@@ -328,7 +326,7 @@ module Ronin
         #
         def self.server_session(**kwargs,&block)
           server = server(**kwargs,&block)
-          server.close()
+          server.close
           return nil
         end
 

data/lib/ronin/support/path.rb

@@ -54,8 +54,8 @@ module Ronin
       # @return [Path]
       #   The root path.
       #
-      def Path.root
-        Path.new('/')
+      def self.root
+        new('/')
       end
 
       #
@@ -89,7 +89,7 @@ module Ronin
             separator
           elsif n > 0
             path = new('..',separator)
-            path.join(*(['..'] * (n-1)))
+            path.join(*(['..'] * (n - 1)))
           else
             raise(ArgumentError,"negative argument")
           end

data/lib/ronin/support/text/erb/mixin.rb

@@ -22,6 +22,9 @@ module Ronin
   module Support
     module Text
       module ERB
+        #
+        # Mixin which adds `erb` helper methods.
+        #
         module Mixin
           #
           # Renders the ERB template file.

data/lib/ronin/support/text/homoglyph/table.rb

@@ -61,7 +61,7 @@ module Ronin
           # @api private
           #
           def self.load_file(path)
-            table = new()
+            table = new
 
             File.open(path) do |file|
               file.each_line(chomp: true) do |line|
@@ -211,11 +211,11 @@ module Ronin
                 offset = 0
 
                 while (index = string.index(replaceable_char,offset))
-                  homoglyph = string.dup
+                  homoglyph        = string.dup
                   homoglyph[index] = substitute_char
 
                   yield homoglyph
-                  offset = index+1
+                  offset = index + 1
                 end
               end
             end