Replace a handful of tabs with spaces.
[obnox/wireshark/wip.git] / asn1 / rtse / packet-rtse-template.c
1 /* packet-rtse_asn1.c
2  * Routines for RTSE packet dissection
3  * Graeme Lunt 2005
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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  */
25
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <glib.h>
31 #include <epan/packet.h>
32 #include <epan/conversation.h>
33 #include <epan/prefs.h>
34 #include <epan/reassemble.h>
35 #include <epan/asn1.h>
36
37 #include <stdio.h>
38 #include <string.h>
39
40 #include "packet-ber.h"
41 #include "packet-pres.h"
42 #include "packet-acse.h"
43 #include "packet-ros.h"
44 #include "packet-rtse.h"
45
46 #define PNAME  "X.228 OSI Reliable Transfer Service"
47 #define PSNAME "RTSE"
48 #define PFNAME "rtse"
49
50 /* Initialize the protocol and registered fields */
51 int proto_rtse = -1;
52
53 static struct SESSION_DATA_STRUCTURE* session = NULL;
54
55 static gboolean open_request=FALSE;
56 static guint32 app_proto=0;
57
58 static proto_tree *top_tree=NULL;
59
60 static  dissector_handle_t rtse_handle = NULL;
61 static  dissector_handle_t ros_handle = NULL;
62
63 /* Preferences */
64 static gboolean rtse_reassemble = TRUE;
65
66 #include "packet-rtse-hf.c"
67
68 /* Initialize the subtree pointers */
69 static gint ett_rtse = -1;
70 #include "packet-rtse-ett.c"
71
72
73 static dissector_table_t rtse_oid_dissector_table=NULL;
74 static GHashTable *oid_table=NULL;
75 static gint ett_rtse_unknown = -1;
76
77 static GHashTable *rtse_segment_table = NULL;
78 static GHashTable *rtse_reassembled_table = NULL;
79  
80 static int hf_rtse_fragments = -1;
81 static int hf_rtse_fragment = -1;
82 static int hf_rtse_fragment_overlap = -1;
83 static int hf_rtse_fragment_overlap_conflicts = -1;
84 static int hf_rtse_fragment_multiple_tails = -1;
85 static int hf_rtse_fragment_too_long_fragment = -1;
86 static int hf_rtse_fragment_error = -1;
87 static int hf_rtse_reassembled_in = -1;
88
89 static gint ett_rtse_fragment = -1;
90 static gint ett_rtse_fragments = -1;
91
92 static const fragment_items rtse_frag_items = {
93         /* Fragment subtrees */
94         &ett_rtse_fragment,
95         &ett_rtse_fragments,
96         /* Fragment fields */
97         &hf_rtse_fragments,
98         &hf_rtse_fragment,
99         &hf_rtse_fragment_overlap,
100         &hf_rtse_fragment_overlap_conflicts,
101         &hf_rtse_fragment_multiple_tails,
102         &hf_rtse_fragment_too_long_fragment,
103         &hf_rtse_fragment_error,
104         /* Reassembled in field */
105         &hf_rtse_reassembled_in,
106         /* Tag */
107         "RTSE fragments"
108 };
109
110 void
111 register_rtse_oid_dissector_handle(const char *oid, dissector_handle_t dissector, int proto _U_, const char *name, gboolean uses_ros)
112 {
113
114   /* save the name - but not used */
115   g_hash_table_insert(oid_table, (gpointer)oid, (gpointer)name);
116
117   /* register RTSE with the BER (ACSE) */
118   register_ber_oid_dissector_handle(oid, rtse_handle, proto, name);
119
120   if(uses_ros) {
121     /* make sure we call ROS ... */
122     dissector_add_string("rtse.oid", oid, ros_handle);
123
124     /* and then tell ROS how to dissect the AS*/
125     register_ros_oid_dissector_handle(oid, dissector, proto, name, TRUE);
126
127   } else {
128     /* otherwise we just remember how to dissect the AS */
129     dissector_add_string("rtse.oid", oid, dissector);
130   }
131 }
132
133 static int
134 call_rtse_oid_callback(const char *oid, tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree)
135 {
136         tvbuff_t *next_tvb;
137
138         next_tvb = tvb_new_subset(tvb, offset, tvb_length_remaining(tvb, offset), tvb_reported_length_remaining(tvb, offset));
139         if(!dissector_try_string(rtse_oid_dissector_table, oid, next_tvb, pinfo, tree)){
140                 proto_item *item=NULL;
141                 proto_tree *next_tree=NULL;
142
143                 item=proto_tree_add_text(tree, next_tvb, 0, tvb_length_remaining(tvb, offset), "RTSE: Dissector for OID:%s not implemented. Contact Wireshark developers if you want this supported", oid);
144                 if(item){
145                         next_tree=proto_item_add_subtree(item, ett_rtse_unknown);
146                 }
147                 dissect_unknown_ber(pinfo, next_tvb, offset, next_tree);
148         }
149
150         /*XXX until we change the #.REGISTER signature for _PDU()s 
151          * into new_dissector_t   we have to do this kludge with
152          * manually step past the content in the ANY type.
153          */
154         offset+=tvb_length_remaining(tvb, offset);
155
156         return offset;
157 }
158
159 static int
160 call_rtse_external_type_callback(gboolean implicit_tag _U_, tvbuff_t *tvb, int offset, asn1_ctx_t *actx, proto_tree *tree, int hf_index _U_)
161 {
162         const char      *oid = NULL;
163
164         if (actx->external.indirect_ref_present) {
165                 oid = (const char *)find_oid_by_pres_ctx_id(actx->pinfo, actx->external.indirect_reference);
166         } else if (actx->external.direct_ref_present) {
167                 oid = actx->external.direct_reference;
168         }
169
170         if (oid)
171                 offset = call_rtse_oid_callback(oid, tvb, offset, actx->pinfo, top_tree ? top_tree : tree);
172
173         return offset;
174 }
175
176 #include "packet-rtse-fn.c"
177
178 /*
179 * Dissect RTSE PDUs inside a PPDU.
180 */
181 static void
182 dissect_rtse(tvbuff_t *tvb, packet_info *pinfo, proto_tree *parent_tree)
183 {
184         int offset = 0;
185         int old_offset;
186         proto_item *item=NULL;
187         proto_tree *tree=NULL;
188         tvbuff_t *next_tvb = NULL;
189         tvbuff_t *data_tvb = NULL;
190         fragment_data *frag_msg = NULL;
191         guint32 fragment_length;
192         guint32 rtse_id = 0;
193         gboolean data_handled = FALSE;
194         conversation_t *conversation = NULL;
195         asn1_ctx_t asn1_ctx;
196         asn1_ctx_init(&asn1_ctx, ASN1_ENC_BER, TRUE, pinfo);
197
198         /* save parent_tree so subdissectors can create new top nodes */
199         top_tree=parent_tree;
200
201         /* do we have application context from the acse dissector?  */
202         if( !pinfo->private_data ){
203                 if(parent_tree){
204                         proto_tree_add_text(parent_tree, tvb, offset, -1,
205                                 "Internal error:can't get application context from ACSE dissector.");
206                 } 
207                 return  ;
208         } else {
209                 session  = ( (struct SESSION_DATA_STRUCTURE*)(pinfo->private_data) );
210
211         }
212
213         if (check_col(pinfo->cinfo, COL_PROTOCOL))
214                 col_set_str(pinfo->cinfo, COL_PROTOCOL, "RTSE");
215         if (check_col(pinfo->cinfo, COL_INFO))
216                 col_clear(pinfo->cinfo, COL_INFO);
217
218         if (rtse_reassemble && 
219             ((session->spdu_type == SES_DATA_TRANSFER) ||
220              (session->spdu_type == SES_MAJOR_SYNC_POINT))) {
221                 /* Use conversation index as fragment id */
222                 conversation  = find_conversation (pinfo->fd->num, 
223                                                    &pinfo->src, &pinfo->dst, pinfo->ptype, 
224                                                    pinfo->srcport, pinfo->destport, 0);
225                 if (conversation != NULL) { 
226                         rtse_id = conversation->index;
227                 } 
228                 session->rtse_reassemble = TRUE;
229         }
230         if (rtse_reassemble && session->spdu_type == SES_MAJOR_SYNC_POINT) {
231                 frag_msg = fragment_end_seq_next (pinfo, rtse_id, rtse_segment_table,
232                                                   rtse_reassembled_table);
233                 next_tvb = process_reassembled_data (tvb, offset, pinfo, "Reassembled RTSE", 
234                                                      frag_msg, &rtse_frag_items, NULL, parent_tree);
235         }
236         if(parent_tree){
237                 item = proto_tree_add_item(parent_tree, proto_rtse, next_tvb ? next_tvb : tvb, 0, -1, FALSE);
238                 tree = proto_item_add_subtree(item, ett_rtse);
239         }
240         if (rtse_reassemble && session->spdu_type == SES_DATA_TRANSFER) {
241                 /* strip off the OCTET STRING encoding - including any CONSTRUCTED OCTET STRING */
242                 dissect_ber_octet_string(FALSE, &asn1_ctx, NULL, tvb, offset, 0, &data_tvb);
243
244                 if (data_tvb) {
245                         fragment_length = tvb_length_remaining (data_tvb, 0);
246                         proto_tree_add_text(tree, data_tvb, 0, (fragment_length) ? -1 : 0,
247                                             "RTSE segment data (%u byte%s)", fragment_length,
248                                       plurality(fragment_length, "", "s"));
249                         frag_msg = fragment_add_seq_next (data_tvb, 0, pinfo, 
250                                                           rtse_id, rtse_segment_table,
251                                                           rtse_reassembled_table, fragment_length, TRUE);
252                         if (frag_msg && pinfo->fd->num != frag_msg->reassembled_in) {
253                                 /* Add a "Reassembled in" link if not reassembled in this frame */
254                                 proto_tree_add_uint (tree, *(rtse_frag_items.hf_reassembled_in),
255                                                      data_tvb, 0, 0, frag_msg->reassembled_in);
256                         }
257                         pinfo->fragmented = TRUE;
258                         data_handled = TRUE;
259                 } else {
260                         fragment_length = tvb_length_remaining (tvb, offset);
261                 }
262
263                 if (check_col(pinfo->cinfo, COL_INFO))
264                         col_append_fstr(pinfo->cinfo, COL_INFO, "[RTSE fragment, %u byte%s]",
265                                         fragment_length, plurality(fragment_length, "", "s"));
266         } else if (rtse_reassemble && session->spdu_type == SES_MAJOR_SYNC_POINT) {
267                 if (next_tvb) {
268                         /* ROS won't do this for us */
269                         session->ros_op = (ROS_OP_INVOKE | ROS_OP_ARGUMENT);
270                         offset=dissect_ber_external_type(FALSE, tree, next_tvb, 0, &asn1_ctx, -1, call_rtse_external_type_callback);
271                 } else {
272                         offset = tvb_length (tvb);
273                 }
274                 pinfo->fragmented = FALSE;
275                 data_handled = TRUE;
276         } 
277
278         if (!data_handled) {
279                 while (tvb_reported_length_remaining(tvb, offset) > 0){
280                         old_offset=offset;
281                         offset=dissect_rtse_RTSE_apdus(TRUE, tvb, offset, &asn1_ctx, tree, -1);
282                         if(offset == old_offset){
283                                 proto_tree_add_text(tree, tvb, offset, -1, "Internal error, zero-byte RTSE PDU");
284                                 offset = tvb_length(tvb);
285                                 break;
286                         }
287                 }
288         }
289
290         top_tree = NULL;
291 }
292
293 static void rtse_reassemble_init (void)
294 {
295         fragment_table_init (&rtse_segment_table);
296         reassembled_table_init (&rtse_reassembled_table);
297 }
298
299 /*--- proto_register_rtse -------------------------------------------*/
300 void proto_register_rtse(void) {
301
302   /* List of fields */
303   static hf_register_info hf[] =
304   {
305     /* Fragment entries */
306     { &hf_rtse_fragments,
307       { "RTSE fragments", "rtse.fragments", FT_NONE, BASE_NONE,
308         NULL, 0x00, "Message fragments", HFILL } },
309     { &hf_rtse_fragment,
310       { "RTSE fragment", "rtse.fragment", FT_FRAMENUM, BASE_NONE,
311         NULL, 0x00, "Message fragment", HFILL } },
312     { &hf_rtse_fragment_overlap,
313       { "RTSE fragment overlap", "rtse.fragment.overlap", FT_BOOLEAN,
314         BASE_NONE, NULL, 0x00, "Message fragment overlap", HFILL } },
315     { &hf_rtse_fragment_overlap_conflicts,
316       { "RTSE fragment overlapping with conflicting data",
317         "rtse.fragment.overlap.conflicts", FT_BOOLEAN, BASE_NONE, NULL,
318         0x00, "Message fragment overlapping with conflicting data", HFILL } },
319     { &hf_rtse_fragment_multiple_tails,
320       { "RTSE has multiple tail fragments",
321         "rtse.fragment.multiple_tails", FT_BOOLEAN, BASE_NONE,
322         NULL, 0x00, "Message has multiple tail fragments", HFILL } },
323     { &hf_rtse_fragment_too_long_fragment,
324       { "RTSE fragment too long", "rtse.fragment.too_long_fragment",
325         FT_BOOLEAN, BASE_NONE, NULL, 0x00, "Message fragment too long",
326         HFILL } },
327     { &hf_rtse_fragment_error,
328       { "RTSE defragmentation error", "rtse.fragment.error", FT_FRAMENUM,
329         BASE_NONE, NULL, 0x00, "Message defragmentation error", HFILL } },
330     { &hf_rtse_reassembled_in,
331       { "Reassembled RTSE in frame", "rtse.reassembled.in", FT_FRAMENUM, BASE_NONE,
332         NULL, 0x00, "This RTSE packet is reassembled in this frame", HFILL } },
333
334 #include "packet-rtse-hfarr.c"
335   };
336
337   /* List of subtrees */
338   static gint *ett[] = {
339     &ett_rtse,
340     &ett_rtse_unknown,
341     &ett_rtse_fragment,
342     &ett_rtse_fragments,
343 #include "packet-rtse-ettarr.c"
344   };
345
346   module_t *rtse_module;
347
348   /* Register protocol */
349   proto_rtse = proto_register_protocol(PNAME, PSNAME, PFNAME);
350   register_dissector("rtse", dissect_rtse, proto_rtse);
351   /* Register fields and subtrees */
352   proto_register_field_array(proto_rtse, hf, array_length(hf));
353   proto_register_subtree_array(ett, array_length(ett));
354   register_init_routine (&rtse_reassemble_init);
355   rtse_module = prefs_register_protocol_subtree("OSI", proto_rtse, NULL);
356
357   prefs_register_bool_preference(rtse_module, "reassemble",
358                                  "Reassemble segmented RTSE datagrams",
359                                  "Whether segmented RTSE datagrams should be reassembled."
360                                  " To use this option, you must also enable"
361                                  " \"Allow subdissectors to reassemble TCP streams\""
362                                  " in the TCP protocol settings.", &rtse_reassemble);
363
364   rtse_oid_dissector_table = register_dissector_table("rtse.oid", "RTSE OID Dissectors", FT_STRING, BASE_NONE);
365   oid_table=g_hash_table_new(g_str_hash, g_str_equal);
366
367   rtse_handle = find_dissector("rtse");
368   ros_handle = find_dissector("ros");
369
370 }
371
372
373 /*--- proto_reg_handoff_rtse --- */
374 void proto_reg_handoff_rtse(void) {
375
376
377 }