It's the AppleTalk Session Protocol, not the AppleTalk Stream Protocol.
[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.13 2002/04/22 09:43:03 guy 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_FACK       9
86 #define PDU_BIND      11
87 #define PDU_BIND_ACK  12
88 #define PDU_BIND_NAK  13
89 #define PDU_ALTER     14
90 #define PDU_ALTER_ACK 15
91 #define PDU_AUTH3     16
92
93 /*
94  * helpers for packet-dcerpc.c and packet-dcerpc-ndr.c
95  * If you're writing a subdissector, you almost certainly want the
96  * NDR functions below.
97  */
98 guint16 dcerpc_tvb_get_ntohs (tvbuff_t *tvb, gint offset, char *drep);
99 guint32 dcerpc_tvb_get_ntohl (tvbuff_t *tvb, gint offset, char *drep);
100 void dcerpc_tvb_get_uuid (tvbuff_t *tvb, gint offset, char *drep, e_uuid_t *uuid);
101 int dissect_dcerpc_uint8 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
102                           proto_tree *tree, char *drep, 
103                           int hfindex, guint8 *pdata);
104 int dissect_dcerpc_uint16 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
105                            proto_tree *tree, char *drep, 
106                            int hfindex, guint16 *pdata);
107 int dissect_dcerpc_uint32 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
108                            proto_tree *tree, char *drep, 
109                            int hfindex, guint32 *pdata);
110 int dissect_dcerpc_uint64 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
111                            proto_tree *tree, char *drep, 
112                            int hfindex, unsigned char *pdata);
113
114
115 /*
116  * NDR routines for subdissectors.
117  */
118 int dissect_ndr_uint8 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
119                        proto_tree *tree, char *drep, 
120                        int hfindex, guint8 *pdata);
121 int dissect_ndr_uint16 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
122                         proto_tree *tree, char *drep, 
123                         int hfindex, guint16 *pdata);
124 int dissect_ndr_uint32 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
125                         proto_tree *tree, char *drep, 
126                         int hfindex, guint32 *pdata);
127 int dissect_ndr_uint64 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
128                         proto_tree *tree, char *drep, 
129                         int hfindex, unsigned char *pdata);
130 int dissect_ndr_uuid_t (tvbuff_t *tvb, gint offset, packet_info *pinfo,
131                         proto_tree *tree, char *drep, 
132                         int hfindex, e_uuid_t *pdata);
133 int dissect_ndr_ctx_hnd (tvbuff_t *tvb, gint offset, packet_info *pinfo,
134                          proto_tree *tree, char *drep, 
135                          int hfindex, e_ctx_hnd *pdata);
136
137
138 typedef int (dcerpc_dissect_fnct_t)(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, char *drep);
139
140 #define NDR_POINTER_REF         1
141 #define NDR_POINTER_UNIQUE      2
142 #define NDR_POINTER_PTR         3
143 int dissect_ndr_pointer (tvbuff_t *tvb, gint offset, packet_info *pinfo,
144                         proto_tree *tree, char *drep, 
145                         dcerpc_dissect_fnct_t *fnct, int type, char *text, int hf_index, int levels);
146
147 /* dissect a NDR unidimensional conformant array */
148 int dissect_ndr_ucarray(tvbuff_t *tvb, gint offset, packet_info *pinfo,
149                         proto_tree *tree, char *drep, 
150                         dcerpc_dissect_fnct_t *fnct);
151
152 /* dissect a NDR unidimensional conformant and varying array */
153 int dissect_ndr_ucvarray(tvbuff_t *tvb, gint offset, packet_info *pinfo,
154                         proto_tree *tree, char *drep, 
155                         dcerpc_dissect_fnct_t *fnct);
156
157
158
159 typedef struct _dcerpc_sub_dissector {
160     guint16 num;
161     gchar   *name;
162     dcerpc_dissect_fnct_t *dissect_rqst;
163     dcerpc_dissect_fnct_t *dissect_resp;
164 } dcerpc_sub_dissector;
165
166 /* registration function for subdissectors */
167 void dcerpc_init_uuid (int proto, int ett, e_uuid_t *uuid, guint16 ver, dcerpc_sub_dissector *procs);
168
169 /* Private data structure to pass to DCERPC dissector. This is used to
170    pass transport specific information down to the dissector from the
171    dissector that parsed this encapsulated calls. */
172
173 #define DCERPC_TRANSPORT_SMB  1
174
175 typedef struct _dcerpc_private_info {
176     int transport_type;         /* Tag */
177
178     union {
179         struct {                /* DCERPC_TRANSPORT_SMB */
180             guint16 fid;
181         } smb;
182     } data;
183 } dcerpc_private_info;
184
185 /* Private data passed to subdissectors from the main DCERPC dissector. */
186 typedef struct _dcerpc_call_value {
187     e_uuid_t uuid;
188     guint16 ver;
189     guint16 opnum;
190     guint32 req_frame;
191     guint32 rep_frame;
192     guint32 max_ptr;
193     void *private_data;
194 } dcerpc_call_value;
195
196 typedef struct _dcerpc_info {
197         conversation_t *conv;   /* Which TCP stream we are in */
198         guint32 call_id;        /* Context id for this call */
199         guint16 smb_fid;        /* FID for DCERPC over SMB */
200         gboolean request;
201         gboolean conformant_run;
202         guint32 array_max_count;        /* max_count for conformant arrays */
203         guint32 array_max_count_offset; 
204         guint32 array_offset;
205         guint32 array_offset_offset;
206         guint32 array_actual_count;     
207         guint32 array_actual_count_offset;      
208         int hf_index;
209         int levels;                    /* number of levels upwards in the tree to append text*/
210         dcerpc_call_value *call_data;
211 } dcerpc_info;
212
213 #endif /* packet-dcerpc.h */