Enhance dissector Aruba ERM

Support type 0 (legacy), type 1 (peek), type 3 (pcap+radio) mode
via preference

type 2 (airmagnet) is no yet supported

Change-Id: I4f0d10e5d9b87bdcf5863d84e565201acaeee45b
Reviewed-on: https://code.wireshark.org/review/647
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Tested-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
Reviewed-by: Anders Broman <a.broman58@gmail.com>

1 files changed, 131 insertions, 64 deletions

diff --git a/epan/dissectors/packet-aruba-erm.c b/epan/dissectors/packet-aruba-erm.c
index c792d4ba53..1de802ad7b 100644
--- a/epan/dissectors/packet-aruba-erm.c
+++ b/epan/dissectors/packet-aruba-erm.c
@@ -59,19 +59,32 @@
 
 #include <glib.h>
 #include <epan/packet.h>
+#include <epan/expert.h>
 #include <epan/prefs.h>
 
 #define PROTO_SHORT_NAME "ARUBA_ERM"
 #define PROTO_LONG_NAME  "ARUBA encapsulated remote mirroring"
-#define PROTO_RADIO_SHORT_NAME "ARUBA_ERM_RADIO_FORMAT"
-#define PROTO_RADIO_LONG_NAME  "ARUBA encapsulated remote mirroring - radio format"
 
+#define TYPE_PCAP 0
+#define TYPE_PEEK 1
+#define TYPE_AIRMAGNET 2
+#define TYPE_PCAPPLUSRADIO 3
+#define TYPE_PPI 4
+
+static const value_string aruba_erm_type_vals[] = {
+    { TYPE_PCAP,            "pcap (type 0)" },
+    { TYPE_PEEK,            "peek (type 1)" },
+    { TYPE_AIRMAGNET,       "Airmagnet (type 2)" },
+    { TYPE_PCAPPLUSRADIO,   "pcap + radio (type 3)" },
+    { TYPE_PPI,             "ppi (type 4)" },
+    { 0, NULL }
+};
 void proto_register_aruba_erm(void);
 void proto_reg_handoff_aruba_erm(void);
 void proto_reg_handoff_aruba_erm_radio(void);
 
 static range_t *global_aruba_erm_port_range;
-static range_t *global_aruba_erm_radio_port_range;
+static gint  aruba_erm_type         = 0;
 
 static int  proto_aruba_erm       = -1;
 
@@ -79,77 +92,114 @@ static int  hf_aruba_erm_time             = -1;
 static int  hf_aruba_erm_incl_len         = -1;
 static int  hf_aruba_erm_orig_len         = -1;
 static int  hf_aruba_erm_data_rate        = -1;
+static int  hf_aruba_erm_data_rate_gen    = -1;
 static int  hf_aruba_erm_channel          = -1;
 static int  hf_aruba_erm_signal_strength  = -1;
 
 static gint ett_aruba_erm = -1;
 
+static expert_field ei_aruba_erm_airmagnet = EI_INIT;
+
 static dissector_handle_t aruba_erm_handle;
-static dissector_handle_t aruba_erm_radio_handle;
 static dissector_handle_t ieee80211_handle;
+static dissector_handle_t peek_handle;
+static dissector_handle_t ppi_handle;
+static dissector_handle_t data_handle;
 
