Skip to content

Latest commit

 

History

History
83 lines (63 loc) · 2.82 KB

README.md

File metadata and controls

83 lines (63 loc) · 2.82 KB
Raw

Freki is a free and open-source malware analysis platform.

Goals

  1. Facilitate malware analysis and reverse engineering;
  2. Provide an easy-to-use REST API for different projects;
  3. Easy deployment (via Docker);
  4. Allow the addition of new features by the community.

Current features

  • Hash extraction.
  • VirusTotal API queries.
  • Static analysis of PE files (headers, sections, imports, capabilities, and strings).
  • Pattern matching with Yara.
  • Web interface and REST API.
  • User management.
  • Community comments.
  • Download samples.

Check our online documentation for more details.

Open an issue to suggest new features. All contributions are welcome.

How to get the source code

git clone https://github.com/cristianzsh/freki.git

Demo

Video demo: https://youtu.be/brvNUPgw7ho.

Running

The easy way: Docker

  1. Install Docker and Docker Compose.
  2. Edit the .env file.
  3. If you are going to use it in production, edit freki.conf to enable HTTPS.
  4. Run docker-compose up or make.

Other ways

If you want to use it locally (e.g., for development), please check our online documentation for more details.

How to cite this work

Freki was presented at the XXI Brazilian Symposium on Information and Computational Systems Security (SBSeg 2021).

@inproceedings{sbseg_estendido,
 author = {Cristian Souza and Felipe Silva},
 title = {Freki: Uma Ferramenta para Análise Automatizada de Malware},
 booktitle = {Anais do XXI Simpósio Brasileiro em Segurança da Informação e de Sistemas Computacionais},
 location = {Evento Online},
 year = {2021},
 pages = {58--65},
 publisher = {SBC},
 address = {Porto Alegre, RS, Brasil},
 doi = {10.5753/sbseg_estendido.2021.17340},
 url = {https://sol.sbc.org.br/index.php/sbseg_estendido/article/view/17340}
}

License

This project is licensed under the GNU Affero General Public License.