https://github.com/letmutx/dex-parser

Rust parser for Android's dex format
https://github.com/letmutx/dex-parser

android dex parser rust

Last synced: 7 days ago
JSON representation

Rust parser for Android's dex format

• Host: GitHub
• URL: https://github.com/letmutx/dex-parser
• Owner: letmutx
• Created: 2018-04-14T23:24:00.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-09T00:59:20.000Z (about 1 month ago)
• Last Synced: 2024-12-27T15:09:22.072Z (14 days ago)
• Topics: android, dex, parser, rust
• Language: Rust
• Homepage:
• Size: 5.33 MB
• Stars: 42
• Watchers: 5
• Forks: 21
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dex

[![Build Status](https://api.travis-ci.org/letmutx/dex-parser.svg?branch=master)](https://travis-ci.org/letmutx/dex-parser)

Dex is a parser for Android's [Dex](https://source.android.com/devices/tech/dalvik/dex-format) format written completely in Rust.

Most of the functionality to access the data structures in the file is implemented. Test coverage stands at 81% as of v0.3.0

## Usage

Add to your `Cargo.toml`:

```

dex = "0.4.0"

```

## Documentation

The primary source of documentation for dex format is [Android website](https://source.android.com/devices/tech/dalvik/dex-format). Most of the public `struct`s, and `method`s in this crate have the same names. There are a few examples [here](https://github.com/letmutx/dex-parser/tree/master/examples/) to get you started.

## Development Notes

* The library makes use of [`mmap`](https://en.wikipedia.org/wiki/Mmap) to access the file contents.

* [scroll](https://crates.io/crates/scroll) is used to parse binary data.

* The included `classes.dex` in the resources folder is from the open-source application [ADW launcher](https://f-droid.org/en/packages/org.adw.launcher/). You can find the source code [here](https://f-droid.org/repo/org.adw.launcher_34_src.tar.gz)

## Running test cases

Some tests contains Java code and require `javac` and [d8](https://developer.android.com/studio/command-line/d8). The other option is to open a PR and test using the travis setup.

* To get `d8`, you need to install Android SDK and add `Android/Sdk/build-tools//` directory to PATH variable.

* For `javac`, you need to install Java.

* Also, `ANDROID_LIB_PATH` variable needs to be set in the environment. It should point to the `android.jar` file in the SDK. (ex: `Android/Sdk/platforms/android-/android.jar`). This is needed to prevent warnings when running `d8`.

* Use `cargo install cargo-tarpaulin` and run `cargo tarpaulin` to get test coverage.

## Contributing

All contributions are welcome! Feel free to raise issues/PRs on Github if you find a bug, have a question or think something can be improved! Please add a test when you open an PR!