Add IEEE C37.118 protocol dissector (#2193)

4 files changed, 102 insertions, 0 deletions

diff --git a/src/include/ndpi_protocol_ids.h b/src/include/ndpi_protocol_ids.h
index d9d9d397b..496f16b11 100644
--- a/src/include/ndpi_protocol_ids.h
+++ b/src/include/ndpi_protocol_ids.h
@@ -395,6 +395,7 @@ typedef enum {
   NDPI_PROTOCOL_UMAS                  = 364,
   NDPI_PROTOCOL_BECKHOFF_ADS          = 365,
   NDPI_PROTOCOL_ISO9506_1_MMS         = 366,
+  NDPI_PROTOCOL_IEEE_C37118           = 367,
 
 #ifdef CUSTOM_NDPI_PROTOCOLS
 #include "../../../nDPI-custom/custom_ndpi_protocol_ids.h"
diff --git a/src/lib/ndpi_main.c b/src/lib/ndpi_main.c
index 0a29295c2..026e6809a 100644
--- a/src/lib/ndpi_main.c
+++ b/src/lib/ndpi_main.c
@@ -2166,6 +2166,10 @@ static void ndpi_init_protocol_defaults(struct ndpi_detection_module_struct *ndp
 			  "ISO9506-1-MMS", NDPI_PROTOCOL_CATEGORY_IOT_SCADA,
 			  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_IEEE_C37118,
+			  "IEEE-C37118", NDPI_PROTOCOL_CATEGORY_IOT_SCADA,
+			  ndpi_build_default_ports(ports_a, 4712, 0, 0, 0, 0) /* TCP */,
+			  ndpi_build_default_ports(ports_b, 4713, 0, 0, 0, 0) /* UDP */);
 
 #ifdef CUSTOM_NDPI_PROTOCOLS
 #include "../../../nDPI-custom/custom_ndpi_main.c"
@@ -5617,6 +5621,9 @@ static int ndpi_callback_init(struct ndpi_detection_module_struct *ndpi_str) {
   /* Manufacturing Message Specification */
   init_iso9506_1_mms_dissector(ndpi_str, &a);
 
+  /* IEEE C37.118 Synchrophasor Protocol */
+  init_ieee_c37118_dissector(ndpi_str, &a);
+
 #ifdef CUSTOM_NDPI_PROTOCOLS
 #include "../../../nDPI-custom/custom_ndpi_main_init.c"
 #endif
diff --git a/src/lib/ndpi_private.h b/src/lib/ndpi_private.h
index a9500d13d..589c03870 100644
--- a/src/lib/ndpi_private.h
+++ b/src/lib/ndpi_private.h
@@ -626,6 +626,7 @@ void init_fins_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int
 void init_ethersio_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id);
 void init_beckhoff_ads_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id);
 void init_iso9506_1_mms_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id);
+void init_ieee_c37118_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id);
 
 #endif
 
diff --git a/src/lib/protocols/ieee-c37118.c b/src/lib/protocols/ieee-c37118.c
new file mode 100644
index 000000000..c4576287f
--- /dev/null
+++ b/src/lib/protocols/ieee-c37118.c
@@ -0,0 +1,93 @@
+/*
+ * ieee-c37118.c
+ *
+ * IEEE C37.118 Synchrophasor Protocol
+ * 
+ * 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_IEEE_C37118
+
+#include "ndpi_api.h"
+#include "ndpi_private.h"
+
+static u_int16_t crc16(const u_int8_t* data, size_t n_bytes)
+{
+  u_int16_t crc = 0xFFFF;
+  
+  while (n_bytes--) {
+    crc ^= *data++ << 8;
+    for (u_int8_t i = 0; i < 8; i++) {
+      crc = crc & 0x8000 ? (crc << 1) ^ 0x1021 : crc << 1;
+    }
+  }
+  
+  return crc & 0xFFFF;
+}
+
+static void ndpi_int_ieee_c37118_add_connection(struct ndpi_detection_module_struct *ndpi_struct,
+                                            struct ndpi_flow_struct *flow)
+{
+  NDPI_LOG_INFO(ndpi_struct, "found IEEE C37.118\n");
+  ndpi_set_detected_protocol(ndpi_struct, flow,
+                             NDPI_PROTOCOL_IEEE_C37118, NDPI_PROTOCOL_UNKNOWN,
+                             NDPI_CONFIDENCE_DPI);
+}
+
+static void ndpi_search_ieee_c37118(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 IEEE C37.118\n");
+
+  /* A little bit of heuristics. Check the minimum length, 
+   * version (0xAA) and frame type (0 to 5) */
+  if ((packet->payload_packet_len >= 17) && (packet->payload[0] == 0xAA) &&
+      ((packet->payload[1] >> 4) < 6))
+  {
+    u_int16_t frame_size = ntohs(get_u_int16_t(packet->payload, 2));
+    u_int16_t crc = ntohs(get_u_int16_t(packet->payload, packet->payload_packet_len-2));
+
+    if ((frame_size == packet->payload_packet_len) &&
+        (crc == crc16(packet->payload, packet->payload_packet_len-2)))
+    {
+      ndpi_int_ieee_c37118_add_connection(ndpi_struct, flow);
+      return;
+    }
+  }
+
+  NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
+}
+
+void init_ieee_c37118_dissector(struct ndpi_detection_module_struct *ndpi_struct, u_int32_t *id)
+{
+  ndpi_set_bitmask_protocol_detection("IEEE-C37118", ndpi_struct, *id,
+                                      NDPI_PROTOCOL_IEEE_C37118,
+                                      ndpi_search_ieee_c37118,
+                                      NDPI_SELECTION_BITMASK_PROTOCOL_V4_V6_TCP_OR_UDP_WITH_PAYLOAD_WITHOUT_RETRANSMISSION,
+                                      SAVE_DETECTION_BITMASK_AS_UNKNOWN,
+                                      ADD_TO_DETECTION_BITMASK);
+
+  *id += 1;
+}