ronin-support 0.5.2 → 1.0.0.beta2

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

@@ -1,345 +0,0 @@
-#
-# 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/formatting/extensions/binary/base64'
-require 'ronin/formatting/extensions/binary/integer'
-require 'ronin/formatting/extensions/text/string'
-require 'ronin/binary/hexdump/parser'
-require 'ronin/binary/template'
-
-begin
-  require 'zlib'
-rescue ::LoadError
-  $stderr.puts "WARNING: Ruby was not compiled with zlib support"
-end
-
-class String
-
-  alias unpack_original unpack
-
-  #
-  # Unpacks the String.
-  #
-  # @param [String, Array<Symbol, (Symbol, Integer)>] arguments
-  #   The `String#unpack` template or a list of {Ronin::Binary::Template} types.
-  #
-  # @return [Array]
-  #   The values unpacked from the String.
-  #
-  # @raise [ArgumentError]
-  #   One of the arguments was not a known {Ronin::Binary::Template} type.
-  #
-  # @example using {Ronin::Binary::Template} types:
-  #   "A\0\0\0hello\0".unpack(:uint32_le, :string)
-  #   # => [10, "hello"]
-  #
-  # @example using a `String#unpack` template:
-  #   "A\0\0\0".unpack('V')
-  #   # => 65
-  #
-  # @see https://rubydoc.info/stdlib/core/String:unpack
-  # @see Ronin::Binary::Template
-  #
-  # @since 0.5.0
-  #
-  # @api public
-  #
-  def unpack(*arguments)
-    if (arguments.length == 1 && arguments.first.kind_of?(String))
-      unpack_original(arguments.first)
-    else
-      unpack_original(Ronin::Binary::Template.compile(arguments))
-    end
-  end
-
-  #
-  # Unpacks the String into an Integer.
-  #
-  # @param [Ronin::Arch, #endian, #address_length, String] arch
-  #   The architecture that the Integer was originally packed with.
-  #
-  # @param [Integer] address_length
-  #   The number of bytes to depack.
-  #
-  # @return [Integer]
-  #   The depacked Integer.
-  #
-  # @raise [ArgumentError]
-  #   The given `arch` does not respond to the `endian` or `address_length`
-  #   methods.
-  #
-  # @example using archs other than `Ronin::Arch`:
-  #   arch = OpenStruct.new(:endian => :little, :address_length => 4)
-  #   
-  #   "A\0\0\0".depack(arch)
-  #   # => 65
-  #
-  # @example using a `Ronin::Arch` arch:
-  #   "A\0\0\0".depack(Arch.i386)
-  #   # => 65
-  #
-  # @example specifying a custom address-length:
-  #   "A\0".depack(Arch.ppc,2)
-  #   # => 65
-  #
-  # @example using a `String#unpack` template:
-  #   "A\0\0\0".depack('V')
-  #   # => 65
-  #
-  # @deprecated
-  #   Deprecated as of 0.5.0, use {#unpack} instead.
-  #
-  # @api public
-  #   
-  def depack(arch,address_length=nil)
-    if arch.kind_of?(String)
-      return unpack(arch)
-    end
-
-    unless arch.respond_to?(:address_length)
-      raise(ArgumentError,"first argument to Ineger#pack must respond to address_length")
-    end
-
-    unless arch.respond_to?(:endian)
-      raise(ArgumentError,"first argument to Ineger#pack must respond to endian")
-    end
-
-    endian           = arch.endian.to_sym
-    address_length ||= arch.address_length
-
-    integer    = 0x0
-    byte_index = 0
-
-    case endian
-    when :little
-      mask = lambda { |b| b << (byte_index * 8) }
-    when :big
-      mask = lambda { |b|
-        b << ((address_length - byte_index - 1) * 8)
-      }
-    else
-      raise(ArgumentError,"invalid endian #{arch.endian.inspect}")
-    end
-
-    each_byte do |b|
-      break if byte_index >= address_length
-
-      integer |= mask.call(b)
-      byte_index += 1
-    end
-
-    return integer
-  end
-
-  #
-  # Hex-escapes characters in the String.
-  #
-  # @return [String]
-  #   The hex escaped version of the String.
-  #
-  # @example
-  #   "hello".hex_escape
-  #   # => "\\x68\\x65\\x6c\\x6c\\x6f"
-  #
-  # @see String#format_bytes
-  #
-  # @api public
-  #
-  def hex_escape(options={})
-    format_bytes(options) { |b| b.hex_escape }
-  end
-
-  alias hex_unescape unescape
-
-  #
-  # XOR encodes the String.
-  #
-  # @param [Enumerable, Integer] key
-  #   The byte to XOR against each byte in the String.
-  #
-  # @return [String]
-  #   The XOR encoded String.
-  #
-  # @example
-  #   "hello".xor(0x41)
-  #   # => ")$--."
-  #
-  # @example
-  #   "hello again".xor([0x55, 0x41, 0xe1])
-  #   # => "=$\x8d9.\xc14&\x80</"
-  #
-  # @api public
-  #
-  def xor(key)
-    key = case key
-          when Integer then [key]
-          when String  then key.bytes
-          else              key
-          end
-
-    key    = key.cycle
-    result = ''
-
-    bytes.each do |b|
-      result << (b ^ key.next).chr
-    end
-
-    return result
-  end
-
-  #
-  # Base64 encodes a string.
-  #
-  # @param [Symbol, nil] mode
-  #   The base64 mode to use. May be either:
-  #
-  #   * `:normal`
-  #   * `:strict`
-  #   * `:url` / `:urlsafe`
-  #
-  # @return [String]
-  #   The base64 encoded form of the string.
-  #
-  # @example
-  #   "hello".base64_encode
-  #   # => "aGVsbG8=\n"
-  #
-  # @api public
-  #
-  def base64_encode(mode=nil)
-    case mode
-    when :strict        then Base64.strict_encode64(self)
-    when :url, :urlsafe then Base64.urlsafe_encode64(self)
-    else                     Base64.encode64(self)
-    end
-  end
-
-  #
-  # Base64 decodes a string.
-  #
-  # @param [Symbol, nil] mode
-  #   The base64 mode to use. May be either:
-  #
-  #   * `nil`
-  #   * `:strict`
-  #   * `:url` / `:urlsafe`
-  #
-  # @return [String]
-  #   The base64 decoded form of the string.
-  #
-  # @note
-  #   `mode` argument is only available on Ruby >= 1.9.
-  #
-  # @example
-  #   "aGVsbG8=\n".base64_decode
-  #   # => "hello"
-  #
-  # @api public
-  #
-  def base64_decode(mode=nil)
-    case mode
-    when :strict        then Base64.strict_decode64(self)
-    when :url, :urlsafe then Base64.urlsafe_decode64(self)
-    else                     Base64.decode64(self)
-    end
-  end
-
-  #
-  # Zlib inflate a string.
-  #
-  # @return [String]
-  #   The Zlib inflated form of the string.
-  #
-  # @example
-  #   "x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15".zlib_inflate
-  #   # => "hello"
-  #
-  # @api public
-  #
-  def zlib_inflate
-    Zlib::Inflate.inflate(self)
-  end
-
-  #
-  # Zlib deflate a string.
-  #
-  # @return [String]
-  #   The Zlib deflated form of the string.
-  #
-  # @example
-  #   "hello".zlib_deflate
-  #   # => "x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15"
-  #
-  # @api public
-  #
-  def zlib_deflate
-    Zlib::Deflate.deflate(self)
-  end
-
-  #
-  # Converts a multitude of hexdump formats back into raw-data.
-  #
-  # @param [Hash] options
-  #   Additional options.
-  #
-  # @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`
-  #
-  # @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 unhexdump(options={})
-    Ronin::Binary::Hexdump::Parser.new(options).parse(self)
-  end
-
-end

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

