hex_dump 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 061d35cd6d8ab4ca7e1ea1839883b63f4a5f539d
+  data.tar.gz: a9c19068b15f30fd9103c34ac6414201d459de5c
+SHA512:
+  metadata.gz: 4286c9c73eeaea2bfea74a812bf5505b2fadbbf5c8ecb53737f0301a099d8b1c15c099d489a679932f233f7b268f1fc969ab5d7287c871df1b071bd2c23042bf
+  data.tar.gz: 0da6d609b65fa05f33354e5210e748f52fdcca600bfef0f82a91cdd32311bcf05cd6608a480ea4445da63dc9bdc031688221da825e06b240785b8c40d878276b

data/examples/file_dump.rb

@@ -0,0 +1,17 @@
+# Hexadecimal dump of a binary (image) file.
+# to run this file enter this on command line:
+# $ ruby file_dump.rb
+
+require 'hex_dump'
+
+contents = File.read("img.png")  # read file into a string
+
+# display hex with default options (line_size:16 and hex_color:HexDump::BLACK)
+HexDump.print contents
+
+# display hex in color Yellow. (default line_size:16 will be used 
+# since it is not specified in options hash)
+HexDump.print contents, options={hex_color: HexDump::CYAN}
+
+# display hex with line width 24 and foreground color green
+HexDump.print contents, options={line_size: 24, hex_color: HexDump::GREEN}

data/lib/hex_dump.rb

@@ -0,0 +1,79 @@
+# This module contains all the methods required for displaying
+# the string/binary in hexadecimal.
+# This has module functions which can be directly called in the code that
+# requires this ruby file or the gem. 
+# The gem is at http://rubygems.org/gems/hex_dump and can be installed using
+# $ gem install hex_dump
+#
+# @author Shivam Patel
+
+module HexDump
+
+  # foreground color constants
+  BLACK   = 30 
+  RED     = 31 
+  GREEN   = 32 
+  YELLOW  = 33 
+  BLUE    = 34 
+  MAGENTA = 35 
+  CYAN    = 36 
+  WHITE   = 37 
+  
+  # Takes a buffer and displays it in hexadecimal in a format described by the options
+  # The optional options are :line_size and :hex_color
+  # :line_size sets the size (width) of the hex display. Can be 16(default), 24, 32 or 64 
+  # :hex_color sets the color of the foreground text. Can be a number between 30 to 37 (see codes above)
+  # @param buffer [String] The actual binary data/string that is to be displayed in hex.
+  # @param options [Hash] This can be blank (in that case defaults options will be used).
+  #   Otherwise a hash providing any of the settings that are to be changed.
+  #   Eg. to change line witdh, pass options as { line_size: 32 }
+  #   to change both line width and the foreground color, pass options as { line_size: 32, hex_color: 34 }
+  # @return [String] A string containing the entire hexdump. 
+  def self.print(buffer = "", options = {})
+    # merge(and overwrite) whatsoever options were passed by user
+    options = {line_size: 16, hex_color: WHITE }.merge(options)
+    
+    line_size = options[:line_size]
+    hex_color = options[:hex_color]
+    
+    line_size = 16 unless [16, 24, 32, 64].include?(line_size) # prevent user providing arbit line_size
+    
+    byte_number = 0
+    lines = ''
+    line_format = '%02x%02x ' * (line_size/2)
+    buffer_length = buffer.length
+    
+    while byte_number < buffer_length
+      line_number = (sprintf '%08x', byte_number) + ": " # print byte number padded with zeros on left
+      
+      if (buffer_length - byte_number) >= line_size
+        characters = buffer.byteslice(byte_number, line_size)             # get a line size worth of characters
+        unpacked_chars = characters.unpack("C#{line_size}")
+        line_hex = send(:sprintf, line_format, *unpacked_chars )
+      else
+        len = buffer_length - byte_number
+        characters = buffer.byteslice(byte_number, len)
+        if len == 1
+          whitespace_pads = " " * ((line_size * 2.5) - 2)   # this last line will only take 3 chars
+          line_format = "%02x#{whitespace_pads}"
+        else
+          whitespace_pads = " " * ((line_size * 2.5) - (len * 2 ) - len/2 )
+          line_format =  '%02x%02x ' * (len/2)  + '%02x' * (len % 2) + whitespace_pads
+        end
+        unpacked_chars = characters.unpack("C#{len}")
+        line_hex = send(:sprintf, line_format, *unpacked_chars )
+        
+        line_size = len # for one last line, change the line_size
+      end
+      # replace all non printable chars with a '.' char
+      line_char = unpacked_chars.map{ |c| c.chr}.join.tr("^\x20-\x7E", '.')
+      
+      line = line_number + "\e[#{hex_color}m" + line_hex + " " + line_char + "\e[0m"
+      byte_number += line_size
+      puts line
+      lines += line
+    end # end while
+    return lines           # the entire hex dump
+  end # end def print
+  
+end #end module

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: hex_dump
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shivam Patel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-17 00:00:00.000000000 Z
+dependencies: []
+description: This gem allows programmers to hexdump arbitary strings and binaries.
+  Helpful for your reverse engineering scripts. Has options like line_width and hex_colors
+  which can help customize the format in which the resultant hexadecimal dump of the
+  string or binary is displayed.
+email: shivam@shivampatel.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- examples/file_dump.rb
+- examples/img.png
+- lib/hex_dump.rb
+homepage: https://github.com/shivampatel/hex_dump
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Hex Dump binaries and string from your ruby code
+test_files: []
+has_rdoc: