Skip to content

Agent responsible for scanning files using the Virus Total public API.

License

Notifications You must be signed in to change notification settings

Ostorlab/agent_virustotal

Repository files navigation

Agent VirusTotal

VirusTotal is an agent that scans for viruses in a file using the VirusTotal public API.


agent_virus_total

This repository is an implementation of the VirusTotal agent.

Getting Started

To perform your first scan, simply run the following command.

oxo scan run --install --agent agent/ostorlab/virustotal file malware.exe

This command will download and install agent/ostorlab/virustotal and targets the file malware.exe. For more information, please refer to the OXO Documentation

Usage

Agent VirusTotal can be installed directly from the oxo agent store or built from this repository.

Install directly from oxo agent store

oxo agent install agent/ostorlab/virustotal

You can then run the agent with the following command:

oxo scan run --agent agent/ostorlab/virustotal file malware.exe

Build directly from the repository

  1. To build the virustotal agent you need to have oxo installed in your machine. if you have already installed oxo, you can skip this step.
pip3 install ostorlab
  1. Clone this repository.
git clone https://github.com/Ostorlab/agent_virus_total.git && cd agent_virus_total
  1. Build the agent image using oxo cli.
ostortlab agent build --file=ostorlab.yaml

You can pass the optional flag --organization to specify your organisation. The organization is empty by default.

  1. Run the agent using one of the following commands:
    • If you did not specify an organization when building the image:
    oxo scan run --agent agent//virustotal file malware.exe
    • If you specified an organization when building the image:
    oxo scan run --agent agent/[ORGANIZATION]/virustotal file malware.exe

License

Apache