Move the -Werror flag in devel mode in setup.py
[netzob.git] / README.txt
1 [******************************************************************************]
2 [**********]                                                       [***********]
3 [**********]       Netzob: inferring communication protocols       [***********]
4 [**********]                                                       [***********]
5 [******************************************************************************]
6
7
8 [******************************************************************************]
9 [***********************]       1. Presentation      [*************************]
10 [******************************************************************************]
11
12 Netzob simplifies the work for security auditors by providing a
13 complete framework for the reverse engineering of communication
14 protocols.
15
16 It handles different types of protocols: text protocols (like HTTP and
17 IRC), fixed fields protocols (like IP and TCP) and variable fields
18 protocols (like ASN.1 based formats).  Netzob is therefore suitable
19 for reversing network protocols, structured files and system and
20 process flows (IPC and communication with drivers). Netzob is provided
21 with modules dedicated to capture data in multiple contexts (network,
22 file, process and kernel data acquisition).
23
24
25 [******************************************************************************]
26 [***********************]       2. Installation      [*************************]
27 [******************************************************************************]
28
29 Netzob currently supports Linux x86 and x64 platforms. A Windows
30 version is expected soon.
31
32 Dependencies:
33
34 * python
35 * python-ptrace
36 * python-matplotlib
37 * python-pcapy
38 * python-bitarray
39 * python-lxml
40 * python-dev
41 * libjs-sphinxdoc
42 * python-sphinx
43 * python-setuptools
44 * graphviz
45
46 Recommends:
47
48 * python-babel (used for translation)
49
50 Linux-specific dependencies:
51
52 * strace
53 * lsof
54
55 Or, on Debian-like operating systems:
56
57 $ sudo apt-get install python python-ptrace python-matplotlib strace lsof \
58   python-pcapy python-bitarray python-dev python-lxml libjs-sphinxdoc     \
59   python-sphinx python-setuptools graphviz python-babel
60
61 And then, 
62
63 $ python setup.py build
64
65
66 [******************************************************************************]
67 [***********************]           3. Usage         [*************************]
68 [******************************************************************************]
69
70 Just run the following command to launch the graphical interface
71
72 $ ./netzob
73
74
75 [******************************************************************************]
76 [***********************]       4. Documentation     [*************************]
77 [******************************************************************************]
78
79 Documentation generation:
80
81 The folder "doc/documentation" contains the documentation of Netzob in sphynx
82 format (.rst). Therefore, if you want to have updated HTMLs in the
83 "/doc/documentation/build/" directory based on the sources of the documentation
84 which is located in "/doc/documentation/source/" you'll have to execute the
85 following command:
86
87 $ sphinx-build -b html doc/documentation/source/ doc/documentation/build/
88
89
90 [******************************************************************************]
91 [***********************]       5. Miscellaneous     [*************************]
92 [******************************************************************************]
93
94 ** Requirements for Network and PCAP input **
95
96 Configuration: 
97
98 $ sudo setcap cap_net_raw=ep /usr/bin/python2.XX
99
100 ** Requirements for IPC input on Ubuntu **
101
102 $ sudo bash -c "echo 0 > /proc/sys/kernel/yama/ptrace_scope"
103
104
105 [******************************************************************************]
106 [***********************]          6. Contact        [*************************]
107 [******************************************************************************]
108
109 * Website: http://www.netzob.org
110 * Email: contact@netzob.org
111 * Mailing lists: https://lists.netzob.org/wws/
112 * Developer's room: https://dev.netzob.org
113 * IRC: #netzob on Freenode
114
115 Authors:
116 * Georges Bossert
117 * Frédéric Guihéry
118
119 Sponsors:
120 * AMOSSYS: http://www.amossys.fr
121 * Supélec: http://www.rennes.supelec.fr/ren/rd/cidre/