CCSDS_study project
This commit is contained in:
99
netzob-030/doc/documentation/source/installation/debian.rst
Normal file
99
netzob-030/doc/documentation/source/installation/debian.rst
Normal file
@@ -0,0 +1,99 @@
|
||||
.. currentmodule:: netzob
|
||||
|
||||
.. _installation_debian:
|
||||
|
||||
|
||||
Installation documentation on Debian
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Using Netzob's APT Repository
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
A dedicated APT repository (apt.netzob.org) is available for downloading
|
||||
and installing Netzob.
|
||||
|
||||
Steps:
|
||||
|
||||
#. edit you ``/etc/apt/sources.list`` to add the netzob's repository
|
||||
URL,
|
||||
#. import the GPG key used to sign the repository,
|
||||
#. install netzob threw ``apt-get``.
|
||||
|
||||
Edit ``/etc/apt/sources.list``
|
||||
|
||||
You need to register the repository in your APT client by adding the
|
||||
following entry (stable or unstable) in your ``/etc/apt/sources.list``
|
||||
or through a dedicated file in ``/etc/apt/sources.list.d/``. Then you
|
||||
need to import the gpg public key used to sign the repository.
|
||||
|
||||
**Unstable & testing ("Wheezy")**
|
||||
|
||||
::
|
||||
|
||||
deb http://apt.netzob.org/debian/ unstable main
|
||||
deb-src http://apt.netzob.org/debian/ unstable main
|
||||
|
||||
**Stable ("Squeeze")**
|
||||
|
||||
::
|
||||
|
||||
deb http://apt.netzob.org/debian/ squeeze-backports main
|
||||
deb-src http://apt.netzob.org/debian/ squeeze-backports main
|
||||
|
||||
Import GPG key\ `¶ <#Import-GPG-key>`_
|
||||
|
||||
The repository is signed, so APT may complain until you register the
|
||||
archive key ``0xE57AEA26`` to your APT keyring. The fingerprint of the
|
||||
key is ``D865 DCF0 9B9A 195C 49F0 E3F3 F750 1A13 E57A EA26`` and has
|
||||
been signed by the followings:
|
||||
|
||||
- 0xA255A6A3 : Georges Bossert
|
||||
<`georges.bossert@supelec.fr <mailto:georges.bossert@supelec.fr>`_\ >
|
||||
- 0x561F7A47 : Frederic Guihery
|
||||
<`frederic.guihery@amossys.fr <mailto:frederic.guihery@amossys.fr>`_\ >
|
||||
- 0x04B1A89C : Olivier Tetard
|
||||
<`olivier.tetard@amossys.fr <mailto:olivier.tetard@amossys.fr>`_\ >
|
||||
|
||||
To import the key of the APT repository you can execute the following
|
||||
commands :
|
||||
|
||||
::
|
||||
|
||||
# wget https://dev.netzob.org/misc/debian_archive.asc -O -| gpg --import
|
||||
# gpg --export -a 0xF7501A13E57AEA26 | sudo apt-key add -
|
||||
|
||||
Install netzob\ `¶ <#Install-netzob>`_
|
||||
|
||||
You can install it with the following commands :
|
||||
|
||||
::
|
||||
|
||||
# apt-get update
|
||||
# apt-get install netzob
|
||||
|
||||
Using the provided Debian package
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Installing Netzob directly from the debian package (deb file) implies
|
||||
you manually install the necessary packages in order to handle the
|
||||
required dependencies. Therefore, the following commands can be executed
|
||||
to install them :
|
||||
|
||||
::
|
||||
|
||||
# apt-get install python python-ptrace python-hachoir-subfile python-matplotlib python-dpkt strace lsof python-pcapy python-bitarray python-dev libjs-sphinxdoc python-sphinx
|
||||
|
||||
Once the requirements are fullfilled you can download the debian file
|
||||
(i386 or amd64) and install it using the following command for an i386
|
||||
architecture (32 bits) :
|
||||
|
||||
::
|
||||
|
||||
# dpkg -i netzob_0.3.0-1_i386.deb
|
||||
|
||||
or for an AMD64 (64 bits) :
|
||||
|
||||
::
|
||||
|
||||
# dpkg -i netzob_0.3.0-1_amd64.deb
|
||||
|
||||
80
netzob-030/doc/documentation/source/installation/gentoo.rst
Normal file
80
netzob-030/doc/documentation/source/installation/gentoo.rst
Normal file
@@ -0,0 +1,80 @@
|
||||
.. currentmodule:: netzob
|
||||
|
||||
.. _installation_gentoo:
|
||||
|
||||
Installation documentation on Gentoo
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
From official portage (not yet available)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Some build scripts have been published for future integration in
|
||||
Portage.
|
||||
While the scripts have not yet been accepted please refer to the
|
||||
alternative procedure.
|
||||
|
||||
::
|
||||
|
||||
# emerge -av netzob
|
||||
|
||||
From Gentoo overlay (recommended, automatic)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Alternative non official repositories are available on Gentoo which are
|
||||
called "overlays".
|
||||
The tool used to synchronize with these repositories is called "layman"
|
||||
|
||||
#. Installing layman
|
||||
|
||||
::
|
||||
|
||||
# emerge app-portage/layman
|
||||
|
||||
#. Adding "lootr" repository containing Netzob ebuild scripts
|
||||
|
||||
::
|
||||
|
||||
# layman -a lootr
|
||||
|
||||
#. Installing Netzob from this repository
|
||||
|
||||
::
|
||||
|
||||
# emerge -av dev-python/netzob
|
||||
|
||||
From netzob repository (expert users only, manual installation)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
First step is to clone the netzob repository:
|
||||
|
||||
::
|
||||
|
||||
# (~) git clone https://dev.netzob.org/git/netzob-gentoo.git
|
||||
|
||||
Then, declare this repository in the portage configuration file
|
||||
*/etc/make.conf* by adding this line:
|
||||
|
||||
::
|
||||
|
||||
PORTDIR_OVERLAY="/home/USER/netzob-gentoo/"
|
||||
|
||||
Synchronize portage
|
||||
|
||||
::
|
||||
|
||||
# emerge --sync
|
||||
|
||||
Finally emerge Netzob package:
|
||||
|
||||
- *tildarched (testing-like) systems:*
|
||||
|
||||
::
|
||||
|
||||
# emerge -av netzob
|
||||
|
||||
- *stable systems:*
|
||||
|
||||
::
|
||||
|
||||
# ACCEPT_KEYWORDS="~x86" emerge -av netzob
|
||||
|
||||
66
netzob-030/doc/documentation/source/installation/python.rst
Normal file
66
netzob-030/doc/documentation/source/installation/python.rst
Normal file
@@ -0,0 +1,66 @@
|
||||
.. currentmodule:: netzob
|
||||
|
||||
.. _installation_python:
|
||||
|
||||
Installation of Netzob
|
||||
======================
|
||||
|
||||
This page presents how to install Netzob as a Python package.
|
||||
|
||||
Installing Netzob system dependencies
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
First thing to do is to check the version of your python3 interpretor.
|
||||
Netzob requires at least Python 3.8::
|
||||
|
||||
$ python3 --version
|
||||
Python 3.8.10
|
||||
|
||||
You have to install the following system dependencies::
|
||||
|
||||
$ apt-get install -y python3 python3-dev python3-setuptools virtualenv build-essential libpcap-dev libgraph-easy-perl libffi-dev
|
||||
|
||||
Then, create a virtualenv::
|
||||
|
||||
$ mkdir venv
|
||||
$ virtualenv venv
|
||||
$ source venv/bin/activate
|
||||
|
||||
Installing Netzob from Pypi
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You can install Netzob from Pypi (recommended choice)::
|
||||
|
||||
(venv) $ pip3 install netzob
|
||||
|
||||
Installing Netzob from sources
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you have retrieved Netzob sources, the installation procedure is::
|
||||
|
||||
(venv) $ pip3 install Cython==0.29.32 # Should be manually installed because of setup.py direct dependency
|
||||
(venv) $ pip3 install -e .
|
||||
|
||||
API usage
|
||||
---------
|
||||
|
||||
Once installed, we recommend to use the Netzob API inside scripts, with the following statement to import Netzob::
|
||||
|
||||
from netzob.all import *
|
||||
|
||||
Start Netzob CLI
|
||||
----------------
|
||||
|
||||
Netzob also provides its own CLI, in order to play interactively with it::
|
||||
|
||||
(venv) $ netzob
|
||||
|
||||
Building the documentation
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The folder *doc/documentation* contains all the documentation of Netzob.
|
||||
|
||||
The user manual can be generated based on RST sources located in folder
|
||||
*doc/documentation/source* with the following command::
|
||||
|
||||
$ sphinx-build -b html doc/documentation/source/ doc/documentation/build/
|
||||
57
netzob-030/doc/documentation/source/installation/windows.rst
Normal file
57
netzob-030/doc/documentation/source/installation/windows.rst
Normal file
@@ -0,0 +1,57 @@
|
||||
.. currentmodule:: netzob
|
||||
|
||||
.. _installation_windows:
|
||||
|
||||
Installation documentation on Windows
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This documentation only applies for Netzob 0.3.3.
|
||||
|
||||
Installation of dependencies
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Steps:
|
||||
|
||||
#. Install Python 2.7 (download the installer from
|
||||
`python.org <http://www.python.org/ftp/python/2.7.3/python-2.7.3.msi>`_)
|
||||
#. Install SetupTools (download the installer from
|
||||
`pypi.python.org <http://pypi.python.org/packages/2.7/s/setuptools/setuptools-0.6c11.win32-py2.7.exe#md5=57e1e64f6b7c7f1d2eddfc9746bbaf20>`_)
|
||||
#. Install PyGTK (download the installer from
|
||||
`gnome.org <http://ftp.gnome.org/pub/GNOME/binaries/win32/pygtk/2.24/pygtk-all-in-one-2.24.2.win32-py2.7.msi>`_)
|
||||
#. Install WinPCap 4.1.2 (download the installer from
|
||||
`winpcap.org <http://www.winpcap.org/install/bin/WinPcap_4_1_2.exe>`_)
|
||||
#. Install Pcapy 0.10.5 (provided on `Netzob's
|
||||
website <http://www.netzob.org/repository/0.3.3/windows-dep/pcapy-0.10.5.win32-py2.7.exe>`_
|
||||
; original source:
|
||||
`oss.coresecurity.com <http://oss.coresecurity.com/repo/pcapy-0.10.5.tar.gz>`_)
|
||||
#. Install following dependencies with SetupTools (be sure to have
|
||||
C:\\Python27\\Scripts\\easy\_install.exe in your PATH):
|
||||
|
||||
#. ::
|
||||
|
||||
easy_install numpy
|
||||
|
||||
#. ::
|
||||
|
||||
easy_install impacket
|
||||
|
||||
#. ::
|
||||
|
||||
easy_install -f "http://downloads.sourceforge.net/project/matplotlib/matplotlib/matplotlib-1.1.0/matplotlib-1.1.0.win32-py2.7.exe?r=http%3A%2F%2Fsourceforge.net%2Fprojects%2Fmatplotlib%2Ffiles%2Fmatplotlib%2Fmatplotlib-1.1.0%2F&ts=1339591175&use_mirror=netcologne" matplotlib
|
||||
|
||||
#. ::
|
||||
|
||||
easy_install bitarray==0.3.5
|
||||
|
||||
Installation of Netzob
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
#. Install
|
||||
`Netzob <http://www.netzob.org/repository/0.3.3/Netzob-0.3.3.win32-py2.7.exe>`_
|
||||
!
|
||||
|
||||
**Remark:** If you have disabled Windows UAC, a error can be raised by
|
||||
Windows when executing Netzob's installer: Failed to start elevated
|
||||
process (ShellExecute returned 3). So you have to run the installer with
|
||||
administrator privilege : right-click on the executable and choose "run
|
||||
as administrator".
|
||||
Reference in New Issue
Block a user