escan

README

malice-escan

Malice eScan AntiVirus Plugin

---

Dependencies

• ubuntu:xenial (118 MB)

Installation

1. Install Docker.
2. Download trusted build from public DockerHub: docker pull malice/escan

Usage

docker run --rm malice/escan EICAR

Or link your own malware folder:

$ docker run --rm -v /path/to/malware:/malware:ro malice/escan FILE

Usage: escan [OPTIONS] COMMAND [arg...]

Malice eScan AntiVirus Plugin

Version: v0.1.0, BuildTime: 20180903

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

Options:
  --verbose, -V          verbose output
  --table, -t            output as Markdown table
  --callback, -c         POST results to Malice webhook [$MALICE_ENDPOINT]
  --proxy, -x            proxy settings for Malice webhook endpoint [$MALICE_PROXY]
  --elasticsearch value  elasticsearch url for Malice to store results [$MALICE_ELASTICSEARCH_URL]
  --timeout value        malice plugin timeout (in seconds) (default: 60) [$MALICE_TIMEOUT]
  --help, -h             show help
  --version, -v          print the version

Commands:
  update  Update virus definitions
  web     Create a EScan scan web service
  help    Shows a list of commands or help for one command

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

This will output to stdout and POST to malice results API webhook endpoint.

Sample Output

JSON

{
  "escan": {
    "infected": true,
    "result": "EICAR-Test-File (not a virus)(DB)",
    "engine": "7.0-20",
    "updated": "20170708"
  }
}

Markdown

---

eScan

Infected	Result	Engine	Updated
true	EICAR-Test-File (not a virus)(DB)	7.0-20	20170708

---

Documentation

• To write results to ElasticSearch
• To create a eScan scan micro-service
• To post results to a webhook
• To update the AV definitions

TODO

• add ability to enable --pack/--heuristic/--max-size scanning options

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

Contributing

See all contributors on GitHub.

Please update the CHANGELOG.md and submit a Pull Request on GitHub.

License

MIT Copyright (c) 2016 blacktop