{"id":13529902,"url":"https://fkie-cad.github.io/FACT_core/","last_synced_at":"2025-04-01T17:31:34.325Z","repository":{"id":37773803,"uuid":"104088122","full_name":"fkie-cad/FACT_core","owner":"fkie-cad","description":"Firmware Analysis and Comparison Tool","archived":false,"fork":false,"pushed_at":"2025-03-27T15:10:43.000Z","size":61219,"stargazers_count":1311,"open_issues_count":115,"forks_count":230,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-03-27T23:02:43.428Z","etag":null,"topics":["firmware-analysis","firmware-tools","security","security-automation"],"latest_commit_sha":null,"homepage":"https://fkie-cad.github.io/FACT_core","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fkie-cad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-19T14:48:11.000Z","updated_at":"2025-03-21T08:03:16.000Z","dependencies_parsed_at":"2022-07-04T08:01:12.787Z","dependency_job_id":"fa51555d-6cff-44dc-a573-fd9615319ba4","html_url":"https://github.com/fkie-cad/FACT_core","commit_stats":{"total_commits":4190,"total_committers":48,"mean_commits":87.29166666666667,"dds":0.6026252983293556,"last_synced_commit":"5890119500ea39ffa428e66378238fe18c4a2129"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fkie-cad%2FFACT_core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fkie-cad%2FFACT_core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fkie-cad%2FFACT_core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fkie-cad%2FFACT_core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fkie-cad","download_url":"https://codeload.github.com/fkie-cad/FACT_core/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246680288,"owners_count":20816670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["firmware-analysis","firmware-tools","security","security-automation"],"created_at":"2024-08-01T07:00:40.486Z","updated_at":"2025-04-01T17:31:29.308Z","avatar_url":"https://github.com/fkie-cad.png","language":"Python","funding_links":[],"categories":["Testing Tools","Software Tools"],"sub_categories":["Firmware Analysis and Exploit Frameworks","Analysis Frameworks","Security Auditing Frameworks"],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"src/web_interface/static/FACT_smaller.png\" alt=\"FACT Logo\" width=\"625\" height=\"263\"/\u003e\n\u003c/p\u003e\n\n# The Firmware Analysis and Comparison Tool (FACT)\n\n[![codecov](https://codecov.io/gh/fkie-cad/FACT_core/branch/master/graph/badge.svg)](https://codecov.io/gh/fkie-cad/FACT_core)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d3910401cb58498a8c2d00be80092080)](https://www.codacy.com/gh/fkie-cad/FACT_core/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=fkie-cad/FACT_core\u0026amp;utm_campaign=Badge_Grade)\n[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/FACT_core/community)\n\nThe Firmware Analysis and Comparison Tool (formerly known as Fraunhofer's Firmware Analysis Framework (FAF)) is intended to automate most of the firmware analysis process. \nIt unpacks arbitrary firmware files and processes several analyses.\nAdditionally, it can compare several images or single files.  \nFurthermore, Unpacking, analysis and comparisons are based on plug-ins guaranteeing maximal flexibility and expandability.  \nMore details and some screenshots can be found on our [project page](https://fkie-cad.github.io/FACT_core/).\n\n## Requirements\n\nFACT is designed as a multiprocess application, the more Cores and RAM, the better.\n\nMinimal | Recommended | Software\n------- | ----------- | --------\n4 Cores\u003cbr\u003e8GB RAM\u003cbr\u003e10 GB disk space | 16 Cores\u003cbr\u003e64GB RAM\u003cbr\u003e10* GB disk space | git\u003cbr\u003epython 3.8 - 3.11\u003cbr\u003eOS see below\n\n\u003e ~ 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.\n\nIt is possible to install FACT on any Linux distribution, but the installer is limited to\n- Ubuntu 20.04 (stable)\n- Ubuntu 22.04 (stable)\n- Debian 11 (stable)\n- Kali (experimental)\n\n: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!**\n\n## Installation\nFACT can be installed and run via docker. See the [FACT_docker](https://github.com/fkie-cad/FACT_docker) repo for more.\n\nThe traditional installation is generally wrapped in a single script. Some features can be selected specifically though.\nSee [INSTALL.md](https://github.com/fkie-cad/FACT_core/blob/master/INSTALL.md) for details.\n\n## Usage\nYou can start FACT by executing the *start_all_installed_fact_components* scripts.\nThe script detects all installed components automatically.\n\n```sh\n$ ./start_all_installed_fact_components\n```\n\nAfterwards FACT can be accessed on \u003chttp://localhost:5000\u003e and \u003chttps://localhost\u003e (nginx), respectively.  \n\nYou can shut down the system by pressing *Ctrl + c* or by sending a SIGTERM to the *start_all_installed_fact_components* script.\n\n## Advanced Usage\n\n:fire: We're currently working to improving our documentation, including installation, getting started and alike. Follow progress on our [wiki pages](https://github.com/fkie-cad/FACT_core/wiki/). :v:\n\n### REST API\nFACT provides a REST API. More information can be found [here](https://github.com/fkie-cad/FACT_core/wiki/Rest-API).\n\n### User Management\nFACT provides an optional basic authentication, role and user management. More information can be found [here](https://github.com/fkie-cad/FACT_core/wiki/Authentication).\n\n## List of available community plug-ins and REST scripts\n* Plug-ins\n  * [CVE Lookup](https://github.com/fkie-cad/FACT_analysis-plugin_CVE-lookup)\n  * [Firmadyne](https://github.com/fkie-cad/FACT_firmadyne_analysis_plugin)\n* REST\n  * [FACT Search and Download](https://github.com/fkie-cad/FACT_Search_and_Download)\n  * [PDF Report Generator](https://github.com/fkie-cad/fact_pdf_report)\n\n## Vagrant\nWe provide monthly and ready-to-use vagrant boxes of our master branch. [Vagrant](https://www.vagrantup.com/) 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](https://app.vagrantup.com/fact-cad/boxes/FACT-master)!\n\nCheck out on how to get started with FACT and vagrant in our [tutorial](https://github.com/fkie-cad/FACT_core/blob/master/INSTALL.vagrant.md).\n\n*Thanks to @botlabsDev, who initially provided a [Vagrantfile](https://github.com/botlabsDev/FACTbox) that is now, however, deprecated.*\n\n## Contribute\nThe easiest way to contribute is writing your own plug-in.\nOur Developers Manual can be found [here](https://github.com/fkie-cad/FACT_core/wiki/).\n\n## Acknowledgments\nThis project is partly financed by [German Federal Office for Information Security (BSI)](https://www.bsi.bund.de) and others.  \n\n## Publications / Presentations\n\n### BlackHat Arsenal\n\nWe've been happy to show FACT in a number of BlackHat Arsenal sessions.\n\n- [![Black Hat Arsenal](https://github.com/toolswatch/badges/blob/master/arsenal/asia/2018.svg)](http://www.toolswatch.org/2018/01/black-hat-arsenal-asia-2018-great-lineup/)\n- [![Black Hat Arsenal](https://github.com/toolswatch/badges/blob/master/arsenal/europe/2018.svg)](http://www.toolswatch.org/2018/09/black-hat-arsenal-europe-2018-lineup-announced/)\n- [![Black Hat Arsenal](https://github.com/toolswatch/badges/blob/master/arsenal/usa/2019.svg)](http://www.toolswatch.org/2019/05/amazing-black-hat-arsenal-usa-2019-lineup-announced/)\n- [![Black Hat Arsenal](https://github.com/toolswatch/badges/blob/master/arsenal/europe/2019.svg)](https://www.blackhat.com/eu-19/arsenal/schedule/#fact--firmware-analysis-and-comparison-tool-18179)\n\n### Other\n\n- [Hardwear.io 2017](https://hardwear.io/the-hague-2017/speakers/johannes-vom-dorp.php) / [Slides](https://hardwear.io/document/hio.pdf)\n- [Pass the salt 2019](https://2019.pass-the-salt.org/talks/71.html) / [Slides](https://2019.pass-the-salt.org/files/slides/04-FACT.pdf) / [Video](https://passthesalt.ubicast.tv/videos/improving-your-firmware-security-analysis-process-with-fact/)\n- [Hardwear.io 2019](https://hardwear.io/netherlands-2019/speakers/johannes-vom-dorp-and-peter-weidenbach.php)\n\n## Social\n\n- \u003ca rel=\"me\" href=\"https://infosec.exchange/@fact\"\u003eMastodon\u003c/a\u003e\n- [Twitter](https://twitter.com/FAandCTool)\n\n## License\n```\n    Firmware Analysis and Comparison Tool (FACT)\n    Copyright (C) 2015-2024  Fraunhofer FKIE\n\n    This program is free software: you can redistribute it and/or modify\n    it under the terms of the GNU General Public License as published by\n    the Free Software Foundation, either version 3 of the License, or\n    (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU General Public License for more details.\n\n    You should have received a copy of the GNU General Public License\n    along with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n    \n    Some plug-ins may have different licenses. If so, a license file is provided in the plug-in's folder.\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/fkie-cad.github.io%2FFACT_core%2F","html_url":"https://awesome.ecosyste.ms/projects/fkie-cad.github.io%2FFACT_core%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/fkie-cad.github.io%2FFACT_core%2F/lists"}