Don't guard col_clear with col_check
[obnox/wireshark/wip.git] / asn1 / disp / packet-disp-template.c
1 /* packet-disp.c
2  * Routines for X.525 (X.500 Directory Shadow Asbtract Service) and X.519 DISP 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/prefs.h>
33 #include <epan/oids.h>
34 #include <epan/asn1.h>
35
36 #include <stdio.h>
37 #include <string.h>
38
39 #include "packet-ber.h"
40 #include "packet-acse.h"
41 #include "packet-ros.h"
42 #include "packet-rtse.h"
43
44 #include "packet-x509if.h"
45 #include "packet-x509af.h"
46 #include "packet-x509sat.h"
47 #include "packet-crmf.h"
48
49 #include "packet-dop.h"
50 #include "packet-dap.h"
51 #include "packet-dsp.h"
52 #include "packet-disp.h"
53
54
55 /* we don't have a separate dissector for X519 - 
56    and most of DISP is defined in X525 */
57 #define PNAME  "X.519 Directory Information Shadowing Protocol"
58 #define PSNAME "DISP"
59 #define PFNAME "disp"
60
61 static guint global_disp_tcp_port = 102;
62 static dissector_handle_t tpkt_handle;
63 void prefs_register_disp(void); /* forward declaration for use in preferences registration */
64
65
66 /* Initialize the protocol and registered fields */
67 int proto_disp = -1;
68
69 static struct SESSION_DATA_STRUCTURE* session = NULL;
70
71 #include "packet-disp-hf.c"
72
73 /* Initialize the subtree pointers */
74 static gint ett_disp = -1;
75 #include "packet-disp-ett.c"
76
77 #include "packet-disp-fn.c"
78
79 /*
80 * Dissect DISP PDUs inside a ROS PDUs
81 */
82 static void
83 dissect_disp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *parent_tree)
84 {
85         int offset = 0;
86         int old_offset;
87         proto_item *item=NULL;
88         proto_tree *tree=NULL;
89         int (*disp_dissector)(gboolean implicit_tag _U_, tvbuff_t *tvb, int offset, asn1_ctx_t *actx, proto_tree *tree, int hf_index _U_) = NULL;
90         char *disp_op_name;
91         asn1_ctx_t asn1_ctx;
92
93         asn1_ctx_init(&asn1_ctx, ASN1_ENC_BER, TRUE, pinfo);
94
95         /* do we have operation information from the ROS dissector?  */
96         if( !pinfo->private_data ){
97                 if(parent_tree){
98                         proto_tree_add_text(parent_tree, tvb, offset, -1,
99                                 "Internal error: can't get operation information from ROS dissector.");
100                 } 
101                 return  ;
102         } else {
103                 session  = ( (struct SESSION_DATA_STRUCTURE*)(pinfo->private_data) );
104         }
105
106         if(parent_tree){
107                 item = proto_tree_add_item(parent_tree, proto_disp, tvb, 0, -1, FALSE);
108                 tree = proto_item_add_subtree(item, ett_disp);
109         }
110         col_set_str(pinfo->cinfo, COL_PROTOCOL, "DISP");
111         col_clear(pinfo->cinfo, COL_INFO);
112
113         switch(session->ros_op & ROS_OP_MASK) {
114         case (ROS_OP_BIND | ROS_OP_ARGUMENT):   /*  BindInvoke */
115           disp_dissector = dissect_disp_DSAShadowBindArgument;
116           disp_op_name = "Shadow-Bind-Argument";
117           break;
118         case (ROS_OP_BIND | ROS_OP_RESULT):     /*  BindResult */
119           disp_dissector = dissect_disp_DSAShadowBindResult;
120           disp_op_name = "Shadow-Bind-Result";
121           break;
122         case (ROS_OP_BIND | ROS_OP_ERROR):      /*  BindError */
123           disp_dissector = dissect_disp_DSAShadowBindError;
124           disp_op_name = "Shadow-Bind-Error";
125           break;
126         case (ROS_OP_INVOKE | ROS_OP_ARGUMENT): /*  Invoke Argument */
127           switch(session->ros_op & ROS_OP_OPCODE_MASK) {
128           case 1: /* requestShadowUpdate */
129             disp_dissector = dissect_disp_RequestShadowUpdateArgument;
130             disp_op_name = "Request-Shadow-Update-Argument";
131             break;
132           case 2: /* updateShadow*/
133             disp_dissector = dissect_disp_UpdateShadowArgument;
134             disp_op_name = "Update-Shadow-Argument";
135             break;
136           case 3: /* coordinateShadowUpdate */
137             disp_dissector = dissect_disp_CoordinateShadowUpdateArgument;
138             disp_op_name = "Coordinate-Shadow-Update-Argument";
139             break;
140           default:
141             proto_tree_add_text(tree, tvb, offset, -1,"Unsupported DISP opcode (%d)",
142                                 session->ros_op & ROS_OP_OPCODE_MASK);
143             break;
144           }
145           break;
146         case (ROS_OP_INVOKE | ROS_OP_RESULT):   /*  Return Result */
147           switch(session->ros_op & ROS_OP_OPCODE_MASK) {
148           case 1: /* requestShadowUpdate */
149             disp_dissector = dissect_disp_RequestShadowUpdateResult;
150             disp_op_name = "Request-Shadow-Result";
151             break;
152           case 2: /* updateShadow */
153             disp_dissector = dissect_disp_UpdateShadowResult;
154             disp_op_name = "Update-Shadow-Result";
155             break;
156           case 3: /* coordinateShadowUpdate */
157             disp_dissector = dissect_disp_CoordinateShadowUpdateResult;
158             disp_op_name = "Coordinate-Shadow-Update-Result";
159             break;
160           default:
161             proto_tree_add_text(tree, tvb, offset, -1,"Unsupported DISP opcode (%d)",
162                                 session->ros_op & ROS_OP_OPCODE_MASK);
163             break;
164           }
165           break;
166         case (ROS_OP_INVOKE | ROS_OP_ERROR):    /*  Return Error */
167           switch(session->ros_op & ROS_OP_OPCODE_MASK) {
168           case 1: /* shadowError */
169             disp_dissector = dissect_disp_ShadowError;
170             disp_op_name = "Shadow-Error";
171             break;
172           default:
173             proto_tree_add_text(tree, tvb, offset, -1,"Unsupported DISP errcode (%d)",
174                                 session->ros_op & ROS_OP_OPCODE_MASK);
175             break;
176           }
177           break;
178         default:
179           proto_tree_add_text(tree, tvb, offset, -1,"Unsupported DISP PDU");
180           return;
181         }
182
183         if(disp_dissector) {
184           if (check_col(pinfo->cinfo, COL_INFO))
185             col_set_str(pinfo->cinfo, COL_INFO, disp_op_name);
186
187           while (tvb_reported_length_remaining(tvb, offset) > 0){
188             old_offset=offset;
189             offset=(*disp_dissector)(FALSE, tvb, offset, &asn1_ctx, tree, -1);
190             if(offset == old_offset){
191               proto_tree_add_text(tree, tvb, offset, -1,"Internal error, zero-byte DISP PDU");
192               offset = tvb_length(tvb);
193               break;
194             }
195           }
196         }
197 }
198
199
200 /*--- proto_register_disp -------------------------------------------*/
201 void proto_register_disp(void) {
202
203   /* List of fields */
204   static hf_register_info hf[] =
205   {
206 #include "packet-disp-hfarr.c"
207   };
208
209   /* List of subtrees */
210   static gint *ett[] = {
211     &ett_disp,
212 #include "packet-disp-ettarr.c"
213   };
214   module_t *disp_module;
215
216   /* Register protocol */
217   proto_disp = proto_register_protocol(PNAME, PSNAME, PFNAME);
218   register_dissector("disp", dissect_disp, proto_disp);
219
220   /* Register fields and subtrees */
221   proto_register_field_array(proto_disp, hf, array_length(hf));
222   proto_register_subtree_array(ett, array_length(ett));
223
224   /* Register our configuration options for DISP, particularly our port */
225
226   disp_module = prefs_register_protocol_subtree("OSI/X.500", proto_disp, prefs_register_disp);
227
228   prefs_register_uint_preference(disp_module, "tcp.port", "DISP TCP Port",
229                                  "Set the port for DISP operations (if other"
230                                  " than the default of 102)",
231                                  10, &global_disp_tcp_port);
232
233 }
234
235
236 /*--- proto_reg_handoff_disp --- */
237 void proto_reg_handoff_disp(void) {
238   dissector_handle_t disp_handle;
239
240   #include "packet-disp-dis-tab.c"
241
242   /* APPLICATION CONTEXT */
243
244   oid_add_from_string("id-ac-shadow-consumer-initiated","2.5.3.4");
245   oid_add_from_string("id-ac-shadow-supplier-initiated","2.5.3.5");
246   oid_add_from_string("id-ac-reliable-shadow-consumer-initiated","2.5.3.6");
247   oid_add_from_string("id-ac-reliable-shadow-supplier-initiated","2.5.3.7");
248
249   /* ABSTRACT SYNTAXES */
250
251   disp_handle = find_dissector("disp");
252
253   register_ros_oid_dissector_handle("2.5.9.3", disp_handle, 0, "id-as-directory-shadow", FALSE); 
254   register_rtse_oid_dissector_handle("2.5.9.5", disp_handle, 0, "id-as-directory-reliable-shadow", FALSE); 
255   register_rtse_oid_dissector_handle("2.5.9.6", disp_handle, 0, "id-as-directory-reliable-binding", FALSE); 
256
257   /* OPERATIONAL BINDING */
258   oid_add_from_string("id-op-binding-shadow","2.5.1.0.5.1");
259
260   tpkt_handle = find_dissector("tpkt");
261
262   /* DNs */
263   x509if_register_fmt(hf_disp_contextPrefix, "cp=");
264
265 }
266
267
268 void prefs_register_disp(void) {
269   static guint tcp_port = 0;
270
271   /* de-register the old port */
272   /* port 102 is registered by TPKT - don't undo this! */
273   if((tcp_port > 0) && (tcp_port != 102) && tpkt_handle)
274     dissector_delete("tcp.port", tcp_port, tpkt_handle);
275
276   /* Set our port number for future use */
277   tcp_port = global_disp_tcp_port;
278
279   if((tcp_port > 0) && (tcp_port != 102) && tpkt_handle)
280     dissector_add("tcp.port", global_disp_tcp_port, tpkt_handle);
281
282 }