Add HART-IP protocol dissector (#2163)

* Add HART-IP protocol dissector

* Update docs

* Update protocols.rst

* Reuse free proto id and re-run tests

* docs: move HART-IP to top of list

---------

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

4 files changed, 122 insertions, 5 deletions

diff --git a/src/include/ndpi_protocol_ids.h b/src/include/ndpi_protocol_ids.h
index efc3d69df..e14eb77d7 100644
--- a/src/include/ndpi_protocol_ids.h
+++ b/src/include/ndpi_protocol_ids.h
@@ -100,7 +100,7 @@ typedef enum {
   NDPI_PROTOCOL_AMONG_US              = 69,
   NDPI_PROTOCOL_YAHOO                 = 70,
   NDPI_PROTOCOL_DISNEYPLUS            = 71,
-  NDPI_PROTOCOL_FREE_72               = 72,
+  NDPI_PROTOCOL_HART_IP               = 72,
   NDPI_PROTOCOL_IP_VRRP               = 73,
   NDPI_PROTOCOL_STEAM                 = 74,
   NDPI_PROTOCOL_HALFLIFE2             = 75,
diff --git a/src/include/ndpi_protocols.h b/src/include/ndpi_protocols.h
index 7d14e38b4..7bbbbe9d0 100644
--- a/src/include/ndpi_protocols.h
+++ b/src/include/ndpi_protocols.h
@@ -251,6 +251,7 @@ void init_can_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int3
 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);
+void init_hart_ip_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 e8e73dbfa..5b7b76770 100644
--- a/src/lib/ndpi_main.c
+++ b/src/lib/ndpi_main.c
@@ -1310,10 +1310,6 @@ static void ndpi_init_protocol_defaults(struct ndpi_detection_module_struct *ndp
 			  "DisneyPlus", NDPI_PROTOCOL_CATEGORY_STREAMING,
 			  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, 0 /* encrypted */, 1 /* app proto */, NDPI_PROTOCOL_FUN, NDPI_PROTOCOL_FREE_72,
-			  "Free72", NDPI_PROTOCOL_CATEGORY_SOCIAL_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_IP_VRRP,
 			  "VRRP", NDPI_PROTOCOL_CATEGORY_NETWORK,
 			  ndpi_build_default_ports(ports_a, 0, 0, 0, 0, 0) /* TCP */,
@@ -2134,6 +2130,10 @@ static void ndpi_init_protocol_defaults(struct ndpi_detection_module_struct *ndp
 			  "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 */);
+  ndpi_set_proto_defaults(ndpi_str, 1 /* cleartext */, 0 /* nw proto */, NDPI_PROTOCOL_ACCEPTABLE, NDPI_PROTOCOL_HART_IP,
+			  "HART-IP", NDPI_PROTOCOL_CATEGORY_IOT_SCADA,
+			  ndpi_build_default_ports(ports_a, 5094, 0, 0, 0, 0) /* TCP */,
+			  ndpi_build_default_ports(ports_b, 0, 0, 0, 0, 0) /* UDP */);
 
 #ifdef CUSTOM_NDPI_PROTOCOLS
 #include "../../../nDPI-custom/custom_ndpi_main.c"
@@ -5567,6 +5567,9 @@ static int ndpi_callback_init(struct ndpi_detection_module_struct *ndpi_str) {
   /* Precision Time Protocol v2 */
   init_ptpv2_dissector(ndpi_str, &a);
 
+  /* Highway Addressable Remote Transducer over IP */
+  init_hart_ip_dissector(ndpi_str, &a);
+
 #ifdef CUSTOM_NDPI_PROTOCOLS
 #include "../../../nDPI-custom/custom_ndpi_main_init.c"
 #endif
diff --git a/src/lib/protocols/hart-ip.c b/src/lib/protocols/hart-ip.c
new file mode 100644
index 000000000..4120d0888
--- /dev/null
+++ b/src/lib/protocols/hart-ip.c
@@ -0,0 +1,113 @@
+/*
+ * hart-ip.c
+ *
+ * Highway Addressable Remote Transducer over IP
+ * 
+ * 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_HART_IP
+
+#include "ndpi_api.h"
+#include "ndpi_private.h"
+
+struct hart_ip_hdr {
+  u_int8_t version;
+  u_int8_t msg_type;
+  u_int8_t msg_id;
+  u_int8_t status;
+  u_int16_t seq_num;
+  u_int16_t msg_len;
+};
+
+enum hart_ip_msg_type {
+  REQUEST_MSG,
+  RESPONSE_MSG,
+  PUBLISH_MSG,
+  NAK_MSG = 15
+};
+
+enum hart_ip_msg_id {
+  SESSION_INITIATE_ID,
+  SESSION_CLOSE_ID,
+  KEEPALIVE_ID,
+  TOKEN_PASSING_PDU_ID,
+  DIRECT_PDU_ID,
+  READ_AUDIT_LOG_ID
+};
+
+static void ndpi_int_hart_ip_add_connection(struct ndpi_detection_module_struct *ndpi_struct,
+                                            struct ndpi_flow_struct *flow)
+{
+  NDPI_LOG_INFO(ndpi_struct, "found HART-IP\n");
+
+  ndpi_set_detected_protocol(ndpi_struct, flow,
+                             NDPI_PROTOCOL_HART_IP, NDPI_PROTOCOL_UNKNOWN,
+                             NDPI_CONFIDENCE_DPI);
+}
+
+static void ndpi_search_hart_ip(struct ndpi_detection_module_struct *ndpi_struct,
+                                struct ndpi_flow_struct *flow)
+{
+  struct ndpi_packet_struct const * const packet = &ndpi_struct->packet;
+
+  NDPI_LOG_DBG(ndpi_struct, "search HART-IP\n");
+  
+  if (packet->payload_packet_len < sizeof(struct hart_ip_hdr)) {
+    goto not_hart_ip;
+  }
+
+  struct hart_ip_hdr const * const hart_ip_header = (struct hart_ip_hdr *)packet->payload;
+  
+  if (hart_ip_header->version == 1 || hart_ip_header->version == 2) {
+    u_int8_t message_type = hart_ip_header->msg_type & 0xF;
+
+    if ((message_type > PUBLISH_MSG && message_type != NAK_MSG) && 
+        hart_ip_header->msg_id > READ_AUDIT_LOG_ID)
+    {
+      goto not_hart_ip;
+    }
+    
+    if (ntohs(hart_ip_header->msg_len) != packet->payload_packet_len) {
+      goto not_hart_ip;
+    }
+    
+    ndpi_int_hart_ip_add_connection(ndpi_struct, flow);
+    return;
+  }
+  
+not_hart_ip:
+  NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
+}
+
+void init_hart_ip_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id)
+{
+  ndpi_set_bitmask_protocol_detection("HART-IP", ndpi_struct, *id,
+                                      NDPI_PROTOCOL_HART_IP,
+                                      ndpi_search_hart_ip,
+                                      NDPI_SELECTION_BITMASK_PROTOCOL_V4_V6_TCP_OR_UDP_WITH_PAYLOAD_WITHOUT_RETRANSMISSION,
+                                      SAVE_DETECTION_BITMASK_AS_UNKNOWN,
+                                      ADD_TO_DETECTION_BITMASK);
+
+  *id += 1;
+}