https://github.com/malice-plugins/clamav
Malice ClamAV Plugin
https://github.com/malice-plugins/clamav
antivirus clamav docker malice malware plugin
Last synced: 3 months ago
JSON representation
Malice ClamAV Plugin
- Host: GitHub
- URL: https://github.com/malice-plugins/clamav
- Owner: malice-plugins
- License: mit
- Created: 2016-11-12T20:06:26.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-01-07T16:38:16.000Z (almost 7 years ago)
- Last Synced: 2025-04-27T04:29:51.533Z (6 months ago)
- Topics: antivirus, clamav, docker, malice, malware, plugin
- Language: Go
- Size: 3.43 MB
- Stars: 9
- Watchers: 3
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# malice-clamav
[](https://circleci.com/gh/malice-plugins/clamav)
[](http://doge.mit-license.org)
[](https://hub.docker.com/r/malice/clamav/)
[](https://hub.docker.com/r/malice/clamav/)
[](https://hub.docker.com/r/malice/clamav/)
Malice ClamAV AntiVirus
> This repository contains a **Dockerfile** of [ClamAV](http://www.clamav.net/lang/en/) for [Docker](https://www.docker.io/)'s [trusted build](https://index.docker.io/u/malice/clamav/) published to the public [DockerHub](https://index.docker.io/).
### Dependencies
- [malice/alpine](https://hub.docker.com/r/malice/alpine/)
## Installation
1. Install [Docker](https://www.docker.io/).
2. Download [trusted build](https://hub.docker.com/r/malice/clamav/) from public [DockerHub](https://hub.docker.com): `docker pull malice/clamav`
### Usage
```
docker run --rm malice/clamav EICAR
```
### Or link your own malware folder:
```bash
$ docker run --rm -v /path/to/malware:/malware:ro malice/clamav FILE
Usage: clamav [OPTIONS] COMMAND [arg...]
Malice ClamAV Plugin
Version: v0.1.0, BuildTime: 20180903
Author:
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 ClamAV scan web service
help Shows a list of commands or help for one command
Run 'clamav COMMAND --help' for more information on a command.
```
## Sample Output
### [JSON](https://github.com/malice-plugins/clamav/blob/master/docs/results.json)
```json
{
"clamav": {
"infected": true,
"result": "Eicar-Test-Signature",
"engine": "0.99.2",
"known": "5630857",
"updated": "20170123",
"error": ""
}
}
```
### [Markdown](https://github.com/malice-plugins/clamav/blob/master/docs/SAMPLE.md)
---
#### ClamAV
| Infected | Result | Engine | Updated |
| -------- | -------------------- | ------ | -------- |
| true | Eicar-Test-Signature | 0.99.2 | 20170123 |
---
## Documentation
- [To write results to ElasticSearch](https://github.com/malice-plugins/clamav/blob/master/docs/elasticsearch.md)
- [To create a ClamAV scan micro-service](https://github.com/malice-plugins/clamav/blob/master/docs/web.md)
- [To post results to a webhook](https://github.com/malice-plugins/clamav/blob/master/docs/callback.md)
- [To update the AV definitions](https://github.com/malice-plugins/clamav/blob/master/docs/update.md)
## Issues
Find a bug? Want more features? Find something missing in the documentation? Let me know! Please don't hesitate to [file an issue](https://github.com/malice-plugins/clamav/issues/new).
## CHANGELOG
See [`CHANGELOG.md`](https://github.com/malice-plugins/clamav/blob/master/CHANGELOG.md)
## Contributing
[See all contributors on GitHub](https://github.com/malice-plugins/clamav/graphs/contributors).
Please update the [CHANGELOG.md](https://github.com/malice-plugins/clamav/blob/master/CHANGELOG.md) and submit a [Pull Request on GitHub](https://help.github.com/articles/using-pull-requests/).
## License
MIT Copyright (c) 2016 **blacktop**