README.md

Saferwall is an open source malware analysis platform.

It aims for the following goals:

• Provide a collaborative platform to share samples among malware researchers.
• Acts as a system expert, to help researchers generates an automated malware analysis report.
• Hunting platform to find new malwares.
• Quality ensurance for signature before releasing.

Features

• Static analysis:

  • Crypto hashes, packer identification
  • Strings extraction

• Multiple AV scanner which includes major antivirus vendors:

  Vendors	status	Vendors	status
  Avast	✔️	FSecure	✔️
  Avira	✔️	Kaspersky	✔️
  Bitdefender	✔️	McAfee	✔️
  ClamAV	✔️	Sophos	✔️
  Comodo	✔️	Symantec	✔️
  ESET	✔️	Windows Defender	✔️

Installation

Saferwall take advantage of kubernetes for its high availability, scalibility and the huge ecosystem behind it.

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

To make it easy to get a production grade Kubernetes cluster up and running, we use kops. It automatically provisions a kubernetes cluster hosted on AWS, GCE, DigitalOcean or OpenStack and also on bare metal. For the time being, only AWS is officially supported.

Steps: (This still needs to be improved)

1. Clone the project: git clone https://github.com/saferwall/saferwall
2. Using a debian linux, make sure build-essential are installed: sudo apt-get install build-essential.
3. Install it: make saferwall.
4. The AVs requires licenses, that is why the containers are not publicly avaibable. Rename the example.env to .env and fill the credentials according to which AVs you want to have. Also, put licenses under build/data and run: make build.
5. Edit the deployments/values.yaml to match your needs.
6. Logs are found elasticsearch:

Built with:

• Golang mostly.
• Backend: Echo
• Frontend: VueJS + Bulma
• Messaging: NSQ
• Database: Couchbase
• Logging: FileBeat + ElasticSearch + Kibanna
• Minio: Object storage
• Deployment: Helm + Kubernetes

Current architecture / Workflow:

Here is a basic workflow which happens during a file scan:

• 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 copy it into to the nfs share avoiding to pull the sample on every container.
• Consumer calls asynchronously scanning services (like AV scanners) via gRPC calls and waits for results.

Acknowledgements

• Fangdun Cai for the awesome vue-admin dashboard.
• horsicq for his tool Detect It Easy.

Contributing

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