ronin-support 0.5.0 → 0.5.1

data/ChangeLog.md

@@ -1,5 +1,18 @@
+### 0.5.1 / 2012-06-29
+
+* Added {Ronin::Binary::Template#inspect}.
+* Added the `:passive` option to {Ronin::Network::FTP#ftp_connect}.
+* Forgot to require `ronin/formatting/extensions/binary/array`.
+* Fixed a bug where {Array#pack} would not accept tuples (ex: `[:uint8, 2]`).
+* Fixed a bug in {String#sql_decode} where `"\\'\\'"` would incorrectly be
+  converted to `'"'`.
+* Ensure that {Integer#pack} only accepts one argument.
+* Have {String#hex_unescape} to decode every two characters.
+* Enable passive-mode by default in {Ronin::Network::FTP#ftp_connect}.
+
 ### 0.5.0 / 2012-06-16
 
+* Require uri-query_params ~> 0.6.
 * Added {Float#pack}.
 * Added {Regexp::WORD}.
 * Added {Regexp::PHONE_NUMBER}.
@@ -51,7 +64,6 @@
 * {Ronin::Fuzzing.[]} now raises a `NoMethodError` for unknown fuzzing methods.
 * Use `module_function` in {Ronin::Fuzzing}, so the generator methods can be
   included into other Classes/Modules.
-* Require uri-query_params ~> 0.6.
 * Use `$stdout` instead of calling `Kernel.puts` or `STDOUT`.
   Prevents infinite recursion if another library overrides `Kernel.puts`.
 * Allow {Ronin::Network::DNS} methods to yield resolved addresses.

data/README.md

@@ -3,8 +3,8 @@
 * [Source](https://github.com/ronin-ruby/ronin-support)
 * [Issues](https://github.com/ronin-ruby/ronin-support/issues)
 * [Documentation](http://ronin-ruby.github.com/docs/ronin-support/frames)
-* [Mailing List](http://groups.google.com/group/ronin-ruby)
-* [irc.freenode.net #ronin](http://webchat.freenode.net/?channels=ronin&uio=Mj10cnVldd)
+* [Mailing List](https://groups.google.com/group/ronin-ruby)
+* [irc.freenode.net #ronin](http://ronin-ruby.github.com/irc/)
 
 ## Description
 
@@ -21,17 +21,19 @@ or payloads over many common Source-Code-Management (SCM) systems.
   * Formatting data:
     * Binary
     * Text
-    * HTTP
     * URIs
+    * HTTP
     * HTML
     * JavaScript
     * SQL
   * Fuzzing
   * Networking:
     * DNS
+    * UNIX
     * TCP
     * UDP
     * SSL
+    * FTP
     * SMTP / ESMTP
     * POP3
     * Imap

data/lib/ronin/binary/hexdump/parser.rb

@@ -137,10 +137,8 @@ module Ronin
           @encoding = options[:encoding]
 
           @type = case @encoding
-                  when :floats, :doubles
-                    :float
-                  else
-                    :integer
+                  when :floats, :doubles then :float
+                  else                        :integer
                   end
           @endian = options.fetch(:endian,:little)
 
@@ -164,12 +162,10 @@ module Ronin
             @word_size = WORD_SIZES.fetch(options[:encoding])
           end
 
-          case @encoding
-          when :hex_chars
-            @chars = CHARS.merge(ESCAPED_CHARS)
-          when :named_chars
-            @chars = CHARS.merge(NAMED_CHARS)
-          end
+          @chars = case @encoding
+                   when :hex_chars   then CHARS.merge(ESCAPED_CHARS)
+                   when :named_chars then CHARS.merge(NAMED_CHARS)
+                   end
         end
 
         #
@@ -352,10 +348,8 @@ module Ronin
         # @api private
         #   
         def parse_int(int)
-          if @chars
-            parse_char(int)
-          else
-            int.to_i(@base)
+          if @chars then parse_char(int)
+          else           int.to_i(@base)
           end
         end
 
@@ -383,10 +377,8 @@ module Ronin
         #  
         def parse_word(word)
           case @type
-          when :integer
-            parse_int(word)
-          when :float
-            parse_float(word)
+          when :integer then parse_int(word)
+          when :float   then parse_float(word)
           end
         end
 

data/lib/ronin/binary/struct.rb

@@ -39,7 +39,7 @@ module Ronin
     #
     #     pkt = Packet.new
     #     pkt.length = 5
-    #     pkt.data = 'hello'
+    #     pkt.data   = 'hello'
     #
     #     buffer = pkt.pack
     #     # => "\x00\x00\x00\x05hello\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
@@ -96,7 +96,7 @@ module Ronin
       #   Unpacking options.
       #
       # @option options [:little, :big, :network] :endian
-      #   The endianness to apply to types.
+      #   The endianness to apply to the types.
       #
       # @return [Struct]
       #   The newly unpacked structure.
@@ -131,10 +131,8 @@ module Ronin
       #   The structure does not contain the field.
       #
       def [](name)
-        if field?(name)
-          send(name)
-        else
-          raise(ArgumentError,"no such field '#{name}'")
+        if field?(name) then send(name)
+        else                 raise(ArgumentError,"no such field '#{name}'")
         end
       end
 
@@ -154,10 +152,8 @@ module Ronin
       #   The structure does not contain the field.
       #
       def []=(name,value)
-        if field?(name)
-          send("#{name}=",value)
-        else
-          raise(ArgumentError,"no such field '#{name}'")
+        if field?(name) then send("#{name}=",value)
+        else                 raise(ArgumentError,"no such field '#{name}'")
         end
       end
 
@@ -170,19 +166,15 @@ module Ronin
       def values
         normalize = lambda { |value|
           case value
-          when Struct
-            value.values
-          else
-            value
+          when Struct then value.values
+          else             value
           end
         }
 
         self.class.layout.map do |name|
           case (value = self[name])
-          when Array
-            value.map(&normalize)
-          else
-            normalize[value]
+          when Array then value.map(&normalize)
+          else            normalize[value]
           end
         end
       end
@@ -208,7 +200,7 @@ module Ronin
       #   Pack options.
       #
       # @option options [:little, :big, :network] :endian
-      #   The endianness to apply to types.
+      #   The endianness to apply to the types.
       #
       # @return [String]
       #   The packed structure.
@@ -227,7 +219,7 @@ module Ronin
       #   Unpack options.
       #
       # @option options [:little, :big, :network] :endian
-      #   The endianness to apply to types.
+      #   The endianness to apply to the types.
       #
       # @return [Struct]
       #   The unpacked structure.
@@ -383,10 +375,8 @@ module Ronin
       #   The endianness of the structure.
       #
       def self.endian(type=nil)
-        if type
-          @endian = type.to_sym
-        else
-          @endian
+        if type then @endian = type.to_sym
+        else         @endian
         end
       end
 
@@ -484,14 +474,10 @@ module Ronin
           end
         else
           if type.kind_of?(Symbol)
-            if Template::INT_TYPES.include?(type)
-              0
-            elsif Template::FLOAT_TYPES.include?(type)
-              0.0
-            elsif Template::CHAR_TYPES.include?(type)
-              "\0"
-            elsif Template::STRING_TYPES.include?(type)
-              ''
+            if    Template::INT_TYPES.include?(type)    then 0
+            elsif Template::FLOAT_TYPES.include?(type)  then 0.0
+            elsif Template::CHAR_TYPES.include?(type)   then "\0"
+            elsif Template::STRING_TYPES.include?(type) then ''
             end
           elsif type < Struct
             type.new

data/lib/ronin/binary/template.rb

@@ -22,7 +22,7 @@ require 'set'
 module Ronin
   module Binary
     #
-    # Provides a translation layer between C types and Ruby `Array#pack`
+    # Provides a translation layer between C-types and Ruby `Array#pack`
     # codes.
     #
     # ## Types
@@ -60,7 +60,7 @@ module Ronin
     # * `:byte` (`c`) - signed byte.
     # * `:string` (`Z*`) - binary String, `\0` terminated.
     #
-    # ### Ruby 1.9 specific types
+    # ### Ruby 1.9 specific C-types
     #
     # * `:uint16_le` (`S<`) - unsigned 16-bit integer, little endian.
     # * `:uint32_le` (`L<`) - unsigned 32-bit integer, little endian.
@@ -99,7 +99,7 @@ module Ronin
     #
     class Template
 
-      # Supported types and corresponding `Array#pack` codes.
+      # Supported C-types and corresponding `Array#pack` codes.
       TYPES = {
         :uint8  => 'C',
         :uint16 => 'S',
@@ -144,7 +144,7 @@ module Ronin
         :string => 'Z*'
       }
 
-      # Additional types, not available on Ruby 1.8:
+      # Additional C-types, not available on Ruby 1.8:
       if RUBY_VERSION > '1.9.'
         TYPES.merge!(
           :uint16_le => 'S<',
@@ -185,7 +185,7 @@ module Ronin
         )
       end
 
-      # Integer types
+      # Integer C-types
       INT_TYPES = Set[
         :uint8,
         :uint16,
@@ -246,17 +246,17 @@ module Ronin
         :long_long_be
       ]
 
-      # Float types
+      # Float C-types
       FLOAT_TYPES = Set[
         :float,    :double,
         :float_le, :double_le,
         :float_be, :double_be
       ]
 
-      # Character types
+      # Character C-types
       CHAR_TYPES = Set[:uchar, :char]
 
-      # String types
+      # String C-types
       STRING_TYPES = CHAR_TYPES + Set[:string]
 
       # Types which have little and big endian forms
@@ -275,19 +275,19 @@ module Ronin
       # Creates a new Binary Template.
       #
       # @param [Array<type, (type, length)>] fields
-      #   The types which the packer will use.
+      #   The C-types which the packer will use.
       #
       # @param [Hash] options
       #   Template options.
       #
       # @option options [:little, :big, :network] :endian
-      #   The endianness to apply to types.
+      #   The endianness to apply to the C-types.
       #
       # @raise [ArgumentError]
       #   A given type is not known.
       #
       # @note
-      #   The following types are **not supported** on Ruby 1.8:
+      #   The following C-types are **not supported** on Ruby 1.8:
       #
       #   * `:uint16_le`
       #   * `:uint32_le`
@@ -343,7 +343,7 @@ module Ronin
       #   Translation options.
       #
       # @option options [:little, :big, :network] :endian
-      #   The endianness to apply to types.
+      #   The endianness to apply to the C-types.
       #
       # @return [Symbol]
       #   The translated type.
@@ -354,10 +354,8 @@ module Ronin
       def self.translate(type,options={})
         if (options[:endian] && ENDIAN_TYPES.include?(type))
           type = case options[:endian]
-                 when :little
-                   :"#{type}_le"
-                 when :big, :network
-                   :"#{type}_be"
+                 when :little        then :"#{type}_le"
+                 when :big, :network then :"#{type}_be"
                  else
                    raise(ArgumentError,"unknown endianness: #{type}")
                  end
@@ -367,17 +365,17 @@ module Ronin
       end
 
       #
-      # Compiles binary types into an `Array#pack` / `String#unpack`
+      # Compiles C-types into an `Array#pack` / `String#unpack`
       # template.
       #
       # @param [Array<type, (type, length)>] types
-      #   The types which the packer will use.
+      #   The C-types which the packer will use.
       #
       # @param [Hash] options
       #   Type options.
       #
       # @option options [:little, :big, :network] :endian
-      #   The endianness to apply to types.
+      #   The endianness to apply to the C-types.
       #
       # @return [String]
       #   The `Array#pack` / `String#unpack` template.
@@ -439,6 +437,18 @@ module Ronin
         @template
       end
 
+      #
+      # Inspects the template.
+      #
+      # @return [String]
+      #   The inspected template.
+      #
+      # @since 1.5.1
+      #
+      def inspect
+        "<#{self.class}: #{@fields.inspect}>"
+      end
+
     end
   end
 end

data/lib/ronin/extensions/ip_addr.rb

@@ -66,12 +66,9 @@ class IPAddr
     return enum_for(__method__,text,version).to_a unless block_given?
 
     regexp = case version
-             when :ipv4, :v4, 4
-               Regexp::IPv4
-             when :ipv6, :v6, 6
-               Regexp::IPv6
-             else
-               Regexp::IP
+             when :ipv4, :v4, 4 then Regexp::IPv4
+             when :ipv6, :v6, 6 then Regexp::IPv6
+             else                    Regexp::IP
              end
 
     text.scan(regexp) do |match|
@@ -128,10 +125,8 @@ class IPAddr
       separator = '::'
       base      = 16
 
-      prefix = if cidr_or_glob.start_with?('::')
-                 '::'
-               else
-                 ''
+      prefix = if cidr_or_glob.start_with?('::') then '::'
+               else                                   ''
                end
 
       format = lambda { |address|

data/lib/ronin/extensions/resolv.rb

@@ -70,10 +70,8 @@ class Resolv
   # @api public
   #
   def Resolv.resolver(nameserver=nil)
-    if nameserver
-      DNS.new(:nameserver => nameserver)
-    else
-      self
+    if nameserver then DNS.new(:nameserver => nameserver)
+    else               self
     end
   end
 

data/lib/ronin/formatting/extensions/binary.rb

@@ -20,6 +20,7 @@
 require 'ronin/formatting/extensions/binary/integer'
 require 'ronin/formatting/extensions/binary/float'
 require 'ronin/formatting/extensions/binary/string'
+require 'ronin/formatting/extensions/binary/array'
 require 'ronin/formatting/extensions/binary/file'
 
 require 'hexdump/extensions'

data/lib/ronin/formatting/extensions/binary/array.rb

@@ -26,14 +26,14 @@ class Array
   #
   # Packs the Array into a String.
   #
-  # @param [String, Array<Symbol>] arguments
+  # @param [String, Array<Symbol, (Symbol, Integer)>] arguments
   #   The `Array#pack` template or a list of {Ronin::Binary::Template} types.
   #
   # @return [String]
   #   The packed Array.
   #
   # @raise [ArgumentError]
-  #   The arguments were not a String or a list of Symbols.
+  #   One of the arguments was not a known {Ronin::Binary::Template} type.
   #
   # @example using {Ronin::Binary::Template} types:
   #   [0x1234, "hello"].pack(:uint16_le, :string)
@@ -44,19 +44,17 @@ class Array
   #   # => "\x34\x12hello\0"
   #
   # @see http://rubydoc.info/stdlib/core/Array:pack
+  # @see Ronin::Binary::Template
   #
   # @since 0.5.0
   #
   # @api public
   #
   def pack(*arguments)
-    case arguments.first
-    when String
+    if (arguments.length == 1 && arguments.first.kind_of?(String))
       pack_original(arguments.first)
-    when Symbol
-      pack_original(Ronin::Binary::Template.compile(arguments))
     else
-      raise(ArgumentError,"first argument to Array#pack must be a String or Symbol")
+      pack_original(Ronin::Binary::Template.compile(arguments))
     end
   end