dist/ipf/man/ipf.4

   1 .\"     $NetBSD$
   2 .\"
   3 .TH IPF 4
   4 .SH NAME
   5 ipf \- packet filtering kernel interface
   6 .SH SYNOPSIS
   7 #include <netinet/ip_compat.h>
   8 .br
   9 #include <netinet/ip_fil.h>
  10 .SH IOCTLS
  11 .PP
  12 To add and delete rules to the filter list, three 'basic' ioctls are provided
  13 for use.  The ioctl's are called as:
  14 .LP
  15 .nf
  16         ioctl(fd, SIOCADDFR, struct frentry **)
  17         ioctl(fd, SIOCDELFR, struct frentry **)
  18         ioctl(fd, SIOCIPFFL, int *)
  19 .fi
  20 .PP
  21 However, the full complement is as follows:
  22 .LP
  23 .nf
  24         ioctl(fd, SIOCADAFR, struct frentry **) (same as SIOCADDFR)
  25         ioctl(fd, SIOCRMAFR, struct frentry **) (same as SIOCDELFR)
  26         ioctl(fd, SIOCADIFR, struct frentry **)
  27         ioctl(fd, SIOCRMIFR, struct frentry **)
  28         ioctl(fd, SIOCINAFR, struct frentry **)
  29         ioctl(fd, SIOCINIFR, struct frentry **)
  30         ioctl(fd, SIOCSETFF, u_int *)
  31         ioctl(fd, SIOGGETFF, u_int *)
  32         ioctl(fd, SIOCGETFS, struct friostat **)
  33         ioctl(fd, SIOCIPFFL, int *)
  34         ioctl(fd, SIOCIPFFB, int *)
  35         ioctl(fd, SIOCSWAPA, u_int *)
  36         ioctl(fd, SIOCFRENB, u_int *)
  37         ioctl(fd, SIOCFRSYN, u_int *)
  38         ioctl(fd, SIOCFRZST, struct friostat **)
  39         ioctl(fd, SIOCZRLST, struct frentry **)
  40         ioctl(fd, SIOCAUTHW, struct fr_info **)
  41         ioctl(fd, SIOCAUTHR, struct fr_info **)
  42         ioctl(fd, SIOCATHST, struct fr_authstat **)
  43 .fi
  44 .PP
  45 The variations, SIOCADAFR vs. SIOCADIFR, allow operation on the two lists,
  46 active and inactive, respectively.  All of these ioctl's are implemented
  47 as being routing ioctls and thus the same rules for the various routing
  48 ioctls and the file descriptor are employed, mainly being that the fd must
  49 be that of the device associated with the module (i.e., /dev/ipl).
  50 .LP
  51 .PP
  52 The three groups of ioctls above perform adding rules to the end of the
  53 list (SIOCAD*), deletion of rules from any place in the list (SIOCRM*)
  54 and insertion of a rule into the list (SIOCIN*).  The rule place into
  55 which it is inserted is stored in the "fr_hits" field, below.
  56 .LP
  57 .nf
  58 typedef struct  frentry {
  59         struct  frentry *fr_next;
  60         u_short fr_group;       /* group to which this rule belongs */
  61         u_short fr_grhead;      /* group # which this rule starts */
  62         struct  frentry *fr_grp;
  63         int     fr_ref;         /* reference count - for grouping */
  64         void    *fr_ifa;
  65 #if BSD >= 199306
  66         void    *fr_oifa;
  67 #endif
  68         /*
  69          * These are only incremented when a packet  matches this rule and
  70          * it is the last match
  71          */
  72         U_QUAD_T        fr_hits;
  73         U_QUAD_T        fr_bytes;
  74         /*
  75          * Fields after this may not change whilst in the kernel.
  76          */
  77         struct  fr_ip   fr_ip;
  78         struct  fr_ip   fr_mip; /* mask structure */
  79
  80         u_char  fr_tcpfm;       /* tcp flags mask */
  81         u_char  fr_tcpf;        /* tcp flags */
  82
  83         u_short fr_icmpm;       /* data for ICMP packets (mask) */
  84         u_short fr_icmp;
  85
  86         u_char  fr_scmp;        /* data for port comparisons */
  87         u_char  fr_dcmp;
  88         u_short fr_dport;
  89         u_short fr_sport;
  90         u_short fr_stop;        /* top port for <> and >< */
  91         u_short fr_dtop;        /* top port for <> and >< */
  92         u_32_t  fr_flags;       /* per-rule flags && options (see below) */
  93         u_short fr_skip;        /* # of rules to skip */
  94         u_short fr_loglevel;    /* syslog log facility + priority */
  95         int     (*fr_func) __P((int, ip_t *, fr_info_t *));
  96         char    fr_icode;       /* return ICMP code */
  97         char    fr_ifname[IFNAMSIZ];
  98 #if BSD > 199306
  99         char    fr_oifname[IFNAMSIZ];
 100 #endif
 101         struct  frdest  fr_tif; /* "to" interface */
 102         struct  frdest  fr_dif; /* duplicate packet interfaces */
 103 } frentry_t;
 104 .fi
 105 .PP
 106 When adding a new rule, all unused fields (in the filter rule) should be
 107 initialised to be zero.  To insert a rule, at a particular position in the
 108 filter list, the number of the rule which it is to be inserted before must
 109 be put in the "fr_hits" field (the first rule is number 0).
 110 .LP
 111 .PP
 112 Flags which are recognised in fr_flags:
 113 .nf
 114
 115      FR_BLOCK        0x000001   /* do not allow packet to pass */
 116      FR_PASS         0x000002   /* allow packet to pass */
 117      FR_OUTQUE       0x000004   /* outgoing packets */
 118      FR_INQUE        0x000008   /* ingoing packets */
 119      FR_LOG          0x000010   /* Log */
 120      FR_LOGB         0x000011   /* Log-fail */
 121      FR_LOGP         0x000012   /* Log-pass */
 122      FR_LOGBODY      0x000020   /* log the body of packets too */
 123      FR_LOGFIRST     0x000040   /* log only the first packet to match */
 124      FR_RETRST       0x000080   /* return a TCP RST packet if blocked */
 125      FR_RETICMP      0x000100   /* return an ICMP packet if blocked */
 126      FR_FAKEICMP     0x00180    /* Return ICMP unreachable with fake source */
 127      FR_NOMATCH      0x000200   /* no match occured */
 128      FR_ACCOUNT      0x000400   /* count packet bytes */
 129      FR_KEEPFRAG     0x000800   /* keep fragment information */
 130      FR_KEEPSTATE    0x001000   /* keep `connection' state information */
 131      FR_INACTIVE     0x002000
 132      FR_QUICK        0x004000   /* match & stop processing list */
 133      FR_FASTROUTE    0x008000   /* bypass normal routing */
 134      FR_CALLNOW      0x010000   /* call another function (fr_func) if matches */
 135      FR_DUP          0x020000   /* duplicate the packet */
 136      FR_LOGORBLOCK   0x040000   /* block the packet if it can't be logged */
 137      FR_NOTSRCIP     0x080000   /* not the src IP# */
 138      FR_NOTDSTIP     0x100000   /* not the dst IP# */
 139      FR_AUTH         0x200000   /* use authentication */
 140      FR_PREAUTH      0x400000   /* require preauthentication */
 141
 142 .fi
 143 .PP
 144 Values for fr_scomp and fr_dcomp (source and destination port value
 145 comparisons) :
 146 .LP
 147 .nf
 148         FR_NONE         0
 149         FR_EQUAL        1
 150         FR_NEQUAL       2
 151         FR_LESST        3
 152         FR_GREATERT     4
 153         FR_LESSTE       5
 154         FR_GREATERTE    6
 155         FR_OUTRANGE     7
 156         FR_INRANGE      8
 157 .fi
 158 .PP
 159 The third ioctl, SIOCIPFFL, flushes either the input filter list, the
 160 output filter list or both and it returns the number of filters removed
 161 from the list(s).  The values which it will take and recognise are FR_INQUE
 162 and FR_OUTQUE (see above).  This ioctl is also implemented for
 163 \fB/dev/ipstate\fP and will flush all state tables entries if passed 0
 164 or just all those which are not established if passed 1.
 165
 166 .IP "\fBGeneral Logging Flags\fP" 0
 167 There are two flags which can be set to log packets independently of the
 168 rules used.  These allow for packets which are either passed or blocked
 169 to be logged.  To set (and clear)/get these flags, two ioctls are
 170 provided:
 171 .IP SIOCSETFF 16
 172 Takes an unsigned integer as the parameter.  The flags are then set to
 173 those provided (clearing/setting all in one).
 174 .nf
 175
 176         FF_LOGPASS      0x10000000
 177         FF_LOGBLOCK     0x20000000
 178         FF_LOGNOMATCH   0x40000000
 179         FF_BLOCKNONIP   0x80000000    /* Solaris 2.x only */
 180 .fi
 181 .IP SIOCGETFF 16
 182 Takes a pointer to an unsigned integer as the parameter.  A copy of the
 183 flags currently in used is copied to user space.
 184 .IP "\fBFilter statistics\fP" 0
 185 Statistics on the various operations performed by this package on packets
 186 is kept inside the kernel.  These statistics apply to packets traversing
 187 through the kernel.  To retrieve this structure, use this ioctl:
 188 .nf
 189
 190         ioctl(fd, SIOCGETFS, struct friostat *)
 191
 192 struct  friostat        {
 193         struct  filterstats     f_st[2];
 194         struct  frentry         *f_fin[2];
 195         struct  frentry         *f_fout[2];
 196         struct  frentry         *f_acctin[2];
 197         struct  frentry         *f_acctout[2];
 198         struct  frentry         *f_auth;
 199         u_long  f_froute[2];
 200         int     f_active;       /* 1 or 0 - active rule set */
 201         int     f_defpass;      /* default pass - from fr_pass */
 202         int     f_running;      /* 1 if running, else 0 */
 203         int     f_logging;      /* 1 if enabled, else 0 */
 204         char    f_version[32];  /* version string */
 205 };
 206
 207 struct  filterstats {
 208         u_long  fr_pass;        /* packets allowed */
 209         u_long  fr_block;       /* packets denied */
 210         u_long  fr_nom;         /* packets which don't match any rule */
 211         u_long  fr_ppkl;        /* packets allowed and logged */
 212         u_long  fr_bpkl;        /* packets denied and logged */
 213         u_long  fr_npkl;        /* packets unmatched and logged */
 214         u_long  fr_pkl;         /* packets logged */
 215         u_long  fr_skip;        /* packets to be logged but buffer full */
 216         u_long  fr_ret;         /* packets for which a return is sent */
 217         u_long  fr_acct;        /* packets for which counting was performed */
 218         u_long  fr_bnfr;        /* bad attempts to allocate fragment state */
 219         u_long  fr_nfr;         /* new fragment state kept */
 220         u_long  fr_cfr;         /* add new fragment state but complete pkt */
 221         u_long  fr_bads;        /* bad attempts to allocate packet state */
 222         u_long  fr_ads;         /* new packet state kept */
 223         u_long  fr_chit;        /* cached hit */
 224         u_long  fr_pull[2];     /* good and bad pullup attempts */
 225 #if SOLARIS
 226         u_long  fr_notdata;     /* PROTO/PCPROTO that have no data */
 227         u_long  fr_nodata;      /* mblks that have no data */
 228         u_long  fr_bad;         /* bad IP packets to the filter */
 229         u_long  fr_notip;       /* packets passed through no on ip queue */
 230         u_long  fr_drop;        /* packets dropped - no info for them! */
 231 #endif
 232 };
 233 .fi
 234 If we wanted to retrieve all the statistics and reset the counters back to
 235 0, then the ioctl() call would be made to SIOCFRZST rather than SIOCGETFS.
 236 In addition to the statistics above, each rule keeps a hit count, counting
 237 both number of packets and bytes.  To reset these counters for a rule,
 238 load the various rule information into a frentry structure and call
 239 SIOCZRLST.
 240 .IP "Swapping Active lists" 0
 241 IP Filter supports two lists of rules for filtering and accounting: an
 242 active list and an inactive list.  This allows for large scale rule base
 243 changes to be put in place atomically with otherwise minimal interruption.
 244 Which of the two is active can be changed using the SIOCSWAPA ioctl.  It
 245 is important to note that no passed argument is recognised and that the
 246 value returned is that of the list which is now inactive.
 247 .br
 248 .SH FILES
 249 /dev/ipauth
 250 .br
 251 /dev/ipl
 252 .br
 253 /dev/ipnat
 254 .br
 255 /dev/ipstate
 256 .SH SEE ALSO
 257 ipl(4), ipnat(4), ipf(5), ipf(8), ipfstat(8)
 258 .SH BUGS
 259 When a packet encapsulated by ipsec(4) tunnel comes in, ipf(4) looks at
 260 wire-format packet on inbound and outbound.
 261 ipf(4) will not look at decapsulated packets on inbound,
 262 nor packets prior to encapsulation on outbound.
 263 .PP
 264 When tunneled packets arrive at the node and are handled by a
 265 tunneling pseudo interface like gif(4),
 266 the packets may go through ipf(4) twice, before and after decapsulation.
 267 In some cases it may be necessary to check, in the ipf(4) rules,
 268 if the inbound interface is a tunneling pseudo interface or not.