ronin-support 0.4.1 → 0.5.2

data/lib/ronin/extensions/resolv.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# Ronin Support is distributed in the hope that it will be useful,
+# ronin-support is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'resolv'
@@ -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/extensions/string.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# Ronin Support is distributed in the hope that it will be useful,
+# ronin-support is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 class String
@@ -46,7 +46,7 @@ class String
   # @api public
   #
   def each_substring(min=1,&block)
-    return enum_for(:each_substring,min) unless block
+    return enum_for(__method__,min) unless block
 
     (0..(length - min)).each do |i|
       ((i + min)..length).each do |j|
@@ -92,7 +92,7 @@ class String
   # @api public
   #
   def each_unique_substring(min=1,&block)
-    return enum_for(:each_unique_substring,min) unless block
+    return enum_for(__method__,min) unless block
 
     unique_strings = {}
 
@@ -137,7 +137,7 @@ class String
   #
   # Finds the common suffix of the string and the specified other string.
   #
-  # @param [String] pther
+  # @param [String] other
   #   The other String to compare against.
   #
   # @return [String]
@@ -175,14 +175,14 @@ class String
   end
 
   #
-  # Finds the uncommon substring within the specified other string,
+  # Finds the uncommon sub-string within the specified other string,
   # which does not occur within the string.
   #
   # @param [String] other
   #   The other String to compare against.
   #
   # @return [String]
-  #   The uncommon substring between the two Strings.
+  #   The uncommon sub-string between the two Strings.
   #
   # @api public
   #

data/lib/ronin/formatting.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# Ronin Support is distributed in the hope that it will be useful,
+# ronin-support is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'ronin/formatting/extensions'

data/lib/ronin/formatting/binary.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# Ronin Support is distributed in the hope that it will be useful,
+# ronin-support is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'ronin/formatting/extensions/binary'

data/lib/ronin/formatting/digest.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# Ronin Support is distributed in the hope that it will be useful,
+# ronin-support is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'ronin/formatting/extensions/digest'

data/lib/ronin/formatting/extensions.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# Ronin Support is distributed in the hope that it will be useful,
+# ronin-support is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'ronin/formatting/extensions/binary'

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

@@ -1,24 +1,26 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# Ronin Support is distributed in the hope that it will be useful,
+# ronin-support is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 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

@@ -0,0 +1,61 @@
+#
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-support.
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/binary/template'
+
+class Array
+
+  alias pack_original pack
+
+  #
+  # Packs the Array into a String.
+  #
+  # @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]
+  #   One of the arguments was not a known {Ronin::Binary::Template} type.
+  #
+  # @example using {Ronin::Binary::Template} types:
+  #   [0x1234, "hello"].pack(:uint16_le, :string)
+  #   # => "\x34\x12hello\0"
+  #
+  # @example using a `String#unpack` template:
+  #   [0x1234, "hello"].pack('vZ*')
+  #   # => "\x34\x12hello\0"
+  #
+  # @see https://rubydoc.info/stdlib/core/Array:pack
+  # @see Ronin::Binary::Template
+  #
+  # @since 0.5.0
+  #
+  # @api public
+  #
+  def pack(*arguments)
+    if (arguments.length == 1 && arguments.first.kind_of?(String))
+      pack_original(arguments.first)
+    else
+      pack_original(Ronin::Binary::Template.compile(arguments))
+    end
+  end
+
+end

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

