dsector

README

dsector

by Andrew Brampton bramp.net (c) 2016

Dsector is a Go package that provides a API for parsing binary files using a predefined grammar. Think the wireshark dissector but for files instead of packets. This useful for debugging or inspecting files.

For example, using the PNG grammar on a sample PNG file produces:

$ go run inspect/main.go grammars/png.grammar samples/png/basi0g01.png 

PNG Images: (1 children)
  [0] PNG File: (3 children)
    [0] Header: (1 children)
      [0] Eye catcher: 89504e470d0a1a0a (Eye catcher)
    [1] IHDR: (4 children)
      [0] Length: 13
      [1] Type: 0x49484452 (IHDR)
      [2] Data: (7 children)
        [0] Width: 32
        [1] Height: 32
        [2] Bit depth: 1
        [3] Color type: 0 (Type0)
        [4] Compression method: 0 (deflate/inflate)
        [5] Filter method: 0 (Adaptive)
        [6] Interlace method: 1 (Adam7 interlace)
      [3] CRC: 2c0677cf (4 bytes)
    [2] Chunks: (3 children)
      [0] gAMA: (4 children)
        [0] Length: 4
        [1] Type: 0x67414d41
        [2] Data: (1 children)
          [0] Gamma: 100000
        [3] CRC: 31e8965f (4 bytes)
      [1] IDAT: (4 children)
        [0] Length: 144
        [1] Type: 0x49444154
        [2] Data: (1 children)
          [0] Image Data: 789c2d8d310e... (144 bytes)
        [3] CRC: 661822f2 (4 bytes)
      [2] IEND: (4 children)
        [0] Length: 0
        [1] Type: 0x49454e44
        [2] Data: (0 children)
        [3] CRC: ae426082 (4 bytes)

Dsector is able to parse the same XML grammar files provided by Synalyze It! a commerical Hex Editor for the Mac. If you need a better, more complete tool, then please consider Synalyze It! or Hexinator.

TODO

• Better document the API.
• Move the code into multiple packages. Ideally the parsing/xml/structs would all be in seperate packages.
• More complete tests
• More sample files for each Grammar
• Run a fuzzing library to check we don't crash!
• Many more things

Licence (Simplified BSD License)

Copyright (c) 2016, Andrew Brampton
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.