{"id":20749449,"url":"https://github.com/cristianzsh/freki","last_synced_at":"2025-04-05T15:08:58.665Z","repository":{"id":39834799,"uuid":"283624144","full_name":"cristianzsh/freki","owner":"cristianzsh","description":":wolf: Malware analysis platform","archived":false,"fork":false,"pushed_at":"2024-01-29T19:05:34.000Z","size":14445,"stargazers_count":409,"open_issues_count":4,"forks_count":58,"subscribers_count":24,"default_branch":"master","last_synced_at":"2024-05-19T06:02:30.599Z","etag":null,"topics":["binary-analysis","docker","flask","hacktoberfest","malware","malware-analysis","malware-research","python3","reverse-engineering","self-hosted","self-hosted-api","self-hosting","static-analysis","threat-intelligence","virustotal","yara"],"latest_commit_sha":null,"homepage":"https://cristian.sh/freki","language":"YARA","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cristianzsh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":null,"patreon":null,"open_collective":"freki","ko_fi":"crhenr","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-07-29T23:38:18.000Z","updated_at":"2024-05-19T02:40:35.000Z","dependencies_parsed_at":"2024-04-07T22:44:52.999Z","dependency_job_id":null,"html_url":"https://github.com/cristianzsh/freki","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cristianzsh%2Ffreki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cristianzsh%2Ffreki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cristianzsh%2Ffreki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cristianzsh%2Ffreki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cristianzsh","download_url":"https://codeload.github.com/cristianzsh/freki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247353746,"owners_count":20925329,"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":["binary-analysis","docker","flask","hacktoberfest","malware","malware-analysis","malware-research","python3","reverse-engineering","self-hosted","self-hosted-api","self-hosting","static-analysis","threat-intelligence","virustotal","yara"],"created_at":"2024-11-17T08:23:03.631Z","updated_at":"2025-04-05T15:08:58.640Z","avatar_url":"https://github.com/cristianzsh.png","language":"YARA","funding_links":["https://opencollective.com/freki","https://ko-fi.com/crhenr"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"freki/app/static/imgs/logos/dark_full.svg\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://www.python.org/\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/python-3.x-blue?style=for-the-badge\u0026logo=python\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://www.codefactor.io/repository/github/cristianzsh/freki\"\u003e\n        \u003cimg src=\"https://img.shields.io/codefactor/grade/github/cristianzsh/freki?style=for-the-badge\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/cristianzsh/freki/blob/master/LICENSE\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/cristianzsh/freki?style=for-the-badge\"/\u003e\n    \u003c/a\u003e\n    \u003cimg src=\"https://img.shields.io/badge/OS-GNU%2FLinux-red?style=for-the-badge\u0026logo=linux\"/\u003e\n\u003c/p\u003e\n\n---\n\nFreki is a free and open-source malware analysis platform.\n\n## Goals\n\n1. Facilitate malware analysis and reverse engineering;\n2. Provide an easy-to-use REST API for different projects;\n3. Easy deployment (via Docker);\n4. Allow the addition of new features by the community.\n\n## Current features\n\n- Hash extraction.\n- VirusTotal API queries.\n- Static analysis of PE files (headers, sections, imports, capabilities, and strings).\n- Pattern matching with Yara.\n- Web interface and REST API.\n- User management.\n- Community comments.\n- Download samples.\n\nCheck our [online documentation](https://cristianzsh.github.io/freki) for more details.\n\nOpen an [issue](https://github.com/cristianzsh/freki/issues) to suggest new features. All contributions are welcome.\n\n## How to get the source code\n`git clone https://github.com/cristianzsh/freki.git`\n\n## Demo\n\nVideo demo: [https://youtu.be/brvNUPgw7ho](https://youtu.be/brvNUPgw7ho).\n\n## Running\n\n#### The easy way: Docker\n1. Install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).\n2. Edit the [.env](.env) file.\n3. If you are going to use it in production, edit [freki.conf](nginx/freki.conf) to enable HTTPS.\n4. Run `docker-compose up` or `make`.\n\n#### Other ways\nIf you want to use it locally (e.g., for development), please check our [online documentation](https://cristianzsh.github.io/freki) for more details.\n\n## How to cite this work\n\nFreki was presented at the XXI Brazilian Symposium on Information and Computational Systems Security (SBSeg 2021).\n\n```\n@inproceedings{sbseg_estendido,\n author = {Cristian Souza and Felipe Silva},\n title = {Freki: Uma Ferramenta para Análise Automatizada de Malware},\n booktitle = {Anais do XXI Simpósio Brasileiro em Segurança da Informação e de Sistemas Computacionais},\n location = {Evento Online},\n year = {2021},\n pages = {58--65},\n publisher = {SBC},\n address = {Porto Alegre, RS, Brasil},\n doi = {10.5753/sbseg_estendido.2021.17340},\n url = {https://sol.sbc.org.br/index.php/sbseg_estendido/article/view/17340}\n}\n```\n\n## License\n\nThis project is licensed under the GNU Affero General Public License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcristianzsh%2Ffreki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcristianzsh%2Ffreki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcristianzsh%2Ffreki/lists"}