First cut at unicode sys_xx functions. Now to start moving upwards.....
[kai/samba.git] / source3 / include / smb.h
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    SMB parameters and setup
5    Copyright (C) Andrew Tridgell 1992-1998
6    Copyright (C) John H Terpstra 1996-1998
7    Copyright (C) Luke Kenneth Casson Leighton 1996-1998
8    Copyright (C) Paul Ashton 1998
9    
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 2 of the License, or
13    (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., 675 Mass Ave, Cambridge, MA 02139, USA.
23 */
24 #ifndef _SMB_H
25 #define _SMB_H
26
27 #define BUFFER_SIZE (0xFFFF)
28 #define SAFETY_MARGIN 1024
29
30 #define NMB_PORT 137
31 #define DGRAM_PORT 138
32 #define SMB_PORT 139
33
34 #define False (0)
35 #define True (1)
36 #define BOOLSTR(b) ((b) ? "Yes" : "No")
37 #define BITSETB(ptr,bit) ((((char *)ptr)[0] & (1<<(bit)))!=0)
38 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
39
40 #define IS_BITS_SET_ALL(var,bit) (((var)&(bit))==(bit))
41 #define IS_BITS_SET_SOME(var,bit) (((var)&(bit))!=0)
42 #define IS_BITS_CLR_ALL(var,bit) (((var)&(bit))==0)
43
44 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
45
46 typedef int BOOL;
47
48 /* limiting size of ipc replies */
49 #define REALLOC(ptr,size) Realloc(ptr,MAX((size),4*1024))
50
51 #define SIZEOFWORD 2
52
53 #ifndef DEF_CREATE_MASK
54 #define DEF_CREATE_MASK (0755)
55 #endif
56
57 /* how long to wait for secondary SMB packets (milli-seconds) */
58 #define SMB_SECONDARY_WAIT (60*1000)
59
60 /* -------------------------------------------------------------------------- **
61  * Debugging code.  See also debug.c
62  */
63
64 /* mkproto.awk has trouble with ifdef'd function definitions (it ignores
65  * the #ifdef directive and will read both definitions, thus creating two
66  * diffferent prototype declarations), so we must do these by hand.
67  */
68 /* I know the __attribute__ stuff is ugly, but it does ensure we get the 
69    arguemnts to DEBUG() right. We have got them wrong too often in the 
70    past */
71 #ifdef HAVE_STDARG_H
72 int  Debug1( char *, ... )
73 #ifdef __GNUC__
74      __attribute__ ((format (printf, 1, 2)))
75 #endif
76 ;
77 BOOL dbgtext( char *, ... )
78 #ifdef __GNUC__
79      __attribute__ ((format (printf, 1, 2)))
80 #endif
81 ;
82 #else
83 int  Debug1();
84 BOOL dbgtext();
85 #endif
86
87 /* If we have these macros, we can add additional info to the header. */
88 #ifdef HAVE_FILE_MACRO
89 #define FILE_MACRO (__FILE__)
90 #else
91 #define FILE_MACRO ("")
92 #endif
93
94 #ifdef HAVE_FUNCTION_MACRO
95 #define FUNCTION_MACRO  (__FUNCTION__)
96 #else
97 #define FUNCTION_MACRO  ("")
98 #endif
99
100 /* Debugging macros. 
101  *  DEBUGLVL() - If level is <= the system-wide DEBUGLEVEL then generate a
102  *               header using the default macros for file, line, and
103  *               function name.
104  *               Returns True if the debug level was <= DEBUGLEVEL.
105  *               Example usage:
106  *                 if( DEBUGLVL( 2 ) )
107  *                   dbgtext( "Some text.\n" );
108  *  DEGUG()    - Good old DEBUG().  Each call to DEBUG() will generate a new
109  *               header *unless* the previous debug output was unterminated
110  *               (i.e., no '\n').  See debug.c:dbghdr() for more info.
111  *               Example usage:
112  *                 DEBUG( 2, ("Some text.\n") );
113  *  DEBUGADD() - If level <= DEBUGLEVEL, then the text is appended to the
114  *               current message (i.e., no header).
115  *               Usage:
116  *                 DEBUGADD( 2, ("Some additional text.\n") );
117  */
118 #define DEBUGLVL( level ) \
119   ( (DEBUGLEVEL >= (level)) \
120    && dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) ) )
121
122 #if 0
123
124 #define DEBUG( level, body ) \
125   ( ( DEBUGLEVEL >= (level) \
126    && dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) ) ) \
127       ? (void)(dbgtext body) : (void)0 )
128
129 #define DEBUGADD( level, body ) \
130      ( (DEBUGLEVEL >= (level)) ? (void)(dbgtext body) : (void)0 )
131
132 #else
133
134 #define DEBUG( level, body ) \
135   (void)( (DEBUGLEVEL >= (level)) \
136        && (dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) )) \
137        && (dbgtext body) )
138
139 #define DEBUGADD( level, body ) \
140   (void)( (DEBUGLEVEL >= (level)) && (dbgtext body) )
141
142 #endif
143
144 /* End Debugging code section.
145  * -------------------------------------------------------------------------- **
146  */
147
148 /* this defines the error codes that receive_smb can put in smb_read_error */
149 #define READ_TIMEOUT 1
150 #define READ_EOF 2
151 #define READ_ERROR 3
152
153
154 #define DIR_STRUCT_SIZE 43
155
156 /* these define all the command types recognised by the server - there
157 are lots of gaps so probably there are some rare commands that are not
158 implemented */
159
160 #define pSETDIR '\377'
161
162 /* these define the attribute byte as seen by DOS */
163 #define aRONLY (1L<<0)
164 #define aHIDDEN (1L<<1)
165 #define aSYSTEM (1L<<2)
166 #define aVOLID (1L<<3)
167 #define aDIR (1L<<4)
168 #define aARCH (1L<<5)
169
170 /* for readability... */
171 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
172 #define IS_DOS_DIR(test_mode) (((test_mode) & aDIR) != 0)
173 #define IS_DOS_ARCHIVE(test_mode) (((test_mode) & aARCH) != 0)
174 #define IS_DOS_SYSTEM(test_mode) (((test_mode) & aSYSTEM) != 0)
175 #define IS_DOS_HIDDEN(test_mode) (((test_mode) & aHIDDEN) != 0)
176
177 /* deny modes */
178 #define DENY_DOS 0
179 #define DENY_ALL 1
180 #define DENY_WRITE 2
181 #define DENY_READ 3
182 #define DENY_NONE 4
183 #define DENY_FCB 7
184
185 /* open modes */
186 #define DOS_OPEN_RDONLY 0
187 #define DOS_OPEN_WRONLY 1
188 #define DOS_OPEN_RDWR 2
189 #define DOS_OPEN_FCB 0xF
190
191 /* define shifts and masks for share and open modes. */
192 #define OPEN_MODE_MASK 0xF
193 #define SHARE_MODE_SHIFT 4
194 #define SHARE_MODE_MASK 0x7
195 #define GET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
196 #define SET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
197 #define GET_DENY_MODE(x) (((x)>>SHARE_MODE_SHIFT) & SHARE_MODE_MASK)
198 #define SET_DENY_MODE(x) ((x)<<SHARE_MODE_SHIFT)
199
200 /* Sync on open file (not sure if used anymore... ?) */
201 #define FILE_SYNC_OPENMODE (1<<14)
202 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
203
204 /* allow delete on open file mode (used by NT SMB's). */
205 #define ALLOW_SHARE_DELETE (1<<15)
206 #define GET_ALLOW_SHARE_DELETE(x) (((x) & ALLOW_SHARE_DELETE) ? True : False)
207 #define SET_ALLOW_SHARE_DELETE(x) ((x) ? ALLOW_SHARE_DELETE : 0)
208
209 /* delete on close flag (used by NT SMB's). */
210 #define DELETE_ON_CLOSE_FLAG (1<<16)
211 #define GET_DELETE_ON_CLOSE_FLAG(x) (((x) & DELETE_ON_CLOSE_FLAG) ? True : False)
212 #define SET_DELETE_ON_CLOSE_FLAG(x) ((x) ? DELETE_ON_CLOSE_FLAG : 0)
213
214 /* open disposition values */
215 #define FILE_EXISTS_FAIL 0
216 #define FILE_EXISTS_OPEN 1
217 #define FILE_EXISTS_TRUNCATE 2
218
219 /* mask for open disposition. */
220 #define FILE_OPEN_MASK 0x3
221
222 #define GET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
223 #define SET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
224
225 /* The above can be OR'ed with... */
226 #define FILE_CREATE_IF_NOT_EXIST 0x10
227 #define FILE_FAIL_IF_NOT_EXIST 0
228
229 #define GET_FILE_CREATE_DISPOSITION(x) ((x) & (FILE_CREATE_IF_NOT_EXIST|FILE_FAIL_IF_NOT_EXIST))
230
231 /* share types */
232 #define STYPE_DISKTREE  0       /* Disk drive */
233 #define STYPE_PRINTQ    1       /* Spooler queue */
234 #define STYPE_DEVICE    2       /* Serial device */
235 #define STYPE_IPC       3       /* Interprocess communication (IPC) */
236 #define STYPE_HIDDEN    0x80000000 /* share is a hidden one (ends with $) */
237
238 /* SMB X/Open error codes for the ERRDOS error class */
239 #define ERRbadfunc 1 /* Invalid function (or system call) */
240 #define ERRbadfile 2 /* File not found (pathname error) */
241 #define ERRbadpath 3 /* Directory not found */
242 #define ERRnofids 4 /* Too many open files */
243 #define ERRnoaccess 5 /* Access denied */
244 #define ERRbadfid 6 /* Invalid fid */
245 #define ERRnomem 8 /* Out of memory */
246 #define ERRbadmem 9 /* Invalid memory block address */
247 #define ERRbadenv 10 /* Invalid environment */
248 #define ERRbadaccess 12 /* Invalid open mode */
249 #define ERRbaddata 13 /* Invalid data (only from ioctl call) */
250 #define ERRres 14 /* reserved */
251 #define ERRbaddrive 15 /* Invalid drive */
252 #define ERRremcd 16 /* Attempt to delete current directory */
253 #define ERRdiffdevice 17 /* rename/move across different filesystems */
254 #define ERRnofiles 18 /* no more files found in file search */
255 #define ERRbadshare 32 /* Share mode on file conflict with open mode */
256 #define ERRlock 33 /* Lock request conflicts with existing lock */
257 #define ERRunsup 50 /* Request unsupported, returned by Win 95, RJS 20Jun98 */
258 #define ERRfilexists 80 /* File in operation already exists */
259 #define ERRcannotopen 110 /* Cannot open the file specified */
260 #define ERRunknownlevel 124
261 #define ERRrename 183
262 #define ERRbadpipe 230 /* Named pipe invalid */
263 #define ERRpipebusy 231 /* All instances of pipe are busy */
264 #define ERRpipeclosing 232 /* named pipe close in progress */
265 #define ERRnotconnected 233 /* No process on other end of named pipe */
266 #define ERRmoredata 234 /* More data to be returned */
267 #define ERRbaddirectory 267 /* Invalid directory name in a path. */
268 #define ERROR_EAS_DIDNT_FIT 275 /* Extended attributes didn't fit */
269 #define ERROR_EAS_NOT_SUPPORTED 282 /* Extended attributes not supported */
270 #define ERROR_NOTIFY_ENUM_DIR 1022 /* Buffer too small to return change notify. */
271 #define ERRunknownipc 2142
272
273
274 /* here's a special one from observing NT */
275 #define ERRnoipc 66 /* don't support ipc */
276
277 /* Error codes for the ERRSRV class */
278
279 #define ERRerror 1 /* Non specific error code */
280 #define ERRbadpw 2 /* Bad password */
281 #define ERRbadtype 3 /* reserved */
282 #define ERRaccess 4 /* No permissions to do the requested operation */
283 #define ERRinvnid 5 /* tid invalid */
284 #define ERRinvnetname 6 /* Invalid servername */
285 #define ERRinvdevice 7 /* Invalid device */
286 #define ERRqfull 49 /* Print queue full */
287 #define ERRqtoobig 50 /* Queued item too big */
288 #define ERRinvpfid 52 /* Invalid print file in smb_fid */
289 #define ERRsmbcmd 64 /* Unrecognised command */
290 #define ERRsrverror 65 /* smb server internal error */
291 #define ERRfilespecs 67 /* fid and pathname invalid combination */
292 #define ERRbadlink 68 /* reserved */
293 #define ERRbadpermits 69 /* Access specified for a file is not valid */
294 #define ERRbadpid 70 /* reserved */
295 #define ERRsetattrmode 71 /* attribute mode invalid */
296 #define ERRpaused 81 /* Message server paused */
297 #define ERRmsgoff 82 /* Not receiving messages */
298 #define ERRnoroom 83 /* No room for message */
299 #define ERRrmuns 87 /* too many remote usernames */
300 #define ERRtimeout 88 /* operation timed out */
301 #define ERRnoresource  89 /* No resources currently available for request. */
302 #define ERRtoomanyuids 90 /* too many userids */
303 #define ERRbaduid 91 /* bad userid */
304 #define ERRuseMPX 250 /* temporarily unable to use raw mode, use MPX mode */
305 #define ERRuseSTD 251 /* temporarily unable to use raw mode, use standard mode */
306 #define ERRcontMPX 252 /* resume MPX mode */
307 #define ERRbadPW /* reserved */
308 #define ERRnosupport 0xFFFF
309 #define ERRunknownsmb 22 /* from NT 3.5 response */
310
311
312 /* Error codes for the ERRHRD class */
313
314 #define ERRnowrite 19 /* read only media */
315 #define ERRbadunit 20 /* Unknown device */
316 #define ERRnotready 21 /* Drive not ready */
317 #define ERRbadcmd 22 /* Unknown command */
318 #define ERRdata 23 /* Data (CRC) error */
319 #define ERRbadreq 24 /* Bad request structure length */
320 #define ERRseek 25
321 #define ERRbadmedia 26
322 #define ERRbadsector 27
323 #define ERRnopaper 28
324 #define ERRwrite 29 /* write fault */
325 #define ERRread 30 /* read fault */
326 #define ERRgeneral 31 /* General hardware failure */
327 #define ERRwrongdisk 34
328 #define ERRFCBunavail 35
329 #define ERRsharebufexc 36 /* share buffer exceeded */
330 #define ERRdiskfull 39
331
332
333 typedef char pstring[1024];
334 typedef char fstring[128];
335
336 /*
337  * SMB UCS2 (16-bit unicode) internal type.
338  */
339
340 typedef uint16 smb_ucs2_t;
341
342 /* ucs2 string types. */
343 typedef smb_ucs2_t wpstring[1024];
344 typedef smb_ucs2_t wfstring[128];
345
346 /* pipe string names */
347 #define PIPE_LANMAN   "\\PIPE\\LANMAN"
348 #define PIPE_SRVSVC   "\\PIPE\\srvsvc"
349 #define PIPE_SAMR     "\\PIPE\\samr"
350 #define PIPE_WINREG   "\\PIPE\\winreg"
351 #define PIPE_WKSSVC   "\\PIPE\\wkssvc"
352 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
353 #define PIPE_NTLSA    "\\PIPE\\ntlsa"
354 #define PIPE_NTSVCS   "\\PIPE\\ntsvcs"
355 #define PIPE_LSASS    "\\PIPE\\lsass"
356 #define PIPE_LSARPC   "\\PIPE\\lsarpc"
357
358
359 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
360 typedef struct nttime_info
361 {
362   uint32 low;
363   uint32 high;
364
365 } NTTIME;
366
367 /* Allowable account control bits */
368 #define ACB_DISABLED   0x0001  /* 1 = User account disabled */
369 #define ACB_HOMDIRREQ  0x0002  /* 1 = Home directory required */
370 #define ACB_PWNOTREQ   0x0004  /* 1 = User password not required */
371 #define ACB_TEMPDUP    0x0008  /* 1 = Temporary duplicate account */
372 #define ACB_NORMAL     0x0010  /* 1 = Normal user account */
373 #define ACB_MNS        0x0020  /* 1 = MNS logon user account */
374 #define ACB_DOMTRUST   0x0040  /* 1 = Interdomain trust account */
375 #define ACB_WSTRUST    0x0080  /* 1 = Workstation trust account */
376 #define ACB_SVRTRUST   0x0100  /* 1 = Server trust account */
377 #define ACB_PWNOEXP    0x0200  /* 1 = User password does not expire */
378 #define ACB_AUTOLOCK   0x0400  /* 1 = Account auto locked */
379  
380 #define MAX_HOURS_LEN 32
381
382 struct sam_passwd
383 {
384         time_t logon_time;            /* logon time */
385         time_t logoff_time;           /* logoff time */
386         time_t kickoff_time;          /* kickoff time */
387         time_t pass_last_set_time;    /* password last set time */
388         time_t pass_can_change_time;  /* password can change time */
389         time_t pass_must_change_time; /* password must change time */
390
391         char *smb_name;     /* username string */
392         char *full_name;    /* user's full name string */
393         char *home_dir;     /* home directory string */
394         char *dir_drive;    /* home directory drive string */
395         char *logon_script; /* logon script string */
396         char *profile_path; /* profile path string */
397         char *acct_desc  ;  /* user description string */
398         char *workstations; /* login from workstations string */
399         char *unknown_str ; /* don't know what this is, yet. */
400         char *munged_dial ; /* munged path name and dial-back tel number */
401
402         uid_t smb_userid;       /* this is actually the unix uid_t */
403         gid_t smb_grpid;        /* this is actually the unix gid_t */
404         uint32 user_rid;      /* Primary User ID */
405         uint32 group_rid;     /* Primary Group ID */
406
407         unsigned char *smb_passwd; /* Null if no password */
408         unsigned char *smb_nt_passwd; /* Null if no password */
409
410         uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
411         uint32 unknown_3; /* 0x00ff ffff */
412
413         uint16 logon_divs; /* 168 - number of hours in a week */
414         uint32 hours_len; /* normally 21 bytes */
415         uint8 hours[MAX_HOURS_LEN];
416
417         uint32 unknown_5; /* 0x0002 0000 */
418         uint32 unknown_6; /* 0x0000 04ec */
419 };
420
421 struct smb_passwd
422 {
423         uid_t smb_userid;     /* this is actually the unix uid_t */
424         char *smb_name;     /* username string */
425
426         unsigned char *smb_passwd; /* Null if no password */
427         unsigned char *smb_nt_passwd; /* Null if no password */
428
429         uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
430         time_t pass_last_set_time;    /* password last set time */
431 };
432
433
434 struct sam_disp_info
435 {
436         uint32 user_rid;      /* Primary User ID */
437         char *smb_name;     /* username string */
438         char *full_name;    /* user's full name string */
439 };
440
441 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
442
443 /* DOM_SID - security id */
444 typedef struct sid_info
445 {
446   uint8  sid_rev_num;             /* SID revision number */
447   uint8  num_auths;               /* number of sub-authorities */
448   uint8  id_auth[6];              /* Identifier Authority */
449   /*
450    * Note that the values in these uint32's are in *native* byteorder,
451    * not neccessarily little-endian...... JRA.
452    */
453   uint32 sub_auths[MAXSUBAUTHS];  /* pointer to sub-authorities. */
454
455 } DOM_SID;
456
457
458 /*** query a local group, get a list of these: shows who is in that group ***/
459
460 /* local group member info */
461 typedef struct local_grp_member_info
462 {
463         DOM_SID sid    ; /* matches with name */
464         uint8   sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
465         fstring name   ; /* matches with sid: must be of the form "DOMAIN\account" */
466
467 } LOCAL_GRP_MEMBER;
468
469 /* enumerate these to get list of local groups */
470
471 /* local group info */
472 typedef struct local_grp_info
473 {
474         fstring name;
475         fstring comment;
476
477 } LOCAL_GRP;
478
479 /*** enumerate these to get list of domain groups ***/
480
481 /* domain group member info */
482 typedef struct domain_grp_info
483 {
484         fstring name;
485         fstring comment;
486         uint32  rid; /* group rid */
487         uint8   attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
488
489 } DOMAIN_GRP;
490
491 /*** query a domain group, get a list of these: shows who is in that group ***/
492
493 /* domain group info */
494 typedef struct domain_grp_member_info
495 {
496         fstring name;
497         uint8   attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
498
499 } DOMAIN_GRP_MEMBER;
500
501 /* DOM_CHAL - challenge info */
502 typedef struct chal_info
503 {
504   uchar data[8]; /* credentials */
505 } DOM_CHAL;
506
507 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
508 typedef struct time_info
509 {
510   uint32 time;
511 } UTIME;
512
513 /* DOM_CREDs - timestamped client or server credentials */
514 typedef struct cred_info
515 {  
516   DOM_CHAL challenge; /* credentials */
517   UTIME timestamp;    /* credential time-stamp */
518 } DOM_CRED;
519
520 /* Structure used when SMBwritebmpx is active */
521 typedef struct
522 {
523   size_t wr_total_written; /* So we know when to discard this */
524   int32 wr_timeout;
525   int32 wr_errclass;
526   int32 wr_error; /* Cached errors */
527   BOOL  wr_mode; /* write through mode) */
528   BOOL  wr_discard; /* discard all further data */
529 } write_bmpx_struct;
530
531 /*
532  * Structure used to indirect fd's from the files_struct.
533  * Needed as POSIX locking is based on file and process, not
534  * file descriptor and process.
535  */
536
537 typedef struct file_fd_struct
538 {
539         struct file_fd_struct *next, *prev;
540         uint16 ref_count;
541         uint16 uid_cache_count;
542         uid_t uid_users_cache[10];
543         SMB_DEV_T dev;
544         SMB_INO_T inode;
545         int fd;
546         int fd_readonly;
547         int fd_writeonly;
548         int real_open_flags;
549         BOOL delete_on_close;
550 } file_fd_struct;
551
552 /*
553  * Structure used to keep directory state information around.
554  * Used in NT change-notify code.
555  */
556
557 typedef struct
558 {
559   time_t modify_time;
560   time_t status_time;
561 } dir_status_struct;
562
563 struct uid_cache {
564   int entries;
565   uid_t list[UID_CACHE_SIZE];
566 };
567
568 typedef struct
569 {
570   char *name;
571   BOOL is_wild;
572 } name_compare_entry;
573
574 typedef struct connection_struct
575 {
576         struct connection_struct *next, *prev;
577         unsigned cnum; /* an index passed over the wire */
578         int service;
579         BOOL force_user;
580         struct uid_cache uid_cache;
581         void *dirptr;
582         BOOL printer;
583         BOOL ipc;
584         BOOL read_only;
585         BOOL admin_user;
586         char *dirpath;
587         char *connectpath;
588         char *origpath;
589         char *user; /* name of user who *opened* this connection */
590         uid_t uid; /* uid of user who *opened* this connection */
591         gid_t gid; /* gid of user who *opened* this connection */
592         char client_address[18]; /* String version of client IP address. */
593
594         uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
595
596         /* following groups stuff added by ih */
597
598         /* This groups info is valid for the user that *opened* the connection */
599         int ngroups;
600         gid_t *groups;
601         
602         time_t lastused;
603         BOOL used;
604         int num_files_open;
605         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
606         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
607         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */       
608
609 } connection_struct;
610
611 struct current_user
612 {
613         connection_struct *conn;
614         uint16 vuid;
615         uid_t uid;
616         gid_t gid;
617         int ngroups;
618         gid_t *groups;
619 };
620
621 typedef struct write_cache
622 {
623     SMB_OFF_T file_size;
624     SMB_OFF_T offset;
625     size_t alloc_size;
626     size_t data_size;
627     char *data;
628 } write_cache;
629
630 /*
631  * Reasons for cache flush.
632  */
633
634 #define NUM_FLUSH_REASONS 8 /* Keep this in sync with the enum below. */
635 enum flush_reason_enum { SEEK_FLUSH, READ_FLUSH, WRITE_FLUSH, READRAW_FLUSH,
636                          OPLOCK_RELEASE_FLUSH, CLOSE_FLUSH, SYNC_FLUSH, SIZECHANGE_FLUSH };     
637
638 typedef struct files_struct
639 {
640         struct files_struct *next, *prev;
641         int fnum;
642         connection_struct *conn;
643         file_fd_struct *fd_ptr;
644         SMB_OFF_T pos;
645         SMB_OFF_T size;
646         mode_t mode;
647         uint16 vuid;
648         write_bmpx_struct *wbmpx_ptr;
649     write_cache *wcp;
650         struct timeval open_time;
651         int share_mode;
652         time_t pending_modtime;
653         int oplock_type;
654         int sent_oplock_break;
655         BOOL open;
656         BOOL can_lock;
657         BOOL can_read;
658         BOOL can_write;
659         BOOL print_file;
660         BOOL modified;
661         BOOL is_directory;
662         BOOL directory_delete_on_close;
663         BOOL stat_open;
664         char *fsp_name;
665 } files_struct;
666
667 /* Defines for the sent_oplock_break field above. */
668 #define NO_BREAK_SENT 0
669 #define EXCLUSIVE_BREAK_SENT 1
670 #define LEVEL_II_BREAK_SENT 2
671
672 /* Domain controller authentication protocol info */
673 struct dcinfo
674 {
675   DOM_CHAL clnt_chal; /* Initial challenge received from client */
676   DOM_CHAL srv_chal;  /* Initial server challenge */
677   DOM_CRED clnt_cred; /* Last client credential */
678   DOM_CRED srv_cred;  /* Last server credential */
679
680   uchar  sess_key[8]; /* Session key */
681   uchar  md4pw[16];   /* md4(machine password) */
682 };
683
684 typedef struct
685 {
686   uid_t uid; /* uid of a validated user */
687   gid_t gid; /* gid of a validated user */
688
689   fstring requested_name; /* user name from the client */
690   fstring name; /* unix user name of a validated user */
691   fstring real_name;   /* to store real name from password file - simeon */
692   BOOL guest;
693
694   /* following groups stuff added by ih */
695   /* This groups info is needed for when we become_user() for this uid */
696   int n_groups;
697   gid_t *groups;
698
699   int n_sids;
700   int *sids;
701
702   /* per-user authentication information on NT RPCs */
703   struct dcinfo dc;
704
705 } user_struct;
706
707
708 enum {LPQ_QUEUED,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING};
709
710 typedef struct
711 {
712   int job;
713   int size;
714   int status;
715   int priority;
716   time_t time;
717   char user[30];
718   char file[100];
719 } print_queue_struct;
720
721 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
722
723 typedef struct
724 {
725   fstring message;
726   int status;
727 }  print_status_struct;
728
729 /* used for server information: client, nameserv and ipc */
730 struct server_info_struct
731 {
732   fstring name;
733   uint32 type;
734   fstring comment;
735   fstring domain; /* used ONLY in ipc.c NOT namework.c */
736   BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
737 };
738
739
740 /* used for network interfaces */
741 struct interface
742 {
743         struct interface *next, *prev;
744         struct in_addr ip;
745         struct in_addr bcast;
746         struct in_addr nmask;
747 };
748
749 /* struct returned by get_share_modes */
750 typedef struct
751 {
752   pid_t pid;
753   uint16 op_port;
754   uint16 op_type;
755   int share_mode;
756   struct timeval time;
757 } share_mode_entry;
758
759
760 /* each implementation of the share mode code needs
761    to support the following operations */
762 struct share_ops {
763         BOOL (*stop_mgmt)(void);
764         BOOL (*lock_entry)(connection_struct *, SMB_DEV_T , SMB_INO_T , int *);
765         BOOL (*unlock_entry)(connection_struct *, SMB_DEV_T , SMB_INO_T , int );
766         int (*get_entries)(connection_struct *, int , SMB_DEV_T , SMB_INO_T , share_mode_entry **);
767         void (*del_entry)(int , files_struct *);
768         BOOL (*set_entry)(int, files_struct *, uint16 , uint16 );
769     BOOL (*mod_entry)(int, files_struct *, void (*)(share_mode_entry *, SMB_DEV_T, SMB_INO_T, void *), void *);
770         int (*forall)(void (*)(share_mode_entry *, char *));
771         void (*status)(FILE *);
772 };
773
774 /* each implementation of the shared memory code needs
775    to support the following operations */
776 struct shmem_ops {
777         BOOL (*shm_close)( void );
778         int (*shm_alloc)(int );
779         BOOL (*shm_free)(int );
780         int (*get_userdef_off)(void);
781         void *(*offset2addr)(int );
782         int (*addr2offset)(void *addr);
783         BOOL (*lock_hash_entry)(unsigned int);
784         BOOL (*unlock_hash_entry)( unsigned int );
785         BOOL (*get_usage)(int *,int *,int *);
786         unsigned (*hash_size)(void);
787 };
788
789 /*
790  * Each implementation of the password database code needs
791  * to support the following operations.
792  */
793
794 struct passdb_ops {
795   /*
796    * Password database ops.
797    */
798   void *(*startsmbpwent)(BOOL);
799   void (*endsmbpwent)(void *);
800   SMB_BIG_UINT (*getsmbpwpos)(void *);
801   BOOL (*setsmbpwpos)(void *, SMB_BIG_UINT);
802
803   /*
804    * smb password database query functions.
805    */
806   struct smb_passwd *(*getsmbpwnam)(char *);
807   struct smb_passwd *(*getsmbpwuid)(uid_t);
808   struct smb_passwd *(*getsmbpwrid)(uint32);
809   struct smb_passwd *(*getsmbpwent)(void *);
810
811   /*
812    * smb password database modification functions.
813    */
814   BOOL (*add_smbpwd_entry)(struct smb_passwd *);
815   BOOL (*mod_smbpwd_entry)(struct smb_passwd *, BOOL);
816
817   /*
818    * Functions that manupulate a struct sam_passwd.
819    */
820   struct sam_passwd *(*getsam21pwent)(void *);
821
822   /*
823    * sam password database query functions.
824    */
825   struct sam_passwd *(*getsam21pwnam)(char *);
826   struct sam_passwd *(*getsam21pwuid)(uid_t);
827   struct sam_passwd *(*getsam21pwrid)(uint32);
828
829   /*
830    * sam password database modification functions.
831    */
832   BOOL (*add_sam21pwd_entry)(struct sam_passwd *);
833   BOOL (*mod_sam21pwd_entry)(struct sam_passwd *, BOOL);
834
835   /*
836    * sam query display info functions.
837    */
838   struct sam_disp_info *(*getsamdispnam)(char *);
839   struct sam_disp_info *(*getsamdisprid)(uint32);
840   struct sam_disp_info *(*getsamdispent)(void *);
841
842 #if 0
843   /*
844    * password checking functions
845    */
846   struct smb_passwd *(*smb_password_chal  )(char *username, char lm_pass[24], char nt_pass[24], char chal[8]);
847   struct smb_passwd *(*smb_password_check )(char *username, char lm_hash[16], char nt_hash[16]);
848   struct passwd     *(*unix_password_check)(char *username, char *pass, int pass_len);
849 #endif
850 };
851
852 /* key and data in the connections database - used in smbstatus and smbd */
853 struct connections_key {
854         pid_t pid;
855         int cnum;
856         fstring name;
857 };
858
859 struct connections_data {
860         int magic;
861         pid_t pid;
862         int cnum;
863         uid_t uid;
864         gid_t gid;
865         char name[24];
866         char addr[24];
867         char machine[128];
868         time_t start;
869 };
870
871
872 /* key and data records in the tdb locking database */
873 struct locking_key {
874         SMB_DEV_T dev;
875         SMB_INO_T inode;
876 };
877
878 struct locking_data {
879         int num_share_mode_entries;
880         /* the following two entries are implicit 
881            share_mode_entry modes[num_share_mode_entries];
882            char file_name[];
883         */
884 };
885
886
887 /* the following are used by loadparm for option lists */
888 typedef enum
889 {
890   P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
891   P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
892 } parm_type;
893
894 typedef enum
895 {
896   P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
897 } parm_class;
898
899 struct enum_list {
900         int value;
901         char *name;
902 };
903
904 struct parm_struct
905 {
906         char *label;
907         parm_type type;
908         parm_class class;
909         void *ptr;
910         BOOL (*special)(char *, char **);
911         struct enum_list *enum_list;
912         unsigned flags;
913         union {
914                 BOOL bvalue;
915                 int ivalue;
916                 char *svalue;
917                 char cvalue;
918         } def;
919 };
920
921 struct bitmap {
922         uint32 *b;
923         int n;
924 };
925
926 #define FLAG_BASIC      0x01 /* fundamental options */
927 #define FLAG_SHARE      0x02 /* file sharing options */
928 #define FLAG_PRINT      0x04 /* printing options */
929 #define FLAG_GLOBAL     0x08 /* local options that should be globally settable in SWAT */
930 #define FLAG_DEPRECATED 0x10 /* options that should no longer be used */
931 #define FLAG_HIDE       0x20 /* options that should be hidden in SWAT */
932 #define FLAG_DOS_STRING 0x40 /* convert from UNIX to DOS codepage when reading this string. */
933
934 #ifndef LOCKING_VERSION
935 #define LOCKING_VERSION 4
936 #endif /* LOCKING_VERSION */
937
938 /* these are useful macros for checking validity of handles */
939 #define OPEN_FSP(fsp)    ((fsp) && (fsp)->open && !(fsp)->is_directory)
940 #define OPEN_CONN(conn)    ((conn) && (conn)->open)
941 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
942 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
943 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn)
944
945 #define CHECK_FSP(fsp,conn) if (!FNUM_OK(fsp,conn)) \
946                                return(ERROR(ERRDOS,ERRbadfid)); \
947                             else if((fsp)->fd_ptr == NULL) \
948                                return(ERROR(ERRDOS,ERRbadaccess))
949
950 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
951                                return(ERROR(ERRDOS,ERRbadaccess))
952 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
953                                return(ERROR(ERRDOS,ERRbadaccess))
954 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
955                                return(CACHED_ERROR(fsp))
956
957 /* translates a connection number into a service number */
958 #define SNUM(conn)         ((conn)?(conn)->service:-1)
959
960 /* access various service details */
961 #define SERVICE(snum)      (lp_servicename(snum))
962 #define PRINTCAP           (lp_printcapname())
963 #define PRINTCOMMAND(snum) (lp_printcommand(snum))
964 #define PRINTERNAME(snum)  (lp_printername(snum))
965 #define CAN_WRITE(conn)    (!conn->read_only)
966 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
967 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
968 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
969 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
970 #define CAN_PRINT(conn)    ((conn) && lp_print_ok((conn)->service))
971 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden((conn)->service))
972 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system((conn)->service))
973 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive((conn)->service))
974 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list))
975 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list))
976 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list))
977
978 /* 
979  * Used by the stat cache code to check if a returned
980  * stat structure is valid.
981  */
982
983 #define VALID_STAT(st) (st.st_nlink != 0)  
984 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR(st.st_mode))
985
986 #define SMBENCRYPT()       (lp_encrypted_passwords())
987
988 /* the basic packet size, assuming no words or bytes */
989 #define smb_size 39
990
991 /* offsets into message for common items */
992 #define smb_com 8
993 #define smb_rcls 9
994 #define smb_reh 10
995 #define smb_err 11
996 #define smb_flg 13
997 #define smb_flg2 14
998 #define smb_reb 13
999 #define smb_tid 28
1000 #define smb_pid 30
1001 #define smb_uid 32
1002 #define smb_mid 34
1003 #define smb_wct 36
1004 #define smb_vwv 37
1005 #define smb_vwv0 37
1006 #define smb_vwv1 39
1007 #define smb_vwv2 41
1008 #define smb_vwv3 43
1009 #define smb_vwv4 45
1010 #define smb_vwv5 47
1011 #define smb_vwv6 49
1012 #define smb_vwv7 51
1013 #define smb_vwv8 53
1014 #define smb_vwv9 55
1015 #define smb_vwv10 57
1016 #define smb_vwv11 59
1017 #define smb_vwv12 61
1018 #define smb_vwv13 63
1019 #define smb_vwv14 65
1020 #define smb_vwv15 67
1021 #define smb_vwv16 69
1022 #define smb_vwv17 71
1023
1024 /* flag defines. CIFS spec 3.1.1 */
1025 #define FLAG_SUPPORT_LOCKREAD       0x01
1026 #define FLAG_CLIENT_BUF_AVAIL       0x02
1027 #define FLAG_RESERVED               0x04
1028 #define FLAG_CASELESS_PATHNAMES     0x08
1029 #define FLAG_CANONICAL_PATHNAMES    0x10
1030 #define FLAG_REQUEST_OPLOCK         0x20
1031 #define FLAG_REQUEST_BATCH_OPLOCK   0x40
1032 #define FLAG_REPLY                  0x80
1033
1034 /* the complete */
1035 #define SMBmkdir      0x00   /* create directory */
1036 #define SMBrmdir      0x01   /* delete directory */
1037 #define SMBopen       0x02   /* open file */
1038 #define SMBcreate     0x03   /* create file */
1039 #define SMBclose      0x04   /* close file */
1040 #define SMBflush      0x05   /* flush file */
1041 #define SMBunlink     0x06   /* delete file */
1042 #define SMBmv         0x07   /* rename file */
1043 #define SMBgetatr     0x08   /* get file attributes */
1044 #define SMBsetatr     0x09   /* set file attributes */
1045 #define SMBread       0x0A   /* read from file */
1046 #define SMBwrite      0x0B   /* write to file */
1047 #define SMBlock       0x0C   /* lock byte range */
1048 #define SMBunlock     0x0D   /* unlock byte range */
1049 #define SMBctemp      0x0E   /* create temporary file */
1050 #define SMBmknew      0x0F   /* make new file */
1051 #define SMBchkpth     0x10   /* check directory path */
1052 #define SMBexit       0x11   /* process exit */
1053 #define SMBlseek      0x12   /* seek */
1054 #define SMBtcon       0x70   /* tree connect */
1055 #define SMBtconX      0x75   /* tree connect and X*/
1056 #define SMBtdis       0x71   /* tree disconnect */
1057 #define SMBnegprot    0x72   /* negotiate protocol */
1058 #define SMBdskattr    0x80   /* get disk attributes */
1059 #define SMBsearch     0x81   /* search directory */
1060 #define SMBsplopen    0xC0   /* open print spool file */
1061 #define SMBsplwr      0xC1   /* write to print spool file */
1062 #define SMBsplclose   0xC2   /* close print spool file */
1063 #define SMBsplretq    0xC3   /* return print queue */
1064 #define SMBsends      0xD0   /* send single block message */
1065 #define SMBsendb      0xD1   /* send broadcast message */
1066 #define SMBfwdname    0xD2   /* forward user name */
1067 #define SMBcancelf    0xD3   /* cancel forward */
1068 #define SMBgetmac     0xD4   /* get machine name */
1069 #define SMBsendstrt   0xD5   /* send start of multi-block message */
1070 #define SMBsendend    0xD6   /* send end of multi-block message */
1071 #define SMBsendtxt    0xD7   /* send text of multi-block message */
1072
1073 /* Core+ protocol */
1074 #define SMBlockread       0x13   /* Lock a range and read */
1075 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1076 #define SMBreadbraw   0x1a  /* read a block of data with no smb header */
1077 #define SMBwritebraw  0x1d  /* write a block of data with no smb header */
1078 #define SMBwritec     0x20  /* secondary write request */
1079 #define SMBwriteclose 0x2c  /* write a file then close it */
1080
1081 /* dos extended protocol */
1082 #define SMBreadBraw      0x1A   /* read block raw */
1083 #define SMBreadBmpx      0x1B   /* read block multiplexed */
1084 #define SMBreadBs        0x1C   /* read block (secondary response) */
1085 #define SMBwriteBraw     0x1D   /* write block raw */
1086 #define SMBwriteBmpx     0x1E   /* write block multiplexed */
1087 #define SMBwriteBs       0x1F   /* write block (secondary request) */
1088 #define SMBwriteC        0x20   /* write complete response */
1089 #define SMBsetattrE      0x22   /* set file attributes expanded */
1090 #define SMBgetattrE      0x23   /* get file attributes expanded */
1091 #define SMBlockingX      0x24   /* lock/unlock byte ranges and X */
1092 #define SMBtrans         0x25   /* transaction - name, bytes in/out */
1093 #define SMBtranss        0x26   /* transaction (secondary request/response) */
1094 #define SMBioctl         0x27   /* IOCTL */
1095 #define SMBioctls        0x28   /* IOCTL  (secondary request/response) */
1096 #define SMBcopy          0x29   /* copy */
1097 #define SMBmove          0x2A   /* move */
1098 #define SMBecho          0x2B   /* echo */
1099 #define SMBopenX         0x2D   /* open and X */
1100 #define SMBreadX         0x2E   /* read and X */
1101 #define SMBwriteX        0x2F   /* write and X */
1102 #define SMBsesssetupX    0x73   /* Session Set Up & X (including User Logon) */
1103 #define SMBffirst        0x82   /* find first */
1104 #define SMBfunique       0x83   /* find unique */
1105 #define SMBfclose        0x84   /* find close */
1106 #define SMBinvalid       0xFE   /* invalid command */
1107
1108 /* Extended 2.0 protocol */
1109 #define SMBtrans2        0x32   /* TRANS2 protocol set */
1110 #define SMBtranss2       0x33   /* TRANS2 protocol set, secondary command */
1111 #define SMBfindclose     0x34   /* Terminate a TRANSACT2_FINDFIRST */
1112 #define SMBfindnclose    0x35   /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1113 #define SMBulogoffX      0x74   /* user logoff */
1114
1115 /* NT SMB extensions. */
1116 #define SMBnttrans       0xA0   /* NT transact */
1117 #define SMBnttranss      0xA1   /* NT transact secondary */
1118 #define SMBntcreateX     0xA2   /* NT create and X */
1119 #define SMBntcancel      0xA4   /* NT cancel */
1120
1121 /* These are the TRANS2 sub commands */
1122 #define TRANSACT2_OPEN                        0
1123 #define TRANSACT2_FINDFIRST                   1
1124 #define TRANSACT2_FINDNEXT                    2
1125 #define TRANSACT2_QFSINFO                     3
1126 #define TRANSACT2_SETFSINFO                   4
1127 #define TRANSACT2_QPATHINFO                   5
1128 #define TRANSACT2_SETPATHINFO                 6
1129 #define TRANSACT2_QFILEINFO                   7
1130 #define TRANSACT2_SETFILEINFO                 8
1131 #define TRANSACT2_FSCTL                       9
1132 #define TRANSACT2_IOCTL                     0xA
1133 #define TRANSACT2_FINDNOTIFYFIRST           0xB
1134 #define TRANSACT2_FINDNOTIFYNEXT            0xC
1135 #define TRANSACT2_MKDIR                     0xD
1136 #define TRANSACT2_SESSION_SETUP             0xE
1137 #define TRANSACT2_GET_DFS_REFERRAL         0x10
1138 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1139
1140 /* These are the NT transact sub commands. */
1141 #define NT_TRANSACT_CREATE                1
1142 #define NT_TRANSACT_IOCTL                 2
1143 #define NT_TRANSACT_SET_SECURITY_DESC     3
1144 #define NT_TRANSACT_NOTIFY_CHANGE         4
1145 #define NT_TRANSACT_RENAME                5
1146 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
1147
1148 /* Relevant IOCTL codes */
1149 #define IOCTL_QUERY_JOB_INFO      0x530060
1150
1151 /* these are the trans2 sub fields for primary requests */
1152 #define smb_tpscnt smb_vwv0
1153 #define smb_tdscnt smb_vwv1
1154 #define smb_mprcnt smb_vwv2
1155 #define smb_mdrcnt smb_vwv3
1156 #define smb_msrcnt smb_vwv4
1157 #define smb_flags smb_vwv5
1158 #define smb_timeout smb_vwv6
1159 #define smb_pscnt smb_vwv9
1160 #define smb_psoff smb_vwv10
1161 #define smb_dscnt smb_vwv11
1162 #define smb_dsoff smb_vwv12
1163 #define smb_suwcnt smb_vwv13
1164 #define smb_setup smb_vwv14
1165 #define smb_setup0 smb_setup
1166 #define smb_setup1 (smb_setup+2)
1167 #define smb_setup2 (smb_setup+4)
1168
1169 /* these are for the secondary requests */
1170 #define smb_spscnt smb_vwv2
1171 #define smb_spsoff smb_vwv3
1172 #define smb_spsdisp smb_vwv4
1173 #define smb_sdscnt smb_vwv5
1174 #define smb_sdsoff smb_vwv6
1175 #define smb_sdsdisp smb_vwv7
1176 #define smb_sfid smb_vwv8
1177
1178 /* and these for responses */
1179 #define smb_tprcnt smb_vwv0
1180 #define smb_tdrcnt smb_vwv1
1181 #define smb_prcnt smb_vwv3
1182 #define smb_proff smb_vwv4
1183 #define smb_prdisp smb_vwv5
1184 #define smb_drcnt smb_vwv6
1185 #define smb_droff smb_vwv7
1186 #define smb_drdisp smb_vwv8
1187
1188 /* these are for the NT trans primary request. */
1189 #define smb_nt_MaxSetupCount smb_vwv0
1190 #define smb_nt_Flags (smb_vwv0 + 1)
1191 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1192 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1193 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1194 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1195 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1196 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1197 #define smb_nt_DataCount (smb_vwv0 + 27)
1198 #define smb_nt_DataOffset (smb_vwv0 + 31)
1199 #define smb_nt_SetupCount (smb_vwv0 + 35)
1200 #define smb_nt_Function (smb_vwv0 + 36)
1201 #define smb_nt_SetupStart (smb_vwv0 + 38)
1202
1203 /* these are for the NT trans secondary request. */
1204 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1205 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1206 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1207 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1208 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1209 #define smb_nts_DataCount (smb_vwv0 + 23)
1210 #define smb_nts_DataOffset (smb_vwv0 + 27)
1211 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1212
1213 /* these are for the NT trans reply. */
1214 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1215 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1216 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1217 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1218 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1219 #define smb_ntr_DataCount (smb_vwv0 + 23)
1220 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1221 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1222
1223 /* these are for the NT create_and_X */
1224 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1225 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1226 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1227 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1228 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1229 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1230 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1231 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1232 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1233 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1234 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1235
1236 /* this is used on a TConX. I'm not sure the name is very helpful though */
1237 #define SMB_SUPPORT_SEARCH_BITS        0x0001
1238
1239 /* these are the constants used in the above call. */
1240 /* DesiredAccess */
1241 /* File Specific access rights. */
1242 #define FILE_READ_DATA        0x001
1243 #define FILE_WRITE_DATA       0x002
1244 #define FILE_APPEND_DATA      0x004
1245 #define FILE_READ_EA          0x008
1246 #define FILE_WRITE_EA         0x010
1247 #define FILE_EXECUTE          0x020
1248 #define FILE_DELETE_CHILD     0x040
1249 #define FILE_READ_ATTRIBUTES  0x080
1250 #define FILE_WRITE_ATTRIBUTES 0x100
1251
1252 #define FILE_ALL_ATTRIBUTES   0x1FF
1253  
1254 /* Generic access masks & rights. */
1255 #define SPECIFIC_RIGHTS_MASK 0x00FFFFL
1256 #define STANDARD_RIGHTS_MASK 0xFF0000L
1257 #define DELETE_ACCESS        (1L<<16)
1258 #define READ_CONTROL_ACCESS  (1L<<17)
1259 #define WRITE_DAC_ACCESS     (1L<<18)
1260 #define WRITE_OWNER_ACCESS   (1L<<19)
1261 #define SYNCHRONIZE_ACCESS   (1L<<20)
1262
1263 #define SYSTEM_SECURITY_ACCESS (1L<<24)
1264 #define GENERIC_ALL_ACCESS   (1<<28)
1265 #define GENERIC_EXECUTE_ACCESS  (1<<29)
1266 #define GENERIC_WRITE_ACCESS   (1<<30)
1267 #define GENERIC_READ_ACCESS   (((unsigned)1)<<31)
1268
1269 #define FILE_ALL_STANDARD_ACCESS 0x1F0000
1270
1271 /* Mapping of access rights to UNIX perms. */
1272 #if 0 /* Don't use all here... JRA. */
1273 #define UNIX_ACCESS_RWX (FILE_ALL_ATTRIBUTES|FILE_ALL_STANDARD_ACCESS)
1274 #else
1275 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1276 #endif
1277
1278 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1279                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1280 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1281                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1282                         FILE_APPEND_DATA|FILE_WRITE_DATA)
1283 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1284                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1285
1286 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1287
1288 /* Flags field. */
1289 #define REQUEST_OPLOCK 2
1290 #define REQUEST_BATCH_OPLOCK 4
1291 #define OPEN_DIRECTORY 8
1292
1293 /* ShareAccess field. */
1294 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1295 #define FILE_SHARE_READ 1
1296 #define FILE_SHARE_WRITE 2
1297 #define FILE_SHARE_DELETE 4
1298
1299 /* FileAttributesField */
1300 #define FILE_ATTRIBUTE_READONLY aRONLY
1301 #define FILE_ATTRIBUTE_HIDDEN aHIDDEN
1302 #define FILE_ATTRIBUTE_SYSTEM aSYSTEM
1303 #define FILE_ATTRIBUTE_DIRECTORY aDIR
1304 #define FILE_ATTRIBUTE_ARCHIVE aARCH
1305 #define FILE_ATTRIBUTE_NORMAL 0x80L
1306 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1307 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1308 #define SAMBA_ATTRIBUTES_MASK 0x7F
1309
1310 /* Flags - combined with attributes. */
1311 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
1312 #define FILE_FLAG_NO_BUFFERING     0x20000000L
1313 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
1314 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
1315 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
1316 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1317 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
1318
1319 /* CreateDisposition field. */
1320 #define FILE_SUPERSEDE 0
1321 #define FILE_OPEN 1
1322 #define FILE_CREATE 2
1323 #define FILE_OPEN_IF 3
1324 #define FILE_OVERWRITE 4
1325 #define FILE_OVERWRITE_IF 5
1326
1327 /* CreateOptions field. */
1328 #define FILE_DIRECTORY_FILE       0x0001
1329 #define FILE_WRITE_THROUGH        0x0002
1330 #define FILE_SEQUENTIAL_ONLY      0x0004
1331 #define FILE_NON_DIRECTORY_FILE   0x0040
1332 #define FILE_NO_EA_KNOWLEDGE      0x0200
1333 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1334 #define FILE_RANDOM_ACCESS        0x0800
1335 #define FILE_DELETE_ON_CLOSE      0x1000
1336
1337 /* Responses when opening a file. */
1338 #define FILE_WAS_OPENED 1
1339 #define FILE_WAS_CREATED 2
1340 #define FILE_WAS_OVERWRITTEN 3
1341
1342 /* File type flags */
1343 #define FILE_TYPE_DISK  0
1344 #define FILE_TYPE_BYTE_MODE_PIPE 1
1345 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1346 #define FILE_TYPE_PRINTER 3
1347 #define FILE_TYPE_COMM_DEVICE 4
1348 #define FILE_TYPE_UNKNOWN 0xFFFF
1349
1350 /* Flag for NT transact rename call. */
1351 #define RENAME_REPLACE_IF_EXISTS 1
1352
1353 /* Filesystem Attributes. */
1354 #define FILE_CASE_SENSITIVE_SEARCH 0x1
1355 #define FILE_CASE_PRESERVED_NAMES 0x2
1356 #define FILE_UNICODE_ON_DISK 0x4
1357 #define FILE_PERSISTENT_ACLS 0x8
1358
1359 /* ChangeNotify flags. */
1360 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x001
1361 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
1362 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
1363 #define FILE_NOTIFY_CHANGE_SIZE        0x008
1364 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
1365 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1366 #define FILE_NOTIFY_CHANGE_CREATION    0x040
1367 #define FILE_NOTIFY_CHANGE_EA          0x080
1368 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
1369
1370 /* where to find the base of the SMB packet proper */
1371 #define smb_base(buf) (((char *)(buf))+4)
1372
1373
1374 /* we don't allow server strings to be longer than 48 characters as
1375    otherwise NT will not honour the announce packets */
1376 #define MAX_SERVER_STRING_LENGTH 48
1377
1378
1379 #define SMB_SUCCESS 0  /* The request was successful. */
1380 #define ERRDOS 0x01 /*  Error is from the core DOS operating system set. */
1381 #define ERRSRV 0x02  /* Error is generated by the server network file manager.*/
1382 #define ERRHRD 0x03  /* Error is an hardware error. */
1383 #define ERRCMD 0xFF  /* Command was not in the "SMB" format. */
1384
1385 #ifdef HAVE_STDARG_H
1386 int slprintf(char *str, int n, char *format, ...)
1387 #ifdef __GNUC__
1388      __attribute__ ((format (printf, 3, 4)))
1389 #endif
1390 ;
1391 #else
1392 int slprintf();
1393 #endif
1394
1395 #ifdef WITH_DFS
1396 void dfs_unlogin(void);
1397 extern int dcelogin_atmost_once;
1398 #endif
1399
1400 #ifdef NOSTRDUP
1401 char *strdup(char *s);
1402 #endif
1403
1404 #ifndef MIN
1405 #define MIN(a,b) ((a)<(b)?(a):(b))
1406 #endif
1407 #ifndef MAX
1408 #define MAX(a,b) ((a)>(b)?(a):(b))
1409 #endif
1410
1411 #ifndef ABS
1412 #define ABS(a) ((a)>0?(a):(-(a)))
1413 #endif
1414
1415 #ifndef SIGNAL_CAST
1416 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1417 #endif
1418
1419 #ifndef SELECT_CAST
1420 #define SELECT_CAST
1421 #endif
1422
1423
1424 /* Some POSIX definitions for those without */
1425  
1426 #ifndef S_IFDIR
1427 #define S_IFDIR         0x4000
1428 #endif
1429 #ifndef S_ISDIR
1430 #define S_ISDIR(mode)   ((mode & 0xF000) == S_IFDIR)
1431 #endif
1432 #ifndef S_IRWXU
1433 #define S_IRWXU 00700           /* read, write, execute: owner */
1434 #endif
1435 #ifndef S_IRUSR
1436 #define S_IRUSR 00400           /* read permission: owner */
1437 #endif
1438 #ifndef S_IWUSR
1439 #define S_IWUSR 00200           /* write permission: owner */
1440 #endif
1441 #ifndef S_IXUSR
1442 #define S_IXUSR 00100           /* execute permission: owner */
1443 #endif
1444 #ifndef S_IRWXG
1445 #define S_IRWXG 00070           /* read, write, execute: group */
1446 #endif
1447 #ifndef S_IRGRP
1448 #define S_IRGRP 00040           /* read permission: group */
1449 #endif
1450 #ifndef S_IWGRP
1451 #define S_IWGRP 00020           /* write permission: group */
1452 #endif
1453 #ifndef S_IXGRP
1454 #define S_IXGRP 00010           /* execute permission: group */
1455 #endif
1456 #ifndef S_IRWXO
1457 #define S_IRWXO 00007           /* read, write, execute: other */
1458 #endif
1459 #ifndef S_IROTH
1460 #define S_IROTH 00004           /* read permission: other */
1461 #endif
1462 #ifndef S_IWOTH
1463 #define S_IWOTH 00002           /* write permission: other */
1464 #endif
1465 #ifndef S_IXOTH
1466 #define S_IXOTH 00001           /* execute permission: other */
1467 #endif
1468
1469
1470 /* these are used in NetServerEnum to choose what to receive */
1471 #define SV_TYPE_WORKSTATION         0x00000001
1472 #define SV_TYPE_SERVER              0x00000002
1473 #define SV_TYPE_SQLSERVER           0x00000004
1474 #define SV_TYPE_DOMAIN_CTRL         0x00000008
1475 #define SV_TYPE_DOMAIN_BAKCTRL      0x00000010
1476 #define SV_TYPE_TIME_SOURCE         0x00000020
1477 #define SV_TYPE_AFP                 0x00000040
1478 #define SV_TYPE_NOVELL              0x00000080
1479 #define SV_TYPE_DOMAIN_MEMBER       0x00000100
1480 #define SV_TYPE_PRINTQ_SERVER       0x00000200
1481 #define SV_TYPE_DIALIN_SERVER       0x00000400
1482 #define SV_TYPE_SERVER_UNIX         0x00000800
1483 #define SV_TYPE_NT                  0x00001000
1484 #define SV_TYPE_WFW                 0x00002000
1485 #define SV_TYPE_SERVER_MFPN         0x00004000
1486 #define SV_TYPE_SERVER_NT           0x00008000
1487 #define SV_TYPE_POTENTIAL_BROWSER   0x00010000
1488 #define SV_TYPE_BACKUP_BROWSER      0x00020000
1489 #define SV_TYPE_MASTER_BROWSER      0x00040000
1490 #define SV_TYPE_DOMAIN_MASTER       0x00080000
1491 #define SV_TYPE_SERVER_OSF          0x00100000
1492 #define SV_TYPE_SERVER_VMS          0x00200000
1493 #define SV_TYPE_WIN95_PLUS          0x00400000
1494 #define SV_TYPE_ALTERNATE_XPORT     0x20000000  
1495 #define SV_TYPE_LOCAL_LIST_ONLY     0x40000000  
1496 #define SV_TYPE_DOMAIN_ENUM         0x80000000
1497 #define SV_TYPE_ALL                 0xFFFFFFFF  
1498
1499 /* what server type are we currently  - JHT Says we ARE 4.20 */
1500 /* this was set by JHT in liaison with Jeremy Allison early 1997 */
1501 /* setting to 4.20 at same time as announcing ourselves as NT Server */
1502 /* History: */
1503 /* Version 4.0 - never made public */
1504 /* Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9 */
1505 /*              - Reappeared in 1.9.16p11 with fixed smbd services */
1506 /* Version 4.20 - To indicate that nmbd and browsing now works better */
1507
1508 #define DEFAULT_MAJOR_VERSION 0x04
1509 #define DEFAULT_MINOR_VERSION 0x02
1510
1511 /* Browser Election Values */
1512 #define BROWSER_ELECTION_VERSION        0x010f
1513 #define BROWSER_CONSTANT        0xaa55
1514
1515 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1516    
1517 #define FLAGS2_LONG_PATH_COMPONENTS   0x0001
1518 #define FLAGS2_EXTENDED_ATTRIBUTES    0x0002
1519 #define FLAGS2_DFS_PATHNAMES          0x1000
1520 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1521 #define FLAGS2_32_BIT_ERROR_CODES     0x4000 
1522 #define FLAGS2_UNICODE_STRINGS        0x8000
1523
1524 /* Capabilities.  see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1525
1526 #define CAP_RAW_MODE         0x0001
1527 #define CAP_MPX_MODE         0x0002
1528 #define CAP_UNICODE          0x0004
1529 #define CAP_LARGE_FILES      0x0008
1530 #define CAP_NT_SMBS          0x0010
1531 #define CAP_RPC_REMOTE_APIS  0x0020
1532 #define CAP_STATUS32         0x0040
1533 #define CAP_LEVEL_II_OPLOCKS 0x0080
1534 #define CAP_LOCK_AND_READ    0x0100
1535 #define CAP_NT_FIND          0x0200
1536 #define CAP_DFS              0x1000
1537 #define CAP_LARGE_READX      0x4000
1538
1539 /* protocol types. It assumes that higher protocols include lower protocols
1540    as subsets */
1541 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1542
1543 /* security levels */
1544 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN};
1545
1546 /* printing types */
1547 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1548                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,PRINT_CUPS};
1549
1550 /* Remote architectures we know about. */
1551 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_WIN2K, RA_SAMBA};
1552
1553 /* case handling */
1554 enum case_handling {CASE_LOWER,CASE_UPPER};
1555
1556 #ifdef WITH_SSL
1557 /* SSL version options */
1558 enum ssl_version_enum {SMB_SSL_V2,SMB_SSL_V3,SMB_SSL_V23,SMB_SSL_TLS1};
1559 #endif /* WITH_SSL */
1560
1561 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
1562    structures. We cannot define these as actual structures
1563    due to possible differences in structure packing
1564    on different machines/compilers. */
1565
1566 #define SMB_LPID_OFFSET(indx) (10 * (indx))
1567 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
1568 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
1569 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
1570 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
1571 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
1572 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
1573
1574 /* Macro to cache an error in a write_bmpx_struct */
1575 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
1576                             w->wr_discard = True, -1)
1577 /* Macro to test if an error has been cached for this fnum */
1578 #define HAS_CACHED_ERROR(fsp) ((fsp)->open && (fsp)->wbmpx_ptr && \
1579                                 (fsp)->wbmpx_ptr->wr_discard)
1580 /* Macro to turn the cached error into an error packet */
1581 #define CACHED_ERROR(fsp) cached_error_packet(inbuf,outbuf,fsp,__LINE__)
1582
1583 /* these are the datagram types */
1584 #define DGRAM_DIRECT_UNIQUE 0x10
1585
1586 #define ERROR(class,x) error_packet(inbuf,outbuf,class,x,__LINE__)
1587
1588 /* this is how errors are generated */
1589 #define UNIXERROR(defclass,deferror) unix_error_packet(inbuf,outbuf,defclass,deferror,__LINE__)
1590
1591 #define SMB_ROUNDUP(x,g) (((x)+((g)-1))&~((g)-1))
1592
1593 /*
1594  * Global value meaing that the smb_uid field should be
1595  * ingored (in share level security and protocol level == CORE)
1596  */
1597
1598 #define UID_FIELD_INVALID 0
1599 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1600
1601 /* Defines needed for multi-codepage support. */
1602 #define MSDOS_LATIN_1_CODEPAGE 850
1603 #define KANJI_CODEPAGE 932
1604 #define HANGUL_CODEPAGE 949
1605 #define BIG5_CODEPAGE 950
1606 #define SIMPLIFIED_CHINESE_CODEPAGE 936
1607
1608 #ifdef KANJI
1609 /* 
1610  * Default client code page - Japanese 
1611  */
1612 #define DEFAULT_CLIENT_CODE_PAGE KANJI_CODEPAGE
1613 #else /* KANJI */
1614 /* 
1615  * Default client code page - 850 - Western European 
1616  */
1617 #define DEFAULT_CLIENT_CODE_PAGE MSDOS_LATIN_1_CODEPAGE
1618 #endif /* KANJI */
1619
1620 /* 
1621  * Size of buffer to use when moving files across filesystems. 
1622  */
1623 #define COPYBUF_SIZE (8*1024)
1624
1625 /* 
1626  * Integers used to override error codes. 
1627  */
1628 extern int unix_ERR_class;
1629 extern int unix_ERR_code;
1630
1631 /*
1632  * Map the Core and Extended Oplock requesst bits down
1633  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1634  */
1635
1636 /*
1637  * Core protocol.
1638  */
1639 #define CORE_OPLOCK_REQUEST(inbuf) \
1640     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1641
1642 /*
1643  * Extended protocol.
1644  */
1645 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1646
1647 /* Lock types. */
1648 #define LOCKING_ANDX_SHARED_LOCK 0x1
1649 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1650 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1651 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1652 #define LOCKING_ANDX_LARGE_FILES 0x10
1653
1654 /* Oplock levels */
1655 #define OPLOCKLEVEL_NONE 0
1656 #define OPLOCKLEVEL_II 1
1657
1658 /*
1659  * Bits we test with.
1660  */
1661
1662 #define NO_OPLOCK 0
1663 #define EXCLUSIVE_OPLOCK 1
1664 #define BATCH_OPLOCK 2
1665 #define LEVEL_II_OPLOCK 4
1666
1667 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1668 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1669 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1670
1671 #define CORE_OPLOCK_GRANTED (1<<5)
1672 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1673
1674 /*
1675  * Return values for oplock types.
1676  */
1677
1678 #define NO_OPLOCK_RETURN 0
1679 #define EXCLUSIVE_OPLOCK_RETURN 1
1680 #define BATCH_OPLOCK_RETURN 2
1681 #define LEVEL_II_OPLOCK_RETURN 3
1682
1683 /*
1684  * Loopback command offsets.
1685  */
1686
1687 #define OPBRK_CMD_LEN_OFFSET 0
1688 #define OPBRK_CMD_PORT_OFFSET 4
1689 #define OPBRK_CMD_HEADER_LEN 6
1690
1691 #define OPBRK_MESSAGE_CMD_OFFSET 0
1692
1693 /*
1694  * Oplock break command code to send over the udp socket.
1695  * The same message is sent for both exlusive and level II breaks. 
1696  * 
1697  * The form of this is :
1698  *
1699  *  0     2       6        10       14    14+devsize 14+devsize+inodesize
1700  *  +----+--------+--------+--------+-------+--------+
1701  *  | cmd| pid    | sec    | usec   | dev   |  inode |
1702  *  +----+--------+--------+--------+-------+--------+
1703  */
1704
1705 #define OPLOCK_BREAK_CMD 0x1
1706 #define OPLOCK_BREAK_PID_OFFSET 2
1707 #define OPLOCK_BREAK_SEC_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1708 #define OPLOCK_BREAK_USEC_OFFSET (OPLOCK_BREAK_SEC_OFFSET + sizeof(time_t))
1709 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_USEC_OFFSET + sizeof(long))
1710 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1711 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1712
1713 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1714
1715 /*
1716  * Capabilities abstracted for different systems.
1717  */
1718
1719 #define KERNEL_OPLOCK_CAPABILITY 0x1
1720
1721 #if defined(HAVE_KERNEL_OPLOCKS)
1722 /*
1723  * Oplock break command code sent via the kernel interface.
1724  *
1725  * Form of this is :
1726  *
1727  *  0     2       2+devsize 2+devsize+inodesize
1728  *  +----+--------+--------+
1729  *  | cmd| dev    |  inode |
1730  *  +----+--------+--------+
1731  */
1732
1733 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1734 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1735 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1736 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1737
1738 #endif /* HAVE_KERNEL_OPLOCKS */
1739
1740 #define CMD_REPLY 0x8000
1741
1742 /* useful macros */
1743
1744 /* zero a structure */
1745 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
1746
1747 /* zero a structure given a pointer to the structure - no zero check */
1748 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
1749
1750 /* zero a structure given a pointer to the structure */
1751 #define ZERO_STRUCTP(x) { if ((x) != NULL) ZERO_STRUCTPN(x); }
1752
1753 /* zero an array - note that sizeof(array) must work - ie. it must not be a 
1754    pointer */
1755 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
1756
1757 #define SMB_ASSERT(b) ((b)?(void)0: \
1758         (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
1759                  __FILE__, __LINE__)), smb_panic("assert failed")))
1760 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
1761
1762 #include "ntdomain.h"
1763
1764 /* A netbios name structure. */
1765 struct nmb_name {
1766   char         name[17];
1767   char         scope[64];
1768   unsigned int name_type;
1769 };
1770
1771 #include "client.h"
1772 #include "rpcclient.h"
1773
1774 /*
1775  * Size of new password account encoding string. DO NOT CHANGE.
1776  */
1777
1778 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1779
1780 /*
1781    Do you want session setups at user level security with a invalid
1782    password to be rejected or allowed in as guest? WinNT rejects them
1783    but it can be a pain as it means "net view" needs to use a password
1784
1785    You have 3 choices in the setting of map_to_guest:
1786
1787    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1788    are rejected. This is the default.
1789
1790    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1791    are rejected, unless the username does not exist, in which case it
1792    is treated as a guest login
1793
1794    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1795    are treated as a guest login
1796
1797    Note that map_to_guest only has an effect in user or server
1798    level security.
1799 */
1800
1801 #define NEVER_MAP_TO_GUEST 0
1802 #define MAP_TO_GUEST_ON_BAD_USER 1
1803 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1804
1805 #endif /* _SMB_H */