ronin-support 1.0.0.beta3 → 1.0.1

data/lib/ronin/support/cli/printing.rb

@@ -27,7 +27,7 @@ module Ronin
       # @since 1.0.0
       #
       module Printing
-        @@debug = false
+        @debug = false
 
         #
         # The current debug mode.
@@ -38,7 +38,7 @@ module Ronin
         # @api semipublic
         #
         def self.debug?
-          @@debug
+          @debug
         end
 
         #
@@ -53,7 +53,7 @@ module Ronin
         # @api semipublic
         #
         def self.debug=(debug_mode)
-          @@debug = debug_mode
+          @debug = debug_mode
         end
 
         # Enables or disables debug mode.

data/lib/ronin/support/compression/zlib.rb

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

data/lib/ronin/support/core_ext/enumerable.rb

@@ -17,7 +17,6 @@
 #
 
 module Enumerable
-
   #
   # Maps the elements to a Hash.
   #
@@ -49,5 +48,4 @@ module Enumerable
     each { |element| new_hash[element] }
     return new_hash
   end
-
 end

data/lib/ronin/support/core_ext/file.rb

@@ -104,7 +104,7 @@ class File
     path = expand_path(File.join('/',path))
 
     # remove the leading slash
-    return path[1..-1]
+    return path[1..]
   end
 
 end

data/lib/ronin/support/core_ext/kernel.rb

@@ -39,10 +39,11 @@ module Kernel
   # @api public
   #
   def try
-    begin
-      yield() if block_given?
-    rescue Exception
-      return nil
-    end
+    yield() if block_given?
+  rescue SyntaxError => error
+    # re-raise syntax errors
+    raise(error)
+  rescue StandardError
+    # ignore any exceptions
   end
 end

data/lib/ronin/support/core_ext/string.rb

@@ -199,7 +199,7 @@ class String
       other_index = (other.length - i - 1)
 
       if self[index] != other[other_index]
-        return self[(index + 1)..-1]
+        return self[(index + 1)..]
       end
     end
 
@@ -220,7 +220,7 @@ class String
   #
   def uncommon_substring(other)
     prefix  = common_prefix(other)
-    postfix = self[prefix.length..-1].common_suffix(other[prefix.length..-1])
+    postfix = self[prefix.length..].common_suffix(other[prefix.length..])
 
     return self[prefix.length...(length - postfix.length)]
   end

data/lib/ronin/support/crypto/cert.rb

@@ -66,7 +66,7 @@ module Ronin
           #   The populated name.
           #
           def self.build(common_name: nil, organizational_unit: nil, organization: nil, locality: nil, state: nil, province: nil, country: nil)
-            name = new()
+            name = new
             name.add_entry("CN",common_name)         if common_name
             name.add_entry("OU",organizational_unit) if organizational_unit
             name.add_entry("O",organization)         if organization
@@ -83,9 +83,7 @@ module Ronin
           # @return [Hash{String => String}]
           #
           def entries
-            @entries ||= Hash[to_a.map { |(oid,value,type)|
-              [oid, value]
-            }]
+            @entries ||= to_a.to_h { |(oid,value,type)| [oid, value] }
           end
 
           alias to_h entries
@@ -328,7 +326,7 @@ module Ronin
         def self.generate(version:    2,
                           serial:     0,
                           not_before: Time.now,
-                          not_after:  not_before+ONE_YEAR,
+                          not_after:  not_before + ONE_YEAR,
                           subject:    nil,
                           extensions: nil,
                           # signing arguments
@@ -336,9 +334,10 @@ module Ronin
                           ca_cert: nil,
                           ca_key:  nil,
                           signing_hash: :sha256)
-          cert = new()
+          cert = new
+
           cert.version = version
-          cert.serial  = if ca_cert then ca_cert.serial+1
+          cert.serial  = if ca_cert then ca_cert.serial + 1
                          else            serial
                          end
 
@@ -351,11 +350,10 @@ module Ronin
                             end
 
           if extensions
-            extension_factory = OpenSSL::X509::ExtensionFactory.new()
+            extension_factory = OpenSSL::X509::ExtensionFactory.new
+
             extension_factory.subject_certificate = cert
-            extension_factory.issuer_certificate  = if ca_cert then ca_cert
-                                                    else            cert
-                                                    end
+            extension_factory.issuer_certificate  = ca_cert || cert
 
             extensions.each do |name,(value,critical)|
               ext = extension_factory.create_extension(name,value,critical)
@@ -363,9 +361,7 @@ module Ronin
             end
           end
 
