{"id":26654139,"url":"https://github.com/malice-plugins/escan","last_synced_at":"2025-04-11T07:18:43.544Z","repository":{"id":85384121,"uuid":"96488459","full_name":"malice-plugins/escan","owner":"malice-plugins","description":"Malice eScan AntiVirus Plugin","archived":false,"fork":false,"pushed_at":"2019-02-10T04:07:41.000Z","size":3339,"stargazers_count":4,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T22:10:31.051Z","etag":null,"topics":["antivirus","docker","escan","malice","malware","malware-analysis","plugin"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/malice-plugins.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-07-07T01:56:58.000Z","updated_at":"2021-02-04T23:49:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"2850a841-aaff-4158-9708-97d8034219a9","html_url":"https://github.com/malice-plugins/escan","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malice-plugins%2Fescan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malice-plugins%2Fescan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malice-plugins%2Fescan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malice-plugins%2Fescan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/malice-plugins","download_url":"https://codeload.github.com/malice-plugins/escan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248358603,"owners_count":21090405,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["antivirus","docker","escan","malice","malware","malware-analysis","plugin"],"created_at":"2025-03-25T04:57:27.210Z","updated_at":"2025-04-11T07:18:43.509Z","avatar_url":"https://github.com/malice-plugins.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# malice-escan\n\n[![Circle CI](https://circleci.com/gh/malice-plugins/escan.png?style=shield)](https://circleci.com/gh/malice-plugins/escan)\n[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)\n[![Docker Stars](https://img.shields.io/docker/stars/malice/escan.svg)](https://hub.docker.com/r/malice/escan/)\n[![Docker Pulls](https://img.shields.io/docker/pulls/malice/escan.svg)](https://hub.docker.com/r/malice/escan/)\n[![Docker Image](https://img.shields.io/badge/docker%20image-1.15GB-blue.svg)](https://hub.docker.com/r/malice/escan/)\n\n\u003e Malice [eScan](https://escanav.com/en/linux-antivirus/antivirus-for-linux-file-servers.asp) AntiVirus Plugin\n\n---\n\n### Dependencies\n\n- [ubuntu:xenial (_118 MB_\\)](https://hub.docker.com/_/ubuntu/)\n\n## Installation\n\n1. Install [Docker](https://www.docker.io/).\n2. Download [trusted build](https://hub.docker.com/r/malice/escan/) from public [DockerHub](https://hub.docker.com): `docker pull malice/escan`\n\n## Usage\n\n```\ndocker run --rm malice/escan EICAR\n```\n\n### Or link your own malware folder:\n\n```bash\n$ docker run --rm -v /path/to/malware:/malware:ro malice/escan FILE\n\nUsage: escan [OPTIONS] COMMAND [arg...]\n\nMalice eScan AntiVirus Plugin\n\nVersion: v0.1.0, BuildTime: 20180903\n\nAuthor:\n  blacktop - \u003chttps://github.com/blacktop\u003e\n\nOptions:\n  --verbose, -V          verbose output\n  --table, -t            output as Markdown table\n  --callback, -c         POST results to Malice webhook [$MALICE_ENDPOINT]\n  --proxy, -x            proxy settings for Malice webhook endpoint [$MALICE_PROXY]\n  --elasticsearch value  elasticsearch url for Malice to store results [$MALICE_ELASTICSEARCH_URL]\n  --timeout value        malice plugin timeout (in seconds) (default: 60) [$MALICE_TIMEOUT]\n  --help, -h             show help\n  --version, -v          print the version\n\nCommands:\n  update  Update virus definitions\n  web     Create a EScan scan web service\n  help    Shows a list of commands or help for one command\n\nRun 'escan COMMAND --help' for more information on a command.\n```\n\nThis will output to stdout and POST to malice results API webhook endpoint.\n\n## Sample Output\n\n### [JSON](https://github.com/malice-plugins/escan/blob/master/docs/results.json)\n\n```json\n{\n  \"escan\": {\n    \"infected\": true,\n    \"result\": \"EICAR-Test-File (not a virus)(DB)\",\n    \"engine\": \"7.0-20\",\n    \"updated\": \"20170708\"\n  }\n}\n```\n\n### [Markdown](https://github.com/malice-plugins/escan/blob/master/docs/SAMPLE.md)\n\n---\n\n#### eScan\n\n| Infected |              Result               | Engine | Updated  |\n| :------: | :-------------------------------: | :----: | :------: |\n|   true   | EICAR-Test-File (not a virus)(DB) | 7.0-20 | 20170708 |\n\n---\n\n## Documentation\n\n- [To write results to ElasticSearch](https://github.com/malice-plugins/escan/blob/master/docs/elasticsearch.md)\n- [To create a eScan scan micro-service](https://github.com/malice-plugins/escan/blob/master/docs/web.md)\n- [To post results to a webhook](https://github.com/malice-plugins/escan/blob/master/docs/callback.md)\n- [To update the AV definitions](https://github.com/malice-plugins/escan/blob/master/docs/update.md)\n\n## TODO\n\n- [ ] add ability to enable `--pack/--heuristic/--max-size` scanning options\n\n## Issues\n\nFind 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/escan/issues/new).\n\n## CHANGELOG\n\nSee [`CHANGELOG.md`](https://github.com/malice-plugins/escan/blob/master/CHANGELOG.md)\n\n## Contributing\n\n[See all contributors on GitHub](https://github.com/malice-plugins/escan/graphs/contributors).\n\nPlease update the [CHANGELOG.md](https://github.com/malice-plugins/escan/blob/master/CHANGELOG.md) and submit a [Pull Request on GitHub](https://help.github.com/articles/using-pull-requests/).\n\n## License\n\nMIT Copyright (c) 2016 **blacktop**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalice-plugins%2Fescan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmalice-plugins%2Fescan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalice-plugins%2Fescan/lists"}