-static void
-dissect_aruba_common(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, gboolean is_radio)
+static int
+dissect_aruba_erm_pcap(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *aruba_erm_tree, gint offset)
 {
-    proto_item *ti;
-    proto_tree *aruba_erm_tree;
-    tvbuff_t   *eth_tvb;
     nstime_t ts;
-    int offset = 16;
-    guint16 data_rate;
-    guint8 signal_strength;
-
-    if (tree) {
-        ti = proto_tree_add_item(tree, proto_aruba_erm, tvb, 0, -1, ENC_NA);
-        aruba_erm_tree = proto_item_add_subtree(ti, ett_aruba_erm);
-
-        ts.secs = tvb_get_ntohl(tvb, 0);
-        ts.nsecs = tvb_get_ntohl(tvb,4)*1000;
-        proto_tree_add_time(aruba_erm_tree, hf_aruba_erm_time, tvb, 0, 8,&ts);
-        proto_tree_add_item(aruba_erm_tree, hf_aruba_erm_incl_len, tvb, 8, 4, ENC_BIG_ENDIAN);
-        proto_tree_add_item(aruba_erm_tree, hf_aruba_erm_orig_len, tvb, 12, 4, ENC_BIG_ENDIAN);
-
-        if (is_radio) {
-            data_rate = tvb_get_ntohs(tvb, 16);
-            proto_tree_add_uint_format(aruba_erm_tree, hf_aruba_erm_data_rate, tvb, 16, 2,
-                                         (guint32)data_rate,
-                                         "Data Rate: %u.%u Mb/s",
-                                         data_rate / 2,
-                                         data_rate & 1 ? 5 : 0);
-
-            proto_tree_add_item(aruba_erm_tree, hf_aruba_erm_channel, tvb, 18, 1, ENC_NA);
-
-            signal_strength = tvb_get_guint8(tvb, 19);
-            proto_tree_add_uint_format(aruba_erm_tree, hf_aruba_erm_signal_strength, tvb, 19, 1,
-                                         (guint32)signal_strength,
-                                         "Signal Strength: %u%%",
-                                         signal_strength);
-            offset += 4;
-        }
-    }
 
-    eth_tvb = tvb_new_subset_remaining(tvb, offset);
-    call_dissector(ieee80211_handle, eth_tvb, pinfo, tree);
+    ts.secs = tvb_get_ntohl(tvb, 0);
+    ts.nsecs = tvb_get_ntohl(tvb,4)*1000;
+    proto_tree_add_time(aruba_erm_tree, hf_aruba_erm_time, tvb, offset, 8,&ts);
+    offset +=8;
+
+    proto_tree_add_item(aruba_erm_tree, hf_aruba_erm_incl_len, tvb, 8, 4, ENC_BIG_ENDIAN);
+    offset +=4;
+
+    proto_tree_add_item(aruba_erm_tree, hf_aruba_erm_orig_len, tvb, 12, 4, ENC_BIG_ENDIAN);
+    offset +=4;
+
+    return offset;
 }
