r9698: Fix a bit of memory management
[sfrench/samba-autobuild/.git] / source4 / include / smb.h
1 /* 
2    Unix SMB/CIFS implementation.
3    SMB parameters and setup, plus a whole lot more.
4    
5    Copyright (C) Andrew Tridgell              1992-2000
6    Copyright (C) John H Terpstra              1996-2002
7    Copyright (C) Luke Kenneth Casson Leighton 1996-2000
8    Copyright (C) Paul Ashton                  1998-2000
9    Copyright (C) Simo Sorce                   2001-2002
10    Copyright (C) Martin Pool                  2002
11    
12    This program is free software; you can redistribute it and/or modify
13    it under the terms of the GNU General Public License as published by
14    the Free Software Foundation; either version 2 of the License, or
15    (at your option) any later version.
16    
17    This program is distributed in the hope that it will be useful,
18    but WITHOUT ANY WARRANTY; without even the implied warranty of
19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20    GNU General Public License for more details.
21    
22    You should have received a copy of the GNU General Public License
23    along with this program; if not, write to the Free Software
24    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 */
26
27 #ifndef _SMB_H
28 #define _SMB_H
29
30 #define SMB_PORTS "445 139"
31
32 enum smb_signing_state {SMB_SIGNING_OFF, SMB_SIGNING_SUPPORTED, 
33                         SMB_SIGNING_REQUIRED, SMB_SIGNING_AUTO};
34
35 /* deny modes */
36 #define DENY_DOS 0
37 #define DENY_ALL 1
38 #define DENY_WRITE 2
39 #define DENY_READ 3
40 #define DENY_NONE 4
41 #define DENY_FCB 7
42
43 /* open modes */
44 #define DOS_OPEN_RDONLY 0
45 #define DOS_OPEN_WRONLY 1
46 #define DOS_OPEN_RDWR 2
47 #define DOS_OPEN_FCB 0xF
48
49
50 /**********************************/
51 /* SMBopen field definitions      */
52 #define OPEN_FLAGS_DENY_MASK  0x70
53 #define OPEN_FLAGS_DENY_DOS   0x00
54 #define OPEN_FLAGS_DENY_ALL   0x10
55 #define OPEN_FLAGS_DENY_WRITE 0x20
56 #define OPEN_FLAGS_DENY_READ  0x30
57 #define OPEN_FLAGS_DENY_NONE  0x40
58
59 #define OPEN_FLAGS_MODE_MASK  0x0F
60 #define OPEN_FLAGS_OPEN_READ     0
61 #define OPEN_FLAGS_OPEN_WRITE    1
62 #define OPEN_FLAGS_OPEN_RDWR     2
63 #define OPEN_FLAGS_FCB        0xFF
64
65
66 /**********************************/
67 /* SMBopenX field definitions     */
68
69 /* OpenX Flags field. */
70 #define OPENX_FLAGS_ADDITIONAL_INFO      0x01
71 #define OPENX_FLAGS_REQUEST_OPLOCK       0x02
72 #define OPENX_FLAGS_REQUEST_BATCH_OPLOCK 0x04
73 #define OPENX_FLAGS_EA_LEN               0x08
74 #define OPENX_FLAGS_EXTENDED_RETURN      0x10
75
76 /* desired access (open_mode), split info 4 4-bit nibbles */
77 #define OPENX_MODE_ACCESS_MASK   0x000F
78 #define OPENX_MODE_ACCESS_READ   0x0000
79 #define OPENX_MODE_ACCESS_WRITE  0x0001
80 #define OPENX_MODE_ACCESS_RDWR   0x0002
81 #define OPENX_MODE_ACCESS_EXEC   0x0003
82 #define OPENX_MODE_ACCESS_FCB    0x000F
83
84 #define OPENX_MODE_DENY_SHIFT    4
85 #define OPENX_MODE_DENY_MASK     (0xF        << OPENX_MODE_DENY_SHIFT)
86 #define OPENX_MODE_DENY_DOS      (DENY_DOS   << OPENX_MODE_DENY_SHIFT)
87 #define OPENX_MODE_DENY_ALL      (DENY_ALL   << OPENX_MODE_DENY_SHIFT)
88 #define OPENX_MODE_DENY_WRITE    (DENY_WRITE << OPENX_MODE_DENY_SHIFT)
89 #define OPENX_MODE_DENY_READ     (DENY_READ  << OPENX_MODE_DENY_SHIFT)
90 #define OPENX_MODE_DENY_NONE     (DENY_NONE  << OPENX_MODE_DENY_SHIFT)
91 #define OPENX_MODE_DENY_FCB      (0xF        << OPENX_MODE_DENY_SHIFT)
92
93 #define OPENX_MODE_LOCALITY_MASK 0x0F00 /* what does this do? */
94
95 #define OPENX_MODE_NO_CACHE      0x1000
96 #define OPENX_MODE_WRITE_THRU    0x4000
97
98 /* open function values */
99 #define OPENX_OPEN_FUNC_MASK  0x3
100 #define OPENX_OPEN_FUNC_FAIL  0x0
101 #define OPENX_OPEN_FUNC_OPEN  0x1
102 #define OPENX_OPEN_FUNC_TRUNC 0x2
103
104 /* The above can be OR'ed with... */
105 #define OPENX_OPEN_FUNC_CREATE 0x10
106
107 /* openx action in reply */
108 #define OPENX_ACTION_EXISTED    1
109 #define OPENX_ACTION_CREATED    2
110 #define OPENX_ACTION_TRUNCATED  3
111
112
113 /**********************************/
114 /* SMBntcreateX field definitions */
115
116 /* ntcreatex flags field. */
117 #define NTCREATEX_FLAGS_REQUEST_OPLOCK       0x02
118 #define NTCREATEX_FLAGS_REQUEST_BATCH_OPLOCK 0x04
119 #define NTCREATEX_FLAGS_OPEN_DIRECTORY       0x08 /* TODO: opens parent? we need
120                                                      a test suite for this */
121 #define NTCREATEX_FLAGS_EXTENDED             0x10
122
123 /* the ntcreatex access_mask field 
124    this is split into 4 pieces
125    AAAABBBBCCCCCCCCDDDDDDDDDDDDDDDD
126    A -> GENERIC_RIGHT_*
127    B -> SEC_RIGHT_*
128    C -> STD_RIGHT_*
129    D -> SA_RIGHT_*
130    
131    which set of SA_RIGHT_* bits is applicable depends on the type
132    of object.
133 */
134
135
136
137 /* ntcreatex share_access field */
138 #define NTCREATEX_SHARE_ACCESS_NONE   0
139 #define NTCREATEX_SHARE_ACCESS_READ   1
140 #define NTCREATEX_SHARE_ACCESS_WRITE  2
141 #define NTCREATEX_SHARE_ACCESS_DELETE 4
142
143 /* ntcreatex open_disposition field */
144 #define NTCREATEX_DISP_SUPERSEDE 0     /* supersede existing file (if it exists) */
145 #define NTCREATEX_DISP_OPEN 1          /* if file exists open it, else fail */
146 #define NTCREATEX_DISP_CREATE 2        /* if file exists fail, else create it */
147 #define NTCREATEX_DISP_OPEN_IF 3       /* if file exists open it, else create it */
148 #define NTCREATEX_DISP_OVERWRITE 4     /* if exists overwrite, else fail */
149 #define NTCREATEX_DISP_OVERWRITE_IF 5  /* if exists overwrite, else create */
150
151 /* ntcreatex create_options field */
152 #define NTCREATEX_OPTIONS_DIRECTORY                0x0001
153 #define NTCREATEX_OPTIONS_WRITE_THROUGH            0x0002
154 #define NTCREATEX_OPTIONS_SEQUENTIAL_ONLY          0x0004
155 #define NTCREATEX_OPTIONS_SYNC_ALERT               0x0010
156 #define NTCREATEX_OPTIONS_ASYNC_ALERT              0x0020
157 #define NTCREATEX_OPTIONS_NON_DIRECTORY_FILE       0x0040
158 #define NTCREATEX_OPTIONS_NO_EA_KNOWLEDGE          0x0200
159 #define NTCREATEX_OPTIONS_EIGHT_DOT_THREE_ONLY     0x0400
160 #define NTCREATEX_OPTIONS_RANDOM_ACCESS            0x0800
161 #define NTCREATEX_OPTIONS_DELETE_ON_CLOSE          0x1000
162 #define NTCREATEX_OPTIONS_OPEN_BY_FILE_ID          0x2000
163
164 /* create options these bits are for private use by backends, they are
165    not valid on the wire */
166 #define NTCREATEX_OPTIONS_PRIVATE_MASK         0xFF000000
167 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS     0x01000000
168 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB     0x02000000
169
170
171 /* ntcreatex impersonation field */
172 #define NTCREATEX_IMPERSONATION_ANONYMOUS      0
173 #define NTCREATEX_IMPERSONATION_IDENTIFICATION 1
174 #define NTCREATEX_IMPERSONATION_IMPERSONATION  2
175 #define NTCREATEX_IMPERSONATION_DELEGATION     3
176
177 /* ntcreatex security flags bit field */
178 #define NTCREATEX_SECURITY_DYNAMIC             1
179 #define NTCREATEX_SECURITY_ALL                 2
180
181 /* ntcreatex create_action in reply */
182 #define NTCREATEX_ACTION_EXISTED     1
183 #define NTCREATEX_ACTION_CREATED     2
184 #define NTCREATEX_ACTION_TRUNCATED   3
185 /* the value 5 can also be returned when you try to create a directory with
186    incorrect parameters - what does it mean? maybe created temporary file? */
187 #define NTCREATEX_ACTION_UNKNOWN 5
188
189 /* used to hold an arbitrary blob of data */
190 typedef struct datablob {
191         uint8_t *data;
192         size_t length;
193 } DATA_BLOB;
194
195 /* by making struct ldb_val and DATA_BLOB the same, we can simplify
196    a fair bit of code */
197 #define ldb_val datablob
198
199 /* 64 bit time (100 nanosec) 1601 - cifs6.txt, section 3.5, page 30, 4 byte aligned */
200 typedef uint64_t NTTIME;
201
202 /* the basic packet size, assuming no words or bytes. Does not include the NBT header */
203 #define MIN_SMB_SIZE 35
204
205 /* when using NBT encapsulation every packet has a 4 byte header */
206 #define NBT_HDR_SIZE 4
207
208 /* offsets into message header for common items - NOTE: These have
209    changed from being offsets from the base of the NBT packet to the base of the SMB packet.
210    this has reduced all these values by 4
211 */
212 #define HDR_COM 4
213 #define HDR_RCLS 5
214 #define HDR_REH 6
215 #define HDR_ERR 7
216 #define HDR_FLG 9
217 #define HDR_FLG2 10
218 #define HDR_PIDHIGH 12
219 #define HDR_SS_FIELD 14
220 #define HDR_TID 24
221 #define HDR_PID 26
222 #define HDR_UID 28
223 #define HDR_MID 30
224 #define HDR_WCT 32
225 #define HDR_VWV 33
226
227
228 /* types of buffers in core SMB protocol */
229 #define SMB_DATA_BLOCK 0x1
230 #define SMB_ASCII4     0x4
231
232
233 /* flag defines. CIFS spec 3.1.1 */
234 #define FLAG_SUPPORT_LOCKREAD       0x01
235 #define FLAG_CLIENT_BUF_AVAIL       0x02
236 #define FLAG_RESERVED               0x04
237 #define FLAG_CASELESS_PATHNAMES     0x08
238 #define FLAG_CANONICAL_PATHNAMES    0x10
239 #define FLAG_REQUEST_OPLOCK         0x20
240 #define FLAG_REQUEST_BATCH_OPLOCK   0x40
241 #define FLAG_REPLY                  0x80
242
243 /* the complete */
244 #define SMBmkdir      0x00   /* create directory */
245 #define SMBrmdir      0x01   /* delete directory */
246 #define SMBopen       0x02   /* open file */
247 #define SMBcreate     0x03   /* create file */
248 #define SMBclose      0x04   /* close file */
249 #define SMBflush      0x05   /* flush file */
250 #define SMBunlink     0x06   /* delete file */
251 #define SMBmv         0x07   /* rename file */
252 #define SMBgetatr     0x08   /* get file attributes */
253 #define SMBsetatr     0x09   /* set file attributes */
254 #define SMBread       0x0A   /* read from file */
255 #define SMBwrite      0x0B   /* write to file */
256 #define SMBlock       0x0C   /* lock byte range */
257 #define SMBunlock     0x0D   /* unlock byte range */
258 #define SMBctemp      0x0E   /* create temporary file */
259 #define SMBmknew      0x0F   /* make new file */
260 #define SMBchkpth     0x10   /* check directory path */
261 #define SMBexit       0x11   /* process exit */
262 #define SMBlseek      0x12   /* seek */
263 #define SMBtcon       0x70   /* tree connect */
264 #define SMBtconX      0x75   /* tree connect and X*/
265 #define SMBtdis       0x71   /* tree disconnect */
266 #define SMBnegprot    0x72   /* negotiate protocol */
267 #define SMBdskattr    0x80   /* get disk attributes */
268 #define SMBsearch     0x81   /* search directory */
269 #define SMBsplopen    0xC0   /* open print spool file */
270 #define SMBsplwr      0xC1   /* write to print spool file */
271 #define SMBsplclose   0xC2   /* close print spool file */
272 #define SMBsplretq    0xC3   /* return print queue */
273 #define SMBsends      0xD0   /* send single block message */
274 #define SMBsendb      0xD1   /* send broadcast message */
275 #define SMBfwdname    0xD2   /* forward user name */
276 #define SMBcancelf    0xD3   /* cancel forward */
277 #define SMBgetmac     0xD4   /* get machine name */
278 #define SMBsendstrt   0xD5   /* send start of multi-block message */
279 #define SMBsendend    0xD6   /* send end of multi-block message */
280 #define SMBsendtxt    0xD7   /* send text of multi-block message */
281
282 /* Core+ protocol */
283 #define SMBlockread       0x13   /* Lock a range and read */
284 #define SMBwriteunlock 0x14 /* write then range then unlock it */
285 #define SMBreadbraw   0x1a  /* read a block of data with no smb header */
286 #define SMBwritebraw  0x1d  /* write a block of data with no smb header */
287 #define SMBwritec     0x20  /* secondary write request */
288 #define SMBwriteclose 0x2c  /* write a file then close it */
289
290 /* dos extended protocol */
291 #define SMBreadBraw      0x1A   /* read block raw */
292 #define SMBreadBmpx      0x1B   /* read block multiplexed */
293 #define SMBreadBs        0x1C   /* read block (secondary response) */
294 #define SMBwriteBraw     0x1D   /* write block raw */
295 #define SMBwriteBmpx     0x1E   /* write block multiplexed */
296 #define SMBwriteBs       0x1F   /* write block (secondary request) */
297 #define SMBwriteC        0x20   /* write complete response */
298 #define SMBsetattrE      0x22   /* set file attributes expanded */
299 #define SMBgetattrE      0x23   /* get file attributes expanded */
300 #define SMBlockingX      0x24   /* lock/unlock byte ranges and X */
301 #define SMBtrans         0x25   /* transaction - name, bytes in/out */
302 #define SMBtranss        0x26   /* transaction (secondary request/response) */
303 #define SMBioctl         0x27   /* IOCTL */
304 #define SMBioctls        0x28   /* IOCTL  (secondary request/response) */
305 #define SMBcopy          0x29   /* copy */
306 #define SMBmove          0x2A   /* move */
307 #define SMBecho          0x2B   /* echo */
308 #define SMBopenX         0x2D   /* open and X */
309 #define SMBreadX         0x2E   /* read and X */
310 #define SMBwriteX        0x2F   /* write and X */
311 #define SMBsesssetupX    0x73   /* Session Set Up & X (including User Logon) */
312 #define SMBffirst        0x82   /* find first */
313 #define SMBfunique       0x83   /* find unique */
314 #define SMBfclose        0x84   /* find close */
315 #define SMBkeepalive     0x85   /* keepalive */
316 #define SMBinvalid       0xFE   /* invalid command */
317
318 /* Extended 2.0 protocol */
319 #define SMBtrans2        0x32   /* TRANS2 protocol set */
320 #define SMBtranss2       0x33   /* TRANS2 protocol set, secondary command */
321 #define SMBfindclose     0x34   /* Terminate a TRANSACT2_FINDFIRST */
322 #define SMBfindnclose    0x35   /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
323 #define SMBulogoffX      0x74   /* user logoff */
324
325 /* NT SMB extensions. */
326 #define SMBnttrans       0xA0   /* NT transact */
327 #define SMBnttranss      0xA1   /* NT transact secondary */
328 #define SMBntcreateX     0xA2   /* NT create and X */
329 #define SMBntcancel      0xA4   /* NT cancel */
330 #define SMBntrename      0xA5   /* NT rename */
331
332 /* used to indicate end of chain */
333 #define SMB_CHAIN_NONE   0xFF
334
335 /* These are the trans subcommands */
336 #define TRANSACT_SETNAMEDPIPEHANDLESTATE  0x01 
337 #define TRANSACT_DCERPCCMD                0x26
338 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
339
340 /* These are the NT transact sub commands. */
341 #define NT_TRANSACT_CREATE                1
342 #define NT_TRANSACT_IOCTL                 2
343 #define NT_TRANSACT_SET_SECURITY_DESC     3
344 #define NT_TRANSACT_NOTIFY_CHANGE         4
345 #define NT_TRANSACT_RENAME                5
346 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
347
348 /* this is used on a TConX. I'm not sure the name is very helpful though */
349 #define SMB_SUPPORT_SEARCH_BITS        0x0001
350 #define SMB_SHARE_IN_DFS               0x0002
351
352 /* Named pipe write mode flags. Used in writeX calls. */
353 #define PIPE_RAW_MODE 0x4
354 #define PIPE_START_MESSAGE 0x8
355
356 /* the desired access to use when opening a pipe */
357 #define DESIRED_ACCESS_PIPE 0x2019f
358  
359
360 /* Mapping of generic access rights for files to specific rights. */
361 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| NT_ACCESS_SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
362
363 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
364                                                         FILE_READ_EA|NT_ACCESS_SYNCHRONIZE_ACCESS)
365
366 #define FILE_GENERIC_WRITE (STANDARD_RIGHTS_WRITE_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
367                             FILE_WRITE_EA|FILE_APPEND_DATA|NT_ACCESS_SYNCHRONIZE_ACCESS)
368
369 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
370                             FILE_EXECUTE|NT_ACCESS_SYNCHRONIZE_ACCESS)
371
372
373 /* FileAttributes (search attributes) field */
374 #define FILE_ATTRIBUTE_READONLY         0x0001
375 #define FILE_ATTRIBUTE_HIDDEN           0x0002
376 #define FILE_ATTRIBUTE_SYSTEM           0x0004
377 #define FILE_ATTRIBUTE_VOLUME           0x0008
378 #define FILE_ATTRIBUTE_DIRECTORY        0x0010
379 #define FILE_ATTRIBUTE_ARCHIVE          0x0020
380 #define FILE_ATTRIBUTE_DEVICE           0x0040
381 #define FILE_ATTRIBUTE_NORMAL           0x0080
382 #define FILE_ATTRIBUTE_TEMPORARY        0x0100
383 #define FILE_ATTRIBUTE_SPARSE           0x0200
384 #define FILE_ATTRIBUTE_REPARSE_POINT    0x0400
385 #define FILE_ATTRIBUTE_COMPRESSED       0x0800
386 #define FILE_ATTRIBUTE_OFFLINE          0x1000
387 #define FILE_ATTRIBUTE_NONINDEXED       0x2000
388 #define FILE_ATTRIBUTE_ENCRYPTED        0x4000
389
390 /* Flags - combined with attributes. */
391 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
392 #define FILE_FLAG_NO_BUFFERING     0x20000000L
393 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
394 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
395 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
396 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
397 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
398
399 /* Responses when opening a file. */
400 #define FILE_WAS_SUPERSEDED 0
401 #define FILE_WAS_OPENED 1
402 #define FILE_WAS_CREATED 2
403 #define FILE_WAS_OVERWRITTEN 3
404
405 /* File type flags */
406 #define FILE_TYPE_DISK  0
407 #define FILE_TYPE_BYTE_MODE_PIPE 1
408 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
409 #define FILE_TYPE_PRINTER 3
410 #define FILE_TYPE_COMM_DEVICE 4
411 #define FILE_TYPE_UNKNOWN 0xFFFF
412
413 /* Flag for NT transact rename call. */
414 #define RENAME_REPLACE_IF_EXISTS 1
415
416 /* flags for SMBntrename call */
417 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
418 #define RENAME_FLAG_HARD_LINK                0x103
419 #define RENAME_FLAG_RENAME                   0x104
420 #define RENAME_FLAG_COPY                     0x105
421
422 /* Filesystem Attributes. */
423 #define FILE_CASE_SENSITIVE_SEARCH 0x01
424 #define FILE_CASE_PRESERVED_NAMES 0x02
425 #define FILE_UNICODE_ON_DISK 0x04
426 /* According to cifs9f, this is 4, not 8 */
427 /* Acconding to testing, this actually sets the security attribute! */
428 #define FILE_PERSISTENT_ACLS 0x08
429 /* These entries added from cifs9f --tsb */
430 #define FILE_FILE_COMPRESSION 0x10
431 #define FILE_VOLUME_QUOTAS 0x20
432 /* I think this is wrong. JRA #define FILE_DEVICE_IS_MOUNTED 0x20 */
433 #define FILE_VOLUME_SPARSE_FILE 0x40
434 #define FILE_VOLUME_IS_COMPRESSED 0x8000
435
436 /* ChangeNotify flags. */
437 #define FILE_NOTIFY_CHANGE_FILE        0x001
438 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
439 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
440 #define FILE_NOTIFY_CHANGE_SIZE        0x008
441 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
442 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
443 #define FILE_NOTIFY_CHANGE_CREATION    0x040
444 #define FILE_NOTIFY_CHANGE_EA          0x080
445 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
446 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x200
447
448 /* change notify action results */
449 #define NOTIFY_ACTION_ADDED 1
450 #define NOTIFY_ACTION_REMOVED 2
451 #define NOTIFY_ACTION_MODIFIED 3
452 #define NOTIFY_ACTION_OLD_NAME 4
453 #define NOTIFY_ACTION_NEW_NAME 5
454 #define NOTIFY_ACTION_ADDED_STREAM 6
455 #define NOTIFY_ACTION_REMOVED_STREAM 7
456 #define NOTIFY_ACTION_MODIFIED_STREAM 8
457
458 /* seek modes for smb_seek */
459 #define SEEK_MODE_START   0
460 #define SEEK_MODE_CURRENT 1
461 #define SEEK_MODE_END     2
462
463 /* where to find the base of the SMB packet proper */
464 /* REWRITE TODO: smb_base needs to be removed */
465 #define smb_base(buf) (((char *)(buf))+4)
466
467 /* we don't allow server strings to be longer than 48 characters as
468    otherwise NT will not honour the announce packets */
469 #define MAX_SERVER_STRING_LENGTH 48
470
471 /* This was set by JHT in liaison with Jeremy Allison early 1997
472  * History:
473  * Version 4.0 - never made public
474  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
475  *              - Reappeared in 1.9.16p11 with fixed smbd services
476  * Version 4.20 - To indicate that nmbd and browsing now works better
477  * Version 4.50 - Set at release of samba-2.2.0 by JHT
478  *
479  *  Note: In the presence of NT4.X do not set above 4.9
480  *        Setting this above 4.9 can have undesired side-effects.
481  *        This may change again in Samba-3.0 after further testing. JHT
482  */
483  
484 #define DEFAULT_MAJOR_VERSION 0x04
485 #define DEFAULT_MINOR_VERSION 0x09
486
487 /* Browser Election Values */
488 #define BROWSER_ELECTION_VERSION        0x010f
489 #define BROWSER_CONSTANT        0xaa55
490
491 /* Sercurity mode bits. */
492 #define NEGOTIATE_SECURITY_USER_LEVEL           0x01
493 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE   0x02
494 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED   0x04
495 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED  0x08
496
497 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
498 #define FLAGS2_LONG_PATH_COMPONENTS    0x0001
499 #define FLAGS2_EXTENDED_ATTRIBUTES     0x0002
500 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
501 #define FLAGS2_IS_LONG_NAME            0x0040
502 #define FLAGS2_EXTENDED_SECURITY       0x0800 
503 #define FLAGS2_DFS_PATHNAMES           0x1000
504 #define FLAGS2_READ_PERMIT_EXECUTE     0x2000
505 #define FLAGS2_32_BIT_ERROR_CODES      0x4000 
506 #define FLAGS2_UNICODE_STRINGS         0x8000
507
508
509 /* CIFS protocol capabilities */
510 #define CAP_RAW_MODE            0x00000001
511 #define CAP_MPX_MODE            0x00000002
512 #define CAP_UNICODE             0x00000004
513 #define CAP_LARGE_FILES         0x00000008
514 #define CAP_NT_SMBS             0x00000010
515 #define CAP_RPC_REMOTE_APIS     0x00000020
516 #define CAP_STATUS32            0x00000040
517 #define CAP_LEVEL_II_OPLOCKS    0x00000080
518 #define CAP_LOCK_AND_READ       0x00000100
519 #define CAP_NT_FIND             0x00000200
520 #define CAP_DFS                 0x00001000
521 #define CAP_W2K_SMBS            0x00002000
522 #define CAP_LARGE_READX         0x00004000
523 #define CAP_LARGE_WRITEX        0x00008000
524 #define CAP_UNIX                0x00800000 /* Capabilities for UNIX extensions. Created by HP. */
525 #define CAP_EXTENDED_SECURITY   0x80000000
526
527 /*
528  * Global value meaning that the smb_uid field should be
529  * ingored (in share level security and protocol level == CORE)
530  */
531
532 #define UID_FIELD_INVALID 0
533
534 /* Lock types. */
535 #define LOCKING_ANDX_SHARED_LOCK     0x01
536 #define LOCKING_ANDX_OPLOCK_RELEASE  0x02
537 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x04
538 #define LOCKING_ANDX_CANCEL_LOCK     0x08
539 #define LOCKING_ANDX_LARGE_FILES     0x10
540
541 /*
542  * Bits we test with.
543  */
544
545 #define OPLOCK_NONE      0
546 #define OPLOCK_EXCLUSIVE 1
547 #define OPLOCK_BATCH     2
548 #define OPLOCK_LEVEL_II  4
549
550 #define CORE_OPLOCK_GRANTED (1<<5)
551 #define EXTENDED_OPLOCK_GRANTED (1<<15)
552
553 /*
554  * Return values for oplock types.
555  */
556
557 #define NO_OPLOCK_RETURN 0
558 #define EXCLUSIVE_OPLOCK_RETURN 1
559 #define BATCH_OPLOCK_RETURN 2
560 #define LEVEL_II_OPLOCK_RETURN 3
561
562 #define CMD_REPLY 0x8000
563
564 /* The maximum length of a trust account password.
565    Used when we randomly create it, 15 char passwords
566    exceed NT4's max password length */
567
568 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
569
570 /* passed to br lock code */
571 enum brl_type {READ_LOCK, WRITE_LOCK, PENDING_READ_LOCK, PENDING_WRITE_LOCK};
572
573 /* string manipulation flags - see clistr.c and srvstr.c */
574 #define STR_TERMINATE 1
575 #define STR_UPPER 2
576 #define STR_ASCII 4
577 #define STR_UNICODE 8
578 #define STR_NOALIGN 16
579 #define STR_NO_RANGE_CHECK 32
580 #define STR_LEN8BIT 64
581 #define STR_TERMINATE_ASCII 128 /* only terminate if ascii */
582 #define STR_LEN_NOTERM 256 /* the length field is the unterminated length */
583
584
585 /*
586   filesystem attribute bits
587 */
588 #define FS_ATTR_CASE_SENSITIVE_SEARCH             0x00000001
589 #define FS_ATTR_CASE_PRESERVED_NAMES              0x00000002
590 #define FS_ATTR_UNICODE_ON_DISK                   0x00000004
591 #define FS_ATTR_PERSISTANT_ACLS                   0x00000008
592 #define FS_ATTR_COMPRESSION                       0x00000010
593 #define FS_ATTR_QUOTAS                            0x00000020
594 #define FS_ATTR_SPARSE_FILES                      0x00000040
595 #define FS_ATTR_REPARSE_POINTS                    0x00000080
596 #define FS_ATTR_REMOTE_STORAGE                    0x00000100
597 #define FS_ATTR_LFN_SUPPORT                       0x00004000
598 #define FS_ATTR_IS_COMPRESSED                     0x00008000
599 #define FS_ATTR_OBJECT_IDS                        0x00010000
600 #define FS_ATTR_ENCRYPTION                        0x00020000
601 #define FS_ATTR_NAMED_STREAMS                     0x00040000
602
603
604 #endif /* _SMB_H */