build: Explicitly mention last release in announcement message
[netsniff-ng.git] / netsniff-ng.8
blob31c4907229a4031b3d3009547dda4578bd072b06
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). Optionally,
81 sending the SIGHUP signal to the netsniff-ng process causes a premature rotation
82 of the file. A trafgen configuration file can currently only be specified if the
83 input device is a pcap file. To specify a  pcap file as the output device, the
84 file name must have \[lq].pcap\[rq] as its extension. If stdout is given as a
85 device, then a trafgen configuration will be written to stdout if the input
86 device is a pcap file, or a pcap file if the input device is a networking
87 device.
88 .PP
89 .SS -C <id>, --fanout-group <id>
90 If multiple netsniff-ng instances are being started that all have the same packet
91 fanout group id, then the ingress network traffic being captured is being
92 distributed/load-balanced among these group participants. This gives a much better
93 scaling than running multiple netsniff-ng processes without a fanout group parameter
94 in parallel, but only with a BPF filter attached as a packet would otherwise need
95 to be delivered to all such capturing processes, instead of only once to such a
96 fanout member. Naturally, each fanout member can have its own BPF filters attached.
97 .PP
98 .SS -K <hash|lb|cpu|rnd|roll|qm>, --fanout-type <hash|lb|cpu|rnd|roll|qm>
99 This parameter specifies the fanout discipline, in other words, how the captured
100 network traffic is dispatched to the fanout group members. Options are to distribute
101 traffic by the packet hash (\[lq]hash\[rq]), in a round-robin manner (\[lq]lb\[rq]),
102 by CPU the packet arrived on (\[lq]cpu\[rq]), by random (\[lq]rnd\[rq]), by rolling
103 over sockets (\[lq]roll\[rq]) which means if one socket's queue is full, we move on
104 to the next one, or by NIC hardware queue mapping (\[lq]qm\[rq]).
106 .SS -L <defrag|roll>, --fanout-opts <defrag|roll>
107 Defines some auxillary fanout options to be used in addition to a given fanout type.
108 These options apply to any fanout type. In case of \[lq]defrag\[rq], the kernel is
109 being told to defragment packets before delivering to user space, and \[lq]roll\[rq]
110 provides the same roll-over option as the \[lq]roll\[rq] fanout type, so that on any
111 different fanout type being used (e.g. \[lq]qm\[rq]) the socket may temporarily roll
112 over to the next fanout group member in case the original one's queue is full.
114 .SS -f, --filter <bpf-file|expr>
115 Specifies to not dump all traffic, but to filter the network packet haystack.
116 As a filter, either a bpfc(8) compiled file can be passed as a parameter or
117 a tcpdump(1)-like filter expression in quotes. For details regarding the
118 bpf-file have a look at bpfc(8), for details regarding a tcpdump(1)-like filter
119 have a look at section \[lq]filter example\[rq] or at pcap-filter(7). A filter
120 expression may also be passed to netsniff-ng without option \[lq]\-f\[rq] in case
121 there is no subsequent option following after the command-line filter expression.
123 .SS -t, --type <type>
124 This defines some sort of filtering mechanisms in terms of addressing. Possible
125 values for type are \[lq]host\[rq] (to us), \[lq]broadcast\[rq] (to all), \[lq]multicast\[rq] (to
126 group), \[lq]others\[rq] (promiscuous mode) or \[lq]outgoing\[rq] (from us).
128 .SS -F, --interval <size|time>
129 If the output device is a folder, with \[lq]\-F\[rq], it is possible to define the pcap
130 file rotation interval either in terms of size or time. Thus, when the interval
131 limit has been reached, a new pcap file will be started. As size parameter, the
132 following values are accepted \[lq]<num>KiB/MiB/GiB\[rq]; As time parameter,
133 it can be \[lq]<num>s/sec/min/hrs\[rq].
135 .SS -J, --jumbo-support
136 By default, in pcap replay or redirect mode, netsniff-ng's ring buffer frames
137 are a fixed size of 2048 bytes. This means that if you are expecting jumbo
138 frames or even super jumbo frames to pass through your network, then you need
139 to enable support for that by using this option. However, this has the
140 disadvantage of performance degradation and a bigger memory footprint for the
141 ring buffer. Note that this doesn't affect (pcap) capturing mode, since tpacket
142 in version 3 is used!
144 .SS -R, --rfraw
145 In case the input or output networking device is a wireless device, it is
146 possible with netsniff-ng to turn this into monitor mode and create a mon<X>
147 device that netsniff-ng will be listening on instead of wlan<X>, for instance.
148 This enables netsniff-ng to analyze, dump, or even replay raw 802.11 frames.
150 .SS -n <0|uint>, --num <0|uint>
151 Process a number of packets and then exit. If the number of packets is 0, then
152 this is equivalent to infinite packets resp. processing until interrupted.
153 Otherwise, a number given as an unsigned integer will limit processing.
155 .SS -P <name>, --prefix <name>
156 When dumping pcap files into a folder, a file name prefix can be defined with
157 this option. If not otherwise specified, the default prefix is \[lq]dump\-\[rq]
158 followed by a Unix timestamp. Use \[lq]\-\-prefex ""\[rq] to set filename as
159 seconds since the Unix Epoch e.g. 1369179203.pcap
161 .SS -T <pcap-magic>, --magic <pcap-magic>
162 Specify a pcap type for storage. Different pcap types with their various meta
163 data capabilities are shown with option \[lq]\-D\[rq]. If not otherwise
164 specified, the pcap-magic 0xa1b2c3d4, also known as a standard tcpdump-capable
165 pcap format, is used. Pcap files with swapped endianness are also supported.
167 .SS -D, --dump-pcap-types
168 Dump all available pcap types with their capabilities and magic numbers that
169 can be used with option \[lq]\-T\[rq] to stdout and exit.
171 .SS -B, --dump-bpf
172 If a Berkeley Packet Filter is given, for example via option \[lq]\-f\[rq], then
173 dump the BPF disassembly to stdout during ring setup. This only serves for informative
174 or verification purposes.
176 .SS -r, --rand
177 If the input and output device are both networking devices, then this option will
178 randomize packet order in the output ring buffer.
180 .SS -M, --no-promisc
181 The networking interface will not be put into promiscuous mode. By default,
182 promiscuous mode is turned on.
184 .SS -N, --no-hwtimestamp
185 Disable taking hardware time stamps for RX packets. By default, if the network
186 device supports hardware time stamping, the hardware time stamps will be used
187 when writing packets to pcap files. This option disables this behavior and
188 forces (kernel based) software time stamps to be used, even if hardware time
189 stamps are available.
191 .SS -A, --no-sock-mem
192 On startup and shutdown, netsniff-ng tries to increase socket read and
193 write buffers if appropriate. This option will prevent netsniff-ng from doing
196 .SS -m, --mmap
197 Use mmap(2) as pcap file I/O. This is the default when replaying pcap files.
199 .SS -G, --sg
200 Use scatter-gather as pcap file I/O. This is the default when capturing
201 pcap files.
203 .SS -c, --clrw
204 Use slower read(2) and write(2) I/O. This is not the default case anywhere, but in
205 some situations it could be preferred as it has a lower latency on write-back
206 to disc.
208 .SS -S <size>, --ring-size <size>
209 Manually define the RX_RING resp. TX_RING size in \[lq]<num>KiB/MiB/GiB\[rq]. By
210 default, the size is determined based on the network connectivity rate.
212 .SS -k <uint>, --kernel-pull <uint>
213 Manually define the interval in micro-seconds where the kernel should be triggered
214 to batch process the ring buffer frames. By default, it is every 10us, but it can
215 manually be prolonged, for instance.
217 .SS -b <cpu>, --bind-cpu <cpu>
218 Pin netsniff-ng to a specific CPU and also pin resp. migrate the NIC's IRQ
219 CPU affinity to this CPU. This option should be preferred in combination with
220 \[lq]\-s\[rq] in case a middle to high packet rate is expected.
222 .SS -u <uid>, --user <uid> resp. -g <gid>, --group <gid>
223 After ring setup drop privileges to a non-root user/group combination.
225 .SS -H, --prio-high
226 Set this process as a high priority process in order to achieve a higher
227 scheduling rate resp. CPU time. This is however not the default setting, since
228 it could lead to starvation of other processes, for example low priority kernel
229 threads.
231 .SS -Q, --notouch-irq
232 Do not reassign the NIC's IRQ CPU affinity settings.
234 .SS -s, --silent
235 Do not enter the packet dissector at all and do not print any packet information
236 to the terminal. Just shut up and be silent. This option should be preferred in
237 combination with pcap recording or replay, since it will not flood your terminal
238 which causes a significant performance degradation.
240 .SS -q, --less
241 Print a less verbose one-line information for each packet to the terminal.
243 .SS -X, --hex
244 Only dump packets in hex format to the terminal.
246 .SS -l, --ascii
247 Only display ASCII printable characters.
249 .SS -U, --update
250 If geographical IP location is used, the built-in database update
251 mechanism will be invoked to get Maxmind's latest database. To configure
252 search locations for databases, the file /etc/netsniff-ng/geoip.conf contains
253 possible addresses. Thus, to save bandwidth or for mirroring of Maxmind's
254 databases (to bypass their traffic limit policy), different hosts or IP
255 addresses can be placed into geoip.conf, separated by a newline.
257 .SS -V, --verbose
258 Be more verbose during startup i.e. show detailed ring setup information.
260 .SS -v, --version
261 Show version information and exit.
263 .SS -h, --help
264 Show user help and exit.
266 .SH USAGE EXAMPLE
268 .SS netsniff-ng
269 The most simple command is to just run \[lq]netsniff-ng\[rq]. This will start
270 listening on all available networking devices in promiscuous mode and dump
271 the packet dissector output to the terminal. No files will be recorded.
273 .SS  netsniff-ng --in eth0 --out dump.pcap -s -T 0xa1e2cb12 -b 0 tcp or udp
274 Capture TCP or UDP traffic from the networking device eth0 into the pcap file
275 named dump.pcap, which has netsniff-ng specific pcap extensions (see
276 \[lq]netsniff-ng \-D\[rq] for capabilities). Also, do not print the content to
277 the terminal and pin the process and NIC IRQ affinity to CPU 0. The pcap write
278 method is scatter-gather I/O.
280 .SS  netsniff-ng --in wlan0 --rfraw --out dump.pcap --silent --bind-cpu 0
281 Put the wlan0 device into monitoring mode and capture all raw 802.11 frames
282 into the file dump.pcap. Do not dissect and print the content to the terminal
283 and pin the process and NIC IRQ affinity to CPU 0. The pcap write method is
284 scatter-gather I/O.
286 .SS  netsniff-ng --in dump.pcap --mmap --out eth0 -k1000 --silent --bind-cpu 0
287 Replay the pcap file dump.pcap which is read through mmap(2) I/O and send
288 the packets out via the eth0 networking device. Do not dissect and print the
289 content to the terminal and pin the process and NIC IRQ affinity to CPU 0.
290 Also, trigger the kernel every 1000us to traverse the TX_RING instead of every
291 10us. Note that the pcap magic type is detected automatically from the pcap
292 file header.
294 .SS  netsniff-ng --in eth0 --out eth1 --silent --bind-cpu 0 --type host -r
295 Redirect network traffic from the networking device eth0 to eth1 for traffic
296 that is destined for our host, thus ignore broadcast, multicast and promiscuous
297 traffic. Randomize the order of packets for the outgoing device and do not
298 print any packet contents to the terminal. Also, pin the process and NIC IRQ
299 affinity to CPU 0.
301 .SS  netsniff-ng --in team0 --out /opt/probe/ -s -m --interval 100MiB -b 0
302 Capture on an aggregated team0 networking device and dump packets into multiple
303 pcap files that are split into 100MiB each. Use mmap(2) I/O as a pcap write
304 method, support for super jumbo frames is built-in (does not need to be
305 configured here), and do not print the captured data to the terminal. Pin
306 netsniff-ng and NIC IRQ affinity to CPU 0. The default pcap magic type is
307 0xa1b2c3d4 (tcpdump-capable pcap).
309 .SS  netsniff-ng --in vlan0 --out dump.pcap -c -u `id -u bob` -g `id -g bob`
310 Capture network traffic on device wlan0 into a pcap file called dump.pcap
311 by using normal read(2), write(2) I/O for the pcap file (slower but less
312 latency). Also, after setting up the RX_RING for capture, drop privileges
313 from root to the user and group \[lq]bob\[rq]. Invoke the packet dissector and print
314 packet contents to the terminal for further analysis.
316 .SS  netsniff-ng --in any --filter http.bpf -B --ascii -V
317 Capture from all available networking interfaces and install a low-level
318 filter that was previously compiled by bpfc(8) into http.bpf in order to
319 filter HTTP traffic. Super jumbo frame support is automatically enabled and
320 only print human readable packet data to the terminal, and also be more
321 verbose during setup phase. Moreover, dump a BPF disassembly of http.bpf.
323 .SS  netsniff-ng --in dump.pcap --out dump.cfg --silent
324 Convert the pcap file dump.pcap into a trafgen(8) configuration file dump.cfg.
325 Do not print pcap contents to the terminal.
327 .SS netsniff-ng -i dump.pcap -f beacon.bpf -o -
328 Convert the pcap file dump.pcap into a trafgen(8) configuration file and write
329 it to stdout. However, do not dump all of its content, but only the one that
330 passes the low-level filter for raw 802.11 from beacon.bpf. The BPF engine
331 here is invoked in user space inside of netsniff-ng, so Linux extensions
332 are not available.
334 .SS cat foo.pcap | netsniff-ng -i - -o -
335 Read a pcap file from stdin and convert it into a trafgen(8) configuration
336 file to stdout.
338 .SS modprobe nlmon
339 .SS ip link add type nlmon
340 .SS ip link set nlmon0 up
341 .SS netsniff-ng -i nlmon0 -o dump.pcap -s
342 .SS ip link set nlmon0 down
343 .SS ip link del dev nlmon0
344 .SS rmmod nlmon
345 In this example, netlink traffic is being captured. If not already done, a
346 netlink monitoring device needs to be set up before it can be used to capture
347 netlink socket buffers (iproute2's ip(1) commands are given for nlmon device
348 setup and teardown). netsniff-ng can then make use of the nlmon device as
349 an input device. In this example a pcap file with netlink traffic is being
350 recorded.
352 .SH CONFIG FILES
354 Files under /etc/netsniff-ng/ can be modified to extend netsniff-ng's
355 functionality:
357     * oui.conf - OUI/MAC vendor database
358     * ether.conf - Ethernet type descriptions
359     * tcp.conf - TCP port/services map
360     * udp.conf - UDP port/services map
361     * geoip.conf - GeoIP database mirrors
363 .SH FILTER EXAMPLE
365 netsniff-ng supports both, low-level and high-level filters that are
366 attached to its packet(7) socket. Low-level filters are described in
367 the bpfc(8) man page.
369 Low-level filters can be used with netsniff-ng in the following way:
371     1. bpfc foo > bar
372     2. netsniff-ng \-f bar
374 Here, foo is the bpfc program that will be translated into a netsniff-ng
375 readable \[lq]opcodes\[rq] file and passed to netsniff-ng through the \-f
376 option.
378 Similarly, high-level filter can be either passed through the \-f option,
379 e.g. \-f "tcp or udp" or at the end of all options without the \[lq]\-f\[rq].
381 The filter syntax is the same as in tcpdump(8), which is described in
382 the man page pcap-filter(7). Just to quote some examples from pcap-filter(7):
384 .SS host sundown
385 To select all packets arriving at or departing from sundown.
387 .SS host helios and \(hot or ace\)
388 To select traffic between helios and either hot or ace.
390 .SS ip host ace and not helios
391 To select all IP packets between ace and any host except helios.
393 .SS net ucb-ether
394 To select all traffic between local hosts and hosts at Berkeley.
396 .SS gateway snup and (port ftp or ftp-data)
397 To select all FTP traffic through Internet gateway snup.
399 .SS ip and not net localnet
400 To select traffic neither sourced from, nor destined for, local hosts. If you
401 have a gateway to another network, this traffic should never make it onto
402 your local network.
404 .SS tcp[tcpflags] & (tcp-syn|tcp-fin) != 0 and not src and dst net localnet
405 To select the start and end packets (the SYN and FIN packets) of each TCP
406 conversation that involve a non-local host.
408 .SS tcp port 80 and (((ip[2:2] - ((ip[0]&0xf)<<2)) - ((tcp[12]&0xf0)>>2)) != 0)
409 To select all IPv4 HTTP packets to and from port 80, that is to say, print only packets
410 that contain data, not, for example, SYN and FIN packets and ACK-only packets.
411 (IPv6 is left as an exercise for the reader.)
413 .SS gateway snup and ip[2:2] > 576
414 To select IP packets longer than 576 bytes sent through gateway snup.
416 .SS ether[0] & 1 = 0 and ip[16] >= 224
417 To select IP broadcast or multicast packets that were not sent via Ethernet
418 broadcast or multicast.
420 .SS icmp[icmptype] != icmp-echo and icmp[icmptype] != icmp-echoreply
421 To select all ICMP packets that are not echo requests or replies
422 (that is to say, not "ping" packets).
424 .SH PCAP FORMATS:
426 netsniff-ng supports a couple of pcap formats, visible through ``netsniff-ng \-D'':
428 .SS tcpdump-capable pcap (default)
429 Pcap magic number is encoded as 0xa1b2c3d4 resp. 0xd4c3b2a1. As packet meta data
430 this format contains the timeval in microseconds, the original packet length and
431 the captured packet length.
433 .SS tcpdump-capable pcap with ns resolution
434 Pcap magic number is encoded as 0xa1b23c4d resp. 0x4d3cb2a1. As packet meta data
435 this format contains the timeval in nanoseconds, the original packet length and
436 the captured packet length.
438 .SS Alexey Kuznetzov's pcap
439 Pcap magic number is encoded as 0xa1b2cd34 resp. 0x34cdb2a1. As packet meta data
440 this format contains the timeval in microseconds, the original packet length,
441 the captured packet length, the interface index (sll_ifindex), the packet's
442 protocol (sll_protocol), and the packet type (sll_pkttype).
444 .SS netsniff-ng pcap
445 Pcap magic number is encoded as 0xa1e2cb12 resp. 0x12cbe2a1. As packet meta data
446 this format contains the timeval in nanoseconds, the original packet length,
447 the captured packet length, the timestamp hw/sw source, the interface index
448 (sll_ifindex), the packet's protocol (sll_protocol), the packet type (sll_pkttype)
449 and the hardware type (sll_hatype).
451 For further implementation details or format support in your application,
452 have a look at pcap_io.h.
454 .SH NOTE
455 To avoid confusion, it should be noted that there is another network
456 analyzer with a similar name, called NetSniff, that is unrelated to
457 the netsniff-ng project.
459 For introducing bit errors, delays with random variation and more
460 while replaying pcaps, make use of tc(8) with its disciplines such
461 as netem.
463 netsniff-ng does only some basic, architecture generic tuning on
464 startup. If you are considering to do high performance capturing,
465 you need to carefully tune your machine, both hardware and software.
466 Simply letting netsniff-ng run without thinking about your underlying
467 system might not necessarily give you the desired performance. Note
468 that tuning your system is always a tradeoff and fine-grained
469 balancing act (throughput versus latency). You should know what
470 you are doing!
472 One recommendation for software-based tuning is tuned(8). Besides
473 that, there are many other things to consider. Just to throw you
474 a few things that you might want to look at: NAPI networking drivers,
475 tickless kernel, I/OAT DMA engine, Direct Cache Access, RAM-based
476 file systems, multi-queues, and many more things. Also, you might
477 want to read the kernel's Documentation/networking/scaling.txt file
478 regarding technologies such as RSS, RPS, RFS, aRFS and XPS. Also
479 check your ethtool(8) settings, for example regarding offloading or
480 Ethernet pause frames.
482 Moreover, to get a deeper understanding of netsniff-ng internals
483 and how it interacts with the Linux kernel, the kernel documentation
484 under Documentation/networking/{packet_mmap.txt, filter.txt,
485 multiqueue.txt} might be of interest.
487 How do you sniff in a switched environment? I rudely refer to dSniff's
488 documentation that says:
490 The easiest route is simply to impersonate the local gateway, stealing
491 client traffic en route to some remote destination. Of course, the traffic
492 must be forwarded by your attacking machine, either by enabling kernel IP
493 forwarding or with a userland program that accomplishes the same
494 (fragrouter \-B1).
496 Several people have reportedly destroyed connectivity on their LAN to the
497 outside world by ARP spoofing the gateway, and forgetting to enable IP
498 forwarding on the attacking machine. Do not do this. You have been warned.
500 A safer option than ARP spoofing would be to use a "port mirror" function
501 if your switch hardware supports it and if you have access to the switch.
503 If you do not need to dump all possible traffic, you have to consider
504 running netsniff-ng with a BPF filter for the ingress path. For that
505 purpose, read the bpfc(8) man page.
507 Also, to aggregate multiple NICs that you want to capture on, you
508 should consider using team devices, further explained in libteam resp.
509 teamd(8).
511 The following netsniff-ng pcap magic numbers are compatible with other
512 tools, at least tcpdump or Wireshark:
514     0xa1b2c3d4 (tcpdump-capable pcap)
515     0xa1b23c4d (tcpdump-capable pcap with ns resolution)
516     0xa1b2cd34 (Alexey Kuznetzov's pcap)
518 Pcap files with different meta data endianness are supported by netsniff-ng
519 as well.
521 .SH BUGS
523 When replaying pcap files, the timing information from the pcap packet
524 header is currently ignored.
526 Also, when replaying pcap files, demultiplexing traffic among multiple
527 networking interfaces does not work. Currently, it is only sent via the
528 interface that is given by the \-\-out parameter.
530 When performing traffic capture on the Ethernet interface, the pcap file
531 is created and packets are received but without a 802.1Q header. When one
532 uses tshark, all headers are visible, but netsniff-ng removes 802.1Q
533 headers. Is that normal behavior?
535 Yes and no. The way VLAN headers are handled in PF_PACKET sockets by the
536 kernel is somewhat \[lq]problematic\[rq] [1]. The problem in the Linux kernel
537 is that some drivers already handle VLANs, others do not. Those who handle it
538 can have different implementations, such as hardware acceleration and so on.
539 So in some cases the VLAN tag is even stripped before entering the protocol
540 stack, in some cases probably not. The bottom line is that a "hack" was
541 introduced in PF_PACKET so that a VLAN ID is visible in some helper data
542 structure that is accessible from the RX_RING.
544 Then it gets really messy in the user space to artificially put the VLAN
545 header back into the right place. Not to mention the resulting performance
546 implications on all of libpcap(3) tools since parts of the packet need to
547 be copied for reassembly via memmove(3).
549 A user reported the following, just to demonstrate this mess: some tests were
550 made with two machines, and it seems that results depend on the driver ...
552     AR8131:
553       ethtool \-k eth0 gives "rx-vlan-offload: on"
554       - wireshark gets the vlan header
555       - netsniff-ng doesn't get the vlan header
556       ethtool \-K eth0 rxvlan off
557       - wireshark gets a QinQ header even though noone sent QinQ
558       - netsniff-ng gets the vlan header
560     RTL8111/8168B:
561       ethtool \-k eth0 gives "rx-vlan-offload: on"
562       - wireshark gets the vlan header
563       - netsniff-ng doesn't get the vlan header
564       ethtool \-K eth0 rxvlan off
565       - wireshark gets the vlan header
566       - netsniff-ng doesn't get the vlan header
568 Even if we agreed on doing the same workaround as libpcap, we still will
569 not be able to see QinQ, for instance, due to the fact that only one VLAN tag
570 is stored in the kernel helper data structure. We think that there should be
571 a good consensus on the kernel space side about what gets transferred to
572 userland first.
574 Update (28.11.2012): the Linux kernel and also bpfc(8) has built-in support
575 for hardware accelerated VLAN filtering, even though tags might not be visible
576 in the payload itself as reported here. However, the filtering for VLANs works
577 reliable if your NIC supports it. See bpfc(8) for an example.
579    [1] http://lkml.indiana.edu/hypermail/linux/kernel/0710.3/3816.html
581 .SH LEGAL
582 netsniff-ng is licensed under the GNU GPL version 2.0.
584 .SH HISTORY
585 .B netsniff-ng
586 was originally written for the netsniff-ng toolkit by Daniel Borkmann. Bigger
587 contributions were made by Emmanuel Roullit, Markus Amend, Tobias Klauser and
588 Christoph Jaeger. It is currently maintained by Tobias Klauser
589 <tklauser@distanz.ch> and Daniel Borkmann <dborkma@tik.ee.ethz.ch>.
591 .SH SEE ALSO
592 .BR trafgen (8),
593 .BR mausezahn (8),
594 .BR ifpps (8),
595 .BR bpfc (8),
596 .BR flowtop (8),
597 .BR astraceroute (8),
598 .BR curvetun (8)
600 .SH AUTHOR
601 Manpage was written by Daniel Borkmann.
603 .SH COLOPHON
604 This page is part of the Linux netsniff-ng toolkit project. A description of the project,
605 and information about reporting bugs, can be found at http://netsniff-ng.org/.