This repository has been archived by the owner on Jan 30, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathntop.html
1513 lines (1211 loc) · 57.7 KB
/
ntop.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!-- Creator : groff version 1.19.2 -->
<!-- CreationDate: Tue Jun 5 11:22:21 2012 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; }
pre { margin-top: 0; margin-bottom: 0; }
table { margin-top: 0; margin-bottom: 0; }
</style>
<title>NTOP</title>
<!-- Added by insertssi -->
<link rel=stylesheet href="/style.css" type="text/css">
<!--#include virtual="/menuHead.html" -->
</head>
<body>
<!--#include virtual="/menuBody.html" -->
<h1 align=center>NTOP</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#COMMAND−LINE OPTIONS">COMMAND−LINE OPTIONS</a><br>
<a href="#WEB VIEWS">WEB VIEWS</a><br>
<a href="#NOTES">NOTES</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#PRIVACY NOTICE">PRIVACY NOTICE</a><br>
<a href="#USER SUPPORT">USER SUPPORT</a><br>
<a href="#AUTHOR">AUTHOR</a><br>
<a href="#LICENCE">LICENCE</a><br>
<a href="#ACKNOWLEDGMENTS">ACKNOWLEDGMENTS</a><br>
<hr>
<a name="NAME"></a>
<h2>NAME</h2>
<p style="margin-left:11%; margin-top: 1em">ntop −
display top network users</p>
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<p style="margin-left:11%; margin-top: 1em"><b>ntop</b>
[<b>@filename</b>] [<b>-a</b>|<b>--access-log-file</b>
<i><path></i>] [<b>-b</b>|<b>--disable-decoders</b>]
[<b>-c</b>|<b>--sticky-hosts</b>]
[<b>-e</b>|<b>--max-table-rows</b>]
[<b>-f</b>|<b>--traffic-dump-file</b> <i>file></i>]
[<b>-g</b>|<b>--track-local-hosts</b>]
[<b>-h</b>|<b>--help</b>] [<b>-l</b>|<b>--pcap-log</b>
<i><path></i>] [<b>-m</b>|<b>--local-subnets</b>
<i><addresses></i>]
[<b>-n</b>|<b>--numeric-ip-addresses</b>]
[<b>-p</b>|<b>--protocols</b> <i><list></i>]
[<b>-q</b>|<b>--create-suspicious-packets</b>]
[<b>-r</b>|<b>--refresh-time</b> <i><number></i>]
[<b>-s</b>|<b>--no-promiscuous</b>]
[<b>-t</b>|<b>--trace-level</b> <i><number></i>]
[<b>-x</b> <i><max_num_hash_entries></i>]
[<b>-w</b>|<b>--http-server</b> <i><port></i>]
[<b>-z</b>|<b>--disable-sessions</b>]
[<b>-A</b>|<b>--set-admin-password</b> <i>password</i>]
[<b>-B</b>|<b>--filter-expression</b> <i>expression</i>]
[<b>-C</b> <i><config</i>mode><i>]</i>
[<b>-D</b>|<b>--domain</b> <i><name></i>]
[<b>-F</b>|<b>--flow-spec</b> <i><specs></i>]
[<b>-M</b>|<b>--no-interface-merge</b>]
[<b>-N</b>|<b>--wwn-map</b> <i><path></i>]
[<b>-O</b>|<b>----output-packet-path</b>
<i><path></i>] [<b>-P</b>|<b>--db-file-path</b>
<i><path></i>] [<b>-Q</b>|<b>--spool-file-path</b>
<i><path></i>] [<b>-U</b>|<b>--mapper</b>
<i><URL></i>] [<b>-V</b>|<b>--version]</b> [<b>-X</b>
<i><max_num_TCP_sessions></i>]
[<b>--disable-instantsessionpurge</b>]
[<b>--disable-mutexextrainfo</b>] [<b>--disable-ndpi</b>]
[<b>--disable-python</b>] [<b>--instance</b>]
[<b>--p3p-cp</b>] [<b>--p3p-uri</b>]
[<b>--skip-version-check</b>] [<b>--w3c</b>]
[<b>-4</b>|<b>--ipv4]</b> [<b>-6</b>|<b>--ipv6]</b></p>
<p style="margin-left:11%; margin-top: 1em">Unix
options:</p>
<p style="margin-left:11%; margin-top: 1em">[<b>-d</b>|<b>--daemon</b>]
[<b>-i</b>|<b>--interface</b> <i><name></i>]
[<b>-u</b>|<b>--user</b> <i><user></i>]
[<b>-K</b>|<b>--enable-debug</b>] [<b>-L</b>]
[<b>--pcap_setnonblock</b>] [<b>--use-syslog=</b>
<i><facility></i>] [<b>--webserver-queue</b>
<i><number></i>]</p>
<p style="margin-left:11%; margin-top: 1em">Windows
option:</p>
<p style="margin-left:11%; margin-top: 1em">[<b>-i</b>|<b>--interface</b>
<i><number|name></i>]</p>
<p style="margin-left:11%; margin-top: 1em">OpenSSL
options:</p>
<p style="margin-left:11%; margin-top: 1em">[<b>-W</b>|<b>--https-server</b>
<i><port></i>] [<b>--ssl-watchdog</b>]</p>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<p style="margin-left:11%; margin-top: 1em"><b>ntop</b>
shows the current network usage. It displays a list of hosts
that are currently using the network and reports information
concerning the (IP and non-IP) traffic generated and
received by each host. <b>ntop</b> may operate as a
front-end collector (sFlow and/or netFlow plugins) or as a
stand-alone collector/display program. A web browser is
needed to access the information captured by the <b>ntop</b>
program.</p>
<p style="margin-left:11%; margin-top: 1em"><b>ntop</b> is
a hybrid layer 2 / layer 3 network monitor, that is by
default it uses the layer 2 Media Access Control (MAC)
addresses AND the layer 3 tcp/ip addresses. <b>ntop</b> is
capable of associating the two, so that ip and non-ip
traffic (e.g. arp, rarp) are combined for a complete picture
of network activity.</p>
<a name="COMMAND−LINE OPTIONS"></a>
<h2>COMMAND−LINE OPTIONS</h2>
<p style="margin-left:11%; margin-top: 1em"><b>@filename</b></p>
<p style="margin-left:12%;">The text of <b>filename</b> is
copied - ignoring line breaks and comment lines (anything
following a #) - into the command line. <b>ntop</b> behaves
as if all of the text had simply been typed directly on the
command line. For example, if the command line is "-t 3
@d -u ntop" and file d contains just the line
’-d’, then the effective command line is -t 3 -d
-u ntop. Multiple @s are permitted. Nested @s (an @ inside
the file) are not permitted.</p>
<p style="margin-left:12%; margin-top: 1em">Remember, most
<b>ntop</b> options are "sticky", that is they
just set an internal flag. Invoking them multiple times
doesn’t change <b>ntop’s</b> behavior. However,
options that set a value, such as --trace-level, will use
the LAST value given: --trace-level 2 --trace-level 3 will
run as --trace-level 3.</p>
<p style="margin-left:12%; margin-top: 1em">Beginning with
3.1, many command-line options may also be set via the web
browser interface. These changes take effect on the next run
of and on each subsequent run until changed.</p>
<p style="margin-left:11%;"><b>-a |
--access-log-file</b></p>
<p style="margin-left:12%;">By default <b>ntop</b> does not
maintain a log of HTTP requests to the internal web server.
Use this parameter to request logging and to specify the
location of the file where these HTTP requests are
logged.</p>
<p style="margin-left:12%; margin-top: 1em">Each log entry
is in Apache-like style. The only difference between Apache
and <b>ntop</b> logs is that an additional column has been
added which has the time (in milliseconds) that <b>ntop</b>
needed to serve the request. Log entries look like this:</p>
<p style="margin-left:12%; margin-top: 1em">192.168.1.1 - -
[04/Sep/2003:20:38:55 -0500] - "GET / HTTP/1.1"
200 1489 4 <br>
192.168.1.1 - - [04/Sep/2003:20:38:55 -0500] - "GET
/index_top.html HTTP/1.1" 200 1854 4 <br>
192.168.1.1 - - [04/Sep/2003:20:38:55 -0500] - "GET
/index_inner.html HTTP/1.1" 200 1441 7 <br>
192.168.1.1 - - [04/Sep/2003:20:38:56 -0500] - "GET
/index_left.html HTTP/1.1" 200 1356 4 <br>
192.168.1.1 - - [04/Sep/2003:20:38:56 -0500] - "GET
/home_.html HTTP/1.1" 200 154/617 9 <br>
192.168.1.1 - - [04/Sep/2003:20:38:56 -0500] - "GET
/home.html HTTP/1.1" 200 1100/3195 10 <br>
192.168.1.1 - - [04/Sep/2003:20:38:56 -0500] - "GET
/About.html HTTP/1.1" 200 2010 10</p>
<p style="margin-left:12%; margin-top: 1em">This parameter
is the complete file name of the access log. In prior
releases it was erroneously called --access-log-path.</p>
<p style="margin-left:11%;"><b>-b |
--disable-decoders</b></p>
<p style="margin-left:12%;">This parameter disables
protocol decoders.</p>
<p style="margin-left:12%; margin-top: 1em">Protocol
decoders examine and collect information about layer 2
protocols such as NetBIOS or Netware SAP, as well as about
specific tcp/ip (layer 3) protocols, such as DNS, http and
ftp.</p>
<p style="margin-left:12%; margin-top: 1em">This support is
specifically coded for each protocol and is different from
the capability to count raw information (packets and bytes)
by protocol specified by the -p | --protocols parameter,
below.</p>
<p style="margin-left:12%; margin-top: 1em">Decoding
protocols is a significant consumer of resources. If the
<b>ntop</b> host is underpowered or monitoring a very busy
network, you may wish to disable protocol decoding via this
parameter. It may also be appropriate to use this parameter
if you believe that <b>ntop</b> has problems handling some
protocols that occur on your network.</p>
<p style="margin-left:12%; margin-top: 1em">Even if
decoding is disabled, ftp-data traffic is still decoded to
look for passive ftp port commands.</p>
<p style="margin-left:11%;"><b>-c | --sticky-hosts</b></p>
<p style="margin-left:12%;">Use this parameter to prevent
idle hosts from being purged from memory.</p>
<p style="margin-left:12%; margin-top: 1em">By default idle
hosts are periodically purged from memory. An idle host is
identified when no packets from or to that host have been
monitored for the period of time defined by the value of
PARM_HOST_PURGE_MINIMUM_IDLE in globals-defines.h.</p>
<p style="margin-left:12%; margin-top: 1em">If you use this
option, all hosts - active and idle - are retained in memory
for the duration of the <b>ntop</b> run.</p>
<p style="margin-left:12%; margin-top: 1em">P2P users, port
scans, popular web servers and other activity will cause
<b>ntop</b> to record data about a large number of hosts. On
an active network, this will consume a significant - and
always growing - amount of memory. It is strongly
recommended that you use a filtering expression to limit the
hosts which are stored if you use --sticky-hosts.</p>
<p style="margin-left:12%; margin-top: 1em">The idle purge
is a statistical one - a random selection of the eligible
hosts will be purged during each cycle. Thus it is possible
on a busy system for an idle host to remain in the
<b>ntop</b> tables and appear ’active’ for some
considerable time after it is truly idle.</p>
<p style="margin-left:11%;"><b>-d | --daemon</b></p>
<p style="margin-left:12%;">This parameter causes ntop to
become a daemon, i.e. a task which runs in the background
without connection to a specific terminal. To use
<b>ntop</b> other than as a casual monitoring tool, you
probably will want to use this option.</p>
<p style="margin-left:12%; margin-top: 1em"><b>WARNING:</b>
If you are running as a daemon, the messages from
<b>ntop</b> will be ’printed’ on to stdout and
thus dropped. You probably don’t want to do this. So
remember to also use the -L or --use-syslog options to save
the messages into the system log.</p>
<p style="margin-left:11%;"><b>-e |
--max-table-rows</b></p>
<p style="margin-left:12%;">This defines the maximum number
of lines that <b>ntop</b> will display on each generated
ML page. If there are more lines to be displayed than this
setting permits, only part of the data will be displayed.
There will be page forward/back arrows placed at the bottom
of the page for navigation between pages.</p>
<p style="margin-left:11%;"><b>-f |
--traffic-dump-file</b></p>
<p style="margin-left:12%;">By default, <b>ntop</b>
captures traffic from network interface cards (NICs) or from
netFlow/sFlow probes. However, <b>ntop</b> can also read
data from a file - typically a tcpdump capture or the output
from one of the <b>ntop</b> packet capture options.</p>
<p style="margin-left:12%; margin-top: 1em">if you specify
-f, <b>ntop</b> will not capture any traffic from NICs
during or after the file has been read. netFlow/sFlow
capture - if enabled - would still be active.</p>
<p style="margin-left:12%; margin-top: 1em">This option is
mostly used for debug purposes.</p>
<p style="margin-left:11%;"><b>-g |
--track-local-hosts</b></p>
<p style="margin-left:12%;">By default, <b>ntop</b> tracks
all hosts that it sees from packets captured on the various
NICs. Use this parameter to tell <b>ntop</b> to capture data
only about local hosts. Local hosts are defined based on the
addresses of the NICs and those networks identified as local
via the -m | --local-subnets parameter.</p>
<p style="margin-left:12%; margin-top: 1em">This parameter
is useful on large networks or those that see many hosts,
(e.g. a border router or gateway), where information about
remote hosts is not desired/required to be tracked.</p>
<p style="margin-left:11%;"><b>-h | --help</b></p>
<p style="margin-left:12%;">Print help information for
<b>ntop,</b> including usage and parameters.</p>
<p style="margin-left:11%;"><b>-i | --interface</b></p>
<p style="margin-left:12%;">Specifies the network interface
or interfaces to be used by <b>ntop</b> for network
monitoring.</p>
<p style="margin-left:12%; margin-top: 1em">If multiple
interfaces are used (this feature is available only if ntop
is compiled with thread support) their names must be
separated with a comma. For instance -i
"eth0,lo".</p>
<p style="margin-left:12%; margin-top: 1em">If not
specified, the default is the first Ethernet device, e.g.
eth0. The specific device that is ’first’ is
highly system dependent. Especially on systems where the
device name reflects the driver name instead of the type of
interface.</p>
<p style="margin-left:12%; margin-top: 1em">By default,
traffic information obtained by all the interfaces is merged
together as if the traffic was seen by only one interface.
Use the -M parameter to keep traffic separate by
interface.</p>
<p style="margin-left:12%; margin-top: 1em">If you do not
want <b>ntop</b> to monitor any interfaces, use -i none.</p>
<p style="margin-left:12%; margin-top: 1em">Under Windows,
the parameter value is either the number of the interface or
its name, e.g. {6252C14C-44C9-49D9-BF59-B2DC18C7B811}. Run
<b>ntop</b> -h to see a list of interface name-number
mappings (at the end of the help information).</p>
<p style="margin-left:11%;"><b>-l | --pcap-log</b></p>
<p style="margin-left:12%;">This parameter causes a dump
file to be created of the network traffic captured by
<b>ntop</b> in tcpdump (pcap) format. This file is useful
for debug, and may be read back into <b>ntop</b> by the -f |
--traffic-dump-file parameter. The dump is made after
processing any filter expression ( never even sees filtered
packets).</p>
<p style="margin-left:12%; margin-top: 1em">The output file
will be named
<i><path>/<log>.<device>.pcap</i>
(Windows: <i><path>/<log>.pcap</i> ), where
<path> is defined by the -O | --output-packet-path
parameter and <log> is defined by this -l | --pcap-log
parameter.</p>
<p style="margin-left:11%;"><b>-m | --local-subnets</b></p>
<p style="margin-left:12%;"><b>ntop</b> determines the ip
addresses and netmasks for each active interface. Any
traffic on those networks is considered local. This
parameter allows the user to define additional networks and
subnetworks whose traffic is also considered local in
<b>ntop</b> reports. All other hosts are considered
remote.</p>
<p style="margin-left:12%; margin-top: 1em">Commas separate
multiple network values. Both netmask and CIDR notation may
be used, even mixed together, for instance
"131.114.21.0/24,10.0.0.0/255.0.0.0".</p>
<p style="margin-left:12%; margin-top: 1em">The local
subnet - as defined by the interface address(es) - is/are
always local and do not need to be specified. If you do give
the same value as a NIC’s local address, a harmless
warning message is issued.</p>
<p style="margin-left:11%;"><b>-n |
--numeric-ip-addresses</b></p>
<p style="margin-left:12%;">By default, <b>ntop</b>
resolves IP addresses using a combination of active
(explicit) DNS queries and passive sniffing. Sniffing of DNS
responses occurs when <b>ntop</b> receives a network packet
containing the response to some other user’s DNS
query. <b>ntop</b> captures this information and enters it
into <b>ntop’s</b> DNS cache, in expectation of
shortly seeing traffic addressed to that host. This way
<b>ntop</b> significantly reduces the number of DNS queries
it makes.</p>
<p style="margin-left:12%; margin-top: 1em">This parameter
causes <b>ntop</b> to skip DNS resolution, showing only
numeric IP addresses instead of the symbolic names. This
option can useful when the DNS is not present or quite
slow.</p>
<p style="margin-left:11%;"><b>-p | --protocols</b></p>
<p style="margin-left:12%;">This parameter is used to
specify the TCP/UDP protocols that <b>ntop</b> will monitor.
The format is <label>=<protocol list> [,
<label>=<protocol list>], where label is used to
symbolically identify the <protocol list>. The format
of <protocol list> is
<protocol>[|<protocol>], where <protocol>
is either a valid protocol specified inside the
/etc/services file or a numeric port range (e.g. 80, or
6000-6500).</p>
<p style="margin-left:12%; margin-top: 1em">A simple
example is
--protocols="HTTP=http|www|https|3128,FTP=ftp|ftp-data",
which reduces the protocols displayed on the "IP"
pages to three:</p>
<p style="margin-left:12%; margin-top: 1em">Host Domain
Data HTTP FTP Other IP <br>
ns2.attbi.com <flag> 954 63.9 % 0 0 954 <br>
64.124.83.112.akamai.com <flag> 240 16.1 % 240 0 0
<br>
64.124.83.99.akamai.com <flag> 240 16.1 % 240 0 0 <br>
toolbarqueries.google.com <flag> 60 4.0 % 60 0 0</p>
<p style="margin-left:12%; margin-top: 1em">If the
<protocol list> is very long you may store it in a
file (for instance protocol.list). To do so, specify the
file name instead of the <protocol list> on the
command line. e.g. <b>ntop -p protocol.list</b></p>
<p style="margin-left:12%; margin-top: 1em">If the -p
parameter is omitted the following default value is
used:</p>
<p style="margin-left:12%; margin-top: 1em">FTP=ftp|ftp-data
<br>
TP=http|www|https|3128 3128 is Squid, the HTTP cache <br>
DNS=name|domain <br>
Telnet=telnet|login <br>
NBios-IP=netbios-ns|netbios-dgm|netbios-ssn <br>
Mail=pop-2|pop-3|pop3|kpop|smtp|imap|imap2 <br>
DHCP-BOOTP=67-68 <br>
SNMP=snmp|snmp-trap <br>
NNTP=nntp <br>
NFS=mount|pcnfs|bwnfs|nfsd|nfsd-status <br>
X11=6000-6010 <br>
SSH=22</p>
<p style="margin-left:12%; margin-top: 1em">Peer-to-Peer
Protocols <br>
---------------------- <br>
Gnutella=6346|6347|6348 <br>
Kazaa=1214 <br>
WinMX=6699|7730 <br>
DirectConnect=0 Dummy port as this is a pure P2P protocol
<br>
eDonkey=4661-4665</p>
<p style="margin-left:12%; margin-top: 1em">Instant
Messenger <br>
----------------- <br>
Messenger=1863|5000|5001|5190-5193</p>
<p style="margin-left:12%; margin-top: 1em">NOTE: To
resolve protocol names to port numbers, they must be
specified in the system file used to list tcp/udp protocols
and ports, which is typically /etc/services file. You will
have to match the names in that file, exactly. Missing or
unspecified (non-standard) ports must be specified by
number, such as 3128 in our examples above.</p>
<p style="margin-left:12%; margin-top: 1em">If you have a
file named /etc/protocols, don’t get confused by it,
as that’s the Ethernet protocol numbers, which are not
what you’re looking for.</p>
<p style="margin-left:11%;"><b>-q |
--create-suspicious-packets</b></p>
<p style="margin-left:12%;">This parameter tells
<b>ntop</b> to create a dump file of suspicious packets.</p>
<p style="margin-left:12%; margin-top: 1em">There are many,
many, things that cause a packet to be labeled as
’suspicious’, including:</p>
<p style="margin-left:12%; margin-top: 1em">Detected ICMP
fragment <br>
Detected Land Attack against host <br>
Detected overlapping/tiny packet fragment <br>
Detected traffic on a diagnostic port <br>
Host performed ACK/FIN/NULL scan <br>
Host rejected TCP session <br>
TP/FTP/SMTP/SSH detected at wrong port <br>
Malformed TCP/UDP/ICMP packet (packet too short) <br>
Packet # %u too long <br>
Received a ICMP protocol Unreachable from host <br>
Sent ICMP Administratively Prohibited packet to host <br>
Smurf packet detected for host <br>
TCP connection with no data exchanged <br>
TCP session reset without completing 3-way handshake <br>
Two MAC addresses found for the same IP address <br>
UDP data to a closed port <br>
Unknown protocol (no HTTP/FTP/SMTP/SSH) detected (on port
80/21/25/22) <br>
Unusual ICMP options</p>
<p style="margin-left:12%; margin-top: 1em">When this
parameter is used, one file is created for each network
interface where suspicious packets are found. The file is in
tcpdump (pcap) format and is named
<path>/ntop-suspicious-pkts.<device>.pcap, where
<path> is defined by the -O | --output-packet-path
parameter.</p>
<p style="margin-left:11%;"><b>-r | --refresh-time</b></p>
<p style="margin-left:12%;">Specifies the delay (in
seconds) between automatic screen updates for those
generated HTML pages which support them. This parameter
allows you to leave your browser window open and have it
always displaying nearly real-time data from
<b>ntop.</b></p>
<p style="margin-left:12%; margin-top: 1em">The default is
3 seconds. Please note that if the delay is very short (1
second for instance), <b>ntop</b> might not be able to
process all of the network traffic.</p>
<p style="margin-left:11%;"><b>-s |
--no-promiscuous</b></p>
<p style="margin-left:12%;">Use this parameter to prevent
from setting the interface(s) into promiscuous mode.</p>
<p style="margin-left:12%; margin-top: 1em">An interface in
promiscuous mode will accept ALL Ethernet frames, regardless
of whether they directed (addressed) to the specific network
interface (NIC) or not. This is an essential part of
enabling <b>ntop</b> to monitor an entire network. (Without
promiscuous mode, <b>ntop</b> will only see traffic directed
to the specific host it is running on, plus broadcast
traffic such as the arp and dhcp protocols.</p>
<p style="margin-left:12%; margin-top: 1em">Even if you use
this parameter, the interface could well be in promiscuous
mode if another application enabled it.</p>
<p style="margin-left:12%; margin-top: 1em"><b>ntop</b>
passes this setting on to libpcap, the packet capture
library. On many systems, a non-promiscuous open of the
network interface will fail, since the libpcap function on
most systems require it to capture raw packets ( <b>ntop</b>
captures raw packets so that we may view and analyze the
layer 2 - MAC - information).</p>
<p style="margin-left:12%; margin-top: 1em">Thus on most
systems, <b>ntop</b> must probably still be started as root,
and this option is largely ornamental. If it fails, you will
see a ***FATALERROR*** message referring to pcap_open_live()
and then an information message, "Sorry, but on this
system, even with -s, it appears that ntop must be started
as root".</p>
<p style="margin-left:11%;"><b>-t | --trace-level</b></p>
<p style="margin-left:12%;">This parameter specifies the
’information’ level of messages that you wish
<b>ntop</b> to display (on stdout or to the log). The higher
the trace level number the more information that is
displayed. The trace level ranges between 0 (no trace) and 5
(full debug tracings).</p>
<p style="margin-left:12%; margin-top: 1em">The default
trace value is 3.</p>
<p style="margin-left:12%; margin-top: 1em">Trace level 0
is not quite zero messages. Fatal errors and certain
startup/shutdown messages are always displayed. Trace level
1 is used to display errors only, level 2 for both errors
and warnings, and level 3 displays error, warning and
informational messages.</p>
<p style="margin-left:12%; margin-top: 1em">Trace level 4
is called ’noisy’ and it is - generating many
messages about the internal functioning of <b>ntop.</b>
Trace level 5 and above are ’noisy’ plus extra
logs, i.e. all possible messages, with a file:line tag
prepended to every message.</p>
<p style="margin-left:11%;"><b>-u | --user</b></p>
<p style="margin-left:12%;">Specifies the user <b>ntop</b>
should run as after it initializes.</p>
<p style="margin-left:12%; margin-top: 1em"><b>ntop</b>
must normally be started as root so that it has sufficient
privileges to open the network interfaces in promiscuous
mode and to receive raw frames. See the discussion of -s |
--no-promiscuous above, if you wish to try starting
<b>ntop</b> as a non-root user.</p>
<p style="margin-left:12%; margin-top: 1em">Shortly after
starting up, <b>ntop</b> becomes the user you specify here,
which normally has substantially reduced privileges, such as
no login shell. This is the userid which owns
<b>ntop’s</b> database and output files.</p>
<p style="margin-left:12%; margin-top: 1em">The value
specified may be either a username or a numeric user id. The
group id used will be the primary group of the user
specified.</p>
<p style="margin-left:12%; margin-top: 1em">If this
parameter is not specified, ntop will try to switch first to
’nobody’ and then to ’anonymous’
before giving up.</p>
<p style="margin-left:12%; margin-top: 1em">NOTE: This
should not be root unless you really understand the security
risks. In order to prevent this by accident, the only way to
run <b>ntop</b> as root is to explicitly specify -u root.
<b>Don’t do it.</b></p>
<p style="margin-left:11%;"><b>-x <br>
-X</b></p>
<p style="margin-left:12%;"><b>ntop</b> creates a new
hash/list entry for each new host/TCP session seen. In case
of DOS (Denial Of Service) an attacker can easily exhaust
all the host available memory because ntop is creating
entries for dummy hosts. In order to avoid this you can set
an upper limit in order to limit the memory ntop can
use.</p>
<p style="margin-left:11%;"><b>-w | --http-server <br>
-W | --https-server</b></p>
<p style="margin-left:12%;"><b>ntop</b> offers an embedded
web server to present the information that has been so
painstakingly gathered. An external HTTP server is NOT
required NOR supported. The <b>ntop</b> web server is
embedded into the application. These parameters specify the
port (and optionally the address (i.e. interface)) of the
<b>ntop</b> web server.</p>
<p style="margin-left:12%; margin-top: 1em">For example, if
started with -w 3000 (the default port), the URL to access
<b>ntop</b> is http://hostname:3000/. If started with a full
specification, e.g. -w 192.168.1.1:3000, <b>ntop</b> listens
on only that address/port combination.</p>
<p style="margin-left:12%; margin-top: 1em">If -w is set to
0 the web server will not listen for http://
connections.</p>
<p style="margin-left:12%; margin-top: 1em">-W operates
similarly, but controls the port for the https://
connections.</p>
<p style="margin-left:12%; margin-top: 1em">Some
examples:</p>
<p style="margin-left:12%; margin-top: 1em"><b>ntop -w 3000
-W 0</b> (this is the default setting) HTTP requests on port
3000 and no HTTPS.</p>
<p style="margin-left:12%; margin-top: 1em"><b>ntop -w 80
-W 443</b> Both HTTP and HTTPS have been enabled on their
most common ports.</p>
<p style="margin-left:12%; margin-top: 1em"><b>ntop -w 0 -W
443</b> HTTP disabled, HTTPS enabled on the common port.</p>
<p style="margin-left:12%; margin-top: 1em">Certain
sensitive, configuration pages of the <b>ntop</b> web server
are protected by a userid/password. By default, these are
the user/URL administration, filter, shutdown and reset
stats are password protected <br>
and are accessible initially only to user <b>admin</b> with
a password set during the first run of <b>ntop.</b></p>
<p style="margin-left:12%; margin-top: 1em">Users can
modify/add/delete users/URLs using ntop itself - see the
Admin tab.</p>
<p style="margin-left:12%; margin-top: 1em">The passwords,
userids and URLs to protect with passwords are stored in a
database file. Passwords are stored in an encrypted form in
the database for further security. Best practices call for
securing that database so that only the <b>ntop</b> user can
read it.</p>
<p style="margin-left:12%; margin-top: 1em">There is a
discussion in docs/FAQ about further securing the
<b>ntop</b> environment.</p>
<p style="margin-left:11%;"><b>-z |
--disable-sessions</b></p>
<p style="margin-left:12%;">This parameter disables TCP
session tracking. Use it for better performance or when you
don’t really need/care to track sessions.</p>
<p style="margin-left:11%;"><b>-A |
--set-admin-password</b></p>
<p style="margin-left:12%;">This parameter is used to start
<b>ntop</b> , set the admin password and quit. It is quite
useful for installers that need to automatically set the
password for the admin user.</p>
<p style="margin-left:12%; margin-top: 1em">-A and
--set-admin-password (without a value) will prompt the user
for the password.</p>
<p style="margin-left:12%; margin-top: 1em">You may also
use this parameter to set a specific value using
--set-admin-password=value. <b>The = is REQUIRED and no
spaces are permitted!</b></p>
<p style="margin-left:12%; margin-top: 1em">If you attempt
to run <b>ntop</b> as a daemon without setting a password, a
FATAL ERROR message is generated and <b>ntop</b> stops.</p>
<p style="margin-left:11%;"><b>-B |
--filter-expression</b></p>
<p style="margin-left:12%;">Filters allows the user to
restrict the traffic seen by <b>ntop</b> on just about any
imaginable item.</p>
<p style="margin-left:12%; margin-top: 1em">The filter
expression is set at run time by this parameter, but it may
be changed during the <b>ntop</b> run on the Admin | Change
Filter web page.</p>
<p style="margin-left:12%; margin-top: 1em">The basic
format is <b>-B filter</b> , where the quotes are
<b>REQUIRED</b></p>
<p style="margin-left:12%; margin-top: 1em">The syntax of
the filter expression uses the same BPF (Berkeley Packet
Filter) expressions used by other packages such as
tcpdump</p>
<p style="margin-left:12%; margin-top: 1em">For instance,
suppose you are interested only in the traffic
generated/received by the host jake.unipi.it. <b>ntop</b>
can then be started with the following filter:</p>
<p style="margin-left:12%; margin-top: 1em"><b>ntop -B src
host jake.unipi.it or dst host jake.unipi.it</b></p>
<p style="margin-left:12%; margin-top: 1em">or in
shorthand:</p>
<p style="margin-left:12%; margin-top: 1em"><b>ntop -B host
jake.unipi.it or host jake.unipi.it</b></p>
<p style="margin-left:12%; margin-top: 1em">See the
’expression’ section of the <b>tcpdump</b> man
page - usually available at
http://www.tcpdump.org/tcpdump_man.html - for further
information and the best quick guide to BPF filters
currently available.</p>
<p style="margin-left:12%; margin-top: 1em">WARNING: If you
are using complex filter expressions, especially those with
=s or meaningful spaces in them, be sure and use the long
option format, --filter-expression="xxxx" and not
-B "xxxx".</p>
<p style="margin-left:11%;"><b>-C |</b></p>
<p style="margin-left:12%;">This instruments ntop to be
used in two configurations: host and network mode. In host
mode (default) ntop works as usual: the IP addresses
received are those of real hosts. In host mode the IP
addresses received are those of the C-class network to which
the address belongs. Using ntop in network mode is extremely
useful when installed in a traffic exchange (e.g. in the
middle of the Internet) whereas the host mode should be used
when ntop is installed on the edge of a network (e.g. inside
a company). The network mode significantly reduces the
amount of work ntop has to perform and it has to be used
whenever ntop is used to find out how the network traffic
flows and not to pin-point specific hosts.</p>
<p style="margin-left:11%;"><b>-D | --domain</b></p>
<p style="margin-left:12%;">This identifies the local
domain suffix, e.g. ntop.org. It may be necessary, if
<b>ntop</b> is having difficulty determining it from the
interface.</p>
<p style="margin-left:11%;"><b>-F | --flow-spec</b></p>
<p style="margin-left:12%;">It is used to specify network
flows similar to more powerful applications such as
NeTraMet. A flow is a stream of captured packets that match
a specified rule. The format is</p>
<p style="margin-left:12%; margin-top: 1em"><b><flow-label>=’<matching
expression>’[,<flow-label>=’<matching
expression>’]</b></p>
<p style="margin-left:12%; margin-top: 1em">, where the
label is used to symbolically identify the flow specified by
the expression. The expression is a bpf (Berkeley Packet
Filter) expression. If an expression is specified, then the
information concerning flows can be accessed following the
ML link named ’List NetFlows’.</p>
<p style="margin-left:12%; margin-top: 1em">For instance
define two flows with the following expression
<b>LucaHosts=’host jake.unipi.it or host
pisanino.unipi.it’,GatewayRoutedPkts=’gateway
gateway.unipi.it’ .</b></p>
<p style="margin-left:12%; margin-top: 1em">All the traffic
sent/received by hosts jake.unipi.it or pisanino.unipi.it is
collected by <b>ntop</b> and added to the LucaHosts flow,
whereas all the packet routed by the gateway
gateway.unipi.it are added to the GatewayRoutedPkts flow. If
the flows list is very long you may store in a file (for
instance flows.list) and specify the file name instead of
the actual flows list (in the above example, this would be
’ntop -F flows.list’).</p>
<p style="margin-left:12%; margin-top: 1em">Note that the
double quotations around the entire flow expression are
required.</p>
<p style="margin-left:11%;"><b>-K | --enable-debug</b></p>
<p style="margin-left:12%;">Use this parameter to simplify
application debug. It does three things: 1. Does not fork()
on the "read only" html pages. 2. Displays mutex
values on the configuration (info.html) page. 3. (If
available - glibc/gcc) Activates an automated backtrace on
application errors.</p>
<p style="margin-left:11%;"><b>-L |
--use-syslog=facility</b></p>
<p style="margin-left:12%;">Use this parameter to send log
messages to the system log instead of stdout.</p>
<p style="margin-left:12%; margin-top: 1em">-L and the
simple form --use-syslog use the default log facility,
defined as LOG_DAEMON in the #define symbol
DEFAULT_SYSLOG_FACILITY in globals-defines.h.</p>
<p style="margin-left:12%; margin-top: 1em">The complex
form, --use-syslog=facility will set the log facility to
whatever value (e.g. local3, security) you specify. <b>The =
is REQUIRED and no spaces are allowed!</b></p>
<p style="margin-left:12%; margin-top: 1em">This setting
applies both to <b>ntop</b> and to any child fork()ed for
reporting. If this parameter is not specified, any fork()ed
child will use the default value and will log it’s
messages to the system log (this occurs because the fork()ed
child must give up it’s access to the parents
stdout).</p>
<p style="margin-left:12%; margin-top: 1em">Because various
systems do not make the permissible names available, we have
a table at the end of globals-core.c. Look for
myFacilityNames.</p>
<p style="margin-left:11%;"><b>-M |
--no-interface-merge</b></p>
<p style="margin-left:12%;">By default, <b>ntop</b> merges
the data collected from all of the interfaces (NICs) it is
monitoring into a single set of counters.</p>
<p style="margin-left:12%; margin-top: 1em">If you have a
simple network, say a small LAN with a connection to the
internet, merging data is good as it gives you a better
picture of the whole network. For larger, more complex
networks, this may not be desirable. You may also have other
reasons for wishing to monitor each interface separately,
for example DMZ vs. LAN traffic.</p>
<p style="margin-left:12%; margin-top: 1em">This option
instructs <b>ntop</b> not to merge network interfaces
together. This means that <b>ntop</b> will collect
statistics for each interface and report them
separately.</p>
<p style="margin-left:12%; margin-top: 1em">Only ONE
interface may be reported on at a time - use the <b>Admin |
Switch NIC</b> option on the web server to select which
interface to report upon.</p>
<p style="margin-left:12%; margin-top: 1em">Note that
activating either the netFlow and/or sFlow plugins will
force the setting of -M. Once enabled, you cannot go
back.</p>
<p style="margin-left:11%;"><b>-N | --wwn-map</b></p>
<p style="margin-left:12%;">This options names the file
providing the map of WWN to FCID/VSAN ids.</p>
<p style="margin-left:11%;"><b>-O |
--output-packet-path</b></p>
<p style="margin-left:12%;">This parameter defines the base
path for the ntop-suspicious-pkts.XXX.pcap and normal packet
dump files.</p>
<p style="margin-left:12%; margin-top: 1em">If this
parameter is not specified, the default value is the
config.h parameter CFG_DBFILE_DIR, which is set during
./configure from the --localstatedir= parameter. If
--localstatedir is not specified, it defaults to the
--prefix value plus /var (e.g. /usr/local/var).</p>
<p style="margin-left:12%; margin-top: 1em">Be aware that
this may not be what you expect when running <b>ntop</b> as
a daemon or Windows service. Setting an explicit and
absolute path value is <b>STRONGLY</b> recommended if you
use this facility.</p>
<p style="margin-left:11%;"><b>-P | --db-file-path <br>
-Q | --spool-file-path</b></p>
<p style="margin-left:12%;">These parameters specify where
<b>ntop</b> stores database files.</p>
<p style="margin-left:12%; margin-top: 1em">There are two
types, ’temporary’ - that is ones which need not
be retained from <b>ntop</b> run to <b>ntop</b> run, and
’permanent’, which must be retained (or
recreated).</p>
<p style="margin-left:12%; margin-top: 1em">The
’permanent’ databases are the preferences,
"prefsCache.db" and the password file,
"ntop_pw.db". These are stored in the -P |
--db-file-path specified location.</p>
<p style="margin-left:12%; margin-top: 1em">Certain plugins
use the -P | --db-file-path specified location for their
database ("LsWatch.db") or (as a default value)
for files (.../rrd/...).</p>
<p style="margin-left:12%; margin-top: 1em">The
’temporary’ databases are the address queue,
"addressQueue.db", the cached DNS resolutions,
"dnsCache.db" and the MAC prefix (vendor table),
"macPrefix.db".</p>
<p style="margin-left:12%; margin-top: 1em">If only -P |
--db-file-path is specified, it is used for both types of
databases.</p>
<p style="margin-left:12%; margin-top: 1em">The directories
named must allow read/write and file creation by the
<b>ntop</b> user. For security, nobody else should have even
read access to these files.</p>
<p style="margin-left:12%; margin-top: 1em">Note that the
default value is the config.h parameter CFG_DBFILE_DIR. This
is set during ./configure from the --localstatedir=
parameter. If --localstatedir is not specified, it defaults
to the --prefix value plus /var (e.g. /usr/local/var).</p>
<p style="margin-left:12%; margin-top: 1em">This may not be
what you expect when running <b>ntop</b> as a daemon or
Windows service.</p>