Virustotal-Public-API-V2.0-Client 
VirusTotal is a free service that analyzes suspicious files and URLs and facilitates the quick detection of viruses, worms, trojans, and all kinds of malware.
This is project is a VirusTotal public API version 2.0 implementation in Java.
Requirements
Getting started
- Clone project from GIT repo
git clone https://github.com/kdkanishka/Virustotal-Public-API-V2.0-Client.git
- OR Download the project as a zip file and extract
https://github.com/kdkanishka/Virustotal-Public-API-V2.0-Client/archive/master.zip
- Build and install the project using maven
mvn clean compile assembly:single -DskipTests
- Add following dependency to your maven project
<dependency>
<groupId>com.kanishka.api</groupId>
<artifactId>VirustotalPublicV2.0</artifactId>
<version>1.1.GA-SNAPSHOT</version>
</dependency>- If your project is not maven based, add
target/VirustotalPublicV2.0-1.1.rB-SNAPSHOT-jar-with-dependencies.jarfile to your class path.
How to use API
Sample codes
scan a given file
public void scanFile() {
try {
VirusTotalConfig.getConfigInstance().setVirusTotalAPIKey("APIKEY");
VirustotalPublicV2 virusTotalRef = new VirustotalPublicV2Impl();
ScanInfo scanInformation = virusTotalRef.scanFile(new File("/Users/kdesilva/Desktop/eicar.com.txt"));
System.out.println("___SCAN INFORMATION___");
System.out.println("MD5 :\t" + scanInformation.getMd5());
System.out.println("Perma Link :\t" + scanInformation.getPermalink());
System.out.println("Resource :\t" + scanInformation.getResource());
System.out.println("Scan Date :\t" + scanInformation.getScanDate());
System.out.println("Scan Id :\t" + scanInformation.getScanId());
System.out.println("SHA1 :\t" + scanInformation.getSha1());
System.out.println("SHA256 :\t" + scanInformation.getSha256());
System.out.println("Verbose Msg :\t" + scanInformation.getVerboseMessage());
System.out.println("Response Code :\t" + scanInformation.getResponseCode());
System.out.println("done.");
} catch (APIKeyNotFoundException ex) {
System.err.println("API Key not found! " + ex.getMessage());
} catch (UnsupportedEncodingException ex) {
System.err.println("Unsupported Encoding Format!" + ex.getMessage());
} catch (UnauthorizedAccessException ex) {
System.err.println("Invalid API Key " + ex.getMessage());
} catch (Exception ex) {
System.err.println("Something Bad Happened! " + ex.getMessage());
}
}Get File Scan Report
public void getFileScanReport() {
try {
VirusTotalConfig.getConfigInstance().setVirusTotalAPIKey("APIKEY");
VirustotalPublicV2 virusTotalRef = new VirustotalPublicV2Impl();
String resource="275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f";
FileScanReport report = virusTotalRef.getScanReport(resource);
System.out.println("MD5 :\t" + report.getMd5());
System.out.println("Perma link :\t" + report.getPermalink());
System.out.println("Resourve :\t" + report.getResource());
System.out.println("Scan Date :\t" + report.getScanDate());
System.out.println("Scan Id :\t" + report.getScanId());
System.out.println("SHA1 :\t" + report.getSha1());
System.out.println("SHA256 :\t" + report.getSha256());
System.out.println("Verbose Msg :\t" + report.getVerboseMessage());
System.out.println("Response Code :\t" + report.getResponseCode());
System.out.println("Positives :\t" + report.getPositives());
System.out.println("Total :\t" + report.getTotal());
HashMap<String, VirusScanInfo> scans = report.getScans();
for (String key : scans.keySet()) {
VirusScanInfo virusInfo = scans.get(key);
System.out.println("Scanner : " + key);
System.out.println("\t\t Resut : " + virusInfo.getResult());
System.out.println("\t\t Update : " + virusInfo.getUpdate());
System.out.println("\t\t Version :" + virusInfo.getVersion());
}
} catch (APIKeyNotFoundException ex) {
System.err.println("API Key not found! " + ex.getMessage());
} catch (UnsupportedEncodingException ex) {
System.err.println("Unsupported Encoding Format!" + ex.getMessage());
} catch (UnauthorizedAccessException ex) {
System.err.println("Invalid API Key " + ex.getMessage());
} catch (Exception ex) {
System.err.println("Something Bad Happened! " + ex.getMessage());
}
}Scan URL
public void scanUrl() {
try {
VirusTotalConfig.getConfigInstance().setVirusTotalAPIKey("APIKEY");
VirustotalPublicV2 virusTotalRef = new VirustotalPublicV2Impl();
String urls[] = {"www.google.lk", "www.yahoo.com"};
ScanInfo[] scanInfoArr = virusTotalRef.scanUrls(urls);
for (ScanInfo scanInformation : scanInfoArr) {
System.out.println("___SCAN INFORMATION___");
System.out.println("MD5 :\t" + scanInformation.getMd5());
System.out.println("Perma Link :\t" + scanInformation.getPermalink());
System.out.println("Resource :\t" + scanInformation.getResource());
System.out.println("Scan Date :\t" + scanInformation.getScanDate());
System.out.println("Scan Id :\t" + scanInformation.getScanId());
System.out.println("SHA1 :\t" + scanInformation.getSha1());
System.out.println("SHA256 :\t" + scanInformation.getSha256());
System.out.println("Verbose Msg :\t" + scanInformation.getVerboseMessage());
System.out.println("Response Code :\t" + scanInformation.getResponseCode());
System.out.println("done.");
}
} catch (APIKeyNotFoundException ex) {
System.err.println("API Key not found! " + ex.getMessage());
} catch (UnsupportedEncodingException ex) {
System.err.println("Unsupported Encoding Format!" + ex.getMessage());
} catch (UnauthorizedAccessException ex) {
System.err.println("Invalid API Key " + ex.getMessage());
} catch (Exception ex) {
System.err.println("Something Bad Happened! " + ex.getMessage());
}
}Get URL Report
public void getUrlReport(){
try {
VirusTotalConfig.getConfigInstance().setVirusTotalAPIKey("APIKEY");
VirustotalPublicV2 virusTotalRef = new VirustotalPublicV2Impl();
String urls[] = {"mahamegha.com","mahamegha.info"};
FileScanReport[] reports = virusTotalRef.getUrlScanReport(urls, false);
for (FileScanReport report : reports) {
if(report.getResponse_code()==0){
continue;
}
System.out.println("MD5 :\t" + report.getMd5());
System.out.println("Perma link :\t" + report.getPermalink());
System.out.println("Resourve :\t" + report.getResource());
System.out.println("Scan Date :\t" + report.getScanDate());
System.out.println("Scan Id :\t" + report.getScanId());
System.out.println("SHA1 :\t" + report.getSha1());
System.out.println("SHA256 :\t" + report.getSha256());
System.out.println("Verbose Msg :\t" + report.getVerboseMessage());
System.out.println("Response Code :\t" + report.getResponseCode());
System.out.println("Positives :\t" + report.getPositives());
System.out.println("Total :\t" + report.getTotal());
HashMap<String, VirusScanInfo> scans = report.getScans();
for (String key : scans.keySet()) {
VirusScanInfo virusInfo = scans.get(key);
System.out.println("Scanner : " + key);
System.out.println("\t\t Resut : " + virusInfo.getResult());
System.out.println("\t\t Update : " + virusInfo.getUpdate());
System.out.println("\t\t Version :" + virusInfo.getVersion());
}
}
} catch (APIKeyNotFoundException ex) {
System.err.println("API Key not found! " + ex.getMessage());
} catch (UnsupportedEncodingException ex) {
System.err.println("Unsupported Encoding Format!" + ex.getMessage());
} catch (UnauthorizedAccessException ex) {
System.err.println("Invalid API Key " + ex.getMessage());
} catch (Exception ex) {
System.err.println("Something Bad Happened! " + ex.getMessage());
}
}Get IP Address Report
public void getIPReport {
try {
VirusTotalConfig.getConfigInstance().setVirusTotalAPIKey("APIKEY");
VirustotalPublicV2 virusTotalRef = new VirustotalPublicV2Impl();
IPAddressReport report = virusTotalRef.getIPAddresReport("69.195.124.58");
System.out.println("___IP Rport__");
Sample[] communicatingSamples = report.getDetectedCommunicatingSamples();
if (communicatingSamples != null) {
System.out.println("Communicating Samples");
for (Sample sample : communicatingSamples) {
System.out.println("SHA256 : " + sample.getSha256());
System.out.println("Date : " + sample.getDate());
System.out.println("Positives : " + sample.getPositives());
System.out.println("Total : " + sample.getTotal());
}
}
Sample[] detectedDownloadedSamples = report.getDetectedDownloadedSamples();
if (detectedDownloadedSamples != null) {
System.out.println("Detected Downloaded Samples");
for (Sample sample : detectedDownloadedSamples) {
System.out.println("SHA256 : " + sample.getSha256());
System.out.println("Date : " + sample.getDate());
System.out.println("Positives : " + sample.getPositives());
System.out.println("Total : " + sample.getTotal());
}
}
URL[] urls = report.getDetectedUrls();
if (urls != null) {
System.out.println("Detected URLs");
for (URL url : urls) {
System.out.println("URL : " + url.getUrl());
System.out.println("Positives : " + url.getPositives());
System.out.println("Total : " + url.getTotal());
System.out.println("Scan Date" + url.getScanDate());
}
}
IPAddressResolution[] resolutions = report.getResolutions();
if (resolutions != null) {
System.out.println("Resolutions");
for (IPAddressResolution resolution : resolutions) {
System.out.println("Host Name : " + resolution.getHostName());
System.out.println("Last Resolved : " + resolution.getLastResolved());
}
}
Sample[] unDetectedDownloadedSamples = report.getUndetectedDownloadedSamples();
if (unDetectedDownloadedSamples != null) {
System.out.println("Undetected Downloaded Samples");
for (Sample sample : unDetectedDownloadedSamples) {
System.out.println("SHA256 : " + sample.getSha256());
System.out.println("Date : " + sample.getDate());
System.out.println("Positives : " + sample.getPositives());
System.out.println("Total : " + sample.getTotal());
}
}
Sample[] unDetectedCommunicatingSamples = report.getUndetectedDownloadedSamples();
if (unDetectedCommunicatingSamples != null) {
System.out.println("Undetected Communicating Samples");
for (Sample sample : unDetectedCommunicatingSamples) {
System.out.println("SHA256 : " + sample.getSha256());
System.out.println("Date : " + sample.getDate());
System.out.println("Positives : " + sample.getPositives());
System.out.println("Total : " + sample.getTotal());
}
}
System.out.println("Response Code : " + report.getResponseCode());
System.out.println("Verbose Message : " + report.getVerboseMessage());
} catch (APIKeyNotFoundException ex) {
System.err.println("API Key not found! " + ex.getMessage());
} catch (UnsupportedEncodingException ex) {
System.err.println("Unsupported Encoding Format!" + ex.getMessage());
} catch (UnauthorizedAccessException ex) {
System.err.println("Invalid API Key " + ex.getMessage());
} catch (Exception ex) {
System.err.println("Something Bad Happened! " + ex.getMessage());
}
}Get Domain Report
public void getDomainReport() {
try {
VirusTotalConfig.getConfigInstance().setVirusTotalAPIKey("APIKEY");
VirustotalPublicV2 virusTotalRef = new VirustotalPublicV2Impl();
DomainReport report = virusTotalRef.getDomainReport("www.ntt62.com");
System.out.println("___Domain Rport__");
Sample[] communicatingSamples = report.getDetectedCommunicatingSamples();
if (communicatingSamples != null) {
System.out.println("Communicating Samples");
for (Sample sample : communicatingSamples) {
System.out.println("SHA256 : " + sample.getSha256());
System.out.println("Date : " + sample.getDate());
System.out.println("Positives : " + sample.getPositives());
System.out.println("Total : " + sample.getTotal());
}
}
Sample[] detectedDownloadedSamples = report.getDetectedDownloadedSamples();
if (detectedDownloadedSamples != null) {
System.out.println("Detected Downloaded Samples");
for (Sample sample : detectedDownloadedSamples) {
System.out.println("SHA256 : " + sample.getSha256());
System.out.println("Date : " + sample.getDate());
System.out.println("Positives : " + sample.getPositives());
System.out.println("Total : " + sample.getTotal());
}
}
URL[] urls = report.getDetectedUrls();
if (urls != null) {
System.out.println("Detected URLs");
for (URL url : urls) {
System.out.println("URL : " + url.getUrl());
System.out.println("Positives : " + url.getPositives());
System.out.println("Total : " + url.getTotal());
System.out.println("Scan Date" + url.getScan_date());
}
}
IPAddressResolution[] resolutions = report.getResolutions();
if (resolutions != null) {
System.out.println("Resolutions");
for (Resolution resolution : resolutions) {
System.out.println("Host Name : " + resolution.getHostName());
System.out.println("Last Resolved : " + resolution.getLastResolved());
}
}
Sample[] unDetectedDownloadedSamples = report.getUndetectedDownloadedSamples();
if (unDetectedDownloadedSamples != null) {
System.out.println("Undetected Downloaded Samples");
for (Sample sample : unDetectedDownloadedSamples) {
System.out.println("SHA256 : " + sample.getSha256());
System.out.println("Date : " + sample.getDate());
System.out.println("Positives : " + sample.getPositives());
System.out.println("Total : " + sample.getTotal());
}
}
Sample[] unDetectedCommunicatingSamples = report.getUndetectedCommunicatingSamples();
if (unDetectedCommunicatingSamples != null) {
System.out.println("Undetected Communicating Samples");
for (Sample sample : unDetectedCommunicatingSamples) {
System.out.println("SHA256 : " + sample.getSha256());
System.out.println("Date : " + sample.getDate());
System.out.println("Positives : " + sample.getPositives());
System.out.println("Total : " + sample.getTotal());
}
}
System.out.println("Response Code : " + report.getResponseCode());
System.out.println("Verbose Message : " + report.getVerboseMessage());
} catch (APIKeyNotFoundException ex) {
System.err.println("API Key not found! " + ex.getMessage());
} catch (UnsupportedEncodingException ex) {
System.err.println("Unsupported Encoding Format!" + ex.getMessage());
} catch (UnauthorizedAccessException ex) {
System.err.println("Invalid API Key " + ex.getMessage());
} catch (Exception ex) {
System.err.println("Something Bad Happened! " + ex.getMessage());
}
}Posting Comments
public void addComment(){
try {
VirusTotalConfig.getConfigInstance().setVirusTotalAPIKey("APIKEY");
VirustotalPublicV2 virusTotalRef = new VirustotalPublicV2Impl();
String resource = "275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f";
String comment = "Eicar file! considered a goodware";
GeneralResponse gRespo = virusTotalRef.makeAComment(resource, comment);
System.out.println("Response Code : " + gRespo.getResponseCode());
System.out.println("Verbose Message : " + gRespo.getVerboseMessage());
} catch (APIKeyNotFoundException ex) {
System.err.println("API Key not found! " + ex.getMessage());
} catch (UnsupportedEncodingException ex) {
System.err.println("Unsupported Encoding Format!" + ex.getMessage());
} catch (UnauthorizedAccessException ex) {
System.err.println("Invalid API Key " + ex.getMessage());
} catch (Exception ex) {
System.err.println("Something Bad Happened! " + ex.getMessage());
}
}Developer guide
To generate checkstyle report
mvn clean checkstyle:checkstyleTo generate jacoco report
mvn test jacoco:reportTo run system tests
mvn clean test -Psystem-testsSupport or Contact
Having trouble with this API ? contact kdkanishka@gmail.com and I'll help you to sort it out.
Contribute to this Project
You are welcome to suggest new features and improvements. please feel free to fork and make pull requests with your additions and improvements.