aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1d6aeec77cae9864f7c0dcbedc38733877ce071b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
nDPI is an open source GPLv3 library for deep-packet inspection. Based on OpenDPI it includes ntop extensions. We have tried to push them into the OpenDPI source tree but nobody in answering emails so we have decided to create mour own source tree

==========

In order to compile this library do

- ./autogen.sh
- ./configure
- make

Please note that the pre-requisites for compilation include:
- GNU tools (autogen, automake, autoconf, libtool)
- GNU C compiler (gcc)

==========

The entire procedure of adding new protocols in detail:

1. Add new protocol together with its unique ID to:
src/include/ndpi_protocols_osdpi.h

2. Create a new protocol in:
src/lib/protocols/

3. Variables to be kept for the duration of the entire flow (as state variables) needs to be placed in:
/include/ndpi_structs.h
in ndpi_flow_tcp_struct (for TCP only), ndpi_flow_udp_struct (for UDP only), or ndpi_flow_struct (for both).

4. Add a new entry for the search function for the new protocol in:
src/include/ndpi_protocols.h

5. Choose (do not change anything) a selection bitmask from:
src/include/ndpi_define.h

6. Add a new entry in ndpi_set_protocol_detection_bitmask2 in:
src/lib/ndpi_main.c

7. Set protocol default ports in ndpi_init_protocol_defaults in:
src/lib/ndpi_main.c

8. Add the new protocol file to:
src/lib/Makefile.am

9.  ./autogen.sh
10. ./configure
11. make

==========

If you want to distribute a source tar file of nDPI do:

- make dist

--------------------------
April 2015 - ntop