Removed trailing whitespaces from .h and .c files using the
[obnox/wireshark/wip.git] / packet-dcerpc.h
1 /* packet-dcerpc.h
2  * Copyright 2001, Todd Sabin <tas@webspan.net>
3  *
4  * $Id: packet-dcerpc.h,v 1.18 2002/06/24 00:03:18 tpot Exp $
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@ethereal.com>
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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifndef __PACKET_DCERPC_H__
26 #define __PACKET_DCERPC_H__
27
28 #include <epan/conversation.h>
29
30 typedef struct _e_uuid_t {
31     guint32 Data1;
32     guint16 Data2;
33     guint16 Data3;
34     guint8 Data4[8];
35 } e_uuid_t;
36
37 typedef struct _e_ctx_hnd {
38     guint32 Data1;
39     e_uuid_t uuid;
40 } e_ctx_hnd;
41
42 typedef struct _e_dce_cn_common_hdr_t {
43     guint8 rpc_ver;
44     guint8 rpc_ver_minor;
45     guint8 ptype;
46     guint8 flags;
47     guint8 drep[4];
48     guint16 frag_len;
49     guint16 auth_len;
50     guint32 call_id;
51 } e_dce_cn_common_hdr_t;
52
53 typedef struct _e_dce_dg_common_hdr_t {
54     guint8 rpc_ver;
55     guint8 ptype;
56     guint8 flags1;
57     guint8 flags2;
58     guint8 drep[3];
59     guint8 serial_hi;
60     e_uuid_t obj_id;
61     e_uuid_t if_id;
62     e_uuid_t act_id;
63     guint32 server_boot;
64     guint32 if_ver;
65     guint32 seqnum;
66     guint16 opnum;
67     guint16 ihint;
68     guint16 ahint;
69     guint16 frag_len;
70     guint16 frag_num;
71     guint8 auth_proto;
72     guint8 serial_lo;
73 } e_dce_dg_common_hdr_t;
74
75
76
77 #define PDU_REQ         0
78 #define PDU_PING        1
79 #define PDU_RESP        2
80 #define PDU_FAULT       3
81 #define PDU_WORKING     4
82 #define PDU_NOCALL      5
83 #define PDU_REJECT      6
84 #define PDU_ACK         7
85 #define PDU_CL_CANCEL   8
86 #define PDU_FACK        9
87 #define PDU_CANCEL_ACK 10
88 #define PDU_BIND       11
89 #define PDU_BIND_ACK   12
90 #define PDU_BIND_NAK   13
91 #define PDU_ALTER      14
92 #define PDU_ALTER_ACK  15
93 #define PDU_AUTH3      16
94 #define PDU_SHUTDOWN   17
95 #define PDU_CO_CANCEL  18
96 #define PDU_ORPHANED   19
97
98 /*
99  * helpers for packet-dcerpc.c and packet-dcerpc-ndr.c
100  * If you're writing a subdissector, you almost certainly want the
101  * NDR functions below.
102  */
103 guint16 dcerpc_tvb_get_ntohs (tvbuff_t *tvb, gint offset, char *drep);
104 guint32 dcerpc_tvb_get_ntohl (tvbuff_t *tvb, gint offset, char *drep);
105 void dcerpc_tvb_get_uuid (tvbuff_t *tvb, gint offset, char *drep, e_uuid_t *uuid);
106 int dissect_dcerpc_uint8 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
107                           proto_tree *tree, char *drep, 
108                           int hfindex, guint8 *pdata);
109 int dissect_dcerpc_uint16 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
110                            proto_tree *tree, char *drep, 
111                            int hfindex, guint16 *pdata);
112 int dissect_dcerpc_uint32 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
113                            proto_tree *tree, char *drep, 
114                            int hfindex, guint32 *pdata);
115 int dissect_dcerpc_uint64 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
116                            proto_tree *tree, char *drep, 
117                            int hfindex, unsigned char *pdata);
118
119
120 /*
121  * NDR routines for subdissectors.
122  */
123 int dissect_ndr_uint8 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
124                        proto_tree *tree, char *drep, 
125                        int hfindex, guint8 *pdata);
126 int dissect_ndr_uint16 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
127                         proto_tree *tree, char *drep, 
128                         int hfindex, guint16 *pdata);
129 int dissect_ndr_uint32 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
130                         proto_tree *tree, char *drep, 
131                         int hfindex, guint32 *pdata);
132 int dissect_ndr_uint64 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
133                         proto_tree *tree, char *drep, 
134                         int hfindex, unsigned char *pdata);
135 int dissect_ndr_uuid_t (tvbuff_t *tvb, gint offset, packet_info *pinfo,
136                         proto_tree *tree, char *drep, 
137                         int hfindex, e_uuid_t *pdata);
138 int dissect_ndr_ctx_hnd (tvbuff_t *tvb, gint offset, packet_info *pinfo,
139                          proto_tree *tree, char *drep, 
140                          int hfindex, e_ctx_hnd *pdata);
141
142
143 typedef int (dcerpc_dissect_fnct_t)(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, char *drep);
144
145 #define NDR_POINTER_REF         1
146 #define NDR_POINTER_UNIQUE      2
147 #define NDR_POINTER_PTR         3
148         
149 int dissect_ndr_pointer (tvbuff_t *tvb, gint offset, packet_info *pinfo,
150                         proto_tree *tree, char *drep, 
151                         dcerpc_dissect_fnct_t *fnct, int type, char *text, int hf_index, int levels);
152
153 /* dissect a NDR unidimensional conformant array */
154 int dissect_ndr_ucarray(tvbuff_t *tvb, gint offset, packet_info *pinfo,
155                         proto_tree *tree, char *drep, 
156                         dcerpc_dissect_fnct_t *fnct);
157
158 /* dissect a NDR unidimensional conformant and varying array */
159 int dissect_ndr_ucvarray(tvbuff_t *tvb, gint offset, packet_info *pinfo,
160                         proto_tree *tree, char *drep, 
161                         dcerpc_dissect_fnct_t *fnct);
162
163
164
165 typedef struct _dcerpc_sub_dissector {
166     guint16 num;
167     gchar   *name;
168     dcerpc_dissect_fnct_t *dissect_rqst;
169     dcerpc_dissect_fnct_t *dissect_resp;
170 } dcerpc_sub_dissector;
171
172 /* registration function for subdissectors */
173 void dcerpc_init_uuid (int proto, int ett, e_uuid_t *uuid, guint16 ver, dcerpc_sub_dissector *procs, int opnum_hf);
174
175 /* Private data structure to pass to DCERPC dissector. This is used to
176    pass transport specific information down to the dissector from the
177    dissector that parsed this encapsulated calls. */
178
179 #define DCERPC_TRANSPORT_SMB  1
180
181 typedef struct _dcerpc_private_info {
182     int transport_type;         /* Tag */
183
184     union {
185         struct {                /* DCERPC_TRANSPORT_SMB */
186             guint16 fid;
187         } smb;
188     } data;
189 } dcerpc_private_info;
190
191 /* Private data passed to subdissectors from the main DCERPC dissector. */
192 typedef struct _dcerpc_call_value {
193     e_uuid_t uuid;
194     guint16 ver;
195     guint16 opnum;
196     guint32 req_frame;
197     guint32 rep_frame;
198     guint32 max_ptr;
199     void *private_data;
200 } dcerpc_call_value;
201
202 typedef struct _dcerpc_info {
203         conversation_t *conv;   /* Which TCP stream we are in */
204         guint32 call_id;        /* Context id for this call */
205         guint16 smb_fid;        /* FID for DCERPC over SMB */
206         gboolean request;
207         gboolean conformant_run;
208         gint32 conformant_eaten; /* how many bytes did the conformant run eat?*/
209         guint32 array_max_count;        /* max_count for conformant arrays */
210         guint32 array_max_count_offset; 
211         guint32 array_offset;
212         guint32 array_offset_offset;
213         guint32 array_actual_count;     
214         guint32 array_actual_count_offset;      
215         int hf_index;
216         int levels;                    /* number of levels upwards in the tree to append text*/
217         dcerpc_call_value *call_data;
218         void *private_data;
219 } dcerpc_info;
220
221 #endif /* packet-dcerpc.h */