man page is now up-to-date
[prads.git] / doc / prads.man
blob3f6c593a416437c4c4f84df1a4906df5d0c99be2
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>.
49  -g <group>      Run as group <group>.
50  -a <nets>       Specify home nets (eg: '192.168.0.0/25,10.0.0.0/255.0.0.0').
51  -D              Enables daemon mode.
52  -p <pidfile>    Name of pidfile - inside chroot
53  -l <file>       Log assets to <file> (default: '/var/log/prads-asset.log')
54  -f <FIFO>       Log assets to <FIFO> -C <dir>        Chroot into <dir> before dropping privs.
55  -XFRMSAK        Flag picker: X - clear flags, F:FIN, R:RST, M:MAC, S:SYN, A:ACK, K:SYNACK
56  -UTtI           Service checks: U:UDP, T:TCP-server, I:ICMP, t:TCP-cLient
57  -s <snaplen>    Dump <snaplen> bytes of each payload.
58  -v              Verbose output - repeat for more verbosity.
59  -q              Quiet - try harder not to produce output.
60  -O              Connection tracking [O]utput - per-packet!
61  -x              Conne[x]ion tracking output  - New, expired and ended.
62  -h              This help message.
65 PROBLEMS
66 ========
68 1. Doesn't detect everything out there :-P
70 SEE ALSO
71 ========
73 * PRADS <http://prads.projects.linpro.no/>
74 * p0f <http://lcamtuf.coredump.cx/p0f.shtml>
75 * PADS <http://passive.sourceforge.net/>
77 BUGS
78 ====
80 Report bugs here:
82 - http://github.com/gamelinux/prads/issues 
84 For general questions:
86 - http://projects.linpro.no/mailman/listinfo/prads-devel 
87 - http://projects.linpro.no/mailman/listinfo/prads-users