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