Add IEEE 1588-2008 (PTPv2) dissector (#2156)

* Add IEEE 1588-2008 (PTPv2) dissector

PTPv2 is a time synchronization protocol in computer networks, similar to NTP.

* Add default protocol ports

* Update default test result for PTPv2

* Update copyright

---------

Co-authored-by: 0xA50C1A1 <mage.wizard88@gmail.com>

4 files changed, 88 insertions, 0 deletions

diff --git a/src/include/ndpi_protocol_ids.h b/src/include/ndpi_protocol_ids.h
index 8da0fef8f..efc3d69df 100644
--- a/src/include/ndpi_protocol_ids.h
+++ b/src/include/ndpi_protocol_ids.h
@@ -386,6 +386,7 @@ typedef enum {
   NDPI_PROTOCOL_TELEGRAM_VOIP         = 355,
   NDPI_PROTOCOL_SINA_WEIBO            = 356,
   NDPI_PROTOCOL_TESLA_SERVICES        = 357,
+  NDPI_PROTOCOL_PTPV2                 = 358,
 
 #ifdef CUSTOM_NDPI_PROTOCOLS
 #include "../../../nDPI-custom/custom_ndpi_protocol_ids.h"
diff --git a/src/include/ndpi_protocols.h b/src/include/ndpi_protocols.h
index da286f925..7d14e38b4 100644
--- a/src/include/ndpi_protocols.h
+++ b/src/include/ndpi_protocols.h
@@ -250,6 +250,7 @@ void init_rmcp_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int
 void init_can_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id);
 void init_protobuf_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id);
 void init_ethereum_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id);
+void init_ptpv2_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id);
 
 /* ndpi_main.c */
 extern u_int32_t ndpi_ip_port_hash_funct(u_int32_t ip, u_int16_t port);
diff --git a/src/lib/ndpi_main.c b/src/lib/ndpi_main.c
index 418b233ac..e8e73dbfa 100644
--- a/src/lib/ndpi_main.c
+++ b/src/lib/ndpi_main.c
@@ -2130,6 +2130,10 @@ static void ndpi_init_protocol_defaults(struct ndpi_detection_module_struct *ndp
               "TeslaServices", NDPI_PROTOCOL_CATEGORY_NETWORK,
               ndpi_build_default_ports(ports_a, 0, 0, 0, 0, 0) /* TCP */,
               ndpi_build_default_ports(ports_b, 0, 0, 0, 0, 0) /* UDP */);
+  ndpi_set_proto_defaults(ndpi_str, 1 /* cleartext */, 0 /* nw proto */, NDPI_PROTOCOL_ACCEPTABLE, NDPI_PROTOCOL_PTPV2,
+			  "PTPv2", NDPI_PROTOCOL_CATEGORY_SYSTEM_OS,
+			  ndpi_build_default_ports(ports_a, 0, 0, 0, 0, 0) /* TCP */,
+			  ndpi_build_default_ports(ports_b, 319, 320, 0, 0, 0) /* UDP */);
 
 #ifdef CUSTOM_NDPI_PROTOCOLS
 #include "../../../nDPI-custom/custom_ndpi_main.c"
@@ -5560,6 +5564,9 @@ static int ndpi_callback_init(struct ndpi_detection_module_struct *ndpi_str) {
     /* ETHEREUM */
   init_ethereum_dissector(ndpi_str, &a);
 
+  /* Precision Time Protocol v2 */
+  init_ptpv2_dissector(ndpi_str, &a);
+
 #ifdef CUSTOM_NDPI_PROTOCOLS
 #include "../../../nDPI-custom/custom_ndpi_main_init.c"
 #endif
diff --git a/src/lib/protocols/ptpv2.c b/src/lib/protocols/ptpv2.c
new file mode 100644
index 000000000..13ad95e38
--- /dev/null
+++ b/src/lib/protocols/ptpv2.c
@@ -0,0 +1,79 @@
+/*
+ * ptpv2.c
+ *
+ * IEEE 1588-2008 Precision Time Protocol (PTP) Version 2
+ * 
+ * Copyright (C) 2023 - ntop.org
+ * Copyright (C) 2023 V.G <jacendi@protonmail.com>
+ *
+ * This file is part of nDPI, an open source deep packet inspection
+ * library based on the OpenDPI and PACE technology by ipoque GmbH
+ *
+ * nDPI is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * nDPI is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with nDPI.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+#include "ndpi_protocol_ids.h"
+
+#define NDPI_CURRENT_PROTO NDPI_PROTOCOL_PTPV2
+
+#include "ndpi_api.h"
+#include "ndpi_private.h"
+
+#define PTP_EVENT_MSG_PORT    319
+#define PTP_GENERAL_MSG_PORT  320
+
+static void ndpi_int_ptpv2_add_connection(struct ndpi_detection_module_struct
+					*ndpi_struct, struct ndpi_flow_struct *flow)
+{
+  ndpi_set_detected_protocol(ndpi_struct, flow, NDPI_PROTOCOL_PTPV2, NDPI_PROTOCOL_UNKNOWN, NDPI_CONFIDENCE_DPI);
+}
+
+static void ndpi_search_ptpv2_udp(struct ndpi_detection_module_struct *ndpi_struct, struct ndpi_flow_struct *flow)
+{
+  struct ndpi_packet_struct *packet = &ndpi_struct->packet;
+
+  NDPI_LOG_DBG(ndpi_struct, "search PTPv2\n");
+
+  /* PTPv2 header is 34 bytes long */
+  if (packet->payload_packet_len > 34) {
+    u_int16_t sport = ntohs(packet->udp->source);
+    u_int16_t dport = ntohs(packet->udp->dest);
+
+    if ((sport == PTP_EVENT_MSG_PORT && dport == PTP_EVENT_MSG_PORT) ||
+        (sport == PTP_GENERAL_MSG_PORT && dport == PTP_GENERAL_MSG_PORT))
+    {
+      /* Check PTP version and message type */
+      if (((packet->payload[0] & 0xF) < 0xF) && packet->payload[1] == 0x02) {
+        NDPI_LOG_INFO(ndpi_struct, "found PTPv2\n");
+        ndpi_int_ptpv2_add_connection(ndpi_struct, flow);
+        return;
+      }
+    }
+  }
+
+  NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
+}
+
+void init_ptpv2_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id)
+{
+  ndpi_set_bitmask_protocol_detection("PTPv2", ndpi_struct, *id,
+              NDPI_PROTOCOL_PTPV2,
+              ndpi_search_ptpv2_udp,
+              NDPI_SELECTION_BITMASK_PROTOCOL_V4_V6_UDP_WITH_PAYLOAD,
+              SAVE_DETECTION_BITMASK_AS_UNKNOWN,
+              ADD_TO_DETECTION_BITMASK);
+
+  *id += 1;
+}