Don't let the user specify a maximum capture file size if they're not
[obnox/wireshark/wip.git] / packet-mtp3.c
1 /* packet-mtp3.c
2  * Routines for Message Transfer Part Level 3 dissection
3  * Copyright 2001, Michael Tuexen <Michael.Tuexen@icn.siemens.de>
4  *
5  * $Id: packet-mtp3.c,v 1.8 2001/12/11 03:04:26 gram Exp $
6  *
7  * Ethereal - Network traffic analyzer
8  * By Gerald Combs <gerald@ethereal.com>
9  * Copyright 1998 Gerald Combs
10  *
11  * Copied from README.developer
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26  */
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <glib.h>
33
34 #include "packet.h"
35 #include "prefs.h"
36
37 /* Initialize the protocol and registered fields */
38 static int proto_mtp3  = -1;
39 static module_t *mtp3_module;
40
41 static int hf_mtp3_service_indicator = -1;
42 static int hf_mtp3_network_indicator = -1;
43 static int hf_mtp3_itu_spare = -1;
44 static int hf_mtp3_ansi_priority = -1;
45 static int hf_mtp3_itu_opc = -1;
46 static int hf_mtp3_opc_network = -1;
47 static int hf_mtp3_opc_cluster = -1;
48 static int hf_mtp3_opc_member = -1;
49 static int hf_mtp3_itu_dpc = -1;
50 static int hf_mtp3_dpc_network = -1;
51 static int hf_mtp3_dpc_cluster = -1;
52 static int hf_mtp3_dpc_member = -1;
53 static int hf_mtp3_itu_sls = -1;
54 static int hf_mtp3_ansi_sls = -1;
55
56 /* Initialize the subtree pointers */
57 static gint ett_mtp3 = -1;
58 static gint ett_mtp3_sio = -1;
59 static gint ett_mtp3_label = -1;
60 static gint ett_mtp3_label_dpc = -1;
61 static gint ett_mtp3_label_opc = -1;
62
63 static dissector_table_t mtp3_sio_dissector_table;
64 typedef enum {
65   ITU_STANDARD  = 1,
66   ANSI_STANDARD = 2
67 } Standard_Type;
68
69
70 static Standard_Type mtp3_standard = ITU_STANDARD;
71
72 #define SIO_LENGTH                1
73
74 #define ITU_ROUTING_LABEL_LENGTH  4
75 #define ITU_HEADER_LENGTH         (SIO_LENGTH + ITU_ROUTING_LABEL_LENGTH)
76 #define ITU_SLS_LENGTH            1
77
78 #define SIO_OFFSET                0
79 #define ITU_SLS_OFFSET            (SIO_OFFSET + ITU_HEADER_LENGTH - ITU_SLS_LENGTH)
80 #define ITU_ROUTING_LABEL_OFFSET  (SIO_OFFSET + SIO_LENGTH)
81 #define ITU_MTP_PAYLOAD_OFFSET    (SIO_OFFSET + ITU_HEADER_LENGTH)
82
83 #define ANSI_DPC_LENGTH           3 
84 #define ANSI_OPC_LENGTH           3
85 #define ANSI_SLS_LENGTH           1
86 #define ANSI_ROUTING_LABEL_LENGTH (ANSI_DPC_LENGTH + ANSI_OPC_LENGTH + ANSI_SLS_LENGTH)
87 #define ANSI_HEADER_LENGTH        (SIO_LENGTH + ANSI_ROUTING_LABEL_LENGTH)
88
89 #define ANSI_ROUTING_LABEL_OFFSET (SIO_OFFSET + SIO_LENGTH)
90 #define ANSI_DPC_OFFSET           ANSI_ROUTING_LABEL_OFFSET
91 #define ANSI_OPC_OFFSET           (ANSI_DPC_OFFSET + ANSI_DPC_LENGTH)
92 #define ANSI_SLS_OFFSET           (ANSI_OPC_OFFSET + ANSI_OPC_LENGTH)
93 #define ANSI_MTP_PAYLOAD_OFFSET   (SIO_OFFSET + ANSI_HEADER_LENGTH)
94
95 #define SERVICE_INDICATOR_MASK         0x0F
96 #define SPARE_MASK                     0x30
97 #define ANSI_PRIORITY_MASK             SPARE_MASK
98 #define NETWORK_INDICATOR_MASK         0xC0
99 #define ITU_DPC_MASK                   0x00003FFF
100 #define ITU_OPC_MASK                   0x0FFFC000
101 #define ITU_SLS_MASK                   0xF0000000
102
103 #define ANSI_NETWORK_MASK              0x0000FF
104 #define ANSI_CLUSTER_MASK              0x00FF00
105 #define ANSI_MEMBER_MASK               0xFF0000
106 #define ANSI_5BIT_SLS_MASK             0x1F
107 /* TODO: eventually add support for ANSI 8-bit SLS */
108 #define ANSI_8BIT_SLS_MASK             0xFF
109
110 static const value_string service_indicator_code_vals[] = {
111         { 0x0,  "Signalling Network Management Message (SNM)" },
112         { 0x1,  "Maintenance Regular Message (MTN)" },
113         { 0x2,  "Maintenance Special Message (MTNS)" },
114         { 0x3,  "SCCP" },
115         { 0x4,  "TUP" },
116         { 0x5,  "ISUP" },
117         { 0x6,  "DUP (call and circuit related messages)" },
118         { 0x7,  "DUP (facility registration and cancellation message)" },
119         { 0x8,  "MTP testing user part" },
120         { 0x9,  "Spare" },
121         { 0xa,  "Spare" },
122         { 0xb,  "Spare" },
123         { 0xc,  "Spare" },
124         { 0xd,  "Spare" },
125         { 0xe,  "Spare" },
126         { 0xf,  "Spare" },
127         { 0,    NULL }
128 };
129
130 static const value_string network_indicator_vals[] = {
131         { 0x0,  "International network" },
132         { 0x1,  "Spare (for international use only)" },
133         { 0x2,  "National network" },
134         { 0x3,  "Reserved for national use" },
135         { 0,    NULL }
136 };
137
138 static dissector_handle_t data_handle;
139
140 static void
141 dissect_mtp3_sio(tvbuff_t *tvb, proto_tree *mtp3_tree)
142 {
143   guint8 sio;
144   proto_item *sio_item;
145   proto_tree *sio_tree;
146
147   sio_item = proto_tree_add_text(mtp3_tree, tvb, SIO_OFFSET, SIO_LENGTH, "Service information octet");
148   sio_tree = proto_item_add_subtree(sio_item, ett_mtp3_sio);
149
150   sio = tvb_get_guint8(tvb, SIO_OFFSET);
151   proto_tree_add_uint(sio_tree, hf_mtp3_network_indicator, tvb, SIO_OFFSET, SIO_LENGTH, sio);
152   
153   switch(mtp3_standard){
154   case ANSI_STANDARD:
155     proto_tree_add_uint(sio_tree, hf_mtp3_ansi_priority, tvb, SIO_OFFSET, SIO_LENGTH, sio);
156     break;
157   case ITU_STANDARD:
158     proto_tree_add_uint(sio_tree, hf_mtp3_itu_spare, tvb, SIO_OFFSET, SIO_LENGTH, sio);
159     break;
160   }
161   
162   proto_tree_add_uint(sio_tree, hf_mtp3_service_indicator, tvb, SIO_OFFSET, SIO_LENGTH, sio);
163 }
164
165 static void
166 dissect_mtp3_routing_label(tvbuff_t *tvb, proto_tree *mtp3_tree)
167 {
168   guint32 label, dpc, opc;
169   guint8 sls;
170   proto_item *label_item, *label_dpc_item, *label_opc_item;
171   proto_tree *label_tree, *label_dpc_tree, *label_opc_tree;
172
173   switch (mtp3_standard) {
174   case ITU_STANDARD:
175     label_item = proto_tree_add_text(mtp3_tree, tvb, ITU_ROUTING_LABEL_OFFSET, ITU_ROUTING_LABEL_LENGTH, "Routing label");
176     label_tree = proto_item_add_subtree(label_item, ett_mtp3_label);
177
178     label = tvb_get_letohl(tvb, ITU_ROUTING_LABEL_OFFSET);
179     sls   = tvb_get_guint8(tvb, ITU_ROUTING_LABEL_OFFSET);
180
181     proto_tree_add_uint(label_tree, hf_mtp3_itu_dpc, tvb, ITU_ROUTING_LABEL_OFFSET, ITU_ROUTING_LABEL_LENGTH, label);
182     proto_tree_add_uint(label_tree, hf_mtp3_itu_opc, tvb, ITU_ROUTING_LABEL_OFFSET, ITU_ROUTING_LABEL_LENGTH, label);
183     proto_tree_add_uint(label_tree, hf_mtp3_itu_sls, tvb, ITU_SLS_OFFSET, ITU_SLS_LENGTH, sls);
184     break;
185
186   case ANSI_STANDARD:
187     /* this could be 5 or 8 bits */
188     sls = tvb_get_guint8(tvb, ANSI_SLS_OFFSET);
189
190     /* Create the Routing Label Tree */
191     label_item = proto_tree_add_text(mtp3_tree, tvb, ANSI_ROUTING_LABEL_OFFSET, ANSI_ROUTING_LABEL_LENGTH, "Routing label");
192     label_tree = proto_item_add_subtree(label_item, ett_mtp3_label);
193
194     /* create the DPC tree */
195     dpc = tvb_get_ntoh24(tvb, ANSI_DPC_OFFSET);
196     label_dpc_item = proto_tree_add_text(label_tree, tvb, ANSI_DPC_OFFSET, ANSI_DPC_LENGTH,
197                                          "DPC (%d-%d-%d)", (dpc & ANSI_NETWORK_MASK), ((dpc & ANSI_CLUSTER_MASK) >> 8), ((dpc & ANSI_MEMBER_MASK) >> 16));
198
199     label_dpc_tree = proto_item_add_subtree(label_dpc_item, ett_mtp3_label_dpc);
200
201     proto_tree_add_uint(label_dpc_tree, hf_mtp3_dpc_member, tvb, ANSI_DPC_OFFSET, ANSI_DPC_LENGTH, dpc);
202     proto_tree_add_uint(label_dpc_tree, hf_mtp3_dpc_cluster,tvb, ANSI_DPC_OFFSET, ANSI_DPC_LENGTH, dpc);
203     proto_tree_add_uint(label_dpc_tree, hf_mtp3_dpc_network,tvb, ANSI_DPC_OFFSET, ANSI_DPC_LENGTH, dpc);
204
205     /* create the OPC tree */
206     opc = tvb_get_ntoh24(tvb, ANSI_OPC_OFFSET);
207
208     label_opc_item = proto_tree_add_text(label_tree, tvb, ANSI_OPC_OFFSET, ANSI_OPC_LENGTH,
209                                          "OPC (%d-%d-%d)", (opc & ANSI_NETWORK_MASK), ((opc & ANSI_CLUSTER_MASK) >> 8), ((opc & ANSI_MEMBER_MASK) >> 16));
210     label_opc_tree = proto_item_add_subtree(label_opc_item, ett_mtp3_label_opc);
211
212     proto_tree_add_uint(label_opc_tree, hf_mtp3_opc_member, tvb, ANSI_OPC_OFFSET, ANSI_OPC_LENGTH, opc);
213     proto_tree_add_uint(label_opc_tree, hf_mtp3_opc_cluster, tvb, ANSI_OPC_OFFSET, ANSI_OPC_LENGTH, opc);
214     proto_tree_add_uint(label_opc_tree, hf_mtp3_opc_network,tvb, ANSI_OPC_OFFSET, ANSI_OPC_LENGTH, opc);
215     /* SLS */
216     /* TODO: separate 5-bit and 8-bit SLS */
217     proto_tree_add_item(label_tree, hf_mtp3_ansi_sls, tvb, ANSI_SLS_OFFSET, ANSI_SLS_LENGTH, sls);
218     /*    proto_tree_add_uint(label_tree, hf_mtp3_ansi_sls, tvb,ANSI_SLS_OFFSET, ANSI_SLS_LENGTH, sls);*/
219     break;
220   }
221 }
222
223 static void
224 dissect_mtp3_payload(tvbuff_t *tvb, packet_info *pinfo, proto_tree *mtp3_tree, proto_tree *tree)
225 {
226   guint8 sio;
227   guint8 service_indicator;
228   tvbuff_t *payload_tvb = NULL;
229
230   sio               = tvb_get_guint8(tvb, SIO_OFFSET);
231   service_indicator = sio & SERVICE_INDICATOR_MASK;
232
233   switch (mtp3_standard) {
234   case ITU_STANDARD:
235     payload_tvb = tvb_new_subset(tvb, ITU_MTP_PAYLOAD_OFFSET, -1, -1);
236     break;
237   case ANSI_STANDARD:
238     payload_tvb = tvb_new_subset(tvb, ANSI_MTP_PAYLOAD_OFFSET, -1, -1);
239     break;
240   }
241
242   if (!dissector_try_port(mtp3_sio_dissector_table, service_indicator, payload_tvb, pinfo, tree)) {
243     call_dissector(data_handle, payload_tvb, pinfo, tree);
244     if (check_col(pinfo->cinfo, COL_INFO))
245       col_append_str(pinfo->cinfo, COL_INFO, "DATA");
246   }
247 }
248
249 /* Code to actually dissect the packets */
250 static void
251 dissect_mtp3(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
252 {
253
254   /* Set up structures needed to add the protocol subtree and manage it */
255   proto_item *mtp3_item = NULL;
256   proto_tree *mtp3_tree = NULL;
257
258   /* Make entries in Protocol column and Info column on summary display */
259   if (check_col(pinfo->cinfo, COL_PROTOCOL))
260     col_set_str(pinfo->cinfo, COL_PROTOCOL, "MTP3");
261
262   if (tree) {
263     /* create display subtree for the protocol */
264     switch (mtp3_standard) {
265     case ITU_STANDARD:
266       mtp3_item = proto_tree_add_item(tree, proto_mtp3, tvb, 0, ITU_HEADER_LENGTH, FALSE);
267       break;
268     case ANSI_STANDARD:
269       mtp3_item = proto_tree_add_item(tree, proto_mtp3, tvb, 0, ANSI_HEADER_LENGTH, FALSE);
270       break;
271     }
272     mtp3_tree = proto_item_add_subtree(mtp3_item, ett_mtp3);
273
274     /* dissect the packet */
275     dissect_mtp3_sio(tvb, mtp3_tree);
276     dissect_mtp3_routing_label(tvb, mtp3_tree);
277     dissect_mtp3_payload(tvb, pinfo, mtp3_tree, tree);
278   }
279 }
280
281 void
282 proto_register_mtp3(void)
283 {
284
285   /* Setup list of header fields  See Section 1.6.1 for details*/
286   static hf_register_info hf[] = {
287     { &hf_mtp3_service_indicator,
288       { "Service indicator", "mtp3.service_indicator",
289         FT_UINT8, BASE_HEX, VALS(service_indicator_code_vals), SERVICE_INDICATOR_MASK,
290               "", HFILL }},
291     { &hf_mtp3_network_indicator,
292       { "Network indicator", "mtp3.network_indicator",
293               FT_UINT8, BASE_HEX, VALS(network_indicator_vals), NETWORK_INDICATOR_MASK,
294               "", HFILL }},
295     { &hf_mtp3_itu_spare,
296       { "Spare", "mtp3.spare",
297               FT_UINT8, BASE_HEX, NULL, SPARE_MASK,
298               "", HFILL }},
299     { &hf_mtp3_ansi_priority,
300       { "Priority", "mtp3.priority",
301               FT_UINT8, BASE_HEX, NULL, ANSI_PRIORITY_MASK,
302               "", HFILL }},
303     { &hf_mtp3_itu_opc,
304       { "OPC", "mtp3.opc",
305               FT_UINT32, BASE_DEC, NULL, ITU_OPC_MASK,
306               "", HFILL }},
307     { &hf_mtp3_opc_network,
308      { "OPC Network", "mtp3.opc.network",
309              FT_UINT24, BASE_DEC, NULL, ANSI_NETWORK_MASK,
310              "", HFILL }},
311     { &hf_mtp3_opc_cluster,
312       { "OPC Cluster", "mtp3.opc.cluster",
313               FT_UINT24, BASE_DEC, NULL, ANSI_CLUSTER_MASK,
314               "", HFILL }},
315     { &hf_mtp3_opc_member,
316       { "OPC Member", "mtp3.opc.member",
317               FT_UINT24, BASE_DEC, NULL, ANSI_MEMBER_MASK,
318               "", HFILL }},
319     { &hf_mtp3_itu_dpc,
320       { "DPC", "mtp3.dpc",
321               FT_UINT32, BASE_DEC, NULL, ITU_DPC_MASK,
322               "", HFILL }},
323     { &hf_mtp3_dpc_network,
324       { "DPC Network", "mtp3.dpc.network",
325               FT_UINT24, BASE_DEC, NULL, ANSI_NETWORK_MASK,
326               "", HFILL }},
327     { &hf_mtp3_dpc_cluster,
328       { "DPC Cluster", "mtp3.dpc.cluster",
329               FT_UINT24, BASE_DEC, NULL, ANSI_CLUSTER_MASK,
330               "", HFILL }},
331     { &hf_mtp3_dpc_member,
332       { "DPC Member", "mtp3.dpc.member",
333               FT_UINT24, BASE_DEC, NULL, ANSI_MEMBER_MASK,
334               "", HFILL }},
335     { &hf_mtp3_itu_sls,
336       { "Signalling Link Selector", "mtp3.sls",
337               FT_UINT32, BASE_DEC, NULL, ITU_SLS_MASK,
338               "", HFILL }},
339     { &hf_mtp3_ansi_sls,
340       { "Signalling Link Selector", "mtp3.sls",
341               FT_UINT8, BASE_DEC, NULL, ANSI_5BIT_SLS_MASK,
342               "", HFILL }}
343   };
344
345   /* Setup protocol subtree array */
346   static gint *ett[] = {
347     &ett_mtp3,
348     &ett_mtp3_sio,
349     &ett_mtp3_label,
350     &ett_mtp3_label_dpc,
351     &ett_mtp3_label_opc
352   };
353
354   static enum_val_t mtp3_options[] = {
355     { "ITU",  ITU_STANDARD },
356     { "ANSI", ANSI_STANDARD },
357     { NULL, 0 }
358   };
359
360   /* Register the protocol name and description */
361   proto_mtp3 = proto_register_protocol("Message Transfer Part Level 3", "MTP3", "mtp3");
362   register_dissector("mtp3", dissect_mtp3, proto_mtp3);
363
364   /* Required function calls to register the header fields and subtrees used */
365   proto_register_field_array(proto_mtp3, hf, array_length(hf));
366   proto_register_subtree_array(ett, array_length(ett));
367
368   mtp3_sio_dissector_table = register_dissector_table("mtp3.service_indicator", "MTP3 Service indicator", FT_UINT8, BASE_HEX);
369   mtp3_module = prefs_register_protocol(proto_mtp3, NULL);
370   prefs_register_enum_preference(mtp3_module, "mtp3_standard", "MTP3 standard", "MTP3 standard",  (gint *)&mtp3_standard, mtp3_options, FALSE);
371 }
372
373 void
374 proto_reg_handoff_mtp3(void)
375 {
376   data_handle = find_dissector("data");
377 }