# FACT_core
**Repository Path**: shen-27/FACT_core
## Basic Information
- **Project Name**: FACT_core
- **Description**: Firmware Analysis and Comparison Tool
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-09-02
- **Last Updated**: 2022-02-18
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# The Firmware Analysis and Comparison Tool (FACT)
[](https://ci.die-weidenbachs.de/job/FACT_core_xenial)
[](https://ci.die-weidenbachs.de/job/FACT_core_bionic)
[](https://codecov.io/gh/fkie-cad/FACT_core)
[](https://bettercodehub.com/)
[](https://www.codacy.com/app/johannes.vom.dorp/FACT_core?utm_source=github.com&utm_medium=referral&utm_content=fkie-cad/FACT_core&utm_campaign=Badge_Grade)
[](https://gitter.im/FACT_core/community)
[](http://www.toolswatch.org/2018/01/black-hat-arsenal-asia-2018-great-lineup/)
The Firmware Analysis and Comparison Tool (formerly known as Fraunhofer's Firmware Analysis Framework (FAF)) is intended to automate most of the firmware analysis process.
It unpacks arbitrary firmware files and processes several analysis.
Additionally, it can compare several images or single files.
Furthermore, Unpacking, analysis and compares are based on plug-ins guaranteeing maximal flexibility and expandability.
More details and some screenshots can be found on our [project page](https://fkie-cad.github.io/FACT_core/).
## Requirements
FACT is designed as a multiprocess application, the more Cores and RAM, the better.
Minimal | Recommended | Software
------- | ----------- | --------
4 Cores
8GB RAM | 16 Cores
64GB RAM | Ubuntu (16.04 or 18.04)
Python 3.5 or above
It is possible to install FACT on any Linux distribution but the installer is limited to Ubuntu 16.04 and 18.04 at the moment.
:exclamation: **Caution: FACT is not intended to be used as public internet service. The GUI is not a hardened WEB-application and it may take your server at risk!**
## Installation
The installation is generally wrapped in a single script. Some features can be selected specifically though.
See [INSTALL.md](https://github.com/fkie-cad/FACT_core/blob/master/INSTALL.md) for details.
## Usage
You can start FACT by executing the *start_all_installed_fact_components* scripts.
The script detects all installed components automatically.
```sh
$ ./start_all_installed_fact_components
```
Afterwards FACT can be accessed on and (nginx), respectively.
You can shutdown the system by pressing *Ctrl + c* or by sending a SIGTERM to the *start_all_installed_faf_components* script.
## Advanced Usage
:fire: We're currently working to improving our documentation, including installation, getting started and alike. Follow progess on our [wiki pages](https://github.com/fkie-cad/FACT_core/wiki/). :v:
### REST API
FACT provides a REST API. More information can be found [here](https://github.com/fkie-cad/FACT_core/wiki/rest-documentation).
### User Management
FACT provides an optional basic authentication, role and user management. More information can be found [here](https://github.com/fkie-cad/FACT_core/wiki/Authentication).
## List of available community plug-ins and REST scripts
* Plug-ins
* [Firmadyne](https://github.com/fkie-cad/FACT_firmadyne_analysis_plugin)
* REST
* [FACT Search and Download](https://github.com/fkie-cad/FACT_Search_and_Download)
* [PDF Report Generator](https://github.com/any333/FACT_analysis_report_pdf_convertor)
## 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_core/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)
Copyright (C) 2015-2019 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.
```