Skip to main content

A command-line interface for disassembling and assembling the Hermes Bytecode.

Project description

hbctool

Python 3.x PyPI version Software License

A command-line interface for disassembling and assembling the Hermes Bytecode.

Since the React Native team created their own JavaScript engine (named Hermes) for running the React Native application, the JavaScript source code is often compiled to the Hermes bytecode. In the penetration test project, I found that some React Native applications have already been migrated to the Hermes engine. It is really head for me to analyze or patch those applications. Therefore, I created hbctool for helping any pentester to test the Hermes bytecode.

Hermes is an open-source JavaScript engine optimized for running React Native apps on Android. For many apps, enabling Hermes will result in improved start-up time, decreased memory usage, and smaller app size. At this time Hermes is an opt-in React Native feature, and this guide explains how to enable it.

Special thanks to ErbaZZ and Jusmistic for helping me research and develop this tool.

For more information, please visit:

https://suam.wtf/posts/react-native-application-static-analysis-en/

Screenshot

hbctool Example

This video with MP4 format can be found at /image/hbctool_example.mp4.

Installation

To install hbctool, simply use pip:

pip install hbctool

Usage

Please run hbctool --help to show the usage.

hbctool --help   
A command-line interface for disassembling and assembling
the Hermes Bytecode.

Usage:
    hbctool disasm <HBC_FILE> <HASM_PATH>
    hbctool asm <HASM_PATH> <HBC_FILE>
    hbctool --help
    hbctool --version

Operation:
    disasm              Disassemble Hermes Bytecode
    asm                 Assemble Hermes Bytecode

Args:
    HBC_FILE            Target HBC file
    HASM_PATH           Target HASM directory path

Options:
    --version           Show hbctool version
    --help              Show hbctool help manual

Examples:
    hbctool disasm index.android.bundle test_hasm
    hbctool asm test_hasm index.android.bundle

For Android, the HBC file normally locates at assets directory with index.android.bundle filename.

Support

hbctool currently supports the following Hermes Bytecode version:

Contribution

Feel free to create an issue or submit the merge request. Anyway you want to contribute this project. I'm very happy about it.

However, please run the unit test before submiting the pull request.

cd hbctool
python test.py

I use poetry to build this tool. To build it yourself, simply execute:

poetry install

Next Step

  • Add the other Hermes bytecode versions
  • Create a class abstraction
  • Support overflow patching
  • Do all TODO, NOTE, FIXME in source code

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hbctool-0.1.5.tar.gz (9.4 MB view details)

Uploaded Source

Built Distribution

hbctool-0.1.5-py3-none-any.whl (9.8 MB view details)

Uploaded Python 3

File details

Details for the file hbctool-0.1.5.tar.gz.

File metadata

  • Download URL: hbctool-0.1.5.tar.gz
  • Upload date:
  • Size: 9.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.8.10 Linux/5.11.0-34-generic

File hashes

Hashes for hbctool-0.1.5.tar.gz
Algorithm Hash digest
SHA256 30aeb050095ba507da2ed26ea8e64a75cd63d459d0db2eeb99e189fb8421c8a3
MD5 5d8fed96367f22a2a92f990768554aa6
BLAKE2b-256 a585aad264ee4e6dbf58fa751bd026472d7d81bff0860c267228dabee7c2a9ae

See more details on using hashes here.

File details

Details for the file hbctool-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: hbctool-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 9.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.8.10 Linux/5.11.0-34-generic

File hashes

Hashes for hbctool-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ba40d3d1997efcc5206fc1ccff715ec3807d5ad051eec14a278cc351481623d8
MD5 093a266d2a76cc3ea3613ecd5285bb5f
BLAKE2b-256 db55dd87db8b14263bee85ca76056a541e06497c5491e2c0fcc091ca62baa9df

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page