-          signing_key = if ca_key then ca_key
-                        else           key
-                        end
+          signing_key    = ca_key || key
           signing_digest = OpenSSL::Digest.const_get(signing_hash.upcase).new
 
           cert.sign(signing_key,signing_digest)
@@ -421,7 +417,7 @@ module Ronin
         #   The Hash of extension OID names and extension objects.
         #
         def extensions_hash
-          Hash[extensions.map { |ext| [ext.oid, ext] }]
+          extensions.to_h { |ext| [ext.oid, ext] }
         end
 
         #

data/lib/ronin/support/crypto/cert_chain.rb

@@ -59,7 +59,7 @@ module Ronin
         #
         def self.parse(string)
           cert_buffer = String.new
-          certs = []
+          certs       = []
 
           string.each_line do |line|
             cert_buffer << line

data/lib/ronin/support/crypto/cipher/aes.rb

@@ -22,6 +22,9 @@ module Ronin
   module Support
     module Crypto
       class Cipher < OpenSSL::Cipher
+        #
+        # The AES cipher.
+        #
         class AES < Cipher
 
           # The AES cipher key size.

data/lib/ronin/support/crypto/cipher/aes128.rb

@@ -22,6 +22,9 @@ module Ronin
   module Support
     module Crypto
       class Cipher < OpenSSL::Cipher
+        #
+        # The AES128 cipher.
+        #
         class AES128 < AES
 
           #
@@ -44,7 +47,7 @@ module Ronin
           #   The list of supported AES 128bit cipher names.
           #
           def self.supported
-            super().grep(/^aes[-]?128/)
+            super().grep(/^aes(?:-)?128/)
           end
 
         end

data/lib/ronin/support/crypto/cipher/aes256.rb

@@ -22,6 +22,9 @@ module Ronin
   module Support
     module Crypto
       class Cipher < OpenSSL::Cipher
+        #
+        # The AES256 cipher.
+        #
         class AES256 < AES
 
           #
@@ -44,7 +47,7 @@ module Ronin
           #   The list of supported AES 256bit cipher names.
           #
           def self.supported
-            super().grep(/^aes[-]?256/)
+            super().grep(/^aes(?:-)?256/)
           end
 
         end

data/lib/ronin/support/crypto/cipher.rb

@@ -43,7 +43,7 @@ module Ronin
       # @see https://rubydoc.info/stdlib/openssl/OpenSSL/Cipher.html
       #
       # @since 1.0.0
-      # 
+      #
       # @api public
       #
       class Cipher < OpenSSL::Cipher

data/lib/ronin/support/crypto/core_ext/file.rb

@@ -172,7 +172,7 @@ class File
   def self.hmac(path, key: , digest: :sha1)
     hmac = Ronin::Support::Crypto.hmac(key: key, digest: digest)
 
-    open(path,'rb') do |file|
+    File.open(path,'rb') do |file|
       until file.eof?
         hmac.update(file.read(16384))
       end

data/lib/ronin/support/crypto/key/methods.rb

@@ -40,6 +40,9 @@ module Ronin
             key_class.extend ClassMethods
           end
 
+          #
+          # Class-methods.
+          #
           module ClassMethods
             #
             # Generates a new random key.
@@ -151,7 +154,7 @@ module Ronin
                          cipher = OpenSSL::Cipher.new(cipher)
                          encoding_method.call(cipher,password)
                        else
-                         encoding_method.call()
+                         encoding_method.call
                        end
 
             File.write(path,exported)

data/lib/ronin/support/crypto/key.rb

@@ -24,6 +24,9 @@ require 'ronin/support/crypto/key/rsa'
 module Ronin
   module Support
     module Crypto
+      #
+      # Top-level methods for working with public/private keys.
+      #
       module Key
         #
         # Parses an PEM encoded key.
@@ -42,7 +45,7 @@ module Ronin
         #
         # @raise [ArgumentError]
         #   The key type could not be determined from the key file.
-        #   
+        #
         # @api public
         #
         def self.parse(key, password: nil)
@@ -93,7 +96,7 @@ module Ronin
         #
         # @raise [ArgumentError]
         #   The key type could not be determined from the key file.
-        #   
+        #
         # @api public
         #
         def self.load_file(path)

data/lib/ronin/support/crypto/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/crypto.rb

@@ -656,7 +656,6 @@ module Ronin
           when Key::RSA           then key
           when OpenSSL::PKey::RSA then Key::RSA.new(key)
           when String             then Key::RSA.load(key, password: password)
