iSER: Add iSER dissector support

Bug: 10189
Change-Id: Ie99d99a1736b3c6446d5a00edf201a49dfcd4780
Reviewed-on: https://code.wireshark.org/review/2247
Reviewed-by: Michael Mann <mmann78@netscape.net>
Reviewed-by: Evan Huus <eapache@gmail.com>

3 files changed, 458 insertions, 0 deletions

diff --git a/epan/CMakeLists.txt b/epan/CMakeLists.txt
index 48b08b4246..018e59c6c2 100644
--- a/epan/CMakeLists.txt
+++ b/epan/CMakeLists.txt
@@ -833,6 +833,7 @@ set(DISSECTOR_SRC
 	dissectors/packet-isakmp.c
 	dissectors/packet-iscsi.c
 	dissectors/packet-isdn.c
+	dissectors/packet-iser.c
 	dissectors/packet-isis-clv.c
 	dissectors/packet-isis-hello.c
 	dissectors/packet-isis-lsp.c
diff --git a/epan/dissectors/Makefile.common b/epan/dissectors/Makefile.common
index 02a747840f..f9b8965e5e 100644
--- a/epan/dissectors/Makefile.common
+++ b/epan/dissectors/Makefile.common
@@ -759,6 +759,7 @@ DISSECTOR_SRC = \
 	packet-isakmp.c		\
 	packet-iscsi.c		\
 	packet-isdn.c		\
+	packet-iser.c		\
 	packet-isis-clv.c	\
 	packet-isis-hello.c	\
 	packet-isis-lsp.c	\
diff --git a/epan/dissectors/packet-iser.c b/epan/dissectors/packet-iser.c
new file mode 100644
index 0000000000..5d990799f9
--- /dev/null
+++ b/epan/dissectors/packet-iser.c
@@ -0,0 +1,456 @@
+/* packet-iser.c
+ * Routines for iSCSI RDMA Extensions dissection
+ * Copyright 2014, Mellanox Technologies Ltd.
+ * Code by Yan Burman.
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "config.h"
+
+#include <epan/packet.h>
+#include <epan/prefs.h>
+#include <epan/conversation.h>
+#include <epan/addr_resolv.h>
+#include <stdlib.h>
+#include <errno.h>
+
+#include "packet-infiniband.h"
+
+#define ISER_WSV    0x08
+#define ISER_RSV    0x04
+#define ISER_REJ    0x01
+
+#define ISER_ISCSI_CTRL    0x10
+#define ISER_HELLO         0x20
+#define ISER_HELLORPLY     0x30
+
+#define ISER_OPCODE_MASK      0xf0
+#define ISER_SPECIFIC_MASK    0x0f
+
+#define ISER_HDR_SZ   (1 + 3 + 4 + 8 + 4 + 8)
+#define ISCSI_HDR_SZ  48
+
+#define ISER_ISCSI_HDR_SZ (ISER_HDR_SZ + ISCSI_HDR_SZ)
+
+#define SID_ULP_MASK   0x00000000FF000000
+#define SID_PROTO_MASK 0x0000000000FF0000
+#define SID_PORT_MASK  0x000000000000FFFF
+
+#define SID_ULP         0x01
+#define SID_PROTO_TCP   0x06
+#define TCP_PORT_ISER_RANGE    "3260"
+
+#define SID_MASK (SID_ULP_MASK | SID_PROTO_MASK)
+#define SID_ULP_TCP ((SID_ULP << 3 * 8) | (SID_PROTO_TCP << 2 * 8))
+
+void proto_reg_handoff_iser(void);
+void proto_register_iser(void);
+
+static int proto_iser = -1;
+static dissector_handle_t iscsi_handler;
+static dissector_handle_t ib_handler;
+static int proto_ib = -1;
+
+/* iSER Header */
+static int hf_iser = -1;
+static int hf_iser_flags = -1;
+static int hf_iser_opcode_f = -1;
+static int hf_iser_RSV_f = -1;
+static int hf_iser_WSV_f = -1;
+static int hf_iser_REJ_f = -1;
+static int hf_iser_write_stag = -1;
+static int hf_iser_write_va = -1;
+static int hf_iser_read_stag = -1;
+static int hf_iser_read_va = -1;
+static int hf_iser_ird = -1;
+static int hf_iser_ord = -1;
+
+/* Initialize the subtree pointers */
+static gint ett_iser = -1;
+static gint ett_iser_flags = -1;
+
+/* global preferences */
+static gboolean gPREF_MAN_EN    = FALSE;
+static gint gPREF_TYPE[2]       = {0};
+static const char *gPREF_ID[2]  = {NULL};
+static guint gPREF_QP[2]        = {0};
+static range_t *gPORT_RANGE;
+
+/* source/destination addresses from preferences menu (parsed from gPREF_TYPE[?], gPREF_ID[?]) */
+static address manual_addr[2];
+static void *manual_addr_data[2];
+
+static const enum_val_t pref_address_types[] = {
+    {"lid", "LID", 0},
+    {"gid", "GID", 1},
+    {NULL, NULL, -1}
+};
+
+static const value_string iser_flags_opcode[] = {
+    { ISER_ISCSI_CTRL >> 4, "iSCSI Control-Type PDU"},
+    { ISER_HELLO >> 4, "Hello Message"},
+    { ISER_HELLORPLY >> 4, "HelloReply Message"},
+    {0, NULL},
+};
+
+static const int *flags_fields[] = {
+    &hf_iser_opcode_f,
+    &hf_iser_WSV_f,
+    &hf_iser_RSV_f,
+    NULL
+};
+static const int *hello_flags_fields[] = {
+    &hf_iser_opcode_f,
+    NULL
+};
+static const int *hellorply_flags_fields[] = {
+    &hf_iser_opcode_f,
+    &hf_iser_REJ_f,
+    NULL
+};
+
+static int dissect_packet(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+{
+    tvbuff_t *next_tvb;
+    /* Set up structures needed to add the protocol subtree and manage it */
+    proto_item *ti;
+    proto_tree *iser_tree;
+    guint offset = 0;
+    guint8 flags = tvb_get_guint8(tvb, 0);
+    guint8 vers;
+    guint8 opcode = flags & ISER_OPCODE_MASK;
+
+    /* Check if the opcode is valid */
+    switch (opcode) {
+    case ISER_ISCSI_CTRL:
+        switch (flags & ISER_SPECIFIC_MASK) {
+        case 0:
+        case ISER_WSV:
+        case ISER_RSV:
+        case ISER_RSV|ISER_WSV:
+            break;
+
+        default:
+            return 0;
+        }
+        break;
+
+    case ISER_HELLO:
+    case ISER_HELLORPLY:
+        vers = tvb_get_guint8(tvb, 1);
+        if ((vers & 0xf) != 10)
+            return 0;
+        if (((vers >> 4) & 0x0f) != 10)
+            return 0;
+        break;
+
+    default:
+        return 0;
+    }
+
+    col_set_str(pinfo->cinfo, COL_PROTOCOL, "iSER");
+    /* Clear out stuff in the info column */
+    col_clear(pinfo->cinfo, COL_INFO);
+
+    /* Set info only for hello, since for iscsi, the iscsi dissector will */
+    switch (opcode) {
+    case ISER_HELLO:
+        col_set_str(pinfo->cinfo, COL_INFO, "iSER Hello");
+        break;
+
+    case ISER_HELLORPLY:
+        col_set_str(pinfo->cinfo, COL_INFO, "iSER HelloRply");
+        break;
+    }
+
+    if (tree) {
+        /* create display subtree for the protocol */
+        ti = proto_tree_add_item(tree, hf_iser, tvb, 0, ISER_HDR_SZ, ENC_NA);
+
+        iser_tree = proto_item_add_subtree(ti, ett_iser);
+
+        switch (opcode) {
+        case ISER_ISCSI_CTRL:
+            proto_tree_add_bitmask(iser_tree, tvb, offset, hf_iser_flags,
+                    ett_iser_flags, flags_fields, ENC_LITTLE_ENDIAN);
+            offset += 4;
+            proto_tree_add_item(iser_tree, hf_iser_write_stag, tvb,
+                    offset, 4, ENC_BIG_ENDIAN);
+            offset += 4;
+            proto_tree_add_item(iser_tree, hf_iser_write_va, tvb,
+                    offset, 8, ENC_BIG_ENDIAN);
+            offset += 8;
+            proto_tree_add_item(iser_tree, hf_iser_read_stag, tvb,
+                    offset, 4, ENC_BIG_ENDIAN);
+            offset += 4;
+            proto_tree_add_item(iser_tree, hf_iser_read_va, tvb,
+                    offset, 8, ENC_BIG_ENDIAN);
+            break;
+
+        case ISER_HELLO:
+            proto_tree_add_bitmask(iser_tree, tvb, offset, hf_iser_flags,
+                    ett_iser_flags, hello_flags_fields, ENC_LITTLE_ENDIAN);
+            offset += 2;
+            proto_tree_add_item(iser_tree, hf_iser_ird, tvb,
+                    offset, 2, ENC_BIG_ENDIAN);
+            break;
+
+        case ISER_HELLORPLY:
+            proto_tree_add_bitmask(iser_tree, tvb, offset, hf_iser_flags,
+                    ett_iser_flags, hellorply_flags_fields, ENC_LITTLE_ENDIAN);
+            offset += 2;
+            proto_tree_add_item(iser_tree, hf_iser_ord, tvb,
+                    offset, 2, ENC_BIG_ENDIAN);
+            break;
+        }
+    }
+
+    if (opcode == ISER_ISCSI_CTRL) {
+            next_tvb = tvb_new_subset_remaining(tvb, ISER_HDR_SZ);
+            call_dissector(iscsi_handler, next_tvb, pinfo, tree);
+    }
+
+    return ISER_HDR_SZ;
+}
+
+static int
+dissect_iser(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree,
+        void *data _U_)
+{
+    conversation_t *conv;
+    conversation_infiniband_data *convo_data = NULL;
+
+    if (tvb_reported_length(tvb) < ISER_ISCSI_HDR_SZ)
+        return 0;
+
+    if (gPREF_MAN_EN) {
+        /* If the manual settings are enabled see if this fits - in which case we can skip
+           the following checks entirely and go straight to dissecting */
+        if (    (ADDRESSES_EQUAL(&pinfo->src, &manual_addr[0]) &&
+                 ADDRESSES_EQUAL(&pinfo->dst, &manual_addr[1]) &&
+                 (pinfo->srcport == 0xffffffff /* is unknown */ || pinfo->srcport == gPREF_QP[0]) &&
+                 (pinfo->destport == 0xffffffff /* is unknown */ || pinfo->destport == gPREF_QP[1]))    ||
+                (ADDRESSES_EQUAL(&pinfo->src, &manual_addr[1]) &&
+                 ADDRESSES_EQUAL(&pinfo->dst, &manual_addr[0]) &&
+                 (pinfo->srcport == 0xffffffff /* is unknown */ || pinfo->srcport == gPREF_QP[1]) &&
+                 (pinfo->destport == 0xffffffff /* is unknown */ || pinfo->destport == gPREF_QP[0]))    )
+            return dissect_packet(tvb, pinfo, tree);
+    }
+
+    /* first try to find a conversation between the two current hosts. in most cases this
+       will not work since we do not have the source QP. this WILL succeed when we're still
+       in the process of CM negotiations */
+    conv = find_conversation(pinfo->fd->num, &pinfo->src, &pinfo->dst,
+                             PT_IBQP, pinfo->srcport, pinfo->destport, 0);
+
+    if (!conv) {
+        /* if not, try to find an established RC channel. recall Infiniband conversations are
+           registered with one side of the channel. since the packet is only guaranteed to
+           contain the qpn of the destination, we'll use this */
+        conv = find_conversation(pinfo->fd->num, &pinfo->dst, &pinfo->dst,
+                                 PT_IBQP, pinfo->destport, pinfo->destport, NO_ADDR_B|NO_PORT_B);
+
+        if (!conv)
+            return 0;   /* nothing to do with no conversation context */
+    }
+
+    convo_data = (conversation_infiniband_data *)conversation_get_proto_data(conv, proto_ib);
+
+    if (!convo_data)
+        return 0;
+
+    if ((convo_data->service_id & SID_MASK) != SID_ULP_TCP)
+        return 0;   /* the service id doesn't match that of TCP ULP - nothing for us to do here */
+
+    if (!(value_is_in_range(gPORT_RANGE, convo_data->service_id & SID_PORT_MASK)))
+        return 0;   /* the port doesn't match that of iSER - nothing for us to do here */
+
+    return dissect_packet(tvb, pinfo, tree);
+}
+
+void
+proto_register_iser(void)
+{
+    module_t *iser_module;
+    static hf_register_info hf[] = {
+        { &hf_iser, {
+            "iSER", "iser",
+            FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL}
+        },
+        { &hf_iser_flags,
+            { "Flags", "iser.flags",
+               FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL}
+        },
+        { &hf_iser_opcode_f,
+            { "Opcode", "iser.flags.opcode",
+               FT_UINT8, BASE_HEX, VALS(iser_flags_opcode),
+               ISER_OPCODE_MASK, NULL, HFILL}
+        },
+        { &hf_iser_RSV_f,
+            { "RSV", "iser.flags.rsv",
+               FT_BOOLEAN, 8, NULL, ISER_RSV, "Read STag Valid", HFILL}
+        },
+        { &hf_iser_WSV_f,
+            { "WSV", "iser.flags.wsv",
+               FT_BOOLEAN, 8, NULL, ISER_WSV, "Write STag Valid", HFILL}
+        },
+        { &hf_iser_REJ_f,
+            { "REJ", "iser.flags.rej",
+               FT_BOOLEAN, 8, NULL, ISER_REJ, "Target reject connection", HFILL}
+        },
+        { &hf_iser_write_stag,
+            { "Write STag", "iser.write_stag",
+               FT_UINT32, BASE_HEX, NULL, 0x0, NULL, HFILL}
+        },
+        { &hf_iser_write_va,
+            { "Write Base Offset", "iser.write_base_offset",
+               FT_UINT64, BASE_HEX, NULL, 0x0, NULL, HFILL}
+        },
+        { &hf_iser_read_stag,
+            { "Read STag", "iser.read_stag",
+               FT_UINT32, BASE_HEX, NULL, 0x0, NULL, HFILL}
+        },
+        { &hf_iser_read_va,
+            { "Read Base Offset", "iser.read_base_offset",
+               FT_UINT64, BASE_HEX, NULL, 0x0, NULL, HFILL}
+        },
+        { &hf_iser_ird,
+            { "iSER-IRD", "iser.ird",
+               FT_UINT16, BASE_HEX, NULL, 0x0, NULL, HFILL}
+        },
+        { &hf_iser_ord,
+            { "iSER-ORD", "iser.ord",
+               FT_UINT16, BASE_HEX, NULL, 0x0, NULL, HFILL}
+        }
+    };
+
+    static gint *ett[] = {
+        &ett_iser,
+        &ett_iser_flags
+    };
+
+    proto_iser = proto_register_protocol (
+        "iSCSI Extensions for RDMA", /* name       */
+        "iSER",      /* short name */
+        "iser"       /* abbrev     */
+        );
+
+    proto_register_field_array(proto_iser, hf, array_length(hf));
+    proto_register_subtree_array(ett, array_length(ett));
+
+    /* Register preferences */
+    iser_module = prefs_register_protocol(proto_iser, proto_reg_handoff_iser);
+
+    prefs_register_bool_preference(iser_module, "manual_en", "Enable manual settings",
+        "Check to treat all traffic between the configured source/destination as SDP",
+        &gPREF_MAN_EN);
+
+    prefs_register_static_text_preference(iser_module, "addr_a", "Address A",
+        "Side A of the manually-configured connection");
+    prefs_register_enum_preference(iser_module, "addr_a_type", "Address Type",
+        "Type of address specified", &gPREF_TYPE[0], pref_address_types, FALSE);
+    prefs_register_string_preference(iser_module, "addr_a_id", "ID",
+        "LID/GID of address A", &gPREF_ID[0]);
+    prefs_register_uint_preference(iser_module, "addr_a_qp", "QP Number",
+        "QP Number for address A", 10, &gPREF_QP[0]);
+
+    prefs_register_static_text_preference(iser_module, "addr_b", "Address B",
+        "Side B of the manually-configured connection");
+    prefs_register_enum_preference(iser_module, "addr_b_type", "Address Type",
+        "Type of address specified", &gPREF_TYPE[1], pref_address_types, FALSE);
+    prefs_register_string_preference(iser_module, "addr_b_id", "ID",
+        "LID/GID of address B", &gPREF_ID[1]);
+    prefs_register_uint_preference(iser_module, "addr_b_qp", "QP Number",
+        "QP Number for address B", 10, &gPREF_QP[1]);
+
+    range_convert_str(&gPORT_RANGE, TCP_PORT_ISER_RANGE, MAX_TCP_PORT);
+    prefs_register_range_preference(iser_module,
+                                    "target_ports",
+                                    "Target Ports Range",
+                                    "Range of iSER target ports"
+                                    "(default " TCP_PORT_ISER_RANGE ")",
+                                    &gPORT_RANGE, MAX_TCP_PORT);
+}
+
+void
+proto_reg_handoff_iser(void)
+{
+    static gboolean initialized = FALSE;
+
+    if (!initialized) {
+        new_create_dissector_handle(dissect_iser, proto_iser);
+        heur_dissector_add("infiniband.payload", dissect_iser, proto_iser);
+        heur_dissector_add("infiniband.mad.cm.private", dissect_iser, proto_iser);
+
+        /* allocate enough space in the addresses to store the largest address (a GID) */
+        manual_addr_data[0] = wmem_alloc(wmem_epan_scope(), GID_SIZE);
+        manual_addr_data[1] = wmem_alloc(wmem_epan_scope(), GID_SIZE);
+
+        iscsi_handler = find_dissector("iscsi");
+        ib_handler = find_dissector("infiniband");
+        proto_ib = dissector_handle_get_protocol_index(ib_handler);
+
+        initialized = TRUE;
+    }
+
+    if (gPREF_MAN_EN) {
+        /* the manual setting is enabled, so parse the settings into the address type */
+        gboolean error_occured = FALSE;
+        char *not_parsed;
+        int i;
+
+        for (i = 0; i < 2; i++) {
+            if (gPREF_TYPE[i] == 0) {   /* LID */
+                errno = 0;  /* reset any previous error indicators */
+                *((guint16*)manual_addr_data[i]) = (guint16)strtoul(gPREF_ID[i], &not_parsed, 0);
+                if (errno || *not_parsed != '\0') {
+                    error_occured = TRUE;
+                } else {
+                    SET_ADDRESS(&manual_addr[i], AT_IB, sizeof(guint16), manual_addr_data[i]);
+                }
+            } else {    /* GID */
+                if (!str_to_ip6(gPREF_ID[i], manual_addr_data[i]) ) {
+                    error_occured = TRUE;
+                } else {
+                    SET_ADDRESS(&manual_addr[i], AT_IB, GID_SIZE, manual_addr_data[i]);
+                }
+            }
+
+            if (error_occured) {
+                /* an invalid id was specified - disable manual settings until it's fixed */
+                gPREF_MAN_EN = FALSE;
+                break;
+            }
+        }
+    }
+}
+
+/*
+ * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
+ *
+ * Local variables:
+ * c-basic-offset: 4
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * vi: set shiftwidth=4 tabstop=8 expandtab:
+ * :indentSize=4:tabSize=8:noTabs=true:
+ */