Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fkie-cad/fact_extractor
Standalone Utility for FACT-like extraction
https://github.com/fkie-cad/fact_extractor
Last synced: 4 days ago
JSON representation
Standalone Utility for FACT-like extraction
- Host: GitHub
- URL: https://github.com/fkie-cad/fact_extractor
- Owner: fkie-cad
- License: gpl-3.0
- Created: 2019-02-11T09:20:24.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-13T12:21:26.000Z (18 days ago)
- Last Synced: 2025-01-20T23:11:20.996Z (11 days ago)
- Language: Python
- Size: 33.8 MB
- Stars: 81
- Watchers: 14
- Forks: 31
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-embedded-and-iot-security - FACT Extractor - Detects container format automatically and executes the corresponding extraction tool. (Software Tools / Extraction Tools)
README
# FACT extractor
Wraps FACT unpack plugins into standalone utility.
Should be able to extract most of the common container formats.
## Command line usage
Quickest usage if you have docker running:
```sh
docker pull fkiecad/fact_extractor
wget https://raw.githubusercontent.com/fkie-cad/fact_extractor/master/extract.py
chmod +x extract.py
./extract.py ./relative/or/absolute/path/to/your/file
```
for more options see
```sh
./extract.py --help
```
## Local setup (aka not running through docker)
Install with:
```bash
fact_extractor/install/pre_install.sh
fact_extractor/install.py
```
:warning: **We no longer support Ubuntu 18.04 and Python <3.8**
(It may still work with a bit of tinkering, though)
:warning: For the `generic_fs` unpacker plugin to work with all file system types, you may need to install extra kernel modules
```sh
sudo apt install linux-modules-extra-$(uname -r)
```
The tool can then be run with
```bash
fact_extractor/fact_extract.py [OPTIONS] PATH_TO_FIRMWARE
```
The tool is build with docker in mind.
To that end it extracts all files into a directory specified in the config.
The same directory also contains the meta data report.
Directories are created during installation, if config is changed make sure to recreate the folder structure.
It looks like:
```text
├── files
└── reports
```
## Use docker container directly
Build with
```bash
docker build -t fact_extractor .
```
(Replace `fact_extractor` with own id if you like)
The docker execution was build so that a single shared directory can be used for container input and output.
Prepare a folder on the host system that resembles
```text
├── files
├── input
│ └── firmware_file
└── reports
```
where **firmware_file** is the file you want to unpack.
Run the extraction with
```bash
docker run -v :/tmp/extractor -v /dev:/dev --privileged --rm fact_extractor
```
(see above)
:warning: Note that the container is run in privileged mode and shares the /dev folder. Thus the container can possibly harm your system in every way.
## Contribute
The easiest way to contribute is writing your own plug-in.
Our Developers Manual can be found [here](https://github.com/fkie-cad/fact_extractor/wiki).
## Acknowledgments
This project is partly financed by [German Federal Office for Information Security (BSI)](https://www.bsi.bund.de) and others.
## License
```
Firmware Analysis and Comparison Tool (FACT) extractor
Copyright (C) 2015-2022 Fraunhofer FKIE
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Some plug-ins may have different licenses. If so, a license file is provided in the plug-in's folder.
```