Merge pull request #55 from ssm/feature/gcc10-support
[prads.git] / doc / prads2snort.man
blob313e5780bed508c46773f8933046cd86e13b9739
1 ===========
2 prads2snort
3 ===========
5 -------------------------------------
6 Snort autotuning of Frag3 and Stream5
7 -------------------------------------
9 :Author: edwardfjellskaal@gmail.com
10 :Date:   2010-06-21
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   prads2snort -i /var/log/prads-asset.log -o /etc/snort/host_attributes.xml -d linux -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).
42 PRADS2SNORT is the tool that does this!
44 OPTIONS
45 =======
47 -i, --infile <file>          file to feed prads2snort.pl
48 -o, --outfile <file>         file to write host_attribute data to (host_attribute.xml)
49 -d, --default <os>           set Default OS if unknown (linux,bsd,macos,windows)
50 -v, --verbose                prints out OS, frag, stream and confidence of asset
51 -h, --help                   this help message
52 --version                   show prads2snort.pl version
54 PROBLEMS
55 ========
57 1. Better mapping of less used apps to their correct snort attributes
58    or drop them.
60 SEE ALSO
61 ========
63 * PRADS <http://prads.projects.linpro.no/>
64 * p0f <http://lcamtuf.coredump.cx/p0f.shtml>
65 * PADS <http://passive.sourceforge.net/>
66 * Snort <http://snort.org>
67 * Sguil <http://sguil.net>
68 * Hogger <http://code.google.com/p/hogger/>
70 BUGS
71 ====
73 Report bugs here:
75 - http://github.com/gamelinux/prads/issues 
77 For general questions:
79 - http://projects.linpro.no/mailman/listinfo/prads-devel 
80 - http://projects.linpro.no/mailman/listinfo/prads-users