LibRadar

LibRadar is a detecting tool for 3rd-party libraries in Android apps. This repository is a modified fork of the original LibRadar repository, which can be found at pkumza/LibRadar.

Documentation

Detailed documentation for LibRadar can be found on Github-Pages.

Installation

Note: This fork of LibRadar does not have a pip installation candidate and is intended for development use only.

To use this fork of LibRadar, follow these steps:

1. Clone the repository:

   $ git clone https://github.com/MAST-Framework/LibRadar.git

2. Install the required dependencies:

   $ pip install -r requirements.txt

3. (Optional) Redis Setup

   If you want to use Redis instead of the traditional in-memory solution, you can download the dumped database file from Dropbox - the link was taken from the original Repository (LibRadar).

   Next, extract the database file and use the pre-defined docker-compose file in this repository to start Redis:

   $ docker compose up -d

   Note: It can take several minutes to load the whole data into your pc's memory. Also, you should have at least 7GB of RAM available for Redis.

4. Download Dataset

   Download the needed dataset from Github at Data_for_LibRadar (It's a CSV file).

Usage

Ordinary (no Redis)

To use LibRadar with the default configuration, you can start with the following command:

$ python3 -m LibRadar -D lite_dataset_10.csv -A data/strict_api.csv \
    -R data/tag_rules.csv \
    -vv /path/to/your/dexFile.dex

You can scan whole directories by just adding a -r to the command and enable threading with --parallel:

$ python3 -m LibRadar -D lite_dataset_10.csv -A data/strict_api.csv \
    -R data/tag_rules.csv \
    --parallel -vv \
    -r /path/to/your/dexDirectory

The commands above using the dataset are equivalent to:

$ python3 -m LibRadar --client InMemoryDataset:lite_dataset_10.csv ...

With Redis

To use LibRadar with Redis, use the following command after the database is ready to accept connections:

$ python3 -m LibRadar --client RedisClient:db=2 -A data/strict_api.csv \
    -R data/tag_rules.csv \
    -vv /path/to/your/dexFile1.dex /path/to/your/dexFile2.dex

Contributing

Contributions to this fork of LibRadar are welcome. Feel free to submit bug reports, feature requests, or pull requests.

License

This fork of LibRadar is licensed under the Apache 2 License.