Have a clear distinction between public and private/internal API

1) Public API/headers in `src/include/` [as it has always been] 2) Private API/headers in `src/lib/` Try to keep the "ndpi_" prefix only for the public functions
ntop · Nov 9, 2023 · 276adfd · 276adfd
1 parent b539b0d
commit 276adfd
Show file tree

Hide file tree

Showing 206 changed files with 621 additions and 424 deletions.
diff --git a/fuzz/Makefile.am b/fuzz/Makefile.am
@@ -65,7 +65,7 @@ fuzz_ndpi_reader_payload_analyzer_LINK=$(LIBTOOL) $(AM_V_lt) --tag=CC $(AM_LIBTO
     $(fuzz_ndpi_reader_payload_analyzer_LDFLAGS) @NDPI_LDFLAGS@ $(LDFLAGS) -o $@
 
 fuzz_quic_get_crypto_data_SOURCES = fuzz_quic_get_crypto_data.c fuzz_common_code.c
-fuzz_quic_get_crypto_data_CFLAGS = @NDPI_CFLAGS@ $(CXXFLAGS)
+fuzz_quic_get_crypto_data_CFLAGS = -I../src/lib/ @NDPI_CFLAGS@ $(CXXFLAGS) -DNDPI_LIB_COMPILATION
 fuzz_quic_get_crypto_data_LDADD = ../src/lib/libndpi.a $(ADDITIONAL_LIBS)
 fuzz_quic_get_crypto_data_LDFLAGS = $(LIBS)
 if HAS_FUZZLDFLAGS
@@ -387,7 +387,7 @@ fuzz_binaryfusefilter_LINK=$(LIBTOOL) $(AM_V_lt) --tag=CC $(AM_LIBTOOLFLAGS) \
     $(fuzz_binaryfusefilter_LDFLAGS) @NDPI_LDFLAGS@ $(LDFLAGS) -o $@
 
 fuzz_tls_certificate_SOURCES = fuzz_tls_certificate.c fuzz_common_code.c
-fuzz_tls_certificate_CFLAGS = @NDPI_CFLAGS@ $(CXXFLAGS)
+fuzz_tls_certificate_CFLAGS = -I../src/lib/ @NDPI_CFLAGS@ $(CXXFLAGS) -DNDPI_LIB_COMPILATION
 fuzz_tls_certificate_LDADD = ../src/lib/libndpi.a $(ADDITIONAL_LIBS)
 fuzz_tls_certificate_LDFLAGS = $(LIBS)
 if HAS_FUZZLDFLAGS
@@ -413,7 +413,7 @@ fuzz_dga_LINK=$(LIBTOOL) $(AM_V_lt) --tag=CC $(AM_LIBTOOLFLAGS) \
     $(fuzz_dga_LDFLAGS) @NDPI_LDFLAGS@ $(LDFLAGS) -o $@
 
 fuzz_is_stun_udp_SOURCES = fuzz_is_stun.c fuzz_common_code.c
-fuzz_is_stun_udp_CFLAGS = @NDPI_CFLAGS@ $(CXXFLAGS)
+fuzz_is_stun_udp_CFLAGS = -I../src/lib/ @NDPI_CFLAGS@ $(CXXFLAGS) -DNDPI_LIB_COMPILATION
 fuzz_is_stun_udp_LDADD = ../src/lib/libndpi.a $(ADDITIONAL_LIBS)
 fuzz_is_stun_udp_LDFLAGS = $(LIBS)
 if HAS_FUZZLDFLAGS
@@ -426,7 +426,7 @@ fuzz_is_stun_udp_LINK=$(LIBTOOL) $(AM_V_lt) --tag=CC $(AM_LIBTOOLFLAGS) \
     $(fuzz_is_stun_udp_LDFLAGS) @NDPI_LDFLAGS@ $(LDFLAGS) -o $@
 
 fuzz_is_stun_tcp_SOURCES = fuzz_is_stun.c fuzz_common_code.c
-fuzz_is_stun_tcp_CFLAGS = @NDPI_CFLAGS@ $(CXXFLAGS) -DSTUN_TCP
+fuzz_is_stun_tcp_CFLAGS = -I../src/lib/ @NDPI_CFLAGS@ $(CXXFLAGS) -DNDPI_LIB_COMPILATION -DSTUN_TCP
 fuzz_is_stun_tcp_LDADD = ../src/lib/libndpi.a $(ADDITIONAL_LIBS)
 fuzz_is_stun_tcp_LDFLAGS = $(LIBS)
 if HAS_FUZZLDFLAGS

diff --git a/fuzz/fuzz_is_stun.c b/fuzz/fuzz_is_stun.c
@@ -1,6 +1,5 @@
-#define NDPI_LIB_COMPILATION
-
 #include "ndpi_api.h"
+#include "ndpi_private.h"
 #include "fuzz_common_code.h"
 
 static struct ndpi_detection_module_struct *ndpi_struct = NULL;

diff --git a/fuzz/fuzz_quic_get_crypto_data.c b/fuzz/fuzz_quic_get_crypto_data.c
@@ -1,4 +1,5 @@
 #include "ndpi_api.h"
+#include "ndpi_private.h"
 #include "fuzz_common_code.h"
 
 #include <stdint.h>
@@ -7,20 +8,6 @@
 struct ndpi_detection_module_struct *ndpi_info_mod = NULL;
 struct ndpi_flow_struct *flow = NULL;
 
-extern const uint8_t *get_crypto_data(struct ndpi_detection_module_struct *ndpi_struct,
-				      struct ndpi_flow_struct *flow,
-				      u_int8_t *clear_payload, uint32_t clear_payload_len,
-				      uint64_t *crypto_data_len);
-extern void process_tls(struct ndpi_detection_module_struct *ndpi_struct,
-			struct ndpi_flow_struct *flow,
-			const u_int8_t *crypto_data, uint32_t crypto_data_len,
-			uint32_t version);
-extern void process_chlo(struct ndpi_detection_module_struct *ndpi_struct,
-			 struct ndpi_flow_struct *flow,
-			 const u_int8_t *crypto_data, uint32_t crypto_data_len);
-extern int is_version_with_tls(uint32_t version);
-
-
 int LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
   const u_int8_t *crypto_data;
   uint64_t crypto_data_len;
@@ -56,7 +43,7 @@ int LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
     if(!is_version_with_tls(version)) {
       process_chlo(ndpi_info_mod, flow, crypto_data, crypto_data_len);
     } else {
-      process_tls(ndpi_info_mod, flow, crypto_data, crypto_data_len, version);
+      process_tls(ndpi_info_mod, flow, crypto_data, crypto_data_len);
     }
   }
 

