Merge pull request #56 from wuruilong01/master
[prads.git] / doc / prads.man
blobf8e39b62fe5af8cc8721c96fd105dafb799ef417
1 =========
2  PRADS
3 =========
5 ---------------------------------------------
6 Passive Real-time Asset Detection System
7 ---------------------------------------------
9 :Author: Edward Bjarte FjellskÃ¥l <edwardfjellskaal@gmail.com>
10 :Author: Kacper Wysocki <comotion@users.sf.net>
11 :Date:   2010-06-17
12 :Copyright: GPL
13 :Version: 0.2
14 :Manual section: 1
15 :Manual group: networking
17 SYNOPSIS
18 ========
20   prads -i eth1 -v
22 DESCRIPTION
23 ===========
25 PRADS is a Passive Real-time Asset Detection System.
27 PRADS employs digital fingerprints to recognize services on the wire, 
28 and can be used to map your network and monitor for changes in real time.
30 Real-time passive traffic analysis will also let you detect assets that 
31 are just connected to the network for a short period of time, since PRADS
32 can glean useful information from every packet.
34 PRADS aims to be the one-stop-shop for passive asset detection, and currently
35 does MAC lookups, TCP and UDP OS fingerprinting as well as client and service
36 application matching and a connection state table. Various output plugins
37 include logfile and FIFO and make PRADS a useful replacement for p0f, pads and sancp.
39 PRADS was built from the ground up for a small footprint and modern networks with IPv6 and gigabits of throughput.
41 OPTIONS
42 =======
44  -i <iface>      Network device <iface> (default: eth0).
45  -r <file>       Read pcap <file>.
46  -c <file>       Read config from <file>.
47  -b <filter>     Apply Berkeley packet filter <filter>.
48  -u <user>       Run as user <user>   (Default: uid 1).
49  -g <group>      Run as group <group> (Default: gid 1).
50  -d              Do not drop privileges.
51  -a <nets>       Specify home nets (eg: '192.168.0.0/25,10.0.0.0/255.0.0.0').
52  -D              Daemonize.
53  -p <pidfile>    Name of pidfile - inside chroot.
54  -l <file>       Log assets to <file> (default: '%s')\n", config.assetlog.
55  -f <FIFO>       Log assets to <FIFO>.
56  -B              Log connections to ringbuffer.
57  -C <dir>        Chroot into <dir> before dropping privs.
58  -XFRMSAK        Flag picker: X - clear flags, F:FIN, R:RST, M:MAC, S:SYN, A:ACK, K:SYNACK
59  -UTtI           Service checks: U:UDP, T:TCP-server, I:ICMP, t:TCP-cLient
60  -P              DHCP fingerprinting.
61  -s <snaplen>    Dump <snaplen> bytes of each payload.
62  -v              Verbose output - repeat for more verbosity.
63  -q              Quiet - try harder not to produce output.
64  -L <dir>        log cxtracker type output to <dir> (will be owned by <uid>).
65  -O              Connection tracking [O]utput - per-packet!
66  -x              Conne[x]ion tracking output  - New, expired and ended.
67  -Z              Passive DNS (Experimental).
68  -H              DHCP fingerprinting (Expermiental).
69  -h              This help message.
71 PROBLEMS
72 ========
74 1. Doesn't detect everything out there :-P
75 2. This man page.
77 SEE ALSO
78 ========
80 * PRADS <http://prads.projects.linpro.no/>
81 * p0f <http://lcamtuf.coredump.cx/p0f.shtml>
82 * PADS <http://passive.sourceforge.net/>
84 BUGS
85 ====
87 Report bugs here:
89 - http://github.com/gamelinux/prads/issues 
91 For general questions:
93 - http://projects.linpro.no/mailman/listinfo/prads-devel 
94 - http://projects.linpro.no/mailman/listinfo/prads-users