-          else
           end
         else
           raise(ArgumentError,"either key: or key_file: keyword arguments must be given")

data/lib/ronin/support/encoding/base16.rb

@@ -51,7 +51,7 @@ module Ronin
           encoded = String.new
 
           data.each_byte do |byte|
-            encoded << "%.2x" % byte
+            encoded << ("%.2x" % byte)
           end
 
           return encoded

data/lib/ronin/support/encoding/base32.rb

@@ -72,14 +72,16 @@ module Ronin
           return decoded
         end
 
-        private
-
         # Base32 alphabet
+        #
+        # @api private
         TABLE = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'
 
         #
         # Represents a chunk of data.
         #
+        # @api private
+        #
         class Chunk
 
           #
@@ -103,8 +105,13 @@ module Ronin
           #
           def decode(output=String.new)
             bytes = @bytes.take_while { |b| b != 61 } # strip padding
-            n = (bytes.length * 5.0 / 8.0).floor
-            p = bytes.length < 8 ? 5 - (n * 8) % 5 : 0
+
+            n = ((bytes.length * 5.0) / 8.0).floor
+            p = if bytes.length < 8
+                  5 - ((n * 8) % 5)
+                else
+                  0
+                end
             c = bytes.reduce(0) { |m,o|
               unless (i = Base32::TABLE.index(o.chr))
                 raise ArgumentError, "invalid character '#{o.chr}'"
@@ -113,8 +120,8 @@ module Ronin
               (m << 5) + i
             } >> p
 
-            (0..n-1).reverse_each.each do |i|
-              output << ((c >> i * 8) & 0xff).chr
+            (0..(n - 1)).reverse_each do |i|
+              output << ((c >> (i * 8)) & 0xff).chr
             end
 
             return output
@@ -130,15 +137,19 @@ module Ronin
           #   The Base32 encoded chunk.
           #
           def encode(output=String.new)
-            n = (@bytes.length * 8.0 / 5.0).ceil
-            p = n < 8 ? 5 - (@bytes.length * 8) % 5 : 0
-            c = @bytes.inject(0) {|m,o| (m << 8) + o} << p
-
-            (0..n-1).reverse_each do |i|
-              output << Base32::TABLE[(c >> i * 5) & 0x1f].chr
+            n = ((@bytes.length * 8.0) / 5.0).ceil
+            p = if n < 8
+                  5 - ((@bytes.length * 8) % 5)
+                else
+                  0
+                end
+            c = @bytes.inject(0) { |m,o| (m << 8) + o } << p
+
+            (0..(n - 1)).reverse_each do |i|
+              output << Base32::TABLE[(c >> (i * 5)) & 0x1f].chr
             end
 
-            return output << ("=" * (8-n))
+            return output << ("=" * (8 - n))
           end
 
         end
@@ -154,11 +165,11 @@ module Ronin
         #
         # @yieldparam [Chunk] chunk
         #
+        # @api private
+        #
         def self.each_chunk(data,size)
-          bytes  = data.bytes
-
-          data.bytes.each_slice(size) do |bytes|
-            yield Chunk.new(bytes)
+          data.bytes.each_slice(size) do |byte_slice|
+            yield Chunk.new(byte_slice)
           end
         end
       end

data/lib/ronin/support/encoding/c/core_ext/integer.rb

@@ -29,7 +29,7 @@ class Integer
   # @raise [RangeError]
   #   The integer value is negative.
   #
-  # @example 
+  # @example
   #   0x41.c_escape
   #   # => "A"
   #   0x22.c_escape

data/lib/ronin/support/encoding/c.rb

@@ -93,7 +93,7 @@ module Ronin
         # @raise [RangeError]
         #   The integer value is negative.
         #
-        # @example 
+        # @example
         #   Encoding::C.escape_byte(0x41)
         #   # => "A"
         #   Encoding::C.escape_byte(0x22)
@@ -223,11 +223,11 @@ module Ronin
           until scanner.eos?
             unescaped << case (char = scanner.getch)
                          when "\\" # backslash
-                           if (hex_char = scanner.scan(/x[0-9a-fA-F]{1,2}/)) # \xXX
+                           if (hex_char        = scanner.scan(/x[0-9a-fA-F]{1,2}/)) # \xXX
                              hex_char[1..].to_i(16).chr
-                           elsif (hex_char = scanner.scan(/u[0-9a-fA-F]{4,8}/)) # \u..
+                           elsif (hex_char     = scanner.scan(/u[0-9a-fA-F]{4,8}/)) # \u..
                              hex_char[1..].to_i(16).chr(Encoding::UTF_8)
