# quark-engine **Repository Path**: xynsd/quark-engine ## Basic Information - **Project Name**: quark-engine - **Description**: No description available - **Primary Language**: Unknown - **License**: GPL-3.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-12-31 - **Last Updated**: 2021-12-31 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
An Obfuscation-Neglect Android Malware Scoring System
[](https://asciinema.org/a/416810)
## Why Quark?
Android malware analysis engine is not a new story. Every antivirus company has their own secrets to build it. With curiosity, we develop a malware scoring system from the perspective of Taiwan Criminal Law in an easy but solid way.
We have an order theory of criminal which explains stages of committing a crime. For example, crime of murder consists of five stages, they are determined, conspiracy, preparation, start and practice. The latter the stage the more we’re sure that the crime is practiced.
According to the above principle, ```we developed our order theory of android malware```. We developed five stages to see if the malicious activity is being practiced. They are 1. Permission requested. 2. Native API call. 3. Certain combination of native API. 4. Calling sequence of native API. 5. APIs that handle the same register. We not only define malicious activities and their stages but also develop weights and thresholds for calculating the threat level of a malware.
Malware evolved with new techniques to gain difficulties for reverse engineering. Obfuscation is one of the most commonly used techniques. In this talk, we present a Dalvik bytecode loader with the order theory of android malware to neglect certain cases of obfuscation.
Our Dalvik bytecode loader consists of functionalities such as 1. Finding cross reference and calling sequence of the native API. 2. Tracing the bytecode register. The combination of these functionalities (yes, the order theory) not only can neglect obfuscation but also match perfectly to the design of our malware scoring system.
## Easy to Use and Reading Friendly Report
Quark is very easy to use and also provides flexible output formats. There are 6 types of output reports: detail report,
call graph, rules classification, summary report, label-based report, behaviors comparison radar chart. Please see below for more details.
### Detail Report
This is how we examine a real android malware (candy corn) with one single rule (crime).
```bash
$ quark -a 14d9f1a92dd984d6040cc41ed06e273e.apk -d
```
and the report will look like:
There is the possibility to select only one label to filter the rules:
```bash
quark -a 14d9f1a92dd984d6040cc41ed06e273e.apk -d network
```
There is also the possibility to select only one rule:
```bash
quark -a 14d9f1a92dd984d6040cc41ed06e273e.apk -d 00058.json
```
### Call Graph for Every Potential Malicious Activity
You can add the `-g` option to the quark command, and you can
get the call graph (only those rules match with 100% confidence)
```bash
quark -a Ahmyth.apk -s -g
```
### Rules Classification
You can add the `-c` option to the quark command, and you can
output the rules classification with the mutual parent function (only those rules match with 100% confidence).
```bash
quark -a Ahmyth.apk -s -c
```
### Summary Report
Examine with rules.
```bash
quark -a 14d9f1a92dd984d6040cc41ed06e273e.apk -s
```
There is the possibility to select only one label to filter the rules:
```bash
quark -a 14d9f1a92dd984d6040cc41ed06e273e.apk -s network
```
There is also the possibility to select only one rule:
```bash
quark -a 14d9f1a92dd984d6040cc41ed06e273e.apk -s
### Behaviors Comparison Radar Chart
With the following command, you can compare different APK actions based on the max confidence of rule labels and generate
a radar chart.
```bash
quark -a first.apk -a second.apk -C
```
### Parallelizing Quark
Now Quark supports multiprocessing for analyzing APKs parallelly, by adding the option `--multi-process` and set the number of processes. (the default is the number of CPUs in your computer.)
```bash
quark -a Ahmyth.apk -s --multi-process 4
```
### Upcoming unstable feature
Now Quark also supports [Rizin](https://github.com/rizinorg/rizin) as one of our Android analysis frameworks. You can use option `--core-library` with `rizin` to enable the Rizin-based analysis library.
```bash
quark -a Ahmyth.apk -s --core-library rizin
```
## QuickStart
### Requirements
- Python 3.8+
- git
- graphviz
- click >= 8.0.1 (For CLI supports)
### Installation
```bash
$ pip3 install -U quark-engine
```
### Get the latest quark rules from our [quark-rules](https://github.com/quark-engine/quark-rules) repo
Now you can download the quark-rules to your home directory with a simple command.
```bash
$ freshquark
```
Check `--help` to see the detailed usage description.
```bash
$ quark --help
```
### Test It Out
You may refer to the [Quark Engine Document](https://quark-engine.readthedocs.io/en/latest/) for more details of testing and development information.
## Acknowledgments
#### The Honeynet Project
#### Google Summer Of Code
Quark-Engine has been participating in the GSoC under the Honeynet Project!
* 2021: Join us! [Projects available](https://www.honeynet.org/gsoc/gsoc-2021/google-summer-of-code-2021-project-ideas/)
Stay tuned for the upcoming GSoC! Join the [Honeynet Slack chat](https://gsoc-slack.honeynet.org/) for more info.
## Core Values of Quark Engine Team
* We love **battle fields**. We embrace **uncertainties**. We challenge **impossibles**. We **rethink** everything. We change the way people think.
And the most important of all, we benefit ourselves by benefit others **first**.