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