ofrak 3.1.0

A binary analysis and modification platform

OFRAK

OFRAK (Open Firmware Reverse Analysis Konsole) is a binary analysis and modification platform that combines the ability unpack, analyze, modify, and repack binaries.

OFRAK combines the ability to:

• Identify and Unpack many binary formats
• Analyze unpacked binaries with field-tested reverse engineering tools
• Modify and Repack binaries with powerful patching strategies

OFRAK supports a range of embedded firmware file formats beyond userspace executables, including:

• Compressed filesystems
• Compressed & checksummed firmware
• Bootloaders
• RTOS/OS kernels

OFRAK equips users with:

• A Graphical User Interface (GUI) for interactive exploration and visualization of binaries
• A Python API for readable and reproducible scripts that can be applied to entire classes of binaries, rather than just one specific binary
• Recursive identification, unpacking, and repacking of many file formats, from ELF executables, to filesystem archives, to compressed and checksummed firmware formats
• Built-in, extensible integration with powerful analysis backends (angr, Binary Ninja, Ghidra, IDA Pro)
• Extensibility by design via a common interface to easily write additional OFRAK components and add support for a new file format or binary patching operation

See ofrak.com for more details.

Package: ofrak

OFRAK
└───ofrak  <-- //YOU ARE HERE//
│   └───component   // Definitions for abstract Component classes (e.g. Analyzer)
│   └───core        // Definitions for standard OFRAK components (plus related tags, views, etc.)
│   └───model       // Definitions for core OFRAK data structures
│   └───service     // Definitions for core OFRAK services
│   
└───ofrak_type
└───ofrak_io
└───ofrak_patch_maker
└───ofrak_tutorial

This is the package containing the core of the OFRAK framework. Install this first to get started with OFRAK!

What is included:

• Definitions for core OFRAK data structures and services, such as Resource, OFRAKContext, and DataService.
• Components to handle unpacking, modifying, and repacking common executable file formats:
  • ELF
  • PE Files
• Definitions for common software and reverse engineering abstractions like Instruction, File, and BasicBlock
• Unpackers & Packers for a number of file types, including:
  • APK
  • bzip2
  • CPIO
  • gip
  • ISO 9660
  • LZMA/XZ
  • LZO
  • 7z
  • squashfs
  • tar
  • UImage
  • zip
  • zlib
• Miscellaneous helpful components:
  • MagicAnalyzer and two Identifier components which uses python-libmagic to automatically tag OFRAK Resources
  • Basic modifiers like StringFindReplaceModifier and BinaryInjectorModifier
  • Basic useful analyzers like Sha256Analyzer and MD5Analyzer which calculate the respective checksums of OFRAK Resources
  • An unpacker for Linux device tree blobs (DTB)
  • Analyzers wrapping strings and binwalk
  • An analyzer to calculate Shannon entropy of binary data

This is only a representative sampling of the features in the core OFRAK. Consult the code reference docs for a complete manifest.

What is not included:

• The OFRAK PatchMaker
• Components which integrate the disassembler backends (Ghidra, BinaryNinja, Angr, Capstone)

Testing

This package maintains 100% test coverage of functions.

License

The code in this repository comes with an OFRAK Community License, which is intended for educational uses, personal development, or just having fun.

Users interested in using OFRAK for commercial purposes can request the Pro or Enterprise License. See OFRAK Licensing for more information.

Documentation

OFRAK has general documentation and API documentation, which can be viewed at https://ofrak.com/docs.