-                           elsif (octal_char = scanner.scan(/[0-7]{1,3}/)) # \N, \NN, or \NNN
+                           elsif (octal_char   = scanner.scan(/[0-7]{1,3}/)) # \N, \NN, or \NNN
                              octal_char.to_i(8).chr
                            elsif (special_char = scanner.getch) # \[A-Za-z]
                              BACKSLASHED_CHARS.fetch(special_char,special_char)

data/lib/ronin/support/encoding/hex.rb

@@ -198,11 +198,11 @@ module Ronin
           until scanner.eos?
             buffer << case (char = scanner.getch)
                       when '\\'
-                        if (hex_escape = scanner.scan(/x[0-9a-fA-F]{4,8}/))
+                        if (hex_escape    = scanner.scan(/x[0-9a-fA-F]{4,8}/))
                           hex_escape[1..].to_i(16).chr(Encoding::UTF_8)
                         elsif (hex_escape = scanner.scan(/x[0-9a-fA-F]{1,2}/))
                           hex_escape[1..].to_i(16).chr
-                        elsif (char = scanner.getch)
+                        elsif (char       = scanner.getch)
                           BACKSLASHED_CHARS.fetch(char,char)
                         end
                       else

data/lib/ronin/support/encoding/js/core_ext/integer.rb

@@ -26,7 +26,7 @@ class Integer
   # @return [String]
   #   The escaped JavaScript character.
   #
-  # @example 
+  # @example
   #   0x41.js_escape
   #   # => "A"
   #   0x22.js_escape

data/lib/ronin/support/encoding/js.rb

@@ -86,7 +86,7 @@ module Ronin
         # @return [String]
         #   The escaped JavaScript character.
         #
-        # @example 
+        # @example
         #   Encoding::JS.escape_byte(0x41)
         #   # => "A"
         #   Encoding::JS.escape_byte(0x22)
@@ -135,7 +135,7 @@ module Ronin
           "\\f"  => "\f",
           "\\r"  => "\r",
           "\\\"" => "\"",
-          "\\\'" => "'",
+          "\\'"  => "'",
           "\\\\" => "\\"
         }
 
