hashgrab-captured
-----------------

About
-----

Hashgrab-captured is a utility designed to capture the network output from 
hashgrabd and store it either on disk or in a database. For more information
on the purpose and capabilities of hashgrabd please see that package.

Limitations
-----------

The authors testing environment is MySQL driven, support for other DBMS' may
be untested.

Outputs
-------

Hashgrab-captured stores the results from hashgrabd in date split text files
and/or in databases.

Requirements
------------

o Perl 5.8+
o Compress::Bzip2
o DateTime
o File::Path
o Proc::Daemon

Obtaining
---------

At current hashgrab-captured does not have an installer, requirements should
be met out of CPAN or other package management tools.

1. Obtain current release of hashgrab-captured.
# wget http://github.com/tignetworking/hashgrab-captured/tarball/release-current

2. Extract current release of hashgrab-captured, XXXXXXX will very depending
   on git commits.
# tar xvzf tignetworking-hashgrab-captured-XXXXXXX.tar.gz

Running
-------

Command-line parameters are listed upon executing the program with no 
arguements.

usage: ./hashgrab-captured.pl [ --listen-port port ] [ --store-directory directory ]
	[ --store-dbi dbi-string ] [ --store-dbi-username username ] 
	[ --store-dbi-password password ] [ --store-expiry days ] [ --daemonize ]

  --listen-port port		- UDP port to listen on for records (default => 10000)
  --store-directory directory	- directory where to store recieved data
  --store-dbi dbi-string	- DBI string where to store recieved data
  --store-dbi-username username	- DBI username to use
  --store-dbi-password password	- DBI password to use
  --store-expiry days		- length of time to store data on disk (default => 90)
  --daemonize			- daemonize program

Examples
--------

* Store captured data from port 9999 in /var/log/hashgrab

./hashgrab-captured.pl --listen-port 9999 --store-directory /var/log/hashgrab

* Store captured data from default port into DBI, providing username/password and daemonize

./hashgrab-captured.pl --store-dbi dbi:mysql:hashgrabdatabase --store-dbi-username hashgrab --store-dbi-password barghsah

See Also
--------

hashgrabd         - Utility to capture eDonkey and BitTorrent cryptographic
                    hashes from BPF, outputting via STDOUT or UDP connection.
hashgrab-web      - PHP site to read from MySQL database, propulated from
                    hashgrab-captured.

Authors
-------

hashgrab-captured is maintained by the following individuals:
o Peter Wood <p.wood@lancaster.ac.uk> (Project Lead)
o Daniel Meyers <d.meyers@lancaster.ac.uk> 

License
-------

Copyright (C) 2010 University of Lancaster

This program is free software: you can redistribute it and/or modify it 
under the terms of the GNU General Public License as published by 
the Free Software Foundation, either version 3 of the License, or 
(at your option) any later version. This program is distributed in the 
hope that it will be useful, but WITHOUT ANY WARRANTY; without 
even the implied warranty of MERCHANTABILITY or FITNESS FOR 
A PARTICULAR PURPOSE. See the GNU General Public License 
for more details. You should have received a copy of the GNU General 
Public License along with this program. If not, see <http://www.gnu.org/licenses/>.