R/file_report.R

Defines functions file_report

Documented in file_report

#' Get File Scan Report
#'
#' @param hash Hash for the scan
#' @param \dots Additional arguments passed to \code{\link{virustotal_GET}}.
#' 
#' @return data.frame with 16 columns: 
#' \code{service, detected, version, update, result, scan_id, sha1, resource, response_code, 
#' scan_date, permalink, verbose_msg, total, positives, sha256, md5}   
#'  
#' @export
#' 
#' @references \url{https://www.virustotal.com/en/documentation/public-api/}
#' 
#' @seealso \code{\link{set_key}} for setting the API key
#' 
#' @examples \dontrun{
#' 
#' # Before calling the function, set the API key using set_key('api_key_here')
#' 
#' file_report(hash='99017f6eebbac24f351415dd410d522d')
#' }

file_report <- function(hash = NULL, ...) {

    if (!is.character(hash)) {
        stop("Must specify hash.\n")
    }

    params <- list(resource = hash)
    res    <- virustotal_GET(path = "file/report", query = params, ...)

    if (res$response_code == 0 ){
      res_df <- read.table(text = "", col.names = c("service", "detected",
                                                    "version", "update",
                                                    "result", "scan_id",
                                                    "sha1", "resource",
                                                    "response_code",
                                                    "scan_date", "permalink",
                                                    "verbose_msg",
                                                    "total, positives",
                                                    "sha256", "md5"))
      res_df[1, match(names(res), names(res_df))] <- res
      return(res_df)
    }

    scan_results <- ldply(lapply(res$scans, unlist), rbind, .id = "service")
    res_df       <- as.data.frame(cbind(scan_results, res[2:length(res)]))
    res_df
}
themains/virustotal documentation built on Nov. 18, 2017, 10:18 p.m.