]> CyberLeo.Net >> Repos - FreeBSD/releng/9.2.git/blob - contrib/ipfilter/man/ipf.5
- Copy stable/9 to releng/9.2 as part of the 9.2-RELEASE cycle.
[FreeBSD/releng/9.2.git] / contrib / ipfilter / man / ipf.5
1 .\" $FreeBSD$
2 .TH IPF 5
3 .SH NAME
4 ipf, ipf.conf, ipf6.conf \- IP packet filter rule syntax
5 .SH DESCRIPTION
6 .PP
7 A rule file for \fBipf\fP may have any name or even be stdin.  As
8 \fBipfstat\fP produces parsable rules as output when displaying the internal
9 kernel filter lists, it is quite plausible to use its output to feed back
10 into \fBipf\fP.  Thus, to remove all filters on input packets, the following
11 could be done:
12 .nf
13
14 \fC# ipfstat \-i | ipf \-rf \-\fP
15 .fi
16 .SH GRAMMAR
17 .PP
18 The format used by \fBipf\fP for construction of filtering rules can be
19 described using the following grammar in BNF:
20 \fC
21 .nf
22 filter-rule = [ insert ] action in-out [ options ] [ tos ] [ ttl ]
23               [ proto ] ip [ group ].
24
25 insert  = "@" decnumber .
26 action  = block | "pass" | log | "count" | skip | auth | call .
27 in-out  = "in" | "out" .
28 options = [ log ] [ tag ] [ "quick" ] [ "on" interface-name [ dup ]
29            [ froute ] [ replyto ] ] .
30 tos     = "tos" decnumber | "tos" hexnumber .
31 ttl     = "ttl" decnumber .
32 proto   = "proto" protocol .
33 ip      = srcdst [ flags ] [ with withopt ] [ icmp ] [ keep ] .
34 group   = [ "head" decnumber ] [ "group" decnumber ] .
35
36 block   = "block" [ return-icmp[return-code] | "return-rst" ] .
37 log     = "log" [ "body" ] [ "first" ] [ "or-block" ] [ "level" loglevel ] .
38 tag     = "tag" tagid .
39 skip    = "skip" decnumber .
40 auth    = "auth" | "preauth" .
41 call    = "call" [ "now" ] function-name .
42 dup     = "dup-to" interface-name [ ":" ipaddr ] .
43 froute  = "fastroute" | "to" interface-name [ ":" ipaddr ] .
44 replyto = "reply-to" interface-name [ ":" ipaddr ] .
45 protocol = "tcp/udp" | "udp" | "tcp" | "icmp" | decnumber .
46 srcdst  = "all" | fromto .
47 fromto  = "from" [ "!" ] object "to" [ "!" ] object .
48
49 return-icmp = "return-icmp" | "return-icmp-as-dest" .
50 return-code = "(" icmp-code ")" .
51 object  = addr [ port-comp | port-range ] .
52 addr    = "any" | nummask | host-name [ "mask" ipaddr | "mask" hexnumber ] .
53 addr    = "any" | "<thishost>" | nummask |
54           host-name [ "mask" ipaddr | "mask" hexnumber ] .
55 port-comp = "port" compare port-num .
56 port-range = "port" port-num range port-num .
57 flags   = "flags" flag { flag } [ "/" flag { flag } ] .
58 with    = "with" | "and" .
59 icmp    = "icmp-type" icmp-type [ "code" decnumber ] .
60 return-code = "(" icmp-code ")" .
61 keep    = "keep" "state" [ "(" state-options ")" ] | "keep" "frags" .
62 loglevel = facility"."priority | priority .
63
64 nummask = host-name [ "/" decnumber ] .
65 host-name = ipaddr | hostname | "any" .
66 ipaddr  = host-num "." host-num "." host-num "." host-num .
67 host-num = digit [ digit [ digit ] ] .
68 port-num = service-name | decnumber .
69 state-options = state-opts [ "," state-options ] .
70
71 state-opts = "age" decnumber [ "/" decnumber ] | "strict" |
72              "no-icmp-err" | "limit" decnumber | "newisn" | "sync" .
73 withopt = [ "not" | "no" ] opttype [ withopt ] .
74 opttype = "ipopts" | "short" | "frag" | "opt" optname .
75 optname = ipopts [ "," optname ] .
76 ipopts  = optlist | "sec-class" [ secname ] .
77 secname = seclvl [ "," secname ] .
78 seclvl  = "unclass" | "confid" | "reserv-1" | "reserv-2" | "reserv-3" |
79           "reserv-4" | "secret" | "topsecret" .
80 icmp-type = "unreach" | "echo" | "echorep" | "squench" | "redir" |
81             "timex" | "paramprob" | "timest" | "timestrep" | "inforeq" |
82             "inforep" | "maskreq" | "maskrep"  | decnumber .
83 icmp-code = decumber | "net-unr" | "host-unr" | "proto-unr" | "port-unr" |
84             "needfrag" | "srcfail" | "net-unk" | "host-unk" | "isolate" |
85             "net-prohib" | "host-prohib" | "net-tos" | "host-tos" |
86             "filter-prohib" | "host-preced" | "cutoff-preced" .
87 optlist = "nop" | "rr" | "zsu" | "mtup" | "mtur" | "encode" | "ts" |
88           "tr" | "sec" | "lsrr" | "e-sec" | "cipso" | "satid" | "ssrr" |
89           "addext" | "visa" | "imitd" | "eip" | "finn" .
90 facility = "kern" | "user" | "mail" | "daemon" | "auth" | "syslog" |
91            "lpr" | "news" | "uucp" | "cron" | "ftp" | "authpriv" |
92            "audit" | "logalert" | "local0" | "local1" | "local2" |
93            "local3" | "local4" | "local5" | "local6" | "local7" .
94 priority = "emerg" | "alert" | "crit" | "err" | "warn" | "notice" |
95            "info" | "debug" . 
96
97 hexnumber = "0" "x" hexstring .
98 hexstring = hexdigit [ hexstring ] .
99 decnumber = digit [ decnumber ] .
100
101 compare = "=" | "!=" | "<" | ">" | "<=" | ">=" | "eq" | "ne" | "lt" |
102           "gt" | "le" | "ge" .
103 range   = "<>" | "><" .
104 hexdigit = digit | "a" | "b" | "c" | "d" | "e" | "f" .
105 digit   = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" .
106 flag    = "F" | "S" | "R" | "P" | "A" | "U" .
107 .fi
108 .PP
109 This syntax is somewhat simplified for readability, some combinations
110 that match this grammar are disallowed by the software because they do
111 not make sense (such as tcp \fBflags\fP for non-TCP packets).
112 .SH FILTER RULES
113 .PP
114 The "briefest" valid rules are (currently) no-ops and are of the form:
115 .nf
116        block in all
117        pass in all
118        log out all
119        count in all
120 .fi
121 .PP
122 Filter rules are checked in order, with the last matching rule
123 determining the fate of the packet (but see the \fBquick\fP option,
124 below).
125 .PP
126 Filters are installed by default at the end of the kernel's filter
127 lists, prepending the rule with \fB@n\fP will cause it to be inserted
128 as the n'th entry in the current list. This is especially useful when
129 modifying and testing active filter rulesets. See ipf(8) for more
130 information.
131 .SH ACTIONS
132 .PP
133 The action indicates what to do with the packet if it matches the rest
134 of the filter rule. Each rule MUST have an action. The following
135 actions are recognised:
136 .TP
137 .B block
138 indicates that the packet should be flagged to be dropped. In response
139 to blocking a packet, the filter may be instructed to send a reply
140 packet, either an ICMP packet (\fBreturn-icmp\fP), an ICMP packet
141 masquerading as being from the original packet's destination
142 (\fBreturn-icmp-as-dest\fP), or a TCP "reset" (\fBreturn-rst\fP).  An
143 ICMP packet may be generated in response to any IP packet, and its
144 type may optionally be specified, but a TCP reset may only be used
145 with a rule which is being applied to TCP packets.  When using
146 \fBreturn-icmp\fP or \fBreturn-icmp-as-dest\fP, it is possible to specify
147 the actual unreachable `type'.  That is, whether it is a network
148 unreachable, port unreachable or even administratively
149 prohibited. This is done by enclosing the ICMP code associated with
150 it in parenthesis directly following \fBreturn-icmp\fP or
151 \fBreturn-icmp-as-dest\fP as follows:
152 .nf
153         block return-icmp(11) ...
154 .fi
155 .PP
156 Would return a Type-Of-Service (TOS) ICMP unreachable error.
157 .TP
158 .B pass
159 will flag the packet to be let through the filter.  
160 .TP
161 .B log
162 causes the packet to be logged (as described in the LOGGING section
163 below) and has no effect on whether the packet will be allowed through
164 the filter.
165 .TP
166 .B count
167 causes the packet to be included in the accounting statistics kept by
168 the filter, and has no effect on whether the packet will be allowed through
169 the filter. These statistics are viewable with ipfstat(8).
170 .TP
171 .B call
172 this action is used to invoke the named function in the kernel, which
173 must conform to a specific calling interface. Customised actions and
174 semantics can thus be implemented to supplement those available. This
175 feature is for use by knowledgeable hackers, and is not currently
176 documented.
177 .TP
178 .B "skip <n>"
179 causes the filter to skip over the next \fIn\fP filter rules.  If a rule is
180 inserted or deleted inside the region being skipped over, then the value of
181 \fIn\fP is adjusted appropriately.
182 .TP
183 .B auth
184 this allows authentication to be performed by a user-space program running
185 and waiting for packet information to validate.  The packet is held for a
186 period of time in an internal buffer whilst it waits for the program to return
187 to the kernel the \fIreal\fP flags for whether it should be allowed through
188 or not.  Such a program might look at the source address and request some sort
189 of authentication from the user (such as a password) before allowing the
190 packet through or telling the kernel to drop it if from an unrecognised source.
191 .TP
192 .B preauth
193 tells the filter that for packets of this class, it should look in the
194 pre-authenticated list for further clarification.  If no further matching
195 rule is found, the packet will be dropped (the FR_PREAUTH is not the same
196 as FR_PASS).  If a further matching rule is found, the result from that is
197 used in its instead.  This might be used in a situation where a person
198 \fIlogs in\fP to the firewall and it sets up some temporary rules defining
199 the access for that person.
200 .PP
201 The next word must be either \fBin\fP or \fBout\fP.  Each packet
202 moving through the kernel is either inbound (just been received on an
203 interface, and moving towards the kernel's protocol processing) or
204 outbound (transmitted or forwarded by the stack, and on its way to an
205 interface). There is a requirement that each filter rule explicitly
206 state which side of the I/O it is to be used on.
207 .SH OPTIONS
208 .PP
209 The list of options is brief, and all are indeed optional. Where
210 options are used, they must be present in the order shown here. These
211 are the currently supported options:
212 .TP
213 .B log
214 indicates that, should this be the last matching rule, the packet
215 header will be written to the \fBipl\fP log (as described in the
216 LOGGING section below).
217 .TP
218 .B tag tagid
219 indicates that, if this rule causes the packet to be logged or entered
220 in the state table, the tagid will be logged as part of the log entry.
221 This can be used to quickly match "similar" rules in scripts that post
222 process the log files for e.g. generation of security reports or accounting
223 purposes. The tagid is a 32 bit unsigned integer.
224 .TP
225 .B quick
226 allows "short-cut" rules in order to speed up the filter or override
227 later rules.  If a packet matches a filter rule which is marked as
228 \fBquick\fP, this rule will be the last rule checked, allowing a
229 "short-circuit" path to avoid processing later rules for this
230 packet. The current status of the packet (after any effects of the
231 current rule) will determine whether it is passed or blocked.
232 .IP
233 If this option is missing, the rule is taken to be a "fall-through"
234 rule, meaning that the result of the match (block/pass) is saved and
235 that processing will continue to see if there are any more matches.
236 .TP
237 .B on
238 allows an interface name to be incorporated into the matching
239 procedure. Interface names are as printed by "netstat \-i". If this
240 option is used, the rule will only match if the packet is going
241 through that interface in the specified direction (in/out). If this
242 option is absent, the rule is taken to be applied to a packet
243 regardless of the interface it is present on (i.e. on all interfaces).
244 Filter rulesets are common to all interfaces, rather than having a
245 filter list for each interface.
246 .IP
247 This option is especially useful for simple IP-spoofing protection:
248 packets should only be allowed to pass inbound on the interface from
249 which the specified source address would be expected, others may be
250 logged and/or dropped.
251 .TP
252 .B dup-to
253 causes the packet to be copied, and the duplicate packet to be sent
254 outbound on the specified interface, optionally with the destination
255 IP address changed to that specified. This is useful for off-host
256 logging, using a network sniffer.
257 .TP
258 .B to
259 causes the packet to be moved to the outbound queue on the
260 specified interface. This can be used to circumvent kernel routing
261 decisions, and even to bypass the rest of the kernel processing of the
262 packet (if applied to an inbound rule). It is thus possible to
263 construct a firewall that behaves transparently, like a filtering hub
264 or switch, rather than a router. The \fBfastroute\fP keyword is a
265 synonym for this option.
266 .SH MATCHING PARAMETERS
267 .PP 
268 The keywords described in this section are used to describe attributes
269 of the packet to be used when determining whether rules match or don't
270 match. The following general-purpose attributes are provided for
271 matching, and must be used in this order:
272 .TP
273 .B tos
274 packets with different Type-Of-Service values can be filtered.
275 Individual service levels or combinations can be filtered upon.  The
276 value for the TOS mask can either be represented as a hex number or a
277 decimal integer value.
278 .TP
279 .B ttl
280 packets may also be selected by their Time-To-Live value.  The value given in
281 the filter rule must exactly match that in the packet for a match to occur.
282 This value can only be given as a decimal integer value.
283 .TP
284 .B proto
285 allows a specific protocol to be matched against.  All protocol names
286 found in \fB/etc/protocols\fP are recognised and may be used.
287 However, the protocol may also be given as a DECIMAL number, allowing
288 for rules to match your own protocols, or new ones which would
289 out-date any attempted listing.
290 .IP
291 The special protocol keyword \fBtcp/udp\fP may be used to match either
292 a TCP or a UDP packet, and has been added as a convenience to save
293 duplication of otherwise-identical rules.
294 .\" XXX grammar should reflect this (/etc/protocols)
295 .PP
296 The \fBfrom\fP and \fBto\fP keywords are used to match against IP
297 addresses (and optionally port numbers). Rules must specify BOTH
298 source and destination parameters.
299 .PP 
300 IP addresses may be specified in one of two ways: as a numerical
301 address\fB/\fPmask, or as a hostname \fBmask\fP netmask.  The hostname
302 may either be a valid hostname, from either the hosts file or DNS
303 (depending on your configuration and library) or of the dotted numeric
304 form.  There is no special designation for networks but network names
305 are recognised.  Note that having your filter rules depend on DNS
306 results can introduce an avenue of attack, and is discouraged.
307 .PP
308 There is a special case for the hostname \fBany\fP which is taken to
309 be 0.0.0.0/0 (see below for mask syntax) and matches all IP addresses.
310 Only the presence of "any" has an implied mask, in all other
311 situations, a hostname MUST be accompanied by a mask.  It is possible
312 to give "any" a hostmask, but in the context of this language, it is
313 non-sensical.
314 .PP
315 The numerical format "x\fB/\fPy" indicates that a mask of y
316 consecutive 1 bits set is generated, starting with the MSB, so a y value
317 of 16 would give 0xffff0000. The symbolic "x \fBmask\fP y" indicates
318 that the mask y is in dotted IP notation or a hexadecimal number of
319 the form 0x12345678.  Note that all the bits of the IP address
320 indicated by the bitmask must match the address on the packet exactly;
321 there isn't currently a way to invert the sense of the match, or to
322 match ranges of IP addresses which do not express themselves easily as
323 bitmasks (anthropomorphization; it's not just for breakfast anymore).
324 .PP
325 If a \fBport\fP match is included, for either or both of source and
326 destination, then it is only applied to
327 .\" XXX - "may only be" ? how does this apply to other protocols? will it not match, or will it be ignored?
328 TCP and UDP packets. If there is no \fBproto\fP match parameter,
329 packets from both protocols are compared. This is equivalent to "proto
330 tcp/udp".  When composing \fBport\fP comparisons, either the service
331 name or an integer port number may be used. Port comparisons may be
332 done in a number of forms, with a number of comparison operators, or
333 port ranges may be specified. When the port appears as part of the
334 \fBfrom\fP object, it matches the source port number, when it appears
335 as part of the \fBto\fP object, it matches the destination port number.
336 See the examples for more information.
337 .PP
338 The \fBall\fP keyword is essentially a synonym for "from any to any"
339 with no other match parameters.
340 .PP
341 Following the source and destination matching parameters, the
342 following additional parameters may be used:
343 .TP
344 .B with
345 is used to match irregular attributes that some packets may have
346 associated with them.  To match the presence of IP options in general,
347 use \fBwith ipopts\fP. To match packets that are too short to contain
348 a complete header, use \fBwith short\fP. To match fragmented packets,
349 use \fBwith frag\fP.  For more specific filtering on IP options,
350 individual options can be listed.
351 .IP
352 Before any parameter used after the \fBwith\fP keyword, the word
353 \fBnot\fP or \fBno\fP may be inserted to cause the filter rule to only
354 match if the option(s) is not present.
355 .IP
356 Multiple consecutive \fBwith\fP clauses are allowed.  Alternatively,
357 the keyword \fBand\fP may be used in place of \fBwith\fP, this is
358 provided purely to make the rules more readable ("with ... and ...").
359 When multiple clauses are listed, all those must match to cause a
360 match of the rule.
361 .\" XXX describe the options more specifically in a separate section
362 .TP
363 .B flags
364 is only effective for TCP filtering.  Each of the letters possible
365 represents one of the possible flags that can be set in the TCP
366 header.  The association is as follows:
367 .LP
368 .nf
369         F - FIN
370         S - SYN
371         R - RST
372         P - PUSH
373         A - ACK
374         U - URG
375 .fi
376 .IP
377 The various flag symbols may be used in combination, so that "SA"
378 would represent a SYN-ACK combination present in a packet.  There is
379 nothing preventing the specification of combinations, such as "SFR",
380 that would not normally be generated by law-abiding TCP
381 implementations.  However, to guard against weird aberrations, it is
382 necessary to state which flags you are filtering against.  To allow
383 this, it is possible to set a mask indicating which TCP flags you wish
384 to compare (i.e., those you deem significant).  This is done by
385 appending "/<flags>" to the set of TCP flags you wish to match
386 against, e.g.:
387 .LP
388 .nf
389         ... flags S
390                         # becomes "flags S/AUPRFS" and will match
391                         # packets with ONLY the SYN flag set.
392
393         ... flags SA
394                         # becomes "flags SA/AUPRFS" and will match any
395                         # packet with only the SYN and ACK flags set.
396
397         ... flags S/SA
398                         # will match any packet with just the SYN flag set
399                         # out of the SYN-ACK pair; the common "establish"
400                         # keyword action.  "S/SA" will NOT match a packet
401                         # with BOTH SYN and ACK set, but WILL match "SFP".
402 .fi
403 .TP
404 .B icmp-type
405 is only effective when used with \fBproto icmp\fP and must NOT be used
406 in conjunction with \fBflags\fP.  There are a number of types, which can be
407 referred to by an abbreviation recognised by this language, or the numbers
408 with which they are associated can be used.  The most important from
409 a security point of view is the ICMP redirect.
410 .SH KEEP HISTORY
411 .PP
412 The second last parameter which can be set for a filter rule is whether or not
413 to record historical information for that packet, and what sort to keep. The
414 following information can be kept:
415 .TP
416 .B state
417 keeps information about the flow of a communication session. State can
418 be kept for TCP, UDP, and ICMP packets.
419 .TP
420 .B frags
421 keeps information on fragmented packets, to be applied to later
422 fragments.
423 .PP
424 allowing packets which match these to flow straight through, rather
425 than going through the access control list.
426 .SH GROUPS
427 The last pair of parameters control filter rule "grouping".  By default, all
428 filter rules are placed in group 0 if no other group is specified.  To add a
429 rule to a non-default group, the group must first be started by creating a
430 group \fIhead\fP.  If a packet matches a rule which is the \fIhead\fP of a
431 group, the filter processing then switches to the group, using that rule as
432 the default for the group.  If \fBquick\fP is used with a \fBhead\fP rule, rule
433 processing isn't stopped until it has returned from processing the group.
434 .PP
435 A rule may be both the head for a new group and a member of a non-default
436 group (\fBhead\fP and \fBgroup\fP may be used together in a rule).
437 .TP
438 .B "head <n>"
439 indicates that a new group (number n) should be created.
440 .TP
441 .B "group <n>"
442 indicates that the rule should be put in group (number n) rather than group 0.
443 .SH LOGGING
444 .PP
445 When a packet is logged, with either the \fBlog\fP action or option,
446 the headers of the packet are written to the \fBipl\fP packet logging
447 pseudo-device. Immediately following the \fBlog\fP keyword, the
448 following qualifiers may be used (in order):
449 .TP
450 .B body
451 indicates that the first 128 bytes of the packet contents will be
452 logged after the headers. 
453 .TP
454 .B first
455 If log is being used in conjunction with a "keep" option, it is recommended
456 that this option is also applied so that only the triggering packet is logged
457 and not every packet which thereafter matches state information.
458 .TP
459 .B or-block
460 indicates that, if for some reason the filter is unable to log the
461 packet (such as the log reader being too slow) then the rule should be
462 interpreted as if the action was \fBblock\fP for this packet.
463 .TP
464 .B "level <loglevel>"
465 indicates what logging facility and priority, or just priority with
466 the default facility being used, will be used to log information about 
467 this packet using ipmon's -s option.
468 .PP
469 See ipl(4) for the format of records written
470 to this device. The ipmon(8) program can be used to read and format
471 this log.
472 .SH EXAMPLES
473 .PP
474 The \fBquick\fP option is good for rules such as:
475 \fC
476 .nf
477 block in quick from any to any with ipopts
478 .fi
479 .PP
480 which will match any packet with a non-standard header length (IP
481 options present) and abort further processing of later rules,
482 recording a match and also that the packet should be blocked.
483 .PP
484 The "fall-through" rule parsing allows for effects such as this:
485 .LP
486 .nf
487         block in from any to any port < 6000
488         pass in from any to any port >= 6000
489         block in from any to any port > 6003
490 .fi
491 .PP
492 which sets up the range 6000-6003 as being permitted and all others being
493 denied.  Note that the effect of the first rule is overridden by subsequent
494 rules.  Another (easier) way to do the same is:
495 .LP
496 .nf
497         block in from any to any port 6000 <> 6003
498         pass in from any to any port 5999 >< 6004
499 .fi
500 .PP
501 Note that both the "block" and "pass" are needed here to effect a
502 result as a failed match on the "block" action does not imply a pass,
503 only that the rule hasn't taken effect.  To then allow ports < 1024, a
504 rule such as:
505 .LP
506 .nf
507         pass in quick from any to any port < 1024
508 .fi
509 .PP
510 would be needed before the first block.  To create a new group for
511 processing all inbound packets on le0/le1/lo0, with the default being to block
512 all inbound packets, we would do something like:
513 .LP
514 .nf
515        block in all
516        block in quick on le0 all head 100
517        block in quick on le1 all head 200
518        block in quick on lo0 all head 300
519 .fi
520 .PP
521
522 and to then allow ICMP packets in on le0, only, we would do:
523 .LP
524 .nf
525        pass in proto icmp all group 100
526 .fi
527 .PP
528 Note that because only inbound packets on le0 are used processed by group 100,
529 there is no need to respecify the interface name.  Likewise, we could further
530 breakup processing of TCP, etc, as follows:
531 .LP
532 .nf
533        block in proto tcp all head 110 group 100
534        pass in from any to any port = 23 group 110
535 .fi
536 .PP
537 and so on.  The last line, if written without the groups would be:
538 .LP
539 .nf
540        pass in on le0 proto tcp from any to any port = telnet
541 .fi
542 .PP
543 Note, that if we wanted to say "port = telnet", "proto tcp" would
544 need to be specified as the parser interprets each rule on its own and
545 qualifies all service/port names with the protocol specified.
546 .SH FILES
547 /dev/ipauth
548 .br
549 /dev/ipl
550 .br
551 /dev/ipstate
552 .br
553 /etc/hosts
554 .br
555 /etc/services
556 .SH SEE ALSO
557 ipftest(1), iptest(1), mkfilters(1), ipf(4), ipnat(5), ipf(8), ipfstat(8)