From Todd Sabin: allocate the buffer for the decrypted payload, rather
[obnox/wireshark/wip.git] / smb.h
1 /* smb.h
2  * Defines for smb packet dissection
3  * Copyright 1999, Richard Sharpe <rsharpe@ns.aus.com>
4  *
5  * $Id: smb.h,v 1.49 2003/02/25 02:00:33 tpot Exp $
6  *
7  * Ethereal - Network traffic analyzer
8  * By Gerald Combs <gerald@ethereal.com>
9  * Copyright 1998, 1999 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 #ifndef _SMB_H
27 #define _SMB_H
28
29 /* SMB command codes, from the SNIA CIFS spec. */
30 extern const value_string smb_cmd_vals[];
31 extern const value_string trans2_cmd_vals[];
32 extern const value_string nt_cmd_vals[];
33
34 #define SMB_COM_CREATE_DIRECTORY                0x00
35 #define SMB_COM_DELETE_DIRECTORY                0x01
36 #define SMB_COM_OPEN                            0x02
37 #define SMB_COM_CREATE                          0x03
38 #define SMB_COM_CLOSE                           0x04
39 #define SMB_COM_FLUSH                           0x05
40 #define SMB_COM_DELETE                          0x06
41 #define SMB_COM_RENAME                          0x07
42 #define SMB_COM_QUERY_INFORMATION               0x08
43 #define SMB_COM_SET_INFORMATION                 0x09
44 #define SMB_COM_READ                            0x0A
45 #define SMB_COM_WRITE                           0x0B
46 #define SMB_COM_LOCK_BYTE_RANGE                 0x0C
47 #define SMB_COM_UNLOCK_BYTE_RANGE               0x0D
48 #define SMB_COM_CREATE_TEMPORARY                0x0E
49 #define SMB_COM_CREATE_NEW                      0x0F
50 #define SMB_COM_CHECK_DIRECTORY                 0x10
51 #define SMB_COM_PROCESS_EXIT                    0x11
52 #define SMB_COM_SEEK                            0x12
53 #define SMB_COM_LOCK_AND_READ                   0x13
54 #define SMB_COM_WRITE_AND_UNLOCK                0x14
55 #define SMB_COM_READ_RAW                        0x1A
56 #define SMB_COM_READ_MPX                        0x1B
57 #define SMB_COM_READ_MPX_SECONDARY              0x1C
58 #define SMB_COM_WRITE_RAW                       0x1D
59 #define SMB_COM_WRITE_MPX                       0x1E
60 #define SMB_COM_WRITE_MPX_SECONDARY             0x1F
61 #define SMB_COM_WRITE_COMPLETE                  0x20
62 #define SMB_COM_QUERY_SERVER                    0x21
63 #define SMB_COM_SET_INFORMATION2                0x22
64 #define SMB_COM_QUERY_INFORMATION2              0x23
65 #define SMB_COM_LOCKING_ANDX                    0x24
66 #define SMB_COM_TRANSACTION                     0x25
67 #define SMB_COM_TRANSACTION_SECONDARY           0x26
68 #define SMB_COM_IOCTL                           0x27
69 #define SMB_COM_IOCTL_SECONDARY                 0x28
70 #define SMB_COM_COPY                            0x29
71 #define SMB_COM_MOVE                            0x2A
72 #define SMB_COM_ECHO                            0x2B
73 #define SMB_COM_WRITE_AND_CLOSE                 0x2C
74 #define SMB_COM_OPEN_ANDX                       0x2D
75 #define SMB_COM_READ_ANDX                       0x2E
76 #define SMB_COM_WRITE_ANDX                      0x2F
77 #define SMB_COM_NEW_FILE_SIZE                   0x30
78 #define SMB_COM_CLOSE_AND_TREE_DISC             0x31
79 #define SMB_COM_TRANSACTION2                    0x32
80 #define SMB_COM_TRANSACTION2_SECONDARY          0x33
81 #define SMB_COM_FIND_CLOSE2                     0x34
82 #define SMB_COM_FIND_NOTIFY_CLOSE               0x35
83 /* Used by Xenix/Unix           0x60-0x6E */
84 #define SMB_COM_TREE_CONNECT                    0x70
85 #define SMB_COM_TREE_DISCONNECT                 0x71
86 #define SMB_COM_NEGOTIATE                       0x72
87 #define SMB_COM_SESSION_SETUP_ANDX              0x73
88 #define SMB_COM_LOGOFF_ANDX                     0x74
89 #define SMB_COM_TREE_CONNECT_ANDX               0x75
90 #define SMB_COM_QUERY_INFORMATION_DISK          0x80
91 #define SMB_COM_SEARCH                          0x81
92 #define SMB_COM_FIND                            0x82
93 #define SMB_COM_FIND_UNIQUE                     0x83
94 #define SMB_COM_FIND_CLOSE                      0x84
95 #define SMB_COM_NT_TRANSACT                     0xA0
96 #define SMB_COM_NT_TRANSACT_SECONDARY           0xA1
97 #define SMB_COM_NT_CREATE_ANDX                  0xA2
98 #define SMB_COM_NT_CANCEL                       0xA4
99 #define SMB_COM_NT_RENAME                       0xA5
100 #define SMB_COM_OPEN_PRINT_FILE                 0xC0
101 #define SMB_COM_WRITE_PRINT_FILE                0xC1
102 #define SMB_COM_CLOSE_PRINT_FILE                0xC2
103 #define SMB_COM_GET_PRINT_QUEUE                 0xC3
104 #define SMB_COM_READ_BULK                       0xD8
105 #define SMB_COM_WRITE_BULK                      0xD9
106 #define SMB_COM_WRITE_BULK_DATA                 0xDA
107
108 /* Error codes */
109
110 #define SMB_SUCCESS 0x00  /* All OK */
111 #define SMB_ERRDOS  0x01  /* DOS based error */
112 #define SMB_ERRSRV  0x02  /* server error, network file manager */
113 #define SMB_ERRHRD  0x03  /* Hardware style error */
114 #define SMB_ERRCMD  0x04  /* Not an SMB format command */
115
116 /* SMB X/Open error codes for the ERRDOS error class */
117 #define SMBE_badfunc 1             /* Invalid function (or system call) */
118 #define SMBE_badfile 2             /* File not found (pathname error) */
119 #define SMBE_badpath 3             /* Directory not found */
120 #define SMBE_nofids 4              /* Too many open files */
121 #define SMBE_noaccess 5            /* Access denied */
122 #define SMBE_badfid 6              /* Invalid fid */
123 #define SMBE_badmcb 7              /* Memory control blocks destroyed */
124 #define SMBE_nomem 8               /* Out of memory */
125 #define SMBE_badmem 9              /* Invalid memory block address */
126 #define SMBE_badenv 10             /* Invalid environment */
127 #define SMBE_badformat 11          /* Invalid format */
128 #define SMBE_badaccess 12          /* Invalid open mode */
129 #define SMBE_baddata 13            /* Invalid data (only from ioctl call) */
130 #define SMBE_res 14
131 #define SMBE_baddrive 15           /* Invalid drive */
132 #define SMBE_remcd 16              /* Attempt to delete current directory */
133 #define SMBE_diffdevice 17         /* rename/move across different filesystems */
134 #define SMBE_nofiles 18            /* no more files found in file search */
135 #define SMBE_badshare 32           /* Share mode on file conflict with open mode */
136 #define SMBE_lock 33               /* Lock request conflicts with existing lock */
137 #define SMBE_unsup 50              /* Request unsupported, returned by Win 95, RJS 20Jun98 */
138 #define SMBE_nosuchshare 67        /* Share does not exits */
139 #define SMBE_filexists 80          /* File in operation already exists */
140 #define SMBE_invalidparam 87       /* Invalid parameter */
141 #define SMBE_cannotopen 110        /* Cannot open the file specified */
142 #define SMBE_insufficientbuffer 122/* Insufficient buffer size */
143 #define SMBE_invalidname 123       /* Invalid name */
144 #define SMBE_unknownlevel 124      /* Unknown info level */
145 #define SMBE_alreadyexists 183     /* File already exists */
146 #define SMBE_badpipe 230           /* Named pipe invalid */
147 #define SMBE_pipebusy 231          /* All instances of pipe are busy */
148 #define SMBE_pipeclosing 232       /* named pipe close in progress */
149 #define SMBE_notconnected 233      /* No process on other end of named pipe */
150 #define SMBE_moredata 234          /* More data to be returned */
151 #define SMBE_nomoreitems 259       /* No more items */
152 #define SMBE_baddirectory 267      /* Invalid directory name in a path. */
153 #define SMBE_eas_didnt_fit 275     /* Extended attributes didn't fit */
154 #define SMBE_eas_nsup 282          /* Extended attributes not supported */
155 #define SMBE_notify_buf_small 1022 /* Buffer too small to return change notify. */
156 #define SMBE_serverunavailable 1722/* Server unavailable */
157 #define SMBE_unknownipc 2142
158 #define SMBE_noipc 66              /* don't support ipc */
159
160 /* These errors seem to be only returned by the NT printer driver system */
161
162 #define SMBE_invalidowner 1307  /* Invalid security descriptor owner */
163 #define SMBE_invalidsecuritydescriptor 1338 /* Invalid security descriptor */
164 #define SMBE_unknownprinterdriver 1797 /* Unknown printer driver */
165 #define SMBE_invalidprintername 1801   /* Invalid printer name */
166 #define SMBE_printeralreadyexists 1802 /* Printer already exists */
167 #define SMBE_invaliddatatype 1804      /* Invalid datatype */
168 #define SMBE_invalidenvironment 1805   /* Invalid environment */
169 #define SMBE_invalidformsize    1903   /* Invalid form size */
170 #define SMBE_printerdriverinuse 3001   /* Printer driver in use */
171
172 /* Error codes for the ERRSRV class */
173
174 #define SMBE_error 1               /* Non specific error code */
175 #define SMBE_badpw 2               /* Bad password */
176 #define SMBE_badtype 3             /* reserved */
177 #define SMBE_access 4              /* No permissions to do the requested operation */
178 #define SMBE_invnid 5              /* tid invalid */
179 #define SMBE_invnetname 6          /* Invalid servername */
180 #define SMBE_invdevice 7           /* Invalid device */
181 #define SMBE_qfull 49              /* Print queue full */
182 #define SMBE_qtoobig 50            /* Queued item too big */
183 #define SMBE_qeof 51               /* EOF in print queue dump */
184 #define SMBE_invpfid 52            /* Invalid print file in smb_fid */
185 #define SMBE_smbcmd 64             /* Unrecognised command */
186 #define SMBE_srverror 65           /* smb server internal error */
187 #define SMBE_filespecs 67          /* fid and pathname invalid combination */
188 #define SMBE_badlink 68
189 #define SMBE_badpermits 69         /* Access specified for a file is not valid */
190 #define SMBE_badpid 70
191 #define SMBE_setattrmode 71        /* attribute mode invalid */
192 #define SMBE_paused 81             /* Message server paused */
193 #define SMBE_msgoff 82             /* Not receiving messages */
194 #define SMBE_noroom 83             /* No room for message */
195 #define SMBE_rmuns 87              /* too many remote usernames */
196 #define SMBE_timeout 88            /* operation timed out */
197 #define SMBE_noresource  89        /* No resources currently available for request. */
198 #define SMBE_toomanyuids 90        /* too many userids */
199 #define SMBE_baduid 91             /* bad userid */
200 #define SMBE_useMPX 250            /* temporarily unable to use raw mode, use MPX mode */
201 #define SMBE_useSTD 251            /* temporarily unable to use raw mode, use standard mode */
202 #define SMBE_contMPX 252           /* resume MPX mode */
203 #define SMBE_badPW 253             /* Check this out ... */
204 #define SMBE_nosupport 0xFFFF
205 #define SMBE_unknownsmb 22         /* from NT 3.5 response */
206
207 /* Error codes for the ERRHRD class */
208
209 #define SMBE_nowrite 19     /* read only media */
210 #define SMBE_badunit 20     /* Unknown device */
211 #define SMBE_notready 21    /* Drive not ready */
212 #define SMBE_badcmd 22      /* Unknown command */
213 #define SMBE_data 23        /* Data (CRC) error */
214 #define SMBE_badreq 24      /* Bad request structure length */
215 #define SMBE_seek 25        /* Seek error */
216 #define SMBE_badmedia 26    /* Unknown media type */
217 #define SMBE_badsector 27   /* Sector not found */
218 #define SMBE_nopaper 28     /* Printer out of paper */
219 #define SMBE_write 29       /* Write fault */
220 #define SMBE_read 30        /* Read fault */
221 #define SMBE_general 31     /* General failure */
222 #define SMBE_badshare 32    /* An open conflicts with an existing open */
223 #define SMBE_lock 33        /* Lock conflict or invalid mode, or unlock of
224                                lock held by another process */
225 #define SMBE_wrongdisk 34   /* The wrong disk was found in a drive */
226 #define SMBE_FCBunavail 35  /* No FCBs are available to process request */
227 #define SMBE_sharebufexc 36 /* A sharing buffer has been exceeded */
228 #define SMBE_diskfull 39
229
230 /* the information we need to keep around for NT transatcion commands */
231 typedef struct {
232         int subcmd;
233 } smb_nt_transact_info_t;
234
235 /* the information we need to keep around for transaction2 commands */
236 typedef struct {
237         int subcmd;
238         int info_level;
239         gboolean resume_keys; /* if "return resume" keys set in T2 FIND_FIRST request */
240 } smb_transact2_info_t;
241
242 /*
243  * The information we need to save about a request in order to show the
244  * frame number of the request in the dissection of the reply.
245  */
246 #define SMB_SIF_TID_IS_IPC      0x0001
247 typedef struct {
248         guint32 frame_req, frame_res;
249         nstime_t req_time;
250         guint16 flags;
251         int cmd;
252         void *extra_info;
253 } smb_saved_info_t;
254
255 /*
256  * The information we need to save about a Transaction request in order
257  * to dissect the reply; this includes information for use by the
258  * Remote API and Mailslot dissectors.
259  * XXX - have an additional data structure hung off of this by the
260  * subdissectors?
261  */
262 typedef struct {
263         int subcmd;
264         int trans_subcmd;
265         int function;
266         int fid;
267         guint16 lanman_cmd;
268         guchar *param_descrip;  /* Keep these descriptors around */
269         guchar *data_descrip;
270         guchar *aux_data_descrip;
271         int info_level;
272 } smb_transact_info_t;
273
274 /*
275  * Subcommand type.
276  */
277 #define TRANSACTION_PIPE        0
278 #define TRANSACTION_MAILSLOT    1
279
280 /* these are defines used to represent different types of TIDs.
281    dont use the value 0 for any of these */
282 #define TID_NORMAL      1
283 #define TID_IPC         2
284
285 /* this is the structure which is associated with each conversation */
286 typedef struct conv_tables {
287         /* these two tables are used to match requests with responses */
288         GHashTable *unmatched;
289         GHashTable *matched;
290         /* this tables is used by DCERPC over SMB reassembly*/
291         GHashTable *dcerpc_fid_to_frame;
292         /* This table is used to track TID->services for a conversation */
293         GHashTable *tid_service;
294         gboolean raw_ntlmssp;   /* Do extended security exc use raw ntlmssp */
295 } conv_tables_t;
296
297 typedef struct smb_info {
298   int cmd;
299   int tid, pid, uid, mid;
300   gboolean unicode;             /* Are strings in this SMB Unicode? */
301   gboolean request;             /* Is this a request? */
302   gboolean unidir;
303   int info_level;
304   int info_count;
305   smb_saved_info_t *sip;        /* smb_saved_info_t, if any, for this */
306   conv_tables_t *ct;
307 } smb_info_t;
308
309 /*
310  * Show file data for a read or write.
311  */
312 extern int dissect_file_data(tvbuff_t *tvb, proto_tree *tree, int offset,
313     guint16 bc, guint16 datalen);
314
315 /*
316  * Add a FID to the protocol tree and the Info column.
317  */
318 extern void add_fid(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree,
319     int offset, int len, guint16 fid);
320
321 /*
322  * Dissect named pipe state information.
323  */
324 extern int dissect_ipc_state(tvbuff_t *tvb, proto_tree *parent_tree,
325     int offset, gboolean setstate);
326
327 extern gboolean smb_dcerpc_reassembly;
328 extern GHashTable *dcerpc_fragment_table;
329
330 /*
331  * NT and DOS error codes used by other dissectors.
332  */
333 extern const value_string NT_errors[];
334 extern const value_string DOS_errors[];
335 extern const value_string ms_country_codes[];
336
337 /*
338  * Access mask values
339  */
340
341 /* Generic rights */
342
343 #define GENERIC_RIGHTS_MASK    0xF0000000
344
345 #define GENERIC_ALL_ACCESS     0x10000000
346 #define GENERIC_EXECUTE_ACCESS 0x20000000
347 #define GENERIC_WRITE_ACCESS   0x40000000
348 #define GENERIC_READ_ACCESS    0x80000000
349
350 /* Misc/reserved */
351
352 #define ACCESS_SACL_ACCESS     0x00800000
353 #define SYSTEM_SECURITY_ACCESS 0x01000000
354 #define MAXIMUM_ALLOWED_ACCESS 0x02000000
355
356 /* Standard rights */
357
358 #define STANDARD_RIGHTS_MASK 0x00FF0000
359
360 #define DELETE_ACCESS        0x00010000
361 #define READ_CONTROL_ACCESS  0x00020000
362 #define WRITE_DAC_ACCESS     0x00040000
363 #define WRITE_OWNER_ACCESS   0x00080000
364 #define SYNCHRONIZE_ACCESS   0x00100000
365
366 /* Specific rights */
367
368 #define SPECIFIC_RIGHTS_MASK 0x0000FFFF /* Specific rights defined per-object */
369
370 #endif