@@ -187,9 +187,9 @@ module Ronin
           data.scan(/[\\%]u[0-9a-fA-F]{1,4}|[\\%][0-9a-fA-F]{1,2}|\\[btnfr\'\"\\]|./) do |c|
             unescaped << BACKSLASHED_CHARS.fetch(c) do
                            if (c.start_with?("\\u") || c.start_with?("%u"))
-                             c[2..-1].to_i(16)
+                             c[2..].to_i(16)
                            elsif (c.start_with?("\\") || c.start_with?("%"))
-                             c[1..-1].to_i(16)
+                             c[1..].to_i(16)
                            else
                              c
                            end

data/lib/ronin/support/encoding/powershell/core_ext/integer.rb

@@ -29,7 +29,7 @@ class Integer
   # @raise [RangeError]
   #   The integer value is negative.
   #
-  # @example 
+  # @example
   #   0x41.powershell_encode
   #   # => "[char]0x41"
   #   0x0a.powershell_encode
@@ -60,7 +60,7 @@ class Integer
   # @raise [RangeError]
   #   The integer value is negative.
   #
-  # @example 
+  # @example
   #   0x41.powershell_escape
   #   # => "A"
   #   0x08.powershell_escape

data/lib/ronin/support/encoding/powershell.rb

@@ -68,7 +68,7 @@ module Ronin
         # @raise [RangeError]
         #   The integer value is negative.
         #
-        # @example 
+        # @example
         #   Encoding::PowerShell.encode_byte(0x41)
         #   # => "[char]0x41"
         #   Encoding::PowerShell.encode_byte(0x0a)
@@ -100,7 +100,7 @@ module Ronin
         # @raise [RangeError]
         #   The integer value is negative.
         #
-        # @example 
+        # @example
         #   Encoding::PowerShell.escape_byte(0x41)
         #   # => "A"
         #   Encoding::PowerShell.escape_byte(0x08)
@@ -197,9 +197,9 @@ module Ronin
           until scanner.eos?
             unescaped << if (backslash_char = scanner.scan(/`[0abetnvfr]/)) # `c
                            BACKSLASHED_CHARS[backslash_char[1,1]]
-                         elsif (hex_char = scanner.scan(/\$\(\[char\]0x[0-9a-fA-F]{1,2}\)/)) # [char]0xXX
+                         elsif (hex_char     = scanner.scan(/\$\(\[char\]0x[0-9a-fA-F]{1,2}\)/)) # [char]0xXX
                            hex_char[10..-2].to_i(16).chr
-                         elsif (hex_char = scanner.scan(/\$\(\[char\]0x[0-9a-fA-F]{3,}\)/)) # [char]0xXX
+                         elsif (hex_char     = scanner.scan(/\$\(\[char\]0x[0-9a-fA-F]{3,}\)/)) # [char]0xXX
                            hex_char[10..-2].to_i(16).chr(Encoding::UTF_8)
                          elsif (unicode_char = scanner.scan(/`u\{[0-9a-fA-F]+\}/)) # `u{XXXX}'
                            unicode_char[3..-2].to_i(16).chr(Encoding::UTF_8)
@@ -299,7 +299,6 @@ module Ronin
             data
           end
         end
-
       end
     end
   end

data/lib/ronin/support/encoding/ruby.rb

@@ -150,6 +150,7 @@ module Ronin
           else                    char
           end
         end
+
         UNESCAPE_CHARS['\0'] = "\0"
         UNESCAPE_CHARS['\a'] = "\a"
         UNESCAPE_CHARS['\b'] = "\b"
@@ -180,10 +181,10 @@ module Ronin
             unescaped << if (unicode_escape = scanner.scan(/\\(?:[0-7]{1,3}|[0-7])/))
                            unicode_escape[1,3].to_i(8).chr
                          elsif (hex_escape = scanner.scan(/\\u[0-9a-fA-F]{4,8}/))
-                           hex_escape[2..-1].to_i(16).chr(Encoding::UTF_8)
+                           hex_escape[2..].to_i(16).chr(Encoding::UTF_8)
                          elsif (hex_escape = scanner.scan(/\\x[0-9a-fA-F]{1,2}/))
-                           hex_escape[2..-1].to_i(16).chr
-                         elsif (escape = scanner.scan(/\\./))
+                           hex_escape[2..].to_i(16).chr
+                         elsif (escape     = scanner.scan(/\\./))
                            UNESCAPE_CHARS[escape]
                          else
                            scanner.getch
@@ -235,7 +236,6 @@ module Ronin
             data
           end
         end
-
       end
     end
   end

data/lib/ronin/support/encoding/shell/core_ext/integer.rb

@@ -29,7 +29,7 @@ class Integer
   # @raise [RangeError]
   #   The integer value is negative.
   #
-  # @example 
+  # @example
   #   0x41.shell_encode
   #   # => "\\x41"
   #   0x0a.shell_encode
@@ -61,7 +61,7 @@ class Integer
   # @raise [RangeError]
   #   The integer value is negative.
   #
-  # @example 
+  # @example
   #   0x41.shell_escape
   #   # => "A"
   #   0x08.shell_escape

data/lib/ronin/support/encoding/shell.rb

@@ -66,7 +66,7 @@ module Ronin
         # @raise [RangeError]
         #   The byte value is negative.
         #
-        # @example 
+        # @example
         #   Encoding::Shell.encode_byte(0x41)
         #   # => "\\x41"
         #   Encoding::Shell.encode_byte(0x0a)
@@ -98,7 +98,7 @@ module Ronin
         # @raise [RangeError]
         #   The integer value is negative.
         #
-        # @example 
+        # @example
         #   Encoding::Shell.escape(0x41)
         #   # => "A"
         #   Encoding::Shell.escape(0x08)
@@ -188,7 +188,7 @@ module Ronin
           until scanner.eos?
             unescaped << if (backslash_char = scanner.scan(/\\[0abetnvfr\'\"]/)) # \n
                            BACKSLASHED_CHARS[backslash_char[1..]]
-                         elsif (hex_char = scanner.scan(/\\x[0-9a-fA-F]+/)) # \XX
+                         elsif (hex_char     = scanner.scan(/\\x[0-9a-fA-F]+/)) # \XX
                            hex_char[2..].to_i(16).chr
                          elsif (unicode_char = scanner.scan(/\\u[0-9a-fA-F]+/)) # \uXXXX
                            unicode_char[2..].to_i(16).chr(Encoding::UTF_8)

data/lib/ronin/support/encoding/sql.rb

@@ -116,7 +116,7 @@ module Ronin
         #   The decoded String.
         #
         def self.decode(data)
-          if (data =~ /^[0-9a-fA-F]{2,}$/ && (data.length % 2 == 0))
+          if (data =~ /^[0-9a-fA-F]{2,}$/ && data.length.even?)
             raw = String.new
 
             data.scan(/../) do |hex_char|