+static int
+dissect_aruba_erm_pcap_radio(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *aruba_erm_tree, gint offset)
+{
+    proto_item *ti_data_rate;
+    guint16 data_rate;
+
+    data_rate = tvb_get_ntohs(tvb, offset);
+    proto_tree_add_item(aruba_erm_tree, hf_aruba_erm_data_rate, tvb, offset, 2, ENC_BIG_ENDIAN);
+    ti_data_rate = proto_tree_add_float_format(aruba_erm_tree, hf_aruba_erm_data_rate_gen,
+                                                tvb, 16, 2,
+                                                (float)data_rate / 2,
+                                                "Data Rate: %.1f Mb/s",
+                                                (float)data_rate / 2);
+    PROTO_ITEM_SET_GENERATED(ti_data_rate);
+    offset += 2;
+
+    proto_tree_add_item(aruba_erm_tree, hf_aruba_erm_channel, tvb, offset, 1, ENC_NA);
+    offset += 1;
 
+    proto_tree_add_item(aruba_erm_tree, hf_aruba_erm_signal_strength, tvb, offset, 1, ENC_NA);
+    offset += 1;
+
+    return offset;
+}
 static void
 dissect_aruba_erm(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 {
-    col_set_str(pinfo->cinfo, COL_PROTOCOL, PROTO_SHORT_NAME);
-    col_set_str(pinfo->cinfo, COL_INFO, PROTO_SHORT_NAME ":");
 
-    dissect_aruba_common(tvb, pinfo, tree, FALSE);
-}
+    proto_item *ti;
+    proto_tree *aruba_erm_tree;
+    tvbuff_t   *eth_tvb;
+
+    int offset = 0 ;
+
+
+    col_set_str(pinfo->cinfo, COL_PROTOCOL, PROTO_SHORT_NAME);
+    col_set_str(pinfo->cinfo, COL_INFO, PROTO_SHORT_NAME);
+
+
+    ti = proto_tree_add_item(tree, proto_aruba_erm, tvb, 0, 0, ENC_NA);
+    proto_item_append_text(ti, ": %s", val_to_str(aruba_erm_type, aruba_erm_type_vals, "Unknown"));
+    aruba_erm_tree = proto_item_add_subtree(ti, ett_aruba_erm);
+
+    switch(aruba_erm_type){
+        case TYPE_PCAP:
+            offset = dissect_aruba_erm_pcap(tvb, pinfo, aruba_erm_tree, offset);
+            proto_set_len(ti, offset);
+            eth_tvb = tvb_new_subset_remaining(tvb, offset);
+            call_dissector(ieee80211_handle, eth_tvb, pinfo, tree);
+            break;
+        case TYPE_PEEK:
+            call_dissector(peek_handle, tvb, pinfo, tree);
+            break;
+        case TYPE_AIRMAGNET:
+            /* Not (yet) supported launch data dissector */
+            proto_tree_add_expert(tree, pinfo, &ei_aruba_erm_airmagnet, tvb, offset, -1);
+            call_dissector(data_handle, tvb, pinfo, tree);
+            break;
+        case TYPE_PCAPPLUSRADIO:
+            offset = dissect_aruba_erm_pcap(tvb, pinfo, aruba_erm_tree, offset);
+            offset = dissect_aruba_erm_pcap_radio(tvb, pinfo, aruba_erm_tree, offset);
+            proto_set_len(ti, offset);
+            eth_tvb = tvb_new_subset_remaining(tvb, offset);
+            call_dissector(ieee80211_handle, eth_tvb, pinfo, tree);
+            break;
+        case TYPE_PPI:
+            call_dissector(ppi_handle, tvb, pinfo, tree);
+            break;
+        default:
+            break;
+    }
 
-static void
-dissect_aruba_erm_radio(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
-{
-    col_set_str(pinfo->cinfo, COL_PROTOCOL, PROTO_RADIO_SHORT_NAME);
-    col_set_str(pinfo->cinfo, COL_INFO, PROTO_RADIO_SHORT_NAME ":");
 
-    dissect_aruba_common(tvb, pinfo, tree, TRUE);
 }
 
+
 void
 proto_register_aruba_erm(void)
 {
@@ -168,11 +218,14 @@ proto_register_aruba_erm(void)
         { &hf_aruba_erm_data_rate,
           { "Data Rate", "aruba_erm.data_rate", FT_UINT16, BASE_DEC, NULL,
             0x00, "Data rate (1/2 Mb/s)", HFILL }},
+        { &hf_aruba_erm_data_rate_gen,
+          { "Data Rate", "aruba_erm.data_rate_gen", FT_FLOAT, BASE_NONE, NULL,
+            0x00, "Data rate (1/2 Mb/s)", HFILL }},
         { &hf_aruba_erm_channel,
           { "Channel", "aruba_erm.channel", FT_UINT8, BASE_DEC, NULL,
             0x00, "802.11 channel number that this frame was sent/received on", HFILL }},
         { &hf_aruba_erm_signal_strength,
-          { "Signal Strength", "aruba_erm.signal_strength", FT_UINT8, BASE_DEC, NULL,
+          { "Signal Strength  [percent]", "aruba_erm.signal_strength", FT_UINT8, BASE_DEC, NULL,
             0x00, "Signal strength (Percentage)", HFILL }},
     };
 
@@ -181,12 +234,26 @@ proto_register_aruba_erm(void)
         &ett_aruba_erm,
     };
 
+    static ei_register_info ei[] = {
+        { &ei_aruba_erm_airmagnet, { "aruba_erm.airmagnet", PI_UNDECODED, PI_ERROR, "Airmagnet (type 2) is no yet supported (Please use other type)", EXPFILL }}
+    };
+
+    static const enum_val_t aruba_erm_types[] = {
+        { "pcap_type_0", "pcap (type 0)", TYPE_PCAP},
+        { "peek_type_1", "peek (type1)", TYPE_PEEK},
+        { "airmagnet_type_2", "airmagnet (type 2)", TYPE_AIRMAGNET},
+        { "pcapplusradio_type_3", "pcap+radio header (type 3)", TYPE_PCAPPLUSRADIO},
+        { "ppi_type_4", "ppi (type 4)", TYPE_PPI},
+        { NULL, NULL, -1}
+    };
+
+
     module_t *aruba_erm_module;
+    expert_module_t* expert_aruba_erm;
 
     proto_aruba_erm = proto_register_protocol(PROTO_LONG_NAME, PROTO_SHORT_NAME, "aruba_erm");
 
     range_convert_str (&global_aruba_erm_port_range, "0", MAX_UDP_PORT);
-    range_convert_str (&global_aruba_erm_radio_port_range, "0", MAX_UDP_PORT);
 
     aruba_erm_module = prefs_register_protocol(proto_aruba_erm, proto_reg_handoff_aruba_erm);
 
@@ -196,14 +263,15 @@ proto_register_aruba_erm(void)
                                     "0 (default) means that the ARUBA_ERM dissector is not active\n",
                                     &global_aruba_erm_port_range, MAX_UDP_PORT);
 
-    prefs_register_range_preference(aruba_erm_module, "radio.udp.ports", "ARUBA_ERM_RADIO_FORMAT UDP Port numbers",
-                                    "Set the UDP port numbers (typically the range 5555 to 5560) used for ARUBA"
-                                    " encapsulated remote mirroring frames with radio format;\n"
-                                    "0 (default) means that the ARUBA_ERM_RADIO_FORMAT dissector is not active\n",
-                                    &global_aruba_erm_radio_port_range, MAX_UDP_PORT);
+    prefs_register_enum_preference(aruba_erm_module, "type.captured",
+                       "Type of formats for captured packets",
+                       "Type of formats for captured packets",
+                       &aruba_erm_type, aruba_erm_types, FALSE);
 
     proto_register_field_array(proto_aruba_erm, hf, array_length(hf));
     proto_register_subtree_array(ett, array_length(ett));
+    expert_aruba_erm = expert_register_protocol(proto_aruba_erm);
+    expert_register_field_array(expert_aruba_erm, ei, array_length(ei));
 }
 
 void
