asn1/sabp/packet-sabp-template.c

   1 /* packet-sbap.c
   2  * Routines for UTRAN Iu-BC Interface: Service Area Broadcast Protocol (SBAP) packet dissection
   3  * Copyright 2007, Tomas Kukosa <tomas.kukosa@siemens.com>
   4  *
   5  * $Id$
   6  *
   7  * Wireshark - Network traffic analyzer
   8  * By Gerald Combs <gerald@wireshark.org>
   9  * Copyright 1998 Gerald Combs
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  24  *
  25  * Ref: 3GPP TS 25.419 version  V9.0.0 (2009-12)
  26  */
  27
  28 #include "config.h"
  29
  30 #include <glib.h>
  31 #include <epan/packet.h>
  32
  33 #include <epan/asn1.h>
  34
  35 #include "packet-tcp.h"
  36 #include "packet-per.h"
  37 #include "packet-e212.h"
  38 #include "packet-gsm_map.h"
  39 #include "packet-gsm_sms.h"
  40 #include <epan/sctpppids.h>
  41 #include "packet-cell_broadcast.h"
  42
  43 #define PNAME  "UTRAN IuBC interface SABP signaling"
  44 #define PSNAME "SABP"
  45 #define PFNAME "sabp"
  46
  47 #include "packet-sabp-val.h"
  48
  49 void proto_register_sabp(void);
  50 void proto_reg_handoff_sabp(void);
  51
  52 /* Initialize the protocol and registered fields */
  53 static int proto_sabp = -1;
  54
  55 static int hf_sabp_no_of_pages = -1;
  56 static int hf_sabp_cb_inf_len = -1;
  57 static int hf_sabp_cb_msg_inf_page = -1;
  58 static int hf_sabp_cbs_page_content = -1;
  59 #include "packet-sabp-hf.c"
  60
  61 /* Initialize the subtree pointers */
  62 static int ett_sabp = -1;
  63 static int ett_sabp_e212 = -1;
  64 static int ett_sabp_cbs_data_coding = -1;
  65 static int ett_sabp_bcast_msg = -1;
  66 static int ett_sabp_cbs_serial_number = -1;
  67 static int ett_sabp_cbs_new_serial_number = -1;
  68 static int ett_sabp_cbs_page = -1;
  69 static int ett_sabp_cbs_page_content = -1;
  70
  71 #include "packet-sabp-ett.c"
  72
  73 /* Global variables */
  74 static guint32 ProcedureCode;
  75 static guint32 ProtocolIE_ID;
  76 static guint32 ProtocolExtensionID;
  77 static guint8 sms_encoding;
  78
  79 /* desegmentation of sabp over TCP */
  80 static gboolean gbl_sabp_desegment = TRUE;
  81
  82 /* Dissector tables */
  83 static dissector_table_t sabp_ies_dissector_table;
  84 static dissector_table_t sabp_extension_dissector_table;
  85 static dissector_table_t sabp_proc_imsg_dissector_table;
  86 static dissector_table_t sabp_proc_sout_dissector_table;
  87 static dissector_table_t sabp_proc_uout_dissector_table;
  88
  89 static int dissect_ProtocolIEFieldValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
  90 static int dissect_ProtocolExtensionFieldExtensionValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
  91 static int dissect_InitiatingMessageValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
  92 static int dissect_SuccessfulOutcomeValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
  93 static int dissect_UnsuccessfulOutcomeValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *);
  94 static void dissect_sabp_cb_data(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
  95
  96 #include "packet-sabp-fn.c"
  97
  98 static int dissect_ProtocolIEFieldValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
  99 {
 100   return (dissector_try_uint(sabp_ies_dissector_table, ProtocolIE_ID, tvb, pinfo, tree)) ? tvb_length(tvb) : 0;
 101 }
 102
 103 static int dissect_ProtocolExtensionFieldExtensionValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
 104 {
 105   return (dissector_try_uint(sabp_extension_dissector_table, ProtocolExtensionID, tvb, pinfo, tree)) ? tvb_length(tvb) : 0;
 106 }
 107
 108 static int dissect_InitiatingMessageValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
 109 {
 110   return (dissector_try_uint(sabp_proc_imsg_dissector_table, ProcedureCode, tvb, pinfo, tree)) ? tvb_length(tvb) : 0;
 111 }
 112
 113 static int dissect_SuccessfulOutcomeValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
 114 {
 115   return (dissector_try_uint(sabp_proc_sout_dissector_table, ProcedureCode, tvb, pinfo, tree)) ? tvb_length(tvb) : 0;
 116 }
 117
 118 static int dissect_UnsuccessfulOutcomeValue(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
 119 {
 120   return (dissector_try_uint(sabp_proc_uout_dissector_table, ProcedureCode, tvb, pinfo, tree)) ? tvb_length(tvb) : 0;
 121 }
 122
 123
 124 /* 3GPP TS 23.041 version 11.4.0
 125  * 9.4.2.2.5 CB Data
 126  */
 127 static void
 128 dissect_sabp_cb_data(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 129 {
 130         proto_item *item, *cbs_page_item;
 131         proto_tree *subtree;
 132         tvbuff_t *page_tvb, *unpacked_tvb;
 133         int offset = 0;
 134         int n;
 135         guint8 nr_pages, len, cb_inf_msg_len;
 136
 137
 138         /* Octet 1 Number-of-Pages */
 139         nr_pages = tvb_get_guint8(tvb, offset);
 140         proto_tree_add_item(tree, hf_sabp_no_of_pages, tvb, offset, 1, ENC_BIG_ENDIAN);
 141         offset++;
 142         /*
 143          * NOTE: n equal to or less than 15
 144          */
 145         if(nr_pages > 15){
 146                 /* Error */
 147                 return;
 148         }
 149         for (n = 0; n < nr_pages; n++) {
 150                 item = proto_tree_add_text(tree, tvb, offset, 83, "CB page %u data",  n+1);
 151                 subtree = proto_item_add_subtree(item, ett_sabp_cbs_page);
 152                 /* octet 2 - 83 CBS-Message-Information-Page 1  */
 153                 cbs_page_item = proto_tree_add_item(subtree, hf_sabp_cb_msg_inf_page, tvb, offset, 82, ENC_BIG_ENDIAN);
 154                 cb_inf_msg_len = tvb_get_guint8(tvb,offset+82);
 155                 page_tvb = tvb_new_subset(tvb, offset, cb_inf_msg_len, cb_inf_msg_len);
 156                 unpacked_tvb = dissect_cbs_data(sms_encoding, page_tvb, subtree, pinfo, 0);
 157                 len = tvb_length(unpacked_tvb);
 158                 if (unpacked_tvb != NULL){
 159                         if (tree != NULL){
 160                                 proto_tree *cbs_page_subtree = proto_item_add_subtree(cbs_page_item, ett_sabp_cbs_page_content);
 161                                 proto_tree_add_string(cbs_page_subtree, hf_sabp_cbs_page_content, unpacked_tvb, 0, len, tvb_get_ephemeral_string(unpacked_tvb, 0, len));
 162                         }
 163                 }
 164
 165                 offset = offset+82;
 166                 /* 84 CBS-Message-Information-Length 1 */
 167                 proto_tree_add_item(subtree, hf_sabp_cb_inf_len, tvb, offset, 1, ENC_BIG_ENDIAN);
 168                 offset++;
 169         }
 170
 171
 172 }
 173
 174 static guint
 175 get_sabp_pdu_len(packet_info *pinfo _U_, tvbuff_t *tvb, int offset)
 176 {
 177         guint32 type_length;
 178         int bit_offset;
 179         asn1_ctx_t asn1_ctx;
 180         asn1_ctx_init(&asn1_ctx, ASN1_ENC_PER, TRUE, pinfo);
 181
 182         /* Length should be in the 3:d octet */
 183         offset = offset + 3;
 184
 185         bit_offset = offset<<3;
 186         /* Get the length of the sabp packet. offset in bits  */
 187         dissect_per_length_determinant(tvb, bit_offset, &asn1_ctx, NULL, -1, &type_length);
 188
 189         /*
 190          * Return the length of the PDU
 191          * which is 3 + the length of the length, we only care about length up to 16K
 192          * ("n" less than 128) a single octet containing "n" with bit 8 set to zero;
 193          * ("n" less than 16K) two octets containing "n" with bit 8 of the first octet set to 1 and bit 7 set to zero;
 194          */
 195         if (type_length < 128)
 196                 return type_length+4;
 197
 198         return type_length+5;
 199 }
 200
 201
 202 static void
 203 dissect_sabp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 204 {
 205         proto_item      *sabp_item = NULL;
 206         proto_tree      *sabp_tree = NULL;
 207
 208         /* make entry in the Protocol column on summary display */
 209         col_set_str(pinfo->cinfo, COL_PROTOCOL, PSNAME);
 210
 211         /* create the sbap protocol tree */
 212         sabp_item = proto_tree_add_item(tree, proto_sabp, tvb, 0, -1, ENC_NA);
 213         sabp_tree = proto_item_add_subtree(sabp_item, ett_sabp);
 214
 215         dissect_SABP_PDU_PDU(tvb, pinfo, sabp_tree, NULL);
 216 }
 217
 218 /* Note a little bit of a hack assumes length max takes two bytes and that the length starts at byte 4 */
 219 static void
 220 dissect_sabp_tcp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 221 {
 222         tcp_dissect_pdus(tvb, pinfo, tree, gbl_sabp_desegment, 5,
 223                                          get_sabp_pdu_len, dissect_sabp);
 224 }
 225
 226 /*--- proto_register_sbap -------------------------------------------*/
 227 void proto_register_sabp(void) {
 228
 229   /* List of fields */
 230
 231   static hf_register_info hf[] = {
 232     { &hf_sabp_no_of_pages,
 233       { "Number-of-Pages", "sabp.no_of_pages",
 234         FT_UINT8, BASE_DEC, NULL, 0,
 235         NULL, HFILL }},
 236     { &hf_sabp_cb_msg_inf_page,
 237       { "CBS-Message-Information-Page", "sabp.cb_msg_inf_page",
 238         FT_BYTES, BASE_NONE, NULL, 0,
 239         NULL, HFILL }},
 240     { &hf_sabp_cbs_page_content,
 241       { "CBS Page Content", "sabp.cb_page_content",
 242         FT_STRING, BASE_NONE, NULL, 0,
 243         NULL, HFILL }},
 244     { &hf_sabp_cb_inf_len,
 245       { "CBS-Message-Information-Length", "sabp.cb_inf_len",
 246         FT_UINT8, BASE_DEC, NULL, 0,
 247         NULL, HFILL }},
 248
 249 #include "packet-sabp-hfarr.c"
 250   };
 251
 252   /* List of subtrees */
 253   static gint *ett[] = {
 254                   &ett_sabp,
 255                   &ett_sabp_e212,
 256                   &ett_sabp_cbs_data_coding,
 257                   &ett_sabp_bcast_msg,
 258           &ett_sabp_cbs_serial_number,
 259           &ett_sabp_cbs_new_serial_number,
 260                   &ett_sabp_cbs_page,
 261                   &ett_sabp_cbs_page_content,
 262 #include "packet-sabp-ettarr.c"
 263   };
 264
 265
 266   /* Register protocol */
 267   proto_sabp = proto_register_protocol(PNAME, PSNAME, PFNAME);
 268   /* Register fields and subtrees */
 269   proto_register_field_array(proto_sabp, hf, array_length(hf));
 270   proto_register_subtree_array(ett, array_length(ett));
 271
 272   /* Register dissector */
 273   register_dissector("sabp", dissect_sabp, proto_sabp);
 274   register_dissector("sabp.tcp", dissect_sabp_tcp, proto_sabp);
 275
 276   /* Register dissector tables */
 277   sabp_ies_dissector_table = register_dissector_table("sabp.ies", "SABP-PROTOCOL-IES", FT_UINT32, BASE_DEC);
 278   sabp_extension_dissector_table = register_dissector_table("sabp.extension", "SABP-PROTOCOL-EXTENSION", FT_UINT32, BASE_DEC);
 279   sabp_proc_imsg_dissector_table = register_dissector_table("sabp.proc.imsg", "SABP-ELEMENTARY-PROCEDURE InitiatingMessage", FT_UINT32, BASE_DEC);
 280   sabp_proc_sout_dissector_table = register_dissector_table("sabp.proc.sout", "SABP-ELEMENTARY-PROCEDURE SuccessfulOutcome", FT_UINT32, BASE_DEC);
 281   sabp_proc_uout_dissector_table = register_dissector_table("sabp.proc.uout", "SABP-ELEMENTARY-PROCEDURE UnsuccessfulOutcome", FT_UINT32, BASE_DEC);
 282
 283 }
 284
 285
 286 /*--- proto_reg_handoff_sbap ---------------------------------------*/
 287 void
 288 proto_reg_handoff_sabp(void)
 289 {
 290   dissector_handle_t sabp_handle;
 291   dissector_handle_t sabp_tcp_handle;
 292
 293   sabp_handle = find_dissector("sabp");
 294   sabp_tcp_handle = find_dissector("sabp.tcp");
 295   dissector_add_uint("udp.port", 3452, sabp_handle);
 296   dissector_add_uint("tcp.port", 3452, sabp_tcp_handle);
 297   dissector_add_uint("sctp.ppi", SABP_PAYLOAD_PROTOCOL_ID,   sabp_handle);
 298
 299 #include "packet-sabp-dis-tab.c"
 300
 301 }
 302
 303