ronin-support 0.5.2 → 1.0.0.beta1

data/lib/ronin/extensions/regexp.rb

@@ -1,157 +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/extensions/resolv'
-
-#
-# @since 0.3.0
-#
-class Regexp
-
-  # Regular expression for finding words
-  #
-  # @since 0.5.0
-  WORD = /[A-Za-z][A-Za-z'\-\.]*[A-Za-z]/
-
-  # Regular expression for finding a decimal octet (0 - 255)
-  #
-  # @since 0.4.0
-  OCTET = /25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9]/
-
-  # Regular expression for finding MAC addresses in text
-  MAC = /[0-9a-fA-F]{2}(?::[0-9a-fA-F]{2}){5}/
-
-  # A regular expression for matching IPv4 Addresses.
-  IPv4 = /#{OCTET}(?:\.#{OCTET}){3}(?:\/\d{1,2})?/
-
-  # A regular expression for matching IPv6 Addresses.
-  IPv6 = union(
-    /(?:[0-9a-f]{1,4}:){6}#{IPv4}/,
-    /(?:[0-9a-f]{1,4}:){5}[0-9a-f]{1,4}:#{IPv4}/,
-    /(?:[0-9a-f]{1,4}:){5}:[0-9a-f]{1,4}:#{IPv4}/,
-    /(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,4}:#{IPv4}/,
-    /(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,3}:#{IPv4}/,
-    /(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,2}:#{IPv4}/,
-    /(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,1}:#{IPv4}/,
-    /:(?::[0-9a-f]{1,4}){1,5}:#{IPv4}/,
-    /(?:(?:[0-9a-f]{1,4}:){1,5}|:):#{IPv4}/,
-    /(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,6}(?:\/\d{1,3})?/,
-    /(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,5}(?:\/\d{1,3})?/,
-    /(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,4}(?:\/\d{1,3})?/,
-    /(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,3}(?:\/\d{1,3})?/,
-    /(?:[0-9a-f]{1,4}:){1,5}(?::[0-9a-f]{1,4}){1,2}(?:\/\d{1,3})?/,
-    /(?:[0-9a-f]{1,4}:){1,6}(?::[0-9a-f]{1,4}){1,1}(?:\/\d{1,3})?/,
-    /[0-9a-f]{1,4}(?::[0-9a-f]{1,4}){7}(?:\/\d{1,3})?/,
-    /:(?::[0-9a-f]{1,4}){1,7}(?:\/\d{1,3})?/,
-    /(?:(?:[0-9a-f]{1,4}:){1,7}|:):(?:\/\d{1,3})?/
-  )
-
-  # A regular expression for matching IP Addresses.
-  IP = /#{IPv4}|#{IPv6}/
-
-  # Regular expression used to find host-names in text
-  HOST_NAME = /(?:[a-zA-Z0-9]+(?:[_-][a-zA-Z0-9]+)*\.)+(?:#{union(Resolv::TLDS)})/i
-
-  # Regular expression to match a word in the username of an email address
-  USER_NAME = /[A-Za-z](?:[A-Za-z0-9]*[\._-])*[A-Za-z0-9]+/
-
-  # Regular expression to find email addresses in text
-  EMAIL_ADDR = /#{USER_NAME}\@#{HOST_NAME}/
-
-  # Regular expression to find phone numbers in text
-  #
-  # @since 0.5.0
-  PHONE_NUMBER = /(?:\d[ \-\.]?)?(?:\d{3}[ \-\.]?)?\d{3}[ \-\.]?\d{4}(?:x\d+)?/
-
-  # Regular expression to find deliminators in text
-  #
-  # @since 0.4.0
-  DELIM = /[;&\n\r]/
-
-  # Regular expression to find identifier in text
-  #
-  # @since 0.4.0
-  IDENTIFIER = /[_]*[a-zA-Z]+[a-zA-Z0-9_-]*/
-
-  # Regular expression to find File extensions in text
-  #
-  # @since 0.4.0
-  FILE_EXT = /(?:\.[A-Za-z0-9]+)+/
-
-  # Regular expression to find File names in text
-  #
-  # @since 0.4.0
-  FILE_NAME = /(?:[^\/\\\. ]|\\[\/\\ ])+/
-
-  # Regular expression to find Files in text
-  #
-  # @since 0.4.0
-  FILE = /#{FILE_NAME}(?:#{FILE_EXT})?/
-
-  # Regular expression to find Directory names in text
-  #
-  # @since 0.4.0
-  DIRECTORY = /(?:\.\.|\.|#{FILE})/
-
-  # Regular expression to find local UNIX Paths in text
-  #
-  # @since 0.4.0
-  RELATIVE_UNIX_PATH = /(?:#{DIRECTORY}\/)+#{DIRECTORY}\/?/
-
-  # Regular expression to find absolute UNIX Paths in text
-  #
-  # @since 0.4.0
-  ABSOLUTE_UNIX_PATH = /(?:\/#{FILE})+\/?/
-
-  # Regular expression to find UNIX Paths in text
-  #
-  # @since 0.4.0
-  UNIX_PATH = /#{ABSOLUTE_UNIX_PATH}|#{RELATIVE_UNIX_PATH}/
-
-  # Regular expression to find local Windows Paths in text
-  #
-  # @since 0.4.0
-  RELATIVE_WINDOWS_PATH = /(?:#{DIRECTORY}\\)+#{DIRECTORY}\\?/
-
-  # Regular expression to find absolute Windows Paths in text
-  #
-  # @since 0.4.0
-  ABSOLUTE_WINDOWS_PATH = /[A-Za-z]:(?:\\#{FILE})+\\?/
-
-  # Regular expression to find Windows Paths in text
-  #
-  # @since 0.4.0
-  WINDOWS_PATH = /#{ABSOLUTE_WINDOWS_PATH}|#{RELATIVE_WINDOWS_PATH}/
-
-  # Regular expression to find local Paths in text
-  #
-  # @since 0.4.0
-  RELATIVE_PATH = /#{RELATIVE_UNIX_PATH}|#{RELATIVE_WINDOWS_PATH}/
-
-  # Regular expression to find absolute Paths in text
-  #
-  # @since 0.4.0
-  ABSOLUTE_PATH = /#{ABSOLUTE_UNIX_PATH}|#{ABSOLUTE_WINDOWS_PATH}/
-
-  # Regular expression to find Paths in text
-  #
-  # @since 0.4.0
-  PATH = /#{UNIX_PATH}|#{WINDOWS_PATH}/
-
-end

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

@@ -1,106 +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 '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,77 +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/binary/hexdump/parser'
-
-class File
-
-  #
-  # Converts a hexdump file to it's original binary data.
-  #
-  # @param [Pathname, String] path
-  #   The path of the hexdump file.
-  #
-  # @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 File.unhexdump(path,options={})
-    Ronin::Binary::Hexdump::Parser.new(options).parse(File.new(path))
-  end
-
-end

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

@@ -1,65 +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/binary/template'
-
-class Float
-
-  #
-  # Packs the Float into a String.
-  #
-  # @param [String, Symbol] argument
-  #   The `Array#pack` String code or {Ronin::Binary::Template} type.
-  #
-  # @return [String]
-  #   The packed float.
-  #
-  # @raise [ArgumentError]
-  #   The given Symbol could not be found in
-  #   {Ronin::Binary::Template::FLOAT_TYPES}.
-  #
-  # @example using `Array#pack` template:
-  #   0.42.pack('F')
-  #   # => =\n\xD7>"
-  #
-  # @example using {Ronin::Binary::Template} types:
-  #   0x42.pack(:float_be)
-  #   # => ">\xD7\n="
-  #
-  # @see https://rubydoc.info/stdlib/core/Array:pack
-  # @see Ronin::Binary::Template
-  #
-  # @since 0.5.0
-  #
-  # @api public
-  #
-  def pack(argument)
-    case argument
-    when String
-      [self].pack(argument)
-    else
-      unless Ronin::Binary::Template::FLOAT_TYPES.include?(argument)
-        raise(ArgumentError,"unsupported integer type: #{argument}")
-      end
-
-      [self].pack(Ronin::Binary::Template::TYPES[argument])
-    end
-  end
-
-end

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

@@ -1,180 +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/binary/template'
-
-class Integer
-
-  #
-  # Extracts a sequence of bytes which represent the Integer.
-  #
-  # @param [Integer] length
-  #   The number of bytes to decode from the Integer.
-  #
-  # @param [Symbol, String] endian
-  #   The endianness to use while decoding the bytes of the Integer.
-  #   May be one of:
-  #
-  #   * `big`
-  #   * `little`
-  #   * `net`
-  #
-  # @return [Array]
-  #   The bytes decoded from the Integer.
-  #
-  # @raise [ArgumentError]
-  #   The given `endian` was not one of:
-  #
-  #   * `little`
-  #   * `net`
-  #   * `big`
-  #
-  # @example
-  #   0xff41.bytes(2)
-  #   # => [65, 255]
-  #
-  # @example
-  #   0xff41.bytes(4, :big)
-  #   # => [0, 0, 255, 65]
-  #
-  # @api public
-  #
-  def bytes(length,endian=:little)
-    endian = endian.to_sym
-    buffer = []
-
-    case endian
-    when :little
-      mask  = 0xff
-      shift = 0
-
-      length.times do |i|
-        buffer << ((self & mask) >> shift)
-
-        mask <<= 8
-        shift += 8
-      end
-    when :big, :net
-      shift = ((length - 1) * 8)
-      mask  = (0xff << shift)
-
-      length.times do |i|
-        buffer << ((self & mask) >> shift)
-
-        mask >>= 8
-        shift -= 8
-      end
-    else
-      raise(ArgumentError,"invalid endian #{endian}")
-    end
-
-    return buffer
-  end
-
-  #
-  # Packs the Integer into a String.
-  #
-  # @param [String, Symbol, arch] arguments
-  #   The `Array#pack` code, {Ronin::Binary::Template} type or Architecture
-  #   object with `#endian` and `#address_length` methods.
-  #
-  # @return [String]
-  #   The packed Integer.
-  #
-  # @raise [ArgumentError]
-  #   The given Symbol could not be found in
-  #   {Ronin::Binary::Template::INT_TYPES}.
-  #
-  # @example using a `Array#pack` template:
-  #   0x41.pack('V')
-  #   # => "A\0\0\0"
-  #
-  # @example using {Ronin::Binary::Template} types:
-  #   0x41.pack(:uint32_le)
-  #
-  # @example using archs other than `Ronin::Arch` (**deprecated**):
-  #   arch = OpenStruct.new(:endian => :little, :address_length => 4)
-  #
-  #   0x41.pack(arch)
-  #   # => "A\0\0\0"
-  #
-  # @example using a `Ronin::Arch` arch (**deprecated**):
-  #   0x41.pack(Arch.i686)
-  #   # => "A\0\0\0"
-  #
-  # @example specifying a custom address-length (**deprecated**):
-  #   0x41.pack(Arch.ppc,2)
-  #   # => "\0A"
-  #
-  # @see https://rubydoc.info/stdlib/core/Array:pack
-  # @see Ronin::Binary::Template
-  #
-  # @api public
-  #
-  def pack(*arguments)
-    if (arguments.length == 1 && arguments.first.kind_of?(String))
-      [self].pack(arguments.first)
-    elsif (arguments.length == 1 && arguments.first.kind_of?(Symbol))
-      type = arguments.first
-
-      unless Ronin::Binary::Template::INT_TYPES.include?(type)
-        raise(ArgumentError,"unsupported integer type: #{type}")
-      end
-
-      [self].pack(Ronin::Binary::Template::TYPES[type])
-    elsif (arguments.length == 1 || arguments.length == 2)
-      # TODO: deprecate this calling convention
-      arch, address_length = arguments
-
-      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
-
-      address_length ||= arch.address_length
-
-      integer_bytes = bytes(address_length,arch.endian)
-      integer_bytes.map! { |b| b.chr }
-
-      return integer_bytes.join
-    else
-      raise(ArgumentError,"wrong number of arguments (#{arguments.length} for 1..2)")
-    end
-  end
-
-  #
-  # @return [String]
-  #   The hex escaped version of the Integer.
-  #
-  # @example
-  #   42.hex_escape
-  #   # => "\\x2a"
-  #
-  # @api public
-  #
-  def hex_escape
-    "\\x%.2x" % self
-  end
-
-  alias char chr
-
-end