# Copyright (c) 2010 Flowerfire, Inc.  All Rights Reserved.
gauntlet = {

  plugin_version = "1.0.1"

  # Initial creation - 1.0
  # 2010-11-19 - 1.0.1 - MSG - Edited info lines.

  info.1.manufacturer = "McAfee"
  info.1.device = "Gauntlet Firewall"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "Gauntlet Log Format"
  log.miscellaneous.log_data_type = "firewall"  
  log.miscellaneous.log_format_type = "firewall"

  # The log is in this format if any of the first ten lines match this regular expression
  log.format.autodetect_regular_expression = "^[A-Z][a-z][a-z] [ 0-9][0-9]* [0-9][0-9]:[0-9][0-9]:[0-9][0-9] [^ ]* http-gw\\[[0-9]*\\]: "

  # This regular expression is used to parse the log fields out of the log entry
  log.format.parsing_regular_expression = "^([A-Z][a-z][a-z] [ 0-9][0-9]*) ([0-9][0-9]:[0-9][0-9]:[0-9][0-9]) ([^ ]*) http-gw\\[[0-9]*\\]: log host=([^ ]*) protocol=([^ ]*) cmd=([^ ]*) dest=([^ ]*) path=([^ ]*)"

  # The format of dates and times in this log
  log.format.date_format = "mmm dd"
  log.format.time_format = "hh:mm:ss"

  # Log fields
  log.fields = {

    date = {
      label = "$lang_stats.field_labels.date"
      type = "date"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # date

    time = {
      label = "$lang_stats.field_labels.time"
      type = "time"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # time

    proxy_hostname = {
      label = "$lang_stats.field_labels.proxy_hostname"
      type = "flat"
      index = 0
      subindex = 0
    } # proxy_hostname

    browsing_hostname = {
      label = "$lang_stats.field_labels.browsing_hostname"
      type = "host"
      index = 0
      subindex = 0
      hierarchy_dividers = "."
      left_to_right = false
      leading_divider = "false"
    } # browsing_hostname

    protocol = {
      label = "$lang_stats.field_labels.protocol"
      type = "flat"
      index = 0
      subindex = 0
    } # protocol

    operation = {
      label = "$lang_stats.field_labels.operation"
      type = "flat"
      index = 0
      subindex = 0
    } # operation

    destination_hostname = {
      label = "$lang_stats.field_labels.destination_hostname"
      type = "flat"
      index = 0
      subindex = 0
    } # destination_hostname

    path = {
      label = "$lang_stats.field_labels.path"
      type = "flat"
      index = 0
      subindex = 0
    } # path

    url = {
      label = "$lang_stats.field_labels.url"
      type = "page"
      index = 0
      subindex = 0
      hierarchy_dividers = "/?"
      left_to_right = true
      leading_divider = "true"
    } # url

  } # log.fields


  # Database fields
  database.fields = {

    date_time = {
      label = "$lang_stats.field_labels.date_time"
      log_field = "date_time"
      type = "string"
      suppress_top = 0
      suppress_bottom = 3
      display_format_type = "date_time"
    } # date_time

    day_of_week = {
      label = "$lang_stats.field_labels.day_of_week"
      log_field = "day_of_week"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
      display_format_type = "day_of_week"
    } # day_of_week

    hour_of_day = {
      label = "$lang_stats.field_labels.hour_of_day"
      log_field = "hour_of_day"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
      display_format_type = "hour_of_day"
    } # hour_of_day

    proxy_hostname = {
      label = "$lang_stats.field_labels.proxy_hostname"
      log_field = "proxy_hostname"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # proxy_hostname

    browsing_hostname = {
      label = "$lang_stats.field_labels.browsing_hostname"
      log_field = "browsing_hostname"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # browsing_hostname

    destination_hostname = {
      label = "$lang_stats.field_labels.destination_hostname"
      log_field = "destination_hostname"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # destination_hostname

    url = {
      label = "$lang_stats.field_labels.url"
      log_field = "url"
      type = "string"
      suppress_top = 1
      suppress_bottom = 3
    } # url

    file_type = {
      label = "$lang_stats.field_labels.file_type"
      log_field = "file_type"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # file_type

    worm = {
      label = "$lang_stats.field_labels.worm"
      log_field = "worm"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # worm

    protocol = {
      label = "$lang_stats.field_labels.protocol"
      log_field = "protocol"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # protocol

    operation = {
      label = "$lang_stats.field_labels.operation"
      log_field = "operation"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # operation

  } # database.fields


  # Log Filters
  log.filters = {


    # This filter builds the URL field from the protocol, browsing hostname, and path
    1 = {
      label = "1"
      comment = ""
      value = "url = protocol;"
    } # 1

    2 = {
      label = "2"
      comment = ""
      value = "url = lowercase(url);"
    } # 2

    3 = {
      label = "3"
      comment = ""
      value = "url = '' . url . '://' . destination_hostname;"
    } # 3

    4 = {
      label = "4"
      comment = ""
      value = "url = '' . url . '/' . path;"
    } # 4

    remove_query = {
      label = "$lang_admin.log_filters.remove_query_label"
      comment = "$lang_admin.log_filters.remove_query_comment"
      value = "if (contains(url, '?')) then url = substr(url, 0, index(url, '?') + 1) . '(parameters)';"
    } # remove_query

    detect_page_views = {
      label = '$lang_admin.log_filters.detect_page_views_label'
      comment = '$lang_admin.log_filters.detect_page_views_comment'
      value = "if ((file_type eq 'JPEG') or (file_type eq 'JPG') or (file_type eq 'GIF') or (file_type eq 'ICO') or (file_type eq 'PNG') or (file_type eq 'CSS') or (file_type eq 'SWF') or (file_type eq 'JS')) then page_views = 0; else page_views = 1;"
    } # detect_page_views

    simplify_url = {
      label = "$lang_admin.log_filters.simplify_url_label"
      comment = "$lang_admin.log_filters.simplify_url_comment"
      value = "if (matches_regular_expression(url, '^([^:]+://[^/]+/)')) then url = $1 . '(omitted)'"
    } # simplify_url

    strip_non_page_views = {
      label = '$lang_admin.log_filters.strip_non_page_views_label'
      comment = '$lang_admin.log_filters.strip_non_page_views_comment'
      value = "if (page_views == 0) then url = substr(url, 0, last_index(url, '/') + 1) . '(nonpage)';"
    } # strip_non_page_views

    mark_entry = {
      label = '$lang_admin.log_filters.mark_entry_label'
      comment = '$lang_admin.log_filters.mark_entry_comment'
      value = 'hits = 1;'
    } # mark_entry

  } # log.filters

  log.field_options = {

    sessions_page_field = "url"
    sessions_visitor_id_field = "browsing_host"
    sessions_event_field = "page_views"

  } # log.field_options


  database.numerical_fields = {

    hits = {
      label = "$lang_stats.field_labels.hits"
      default = false
      requires_log_field = false
      type = "int"
      display_format_type = "integer"
      entries_field = true
    } # hits

    page_views = {
      label = "$lang_stats.field_labels.page_views"
      default = true
      requires_log_field = false
      type = "int"
      display_format_type = "integer"
    } # page_views

    visitors = {
      label = "$lang_stats.field_labels.visitors"
      default = false
      requires_log_field = true
      log_field = "browsing_host"
      type = "unique"
      display_format_type = "integer"
    } # visitors

  } # database.numerical_fields


  create_profile_wizard_options = {
    date_time_tracking = true
    host_tracking = true

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      proxy_hostname = true
      browsing_hostname = true
      destination_hostname = true
      url = true
      file_type = true
      worm = true
      protocol = true
      operation = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
    bandwidth = true
    sessions = true
  } # not_supported

} # gauntlet