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