ronin-support 1.0.0 → 1.0.2

data/lib/ronin/support/binary/union.rb

@@ -37,7 +37,7 @@ module Ronin
       #       member :c, :char
       #       member :i, :int16
       #       member :u, :uint32
-      #     
+      #
       #     end
       #
       # ### Initializing Fields
@@ -54,19 +54,19 @@ module Ronin
       #       member :c, :char
       #       member :i, :int16
       #       member :u, :uint32
-      #     
+      #
       #     end
-      #     
+      #
       #     class MyUnion2 < MyUnion
-      #     
+      #
       #       member :f, :float32
       #       member :d, :float64
-      #     
+      #
       #     end
-      #     
+      #
       #     union   = MyUnion.new
       #     union.i = -1
-      #     
+      #
       #     union2   = MyUnion.new
       #     union2.i = -1
       #     union2.d = 1.123
@@ -74,13 +74,13 @@ module Ronin
       # ### Packing Unions
       #
       #     class MyUnion < Ronin::Support::Binary::Union
-      #     
+      #
       #       member :c, :char
       #       member :i, :int16
       #       member :u, :uint32
-      #     
+      #
       #     end
-      #     
+      #
       #     union = MyUnion.new
       #     union.u = 0x11111111
       #     union.i = -1
@@ -90,13 +90,13 @@ module Ronin
       # ### Unpacking Unions
       #
       #     class MyUnion < Ronin::Support::Binary::Union
-      #     
+      #
       #       member :c, :char
       #       member :i, :int32
       #       member :u, :uint32
-      #     
+      #
       #     end
-      #     
+      #
       #     union = MyUnion.unpack("\xFF\xFF\x11\x11")
       #     union.c
       #     # => "\xFF"
@@ -108,12 +108,12 @@ module Ronin
       # ### Array Fields
       #
       #     class MyUnion < Ronin::Support::Binary::Union
-      #     
+      #
       #       member :c, :char
       #       member :i, :int16
       #       member :u, :uint32
       #       member :nums, [:uint8, 10]
-      #     
+      #
       #     end
       #
       #     union = MyUnion.new
@@ -124,14 +124,14 @@ module Ronin
       # ### Unbounded Array Fields
       #
       #     class MyUnion < Ronin::Support::Binary::Union
-      #     
+      #
       #       member :c, :char
       #       member :i, :int16
       #       member :u, :uint32
       #       member :payload, (:uint8..)
-      #     
+      #
       #     end
-      #     
+      #
       #     union = MyUnion.new
       #     union.payload = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08]
       #     union.pack
@@ -140,15 +140,15 @@ module Ronin
       # ### Default Endianness
       #
       #     class MyUnion < Ronin::Support::Binary::Union
-      #     
+      #
       #       endian :big
-      #     
+      #
       #       member :c, :char
       #       member :i, :int32
       #       member :u, :uint32
-      #     
+      #
       #     end
-      #     
+      #
       #     union = MyUnion.new(u: 0xaabbccdd)
       #     union.pack
       #     # => "\xAA\xBB\xCC\xDD"

data/lib/ronin/support/binary.rb

@@ -19,6 +19,7 @@
 require 'ronin/support/binary/core_ext'
 require 'ronin/support/binary/template'
 require 'ronin/support/binary/buffer'
+require 'ronin/support/binary/cstring'
 require 'ronin/support/binary/array'
 require 'ronin/support/binary/stack'
 require 'ronin/support/binary/struct'

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

@@ -323,7 +323,6 @@ module Ronin
             end
           end
         end
-
       end
     end
   end

data/lib/ronin/support/cli/io_shell/core_ext/io.rb

@@ -40,7 +40,7 @@ class IO
   #   # NOTICE AUTH :*** Checking Ident
   #   # NOTICE AUTH :*** Found your hostname
   #   # NOTICE AUTH :*** No ident response
-  #   # USER test_ruby * * * 
+  #   # USER test_ruby * * *
   #   # NICK test_ruby
   #   # PING :3167790481
   #   # PONG 3167790481

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

@@ -34,7 +34,7 @@ module Ronin
       # NOTICE AUTH :*** Checking Ident
       # NOTICE AUTH :*** Found your hostname
       # NOTICE AUTH :*** No ident response
-      # USER test_ruby * * * 
+      # USER test_ruby * * *
       # NICK test_ruby
       # PING :3167790481
       # PONG 3167790481
@@ -123,7 +123,7 @@ module Ronin
           io_array = [@io, @stdin]
 
           loop do
-            readable, writable, errors = IO.select(io_array,nil,io_array)
+            readable, _writable, errors = IO.select(io_array,nil,io_array)
 
             if errors.include?(@io) || errors.include?(@stdin)
               return false
@@ -132,7 +132,7 @@ module Ronin
             if readable.include?(@io)
               data = begin
                        @io.readpartial(4096)
-                     rescue EOFError => error
+                     rescue EOFError
                        return false
                      end
 
@@ -142,7 +142,7 @@ module Ronin
             if readable.include?(@stdin)
               data = begin
                        @stdin.readpartial(4096)
-                     rescue EOFError => error
+                     rescue EOFError
                        return true
                      end
 

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/core_ext/file.rb

@@ -36,6 +36,13 @@ class File
   # @return [Ronin::Support::Compression::Gzip::Reader]
   #   The gzip reader object.
   #
+  # @example
+  #   File.gunzip('wordlist.gz') do |gz|
+  #     gz.each_line do |line|
+  #       # ...
+  #     end
+  #   end
+  #
   # @api public
   #
   # @since 1.0.0
