R/import.r

In hrbrmstr/burrp: Tools to Import and Process 'PortSwigger' 'Burp' Proxy Data

#' Read in a Burp proxy XML export file
#'
#' For now, this function expects the `request` and `response`
#' elements to be base64 encoded.
#'
#' Eventually there will likely be an `as_har()` function to turn the
#' entire structure into a `HARtools` object.
#'
#' @md
#' @param burp_file path to a Burp proxy XML export file
#' @param convert_response if `TRUE`, turn the `response` record into
#'        and `httr` `response` object. If the `response` record cannot
#'        be turned into an `httr` `response` object a warning will
#'        be issued and the raw `response` record will be returned.
#' @param convert_request if `TRUE`, turn the `request` record into
#'        and `httr` `request` object. If the `request` record cannot
#'        be turned into an `httr` `request` object a warning will
#'        be issued and the raw `request` record will be returned.
#' @return a `tibble`
#' @export
#' @examples
#' library(dplyr)
#'
#' system.file("extdata", "hottest_year.xml", package="burrp") %>%
#'   read_burp() %>%
#'   glimpse()
read_burp <- function(burp_file, convert_response=TRUE, convert_request=TRUE) {

  burp_file <- normalizePath(path.expand(burp_file))

  if (!file.exists(burp_file)) stop("File not found", call.=FALSE)

  burp <- xml2::read_xml(burp_file)

  xml_find_all(burp, ".//item") %>%
   purrr::map_df(function(x) {
      kids <- xml_children(x)
      xml_text(kids) %>%
        as.list() %>%
        setNames(xml_name(kids))
    }) %>%
   dplyr::mutate(
      time = burp_time(time),
      request = purrr::map(request, base64_decode),
      response = purrr::map(response, base64_decode),
      raw_request = purrr::map(request, ~rawToChar(.x[.x != as.raw(0x00)])),
      raw_response = purrr::map(response, ~rawToChar(.x[.x != as.raw(0x00)])),
      responselength = as.numeric(responselength)
    ) -> burp_df

  if (convert_response) {
    burp_df <- dplyr::mutate(burp_df, response=pmap(list(response, url, time), make_response))
  }

  if (convert_request) {
    burp_df <- dplyr::mutate(burp_df, request=pmap(list(request, url, time), make_request))
  }

  class(burp_df) <- c("burrp", class(burp_df))

  burp_df

}

#' @export
summary.burrp <- function(object, ...) {

  x <- object

  x <- dplyr::left_join(x, status_codes_df)

  cat("<Burp Proxy Export>\n")
  cat(sprintf("- %s total records\n\n", nrow(x)))

  print(ungroup(count(x, status, description, sort=TRUE)))
  cat("\n")

  print(count(x, port, sort=TRUE))
  cat("\n")

  print(count(x, protocol, sort=TRUE))
  cat("\n")

  print(count(x, method, sort=TRUE))
  cat("\n")

  print(count(x, extension, sort=TRUE))
  cat("\n")

}