@@ -215,21 +283,20 @@ proto_reg_handoff_aruba_erm(void)
 
     if (!initialized) {
         ieee80211_handle = find_dissector("wlan");
+        ppi_handle = find_dissector("ppi");
+        peek_handle = find_dissector("peekremote");
+        data_handle = find_dissector("data");
         aruba_erm_handle = create_dissector_handle(dissect_aruba_erm, proto_aruba_erm);
-        aruba_erm_radio_handle = create_dissector_handle(dissect_aruba_erm_radio, proto_aruba_erm);
         initialized = TRUE;
     } else {
         dissector_delete_uint_range("udp.port", aruba_erm_port_range, aruba_erm_handle);
-        dissector_delete_uint_range("udp.port", aruba_erm_radio_port_range, aruba_erm_radio_handle);
         g_free(aruba_erm_port_range);
         g_free(aruba_erm_radio_port_range);
     }
 
     aruba_erm_port_range = range_copy(global_aruba_erm_port_range);
-    aruba_erm_radio_port_range = range_copy(global_aruba_erm_radio_port_range);
 
     dissector_add_uint_range("udp.port", aruba_erm_port_range, aruba_erm_handle);
-    dissector_add_uint_range("udp.port", aruba_erm_radio_port_range, aruba_erm_radio_handle);
 }
 
 /*