@@ -0,0 +1,106 @@
+#
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-support.
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'base64'
+
+#
+# Adds Ruby 1.9 specific methods when running on Ruby 1.8.7.
+#
+module Base64
+  if RUBY_VERSION < '1.9.'
+    module_function
+
+    #
+    # Strictly encodes a base64 String.
+    #
+    # @param [String] bin
+    #   The String to encode.
+    #
+    # @return [String]
+    #   The strictly encoded base64 String.
+    #
+    # @note
+    #   This method complies with RFC 4648.
+    #   No line feeds are added.
+    #
+    def strict_encode64(bin)
+      encode64(bin).tr("\n",'')
+    end
+
+    #
+    # Decodes a strictly base64 encoded String.
+    #
+    # @param [String] str
+    #   The strictly encoded base64 String.
+    #
+    # @return [String]
+    #   The decoded String.
+    #
+    # @raise [ArgumentError]
+    #   The String is incorrectly padded or contains non-alphabet characters.
+    #   Note: CR or LF are also rejected.
+    #
+    # @note
+    #   This method complies with RFC 4648.
+    #
+    def strict_decode64(str)
+      unless str.include?("\n")
+        decode64(str)
+      else
+        raise(ArgumentError,"invalid base64")
+      end
+    end
+
+    #
+    # Encodes a URL-safe base64 String.
+    #
+    # @param [String] bin
+    #   The String to encode.
+    #
+    # @return [String]
+    #   The URL-safe encoded base64 String.
+    #
+    # @note
+    #   This method complies with ``Base 64 Encoding with URL and filename Safe
+    #   Alphabet'' in RFC 4648.
+    #   The alphabet uses '-' instead of '+' and '_' instead of '/'.
+    #
+    def urlsafe_encode64(bin)
+      strict_encode64(bin).tr("+/", "-_")
+    end
+
+    #
+    # Decodes a URL-safe base64 encoded String.
+    #
+    # @param [String] str
+    #   The URL-safe encoded base64 String.
+    #
+    # @return [String]
+    #   The decoded String.
+    #
+    # @note
+    #   This method complies with ``Base 64 Encoding with URL and filename Safe
+    #   Alphabet'' in RFC 4648.
+    #   The alphabet uses '-' instead of '+' and '_' instead of '/'.
+    #
+    def urlsafe_decode64(str)
+      strict_decode64(str.tr("-_", "+/"))
+    end
+  end
+end

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

@@ -1,23 +1,23 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# Ronin Support is distributed in the hope that it will be useful,
+# ronin-support is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/formatting/extensions/binary/string'
+require 'ronin/binary/hexdump/parser'
 
 class File
 
@@ -28,17 +28,50 @@ class File
   #   The path of the hexdump file.
   #
   # @param [Hash] options
-  #   Hexdump options.
+  #   Additional options.
   #
-  # @return [String]
-  #   The original binary data.
+  # @option options [Symbol] :format
+  #   The expected format of the hexdump. Must be either `:od` or
+  #   `:hexdump`.
+  #
+  # @option options [Symbol] :encoding
+  #   Denotes the encoding used for the bytes within the hexdump.
+  #   Must be one of the following:
+  #
+  #   * `:binary`
+  #   * `:octal`
+  #   * `:octal_bytes`
+  #   * `:octal_shorts`
+  #   * `:octal_ints`
+  #   * `:octal_quads` (Ruby 1.9 only)
+  #   * `:decimal`
+  #   * `:decimal_bytes`
+  #   * `:decimal_shorts`
+  #   * `:decimal_ints`
+  #   * `:decimal_quads` (Ruby 1.9 only)
+  #   * `:hex`
+  #   * `:hex_chars`
+  #   * `:hex_bytes`
+  #   * `:hex_shorts`
+  #   * `:hex_ints`
+  #   * `:hex_quads`
+  #   * `:named_chars` (Ruby 1.9 only)
+  #   * `:floats`
+  #   * `:doubles`
   #
-  # @see String#unhexdump.
+  # @option options [:little, :big, :network] :endian (:little)
+  #   The endianness of the words.
+  #
+  # @option options [Integer] :segment (16)
+  #   The length in bytes of each segment in the hexdump.
+  #
+  # @return [String]
+  #   The raw-data from the hexdump.
   #
   # @api public
   #
   def File.unhexdump(path,options={})
-    File.read(path).unhexdump(options)
+    Ronin::Binary::Hexdump::Parser.new(options).parse(File.new(path))
   end
 
 end