• Stars
    star
    1,230
  • Rank 38,157 (Top 0.8 %)
  • Language
    Python
  • License
    GNU General Publi...
  • Created about 7 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Firmware Analysis and Comparison Tool

FACT Logo

The Firmware Analysis and Comparison Tool (FACT)

codecov 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 analyses. Additionally, it can compare several images or single files.
Furthermore, Unpacking, analysis and comparisons 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.8 - 3.11
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 20.04 (stable)
  • Ubuntu 22.04 (stable)
  • Debian 11 (stable)
  • Kali (experimental)

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

FACT can be installed and run via docker. See the FACT_docker repo for more.

The traditional 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 start_all_installed_fact_components 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 shut down the system by pressing Ctrl + c or by sending a SIGTERM to the start_all_installed_fact_components script.

Advanced Usage

🔥 We're currently working to improving our documentation, including installation, getting started and alike. Follow progress on our wiki pages. ✌️

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

Vagrant

We provide monthly and ready-to-use vagrant boxes of our master branch. Vagrant is an easy and convenient way to get started with FACT without having to install it on your machine. Just setup vagrant and import our provided box into VirtualBox. Our boxes can be found here!

Check out on how to get started with FACT and vagrant in our tutorial.

Thanks to @botlabsDev, who initially provided a Vagrantfile that is now, however, deprecated.

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
  • Black Hat Arsenal

Other

Social

License

    Firmware Analysis and Comparison Tool (FACT)
    Copyright (C) 2015-2023  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://www.gnu.org/licenses/>.
    
    Some plug-ins may have different licenses. If so, a license file is provided in the plug-in's folder.

More Repositories

1

awesome-embedded-and-iot-security

A curated list of awesome embedded and IoT security resources.
1,395
star
2

cwe_checker

cwe_checker finds vulnerable patterns in binary executables
Rust
1,088
star
3

friTap

The goal of this project is to help researchers to analyze traffic encapsulated in SSL or TLS.
JavaScript
257
star
4

dewolf

A research decompiler implemented as a Binary Ninja plugin.
Python
171
star
5

libdesock

A de-socketing library for fuzzing.
C
131
star
6

nvd-json-data-feeds

Community reconstruction of the legacy JSON NVD Data Feeds. This project uses and redistributes data from the NVD API but is neither endorsed nor certified by the NVD.
Shell
109
star
7

RoAMer

Robust Automated Malware Unpacker
Python
84
star
8

fact_extractor

Standalone Utility for FACT-like extraction
Python
80
star
9

LuckyCAT

A distributed fuzzing management framework
Python
63
star
10

iva

IVA is a system to scan for known vulnerabilities in software products installed inside an organization. IVA uses CPE identifiers to search for CVEs related to a software product.
Python
60
star
11

DeStroid

Fighting String Encryption in Android Malware
Python
53
star
12

butterfly

LibAFL components for stateful fuzzing
Rust
42
star
13

yapscan

Yapscan is a YAra based Process SCANner, aimed at giving more control about what to scan and giving detailed reports on matches.
Go
40
star
14

bountyhunter

A Caldera plugin for the emulation of complete, realistic cyberattack chains.
Python
40
star
15

socbed

A Self-Contained Open-Source Cyberattack Experimentation Testbed
Python
35
star
16

pcapFS

A FUSE module to mount captured network data
C++
32
star
17

Logprep

log data pre processing, generation and shipping in python
Python
30
star
18

embedded-evaluation-corpus

firmware evaluation reference corpus
22
star
19

wattson

A co-simulation framework for reasearching cybersecurity in power grids.
Python
19
star
20

ipal_transcriber

Industrial protocol transcriber - a common representation of industrial communication as input for protocol-independent industrial intrusion detection systems.
Python
19
star
21

ipal_ids_framework

Industrial Intrusion Detection - A framework for protocol-independent industrial intrusion detection on top of IPAL.
Python
19
star
22

FACT_docker

Dockerfile for building the FACT container
Python
18
star
23

ipal_datasets

Industrial datasets - datasets for evaluating industrial intrusion detection systems on IPAL.
Python
14
star
24

FACT_analysis-plugin_CVE-lookup

FACT analysis plug-in that maps software version to cves
Python
13
star
25

headerParser

Header information parser for PE, ELF, DEX, MachO, ZIP (JAR, DocX).
C
13
star
26

blackbox-opcua-fuzzing

Python
9
star
27

Codescanner

Python
9
star
28

png-carving

PNG file carving related material
C++
8
star
29

mcritweb

JavaScript
7
star
30

bidcos-security-doc

A documentation of the Bidcos (homematic) radio protocol with focus on practical security aspects
Python
7
star
31

FACT_firmadyne_analysis_plugin

