packet-dcerpc.h

   1 /* packet-dcerpc.h
   2  * Copyright 2001, Todd Sabin <tas@webspan.net>
   3  *
   4  * $Id: packet-dcerpc.h,v 1.24 2002/10/25 01:08:42 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_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 /*
 100  * helpers for packet-dcerpc.c and packet-dcerpc-ndr.c
 101  * If you're writing a subdissector, you almost certainly want the
 102  * NDR functions below.
 103  */
 104 guint16 dcerpc_tvb_get_ntohs (tvbuff_t *tvb, gint offset, char *drep);
 105 guint32 dcerpc_tvb_get_ntohl (tvbuff_t *tvb, gint offset, char *drep);
 106 void dcerpc_tvb_get_uuid (tvbuff_t *tvb, gint offset, char *drep, e_uuid_t *uuid);
 107 int dissect_dcerpc_uint8 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 108                           proto_tree *tree, char *drep,
 109                           int hfindex, guint8 *pdata);
 110 int dissect_dcerpc_uint16 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 111                            proto_tree *tree, char *drep,
 112                            int hfindex, guint16 *pdata);
 113 int dissect_dcerpc_uint32 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 114                            proto_tree *tree, char *drep,
 115                            int hfindex, guint32 *pdata);
 116 int dissect_dcerpc_uint64 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 117                            proto_tree *tree, char *drep,
 118                            int hfindex, unsigned char *pdata);
 119 int dissect_dcerpc_float  (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 120                            proto_tree *tree, char *drep,
 121                            int hfindex, gfloat *pdata);
 122 int dissect_dcerpc_double (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 123                            proto_tree *tree, char *drep,
 124                            int hfindex, gdouble *pdata);
 125 int dissect_dcerpc_time_t (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 126                            proto_tree *tree, char *drep,
 127                            int hfindex, guint32 *pdata);
 128 /*
 129  * NDR routines for subdissectors.
 130  */
 131 int dissect_ndr_uint8 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 132                        proto_tree *tree, char *drep,
 133                        int hfindex, guint8 *pdata);
 134 int dissect_ndr_uint16 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 135                         proto_tree *tree, char *drep,
 136                         int hfindex, guint16 *pdata);
 137 int dissect_ndr_uint32 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 138                         proto_tree *tree, char *drep,
 139                         int hfindex, guint32 *pdata);
 140 int dissect_ndr_uint64 (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 141                         proto_tree *tree, char *drep,
 142                         int hfindex, unsigned char *pdata);
 143 int dissect_ndr_float (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 144                         proto_tree *tree, char *drep,
 145                         int hfindex, gfloat *pdata);
 146 int dissect_ndr_double (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 147                         proto_tree *tree, char *drep,
 148                         int hfindex, gdouble *pdata);
 149 int dissect_ndr_time_t (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 150                         proto_tree *tree, char *drep,
 151                         int hfindex, guint32 *pdata);
 152 int dissect_ndr_uuid_t (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 153                         proto_tree *tree, char *drep,
 154                         int hfindex, e_uuid_t *pdata);
 155 int dissect_ndr_ctx_hnd (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 156                          proto_tree *tree, char *drep,
 157                          int hfindex, e_ctx_hnd *pdata);
 158
 159
 160 typedef int (dcerpc_dissect_fnct_t)(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, char *drep);
 161
 162 #define NDR_POINTER_REF         1
 163 #define NDR_POINTER_UNIQUE      2
 164 #define NDR_POINTER_PTR         3
 165
 166 int dissect_ndr_pointer (tvbuff_t *tvb, gint offset, packet_info *pinfo,
 167                         proto_tree *tree, char *drep,
 168                         dcerpc_dissect_fnct_t *fnct, int type, char *text, int hf_index, int levels);
 169
 170 /* dissect a NDR unidimensional conformant array */
 171 int dissect_ndr_ucarray(tvbuff_t *tvb, gint offset, packet_info *pinfo,
 172                         proto_tree *tree, char *drep,
 173                         dcerpc_dissect_fnct_t *fnct);
 174
 175 /* dissect a NDR unidimensional conformant and varying array */
 176 int dissect_ndr_ucvarray(tvbuff_t *tvb, gint offset, packet_info *pinfo,
 177                         proto_tree *tree, char *drep,
 178                         dcerpc_dissect_fnct_t *fnct);
 179
 180
 181
 182 typedef struct _dcerpc_sub_dissector {
 183     guint16 num;
 184     gchar   *name;
 185     dcerpc_dissect_fnct_t *dissect_rqst;
 186     dcerpc_dissect_fnct_t *dissect_resp;
 187 } dcerpc_sub_dissector;
 188
 189 /* registration function for subdissectors */
 190 void dcerpc_init_uuid (int proto, int ett, e_uuid_t *uuid, guint16 ver, dcerpc_sub_dissector *procs, int opnum_hf);
 191 char *dcerpc_get_proto_name(e_uuid_t *uuid, guint16 ver);
 192 dcerpc_sub_dissector *dcerpc_get_proto_sub_dissector(e_uuid_t *uuid, guint16 ver);
 193
 194
 195 /* Private data structure to pass to DCERPC dissector. This is used to
 196    pass transport specific information down to the dissector from the
 197    dissector that parsed this encapsulated calls. */
 198
 199 #define DCERPC_TRANSPORT_SMB  1
 200
 201 typedef struct _dcerpc_private_info {
 202     int transport_type;         /* Tag */
 203
 204     union {
 205         struct {                /* DCERPC_TRANSPORT_SMB */
 206             guint16 fid;
 207         } smb;
 208     } data;
 209 } dcerpc_private_info;
 210
 211 /* Private data passed to subdissectors from the main DCERPC dissector. */
 212 typedef struct _dcerpc_call_value {
 213     e_uuid_t uuid;
 214     guint16 ver;
 215     guint16 opnum;
 216     guint32 req_frame;
 217     nstime_t req_time;
 218     guint32 rep_frame;
 219     guint32 max_ptr;
 220     void *private_data;
 221 } dcerpc_call_value;
 222
 223 typedef struct _dcerpc_info {
 224         conversation_t *conv;   /* Which TCP stream we are in */
 225         guint32 call_id;        /* Context id for this call */
 226         guint16 smb_fid;        /* FID for DCERPC over SMB */
 227         gboolean request;
 228         gboolean conformant_run;
 229         gint32 conformant_eaten; /* how many bytes did the conformant run eat?*/
 230         guint32 array_max_count;        /* max_count for conformant arrays */
 231         guint32 array_max_count_offset;
 232         guint32 array_offset;
 233         guint32 array_offset_offset;
 234         guint32 array_actual_count;
 235         guint32 array_actual_count_offset;
 236         int hf_index;
 237         int levels;                    /* number of levels upwards in the tree to append text*/
 238         dcerpc_call_value *call_data;
 239         void *private_data;
 240 } dcerpc_info;
 241
 242
 243 /* the registered subdissectors */
 244 extern GHashTable *dcerpc_uuids;
 245
 246 typedef struct _dcerpc_uuid_key {
 247     e_uuid_t uuid;
 248     guint16 ver;
 249 } dcerpc_uuid_key;
 250
 251 typedef struct _dcerpc_uuid_value {
 252     int proto;
 253     int ett;
 254     gchar *name;
 255     dcerpc_sub_dissector *procs;
 256     int opnum_hf;
 257 } dcerpc_uuid_value;
 258
 259
 260 #endif /* packet-dcerpc.h */