README

   1 #### PRADS README
   2 #  ______
   3 # |  __  |                  __
   4 # | _____|.----..------..--|  |.-----. (tm)
   5 # |  |    |  |-'|  __  ||  _  |__  --'
   6 # |__|    |__|  |____|_||_____|______|
   7 #
   8 # Passive Real-time Asset Detection system!
   9 #
  10
  11 # Baut'
  12 Is a `Passive Real-time Asset Detection System`. It passively listen to network traffic and gathers information on hosts and services it sees on the network. This information can be used to map your network, letting you know what services and hosts are active, and can be used together with your favorite IDS/IPS setup for "event to application" correlation.
  13
  14 # As is!
  15 This program is served 'as is'. We take no responsibility for anything :)
  16
  17 # Lic
  18 GPL v2 or better? See LICENSE
  19
  20 # Install
  21 See doc/INSTALL
  22
  23 # USE
  24 There are several ways to use PRADS.
  25 PRADS has many commandline options, see the prads(1) man page.
  26
  27 # Example
  28   prads -i eth0 -l prads.log
  29
  30 If you run the prads service, the assets it sees will be dumped into /var/log/prads.log and look like this:
  31
  32 10.43.2.181,0,54354,6,SYN,[65535:64:1:64:M1460,N,W2,N,N,T,S,E,E:P:MacOS:iPhone OS 3.1.3 (UC):link:ethernet/modem:uptime:1574hrs],0,1300882012
  33 10.43.2.181,0,0,0,ARP (Apple),C8:BC:C8:48:65:CA,0,1300882017
  34
  35 This information can be further processed, inserted into an SQL database etc.
  36
  37 the general format fo this data is:
  38 asset,vlan,port,proto,service,[service-info],distance,discovered
  39
  40 asset       = The ip address of the asset.
  41 vlan        = The virtual lan tag of the asset.
  42 port        = The port number of the detected service.
  43 proto       = The protocol number of the matching fingerprint.
  44 service     = The "Service" detected, like: TCP-SERVICE, UDP-SERVICE, SYN, SYNACK,MAC,.....
  45 service-info= The fingerprint that the match was done on, with info.
  46 distance    = Distance based on guessed initial TTL (service = SYN/SYNACK)
  47 discovered  = The timestamp when the data was collected
  48
  49 May it sniff your network for a while and you will be able to do anomaly detection.
  50
  51 # SNORT (snort.org)
  52 The prads2snort script may be used to convert the prads log into a hosts_attribute.xml file that can be used by snort to decide fragmentation policies, for better event detection.
  53  http://snort.org/docs/snort_manual/node189.html
  54
  55 # Sguil (sguil.net)
  56 You can feed events from PRADS straight into sguil replacing pads by using the sguil pads agent. PRADS supports the -f fifo argument and the 'fifo: /path/to/fifo' configuration option to feed events into a FIFO.
  57
  58 # SQL database, WebGUI etc.
  59 This is on the agenda. There will be a webgui to the database, for easy browsing of your network.
  60