Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/saferwall/saferwall

:cloud: Collaborative Malware Analysis Platform at Scale
https://github.com/saferwall/saferwall

antivirus dynamic-analysis malware malware-analysis multiav portable-executable sandbox security-tools static-analysis

Last synced: 6 days ago
JSON representation

:cloud: Collaborative Malware Analysis Platform at Scale

Host: GitHub
URL: https://github.com/saferwall/saferwall
Owner: saferwall
License: apache-2.0
Created: 2018-12-15T06:38:12.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2024-09-14T01:01:38.000Z (about 2 months ago)
Last Synced: 2024-09-15T14:37:57.623Z (about 2 months ago)
Topics: antivirus, dynamic-analysis, malware, malware-analysis, multiav, portable-executable, sandbox, security-tools, static-analysis
Language: Go
Homepage: https://saferwall.com
Size: 105 MB
Stars: 688
Watchers: 25
Forks: 123
Open Issues: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md

Awesome Lists containing this project

awesome-morocco - saferwall - A hackable malware sandbox for the 21st Century. by [@LordNoteworthy](https://github.com/LordNoteworthy) (Uncategorized / Uncategorized)
awesome-hacking-lists - saferwall/saferwall - :cloud: Collaborative Malware Analysis Platform at Scale (Go)

README

        




Collaborative and Streamlined Threat Analysis at Scale





  

  

  

  

  

  

  

  


Saferwall allows you to analyze, triage and classify threats in just minutes.

:star: **Collaborative** - Built for _security teams_ and _researchers_ to streamline analysis, identification and sharing malware samples.

:cloud: **Fast & cloud-native** - Scalable and cloud-native by design, deploy in minutes to bare metal or in the cloud.

:zap: **Save time** - Automate cumbersome tasks, generate IoC's and reports with **zero friction**.

:package: **Batteries included** - All your favorite tools included, build intelligence feeds for hunting threats or generating signatures.

:heart: **Open source first** - We are _open-source_, _developer friendly_ and _user driven._



## Batteries Included

- Static Analysis:

  - File metadata, packer identification and crypto hashes.

  - String (ASCII/Unicode and ASM) extraction.

  - [PE (Portable Executable) file parser](https://github.com/saferwall/pe).

  - [ELF (Executable Linkable Format) file parser](https://github.com/saferwall/elf).

- Dynamic Analysis:

  - Automated Malware Analysis using a Hypervisor based VM.

  - Intercepting OS System Calls to build an execution trace of executable files.

  - Generate detailed reports and gain insight into malware behavior.

  - Choose which API's to trace, grab _screenshots_ and file changes as well as memory dumps.

- Multiple AV scanner supporting major vendors:

  | Vendors     | status             | Vendors          | status             |

  | ----------- | ------------------ | ---------------- | ------------------ |

  | Avast       | :heavy_check_mark: | FSecure          | :heavy_check_mark: |

  | Avira       | :heavy_check_mark: | Kaspersky        | :heavy_check_mark: |

  | Bitdefender | :heavy_check_mark: | McAfee           | :heavy_check_mark: |

  | ClamAV      | :heavy_check_mark: | Sophos           | :heavy_check_mark: |

  | Comodo      | :heavy_check_mark: | Symantec         | :heavy_check_mark: |

  | ESET        | :heavy_check_mark: | Windows Defender | :heavy_check_mark: |

  | TrendMicro  | :heavy_check_mark: | DrWeb            | :heavy_check_mark: |

- Integrations with your own data processing pipeline.

## Get Started

Saferwall takes advantage of [Kubernetes](https://kubernetes.io/) for its high availability, scalability and ecosystem behind it.

Everything runs inside Kubernetes. You can either deploy it in the cloud or have it self hosted.

Here are the different deployment options available depending on how you are planning to use it:

- _"I want to try it first"_ : Use the cloud instance in [https://saferwall.com](https://saferwall.com).

- _"I want to run it locally"_ : A [Vagrant](https://www.vagrantup.com/) box is available, the only requirements are VirtualBox and Vagrant with full support

  of Windows, Linux and OSX, see [the guide](docs/DEPLOYING-TEST.md) for detailed steps.

- _"I want to make a PR or make changes"_ : When you intend to make changes to the code or make PR's, see [this guide](docs/DEPLOYING-DEV.md) for detailed steps.

- _"I love it ! I want to run it in prod"_ : First get you a [kops](https://github.com/kubernetes/kops) and check [this guide](docs/DEPLOYING-PROD.md).

The _production_ deployment using Kops automatically provisions a Kubernetes cluster hosted on AWS, GCE, DigitalOcean or OpenStack and also on bare metal. For the time being, only [AWS](https://aws.amazon.com/) is officially supported. A [helm](https://helm.sh/) chart is also provided for fast deployment. This setup works well for companies or small teams planning to scan a massive amounts of file.

## Our Stack:

- Golang mostly.

- Backend: [Echo](https://echo.labstack.com/)

- Frontend: [VueJS](https://vuejs.org/) + [Tailwind.css](https://tailwindcss.com/)

- Messaging: [NSQ](https://nsq.io/)

- Database: [Couchbase](https://www.couchbase.com/)

- Logging: [Grafana Loki](https://grafana.com/oss/loki/)

- Metrics: [Prometheus](https://prometheus.io/)

- Visualization: [Grafana](https://grafana.com/grafana/)

- MinIO: [Object storage](https://min.io/)

- Deployment: [Helm](https://helm.sh/) + [Kubernetes](https://kubernetes.io/)

## Current architecture / Workflow:



Here is a basic workflow of what happens when a new file is submitted:

- Frontend talks to the the backend via REST APIs.

- Backend uploads samples to the object storage.

- Backend pushes a message into the scanning queue.

- Consumer fetches the file and copies it to the nfs share avoiding to pull the sample on every container.

- Consumer starts scanning routines for static information such as (File metadata, File format details...)

- Consumer calls asynchronously scanning services (like AV scanners) via gRPC calls and waits for results.

## Acknowledgements

- [horsicq](https://github.com/horsicq) for [Detect It Easy](https://github.com/horsicq/Detect-It-Easy).

## Contributing

Please read [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.