ronin-support 1.0.0 → 1.0.2

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
@@ -115,7 +115,7 @@ module Ronin
       #   # => #<Ronin::Support::Path:../../../../../../../etc/passwd>
       #
       def join(*names)
-        joined_path = if root? then String.new
+        joined_path = if root? then String.new(encoding: Encoding::UTF_8)
                       else          self.to_s
                       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/core_ext/string.rb

@@ -39,6 +39,10 @@ class String
   # @raise [Ronin::Support::Text::Homoglyph::NotViable]
   #   No homoglyph replaceable characters were found in the String.
   #
+  # @example
+  #   "microsoft".homoglyph
+  #   # => "mｉcrosoft"
+  #
   # @see Ronin::Support::Text::Homoglyph.substitute
   #
   # @api public
@@ -68,6 +72,11 @@ class String
   # @return [Enumerator]
   #   If no block is given, an Enumerator object will be returned.
   #
+  # @example
+  #   "microsoft".each_homoglyph do |homoglyph|
+  #     # ...
+  #   end
+  #
   # @see Ronin::Support::Text::Homoglyph.each_substitution
   #
   # @api public
@@ -95,6 +104,30 @@ class String
   # @return [Array<String>]
   #   All variation of the given String.
   #
+  # @example
+  #   "microsoft".homoglyphs
+  #   # =>
+  #   # ["ⅿicrosoft",
+  #   #  "ｍicrosoft",
+  #   #  "mіcrosoft",
+  #   #  "mⅰcrosoft",
+  #   #  "mｉcrosoft",
+  #   #  "miϲrosoft",
+  #   #  "miсrosoft",
+  #   #  "miⅽrosoft",
+  #   #  "miｃrosoft",
+  #   #  "micｒosoft",
+  #   #  "micrοsoft",
+  #   #  "microsοft",
+  #   #  "micrоsoft",
+  #   #  "microsоft",
+  #   #  "micrｏsoft",
+  #   #  "microsｏft",
+  #   #  "microѕoft",
+  #   #  "microｓoft",
+  #   #  "microsoｆt",
+  #   #  "microsofｔ"]
+  #
   # @see Ronin::Support::Text::Homoglyph.each_substitution
   #
   # @api public

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

data/lib/ronin/support/text/patterns/credentials.rb

@@ -59,10 +59,10 @@ module Ronin
         # @since 1.0.0
         AWS_ACCESS_KEY_ID = /(?<=[^A-Z0-9]|^)[A-Z0-9]{20}(?=[^A-Z0-9]|$)/
 
-        # Regular expression for finding all AWS secret access key 
+        # Regular expression for finding all AWS secret access key
         #
         # @since 1.0.0
-        AWS_SECRET_ACCESS_KEY = /(?<=[^A-Za-z0-9\/+=]|^)[A-Za-z0-9\/+=]{40}(?=[^A-Za-z0-9\/+=]|$)/
+        AWS_SECRET_ACCESS_KEY = %r{(?<=[^A-Za-z0-9/+=]|^)[A-Za-z0-9/+=]{40}(?=[^A-Za-z0-9/+=]|$)}
 
         # Regular expression for finding all API keys (md5, sha1, sha256,
         # sha512, AWS access key ID or AWS secret access key).

data/lib/ronin/support/text/patterns/crypto.rb

@@ -60,7 +60,7 @@ module Ronin
         # Regular expression for finding all SSH public keys in text.
         #
         # @since 1.0.0
-        SSH_PUBLIC_KEY = /(?:ssh-(?:rsa|dss|ed25519(?:@openssh.com)?)|ecdsa-sha2-nistp(?:256|384|521)(?:@openssh.com)?) AAAA[A-Za-z0-9+\/]+[=]{0,3} [^@\s]+@[^@\s]+/
+        SSH_PUBLIC_KEY = %r{(?:ssh-(?:rsa|dss|ed25519(?:@openssh.com)?)|ecdsa-sha2-nistp(?:256|384|521)(?:@openssh.com)?) AAAA[A-Za-z0-9+/]+(?:=){0,3} [^@\s]+@[^@\s]+}
       end
     end
   end

data/lib/ronin/support/text/patterns/file_system.rb

@@ -35,7 +35,7 @@ module Ronin
         # Regular expression to find file names in text
         #
         # @since 0.4.0
