Add bitcoing protocol dissector. (#1992)

* Add bitcoing protocol dissector.

* remove bitcoin protcol detection from mining.c
* add a new bitcoin deissector.
* add a new category: Cryptocurrency.

Signed-off-by: Mahmoud Maatuq <mahmoudmatook.mm@gmail.com>

* Remove useless checks and add missing windows and docs file.

Signed-off-by: Mahmoud Maatuq <mahmoudmatook.mm@gmail.com>

* update affected tests.

Signed-off-by: Mahmoud Maatuq <mahmoudmatook.mm@gmail.com>

* add a brief version.

Add notes on the difference between normal bitcoin protocol and the
mining protocol.

Signed-off-by: Mahmoud Maatuq <mahmoudmatook.mm@gmail.com>

* update enable_payload_stat test after dev rebasing.

Signed-off-by: Mahmoud Maatuq <mahmoudmatook.mm@gmail.com>

---------

Signed-off-by: Mahmoud Maatuq <mahmoudmatook.mm@gmail.com>

2 files changed, 71 insertions, 17 deletions

diff --git a/src/lib/protocols/bitcoin.c b/src/lib/protocols/bitcoin.c
new file mode 100644
index 000000000..2154e912a
--- /dev/null
+++ b/src/lib/protocols/bitcoin.c
@@ -0,0 +1,71 @@
+/*
+ * bitcoin.c
+ *
+ * Copyright (C) 2018-23 - ntop.org
+ *
+ * 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_BITCOIN
+#include "ndpi_api.h"
+
+/*https://en.bitcoin.it/wiki/Protocol_documentation*/
+#define MAIN_NET_MAGIC           0xF9BEB4D9
+#define TEST_NET_MAGIC           0xFABFB5DA
+#define TEST_3_NET_MAGIC         0x0B110907
+#define SIG_NET_MAGIC            0x0A03CF40
+#define NAME_COIN_NET_MAGIC      0xF9BEB4FE
+
+static void ndpi_search_bitcoin(struct ndpi_detection_module_struct *ndpi_struct,
+				   struct ndpi_flow_struct *flow) {
+  NDPI_LOG_DBG(ndpi_struct, "search BITCOIN\n");
+  struct ndpi_packet_struct *packet = &ndpi_struct->packet;
+  if(packet->payload_packet_len >= 4) {
+    if(packet->tcp->source == htons(8333) ||
+      packet->tcp->dest == htons(8333)) {
+      u_int32_t ntoh_to_match = ntohl(*(u_int32_t*)packet->payload);  
+      switch (ntoh_to_match) {
+        case MAIN_NET_MAGIC:
+        case TEST_NET_MAGIC:
+        case TEST_3_NET_MAGIC:
+        case SIG_NET_MAGIC:
+        case NAME_COIN_NET_MAGIC:
+          ndpi_set_detected_protocol(ndpi_struct, flow, NDPI_PROTOCOL_BITCOIN, NDPI_PROTOCOL_UNKNOWN, NDPI_CONFIDENCE_DPI);
+          NDPI_LOG_INFO(ndpi_struct, "found BITCOIN\n");
+          return;
+      }
+    }
+  }
+  NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
+}
+
+/* ************************************************************************** */
+
+void init_bitcoin_dissector(struct ndpi_detection_module_struct *ndpi_struct,
+			   u_int32_t *id)
+{
+  ndpi_set_bitmask_protocol_detection("Bitcoin", ndpi_struct, *id,
+				      NDPI_PROTOCOL_BITCOIN,
+				      ndpi_search_bitcoin,
+				      NDPI_SELECTION_BITMASK_PROTOCOL_V4_V6_TCP_WITH_PAYLOAD_WITHOUT_RETRANSMISSION,
+				      SAVE_DETECTION_BITMASK_AS_UNKNOWN,
+				      ADD_TO_DETECTION_BITMASK);
+
+  *id += 1;
+}
+
diff --git a/src/lib/protocols/mining.c b/src/lib/protocols/mining.c
index c6a3420b7..ba1da1454 100644
--- a/src/lib/protocols/mining.c
+++ b/src/lib/protocols/mining.c
@@ -98,23 +98,6 @@ static void ndpi_search_mining_tcp(struct ndpi_detection_module_struct *ndpi_str
 
   /* Check connection over TCP */
   if(packet->payload_packet_len > 10) {
-    if(packet->tcp->source == htons(8333) ||
-       packet->tcp->dest == htons(8333)) {
-      /*
-	Bitcoin
-	
-	bitcoin.magic == 0xf9beb4d9 || bitcoin.magic == 0xfabfb5da
-      */
-      u_int32_t magic = htonl(0xf9beb4d9), magic1 = htonl(0xfabfb5da), *to_match = (u_int32_t*)packet->payload;
-      
-      if((*to_match == magic) || (*to_match == magic1)) {
-       ndpi_snprintf(flow->flow_extra_info, sizeof(flow->flow_extra_info), "%s", "ETH");
-	ndpi_set_detected_protocol(ndpi_struct, flow, NDPI_PROTOCOL_MINING, NDPI_PROTOCOL_UNKNOWN, NDPI_CONFIDENCE_DPI);
-	cacheMiningHostTwins(ndpi_struct, flow);
-	return;
-      }
-    }
-
     if((packet->payload_packet_len > 300)
        && (packet->payload_packet_len < 600)
        && (packet->payload[2] == 0x04)) {