fprot

README

malice-fprot

Malice F-PROT AntiVirus Plugin

This repository contains a Dockerfile of fprot for Docker's trusted build published to the public DockerHub.

Dependencies

• ubuntu:bionic (84.1 MB)

Installation

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

Usage

docker run --rm malice/fprot EICAR

Or link your own malware folder:

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

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

Malice F-PROT 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 F-PROT scan web service
  help    Shows a list of commands or help for one command

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

Sample Output

JSON

{
  "f-prot": {
    "infected": true,
    "result": "EICAR_Test_File (exact)",
    "engine": "4.6.5.141",
    "updated": "20170122"
  }
}

Markdown

---

F-PROT

Infected	Result	Engine	Updated
true	EICAR_Test_File (exact)	4.6.5.141	20170122

---

Documentation

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

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