@@ -1,129 +0,0 @@
-#
-# 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 'digest/md5'
-require 'digest/sha1'
-require 'digest/sha2'
-
-class File
-
-  #
-  # Calculates the MD5 checksum of a file.
-  #
-  # @param [String] path
-  #   The path to the file.
-  #
-  # @return [String]
-  #   The MD5 checksum of the file.
-  #
-  # @example
-  #   File.md5('data.txt')
-  #   # => "5d41402abc4b2a76b9719d911017c592"
-  #
-  # @api public
-  #
-  def File.md5(path)
-    Digest::MD5.file(path).hexdigest
-  end
-
-  #
-  # Calculates the SHA1 checksum of a file.
-  #
-  # @param [String] path
-  #   The path to the file.
-  #
-  # @return [String]
-  #   The SHA1 checksum of the file.
-  #
-  # @example
-  #   File.sha1('data.txt')
-  #   # => "aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d"
-  #
-  # @api public
-  #
-  def File.sha1(path)
-    Digest::SHA1.file(path).hexdigest
-  end
-
-  #
-  # @see File.sha1
-  #
-  # @api public
-  #
-  def File.sha128(path)
-    File.sha1(path)
-  end
-
-  #
-  # Calculates the SHA256 checksum of a file.
-  #
-  # @param [String] path
-  #   The path to the file.
-  #
-  # @return [String]
-  #   The SHA256 checksum of the file.
-  #
-  # @example
-  #   File.sha256('data.txt')
-  #   # => "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
-  #
-  # @api public
-  #
-  def File.sha256(path)
-    Digest::SHA256.file(path).hexdigest
-  end
-
-  #
-  # @see File.sha256
-  #
-  # @api public
-  #
-  def File.sha2(path)
-    File.sha256(path)
-  end
-
-  #
-  # Calculates the SHA512 checksum of a file.
-  #
-  # @param [String] path
-  #   The path to the file.
-  #
-  # @return [String]
-  #   The SHA512 checksum of the file.
-  #
-  # @example
-  #   File.sha512('data.txt')
-  #   # => "9b71d224bd62f3785d96d46ad3ea3d73319bfbc2890caadae2dff72519673ca72323c3d99ba5c11d7c7acc6e14b8c5da0c4663475c2e5c3adef46f73bcdec043"
-  #
-  # @api public
-  #
-  def File.sha512(path)
-    Digest::SHA512.file(path).hexdigest
-  end
-
-  #
-  # @see File.sha512
-  #
-  # @api public
-  #
-  def File.sha5(path)
-    File.sha512(path)
-  end
-
-end

