Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pr0v3rbs/FirmAE
Towards Large-Scale Emulation of IoT Firmware for Dynamic Analysis
https://github.com/pr0v3rbs/FirmAE
analysis arbitration emulation firmware fuzzing
Last synced: 12 days ago
JSON representation
Towards Large-Scale Emulation of IoT Firmware for Dynamic Analysis
- Host: GitHub
- URL: https://github.com/pr0v3rbs/FirmAE
- Owner: pr0v3rbs
- License: mit
- Created: 2020-09-22T06:20:51.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-22T12:45:52.000Z (about 1 year ago)
- Last Synced: 2024-03-28T15:17:02.070Z (9 months ago)
- Topics: analysis, arbitration, emulation, firmware, fuzzing
- Language: Python
- Homepage:
- Size: 1.42 MB
- Stars: 572
- Watchers: 16
- Forks: 111
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-rainmana - pr0v3rbs/FirmAE - Towards Large-Scale Emulation of IoT Firmware for Dynamic Analysis (Python)
README
# FirmAE
FirmAE is a fully-automated framework that performs emulation and vulnerability analysis. FirmAE significantly increases the emulation success rate (From [Firmadyne](https://github.com/firmadyne/firmadyne)'s 16.28% to 79.36%) with five arbitration techniques. We tested FirmAE on 1,124 wireless-router and IP-camera firmware images from top eight vendors.
We also developed a dynamic analysis tool for 0-day discovery, which infers web service information based on the filesystem and kernel logs of target firmware.
By running our tool on the succesfully emulation firmware images, we discovered 12 new 0-days which affect 23 devices.
# Installation
Note that we tested FirmAE on Ubuntu 18.04.
1. Clone `FirmAE`
```console
$ git clone --recursive https://github.com/pr0v3rbs/FirmAE
```
2. Run `download.sh` script.
```console
$ ./download.sh
```
3. Run `install.sh` script.
```console
$ ./install.sh
```
# Usage
1. Execute `init.sh` script.
```console
$ ./init.sh
```
2. Prepare a firmware.
```console
$ wget https://github.com/pr0v3rbs/FirmAE/releases/download/v1.0/DIR-868L_fw_revB_2-05b02_eu_multi_20161117.zip
```
3. Check emulation
```console
$ sudo ./run.sh -c
```
4. Analyze the target firmware
* Analysis mode uses the FirmAE analyzer
```console
$ sudo ./run.sh -a
```
* Run mode helps to test web service or execute custom analyzer
```console
$ sudo ./run.sh -r
```
## Debug
After `run.sh -c` finished.
1. User-level basic debugging utility. (Useful when an emulated firmware is network reachable)
```console
$ sudo ./run.sh -d
```
2. Kernel-level boot debugging.
```console
$ sudo ./run.sh -b
```
## Turn on/off arbitration
Check the five arbitrations environment variable in the `firmae.config`
```sh
$ head firmae.config
#!/bin/sh
FIRMAE_BOOT=true
FIRMAE_NETWORK=true
FIRMAE_NVRAM=true
FIRMAE_KERNEL=true
FIRMAE_ETC=true
if (${FIRMAE_ETC}); then
TIMEOUT=240
```
## Docker
First, prepare a docker image.
```console
$ ./docker-init.sh
```
### Parallel mode
Then, run one of the below commands. ```-ec``` checks only the emulation, and ```-ea``` checks the emulation and analyzes vulnerabilities.
```console
$ ./docker-helper.py -ec
$ ./docker-helper.py -ea
```
### Debug mode
After a firmware image successfully emulated.
```console
$ ./docker-helper.py -ed
```
# Evaluation
## Emulation result
Google spreadsheet -
[view](https://docs.google.com/spreadsheets/d/1dbKxr_WOZ7UmneOogug1Zykj1erpfk-GzRNni8DjroI/edit?usp=sharing)
## Dataset
Google drive -
[download](https://drive.google.com/file/d/1hdm75NVKBvs-eVH9rKb5xfgryNSnsg_8/view?usp=sharing)
# CVEs
- ASUS: [CVE-2019-20082](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2019-20082)
- Belkin: [Belkin01](https://github.com/pr0v3rbs/CVE/tree/master/Belkin01)
- D-Link: [CVE-2018-20114](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2018-20114),
[CVE-2018-19986](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2018-19986%20-%2019990#cve-2018-19986---hnap1setroutersettings),
[CVE-2018-19987](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2018-19986%20-%2019990#cve-2018-19987---hnap1setaccesspointmode),
[CVE-2018-19988](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2018-19986%20-%2019990#cve-2018-19988---hnap1setclientinfodemo),
[CVE-2018-19989](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2018-19986%20-%2019990#cve-2018-19989---hnap1setqossettings),
[CVE-2018-19990](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2018-19986%20-%2019990#cve-2018-19990---hnap1setwifiverifyalpha),
[CVE-2019-6258](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2019-6258),
[CVE-2019-20084](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2019-20084)
- TRENDNet: [CVE-2019-11399](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2019-11399),
[CVE-2019-11400](https://github.com/pr0v3rbs/CVE/tree/master/CVE-2019-11400)
# Authors
This research project has been conducted by [SysSec Lab](https://syssec.kr) at KAIST.
* [Mingeun Kim](https://pr0v3rbs.blogspot.kr/)
* [Dongkwan Kim](https://0xdkay.me/)
* [Eunsoo Kim](https://hahah.kim)
* [Suryeon Kim](#)
* [Yeongjin Jang](https://www.unexploitable.systems/)
* [Yongdae Kim](https://syssec.kaist.ac.kr/~yongdaek/)
# Citation
We would appreciate if you consider citing [our paper](https://syssec.kaist.ac.kr/pub/2020/kim_acsac2020.pdf) when using FirmAE.
```bibtex
@inproceedings{kim:2020:firmae,
author = {Mingeun Kim and Dongkwan Kim and Eunsoo Kim and Suryeon Kim and Yeongjin Jang and Yongdae Kim},
title = {{FirmAE}: Towards Large-Scale Emulation of IoT Firmware for Dynamic Analysis},
booktitle = {Annual Computer Security Applications Conference (ACSAC)},
year = 2020,
month = dec,
address = {Online}
}
```