FACT_core

by fkie-cad

fkie-cad / FACT_core

Firmware Analysis and Comparison Tool

576 Stars 114 Forks Last release: 5 months ago (3.1) GNU General Public License v3.0 3.2K Commits 7 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

FACT Logo

The Firmware Analysis and Comparison Tool (FACT)

codecov BCH compliance Codacy Badge Gitter chat

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.

Requirements

FACT is designed as a multiprocess application, the more Cores and RAM, the better.

Minimal

Recommended Software
4 Cores
8GB RAM
10 GB disk space
16 Cores
64GB RAM
10* GB disk space
git
python 3.5 - 3.8
OS see below

~ 10 GB required to set up FACT code, container and binaries. Additional space is necessary for result storage. That can be on a separate partition or drive.

It is possible to install FACT on any Linux distribution but the installer is limited to - Ubuntu 16.04, 18.04, 20.04 (stable) - Deprecation warning: Ubuntu 16.04 support will be discontinued when Python 3.5 hits its End of Life in 09/2020 - Ubuntu 19.04 (experimental) - Debian 9, 10 (experimental) - Kali (tested on 2019.3 and 2019.4) (experimental)

: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 for details.

Usage

You can start FACT by executing the startallinstalledfactcomponents scripts. The script detects all installed components automatically.

$ ./start_all_installed_fact_components

Afterwards FACT can be accessed on http://localhost:5000 and https://localhost (nginx), respectively.

You can shutdown the system by pressing Ctrl + c or by sending a SIGTERM to the startallinstalledfactcomponents script.

Advanced Usage

:fire: We're currently working to improving our documentation, including installation, getting started and alike. Follow progress on our wiki pages. :v:

REST API

FACT provides a REST API. More information can be found here.

User Management

FACT provides an optional basic authentication, role and user management. More information can be found here.

List of available community plug-ins and REST scripts

Contribute

The easiest way to contribute is writing your own plug-in. Our Developers Manual can be found here.

Acknowledgments

This project is partly financed by German Federal Office for Information Security (BSI) and others.

Publications / Presentations

BlackHat Arsenal

We've been happy to show FACT in a number of BlackHat Arsenal sessions.

  • Black Hat Arsenal
  • Black Hat Arsenal
  • Black Hat Arsenal

Other

License

    Firmware Analysis and Comparison Tool (FACT)
    Copyright (C) 2015-2020  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 <http:></http:>.

Some plug-ins may have different licenses. If so, a license file is provided in the plug-in's folder.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.