data/lib/ronin/formatting/extensions/digest/string.rb

@@ -1,86 +0,0 @@
-#
-# 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 'digest/md5'
-require 'digest/sha1'
-require 'digest/sha2'
-
-class String
-
-  #
-  # @return [String]
-  #   The MD5 checksum of the String.
-  #
-  # @example
-  #   "hello".md5
-  #   # => "5d41402abc4b2a76b9719d911017c592"
-  #
-  # @api public
-  #
-  def md5
-    Digest::MD5.hexdigest(self)
-  end
-
-  #
-  # @return [String]
-  #   The SHA1 checksum of the String.
-  #
-  # @example
-  #   "hello".sha1
-  #   # => "aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d"
-  #
-  # @api public
-  #
-  def sha1
-    Digest::SHA1.hexdigest(self)
-  end
-
-  alias sha128 sha1
-
-  #
-  # @return [String]
-  #   The SHA2 checksum of the String.
-  #
-  # @example
-  #   "hello".sha2
-  #   # => "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
-  #
-  # @api public
-  #
-  def sha256
-    Digest::SHA256.hexdigest(self)
-  end
-
-  alias sha2 sha256
-
-  #
-  # @return [String]
-  #   The SHA512 checksum of the String.
-  #
-  # @example
-  #   "hello".sha512
-  #   # => "9b71d224bd62f3785d96d46ad3ea3d73319bfbc2890caadae2dff72519673ca72323c3d99ba5c11d7c7acc6e14b8c5da0c4663475c2e5c3adef46f73bcdec043"
-  #
-  # @api public
-  #
-  def sha512
-    Digest::SHA512.hexdigest(self)
-  end
-
-end

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

@@ -1,21 +0,0 @@
-#
-# 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/formatting/extensions/digest/string'
-require 'ronin/formatting/extensions/digest/file'

data/lib/ronin/formatting/extensions/html/integer.rb

@@ -1,142 +0,0 @@
-#
-# 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 'cgi'
-
-class Integer
-
-  # Special JavaScript bytes and their escaped Strings.
-  JS_ESCAPE_BYTES = {
-    0x00 => '\u0000',
-    0x01 => '\u0001',
-    0x02 => '\u0002',
-    0x03 => '\u0003',
-    0x04 => '\u0004',
-    0x05 => '\u0005',
-    0x06 => '\u0006',
-    0x07 => '\u0007',
-    0x08 =>  '\b',
-    0x09 =>  '\t',
-    0x0a =>  '\n',
-    0x0b => '\u000b',
-    0x0c =>  '\f',
-    0x0d =>  '\r',
-    0x0e => '\u000e',
-    0x0f => '\u000f',
-    0x10 => '\u0010',
-    0x11 => '\u0011',
-    0x12 => '\u0012',
-    0x13 => '\u0013',
-    0x14 => '\u0014',
-    0x15 => '\u0015',
-    0x16 => '\u0016',
-    0x17 => '\u0017',
-    0x18 => '\u0018',
-    0x19 => '\u0019',
-    0x1a => '\u001a',
-    0x1b => '\u001b',
-    0x1c => '\u001c',
-    0x1d => '\u001d',
-    0x1e => '\u001e',
-    0x1f => '\u001f',
-    0x22 =>  '\"',
-    0x5c =>  '\\\\',
-  }
-
-  #
-  # Escapes the Integer as an HTML String.
-  #
-  # @return [String]
-  #   The escaped HTML String.
-  #
-  # @example
-  #   0x26.html_escape
-  #   # => "&amp;"
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def html_escape
-    CGI.escapeHTML(chr)
-  end
-
-  #
-  # Formats the Integer as a HTML String.
-  #
-  # @return [String]
-  #   The HTML String.
-  #
-  # @example
-  #   0x41.format_html
-  #   # => "&#65;"
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def format_html
-    "&#%d;" % self
-  end
-
-  #
-  # Escapes the Integer as a JavaScript String.
-  #
-  # @return [String]
-  #   The escaped JavaScript String.
-  #
-  # @example 
-  #   0x22.js_escape
-  #   # => "\\\""
-  #
-  # @example
-  #   0x7f.js_escape
-  #   # => "\x7F"
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def js_escape
-    if self > 0xff then format_js
-    else                JS_ESCAPE_BYTES.fetch(self,chr)
-    end
-  end
-
-  #
-  # Formats the Integer as a JavaScript escaped String.
-  #
-  # @return [String]
-  #   The escaped JavaScript String.
-  #
-  # @example
-  #   0x41.format_js
-  #   # => "%41"
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def format_js
-    if self > 0xff then "\\u%.4X" % self
-    else                "\\x%.2X" % self
-    end
-  end
-
-end