dist/ipf/man/ipmon.5

   1 .\"     $NetBSD: ipmon.5,v 1.1.1.1 2004/03/28 08:56:23 martti Exp $
   2 .\"
   3 .TH IPMON 5
   4 .SH NAME
   5 ipmon, ipmon.conf \- ipmon configuration file format
   6 .SH DESCRIPTION
   7 The format for files accepted by ipmon is described by the following grammar:
   8 .LP
   9 .nf
  10 "match" "{" matchlist "}" "do" "{" doing "}" ";"
  11
  12 matchlist ::= matching [ "," matching ] .
  13 matching  ::= direction | dstip | dstport | every | group | interface |
  14               logtag | nattag | protocol | result | rule | srcip | srcport .
  15
  16 dolist ::= doing [ "," doing ] .
  17 doing  ::= execute | save | syslog .
  18
  19 direction ::= "in" | "out" .
  20 dstip     ::= "dstip" "=" ipv4 "/" number .
  21 dstport   ::= "dstport" "=" number .
  22 every     ::= "every" every-options .
  23 execute   ::= "execute" "=" string .
  24 group     ::= "group" "=" string | "group" "=" number .
  25 interface ::= "interface" "=" string .
  26 logtag    ::= "logtag" "=" string | "logtag" "=" number .
  27 nattag    ::= "nattag" "=" string .
  28 protocol  ::= "protocol" "=" string | "protocol" "=" number .
  29 result    ::= "result" "=" result-option .
  30 rule      ::= "rule" "=" number .
  31 srcip     ::= "srcip" "=" ipv4 "/" number .
  32 srcport   ::= "srcport" "=" number .
  33 type      ::= "type" "=" ipftype .
  34 ipv4      ::= number "." number "." number "." number .
  35
  36 every-options ::= "second" | number "seconds" | "packet" | number "packets" .
  37 result-option ::= "pass" | "block" | "short" | "nomatch" | "log" .
  38 ipftype ::= "ipf" | "nat" | "state" .
  39
  40 .fi
  41 .PP
  42 In addition, lines that start with a # are considered to be comments.
  43 .SH OVERVIEW
  44 .PP
  45 The ipmon configuration file is used for defining rules to be executed when
  46 logging records are read from
  47 .B /dev/ipl.
  48 .PP
  49 At present, only IPv4 matching is available for source/destination address
  50 matching.
  51 .SH MATCHING
  52 .PP
  53 Each rule for ipmon consists of two primary segments: the first describes how
  54 the log record is to be matched, the second defines what action to take if
  55 there is a positive match.  All entries of the rules present in the file are
  56 compared for matches - there is no first or last rule match.
  57 .SH FILES
  58 /dev/ipl
  59 .br
  60 /dev/ipf
  61 .br
  62 /dev/ipnat
  63 .br
  64 /dev/ipstate
  65 .br
  66 /etc/ipmon.conf
  67 .SH SEE ALSO
  68 ipmon(8), ipl(4)