-        FILE_NAME = /(?:[^\/\\\. ]|\\[\/\\ ])+(?:#{FILE_EXT})?/
+        FILE_NAME = %r{(?:[^/\\\. ]|\\[/\\ ])+(?:#{FILE_EXT})?}
 
         # Regular expression to find Directory names in text
         #
@@ -45,12 +45,12 @@ module Ronin
         # Regular expression to find local UNIX Paths in text
         #
         # @since 0.4.0
-        RELATIVE_UNIX_PATH = /(?:#{DIR_NAME}\/)+#{DIR_NAME}\/?/
+        RELATIVE_UNIX_PATH = %r{(?:#{DIR_NAME}/)+#{DIR_NAME}/?}
 
         # Regular expression to find absolute UNIX Paths in text
         #
         # @since 0.4.0
-        ABSOLUTE_UNIX_PATH = /(?:\/#{FILE_NAME})+\/?/
+        ABSOLUTE_UNIX_PATH = %r{(?:/#{FILE_NAME})+/?}
 
         # Regular expression to find UNIX Paths in text
         #
@@ -86,7 +86,6 @@ module Ronin
         #
         # @since 0.4.0
         PATH = /#{UNIX_PATH}|#{WINDOWS_PATH}/
-
       end
     end
   end

data/lib/ronin/support/text/patterns/network.rb

@@ -40,31 +40,31 @@ module Ronin
         # A regular expression for matching IPv4 Addresses.
         #
         # @since 1.0.0
-        IPV4_ADDR = /#{decimal_octet}(?:\.#{decimal_octet}){3}(?:\/\d{1,2})?/
+        IPV4_ADDR = %r{#{decimal_octet}(?:\.#{decimal_octet}){3}(?:/\d{1,2})?}
 
         # A regular expression for matching IPv6 Addresses.
         #
         # @since 1.0.0
-        IPV6_ADDR = Regexp.union(
-          /(?:[0-9a-f]{1,4}:){6}#{IPV4_ADDR}/,
-          /(?:[0-9a-f]{1,4}:){5}[0-9a-f]{1,4}:#{IPV4_ADDR}/,
-          /(?:[0-9a-f]{1,4}:){5}:[0-9a-f]{1,4}:#{IPV4_ADDR}/,
-          /(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,4}:#{IPV4_ADDR}/,
-          /(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,3}:#{IPV4_ADDR}/,
-          /(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,2}:#{IPV4_ADDR}/,
-          /(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,1}:#{IPV4_ADDR}/,
-          /:(?::[0-9a-f]{1,4}){1,5}:#{IPV4_ADDR}/,
-          /(?:(?:[0-9a-f]{1,4}:){1,5}|:):#{IPV4_ADDR}/,
-          /(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,6}(?:\/\d{1,3})?/,
-          /(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,5}(?:\/\d{1,3})?/,
-          /(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,4}(?:\/\d{1,3})?/,
-          /(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,3}(?:\/\d{1,3})?/,
-          /(?:[0-9a-f]{1,4}:){1,5}(?::[0-9a-f]{1,4}){1,2}(?:\/\d{1,3})?/,
-          /(?:[0-9a-f]{1,4}:){1,6}(?::[0-9a-f]{1,4}){1,1}(?:\/\d{1,3})?/,
-          /[0-9a-f]{1,4}(?::[0-9a-f]{1,4}){7}(?:\/\d{1,3})?/,
-          /:(?::[0-9a-f]{1,4}){1,7}(?:\/\d{1,3})?/,
-          /(?:(?:[0-9a-f]{1,4}:){1,7}|:):(?:\/\d{1,3})?/
-        )
+        IPV6_ADDR = %r{
+          (?:[0-9a-f]{1,4}:){6}#{IPV4_ADDR}|
+          (?:[0-9a-f]{1,4}:){5}[0-9a-f]{1,4}:#{IPV4_ADDR}|
+          (?:[0-9a-f]{1,4}:){5}:[0-9a-f]{1,4}:#{IPV4_ADDR}|
+          (?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,4}:#{IPV4_ADDR}|
+          (?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,3}:#{IPV4_ADDR}|
+          (?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,2}:#{IPV4_ADDR}|
+          (?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,1}:#{IPV4_ADDR}|
+          :(?::[0-9a-f]{1,4}){1,5}:#{IPV4_ADDR}|
+          (?:(?:[0-9a-f]{1,4}:){1,5}|:):#{IPV4_ADDR}|
+          (?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,6}(?:/\d{1,3})?|
+          (?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,5}(?:/\d{1,3})?|
+          (?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,4}(?:/\d{1,3})?|
+          (?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,3}(?:/\d{1,3})?|
+          (?:[0-9a-f]{1,4}:){1,5}(?::[0-9a-f]{1,4}){1,2}(?:/\d{1,3})?|
+          (?:[0-9a-f]{1,4}:){1,6}(?::[0-9a-f]{1,4}){1,1}(?:/\d{1,3})?|
+          [0-9a-f]{1,4}(?::[0-9a-f]{1,4}){7}(?:/\d{1,3})?|
+          :(?::[0-9a-f]{1,4}){1,7}(?:/\d{1,3})?|
+          (?:(?:[0-9a-f]{1,4}:){1,7}|:):(?:/\d{1,3})?
+        }x
 
         # A regular expression for matching IP Addresses.
         #

data/lib/ronin/support/text/patterns/numeric.rb

@@ -26,7 +26,7 @@ module Ronin
         #
         # @group Numeric Patterns
         #
-        
+
         # Regular expression for finding all numbers in text.
         #
         # @since 1.0.0

data/lib/ronin/support/text/patterns/source_code.rb

@@ -35,7 +35,7 @@ module Ronin
         # Regular expression to find identifier in text
         #
         # @since 0.4.0
-        IDENTIFIER = /[_]*[a-zA-Z]+[a-zA-Z0-9_-]*/
+        IDENTIFIER = /_*[a-zA-Z]+[a-zA-Z0-9_-]*/
 
         # Regular expression to find all variable names in text.
         #
@@ -77,7 +77,7 @@ module Ronin
         # Regular expression to find all Base64 encoded strings in the text.
         #
         # @since 1.0.0
-        BASE64 = /(?:[A-Za-z0-9+\/]{4}\n?)+(?:[A-Za-z0-9+\/]{2}==\n?|[A-Za-z0-9+\/]{3}=\n?)?|[A-Za-z0-9+\/]{2}==\n?|[A-Za-z0-9+\/]{3}=\n?/
+        BASE64 = %r{(?:[A-Za-z0-9+/]{4}\n?)+(?:[A-Za-z0-9+/]{2}==\n?|[A-Za-z0-9+/]{3}=\n?)?|[A-Za-z0-9+/]{2}==\n?|[A-Za-z0-9+/]{3}=\n?}
 
         # Regular expression to match any single-line or multi-line C-style
         # comments.

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

@@ -31,7 +31,7 @@ module Ronin
           #
           # Generates a random String of numeric characters.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -56,7 +56,7 @@ module Ronin
           #
           # A random octal-digit string.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -79,7 +79,7 @@ module Ronin
           #
           # The upper-case hexadecimal character set.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -104,7 +104,7 @@ module Ronin
           #
           # The lower-case hexadecimal character set.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -129,7 +129,7 @@ module Ronin
           #
           # A random hexadecimal string.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -152,7 +152,7 @@ module Ronin
           #
           # The upper-case alphabetic character set.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -177,7 +177,7 @@ module Ronin
           #
           # The lower-case alphabetic character set.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -202,7 +202,7 @@ module Ronin
           #
           # A random alphabetic string.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -225,7 +225,7 @@ module Ronin
           #
           # A random alpha-numeric string.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -248,7 +248,7 @@ module Ronin
           #
           # A random punctuation string.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -271,7 +271,7 @@ module Ronin
           #
           # A random symbolic string.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -294,7 +294,7 @@ module Ronin
           #
           # A random whitespace string.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -319,7 +319,7 @@ module Ronin
           #
           # The set of printable characters, not including spaces.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -342,7 +342,7 @@ module Ronin
           #
           # The set of printable characters, including spaces.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -365,7 +365,7 @@ module Ronin
           #
           # A random control-character string.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -388,7 +388,7 @@ module Ronin
           #
           # The signed ASCII character set.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]
@@ -411,7 +411,7 @@ module Ronin
           #
           # A random ASCII string.
           #
-          # @param [Integer] n
+          # @param [Integer, Range<Integer>] n
           #   The desired length of the String.
           #
           # @return [String]