bump version
[prads.git] / doc / prads.man
bloba1d351a709b0d9653de5bdeacf43cac664464139
1 =========
2  PRADS
3 =========
5 ---------------------------------------------
6 Passive Real-time Asset Detection System
7 ---------------------------------------------
9 :Author: edwardfjellskaal@gmail.com
10 :Date:   2010-06-17
11 :Copyright: GPL
12 :Version: 0.2
13 :Manual section: 1
14 :Manual group: networking
16 .. TODO: authors and author with name <email>
18 SYNOPSIS
19 ========
21   prads -i eth1 -v
23 DESCRIPTION
24 ===========
26 PRADS is a Passive Real-time Asset Detection System.
28 It passively listen to network traffic and gathers information
29 on hosts and services it sees on the network. This information
30 can be used to map your network, letting you know what services
31 and hosts are alive/used, or can be used together with your
32 favorite IDS/IPS setup for "event to host/service" correlation.
34 Gathering info about your hosts in real-time, will also let you
35 detect assets that are just connected to the network for a short
36 period of time, where a active network scan (nmap etc.) would take
37 long time, and not common to run continually, hence missing the asset. 
39 The initial goal of implementing PRADS, was to make the
40 host_attribute_table.xml for Snort (automatically) and to add more
41 info into the Sguil application. The list of useful stuff that
42 PRADS can be used for is growing all the time. PRADS aims to be the
43 one-stop-shop for passive asset detection. If you can detect it
44 passively, PRADS should have it implemented! 
46 OPTIONS
47 =======
49 -i <iface>              Network device <iface> (default: eth0).
50 -r <file>               Read pcap <file>.
51 -c <file>               Read config from <file>.
52 -b <filter>             Apply Berkeley packet filter <filter>.
53 -u <user>               Run as user <user>.
54 -g <group>              Run as group <group>.
55 -a <nets>               Specify home nets (eg: '192.168.0.0/25,10.0.0.0/255.0.0.0').
56 -D                      Enables daemon mode.
57 -h                      This help message.
58 -v                      Verbose.
60 PROBLEMS
61 ========
63 1. Doesn't detect everything out there :-P
65 SEE ALSO
66 ========
68 * PRADS <http://prads.projects.linpro.no/>
69 * p0f <http://lcamtuf.coredump.cx/p0f.shtml>
70 * PADS <http://passive.sourceforge.net/>
72 BUGS
73 ====
75 Report bugs here:
77 - http://github.com/gamelinux/prads/issues 
79 For general questions:
81 - http://projects.linpro.no/mailman/listinfo/prads-devel 
82 - http://projects.linpro.no/mailman/listinfo/prads-users