1 .\" Copyright (c) 1987, 1988, 1989, 1990, 1991, 1992, 1994, 1995, 1996, 1997
2 .\" The Regents of the University of California. All rights reserved.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that: (1) source code distributions
7 .\" retain the above copyright notice and this paragraph in its entirety, (2)
8 .\" distributions including binary code include the above copyright notice and
9 .\" this paragraph in its entirety in the documentation or other materials
10 .\" provided with the distribution, and (3) all advertising materials mentioning
11 .\" features or use of this software display the following acknowledgement:
12 .\" ``This product includes software developed by the University of California,
13 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
14 .\" the University nor the names of its contributors may be used to endorse
15 .\" or promote products derived from this software without specific prior
16 .\" written permission.
17 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
18 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
19 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
21 .TH PCAP-FILTER @MAN_MISC_INFO@ "29 January 2025"
23 pcap-filter \- packet filter syntax
28 .BR pcap_compile (3PCAP)
29 is used to compile a string into a filter program.
30 The resulting filter program can then be applied to
31 some stream of packets to determine which packets will be supplied to
32 .BR pcap_loop (3PCAP),
33 .BR pcap_dispatch (3PCAP),
34 .BR pcap_next (3PCAP),
36 .BR pcap_next_ex (3PCAP).
38 The \fIfilter expression\fP consists of one or more
40 Primitives usually consist of an
42 (name or number) preceded by one or more qualifiers.
44 different kinds of qualifier:
47 qualifiers say what kind of thing the id name or number refers to.
54 E.g., `\fBhost\fP foo', `\fBnet\fP 128.3', `\fBport\fP 20', `\fBportrange\fP 6000-6008'.
61 qualifiers specify a particular transfer direction to and/or from
63 Possible directions are
75 E.g., `\fBsrc\fP foo', `\fBdst net\fP 128.3', `\fBsrc or dst port\fP ftp-data'.
77 there is no dir qualifier, `\fBsrc or dst\fP' is assumed.
86 qualifiers are only valid for IEEE 802.11 Wireless LAN link layers.
89 qualifiers restrict the match to a particular protocol.
105 E.g., `\fBether src\fP foo', `\fBarp net\fP 128.3', `\fBtcp port\fP 21',
106 `\fBudp portrange\fP 7000-7009', `\fBwlan addr2\fP 0:2:3:4:5:6'.
109 qualifier, all protocols consistent with the type are assumed.
110 E.g., `\fBsrc\fP foo' means `\fB(ip6 or ip or arp or rarp) src\fP foo',
111 `\fBnet\fP bar' means `\fB(ip or arp or rarp) net\fP bar' and
112 `\fBport\fP 53' means `\fB(tcp or udp or sctp) port\fP 53'
113 (note that these examples use invalid syntax to illustrate the principle).
115 [\fBfddi\fP is actually an alias for \fBether\fP; the parser treats them
116 identically as meaning ``the data link level used on the specified
117 network interface''. FDDI headers contain Ethernet-like source
118 and destination addresses, and often contain Ethernet-like packet
119 types, so you can filter on these FDDI fields just as with the
120 analogous Ethernet fields.
121 FDDI headers also contain other fields,
122 but you cannot name them explicitly in a filter expression.
124 Similarly, \fBtr\fP and \fBwlan\fP are aliases for \fBether\fP; the previous
125 paragraph's statements about FDDI headers also apply to Token Ring
126 and 802.11 wireless LAN headers. For 802.11 headers, the destination
127 address is the DA field and the source address is the SA field; the
128 BSSID, RA, and TA fields aren't tested.]
130 In addition to the above, there are some special `primitive' keywords
131 that don't follow the pattern:
136 and arithmetic expressions.
137 All of these are described below.
139 More complex filter expressions are built up by using the words
144 (or equivalently: `\fB&&\fP', `\fB||\fP' and `\fB!\fP' respectively)
145 to combine primitives.
146 E.g., `\fBhost\fP foo \fBand not port\fP ftp \fBand not port\fP ftp-data'.
147 To save typing, identical qualifier lists can be omitted.
149 `\fBtcp dst port\fP ftp \fBor\fP ftp-data \fBor\fP domain' is exactly the same as
150 `\fBtcp dst port\fP ftp \fBor tcp dst port\fP ftp-data \fBor tcp dst port\fP domain'.
152 Allowable primitives are:
153 .IP "\fBdst host \fIhostnameaddr\fR"
154 True if the IPv4/v6 destination field of the packet is \fIhostnameaddr\fP,
155 which may be either an address or a name.
156 .IP "\fBsrc host \fIhostnameaddr\fR"
157 True if the IPv4/v6 source field of the packet is \fIhostnameaddr\fP.
158 .IP "\fBhost \fIhostnameaddr\fP"
159 True if either the IPv4/v6 source or destination of the packet is \fIhostnameaddr\fP.
161 Any of the above host expressions can be prepended with the keywords,
162 \fBip\fP, \fBarp\fP, \fBrarp\fP, or \fBip6\fP as in:
165 \fBip host \fIhostnameaddr\fR
168 which is equivalent to:
171 \fBether proto \\\fRip \fBand host \fIhostnameaddr\fR
174 If \fIhostnameaddr\fR is a name with multiple IPv4/v6 addresses, each address will
175 be checked for a match.
176 .IP "\fBether dst \fIethernameaddr\fP"
177 True if the Ethernet destination address is \fIethernameaddr\fP.
179 may be either a name from /etc/ethers or a numerical MAC address of the
180 form "xx:xx:xx:xx:xx:xx", "xx.xx.xx.xx.xx.xx", "xx-xx-xx-xx-xx-xx",
181 "xxxx.xxxx.xxxx" or "xxxxxxxxxxxx",
182 where each "x" is a hex digit (0-9, a-f, or A-F).
183 .IP "\fBether src \fIethernameaddr\fP"
184 True if the Ethernet source address is \fIethernameaddr\fP.
185 .IP "\fBether host \fIethernameaddr\fP"
186 True if either the Ethernet source or destination address is \fIethernameaddr\fP.
187 .IP "\fBgateway\fP \fIhost\fP"
188 True if the packet used \fIhost\fP as a gateway.
190 source or destination address was \fIhost\fP but neither the IP source
191 nor the IP destination was \fIhost\fP.
192 \fIHost\fP must be a name and
193 must be found both by the machine's host-name-to-IP-address resolution
194 mechanisms (host name file, DNS, NIS, etc.) and by the machine's
195 host-name-to-Ethernet-address resolution mechanism (/etc/ethers, etc.).
196 (An equivalent expression is
199 \fBether host \fIethernameaddr \fBand not host \fIhostnameaddr\fR
202 which can be used with either names or numbers for \fIhostnameaddr / ethernameaddr\fP.)
203 This syntax does not work in IPv6-enabled configuration at this moment.
204 .IP "\fBdst net \fInetnameaddr\fR"
205 True if the IPv4/v6 destination address of the packet has a network
206 number of \fInetnameaddr\fP.
207 \fINet\fP may be either a name from the networks database
208 (/etc/networks, etc.) or a network number.
209 An IPv4 network number can be written as a dotted quad (e.g., 192.168.1.0),
210 dotted triple (e.g., 192.168.1), dotted pair (e.g, 172.16), or single
211 number (e.g., 10); the netmask is 255.255.255.255 for a dotted quad
212 (which means that it's really a host match), 255.255.255.0 for a dotted
213 triple, 255.255.0.0 for a dotted pair, or 255.0.0.0 for a single number.
214 An IPv6 network number must be written out fully; the netmask is
215 ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff, so IPv6 "network" matches are really always
216 host matches, and a network match requires a netmask length.
217 .IP "\fBsrc net \fInetnameaddr\fR"
218 True if the IPv4/v6 source address of the packet has a network
219 number of \fInetnameaddr\fP.
220 .IP "\fBnet \fInetnameaddr\fR"
221 True if either the IPv4/v6 source or destination address of the packet has a network
222 number of \fInetnameaddr\fP.
223 .IP "\fBnet \fInetaddr\fR \fBmask \fInetmask\fR"
224 True if the IPv4 address matches \fInetaddr\fR with the specific \fInetmask\fR.
225 May be qualified with \fBsrc\fR or \fBdst\fR.
226 Note that this syntax is not valid for IPv6 \fInetaddr\fR.
227 .IP "\fBnet \fInetaddr\fR/\fIlen\fR"
228 True if the IPv4/v6 address matches \fInetaddr\fR with a netmask \fIlen\fR
230 May be qualified with \fBsrc\fR or \fBdst\fR.
231 .IP "\fBdst port \fIportnamenum\fR"
232 True if the packet is IPv4/v6 TCP, UDP or SCTP and has a
233 destination port value of \fIportnamenum\fP.
234 The \fIportnamenum\fP can be a number or a name used in /etc/services (see
236 If a name is used, both the port
237 number and protocol are checked.
238 If a number or ambiguous name is used,
239 only the port number is checked (e.g., `\fBdst port\fR 513' will print both
240 tcp/login traffic and udp/who traffic, and `\fBport\fR domain' will print
241 both tcp/domain and udp/domain traffic).
242 .IP "\fBsrc port \fIportnamenum\fR"
243 True if the packet has a source port value of \fIportnamenum\fP.
244 .IP "\fBport \fIportnamenum\fR"
245 True if either the source or destination port of the packet is \fIportnamenum\fP.
246 .IP "\fBdst portrange \fIportnamenum1-portnamenum2\fR"
247 True if the packet is IPv4/v6 TCP, UDP or SCTP and has a
248 destination port value between \fIportnamenum1\fP and \fIportnamenum2\fP (both inclusive).
252 are interpreted in the same fashion as the
256 .IP "\fBsrc portrange \fIportnamenum1-portnamenum2\fR"
257 True if the packet has a source port value between \fIportnamenum1\fP and
258 \fIportnamenum2\fP (both inclusive).
259 .IP "\fBportrange \fIportnamenum1-portnamenum2\fR"
260 True if either the source or destination port of the packet is between
261 \fIportnamenum1\fP and \fIportnamenum2\fP (both inclusive).
263 Any of the above port or port range expressions can be prepended with
264 the keywords, \fBtcp\fP, \fBudp\fP or \fBsctp\fP, as in:
267 \fBtcp src port \fIportnamenum\fR
270 which matches only TCP packets whose source port is \fIportnamenum\fP.
271 .IP "\fBless \fIlength\fR"
272 True if the packet has a length less than or equal to \fIlength\fP.
273 This is equivalent to:
276 \fBlen <= \fIlength\fP
279 .IP "\fBgreater \fIlength\fR"
280 True if the packet has a length greater than or equal to \fIlength\fP.
281 This is equivalent to:
284 \fBlen >= \fIlength\fP
287 .IP "\fBip proto \fIprotocol\fR"
288 True if the packet is an IPv4 packet of protocol type \fIprotocol\fP.
289 \fIProtocol\fP can be a number or one of the names recognized by
290 .BR getprotobyname (3),
295 (only in Linux with glibc, FreeBSD, NetBSD, DragonFly BSD, and macOS),
299 (only in Haiku and OpenBSD),
306 Note that most of these example identifiers
307 are also keywords and must be escaped via backslash (\\).
308 Note that this primitive does not chase the protocol header chain.
311 .BR getprotobyname (3)
314 file to translate protocol names to numbers, and the
315 .B "getent protocols"
316 command lists the protocols recognised by the function. This is not entirely
317 so in AIX (which does not have the command), Haiku (which has the file at
318 .IR \%/system/data/network/protocols
319 and does not have the command), on Linux with musl libc (which hard-codes the
320 list of protocols) and on hosts that use a network database to resolve
321 protocol names to numbers (see
322 .BR nsswitch.conf (5)).
323 If a protocol name fails to translate to a number, this version of libpcap
324 will treat the filter expression as invalid.
325 .IP "\fBcarp\fR, \fBvrrp\fR"
353 .IP "\fBip6 proto \fIprotocol\fR"
354 True if the packet is an IPv6 packet of protocol type \fIprotocol\fP.
355 (See `\fBip proto\fP' above for the meaning of \fIprotocol\fR.)
356 Note that the IPv6 variant of ICMP uses a different protocol number, named
358 in AIX, FreeBSD, illumos, Haiku, GNU/Hurd, Linux, macOS, NetBSD, OpenBSD,
360 Note that this primitive does not chase the protocol header chain.
368 .IP "\fBproto \fIprotocol\fR"
369 True if the packet is an IPv4 or IPv6 packet of protocol type
370 \fIprotocol\fP. (See `\fBip proto\fP' above for the meaning of
371 \fIprotocol\fP.) Note that this primitive does not chase the protocol
373 .IP "\fBah\fR, \fBesp\fR, \fBpim\fR, \fBsctp\fR, \fBtcp\fR, \fBudp\fR"
377 \fBproto \\\fIprotocol\fR
380 where \fIprotocol\fR is one of the above protocols.
381 .IP "\fBip6 protochain \fIprotocol\fR"
382 True if the packet is IPv6 packet,
383 and contains protocol header with type \fIprotocol\fR
384 in its protocol header chain.
385 (See `\fBip proto\fP' above for the meaning of \fIprotocol\fP.)
389 \fBip6 protochain\fR 6
392 matches any IPv6 packet with TCP protocol header in the protocol header chain.
393 The packet may contain, for example,
394 authentication header, routing header, or hop-by-hop option header,
395 between IPv6 header and TCP header.
396 The BPF code emitted by this primitive is complex and
397 cannot be optimized by the BPF optimizer code, and is not supported by
398 filter engines in the kernel, so this can be somewhat slow, and may
399 cause more packets to be dropped.
400 .IP "\fBip protochain \fIprotocol\fR"
401 Equivalent to \fBip6 protochain \fIprotocol\fR, but this is for IPv4.
402 (See `\fBip proto\fP' above for the meaning of \fIprotocol\fP.)
403 .IP "\fBprotochain \fIprotocol\fR"
404 True if the packet is an IPv4 or IPv6 packet of protocol type
405 \fIprotocol\fP. (See `\fBip proto\fP' above for the meaning of
406 \fIprotocol\fP.) Note that this primitive chases the protocol
408 .IP "\fBether broadcast\fR"
409 True if the packet is an Ethernet broadcast packet.
412 .IP "\fBip broadcast\fR"
413 True if the packet is an IPv4 broadcast packet.
414 It checks for both the all-zeroes and all-ones broadcast conventions,
415 and looks up the subnet mask on the interface on which the capture is
418 If the subnet mask of the interface on which the capture is being done
419 is not available, either because the interface on which capture is being
420 done has no netmask or because the capture is being done on the Linux
421 "any" interface, which can capture on more than one interface, this
422 check will not work correctly.
423 .IP "\fBether multicast\fR"
424 True if the packet is an Ethernet multicast packet.
427 This is shorthand for `\fBether[\fP0\fB] & \fP1\fB != \fP0'.
428 .IP "\fBip multicast\fR"
429 True if the packet is an IPv4 multicast packet.
430 .IP "\fBip6 multicast\fR"
431 True if the packet is an IPv6 multicast packet.
432 .IP "\fBether proto \fIprotocol\fR"
433 True if the packet is of ether type \fIprotocol\fR.
434 \fIProtocol\fP can be a number or one of the names
435 \fBaarp\fP, \fBarp\fP, \fBatalk\fP, \fBdecnet\fP, \fBip\fP, \fBip6\fP,
436 \fBipx\fP, \fBiso\fP, \fBlat\fP, \fBloopback\fP, \fBmopdl\fP, \fBmoprc\fP, \fBnetbeui\fP,
437 \fBrarp\fP, \fBsca\fP or \fBstp\fP.
438 Note these identifiers (except \fBloopback\fP) are also keywords
439 and must be escaped via backslash (\\).
441 [In the case of FDDI (e.g., `\fBfddi proto \\arp\fR'), Token Ring
442 (e.g., `\fBtr proto \\arp\fR'), and IEEE 802.11 wireless LANs (e.g.,
443 `\fBwlan proto \\arp\fR'), for most of those protocols, the
444 protocol identification comes from the 802.2 Logical Link Control (LLC)
445 header, which is usually layered on top of the FDDI, Token Ring, or
448 When filtering for most protocol identifiers on FDDI, Token Ring, or
449 802.11, the filter checks only the protocol ID field of an LLC header
450 in so-called SNAP format with an Organizational Unit Identifier (OUI) of
451 0x000000, for encapsulated Ethernet; it doesn't check whether the packet
452 is in SNAP format with an OUI of 0x000000.
457 the filter checks the DSAP (Destination Service Access Point) and
458 SSAP (Source Service Access Point) fields of the LLC header;
460 \fBstp\fP and \fBnetbeui\fP
461 the filter checks the DSAP of the LLC header;
464 the filter checks for a SNAP-format packet with an OUI of 0x080007
465 and the AppleTalk etype.
468 In the case of Ethernet, the filter checks the Ethernet type field
469 for most of those protocols. The exceptions are:
472 \fBiso\fP, \fBstp\fP, and \fBnetbeui\fP
473 the filter checks for an 802.3 frame and then checks the LLC header as
474 it does for FDDI, Token Ring, and 802.11;
477 the filter checks both for the AppleTalk etype in an Ethernet frame and
478 for a SNAP-format packet as it does for FDDI, Token Ring, and 802.11;
481 the filter checks for the AppleTalk ARP etype in either an Ethernet
482 frame or an 802.2 SNAP frame with an OUI of 0x000000;
485 the filter checks for the IPX etype in an Ethernet frame, the IPX
486 DSAP in the LLC header, the 802.3-with-no-LLC-header encapsulation of
487 IPX, and the IPX etype in a SNAP frame.
489 .IP "\fBip\fR, \fBip6\fR, \fBarp\fR, \fBrarp\fR, \fBatalk\fR, \fBaarp\fR, \fBdecnet\fR, \fBiso\fR, \fBstp\fR, \fBipx\fR, \fBnetbeui\fP"
493 \fBether proto \\\fIprotocol\fR
496 where \fIprotocol\fR is one of the above protocols.
497 .IP "\fBlat\fR, \fBmopdl\fR, \fBmoprc\fR, \fBsca\fR"
501 \fBether proto \\\fIprotocol\fR
504 where \fIprotocol\fR is one of the above protocols, all of which originated
505 at DEC, but are not the same as DECnet. Namely,
507 is Local Area Transport (LAT),
509 is DNA Dump/Load (MOP),
511 is DNA Remote Console (MOP) and
513 is System Communication Architecture (SCA).
514 .IP "\fBdecnet src \fIdecnetaddr\fR"
515 True if the DECnet source address is
517 which is an address of the form
518 .B AREANUMBER.NODENUMBER
519 (for example, "10.123"), where the area number can be between 0 and 63
520 and the node number can be between 0 and 1023 and both numbers always use
522 .IP "\fBdecnet dst \fIdecnetaddr\fR"
523 True if the DECnet destination address is
525 .IP "\fBdecnet host \fIdecnetaddr\fR"
526 True if either the DECnet source or destination address is
529 True if the packet has an 802.2 LLC header. This includes:
531 Ethernet packets with a length field rather than a type field that
532 aren't raw NetWare-over-802.3 packets;
534 IEEE 802.11 data packets;
536 Token Ring packets (no check is done for LLC frames);
538 FDDI packets (no check is done for LLC frames);
540 LLC-encapsulated ATM packets, for SunATM on Solaris.
541 .IP "\fBllc\fP \fItype\fR"
542 True if the packet has an 802.2 LLC header and has the specified
558 Receiver Ready (RR) S PDUs
561 Receiver Not Ready (RNR) S PDUs
567 Unnumbered Information (UI) U PDUs
570 Unnumbered Acknowledgment (UA) U PDUs
573 Disconnect (DISC) U PDUs
576 Disconnected Mode (DM) U PDUs
579 Set Asynchronous Balanced Mode Extended (SABME) U PDUs
585 Exchange Identification (XID) U PDUs
588 Frame Reject (FRMR) U PDUs
591 Packet was received by the host performing the capture rather than being
592 sent by that host. This is only supported for certain link-layer types,
593 such as SLIP and the ``cooked'' Linux capture mode
594 used for the ``any'' device and for some other device types.
596 Packet was sent by the host performing the capture rather than being
597 received by that host. This is only supported for certain link-layer types,
598 such as SLIP and the ``cooked'' Linux capture mode
599 used for the ``any'' device and for some other device types.
600 .IP "\fBifindex \fIinterface_index\fR"
601 True if the packet was logged via the specified interface (applies only to
602 packets logged by the Linux "any" cooked v2 interface).
603 .IP "\fBifname \fIinterface\fR"
604 True if the packet was logged as coming from the specified interface (applies
605 only to packets logged by OpenBSD's or FreeBSD's
607 .IP "\fBon \fIinterface\fR"
611 .IP "\fBrnr \fInum\fR"
612 True if the packet was logged as matching the specified PF rule number
613 (applies only to packets logged by OpenBSD's or FreeBSD's
615 .IP "\fBrulenum \fInum\fR"
619 .IP "\fBreason \fIcode\fR"
620 True if the packet was logged with the specified PF reason code. The known
629 (applies only to packets logged by OpenBSD's or FreeBSD's
631 .IP "\fBrset \fIname\fR"
632 True if the packet was logged as matching the specified PF ruleset
633 name of an anchored ruleset (applies only to packets logged by OpenBSD's
636 .IP "\fBruleset \fIname\fR"
640 .IP "\fBsrnr \fInum\fR"
641 True if the packet was logged as matching the specified PF rule number
642 of an anchored ruleset (applies only to packets logged by OpenBSD's or
645 .IP "\fBsubrulenum \fInum\fR"
649 .IP "\fBaction \fIact\fR"
650 True if PF took the specified action when the packet was logged. Known actions
655 and, with later versions of
662 (applies only to packets logged by OpenBSD's or FreeBSD's
664 .IP "\fBwlan ra \fIehost\fR"
665 True if the IEEE 802.11 RA is
667 The RA field is used in all frames except for management frames.
668 .IP "\fBwlan ta \fIehost\fR"
669 True if the IEEE 802.11 TA is
671 The TA field is used in all frames except for management frames and
672 CTS (Clear To Send) and ACK (Acknowledgment) control frames.
673 .IP "\fBwlan addr1 \fIehost\fR"
674 True if the first IEEE 802.11 address is
676 .IP "\fBwlan addr2 \fIehost\fR"
677 True if the second IEEE 802.11 address, if present, is
679 The second address field is used in all frames except for CTS (Clear To
680 Send) and ACK (Acknowledgment) control frames.
681 .IP "\fBwlan addr3 \fIehost\fR"
682 True if the third IEEE 802.11 address, if present, is
684 The third address field is used in management and data frames, but not
686 .IP "\fBwlan addr4 \fIehost\fR"
687 True if the fourth IEEE 802.11 address, if present, is
689 The fourth address field is only used for
690 WDS (Wireless Distribution System) frames.
691 .IP "\fBwlan type \fIwlan_type\fR"
692 True if the IEEE 802.11 frame type matches the specified \fIwlan_type\fR.
693 Valid \fIwlan_type\fRs are:
700 .IP "\fBwlan type \fIwlan_type \fBsubtype \fIwlan_subtype\fR"
701 True if the IEEE 802.11 frame type matches the specified \fIwlan_type\fR
702 and frame subtype matches the specified \fIwlan_subtype\fR.
707 If the specified \fIwlan_type\fR is \fBmgt\fP,
708 then valid \fIwlan_subtype\fRs are:
721 If the specified \fIwlan_type\fR is \fBctl\fP,
722 then valid \fIwlan_subtype\fRs are:
732 If the specified \fIwlan_type\fR is \fBdata\fP,
733 then valid \fIwlan_subtype\fRs are:
737 .BR \%data-cf-ack-poll ,
743 .BR \%qos-data-cf-ack ,
744 .BR \%qos-data-cf-poll ,
745 .BR \%qos-data-cf-ack-poll ,
749 .BR \%qos-cf-ack-poll .
750 .IP "\fBwlan subtype \fIwlan_subtype\fR"
751 True if the IEEE 802.11 frame subtype matches the specified \fIwlan_subtype\fR
752 and frame has the type to which the specified \fIwlan_subtype\fR belongs.
756 .IP "\fBwlan dir \fIdirection\fR"
757 True if the IEEE 802.11 frame direction matches the specified
759 Valid directions are:
768 .IP "\fBvlan \fI[vlan_id]\fR"
769 True if the packet is an IEEE 802.1Q VLAN packet.
770 If the optional \fIvlan_id\fR is specified, only true if the packet has the specified
772 Note that the first \fBvlan\fR keyword encountered in an expression
773 changes the decoding offsets for the remainder of the expression on
774 the assumption that the packet is a VLAN packet. The `\fBvlan
775 \fI[vlan_id]\fR` keyword may be used more than once, to filter on VLAN
776 hierarchies. Each use of that keyword increments the filter offsets
782 \fBvlan\fP 100 \fB&& vlan\fR 200
785 filters on VLAN 200 encapsulated within VLAN 100, and
788 \fBvlan && vlan \fP300 \fB&& ip\fR
791 filters IPv4 protocol encapsulated in VLAN 300 encapsulated within any
793 .IP "\fBmpls \fI[label_num]\fR"
794 True if the packet is an MPLS packet.
795 If the optional \fIlabel_num\fR is specified, only true if the packet has the specified
797 Note that the first \fBmpls\fR keyword encountered in an expression
798 changes the decoding offsets for the remainder of the expression on
799 the assumption that the packet is a MPLS-encapsulated IP packet. The
800 `\fBmpls \fI[label_num]\fR` keyword may be used more than once, to
801 filter on MPLS hierarchies. Each use of that keyword increments the
807 \fBmpls\fP 100000 \fB&& mpls\fR 1024
810 filters packets with an outer label of 100000 and an inner label of
814 \fBmpls && mpls\fP 1024 \fB&& host\fR 192.9.200.1
817 filters packets to or from 192.9.200.1 with an inner label of 1024 and
820 True if the packet is a PPP-over-Ethernet Discovery packet (Ethernet
822 .IP "\fBpppoes \fI[session_id]\fR"
823 True if the packet is a PPP-over-Ethernet Session packet (Ethernet
825 If the optional \fIsession_id\fR is specified, only true if the packet has the specified
827 Note that the first \fBpppoes\fR keyword encountered in an expression
828 changes the decoding offsets for the remainder of the expression on
829 the assumption that the packet is a PPPoE session packet.
834 \fBpppoes\fP 0x27 \fB&& ip\fR
837 filters IPv4 protocol encapsulated in PPPoE session id 0x27.
838 .IP "\fBgeneve \fI[vni]\fR"
839 True if the packet is a Geneve packet (UDP port 6081). If the optional \fIvni\fR
840 is specified, only true if the packet has the specified \fIvni\fR.
841 Note that when the \fBgeneve\fR keyword is encountered in
842 an expression, it changes the decoding offsets for the remainder of
843 the expression on the assumption that the packet is a Geneve packet.
848 \fBgeneve\fP 0xb \fB&& ip\fR
851 filters IPv4 protocol encapsulated in Geneve with VNI 0xb. This will
852 match both IPv4 directly encapsulated in Geneve as well as IPv4 contained
853 inside an Ethernet frame.
854 .IP "\fBvxlan \fI[vni]\fR"
855 True if the packet is a VXLAN packet (UDP port 4789). If the optional
856 \fIvni\fR is specified, only true if the packet has the specified
857 \fIvni\fR. Note that when the \fBvxlan\fR keyword is encountered in
858 an expression, it changes the decoding offsets for the remainder of
859 the expression on the assumption that the packet is a VXLAN packet.
864 \fBvxlan\fP 0x7 \fB&& ip6 \fR
867 filters IPv6 protocol encapsulated in VXLAN with VNI 0x7.
868 .IP "\fBiso proto \fIprotocol\fR"
869 True if the packet is an OSI packet of protocol type \fIprotocol\fP.
870 \fIProtocol\fP can be a number or one of the names
871 \fBclnp\fP, \fBesis\fP, or \fBisis\fP.
872 .IP "\fBclnp\fR, \fBesis\fR, \fBisis\fR"
876 \fBiso proto \\\fIprotocol\fR
879 where \fIprotocol\fR is one of the above protocols.
880 .IP "\fBl1\fR, \fBl2\fR, \fBiih\fR, \fBlsp\fR, \fBsnp\fR, \fBcsnp\fR, \fBpsnp\fR"
881 Abbreviations for IS-IS PDU types.
882 .IP "\fIatmfield relop val\fR"
883 True if the packet is an ATM packet, for SunATM on Solaris, and the relation
907 stand for the virtual path identifier (VPI) and the virtual channel
908 identifier (VCI) fields respectively.
909 .IP "\fIatmfield\fP \fIval\fR"
913 \fIatmfield\fR == \fIval\fR
916 in the expression above.
917 .IP "\fIatmfield\fP (\fIval1\fR \fBor\fP ... \fBor\fP \fIvalN\fR)"
921 (\fIatmfield\fP == \fIval1\fP \fBor\fP ... \fBor\fP \fIatmfield\fP == \fIvalN\fR)
924 in the expression above.
926 True if the packet is an ATM packet, for SunATM on Solaris, and is
928 Note that the first \fBlane\fR keyword encountered in an expression
929 changes the tests done in the remainder of the expression
930 on the assumption that the packet is either a LANE emulated Ethernet
931 packet or a LANE LE Control packet. If \fBlane\fR isn't specified, the
932 tests are done under the assumption that the packet is an
933 LLC-encapsulated packet.
935 True if the packet is an ATM packet, for SunATM on Solaris, and is
936 a segment OAM F4 flow cell (VPI=0 & VCI=3).
938 True if the packet is an ATM packet, for SunATM on Solaris, and is
939 an end-to-end OAM F4 flow cell (VPI=0 & VCI=4).
941 True if the packet is an ATM packet, for SunATM on Solaris, and is
942 a segment or end-to-end OAM F4 flow cell (VPI=0 & (VCI=3 | VCI=4)).
944 True if the packet is an ATM packet, for SunATM on Solaris, and is
945 a segment or end-to-end OAM F4 flow cell (VPI=0 & (VCI=3 | VCI=4)).
947 True if the packet is an ATM packet, for SunATM on Solaris, and is
948 on a meta signaling circuit (VPI=0 & VCI=1).
950 True if the packet is an ATM packet, for SunATM on Solaris, and is
951 on a broadcast signaling circuit (VPI=0 & VCI=2).
953 True if the packet is an ATM packet, for SunATM on Solaris, and is
954 on a signaling circuit (VPI=0 & VCI=5).
956 True if the packet is an ATM packet, for SunATM on Solaris, and is
957 on an ILMI circuit (VPI=0 & VCI=16).
959 True if the packet is an ATM packet, for SunATM on Solaris, and is
960 on a signaling circuit and is a Q.2931 Setup, Call Proceeding, Connect,
961 Connect Ack, Release, or Release Done message.
962 .IP \fBmetaconnect\fP
963 True if the packet is an ATM packet, for SunATM on Solaris, and is
964 on a meta signaling circuit and is a Q.2931 Setup, Call Proceeding, Connect,
965 Release, or Release Done message.
967 True if the packet is a Fill-In Signal Unit (FISU) MTP2 packet.
969 True if the packet is a Link Status Signal Unit (LSSU) MTP2 packet.
971 True if the packet is a Message Signal Unit (MSU) MTP2 packet.
972 .IP "\fImtpfield relop val\fR"
973 True if the relation holds.
996 stands for the Service Information Octet (SIO) field of the MTP2 MSU header;
997 note that this keyword does not test whether the packet is an MSU packet.
1002 stand for the Destination Point Code (DPC), Originating Point Code (OPC) and
1003 Signalling Link Selection (SLS) fields respectively of the MTP3 standard
1004 routing label; note that these keywords do not test whether the packet is an
1006 .IP "\fImtpfield\fP \fIval\fR"
1010 \fImtpfield\fR == \fIval\fR
1013 in the expression above.
1014 .IP "\fImtpfield\fP (\fIval1\fR \fBor\fP ... \fBor\fP \fIvalN\fR)"
1018 (\fImtpfield\fP == \fIval1\fP \fBor\fP ... \fBor\fP \fImtpfield\fP == \fIvalN\fR)
1021 in the expression above.
1022 .IP "\fBhfisu\fR, \fBhlssu\fR, \fBhmsu\fR, \fBhsio\fR, \fBhdpc\fR, \fBhopc\fR, \fBhsls\fP"
1032 respectively, but only if the MTP2 link uses the extended sequence numbers
1033 encoding specified for high speed signalling links (HSL) in ITU-T
1034 Recommendation Q.703 Annex A.
1035 .IP "\fBlink src \fIarcnetaddr\fR"
1039 .BR \%DLT_ARCNET_LINUX ,
1040 if the ARCnet source address is
1042 which in this expression is a string of the form
1046 where "x" is a hexadecimal digit (for example,
1048 Note that this address syntax clashes with the parameter expansion syntax
1049 in POSIX-compatible shells and elsewhere, so depending on the use case the
1050 filter string may require the use of single quotes or a backslash.
1051 .IP "\fBlink dst \fIarcnetaddr\fR"
1052 Same as the above, but for the destination ARCnet address; also in ARCnet
1058 .BR "\%link dst $0" .
1059 .IP "\fBlink host \fIarcnetaddr\fR"
1063 \fBlink src \fIarcnetaddr \fBor link dst \fIarcnetaddr\fR
1066 in the expressions above.
1067 .IP "\fIexpr1 relop expr2\fR"
1068 True if the relation holds. \fIRelop\fR is one of
1080 Each of \fIexpr1\fR and \fIexpr2\fR is an arithmetic expression composed of
1081 integer constants (expressed in standard C syntax), the normal binary operators
1092 a length operator, and special packet data
1093 accessors. Note that all comparisons are unsigned, so that, for example,
1094 0x80000000 and 0xffffffff are > 0.
1100 operators are currently only supported for filtering in the kernel on
1101 particular operating systems (for example: FreeBSD, Linux with 3.7 and later
1102 kernels, NetBSD); on all other systems (for example: AIX, Hurd, illumos, Solaris,
1104 those operators are used, filtering will be done in user mode, which
1105 will increase the overhead of capturing packets and may cause more
1106 packets to be dropped.
1108 The length operator, indicated by the keyword \fBlen\fP, gives the
1109 length of the packet.
1111 To access data inside the packet, use the following syntax:
1114 \fIproto\fB [ \fIexpr\fB : \fIsize\fB ]\fR
1149 indicates the protocol layer for the index operation.
1159 link layer. \fBradio\fR refers to the "radio header" added to some
1161 Note that \fBtcp\fR, \fBudp\fR and other upper-layer protocol types only
1162 apply to IPv4, not IPv6 (this will be fixed in the future).
1163 The byte offset, relative to the indicated protocol layer, is
1164 given by \fIexpr\fR.
1165 \fISize\fR is optional and indicates the number of bytes in the
1166 field of interest; it can be either one, two, or four, and defaults to one.
1168 For example, `\fBether[\fP0\fB] &\fP 1 \fB!=\fP 0' catches all multicast traffic.
1169 The expression `\fBip[\fP0\fB] &\fP 0xf \fB!=\fP 5'
1170 catches all IPv4 packets with options.
1172 `\fBip[\fP6:2\fB] &\fP 0x1fff \fB=\fP 0'
1173 catches only unfragmented IPv4 datagrams and frag zero of fragmented
1175 This check is implicitly applied to the
1187 For instance, \fBtcp[\fP0\fB]\fP always means the first
1188 byte of the TCP \fIheader\fP, and never means the first byte of an
1189 intervening fragment.
1191 Some offsets and field values may be expressed as names rather than
1193 The following protocol header field offsets are
1194 available: \fBicmptype\fP (ICMP type field), \fBicmp6type\fP (ICMPv6 type field),
1195 \fBicmpcode\fP (ICMP code field), \fBicmp6code\fP (ICMPv6 code field) and
1196 \fBtcpflags\fP (TCP flags field).
1198 The following ICMP type field values are available:
1199 .BR \%icmp-echoreply ,
1200 .BR \%icmp-unreach ,
1201 .BR \%icmp-sourcequench ,
1202 .BR \%icmp-redirect ,
1204 .BR \%icmp-routeradvert ,
1205 .BR \%icmp-routersolicit ,
1206 .BR \%icmp-timxceed ,
1207 .BR \%icmp-paramprob ,
1209 .BR \%icmp-tstampreply ,
1211 .BR \%icmp-ireqreply ,
1212 .BR \%icmp-maskreq ,
1213 .BR \%icmp-maskreply .
1215 The following ICMPv6 type field values are available:
1216 .BR \%icmp6-destinationunreach ,
1217 .BR \%icmp6-packettoobig ,
1218 .BR \%icmp6-timeexceeded ,
1219 .BR \%icmp6-parameterproblem ,
1221 .BR \%icmp6-echoreply ,
1222 .BR \%icmp6-multicastlistenerquery ,
1223 .BR \%icmp6-multicastlistenerreportv1 ,
1224 .BR \%icmp6-multicastlistenerdone ,
1225 .BR \%icmp6-routersolicit ,
1226 .BR \%icmp6-routeradvert ,
1227 .BR \%icmp6-neighborsolicit ,
1228 .BR \%icmp6-neighboradvert ,
1229 .BR \%icmp6-redirect ,
1230 .BR \%icmp6-routerrenum ,
1231 .BR \%icmp6-nodeinformationquery ,
1232 .BR \%icmp6-nodeinformationresponse ,
1233 .BR \%icmp6-ineighbordiscoverysolicit ,
1234 .BR \%icmp6-ineighbordiscoveryadvert ,
1235 .BR \%icmp6-multicastlistenerreportv2 ,
1236 .BR \%icmp6-homeagentdiscoveryrequest ,
1237 .BR \%icmp6-homeagentdiscoveryreply ,
1238 .BR \%icmp6-mobileprefixsolicit ,
1239 .BR \%icmp6-mobileprefixadvert ,
1240 .BR \%icmp6-certpathsolicit ,
1241 .BR \%icmp6-certpathadvert ,
1242 .BR \%icmp6-multicastrouteradvert ,
1243 .BR \%icmp6-multicastroutersolicit ,
1244 .BR \%icmp6-multicastrouterterm .
1246 The following TCP flags field values are available: \fBtcp-fin\fP,
1247 \fBtcp-syn\fP, \fBtcp-rst\fP, \fBtcp-push\fP,
1248 \fBtcp-ack\fP, \fBtcp-urg\fP, \fBtcp-ece\fP,
1251 Primitives may be combined using:
1253 A parenthesized group of primitives and operators.
1255 Negation (`\fB!\fP' or `\fBnot\fP').
1257 Concatenation (`\fB&&\fP' or `\fBand\fP').
1259 Alternation (`\fB||\fP' or `\fBor\fP').
1261 Negation has the highest precedence.
1262 Alternation and concatenation have equal precedence and associate
1265 If an identifier is given without a keyword, the most recent keyword
1270 \fBnot host\fP vs \fBand\fR ace
1276 \fBnot host\fP vs \fBand host\fR ace
1279 which should not be confused with
1282 \fBnot (host \fPvs\fB or \fPace\fB)\fR
1287 To select all packets arriving at or departing from `sundown':
1294 To select traffic between `helios' and either `hot' or `ace':
1297 \fBhost\fP helios \fBand (\fPhot \fBor\fP ace\fB)\fP
1301 To select all IPv4 packets between `ace' and any host except `helios':
1304 \fBip host\fP ace \fBand not\fP helios
1308 To select all traffic between local hosts and hosts at Berkeley:
1315 To select all FTP traffic through Internet gateway `snup':
1318 \fBgateway\fP snup \fBand (port\fP ftp \fBor\fP ftp-data\fB)\fP
1322 To select IPv4 traffic neither sourced from nor destined for local hosts
1323 (if you gateway to one other net, this stuff should never make it
1324 onto your local net).
1327 \fBip and not net \fPlocalnet
1331 To select the start and end packets (the SYN and FIN packets) of each
1332 TCP conversation that involves a non-local host.
1335 \fBtcp[tcpflags] & (tcp-syn|tcp-fin) !=\fP 0 \fBand not src and dst net\fP localnet
1339 To select the TCP packets with flags RST and ACK both set.
1340 (i.e. select only the RST and ACK flags in the flags field, and if the result
1341 is "RST and ACK both set", match)
1345 tcp[tcpflags] & (tcp-rst|tcp-ack) == (tcp-rst|tcp-ack)
1349 To select all IPv4 HTTP packets to and from port 80, i.e. print only
1350 packets that contain data, not, for example, SYN and FIN packets and
1351 ACK-only packets. (IPv6 is left as an exercise for the reader.)
1354 \fBtcp port\fP 80 \fBand (((ip[\fP2:2\fB] - ((ip[\fP0\fB]&\fP0xf\fB)<<\fP2\fB)) - ((tcp[\fP12\fB]&\fP0xf0\fB)>>\fP2\fB)) != \fP0\fB)
1358 To select IPv4 packets longer than 576 bytes sent through gateway `snup':
1361 \fBgateway\fP snup \fBand ip[\fP2:2\fB] >\fP 576
1365 To select IPv4 broadcast or multicast packets that were
1367 sent via Ethernet broadcast or multicast:
1370 \fBether[\fP0\fB] &\fP 1 \fB=\fP 0 \fBand ip[\fP16\fB] >=\fP 224
1374 To select all ICMP packets that are not echo requests/replies (i.e., not
1379 icmp[icmptype] != icmp-echo and icmp[icmptype] != icmp-echoreply
1381 icmp6[icmp6type] != icmp6-echo and icmp6[icmp6type] != icmp6-echoreply
1384 .SH BACKWARD COMPATIBILITY
1387 keyword became available in libpcap 1.2.1.
1398 keywords became available in libpcap 1.5.3.
1404 binary operators became available in libpcap 1.6.2.
1408 keyword became available in libpcap 1.8.0.
1410 The ICMPv6 type code names, as well as the
1414 TCP flag names became available in libpcap 1.9.0.
1418 keyword became available in libpcap 1.10.0.
1422 keyword became available in libpcap 1.11.0.
1426 To report a security issue please send an e-mail to \%security@tcpdump.org.
1428 To report bugs and other problems, contribute patches, request a
1429 feature, provide generic feedback etc please see the file
1431 in the libpcap source tree root.
1433 Filter expressions on fields other than those in Token Ring headers will
1434 not correctly handle source-routed Token Ring packets.
1436 Filter expressions on fields other than those in 802.11 headers will not
1437 correctly handle 802.11 data packets with both To DS and From DS set.
1440 should chase header chain, but at this moment it does not.
1441 `\fBip6 protochain\fP'
1442 is supplied for this behavior. For example, to match IPv6 fragments:
1443 `\fBip6 protochain\fP 44'
1445 Arithmetic expression against transport layer headers, like \fBtcp[0]\fP,
1446 does not work against IPv6 packets.
1447 It only looks at IPv4 packets.