Skip to content

Commit

Permalink
bumped version for release and updated readme + changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
jstucke committed May 6, 2022
1 parent a427fac commit 13f9926
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 11 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
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 compares are based on plug-ins guaranteeing maximal flexibility and expandability.
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](https://fkie-cad.github.io/FACT_core/).

## Requirements
Expand All @@ -21,16 +21,15 @@ FACT is designed as a multiprocess application, the more Cores and RAM, the bett

Minimal | Recommended | Software
------- | ----------- | --------
4 Cores<br>8GB RAM<br>10 GB disk space | 16 Cores<br>64GB RAM<br>10* GB disk space | git<br>python 3.6 - 3.9<br>OS see below
4 Cores<br>8GB RAM<br>10 GB disk space | 16 Cores<br>64GB RAM<br>10* GB disk space | git<br>python 3.7 - 3.10<br>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 18.04, 20.04 (stable)
- Ubuntu 19.04 (experimental)
- Debian 9, 10 (experimental)
- Kali (tested on 2019.3 and 2019.4) (experimental)
- Fedora (tested on 31 and 33) (experimental)
- Ubuntu 18.04 (with Python >3.6)
- Ubuntu 20.04 (stable)
- Debian 10 (stable)
- Kali (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!**

Expand Down Expand Up @@ -89,6 +88,7 @@ We've been happy to show FACT in a number of BlackHat Arsenal sessions.
- [![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/)
- [![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/)
- [![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/)
- [![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)

### Other

Expand Down
2 changes: 1 addition & 1 deletion src/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
'''

__VERSION__ = '3.3-dev'
__VERSION__ = '3.3'
23 changes: 20 additions & 3 deletions src/web_interface/templates/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,34 @@ <h3 class="my-4">Change Log</h3>

<div class="row justify-content-center">
<div class="col-xl-8 col-lg-12" style="width:100%;column-count:2;column-rule:grey 1px dotted;column-gap:50px">
<h4>FACT 3.3-dev</h4>
<h4>FACT 3.3 (2022-05-06)</h4>
<ul>
<li>New or Improved Analysis
<ul>
<li>New plugin for finding and checking Linux kernel configurations.</li>
<li>New plugin for finding device trees.</li>
<li>New plugin for matching known software from the circ.lu hash library.</li>
<li>New plugin for detecting unintentionally leaked information in firmware.</li>
<li>New plugin for gathering hardware information.</li>
<li>The results of the cve_lookup plugin are now sorted by severity.</li>
<li>Added support for additional ISAs to the architecture detection plugin.</li>
<li>Added ruby and php linters to the source code analysis plugin.</li>
</ul>
</li>
<li>Improved loading of analysis tags.</li>
<li>Added support for searching firmware tags to the "basic search".</li>
<li>New Swagger documentation for all REST endpoints.</li>
<li>Added software signatures.</li>
<li>Added new feature to force single analysis update (will be removed when scheduling problems are fixed).</li>
<li>Added new feature to force single analysis and whole firmware analysis update (will be removed when scheduling problems are fixed).</li>
<li>Changed "update analysis" to skip the unpacking step ("re-do analysis" still unpacks).</li>
<li>Improved system monitoring page with live updates.</li>
<li>Improved dependency graph page.</li>
<li>New page for monitoring FACT logs.</li>
<li>New page for browsing previous "binary search" queries.</li>
<li>New hex preview for binary files on the analysis page.</li>
<li>New text file diffing feature.</li>
<li>Added support for Python virtual environments.</li>
<li>Improved CLI user management script.</li>
<li>Updated the web framework Flask to version 2.0
<ul>
<li>
Expand All @@ -76,7 +92,8 @@ <h4>FACT 3.3-dev</h4>
</li>
</ul>
</li>
<li>Bug fixes.</li>
<li>Improved documentation.</li>
<li>Bug fixes, stability improvements and better error reporting.</li>
</ul>

<h4>FACT 3.2 (2021-05-21)</h4>
Expand Down

0 comments on commit 13f9926

Please sign in to comment.