Integrates Firmadyne into FACT
Python
7
star
32

61850-fuzzing

This repository provides fuzzing scripts to analyze an IEC 61850 implementation
Python
6
star
33

woodblock

A framework to generate file carving test data.
Python
6
star
34

eeva

E²VA short for Exploitation Experience with Vulnerable App is a vulnerable app to learn userspace exploitation on Android
Java
6
star
35

common_analysis_oms

Offline Malware Scanner (OMS) scans files with multiple locally installed malware scanners.
Python
6
star
36

dewolf-logic

A graph-based logic engine for bitwise operations.
Python
5
star
37

fact_pdf_report

FACT PDF Report Generator
Python
4
star
38

maritime-dissector

A lua plugin for Wireshark which contains dissectors for common maritime protocols.
Lua
4
star
39

common_analysis_ip_and_uri

Detects IPv4 and IPv6 adresses as well as URIs
Python
4
star
40

Algorithmic-Heap-Layout-Manipulation-in-the-Linux-Kernel

Our artifacts to our Paper: "Algorithmic Heap Layout Manipulation in the Linux Kernel"
C
4
star
41

bpf-rootkit-workshop

Workshop: Forensic Analysis of eBPF based Linux Rootkits
C
4
star
42

bpmac

C
3
star
43

talk

NtDeviceIoControlFile talker
C
3
star
44

windowsScripts

A collection of some useful windows (batch) scripts.
Batchfile
3
star
45

common_helper_extraction

Extraction support functions
Python
3
star
46

cve-attribution-s2

Companion Repository to our the whitepaper "Towards Reliable and Scalable Linux Kernel CVE Attribution in Automated Static Firmware Analyses": https://arxiv.org/abs/2209.05217
Python
3
star
47

fact_helper_file

File type helper functions and magic library
Python
3
star
48

entropython

Efficient calculation of shannon byte entropy based on rust library.
Rust
3
star
49

docker_qemu_user

Phusion-based docker image containing the binaries for Qemu User Emulation
Shell
2
star
50

epf-parameter-screening

Shell
2
star
51

pidarci

PIdARCI Prototype Implementation
Python
2
star
52

FACT_analysis_plugin_template

Download this template if you want to write your own FACT analysis plug-in
Python
2
star
53

FACT_Search_and_Download

This tool is intended to create a ground truth matching specific parameters for scientific research on firmware.
Python
2
star
54

common_helper_files

Python
2
star
55

common_helper_yara

Yara command line wrapper
Python
2
star
56

bamboo-chuck-norris-plugin

2
star
57

ELFbin

C
2
star
58

hexter

A minimal terminal hex viewer supporting reading, writing and searching in files and processes.
C
2
star
59

docker_ghidra_headless_base

base docker image for ghidra headless scripting
Dockerfile
2
star
60

ssdeeper

Supplemental material for our paper: ssdeeper - Evaluating and Improving ssdeep.
Shell
1
star
61

common_helper_filter

generate nice structured output
Python
1
star
62

cwe_checker_travis_docker_image

Docker image with current BAP (opam testing) and other dependencies for fast testing of cwe_checker on travis
Dockerfile
1
star
63

mana

Python
1
star
64

FACT_remote_plugin_runner

Base class for FACT remote analysis systems
1
star
65

epf-case-study

C
1
star
66

fact_radare_viewer

Start radare webUI via REST in container and deliver url to view
Python
1
star
67

socbed-eval-acsac-2021

SOCBED evaluation code and dataset as presented at ACSAC 2021
Python
1
star
68

ei2f

C++
1
star
69

common_helper_unpacking_classifier

Try to guess if unpacking a container was successfull.
Python
1
star
70

docker-radare-web-gui

Dockerfile for Radare2 web gui
Shell
1
star
71

dewolf-idioms

A new approach for compiler idioms handling that automatically generates patterns to annotate them.
Python
1
star
72

conpot-plus

Python
1
star
73

frida-emulator-bypass

1
star
74

common_helper_passwords

Helper functions for handling password lists and files.
Python
1
star
75

Web-Content-Integrity

Web Content Integrity: Tamper-proof websites beyond HTTPS
HTML
1
star
76

spmac

Python
1
star
77

common_helper_process

fail-safe process helpers
Python
1
star
78

powerowl

PowerOwl models power grids as a whole and allows to simulate their power-domain behavior.
Python
1
star
79

winDbgFixPte

Fixes WinDbg !pte command not working bug
C
1
star
80

DEXSLib

Currently, the project is being heavily refactored and is therefore in an unusable state. Android RE library for static forward and backward slicing
Java
1
star
81

fact_goblin_bindings

Goblin bindings for parsing ELF header information in FACT
Rust
1
star
82

linux-firmware-corpus

HTML
1
star