search

fkie-cad / FACT_core

Firmware Analysis and Comparison Tool
https://fkie-cad.github.io/FACT_core
GNU General Public License v3.0
1.23k stars 224 forks source link

Install automation with ansible, questions #558

Open juju4 opened 3 years ago

juju4 commented 3 years ago

Thanks a lot for your work. Great project!

I'm building an ansible role to automate setup of FACT. https://github.com/juju4/ansible-fact/ for now, devel branch is using python installer and working fine in Azure + Ubuntu 18.04 or 20.04. (with some github action only issues) Still work on Fedora/RHEL side and working on a full ansible install in separate branch without python installer.

I have a few questions

jstucke commented 3 years ago

Hi and thank you!

any way to test submission of example router file like https://github.com/praetorian-inc/DVRF/blob/master/Firmware/DVRF_v03.bin through CLI or API? that would also be useful to submit large firmware locally. tried 1GB TV firmware and did not submit...

Submitting very large firmware images is currently an issue because the request may time out. We are addressing this issue in #552 (at least for the frontend). Did you try the REST endpoint (see https://github.com/fkie-cad/FACT_core/wiki/Rest-API)?

any other tests that would be useful to ensure instance is functional?

Did you try running pytest? The tests should cover most of the functionalities in FACT.

any way to avoid the use of docker privileged in extractor?

Docker privileged is needed for mounting file systems in the extractor (in order to unpack them). We haven't found a good way to circumvent this yet.

on backup & restore, need mongodump, /media/data. anything else?

Maybe the configuration files inside src/config if you made changes to them. The config file for FACT (main.cfg) is especially important as it contains the password that is also used for DB authentication.

juju4 commented 3 years ago

Sorry for delayed update. Yes, REST API was what I was looking for. not sure how I missed it or if added recently. pytest: again, right what I need. Thanks! Added both to my verify playbook

on backup/restore, I was more thinking on data/reports because if setup is automated which it is with ansible, config does not really matter. If many analysis/processing done, we probably want to be able to keep results and restore without reprocessing everything. was more thinking on this side.

dorpvom commented 3 years ago

Regarding backup, there is an old issue similar to what you intend I think #446. We haven't addressed this since. I guess it should not be overly complicated writing a naive script to backup data files and database entries recursively. If you are interested in writing something yourself, we could provide some pointers as to where to start and possible pitfalls.