github.com/maliceio/go-malice/api

VirusTotal Wanna Be - Now with 100% more Hipster


Keywords
antivirus, cloud, cybersecurity, dfir, docker, elasticsearch, golang, infosec, malice, malware, malware-analysis, malware-research, virustotal
License
Apache-2.0
Install
go get github.com/maliceio/go-malice/api

Documentation

malice logo

malice

CircleCI License GoDoc Slack

Malice's mission is to be a free open source version of VirusTotal that anyone can use at any scale from an independent researcher to a fortune 500 company.

Setup Docker (OSX)

Install Docker for Mac

-Or-

Install with homebrew.

$ brew install caskroom/cask/brew-cask
$ brew cask install virtualbox
$ brew install docker
$ brew install docker-machine
$ docker-machine create --driver virtualbox --engine-storage-driver overlay malice
$ eval $(docker-machine env malice)

Getting Started (OSX)

Install

$ brew install https://raw.githubusercontent.com/maliceio/malice/master/contrib/homebrew/Formula/malice.rb
Usage: malice [OPTIONS] COMMAND [arg...]

Open Source Malware Analysis Framework

Version: 0.1.0-alpha, build HEAD

Author:
  blacktop - <https://github.com/blacktop>

Options:
  --debug, -D   Enable debug mode [$MALICE_DEBUG]
  --help, -h    show help
  --version, -v print the version

Commands:
  scan      Scan a file
  watch     Watch a folder
  lookup    Look up a file hash
  elk       Start an ELK docker container
  web       Start, Stop Web services
  plugin    List, Install or Remove Plugins
  help      Shows a list of commands or help for one command

Run 'malice COMMAND --help' for more information on a command.

Scan some malware

$ malice scan evil.malware

NOTE: On the first run malice will download all of it's default plugins which can take a while to complete.

Malice will output the results as a markdown table that can be piped or copied into a results.md that will look great on Github see here

Once the scan completes you can open the Kibana UI and look at the scan results here: http://localhost (assuming you are using Docker for Mac)

kibana-setup

  • Type in malice as the Index name or pattern and click Create.

  • Now click on the Discover Tab and behold!!!

kibana-scan

Getting Started (Docker in Docker)

Docker Stars Docker Pulls Docker Image

Install/Update all Plugins

docker run --rm -v /var/run/docker.sock:/var/run/docker.sock malice/engine plugin update --all

Scan a file

docker run --rm -v /var/run/docker.sock:/var/run/docker.sock \
                -v `pwd`:/malice/samples \
                -e MALICE_VT_API=$MALICE_VT_API \
                malice/engine scan SAMPLE

Documentation

Known Issues ⚠️

I have noticed when running the new 5.0 version of blacktop/elastic-stack on a linux host you need to increase the memory map areas with the following command

sudo sysctl -w vm.max_map_count=262144

Issues

Find a bug? Want more features? Find something missing in the documentation? Let me know! Please don't hesitate to file an issue

CHANGELOG

See CHANGELOG.md

License

Apache License (Version 2.0)
Copyright (c) 2013 - 2016 blacktop Joshua Maine