netsniff-ng: Move variable definition
[netsniff-ng.git] / netsniff-ng.8
blobb6f129ad5235cf0e85826e85f22c417d83f0e47e
1 .\" netsniff-ng - the packet sniffing beast
2 .\" Copyright 2013 Daniel Borkmann.
3 .\" Subject to the GPL, version 2.
4 .TH NETSNIFF-NG 8 "03 March 2013" "Linux" "netsniff-ng toolkit"
5 .SH NAME
6 netsniff-ng \- the packet sniffing beast
7 .PP
8 .SH SYNOPSIS
9 .PP
10 \fBnetsniff-ng\fR { [\fIoptions\fR] [\fIfilter-expression\fR] }
11 .PP
12 .SH DESCRIPTION
13 .PP
14 netsniff-ng is a fast, minimal tool to analyze network packets, capture
15 pcap files, replay pcap files, and redirect traffic between interfaces
16 with the help of zero-copy packet(7) sockets. netsniff-ng uses both Linux
17 specific RX_RING and TX_RING interfaces to perform zero-copy. This is to avoid
18 copy and system call overhead between kernel and user address space. When we
19 started working on netsniff-ng, the pcap(3) library did not use this
20 zero-copy facility.
21 .PP
22 netsniff-ng is Linux specific, meaning there is no support for other
23 operating systems. Therefore we can keep the code footprint quite minimal and to
24 the point. Linux packet(7) sockets and its RX_RING and TX_RING interfaces
25 bypass the normal packet processing path through the networking stack.
26 This is the fastest capturing or transmission performance one can get from user
27 space out of the box, without having to load unsupported or non-mainline
28 third-party kernel modules. We explicitly refuse to build netsniff-ng on top of
29 ntop/PF_RING. Not because we do not like it (we do find it interesting), but
30 because of the fact that it is not part of the mainline kernel. Therefore, the
31 ntop project has to maintain and sync out-of-tree drivers to adapt them to their
32 DNA. Eventually, we went for untainted Linux kernel, since its code has a higher
33 rate of review, maintenance, security and bug fixes.
34 .PP
35 netsniff-ng also supports early packet filtering in the kernel. It has support
36 for low-level and high-level packet filters that are translated into Berkeley
37 Packet Filter instructions.
38 .PP
39 netsniff-ng can capture pcap files in several different pcap formats that
40 are interoperable with other tools. It has different pcap I/O methods supported
41 (scatter-gather, mmap(2), read(2), and write(2)) for efficient to-disc capturing.
42 netsniff-ng is also able to rotate pcap files based on data size or time
43 intervals, thus, making it a useful backend tool for subsequent traffic
44 analysis.
45 .PP
46 netsniff-ng itself also supports analysis, replaying, and dumping of raw 802.11
47 frames. For online or offline analysis, netsniff-ng has a built-in packet
48 dissector for the current 802.3 (Ethernet), 802.11* (WLAN), ARP, MPLS, 802.1Q
49 (VLAN), 802.1QinQ, LLDP, IPv4, IPv6, ICMPv4, ICMPv6, IGMP, TCP and UDP,
50 including GeoIP location analysis. Since netsniff-ng does not establish any
51 state or perform reassembly during packet dissection, its memory footprint is quite
52 low, thus, making netsniff-ng quite efficient for offline analysis of large
53 pcap files as well.
54 .PP
55 Note that netsniff-ng is currently not multithreaded. However, this does not
56 prevent you from starting multiple netsniff-ng instances that are pinned to
57 different, non-overlapping CPUs and f.e. have different BPF filters attached.
58 Likely that at some point in time your harddisc might become a bottleneck
59 assuming you do not rotate such pcaps in ram (and from there periodically
60 scheduled move to slower medias). You can then use mergecap(1) to transform
61 all pcaps into a single large pcap. Thus, netsniff-ng then works multithreaded
62 eventually.
63 .PP
64 netsniff-ng can also be used to debug netlink traffic.
65 .PP
66 .SH OPTIONS
67 .PP
68 .SS -i <dev|pcap|->, -d <dev|pcap|->, --in <dev|pcap|->, --dev <dev|pcap|->
69 Defines an input device. This can either be a networking device, a pcap file
70 or stdin (\[lq]\-\[rq]). In case of a pcap file, the pcap type (\[lq]\-D\[rq]
71 option) is determined automatically by the pcap file magic. In case of stdin,
72 it is assumed that the input stream is a pcap file.
73 .PP
74 .SS -o <dev|pcap|dir|cfg|->, --out <dev|pcap|dir|cfg|->
75 Defines the output device. This can either be a networking device, a pcap file,
76 a folder, a trafgen(8) configuration file or stdout (\[lq]-\[rq]). In the case of a pcap
77 file that should not have the default pcap type (0xa1b2c3d4), the additional
78 option \[lq]\-T\[rq] must be provided. If a directory is given, then, instead of a
79 single pcap file, multiple pcap files are generated with rotation based on
80 maximum file size or a given interval (\[lq]\-F\[rq] option). A trafgen configuration
81 file can currently only be specified if the input device is a pcap file. If
82 stdout is given as a device, then a trafgen configuration will be written to
83 stdout if the input device is a pcap file, or a pcap file if the input device
84 is a networking device.
85 .PP
86 .SS -f, --filter <bpf-file|expr>
87 Specifies to not dump all traffic, but to filter the network packet haystack.
88 As a filter, either a bpfc(8) compiled file can be passed as a parameter or
89 a tcpdump(1)-like filter expression in quotes. For details regarding the
90 bpf-file have a look at bpfc(8), for details regarding a tcpdump(1)-like filter
91 have a look at section \[lq]filter example\[rq] or at pcap-filter(7). A filter
92 expression may also be passed to netsniff-ng without option \[lq]\-f\[rq] in case
93 there is no subsequent option following after the command-line filter expression.
94 .PP
95 .SS -t, --type <type>
96 This defines some sort of filtering mechanisms in terms of addressing. Possible
97 values for type are \[lq]host\[rq] (to us), \[lq]broadcast\[rq] (to all), \[lq]multicast\[rq] (to
98 group), \[lq]others\[rq] (promiscuous mode) or \[lq]outgoing\[rq] (from us).
99 .PP
100 .SS -F, --interval <size|time>
101 If the output device is a folder, with \[lq]\-F\[rq], it is possible to define the pcap
102 file rotation interval either in terms of size or time. Thus, when the interval
103 limit has been reached, a new pcap file will be started. As size parameter, the
104 following values are accepted \[lq]<num>KiB/MiB/GiB\[rq]; As time parameter,
105 it can be \[lq]<num>s/sec/min/hrs\[rq].
107 .SS -J, --jumbo-support
108 By default, in pcap replay or redirect mode, netsniff-ng's ring buffer frames
109 are a fixed size of 2048 bytes. This means that if you are expecting jumbo
110 frames or even super jumbo frames to pass through your network, then you need
111 to enable support for that by using this option. However, this has the
112 disadvantage of performance degradation and a bigger memory footprint for the
113 ring buffer. Note that this doesn't affect (pcap) capturing mode, since tpacket
114 in version 3 is used!
116 .SS -R, --rfraw
117 In case the input or output networking device is a wireless device, it is
118 possible with netsniff-ng to turn this into monitor mode and create a mon<X>
119 device that netsniff-ng will be listening on instead of wlan<X>, for instance.
120 This enables netsniff-ng to analyze, dump, or even replay raw 802.11 frames.
122 .SS -n <0|uint>, --num <0|uint>
123 Process a number of packets and then exit. If the number of packets is 0, then
124 this is equivalent to infinite packets resp. processing until interrupted.
125 Otherwise, a number given as an unsigned integer will limit processing.
127 .SS -P <name>, --prefix <name>
128 When dumping pcap files into a folder, a file name prefix can be defined with
129 this option. If not otherwise specified, the default prefix is \[lq]dump\-\[rq]
130 followed by a Unix timestamp. Use \[lq]\-\-prefex ""\[rq] to set filename as
131 seconds since the Unix Epoch e.g. 1369179203.pcap
133 .SS -T <pcap-magic>, --magic <pcap-magic>
134 Specify a pcap type for storage. Different pcap types with their various meta
135 data capabilities are shown with option \[lq]\-D\[rq]. If not otherwise
136 specified, the pcap-magic 0xa1b2c3d4, also known as a standard tcpdump-capable
137 pcap format, is used. Pcap files with swapped endianness are also supported.
139 .SS -D, --dump-pcap-types
140 Dump all available pcap types with their capabilities and magic numbers that
141 can be used with option \[lq]\-T\[rq] to stdout and exit.
143 .SS -B, --dump-bpf
144 If a Berkeley Packet Filter is given, for example via option \[lq]\-f\[rq], then
145 dump the BPF disassembly to stdout during ring setup. This only serves for informative
146 or verification purposes.
148 .SS -r, --rand
149 If the input and output device are both networking devices, then this option will
150 randomize packet order in the output ring buffer.
152 .SS -M, --no-promisc
153 The networking interface will not be put into promiscuous mode. By default,
154 promiscuous mode is turned on.
156 .SS -N, --no-hwtimestamp
157 Disable taking hardware time stamps for RX packets. By default, if the network
158 device supports hardware time stamping, the hardware time stamps will be used
159 when writing packets to pcap files. This option disables this behavior and
160 forces (kernel based) software time stamps to be used, even if hardware time
161 stamps are available.
163 .SS -A, --no-sock-mem
164 On startup and shutdown, netsniff-ng tries to increase socket read and
165 write buffers if appropriate. This option will prevent netsniff-ng from doing
168 .SS -m, --mmap
169 Use mmap(2) as pcap file I/O. This is the default when replaying pcap files.
171 .SS -G, --sg
172 Use scatter-gather as pcap file I/O. This is the default when capturing
173 pcap files.
175 .SS -c, --clrw
176 Use slower read(2) and write(2) I/O. This is not the default case anywhere, but in
177 some situations it could be preferred as it has a lower latency on write-back
178 to disc.
180 .SS -S <size>, --ring-size <size>
181 Manually define the RX_RING resp. TX_RING size in \[lq]<num>KiB/MiB/GiB\[rq]. By
182 default, the size is determined based on the network connectivity rate.
184 .SS -k <uint>, --kernel-pull <uint>
185 Manually define the interval in micro-seconds where the kernel should be triggered
186 to batch process the ring buffer frames. By default, it is every 10us, but it can
187 manually be prolonged, for instance.
189 .SS -b <cpu>, --bind-cpu <cpu>
190 Pin netsniff-ng to a specific CPU and also pin resp. migrate the NIC's IRQ
191 CPU affinity to this CPU. This option should be preferred in combination with
192 \[lq]\-s\[rq] in case a middle to high packet rate is expected.
194 .SS -u <uid>, --user <uid> resp. -g <gid>, --group <gid>
195 After ring setup drop privileges to a non-root user/group combination.
197 .SS -H, --prio-high
198 Set this process as a high priority process in order to achieve a higher
199 scheduling rate resp. CPU time. This is however not the default setting, since
200 it could lead to starvation of other processes, for example low priority kernel
201 threads.
203 .SS -Q, --notouch-irq
204 Do not reassign the NIC's IRQ CPU affinity settings.
206 .SS -s, --silent
207 Do not enter the packet dissector at all and do not print any packet information
208 to the terminal. Just shut up and be silent. This option should be preferred in
209 combination with pcap recording or replay, since it will not flood your terminal
210 which causes a significant performance degradation.
212 .SS -q, --less
213 Print a less verbose one-line information for each packet to the terminal.
215 .SS -X, --hex
216 Only dump packets in hex format to the terminal.
218 .SS -l, --ascii
219 Only display ASCII printable characters.
221 .SS -U, --update
222 If geographical IP location is used, the built-in database update
223 mechanism will be invoked to get Maxmind's latest database. To configure
224 search locations for databases, the file /etc/netsniff-ng/geoip.conf contains
225 possible addresses. Thus, to save bandwidth or for mirroring of Maxmind's
226 databases (to bypass their traffic limit policy), different hosts or IP
227 addresses can be placed into geoip.conf, separated by a newline.
229 .SS -V, --verbose
230 Be more verbose during startup i.e. show detailed ring setup information.
232 .SS -v, --version
233 Show version information and exit.
235 .SS -h, --help
236 Show user help and exit.
238 .SH USAGE EXAMPLE
240 .SS netsniff-ng
241 The most simple command is to just run \[lq]netsniff-ng\[rq]. This will start
242 listening on all available networking devices in promiscuous mode and dump
243 the packet dissector output to the terminal. No files will be recorded.
245 .SS  netsniff-ng --in eth0 --out dump.pcap -s -T 0xa1e2cb12 -b 0 tcp or udp
246 Capture TCP or UDP traffic from the networking device eth0 into the pcap file
247 named dump.pcap, which has netsniff-ng specific pcap extensions (see
248 \[lq]netsniff-ng \-D\[rq] for capabilities). Also, do not print the content to
249 the terminal and pin the process and NIC IRQ affinity to CPU 0. The pcap write
250 method is scatter-gather I/O.
252 .SS  netsniff-ng --in wlan0 --rfraw --out dump.pcap --silent --bind-cpu 0
253 Put the wlan0 device into monitoring mode and capture all raw 802.11 frames
254 into the file dump.pcap. Do not dissect and print the content to the terminal
255 and pin the process and NIC IRQ affinity to CPU 0. The pcap write method is
256 scatter-gather I/O.
258 .SS  netsniff-ng --in dump.pcap --mmap --out eth0 -k1000 --silent --bind-cpu 0
259 Replay the pcap file dump.pcap which is read through mmap(2) I/O and send
260 the packets out via the eth0 networking device. Do not dissect and print the
261 content to the terminal and pin the process and NIC IRQ affinity to CPU 0.
262 Also, trigger the kernel every 1000us to traverse the TX_RING instead of every
263 10us. Note that the pcap magic type is detected automatically from the pcap
264 file header.
266 .SS  netsniff-ng --in eth0 --out eth1 --silent --bind-cpu 0 --type host -r
267 Redirect network traffic from the networking device eth0 to eth1 for traffic
268 that is destined for our host, thus ignore broadcast, multicast and promiscuous
269 traffic. Randomize the order of packets for the outgoing device and do not
270 print any packet contents to the terminal. Also, pin the process and NIC IRQ
271 affinity to CPU 0.
273 .SS  netsniff-ng --in team0 --out /opt/probe/ -s -m --interval 100MiB -b 0
274 Capture on an aggregated team0 networking device and dump packets into multiple
275 pcap files that are split into 100MiB each. Use mmap(2) I/O as a pcap write
276 method, support for super jumbo frames is built-in (does not need to be
277 configured here), and do not print the captured data to the terminal. Pin
278 netsniff-ng and NIC IRQ affinity to CPU 0. The default pcap magic type is
279 0xa1b2c3d4 (tcpdump-capable pcap).
281 .SS  netsniff-ng --in vlan0 --out dump.pcap -c -u `id -u bob` -g `id -g bob`
282 Capture network traffic on device wlan0 into a pcap file called dump.pcap
283 by using normal read(2), write(2) I/O for the pcap file (slower but less
284 latency). Also, after setting up the RX_RING for capture, drop privileges
285 from root to the user and group \[lq]bob\[rq]. Invoke the packet dissector and print
286 packet contents to the terminal for further analysis.
288 .SS  netsniff-ng --in any --filter http.bpf -B --ascii -V
289 Capture from all available networking interfaces and install a low-level
290 filter that was previously compiled by bpfc(8) into http.bpf in order to
291 filter HTTP traffic. Super jumbo frame support is automatically enabled and
292 only print human readable packet data to the terminal, and also be more
293 verbose during setup phase. Moreover, dump a BPF disassembly of http.bpf.
295 .SS  netsniff-ng --in dump.pcap --out dump.cfg --silent
296 Convert the pcap file dump.pcap into a trafgen(8) configuration file dump.cfg.
297 Do not print pcap contents to the terminal.
299 .SS netsniff-ng -i dump.pcap -f beacon.bpf -o -
300 Convert the pcap file dump.pcap into a trafgen(8) configuration file and write
301 it to stdout. However, do not dump all of its content, but only the one that
302 passes the low-level filter for raw 802.11 from beacon.bpf. The BPF engine
303 here is invoked in user space inside of netsniff-ng, so Linux extensions
304 are not available.
306 .SS cat foo.pcap | netsniff-ng -i - -o -
307 Read a pcap file from stdin and convert it into a trafgen(8) configuration
308 file to stdout.
310 .SS modprobe nlmon
311 .SS ip link add type nlmon
312 .SS ip link set nlmon0 up
313 .SS netsniff-ng -i nlmon0 -o dump.pcap -s
314 .SS ip link set nlmon0 down
315 .SS ip link del dev nlmon0
316 .SS rmmod nlmon
317 In this example, netlink traffic is being captured. If not already done, a
318 netlink monitoring device needs to be set up before it can be used to capture
319 netlink socket buffers (iproute2's ip(1) commands are given for nlmon device
320 setup and teardown). netsniff-ng can then make use of the nlmon device as
321 an input device. In this example a pcap file with netlink traffic is being
322 recorded.
324 .SH CONFIG FILES
326 Files under /etc/netsniff-ng/ can be modified to extend netsniff-ng's
327 functionality:
329     * oui.conf - OUI/MAC vendor database
330     * ether.conf - Ethernet type descriptions
331     * tcp.conf - TCP port/services map
332     * udp.conf - UDP port/services map
333     * geoip.conf - GeoIP database mirrors
335 .SH FILTER EXAMPLE
337 netsniff-ng supports both, low-level and high-level filters that are
338 attached to its packet(7) socket. Low-level filters are described in
339 the bpfc(8) man page.
341 Low-level filters can be used with netsniff-ng in the following way:
343     1. bpfc foo > bar
344     2. netsniff-ng \-f bar
346 Here, foo is the bpfc program that will be translated into a netsniff-ng
347 readable \[lq]opcodes\[rq] file and passed to netsniff-ng through the \-f
348 option.
350 Similarly, high-level filter can be either passed through the \-f option,
351 e.g. \-f "tcp or udp" or at the end of all options without the \[lq]\-f\[rq].
353 The filter syntax is the same as in tcpdump(8), which is described in
354 the man page pcap-filter(7). Just to quote some examples from pcap-filter(7):
356 .SS host sundown
357 To select all packets arriving at or departing from sundown.
359 .SS host helios and \(hot or ace\)
360 To select traffic between helios and either hot or ace.
362 .SS ip host ace and not helios
363 To select all IP packets between ace and any host except helios.
365 .SS net ucb-ether
366 To select all traffic between local hosts and hosts at Berkeley.
368 .SS gateway snup and (port ftp or ftp-data)
369 To select all FTP traffic through Internet gateway snup.
371 .SS ip and not net localnet
372 To select traffic neither sourced from, nor destined for, local hosts. If you
373 have a gateway to another network, this traffic should never make it onto
374 your local network.
376 .SS tcp[tcpflags] & (tcp-syn|tcp-fin) != 0 and not src and dst net localnet
377 To select the start and end packets (the SYN and FIN packets) of each TCP
378 conversation that involve a non-local host.
380 .SS tcp port 80 and (((ip[2:2] - ((ip[0]&0xf)<<2)) - ((tcp[12]&0xf0)>>2)) != 0)
381 To select all IPv4 HTTP packets to and from port 80, that is to say, print only packets
382 that contain data, not, for example, SYN and FIN packets and ACK-only packets.
383 (IPv6 is left as an exercise for the reader.)
385 .SS gateway snup and ip[2:2] > 576
386 To select IP packets longer than 576 bytes sent through gateway snup.
388 .SS ether[0] & 1 = 0 and ip[16] >= 224
389 To select IP broadcast or multicast packets that were not sent via Ethernet
390 broadcast or multicast.
392 .SS icmp[icmptype] != icmp-echo and icmp[icmptype] != icmp-echoreply
393 To select all ICMP packets that are not echo requests or replies
394 (that is to say, not "ping" packets).
396 .SH PCAP FORMATS:
398 netsniff-ng supports a couple of pcap formats, visible through ``netsniff-ng \-D'':
400 .SS tcpdump-capable pcap (default)
401 Pcap magic number is encoded as 0xa1b2c3d4 resp. 0xd4c3b2a1. As packet meta data
402 this format contains the timeval in microseconds, the original packet length and
403 the captured packet length.
405 .SS tcpdump-capable pcap with ns resolution
406 Pcap magic number is encoded as 0xa1b23c4d resp. 0x4d3cb2a1. As packet meta data
407 this format contains the timeval in nanoseconds, the original packet length and
408 the captured packet length.
410 .SS Alexey Kuznetzov's pcap
411 Pcap magic number is encoded as 0xa1b2cd34 resp. 0x34cdb2a1. As packet meta data
412 this format contains the timeval in microseconds, the original packet length,
413 the captured packet length, the interface index (sll_ifindex), the packet's
414 protocol (sll_protocol), and the packet type (sll_pkttype).
416 .SS netsniff-ng pcap
417 Pcap magic number is encoded as 0xa1e2cb12 resp. 0x12cbe2a1. As packet meta data
418 this format contains the timeval in nanoseconds, the original packet length,
419 the captured packet length, the timestamp hw/sw source, the interface index
420 (sll_ifindex), the packet's protocol (sll_protocol), the packet type (sll_pkttype)
421 and the hardware type (sll_hatype).
423 For further implementation details or format support in your application,
424 have a look at pcap_io.h.
426 .SH NOTE
427 To avoid confusion, it should be noted that there is another network
428 analyzer with a similar name, called NetSniff, that is unrelated to
429 the netsniff-ng project.
431 For introducing bit errors, delays with random variation and more
432 while replaying pcaps, make use of tc(8) with its disciplines such
433 as netem.
435 netsniff-ng does only some basic, architecture generic tuning on
436 startup. If you are considering to do high performance capturing,
437 you need to carefully tune your machine, both hardware and software.
438 Simply letting netsniff-ng run without thinking about your underlying
439 system might not necessarily give you the desired performance. Note
440 that tuning your system is always a tradeoff and fine-grained
441 balancing act (throughput versus latency). You should know what
442 you are doing!
444 One recommendation for software-based tuning is tuned(8). Besides
445 that, there are many other things to consider. Just to throw you
446 a few things that you might want to look at: NAPI networking drivers,
447 tickless kernel, I/OAT DMA engine, Direct Cache Access, RAM-based
448 file systems, multi-queues, and many more things. Also, you might
449 want to read the kernel's Documentation/networking/scaling.txt file
450 regarding technologies such as RSS, RPS, RFS, aRFS and XPS. Also
451 check your ethtool(8) settings, for example regarding offloading or
452 Ethernet pause frames.
454 Moreover, to get a deeper understanding of netsniff-ng internals
455 and how it interacts with the Linux kernel, the kernel documentation
456 under Documentation/networking/{packet_mmap.txt, filter.txt,
457 multiqueue.txt} might be of interest.
459 How do you sniff in a switched environment? I rudely refer to dSniff's
460 documentation that says:
462 The easiest route is simply to impersonate the local gateway, stealing
463 client traffic en route to some remote destination. Of course, the traffic
464 must be forwarded by your attacking machine, either by enabling kernel IP
465 forwarding or with a userland program that accomplishes the same
466 (fragrouter \-B1).
468 Several people have reportedly destroyed connectivity on their LAN to the
469 outside world by ARP spoofing the gateway, and forgetting to enable IP
470 forwarding on the attacking machine. Do not do this. You have been warned.
472 A safer option than ARP spoofing would be to use a "port mirror" function
473 if your switch hardware supports it and if you have access to the switch.
475 If you do not need to dump all possible traffic, you have to consider
476 running netsniff-ng with a BPF filter for the ingress path. For that
477 purpose, read the bpfc(8) man page.
479 Also, to aggregate multiple NICs that you want to capture on, you
480 should consider using team devices, further explained in libteam resp.
481 teamd(8).
483 The following netsniff-ng pcap magic numbers are compatible with other
484 tools, at least tcpdump or Wireshark:
486     0xa1b2c3d4 (tcpdump-capable pcap)
487     0xa1b23c4d (tcpdump-capable pcap with ns resolution)
488     0xa1b2cd34 (Alexey Kuznetzov's pcap)
490 Pcap files with different meta data endianness are supported by netsniff-ng
491 as well.
493 .SH BUGS
495 When replaying pcap files, the timing information from the pcap packet
496 header is currently ignored.
498 Also, when replaying pcap files, demultiplexing traffic among multiple
499 networking interfaces does not work. Currently, it is only sent via the
500 interface that is given by the \-\-out parameter.
502 When performing traffic capture on the Ethernet interface, the pcap file
503 is created and packets are received but without a 802.1Q header. When one
504 uses tshark, all headers are visible, but netsniff-ng removes 802.1Q
505 headers. Is that normal behavior?
507 Yes and no. The way VLAN headers are handled in PF_PACKET sockets by the
508 kernel is somewhat \[lq]problematic\[rq] [1]. The problem in the Linux kernel
509 is that some drivers already handle VLANs, others do not. Those who handle it
510 can have different implementations, such as hardware acceleration and so on.
511 So in some cases the VLAN tag is even stripped before entering the protocol
512 stack, in some cases probably not. The bottom line is that a "hack" was
513 introduced in PF_PACKET so that a VLAN ID is visible in some helper data
514 structure that is accessible from the RX_RING.
516 Then it gets really messy in the user space to artificially put the VLAN
517 header back into the right place. Not to mention the resulting performance
518 implications on all of libpcap(3) tools since parts of the packet need to
519 be copied for reassembly via memmove(3).
521 A user reported the following, just to demonstrate this mess: some tests were
522 made with two machines, and it seems that results depend on the driver ...
524     AR8131:
525       ethtool \-k eth0 gives "rx-vlan-offload: on"
526       - wireshark gets the vlan header
527       - netsniff-ng doesn't get the vlan header
528       ethtool \-K eth0 rxvlan off
529       - wireshark gets a QinQ header even though noone sent QinQ
530       - netsniff-ng gets the vlan header
532     RTL8111/8168B:
533       ethtool \-k eth0 gives "rx-vlan-offload: on"
534       - wireshark gets the vlan header
535       - netsniff-ng doesn't get the vlan header
536       ethtool \-K eth0 rxvlan off
537       - wireshark gets the vlan header
538       - netsniff-ng doesn't get the vlan header
540 Even if we agreed on doing the same workaround as libpcap, we still will
541 not be able to see QinQ, for instance, due to the fact that only one VLAN tag
542 is stored in the kernel helper data structure. We think that there should be
543 a good consensus on the kernel space side about what gets transferred to
544 userland first.
546 Update (28.11.2012): the Linux kernel and also bpfc(8) has built-in support
547 for hardware accelerated VLAN filtering, even though tags might not be visible
548 in the payload itself as reported here. However, the filtering for VLANs works
549 reliable if your NIC supports it. See bpfc(8) for an example.
551    [1] http://lkml.indiana.edu/hypermail/linux/kernel/0710.3/3816.html
553 .SH LEGAL
554 netsniff-ng is licensed under the GNU GPL version 2.0.
556 .SH HISTORY
557 .B netsniff-ng
558 was originally written for the netsniff-ng toolkit by Daniel Borkmann. Bigger
559 contributions were made by Emmanuel Roullit, Markus Amend, Tobias Klauser and
560 Christoph Jaeger. It is currently maintained by Tobias Klauser
561 <tklauser@distanz.ch> and Daniel Borkmann <dborkma@tik.ee.ethz.ch>.
563 .SH SEE ALSO
564 .BR trafgen (8),
565 .BR mausezahn (8),
566 .BR ifpps (8),
567 .BR bpfc (8),
568 .BR flowtop (8),
569 .BR astraceroute (8),
570 .BR curvetun (8)
572 .SH AUTHOR
573 Manpage was written by Daniel Borkmann.
575 .SH COLOPHON
576 This page is part of the Linux netsniff-ng toolkit project. A description of the project,
577 and information about reporting bugs, can be found at http://netsniff-ng.org/.