Skip to content

Latest commit

 

History

History
194 lines (153 loc) · 5.47 KB

README.md

File metadata and controls

194 lines (153 loc) · 5.47 KB
Raw

Hexter

A minimal terminal hex viewer supporting reading, writing and searching in files and processes.

Compiles and runs under

  • Linux
  • Windows (x86/x64).
  • OsX may work too, but only the -file functionality.
  • Android in Termux

Version

1.8.3
Last changed: 17.09.2024

REQUIREMENTS

  • Linux
    • Gcc
  • Windows
    • msbuild

BUILD

Linux (gcc) & linuxBuild.sh

$ ./linuxBuild.sh -t app [-d|r] [-c] [-h]

Linux (gcc) manual

$ mkdir build
$ gcc -o build/hexter -Wl,-z,relro,-z,now -D_FILE_OFFSET_BITS=64 -Ofast src/hexter.c src/Finder.c src/Printer.c src/ProcessHandlerLinux.c src/Writer.c src/utils/*.c

Use clang instead of gcc in Termux on Android.

Windows (MsBuild)

$ winBuild.bat [/exe] [/m Release|Debug] [/b 32|64] [/rt] [/pdb] [/pts <toolset>] [/bt <path>] [/h]

This will run in a normal cmd.

The correct path to your build tools may be passed with the /bt parameter or just changed in the script winBuild.bat itself.

The PlatformToolset defaults to "v142", but may be changed with the /pts option. "v142" is used for VS 2019 version, "v143" would be used in VS 2022.

In a developer cmd you can also type:

$devcmd> msbuild Hexter.vcxproj /p:Configuration=<Release|Debug> /p:Platform=<x64|x86> [/p:PlatformToolset=<v142|v143|WindowsApplicationForDrivers10.0>]

DLL : Windows (MsBuild)

$ winBuild.bat /lib [/b 64] [/m Release] [/rt] [/pdb] [/pts <toolset>] [/bt a\path] [/?]

SH : Linux (gcc)

$ ./linuxBuild.sh -sh [-d|r] [-c] [-h]

Runtime Errors (Windows)

If a "VCRUNTIMExxx.dll not found Error" occurs on the target system, statically including runtime libs is a solution.
This is done by using the /p:RunTimeLib=Debug|Release (msbuild) or [/rtl] (winBuild) flags.

Windows Context Menu

It may be convenient to add Hexter to the context menu to be able to right-click a file and hexter it. In this scenario, you may use

$ addHeaderHexterToShellCtxtMenu.bat /p "c:\Hexter.exe" [/l "Open in Hexter"]

USAGE

$ ./hexter [options] -file a/file/name [options]
$ ./hexter [options] -pid xx [options]

Optional Parameters:

  • -file string A path to file.
  • -pid uint32_t A process id.
  • -s size_t Start offset in hex or dec. Default = 0.
  • -l size_t Length of the part to display in hex or dec. Default = 0x100.
  • -b Force breaking, not continuous mode and print just one block.
  • Printing format:
    • -pa ASCII only print.
    • -pu UNICODE (utf-16) only print.
    • -px HEX only print.
    • -po Print address (only valid in combination with the other options).
    • -pp Print plain, not console styled output.
    • -pbs Print plain byte string.
  • File manipulation/examination.
    • -d Delete -l bytes from offset -s. (File mode only.) Pass -l 0 to delete from -s to file end.
    • -i* Insert hex byte sequence (destructive!). Where * is a format option. (File mode only.)
    • -o* Overwrite hex byte sequence (destructive!). Where * is a format option.
    • -f* Find hex byte sequence. Where * is a format option.
    • Format options:
      • h: plain bytes,
      • a: ascii/utf-8 text,
      • u: unicode (windows utf-16) text,
      • b: byte,
      • f: fill byte (will be inserted -l times),
      • w: word,
      • d: double word,
      • q: quad word.
        Expect for the string types, all values have to be passed as hex values, omitting 0x.
    • Find options:
      • -ci: case insensitive (for ascii search only).
  • -pid only:
    • -lpx List entire process memory layout.
    • -lpm List all process modules.
    • -lpt List all process threads.
    • -lph List all process heaps.
    • -lphb List all process heaps and its blocks.
    • -lrp List all running processes. Pass any pid or 0 to get it running.
  • -h Print this.

Either use -file or -pid, not both. The program runs in continuous mode by default, expect for the -i, -o and -d option, or if the -b option is set.
Step through the file by pressing ENTER.
Quit with "q".
If searching something in continuous mode, type "n" to find next occurrence.
The length value will be padded to fit a block size in continuous mode.

EXAMPLES

files
Print 100 bytes from offset 20 in hex only style.

$ ./hexter -file a/file/name -s 20 -l 100 -x

Insert bytes at offset 0x20 with 0xdead0bea

$ ./hexter -file a/file/name -s 0x20 -ih dead0bea

Overwrite dword at offset 0x20 with 0xdead0bea

$ ./hexter -file a/file/name -s 0x20 -od dead0bea

Find ascii string "PE"

$ ./hexter -file a/file/name -fa PE

Delete 16 bytes from offset 16

$ ./hexter -file a/file/name -d -s 16 -l 16

Create file with 8 bytes

$ ./hexter -file a/file/name -ih 0102030405060708

processes
Print my process (0) and a list of its modules

$ ./hexter -pid 0 -lpm

Print a list of running processes.

$ ./hexter -pid 0 -lrp

TESTS

(Currently Gtests run linux only)

REQUIREMENTS

  • The google c++ testing framework gtest [1]
  • A c++ compiler available to cmake

The test may be built with the target_name=hexter_tests which is the name of the test program as well.

[1] https://github.com/google/googletest

COPYRIGHT, CREDITS & CONTACT

Published under GNU GENERAL PUBLIC LICENSE.

Author

Co-Author

common_codeio.c