diff --git a/fuzz/fuzz_tls_certificate.c b/fuzz/fuzz_tls_certificate.c
@@ -1,14 +1,10 @@
-#define NDPI_LIB_COMPILATION
-
 #include "ndpi_api.h"
+#include "ndpi_private.h"
 #include "fuzz_common_code.h"
 
 #include <stdint.h>
 #include <stdio.h>
 
-extern void processCertificateElements(struct ndpi_detection_module_struct *ndpi_struct,
-				       struct ndpi_flow_struct *flow,
-				       u_int16_t p_offset, u_int16_t certificate_len);
 struct ndpi_tcphdr tcph;
 struct ndpi_iphdr iph;
 struct ndpi_ipv6hdr iphv6;

diff --git a/python/ndpi/ndpi_build.py b/python/ndpi/ndpi_build.py
@@ -91,9 +91,6 @@
                            ).stdout.decode('utf-8',
                                            errors='ignore')
 
-NDPI_MODULE_STRUCT_CDEF = NDPI_CDEF.split("//CFFI.NDPI_MODULE_STRUCT")[1]
-
-
 NDPI_PACKED = subprocess.run(["gcc",
                               "-DNDPI_LIB_COMPILATION", "-DNDPI_CFFI_PREPROCESSING",
                               "-E", "-x", "c", "-P", "-C",
@@ -104,7 +101,7 @@
 
 NDPI_PACKED_STRUCTURES = NDPI_PACKED.split("//CFFI.NDPI_PACKED_STRUCTURES")[1]
 
-NDPI_SOURCE = NDPI_INCLUDES + NDPI_MODULE_STRUCT_CDEF + NDPI_HELPERS
+NDPI_SOURCE = NDPI_INCLUDES + NDPI_HELPERS
 
 
 ffi_builder.set_source("_ndpi",