epan/dissectors/packet-scop.c

   1 /* packet-scop.c
   2  * Owen Kirby <osk@exegin.com>
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #include "config.h"
  26
  27 #include <string.h>
  28 #include <epan/packet.h>
  29 #include <epan/prefs.h>
  30 #include "packet-tcp.h"
  31
  32 /* Default SCOP Port numbers. */
  33 #define SCOP_DEFAULT_PORT           17755
  34 #define SCOP_DEFAULT_PORT_SECURED   17756
  35
  36 /* Structure to contain information from the SCoP packet. */
  37 typedef struct {
  38     guint8      transport;
  39     guint8      version;
  40     guint16     length;
  41     gboolean    encrypted;
  42     guint8      service;
  43     guint8      type;
  44 } scop_packet;
  45
  46 /* Header definitions for use with the TCP transport layer. */
  47 #define SCOP_HEADER_LENGTH      4
  48 #define SCOP_LENGTH_OFFSET      2
  49
  50 /* SCoP Transport Types */
  51 #define SCOP_TRANSPORT_UDP        1
  52 #define SCOP_TRANSPORT_TCP        2
  53 #define SCOP_TRANSPORT_UDP_CCM  129
  54 #define SCOP_TRANSPORT_TCP_CCM  130
  55 #define SCOP_TRANSPORT_TCP_SSL  131
  56
  57 /* Service Identifier Field */
  58 #define SCOP_SERVICE_SCOP       0x00
  59 #define SCOP_SERVICE_BRIDGE     0x01
  60 #define SCOP_SERVICE_GATEWAY    0x02
  61
  62 /* SCoP Command Values */
  63 #define SCOP_CMD_HELLO          0x00
  64 #define SCOP_CMD_HELLO_RESP     0x01
  65 #define SCOP_CMD_HELLO_ACK      0x02
  66 #define SCOP_CMD_GOODBYE        0x04
  67 #define SCOP_CMD_GOODBYE_RESP   0x05
  68 #define SCOP_CMD_KEEPALIVE_PING 0x06
  69 #define SCOP_CMD_KEEPALIVE_PONG 0x07
  70
  71 /* Bridge Command type values. */
  72 #define SCOP_BRIDGE_CMD         0x00
  73 #define SCOP_BRIDGE_MSG         0x01
  74
  75 /*  Function declarations */
  76 void proto_reg_handoff_scop(void);
  77
  78 static void dissect_scop_zip       (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
  79 static void dissect_scop_bridge    (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
  80
  81 static guint get_scop_length(packet_info *pinfo _U_, tvbuff_t *tvb, int offset);
  82
  83 /*  Initialize protocol and registered fields */
  84 static int proto_scop = -1;
  85 static int hf_scop_transport = -1;
  86 static int hf_scop_version = -1;
  87 static int hf_scop_length = -1;
  88 static int hf_scop_service = -1;
  89 static int hf_scop_type = -1;
  90 static int hf_scop_status = -1;
  91
  92 static gint ett_scop = -1;
  93
  94 static const value_string scop_transports [] = {
  95     { SCOP_TRANSPORT_UDP,       "UDP Mode 1" },
  96     { SCOP_TRANSPORT_TCP,       "TCP Mode 2" },
  97     { SCOP_TRANSPORT_UDP_CCM,   "UDP Mode 1 with CCM* Security" },
  98     { SCOP_TRANSPORT_TCP_CCM,   "TCP Mode 2 with CCM* Security" },
  99     { SCOP_TRANSPORT_TCP_SSL,   "TCP Mode 3 with SSL/TSL Tunnel" },
 100     { 0, NULL }
 101 };
 102
 103 static const value_string scop_types [] = {
 104     { SCOP_CMD_HELLO,           "Hello" },
 105     { SCOP_CMD_HELLO_RESP,      "Hello Response" },
 106     { SCOP_CMD_HELLO_ACK,       "Hello Acknowledgment" },
 107     { SCOP_CMD_GOODBYE,         "Goodbye" },
 108     { SCOP_CMD_GOODBYE_RESP,    "Goodbye Response" },
 109     { SCOP_CMD_KEEPALIVE_PING,  "Keep Alive Ping" },
 110     { SCOP_CMD_KEEPALIVE_PONG,  "Keep Alive Pong" },
 111     { 0, NULL }
 112 };
 113
 114 static const value_string scop_services [] = {
 115     { SCOP_SERVICE_SCOP,    "SCoP" },
 116     { SCOP_SERVICE_BRIDGE,  "Bridge" },
 117     { SCOP_SERVICE_GATEWAY, "Gateway" },
 118     { 0, NULL }
 119 };
 120
 121 static guint32  gPREF_scop_port         = SCOP_DEFAULT_PORT;
 122 static guint32  gPREF_scop_port_secured = SCOP_DEFAULT_PORT_SECURED;
 123
 124 /*  Dissector handle */
 125 static dissector_handle_t data_handle;
 126 static dissector_handle_t ieee802154_handle;
 127
 128 /*FUNCTION:------------------------------------------------------
 129  *  NAME
 130  *      dissect_scop
 131  *  DESCRIPTION
 132  *      ZigBee SCoP packet dissection routine for Wireshark.
 133  *  PARAMETERS
 134  *      tvbuff_t    *tvb    - pointer to buffer containing raw packet.
 135  *      packet_info *pinfo  - pointer to packet information fields
 136  *      proto_tree  *tree   - pointer to data tree Wireshark uses to display packet.
 137  *  RETURNS
 138  *      void
 139  *---------------------------------------------------------------
 140  */
 141 static int
 142 dissect_scop(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
 143 {
 144     tvbuff_t    *next_tvb;
 145     proto_item  *proto_root;
 146     proto_tree  *scop_tree;
 147
 148     guint        offset = 0;
 149     scop_packet  packet;
 150
 151     memset(&packet, 0, sizeof(packet));
 152
 153     /* Set the protocol name. */
 154     col_set_str(pinfo->cinfo, COL_PROTOCOL, "SCoP");
 155
 156     /* Clear the info column. */
 157     col_clear(pinfo->cinfo, COL_INFO);
 158
 159     /* Create the protocol display tree. */
 160     proto_root = proto_tree_add_protocol_format(tree, proto_scop, tvb, 0, tvb_length(tvb),
 161                                                 "ZigBee SCoP");
 162     scop_tree = proto_item_add_subtree(proto_root, ett_scop);
 163
 164     /* Extract the SCoP Transport type. */
 165     packet.transport = tvb_get_guint8(tvb, offset);
 166     proto_tree_add_uint(scop_tree, hf_scop_transport, tvb, offset, 1, packet.transport);
 167     offset += 1;
 168
 169     /* Extract the SCoP Version. */
 170     packet.version = tvb_get_guint8(tvb, offset);
 171     proto_tree_add_uint(scop_tree, hf_scop_version, tvb, offset, 1, packet.version);
 172     offset += 1;
 173
 174     /* Extract the SCoP Packet length. */
 175     packet.length = tvb_get_ntohs(tvb, offset);
 176     proto_tree_add_uint(scop_tree, hf_scop_length, tvb, offset, 2, packet.length);
 177     offset += 2;
 178
 179     if (   (packet.transport == SCOP_TRANSPORT_UDP_CCM)
 180         || (packet.transport == SCOP_TRANSPORT_TCP_CCM)) {
 181         /* Decryption Failed. */
 182         return offset;
 183     }
 184     next_tvb = tvb;
 185
 186     /* Extract the service type. */
 187     packet.service = tvb_get_guint8(next_tvb, offset);
 188     proto_tree_add_uint(scop_tree, hf_scop_service, next_tvb, offset, 1, packet.service);
 189     offset += 1;
 190
 191     /* Call the appropriate helper routine to dissect based on the service type. */
 192     switch (packet.service) {
 193         case SCOP_SERVICE_SCOP:
 194             dissect_scop_zip(tvb_new_subset_remaining(next_tvb, offset), pinfo, scop_tree);
 195             break;
 196         case SCOP_SERVICE_BRIDGE:
 197             dissect_scop_bridge(tvb_new_subset_remaining(next_tvb, offset), pinfo, scop_tree);
 198             break;
 199         case SCOP_SERVICE_GATEWAY:
 200             /* Nothing yet defined for the gateway. Fall-Through. */
 201         default:
 202             /* Unknown Service Type. */
 203             call_dissector(data_handle, tvb_new_subset_remaining(next_tvb, offset), pinfo, tree);
 204             break;
 205     }
 206
 207     return tvb_length(tvb);
 208 } /* dissect_scop() */
 209
 210 /*FUNCTION:------------------------------------------------------
 211  *  NAME
 212  *      get_scop_length
 213  *  DESCRIPTION
 214  *      Returns the length of a SCoP packet. For use with the TCP
 215  *      transport type.
 216  *  PARAMETERS
 217  *      packet_info *pinfo  - pointer to packet information fields
 218  *      tvbuff_t    *tvb    - pointer to buffer containing the packet.
 219  *      int         offset  - beginning of packet.
 220  *  RETURNS
 221  *      guint               - Length of SCoP packet
 222  *---------------------------------------------------------------
 223  */
 224 static guint
 225 get_scop_length(packet_info *pinfo _U_, tvbuff_t *tvb, int offset)
 226 {
 227     /* Byte  0:   Protocol Type.
 228      * Byte  1:   Protocol Version.
 229      * Bytes 2-3: Packet Length (network order).
 230      */
 231     return tvb_get_ntohs(tvb, offset + SCOP_LENGTH_OFFSET);
 232 } /* get_scop_length */
 233
 234 /*FUNCTION:------------------------------------------------------
 235  *  NAME
 236  *      dissect_scop_tcp
 237  *  DESCRIPTION
 238  *      ZigBee SCoP packet dissection routine for Wireshark.
 239  *      for use with TCP ports.
 240  *  PARAMETERS
 241  *      tvbuff_t    *tvb    - pointer to buffer containing raw packet.
 242  *      packet_info *pinfo  - pointer to packet information fields
 243  *      proto_tree  *tree   - pointer to data tree Wireshark uses to display packet.
 244  *  RETURNS
 245  *      void
 246  *---------------------------------------------------------------
 247  */
 248 static int
 249 dissect_scop_tcp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data)
 250 {
 251     tcp_dissect_pdus(tvb, pinfo, tree, TRUE, SCOP_HEADER_LENGTH, get_scop_length, dissect_scop, data);
 252     return tvb_length(tvb);
 253 } /* dissect_scop_tcp */
 254
 255
 256 /*FUNCTION:------------------------------------------------------
 257  *  NAME
 258  *      dissect_scop_zip
 259  *  DESCRIPTION
 260  *      Intermediate dissector for the SCoP service type.
 261  *  PARAMETERS
 262  *      tvbuff_t    *tvb    - pointer to buffer containing raw packet.
 263  *      packet_info *pinfo  - pointer to packet information fields
 264  *      proto_tree  *tree   - pointer to data tree Wireshark uses to display packet.
 265  *  RETURNS
 266  *      void
 267  *---------------------------------------------------------------
 268  */
 269 static void
 270 dissect_scop_zip(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 271 {
 272     guint       offset = 0;
 273     guint8      type = tvb_get_guint8(tvb, offset);
 274     guint16     status;
 275
 276     /* Display the Packet type*/
 277     proto_tree_add_uint(tree, hf_scop_type, tvb, offset, 1, type);
 278     proto_item_append_text(tree, ", %s", val_to_str_const(type, scop_types, "Reserved Type"));
 279     col_set_str(pinfo->cinfo, COL_INFO, val_to_str_const(type, scop_types, "Reserved Type"));
 280     offset += 2;
 281
 282     if (type == SCOP_CMD_HELLO_RESP) {
 283         status = tvb_get_ntohs(tvb, 1);
 284         proto_tree_add_uint_format_value(tree, hf_scop_status, tvb, offset, 2, status, "%s", (status==0x0000)?"Success":"Failure");
 285         offset += 2;
 286     }
 287
 288     /* If there are any bytes left over, pass them to the data dissector. */
 289     if (offset < tvb_length(tvb)) {
 290         tvbuff_t    *payload_tvb = tvb_new_subset_remaining(tvb, offset);
 291         proto_tree  *root        = proto_tree_get_root(tree);
 292         call_dissector(data_handle, payload_tvb, pinfo, root);
 293     }
 294 } /* dissect_scop_zip() */
 295
 296 /*FUNCTION:------------------------------------------------------
 297  *  NAME
 298  *      dissect_scop_bridge
 299  *  DESCRIPTION
 300  *      Intermediate dissector for the Bridge service type.
 301  *  PARAMETERS
 302  *      tvbuff_t    *tvb    - pointer to buffer containing raw packet.
 303  *      packet_info *pinfo  - pointer to packet information fields
 304  *      proto_tree  *tree   - pointer to data tree Wireshark uses to display packet.
 305  *  RETURNS
 306  *      void
 307  *---------------------------------------------------------------
 308  */
 309 static void
 310 dissect_scop_bridge(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 311 {
 312     call_dissector(ieee802154_handle, tvb, pinfo, proto_tree_get_root(tree));
 313 } /* dissect_scop_bridge() */
 314
 315 /*FUNCTION:------------------------------------------------------
 316  *  NAME
 317  *      proto_register_scop
 318  *  DESCRIPTION
 319  *      SCoP protocol registration.
 320  *  PARAMETERS
 321  *      none
 322  *  RETURNS
 323  *      void
 324  *---------------------------------------------------------------
 325  */
 326 void proto_register_scop(void)
 327 {
 328     module_t *scop_module;
 329
 330     static hf_register_info hf[] = {
 331         { &hf_scop_transport,
 332         { "Transport Type",         "scop.transport", FT_UINT8, BASE_DEC, VALS(scop_transports), 0x0,
 333             "The type of transport used.", HFILL }},
 334
 335         { &hf_scop_version,
 336         { "Version",                "scop.version", FT_UINT8, BASE_DEC, NULL, 0x0,
 337             "The version of the sniffer.", HFILL }},
 338
 339         { &hf_scop_length,
 340         { "Length",                 "scop.length", FT_UINT16, BASE_DEC, NULL, 0x0,
 341             NULL, HFILL }},
 342
 343         { &hf_scop_service,
 344         { "Service Identifier",     "scop.service", FT_UINT8, BASE_DEC, VALS(scop_services), 0x0,
 345             NULL, HFILL }},
 346
 347         { &hf_scop_type,
 348         { "Packet Type",            "scop.type", FT_UINT8, BASE_DEC, VALS(scop_types), 0x0,
 349             "Service-specific packet type.", HFILL }},
 350
 351         { &hf_scop_status,
 352         { "Status",                 "scop.status", FT_UINT16, BASE_HEX, NULL, 0x0,
 353             "Status of the SCoP Command.", HFILL }}
 354     };
 355
 356     static gint *ett[] = {
 357         &ett_scop
 358     };
 359
 360     /*  Register protocol name and description. */
 361     proto_scop = proto_register_protocol("ZigBee SCoP", "SCoP", "scop");
 362
 363     /*  Register header fields and subtrees. */
 364     proto_register_field_array(proto_scop, hf, array_length(hf));
 365     proto_register_subtree_array(ett, array_length(ett));
 366
 367     /*  Register preferences module */
 368     scop_module = prefs_register_protocol(proto_scop, proto_reg_handoff_scop);
 369
 370     /*  Register preferences */
 371     prefs_register_uint_preference(scop_module, "port", "SCoP Port",
 372                  "Set the port for SCoP\n",
 373                  10, &gPREF_scop_port);
 374     prefs_register_uint_preference(scop_module, "port_secure", "SCoP Secured Port",
 375                  "Set the port for secured SCoP\n",
 376                  10, &gPREF_scop_port_secured);
 377
 378     /*  Register dissector with Wireshark. */
 379     new_register_dissector("scop.udp", dissect_scop, proto_scop);
 380     new_register_dissector("scop.tcp", dissect_scop_tcp, proto_scop);
 381 } /* proto_register_scop() */
 382
 383 /*FUNCTION:------------------------------------------------------
 384  *  NAME
 385  *      proto_reg_handoff_scop
 386  *  DESCRIPTION
 387  *      Registers the zigbee dissector with Wireshark.
 388  *      Will be called every time 'apply' is pressed in the preferences menu.
 389  *  PARAMETERS
 390  *      none
 391  *  RETURNS
 392  *      void
 393  *---------------------------------------------------------------
 394  */
 395 void proto_reg_handoff_scop(void)
 396 {
 397     static gboolean inited = FALSE;
 398     static guint32  lastPort;
 399     static guint32  lastPort_secured;
 400
 401     static dissector_handle_t  scop_udp_handle;
 402     static dissector_handle_t  scop_tcp_handle;
 403
 404     if (!inited){
 405         scop_udp_handle     = find_dissector("scop.udp");
 406         scop_tcp_handle     = find_dissector("scop.tcp");
 407         ieee802154_handle   = find_dissector("wpan_nofcs");
 408         data_handle         = find_dissector("data");
 409         inited = TRUE;
 410     } else {
 411         dissector_delete_uint("udp.port", lastPort, scop_udp_handle);
 412         dissector_delete_uint("tcp.port", lastPort, scop_tcp_handle);
 413         dissector_delete_uint("udp.port", lastPort_secured, scop_udp_handle);
 414         dissector_delete_uint("tcp.port", lastPort_secured, scop_tcp_handle);
 415     }
 416     dissector_add_uint("udp.port", gPREF_scop_port, scop_udp_handle);
 417     dissector_add_uint("tcp.port", gPREF_scop_port, scop_tcp_handle);
 418     dissector_add_uint("udp.port", gPREF_scop_port_secured, scop_udp_handle);
 419     dissector_add_uint("tcp.port", gPREF_scop_port_secured, scop_tcp_handle);
 420
 421     lastPort         = gPREF_scop_port;
 422     lastPort_secured = gPREF_scop_port_secured;
 423 } /* proto_reg_handoff_scop */
 424