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

  plugin_version = "1.0.1"

  # Initial creation - 1.0
  # 2011-07-22 - 1.0.1 - MSG - Edited info lines.

  info.1.manufacturer = "Watchtuard"
  info.1.device = "SOHO"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "Watchguard SOHO Log Format"
  log.miscellaneous.log_data_type = "syslog_required"  
  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 = "(MONITOR|IP):( Packet | )(allowed|allow|discarded) from [0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+"

  # All log field parsing will be done using the parsing filters
  log.format.parse_only_with_filters = "true"

  # Log fields
  log.fields = {

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

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

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

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

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

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

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

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

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

  } # log.fields


  #          
  # Log Parsing Filters
  log.parsing_filters = {


    # Parse out the type and status
    1 = {
      label = "1"
      comment = ""
      value = "collect_fields_using_regexp('()(MONITOR|IP):( Packet | )(allowed|discarded|discard)', '*KEY*,type,dummy,action')"
    } # 1


    # Parse out the source/dest fields
    srcdest = {
      label = "src/dest"
      comment = ""
      value = "collect_fields_using_regexp('()from ([0-9.]+) port ([0-9]+) to ([0-9.]+) port ([0-9]+) ', '*KEY*,source_ip,source_port,destination_ip,destination_port')"
    } # src/dest

    # Parse out the protocol/rule
    protocol = {
      label = "protocol"
      comment = ""
      value = "collect_fields_using_regexp('()to [0-9.]+ port [0-9]+ ([^ (]+) ', '*KEY*,protocol')"
    }

    # Parse out the rule
    rule = {
      label = "rule"
      comment = ""
      value = "collect_fields_using_regexp('()\\\\((deny|allow) by ([^)]+)\\\\)', '*KEY*,dummy,rule')"
    }

    # Parse out an ICMP line
    icmp = {
      label = "icmp"
      comment = ""
      value = "collect_fields_using_regexp('()from ([0-9.]+) ICMP type \\\\(([^)]+)\\\\) code \\\\(([^)]+)\\\\) to ([0-9.]+)\\\\((deny|allow) by ([^)]+)\\\\)', '*KEY*,source_ip,icmp_type,icmp_code,destination_ip,dummy,rule')"
    } # 3


    # Accept the collected field
    4 = {
      label = "4"
      comment = ""
      value = "accept_collected_entry_using_regexp('()', false)"
    } # 4


  } # log.parsing_filters


  # Database fields
  database.fields = {

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

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

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

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

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

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

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

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

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

  } # database.fields


  # Log Filters
  log.filters = {


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

  } # log.filters

  database.numerical_fields = {

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

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

  } # database.numerical_fields


  create_profile_wizard_options = {

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      source_ip = true
      destination_ip = true
      source_port = true
      destination_port = true
      protocol = true
      action = true
      rule = true
      icmp_type = true
      icmp_code = true
    } # report_groups

  } # create_profile_wizard_options

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

} # watchguard_soho