R/scan_file.R

In soodoku/virustotal: R Client for the VirusTotal API

#' Submit a file for scanning
#'
#' @param file_path Required; Path to the document
#' @param \dots Additional arguments passed to \code{\link{virustotal2_POST}}.
#' 
#' @return data.frame with the following columns: 
#' \code{scan_id, sha1, resource, response_code, sha256, permalink, md5, verbose_msg}
#'  
#' @export
#' 
#' @references \url{https://developers.virustotal.com/v2.0/reference}
#' 
#' @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')
#' 
#' scan_file(file_path='path_to_suspicious_file')
#' }

scan_file <- function(file_path = NULL, ...) {

  if (!file.exists(file_path)) stop("The file doesn't Exist.
                                                      Please check the path.\n")
    .Deprecated("")

    res   <- virustotal2_POST(path = "file/scan", body =
                                            list(file = upload_file(file_path)))

    as.data.frame(res)
}