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

  plugin_version = "1.0.1"

  # Initial creation - 1.0
  # 2011-01-11 - 1.0.1 - MSG - Edited info lines.

  info.1.manfacturer = "FreeBSD"
  info.1.device = "IPFW"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "IPFW 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 = "[0-9]+ (Accept|Deny) (TCP|UDP|ICMP:[0-9.]+) [0-9.:]+ [0-9.:]+ (in|out) via "
  statistics.miscellaneous.entry_name = "events"

  # Log fields
  log.fields = {

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

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

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

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

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

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

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

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

  } # log.fields


  #          
  # Log Parsing Filters
  log.parsing_filters = {


    # Parse out the line
    tcp_udp = {
      label = "TCP/UDP"
      comment = ""
      value = "collect_fields_using_regexp('()(Deny TCP|Deny UDP|Accept TCP|Deny TCP) ([0-9.]+):([0-9]+) ([0-9.]+):([0-9]+) (in|out) via ([a-z0-9]+)', '*KEY*,action,source_host,source_port,destination_host,destination_port,direction,interface')"
    } # tcp_udp

    # Parse out the line
    icmp = {
      label = "ICMP"
      comment = ""
      value = "collect_fields_using_regexp('()(Accept ICMP|Deny ICMP):([^ ]+) ([0-9.]+) ([0-9.]+) (in|out) via ([a-z0-9]+)', '*KEY*,action,icmp_type,source_host,destination_host,direction,interface')"
    } # icmp

    # Accept any line
    2 = {
      label = "2"
      comment = ""
      value = "accept_collected_entry_using_regexp('()', false)"
    } # 2


  } # log.parsing_filters


  # Database fields
  database.fields = {

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

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

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

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

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

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

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

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

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

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

  } # 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 = 'events = 1;'
    } # mark_entry

  } # log.filters

  database.numerical_fields = {

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

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

  } # database.numerical_fields


  create_profile_wizard_options = {
    host_tracking = true

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      action = true
      source_host = true
      source_port = true
      country = true
      domain_description = true
      destination_host = true
      destination_port = true
      interface = true
      direction = true
      icmp_type = true
    } # report_groups

  } # create_profile_wizard_options

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

} # ipfw