WikiStart: INSTALL

File INSTALL, 4.8 KB (added by arthur, 8 years ago)

INSTALL file for honeysnap

Line 
1INSTALLING HONEYSNAP
2=====================
3
4This document explains step by step how to install
5Honeysnap, including all dependencies.  Suggestions
6for this document, or Honeysnap in general should be
7sent to <[email protected]>.  This document is
8broken down into the following parts.
9
101: Dependencies
112: Installation on a Linux/Unix/OS X Workstation
123: Installation on Windows
134: Installation on a Honeywall
145: Running Honeysnap
15
16
171. DEPENDENCIES
18================
19
20General Dependencies
21 Python 2.4 or greater      http://www.python.org
22 libpcap                    http://sourceforge.net/projects/libpcap/
23 pypcap 1.1 or greater      http://code.google.com/p/pypcap/
24
25Pure python modules:
26 irclib 0.4.6 or greater    http://python-irclib.sourceforge.net/
27 dpkt                       http://code.google.com/p/dpkt/
28 magic                      http://www.demonseed.net/~jp/code/magic.py
29
30This latter set should be installed automatically and are listed
31here for completeness.
32     
332: INSTALLATION ON UNIX
34========================
35
36First, you will need to install python 2.4 or 2.5 and its header file.  Most
37distributions most likely already have this installed.  Then you will
38need libpcap.  For most UNIX-like systems, it should be in your package
39management system (apt-get, yum, MacPorts etc.).  You will need libpcap
40and also libpcap-devel if that is listed separately.  For example, on
41Debian/Ubuntu with python2.4:
42
43  $ sudo apt-get install python2.4-dev
44  $ sudo apt-get install libpcap0.8 libpcap0.8-dev
45
46On Fedora/RHEL
47
48$ sudo yum install python-devel
49$ sudo yum install libpcap-devel
50
51Get pypcap from https://projects.honeynet.org/honeysnap/attachment/wiki/WikiStart/pypcap-1.1.tar.gz
52
53This version is the same as the one from Dug Song's site, but with the
54installer altered to install cleanly on linux and on python 2.5.
55                             
56$ wget -O pypcap-1.1.tar.gz --no-check-certificate https://projects.honeynet.org/honeysnap/attachment/wiki/WikiStart/pypcap-1.1.tar.gz
57$ tar xvzf pypcap-1.1.tar.gz
58$ cd pcap-1.1
59$ sudo python setup.py install
60
61You should then be able to install Honeysnap and all its remaining
62dependencies (provided you have a network connection).
63E.g. for version 1.0.6:
64
65  $ tar xvzf honeysnap-1.0.6
66  $ cd honeysnap-1.0.6
67  $ sudo python setup.py install
68
69If you already have easy_install installed, you can simplify the
70installation process further by simply executing the following.
71
72  $ sudo easy_install https://projects.honeynet.org/honeysnap/attachment/wiki/WikiStart/pypcap-1.1.tar.gz
73  $ sudo easy_install -f . honeysnap-1.0.6.tar.gz
74
75This is exactly the same as untar'ing the distribution and
76running 'sudo python setup.py install'
77
78Please note that this will install the honeysnap script into your
79PATH, usually in /usr/bin. If this isn't what you want, specify
80--script-dir. e.g
81
82$ sudo easy_install --script-dir /usr/local/bin honeysnap-1.0.6.tar.gz
83
843: INSTALLATION ON WINDOWS
85==========================
86
87Download  and install the following, in order.
88
89  * Python 2.4 (from http://www.python.org/download). You can install
90  from the Windows MSI installer linked from that page.
91
92  * winpcap from
93  http://www.winpcap.org/install/default.htm 
94       
95  * pypcap from http://code.google.com/p/pypcap/downloads/list
96  You need to download and run the Windows installer for your
97  version of Python (2.4 in our example)
98
99To make Python easily available on the command line, right click
100on "My Computer" and select Properties. Then go to Advanced and
101choose Environment Variables. Add to the end of the PATH variable
102
103 ;C:\Python24;C:\Python24\Scripts
104
105(assuming you installed Python to the default location). If you
106don't already have setuptools installed, you'll need to download
107ez_setup.py from
108
109  http://peak.telecommunity.com/dist/ez_setup.py
110
111and run it. This will install easy_setup. Finally run
112
113  easy_install -f . honeysnap-1.0.6.zip
114                                                   
115This should download and install honeysnap and all its
116dependencies.
117                 
1184: INSTALLATION ON A HONEYWALL
119==============================
120
121Note: These instructions apply to version 1.3 of the Honeywall
122and later only.
123                 
124i) yum install pcap
125
126ii) Install honeysnap (e.g. version 1.0.6):
127
128$ wget https://projects.honeynet.org/honeysnap/attachment/wiki/WikiStart/honeysnap-1.0.6.12.tar.gz
129$ tar xvzf honeysnap-1.0.6
130$ cd honeysnap-1.0.6
131$ sudo python setup.py install
132
133ii) Test!
134
135$ honeysnap --version
136
137
1385: Running honeysnap
139====================
140Try to execute 'honeysnap':
141
142  $ honeysnap
143
144You should see:
145                               
146usage: honeysnap [options]
147
148options:
149  --version             show program's version number and exit
150  -h, --help            show this help message and exit
151  [.... more options snipped....]
152
153  Please see the accompanying documentation for instructions on
154  configuration.
155
156