@@ -59,6 +66,15 @@ class File
   # @return [Ronin::Support::Compression::Gzip::Writer]
   #   The gzip writer object.
   #
+  # @example
+  #   File.gunzip('file.gz') do |gz|
+  #     # gzip header info
+  #     gz.mtime = Time.now
+  #     gz.orig_name = 'file.txt'
+  #
+  #     gz.write('Hello World!')
+  #   end
+  #
   # @api public
   #
   # @since 1.0.0

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

@@ -16,11 +16,7 @@
 # along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/support/mixin'
-
 module Kernel
-  include Ronin::Support::Mixin
-
   #
   # Calls the given block and ignores any raised exceptions.
   #
@@ -39,10 +35,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
@@ -224,6 +224,10 @@ class File
   # @return [String]
   #   The encrypted data.
   #
+  # @example
+  #   File.encrypt('file.txt', 'aes-256-cbc', password: 's3cr3t')
+  #   # => "..."
+  #
   # @see http://rubydoc.info/stdlib/openssl/OpenSSL/Cipher
   #
   # @since 0.6.0
@@ -281,6 +285,10 @@ class File
   # @return [String]
   #   The decrypted data.
   #
+  # @example
+  #   File.decrypt('encrypted.bin', 'aes-256-cbc', password: 's3cr3t')
+  #   # => "..."
+  #
   # @see http://rubydoc.info/stdlib/openssl/OpenSSL/Cipher
   #
   # @since 0.6.0
@@ -338,6 +346,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes_encrypt('file.txt', key_size: 256, password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes_encrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -390,6 +402,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes_decrypt('encrypted.bin', key_size: 256, password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes_decrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -439,6 +455,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes128_encrypt('file.txt', password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes128_encrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -488,6 +508,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes256_decrypt('encrypted.bin', password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes128_decrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -537,6 +561,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes256_encrypt('file.txt', password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes256_encrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -586,6 +614,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes256_decrypt('encrypted.bin', password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes256_decrypt(path, block_size: 16384, output: nil, **kwargs,&block)

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

@@ -54,10 +54,10 @@ class String
 
   #
   # @return [String]
-  #   The SHA2 checksum of the String.
+  #   The SHA256 checksum of the String.
   #
   # @example
-  #   "hello".sha2
+  #   "hello".sha256
   #   # => "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
   #
   # @api public
@@ -152,6 +152,10 @@ class String
   # @return [String]
   #   The encrypted String.
   #
+  # @example
+  #   "top secret".encrypt('aes-256-cbc', password: 's3cr3t')
+  #   # => "\xF0[\x17\xDA\xA2\x82\x93\xF4\xB6s\xB5\xD8\x1F\xF2\xC6\\"
+  #
   # @see http://rubydoc.info/stdlib/openssl/OpenSSL/Cipher
   #
   # @since 0.6.0
@@ -191,6 +195,10 @@ class String
   # @return [String]
   #   The decrypted String.
   #
+  # @example
+  #  "\xF0[\x17\xDA\xA2\x82\x93\xF4\xB6s\xB5\xD8\x1F\xF2\xC6\\".decrypt('aes-256-cbc', password: 's3cr3t')
+  #  # => "top secret"
+  #
   # @see http://rubydoc.info/stdlib/openssl/OpenSSL/Cipher
   #
   # @since 0.6.0
@@ -236,6 +244,10 @@ class String
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   "top secret".aes_encrypt(key_size: 256, password: 's3cr3t')
+  #   # => "\xF0[\x17\xDA\xA2\x82\x93\xF4\xB6s\xB5\xD8\x1F\xF2\xC6\\"
+  #
   # @since 1.0.0
   #
   def aes_encrypt(**kwargs)
@@ -275,6 +287,10 @@ class String
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   "\xF0[\x17\xDA\xA2\x82\x93\xF4\xB6s\xB5\xD8\x1F\xF2\xC6\\".aes_decrypt(key_size: 256, password: 's3cr3t')
+  #   # => "top secret"
+  #
   # @since 1.0.0
   #
   def aes_decrypt(**kwargs)
@@ -311,6 +327,10 @@ class String
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   "top secret".aes128_encrypt(password: 's3cr3t')
+  #   # => "\x88\xA53\xE9|\xE2\x8E\xA0\xABv\xCF\x94\x17\xBB*\xC5"
+  #
   # @since 1.0.0
   #
   def aes128_encrypt(**kwargs)
@@ -347,6 +367,10 @@ class String
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   "\x88\xA53\xE9|\xE2\x8E\xA0\xABv\xCF\x94\x17\xBB*\xC5".aes128_decrypt(password: 's3cr3t')
+  #   # => "top secret"
+  #
   # @since 1.0.0
   #
   def aes128_decrypt(**kwargs)
@@ -383,6 +407,10 @@ class String
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   "top secret".aes256_encrypt(password: 's3cr3t')
+  #   # => "\xF0[\x17\xDA\xA2\x82\x93\xF4\xB6s\xB5\xD8\x1F\xF2\xC6\\"
+  #
   # @since 1.0.0
   #
   def aes256_encrypt(**kwargs)
@@ -419,6 +447,10 @@ class String
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   "\xF0[\x17\xDA\xA2\x82\x93\xF4\xB6s\xB5\xD8\x1F\xF2\xC6\\".aes256_decrypt(password: 's3cr3t')
+  #   # => "top secret"
+  #
   # @since 1.0.0
   #
   def aes256_decrypt(**kwargs)

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)