Metadata-Version: 2.0
Name: websnort
Version: 0.3
Summary: Web service for analysing pcap files with snort
Home-page: https://github.com/shendo/websnort
Author: Steve Henderson
Author-email: steve.henderson@hendotech.com.au
License: GPL
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Internet
Classifier: Topic :: Security
Requires-Dist: bottle (>=0.10)
Requires-Dist: jinja2 (>=2.5)

websnort
========

Web service for analysing pcap files with ``snort``.

|build_status| |pypi_version|

Overview
--------

``websnort`` provides a web interface for user and system submission of packet
capture files to run against a ``snort`` IDS instance.  Alerts and logs are
returned as results.

If you are after a web interface for monitoring a running ``snort`` instance,
see https://www.snort.org/downloads#additional-downloads instead.

Getting Started
---------------

**Ubuntu**

Install ``snort`` if needed: ::

    sudo apt-get install snort

*Optional* Disable running snort service if only required for this web api: ::

    sudo service snort stop
    sudo update-rc.d snort disable

On recent ubuntu/debian releases the default *snort.conf* is not world readable.  Unless 
planning to run the web service as root (not recommended) you will need to modify the
permissions, for example: ::

	sudo chmod a+r /etc/snort/snort.conf

Install web service using ``pip``: ::

	sudo pip install websnort

Start the ``websnort`` web server on the default port: ::

	websnort

Browse to server:8080 and submit a pcap file for analysis.

Issues
------

Source code for ``websnort`` is hosted on `GitHub`_. Any bug reports or feature
requests can be made using GitHub's `issues system`_.

.. _GitHub: https://github.com/shendo/websnort
.. _issues system: https://github.com/shendo/websnort/issues

.. |build_status| image:: https://secure.travis-ci.org/shendo/websnort.png?branch=master
   :target: https://travis-ci.org/shendo/websnort
   :alt: Current build status

.. |pypi_version| image:: https://pypip.in/v/websnort/badge.png
   :target: https://pypi.python.org/pypi/websnort
   :alt: Latest PyPI version



