"For I have laboured mightily on Luke's code, and hath broken
[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 /*
52    Samba needs type definitions for int16, int32, uint16 and uint32.
53    
54    Normally these are signed and unsigned 16 and 32 bit integers, but
55    they actually only need to be at least 16 and 32 bits
56    respectively. Thus if your word size is 8 bytes just defining them
57    as signed and unsigned int will work.
58 */
59
60 /* afs/stds.h defines int16 and int32 */
61 #ifndef AFS_AUTH
62 typedef short int16;
63 typedef int int32;
64 #endif
65
66 #ifndef uint8
67 typedef unsigned char uint8;
68 #endif
69
70 #ifndef uint16
71 typedef unsigned short uint16;
72 #endif
73
74 #ifndef uint32
75 typedef unsigned int uint32;
76 #endif
77
78 #ifndef uchar
79 #define uchar unsigned char
80 #endif
81 #ifndef int16
82 #define int16 short
83 #endif
84 #ifndef uint16
85 #define uint16 unsigned short
86 #endif
87 #ifndef uint32
88 #define uint32 unsigned int
89 #endif
90
91 #define SIZEOFWORD 2
92
93 #ifndef DEF_CREATE_MASK
94 #define DEF_CREATE_MASK (0755)
95 #endif
96
97 /* how long to wait for secondary SMB packets (milli-seconds) */
98 #define SMB_SECONDARY_WAIT (60*1000)
99
100 /* debugging code */
101 #ifndef SYSLOG
102 #define DEBUG(level,body) ((DEBUGLEVEL>=(level))?(Debug1 body):0)
103 #else
104 extern int syslog_level;
105
106 #define DEBUG(level,body) ((DEBUGLEVEL>=(level))? (syslog_level = (level), Debug1 body):0)
107 #endif
108
109 /* this defines the error codes that receive_smb can put in smb_read_error */
110 #define READ_TIMEOUT 1
111 #define READ_EOF 2
112 #define READ_ERROR 3
113
114
115 #define DIR_STRUCT_SIZE 43
116
117 /* these define all the command types recognised by the server - there
118 are lots of gaps so probably there are some rare commands that are not
119 implemented */
120
121 #define pSETDIR '\377'
122
123 /* these define the attribute byte as seen by DOS */
124 #define aRONLY (1L<<0)
125 #define aHIDDEN (1L<<1)
126 #define aSYSTEM (1L<<2)
127 #define aVOLID (1L<<3)
128 #define aDIR (1L<<4)
129 #define aARCH (1L<<5)
130
131 /* deny modes */
132 #define DENY_DOS 0
133 #define DENY_ALL 1
134 #define DENY_WRITE 2
135 #define DENY_READ 3
136 #define DENY_NONE 4
137 #define DENY_FCB 7
138
139 /* share types */
140 #define STYPE_DISKTREE  0       /* Disk drive */
141 #define STYPE_PRINTQ    1       /* Spooler queue */
142 #define STYPE_DEVICE    2       /* Serial device */
143 #define STYPE_IPC       3       /* Interprocess communication (IPC) */
144 #define STYPE_HIDDEN    0x80000000 /* share is a hidden one (ends with $) */
145
146 /* SMB X/Open error codes for the ERRdos error class */
147 #define ERRbadfunc 1 /* Invalid function (or system call) */
148 #define ERRbadfile 2 /* File not found (pathname error) */
149 #define ERRbadpath 3 /* Directory not found */
150 #define ERRnofids 4 /* Too many open files */
151 #define ERRnoaccess 5 /* Access denied */
152 #define ERRbadfid 6 /* Invalid fid */
153 #define ERRnomem 8 /* Out of memory */
154 #define ERRbadmem 9 /* Invalid memory block address */
155 #define ERRbadenv 10 /* Invalid environment */
156 #define ERRbadaccess 12 /* Invalid open mode */
157 #define ERRbaddata 13 /* Invalid data (only from ioctl call) */
158 #define ERRres 14 /* reserved */
159 #define ERRbaddrive 15 /* Invalid drive */
160 #define ERRremcd 16 /* Attempt to delete current directory */
161 #define ERRdiffdevice 17 /* rename/move across different filesystems */
162 #define ERRnofiles 18 /* no more files found in file search */
163 #define ERRbadshare 32 /* Share mode on file conflict with open mode */
164 #define ERRlock 33 /* Lock request conflicts with existing lock */
165 #define ERRfilexists 80 /* File in operation already exists */
166 #define ERRcannotopen 110 /* Cannot open the file specified */
167 #define ERRunknownlevel 124
168 #define ERRbadpipe 230 /* Named pipe invalid */
169 #define ERRpipebusy 231 /* All instances of pipe are busy */
170 #define ERRpipeclosing 232 /* named pipe close in progress */
171 #define ERRnotconnected 233 /* No process on other end of named pipe */
172 #define ERRmoredata 234 /* More data to be returned */
173 #define ERRbaddirectory 267 /* Invalid directory name in a path. */
174 #define ERROR_EAS_DIDNT_FIT 275 /* Extended attributes didn't fit */
175 #define ERROR_EAS_NOT_SUPPORTED 282 /* Extended attributes not supported */
176 #define ERRunknownipc 2142
177
178
179 /* here's a special one from observing NT */
180 #define ERRnoipc 66 /* don't support ipc */
181
182 /* Error codes for the ERRSRV class */
183
184 #define ERRerror 1 /* Non specific error code */
185 #define ERRbadpw 2 /* Bad password */
186 #define ERRbadtype 3 /* reserved */
187 #define ERRaccess 4 /* No permissions to do the requested operation */
188 #define ERRinvnid 5 /* tid invalid */
189 #define ERRinvnetname 6 /* Invalid servername */
190 #define ERRinvdevice 7 /* Invalid device */
191 #define ERRqfull 49 /* Print queue full */
192 #define ERRqtoobig 50 /* Queued item too big */
193 #define ERRinvpfid 52 /* Invalid print file in smb_fid */
194 #define ERRsmbcmd 64 /* Unrecognised command */
195 #define ERRsrverror 65 /* smb server internal error */
196 #define ERRfilespecs 67 /* fid and pathname invalid combination */
197 #define ERRbadlink 68 /* reserved */
198 #define ERRbadpermits 69 /* Access specified for a file is not valid */
199 #define ERRbadpid 70 /* reserved */
200 #define ERRsetattrmode 71 /* attribute mode invalid */
201 #define ERRpaused 81 /* Message server paused */
202 #define ERRmsgoff 82 /* Not receiving messages */
203 #define ERRnoroom 83 /* No room for message */
204 #define ERRrmuns 87 /* too many remote usernames */
205 #define ERRtimeout 88 /* operation timed out */
206 #define ERRnoresource  89 /* No resources currently available for request. */
207 #define ERRtoomanyuids 90 /* too many userids */
208 #define ERRbaduid 91 /* bad userid */
209 #define ERRuseMPX 250 /* temporarily unable to use raw mode, use MPX mode */
210 #define ERRuseSTD 251 /* temporarily unable to use raw mode, use standard mode */
211 #define ERRcontMPX 252 /* resume MPX mode */
212 #define ERRbadPW /* reserved */
213 #define ERRnosupport 0xFFFF
214 #define ERRunknownsmb 22 /* from NT 3.5 response */
215
216
217 /* Error codes for the ERRHRD class */
218
219 #define ERRnowrite 19 /* read only media */
220 #define ERRbadunit 20 /* Unknown device */
221 #define ERRnotready 21 /* Drive not ready */
222 #define ERRbadcmd 22 /* Unknown command */
223 #define ERRdata 23 /* Data (CRC) error */
224 #define ERRbadreq 24 /* Bad request structure length */
225 #define ERRseek 25
226 #define ERRbadmedia 26
227 #define ERRbadsector 27
228 #define ERRnopaper 28
229 #define ERRwrite 29 /* write fault */
230 #define ERRread 30 /* read fault */
231 #define ERRgeneral 31 /* General hardware failure */
232 #define ERRwrongdisk 34
233 #define ERRFCBunavail 35
234 #define ERRsharebufexc 36 /* share buffer exceeded */
235 #define ERRdiskfull 39
236
237
238 typedef char pstring[1024];
239 typedef char fstring[128];
240 typedef fstring string;
241
242
243 /* pipe strings */
244 #define PIPE_LANMAN   "\\PIPE\\LANMAN"
245 #define PIPE_SRVSVC   "\\PIPE\\srvsvc"
246 #define PIPE_SAMR     "\\PIPE\\samr"
247 #define PIPE_WKSSVC   "\\PIPE\\wkssvc"
248 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
249 #define PIPE_NTLSA    "\\PIPE\\ntlsa"
250 #define PIPE_NTSVCS   "\\PIPE\\ntsvcs"
251 #define PIPE_LSASS    "\\PIPE\\lsass"
252 #define PIPE_LSARPC   "\\PIPE\\lsarpc"
253
254 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
255 typedef struct time_info
256 {
257   uint32 time;
258
259 } UTIME;
260
261 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
262 typedef struct nttime_info
263 {
264   uint32 low;
265   uint32 high;
266
267 } NTTIME;
268
269 /* Allowable account control bits */
270 #define ACB_DISABLED   0x0001  /* 1 = User account disabled */
271 #define ACB_HOMDIRREQ  0x0002  /* 1 = Home directory required */
272 #define ACB_PWNOTREQ   0x0004  /* 1 = User password not required */
273 #define ACB_TEMPDUP    0x0008  /* 1 = Temporary duplicate account */
274 #define ACB_NORMAL     0x0010  /* 1 = Normal user account */
275 #define ACB_MNS        0x0020  /* 1 = MNS logon user account */
276 #define ACB_DOMTRUST   0x0040  /* 1 = Interdomain trust account */
277 #define ACB_WSTRUST    0x0080  /* 1 = Workstation trust account */
278 #define ACB_SVRTRUST   0x0100  /* 1 = Server trust account */
279 #define ACB_PWNOEXP    0x0200  /* 1 = User password does not expire */
280 #define ACB_AUTOLOCK   0x0400  /* 1 = Account auto locked */
281  
282 struct smb_passwd
283 {
284         int smb_userid;
285         char *smb_name;
286         unsigned char *smb_passwd; /* Null if no password */
287         unsigned char *smb_nt_passwd; /* Null if no password */
288         /* Other fields / flags may be added later */
289         uint16 acct_ctrl;
290 };
291
292 struct cli_state {
293         int fd;
294         int cnum;
295         int pid;
296         int mid;
297         int uid;
298         int protocol;
299         int sec_mode;
300         int error;
301         int privilages;
302         fstring eff_name;
303         fstring desthost;
304         char cryptkey[8];
305         uint32 sesskey;
306         int serverzone;
307         uint32 servertime;
308         int readbraw_supported;
309         int writebraw_supported;
310         int timeout;
311         int max_xmit;
312         char *outbuf;
313         char *inbuf;
314         int bufsize;
315         int initialised;
316 };
317
318
319 struct current_user
320 {
321   int cnum, vuid;
322   int uid, gid;
323   int ngroups;
324   gid_t *groups;
325   int *igroups;
326   int *attrs;
327 };
328
329 typedef struct
330 {
331   int size;
332   int mode;
333   int uid;
334   int gid;
335   /* these times are normally kept in GMT */
336   time_t mtime;
337   time_t atime;
338   time_t ctime;
339   pstring name;
340
341 } file_info;
342
343
344 /* Structure used when SMBwritebmpx is active */
345 typedef struct
346         {
347         int   wr_total_written; /* So we know when to discard this */
348         int32 wr_timeout;
349         int32 wr_errclass;
350         int32 wr_error; /* Cached errors */
351         BOOL  wr_mode; /* write through mode) */
352         BOOL  wr_discard; /* discard all further data */
353         } write_bmpx_struct;
354
355 /*
356  * Structure used to indirect fd's from the files_struct.
357  * Needed as POSIX locking is based on file and process, not
358  * file descriptor and process.
359  */
360
361 typedef struct
362 {
363   uint16 ref_count;
364   uint32 dev;
365   uint32 inode;
366   int fd;
367   int fd_readonly;
368   int fd_writeonly;
369   int real_open_flags;
370 } file_fd_struct;
371
372 typedef struct
373 {
374   int cnum;
375   file_fd_struct *fd_ptr;
376   int pos;
377   uint32 size;
378   int mode;
379   int vuid;
380   char *mmap_ptr;
381   uint32 mmap_size;
382   write_bmpx_struct *wbmpx_ptr;
383   struct timeval open_time;
384   BOOL open;
385   BOOL can_lock;
386   BOOL can_read;
387   BOOL can_write;
388   BOOL share_mode;
389   BOOL print_file;
390   BOOL modified;
391   BOOL granted_oplock;
392   BOOL sent_oplock_break;
393   BOOL reserved;
394   char *name;
395 } files_struct;
396
397
398 struct uid_cache {
399   int entries;
400   int list[UID_CACHE_SIZE];
401 };
402
403 typedef struct
404 {
405   char *name;
406   BOOL is_wild;
407 } name_compare_entry;
408
409 typedef struct
410 {
411   int service;
412   BOOL force_user;
413   struct uid_cache uid_cache;
414   void *dirptr;
415   BOOL open;
416   BOOL printer;
417   BOOL ipc;
418   BOOL read_only;
419   BOOL admin_user;
420   char *dirpath;
421   char *connectpath;
422   char *origpath;
423   char *user; /* name of user who *opened* this connection */
424   int uid; /* uid of user who *opened* this connection */
425   int gid; /* gid of user who *opened* this connection */
426
427   uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
428
429   /* following groups stuff added by ih */
430
431   /* This groups info is valid for the user that *opened* the connection */
432   int ngroups;
433   gid_t *groups;
434   int *igroups; /* an integer version - some OSes are broken :-( */
435   int *attrs;
436
437   time_t lastused;
438   BOOL used;
439   int num_files_open;
440   name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
441   name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
442   name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
443
444 } connection_struct;
445
446 /* DOM_CHAL - challenge info */
447 typedef struct chal_info
448 {
449   uchar data[8]; /* credentials */
450 } DOM_CHAL;
451
452 /* DOM_CREDs - timestamped client or server credentials */
453 typedef struct cred_info
454 {  
455   DOM_CHAL challenge; /* credentials */
456   UTIME timestamp;    /* credential time-stamp */
457
458 } DOM_CRED;
459
460 /* Domain controller authentication protocol info */
461 struct dcinfo
462 {
463   DOM_CHAL clnt_chal; /* Initial challenge received from client */
464   DOM_CHAL srv_chal;  /* Initial server challenge */
465   DOM_CRED clnt_cred; /* Last client credential */
466   DOM_CRED srv_cred;  /* Last server credential */
467
468   uchar  sess_key[8]; /* Session key */
469   uchar  md4pw[16];   /* md4(machine password) */
470 };
471
472 typedef struct
473 {
474   int uid; /* uid of a validated user */
475   int gid; /* gid of a validated user */
476
477   fstring name; /* name of a validated user */
478   fstring real_name;   /* to store real name from password file - simeon */
479   BOOL guest;
480
481   /* following groups stuff added by ih */
482   /* This groups info is needed for when we become_user() for this uid */
483   int n_groups;
484   gid_t *groups;
485   int *igroups; /* an integer version - some OSes are broken :-( */
486   int *attrs; /* attributes associated with each gid */
487
488   int n_sids;
489   int *sids;
490
491   /* per-user authentication information on NT RPCs */
492   struct dcinfo dc;
493
494 } user_struct;
495
496
497 enum {LPQ_QUEUED,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING};
498
499 typedef struct
500 {
501   int job;
502   int size;
503   int status;
504   int priority;
505   time_t time;
506   char user[30];
507   char file[100];
508 } print_queue_struct;
509
510 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
511
512 typedef struct
513 {
514   fstring message;
515   int status;
516 }  print_status_struct;
517
518 /* used for server information: client, nameserv and ipc */
519 struct server_info_struct
520 {
521   fstring name;
522   uint32 type;
523   fstring comment;
524   fstring domain; /* used ONLY in ipc.c NOT namework.c */
525   BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
526 };
527
528
529 /* used for network interfaces */
530 struct interface
531 {
532         struct interface *next;
533         struct in_addr ip;
534         struct in_addr bcast;
535         struct in_addr nmask;
536 };
537
538 /* struct returned by get_share_modes */
539 typedef struct
540 {
541   int pid;
542   uint16 op_port;
543   uint16 op_type;
544   int share_mode;
545   struct timeval time;
546 } share_mode_entry;
547
548
549 /* each implementation of the share mode code needs
550    to support the following operations */
551 struct share_ops {
552         BOOL (*stop_mgmt)(void);
553         BOOL (*lock_entry)(int , uint32 , uint32 , int *);
554         BOOL (*unlock_entry)(int , uint32 , uint32 , int );
555         int (*get_entries)(int , int , uint32 , uint32 , share_mode_entry **);
556         void (*del_entry)(int , int );
557         BOOL (*set_entry)(int , int , uint16 , uint16 );
558         BOOL (*remove_oplock)(int , int);
559         int (*forall)(void (*)(share_mode_entry *, char *));
560         void (*status)(FILE *);
561 };
562
563 /* each implementation of the shared memory code needs
564    to support the following operations */
565 struct shmem_ops {
566         BOOL (*shm_close)( void );
567         int (*shm_alloc)(int );
568         BOOL (*shm_free)(int );
569         int (*get_userdef_off)(void);
570         void *(*offset2addr)(int );
571         int (*addr2offset)(void *addr);
572         BOOL (*lock_hash_entry)(unsigned int);
573         BOOL (*unlock_hash_entry)( unsigned int );
574         BOOL (*get_usage)(int *,int *,int *);
575         unsigned (*hash_size)(void);
576 };
577
578
579 /* this is used for smbstatus */
580 struct connect_record
581 {
582   int magic;
583   int pid;
584   int cnum;
585   int uid;
586   int gid;
587   char name[24];
588   char addr[24];
589   char machine[128];
590   time_t start;
591 };
592
593 /* This is used by smbclient to send it to a smbfs mount point */
594 struct connection_options {
595   int protocol;
596   /* Connection-Options */
597   uint32 max_xmit;
598   uint16 server_uid;
599   uint16 tid;
600   /* The following are LANMAN 1.0 options */
601   uint16 sec_mode;
602   uint16 max_mux;
603   uint16 max_vcs;
604   uint16 rawmode;
605   uint32 sesskey;
606   /* The following are NT LM 0.12 options */
607   uint32 maxraw;
608   uint32 capabilities;
609   uint16 serverzone;
610 };
611
612 /* the following are used by loadparm for option lists */
613 typedef enum
614 {
615   P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
616   P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM
617 } parm_type;
618
619 typedef enum
620 {
621   P_LOCAL,P_GLOBAL,P_NONE
622 } parm_class;
623
624 struct enum_list {
625         int value;
626         char *name;
627 };
628
629 struct parm_struct
630 {
631         char *label;
632         parm_type type;
633         parm_class class;
634         void *ptr;
635         BOOL (*special)();
636         struct enum_list *enum_list;
637         unsigned flags;
638 };
639
640
641 #define FLAG_BASIC 1
642 #define FLAG_HIDE  2
643 #define FLAG_PRINT 4
644
645 #ifndef LOCKING_VERSION
646 #define LOCKING_VERSION 4
647 #endif /* LOCKING_VERSION */
648
649 /* these are useful macros for checking validity of handles */
650 #define VALID_FNUM(fnum)   (((fnum) >= 0) && ((fnum) < MAX_OPEN_FILES))
651 #define OPEN_FNUM(fnum)    (VALID_FNUM(fnum) && Files[fnum].open)
652 #define VALID_CNUM(cnum)   (((cnum) >= 0) && ((cnum) < MAX_CONNECTIONS))
653 #define OPEN_CNUM(cnum)    (VALID_CNUM(cnum) && Connections[cnum].open)
654 #define IS_IPC(cnum)       (VALID_CNUM(cnum) && Connections[cnum].ipc)
655 #define IS_PRINT(cnum)       (VALID_CNUM(cnum) && Connections[cnum].printer)
656 #define FNUM_OK(fnum,c) (OPEN_FNUM(fnum) && (c)==Files[fnum].cnum)
657
658 #define CHECK_FNUM(fnum,c) if (!FNUM_OK(fnum,c)) \
659                                return(ERROR(ERRDOS,ERRbadfid))
660 #define CHECK_READ(fnum) if (!Files[fnum].can_read) \
661                                return(ERROR(ERRDOS,ERRbadaccess))
662 #define CHECK_WRITE(fnum) if (!Files[fnum].can_write) \
663                                return(ERROR(ERRDOS,ERRbadaccess))
664 #define CHECK_ERROR(fnum) if (HAS_CACHED_ERROR(fnum)) \
665                                return(CACHED_ERROR(fnum))
666
667 /* translates a connection number into a service number */
668 #define SNUM(cnum)         (Connections[cnum].service)
669
670 /* access various service details */
671 #define SERVICE(snum)      (lp_servicename(snum))
672 #define PRINTCAP           (lp_printcapname())
673 #define PRINTCOMMAND(snum) (lp_printcommand(snum))
674 #define PRINTERNAME(snum)  (lp_printername(snum))
675 #define CAN_WRITE(cnum)    (OPEN_CNUM(cnum) && !Connections[cnum].read_only)
676 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
677 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
678 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
679 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
680 #define CAN_PRINT(cnum)    (OPEN_CNUM(cnum) && lp_print_ok(SNUM(cnum)))
681 #define POSTSCRIPT(cnum)   (OPEN_CNUM(cnum) && lp_postscript(SNUM(cnum)))
682 #define MAP_HIDDEN(cnum)   (OPEN_CNUM(cnum) && lp_map_hidden(SNUM(cnum)))
683 #define MAP_SYSTEM(cnum)   (OPEN_CNUM(cnum) && lp_map_system(SNUM(cnum)))
684 #define MAP_ARCHIVE(cnum)   (OPEN_CNUM(cnum) && lp_map_archive(SNUM(cnum)))
685 #define IS_HIDDEN_PATH(cnum,path)  (is_in_path((path),Connections[(cnum)].hide_list))
686 #define IS_VETO_PATH(cnum,path)  (is_in_path((path),Connections[(cnum)].veto_list))
687 #define IS_VETO_OPLOCK_PATH(cnum,path)  (is_in_path((path),Connections[(cnum)].veto_oplock_list))
688
689 #define SMBENCRYPT()       (lp_encrypted_passwords())
690
691 /* the basic packet size, assuming no words or bytes */
692 #define smb_size 39
693
694 /* offsets into message for common items */
695 #define smb_com 8
696 #define smb_rcls 9
697 #define smb_reh 10
698 #define smb_err 11
699 #define smb_flg 13
700 #define smb_flg2 14
701 #define smb_reb 13
702 #define smb_tid 28
703 #define smb_pid 30
704 #define smb_uid 32
705 #define smb_mid 34
706 #define smb_wct 36
707 #define smb_vwv 37
708 #define smb_vwv0 37
709 #define smb_vwv1 39
710 #define smb_vwv2 41
711 #define smb_vwv3 43
712 #define smb_vwv4 45
713 #define smb_vwv5 47
714 #define smb_vwv6 49
715 #define smb_vwv7 51
716 #define smb_vwv8 53
717 #define smb_vwv9 55
718 #define smb_vwv10 57
719 #define smb_vwv11 59
720 #define smb_vwv12 61
721 #define smb_vwv13 63
722 #define smb_vwv14 65
723 #define smb_vwv15 67
724 #define smb_vwv16 69
725 #define smb_vwv17 71
726
727
728 /* the complete */
729 #define SMBmkdir      0x00   /* create directory */
730 #define SMBrmdir      0x01   /* delete directory */
731 #define SMBopen       0x02   /* open file */
732 #define SMBcreate     0x03   /* create file */
733 #define SMBclose      0x04   /* close file */
734 #define SMBflush      0x05   /* flush file */
735 #define SMBunlink     0x06   /* delete file */
736 #define SMBmv         0x07   /* rename file */
737 #define SMBgetatr     0x08   /* get file attributes */
738 #define SMBsetatr     0x09   /* set file attributes */
739 #define SMBread       0x0A   /* read from file */
740 #define SMBwrite      0x0B   /* write to file */
741 #define SMBlock       0x0C   /* lock byte range */
742 #define SMBunlock     0x0D   /* unlock byte range */
743 #define SMBctemp      0x0E   /* create temporary file */
744 #define SMBmknew      0x0F   /* make new file */
745 #define SMBchkpth     0x10   /* check directory path */
746 #define SMBexit       0x11   /* process exit */
747 #define SMBlseek      0x12   /* seek */
748 #define SMBtcon       0x70   /* tree connect */
749 #define SMBtconX      0x75   /* tree connect and X*/
750 #define SMBtdis       0x71   /* tree disconnect */
751 #define SMBnegprot    0x72   /* negotiate protocol */
752 #define SMBdskattr    0x80   /* get disk attributes */
753 #define SMBsearch     0x81   /* search directory */
754 #define SMBsplopen    0xC0   /* open print spool file */
755 #define SMBsplwr      0xC1   /* write to print spool file */
756 #define SMBsplclose   0xC2   /* close print spool file */
757 #define SMBsplretq    0xC3   /* return print queue */
758 #define SMBsends      0xD0   /* send single block message */
759 #define SMBsendb      0xD1   /* send broadcast message */
760 #define SMBfwdname    0xD2   /* forward user name */
761 #define SMBcancelf    0xD3   /* cancel forward */
762 #define SMBgetmac     0xD4   /* get machine name */
763 #define SMBsendstrt   0xD5   /* send start of multi-block message */
764 #define SMBsendend    0xD6   /* send end of multi-block message */
765 #define SMBsendtxt    0xD7   /* send text of multi-block message */
766
767 /* Core+ protocol */
768 #define SMBlockread       0x13   /* Lock a range and read */
769 #define SMBwriteunlock 0x14 /* Unlock a range then write */
770 #define SMBreadbraw   0x1a  /* read a block of data with no smb header */
771 #define SMBwritebraw  0x1d  /* write a block of data with no smb header */
772 #define SMBwritec     0x20  /* secondary write request */
773 #define SMBwriteclose 0x2c  /* write a file then close it */
774
775 /* dos extended protocol */
776 #define SMBreadBraw      0x1A   /* read block raw */
777 #define SMBreadBmpx      0x1B   /* read block multiplexed */
778 #define SMBreadBs        0x1C   /* read block (secondary response) */
779 #define SMBwriteBraw     0x1D   /* write block raw */
780 #define SMBwriteBmpx     0x1E   /* write block multiplexed */
781 #define SMBwriteBs       0x1F   /* write block (secondary request) */
782 #define SMBwriteC        0x20   /* write complete response */
783 #define SMBsetattrE      0x22   /* set file attributes expanded */
784 #define SMBgetattrE      0x23   /* get file attributes expanded */
785 #define SMBlockingX      0x24   /* lock/unlock byte ranges and X */
786 #define SMBtrans         0x25   /* transaction - name, bytes in/out */
787 #define SMBtranss        0x26   /* transaction (secondary request/response) */
788 #define SMBioctl         0x27   /* IOCTL */
789 #define SMBioctls        0x28   /* IOCTL  (secondary request/response) */
790 #define SMBcopy          0x29   /* copy */
791 #define SMBmove          0x2A   /* move */
792 #define SMBecho          0x2B   /* echo */
793 #define SMBopenX         0x2D   /* open and X */
794 #define SMBreadX         0x2E   /* read and X */
795 #define SMBwriteX        0x2F   /* write and X */
796 #define SMBsesssetupX    0x73   /* Session Set Up & X (including User Logon) */
797 #define SMBffirst        0x82   /* find first */
798 #define SMBfunique       0x83   /* find unique */
799 #define SMBfclose        0x84   /* find close */
800 #define SMBinvalid       0xFE   /* invalid command */
801
802 /* Extended 2.0 protocol */
803 #define SMBtrans2        0x32   /* TRANS2 protocol set */
804 #define SMBtranss2       0x33   /* TRANS2 protocol set, secondary command */
805 #define SMBfindclose     0x34   /* Terminate a TRANSACT2_FINDFIRST */
806 #define SMBfindnclose    0x35   /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
807 #define SMBulogoffX      0x74   /* user logoff */
808
809 /* NT SMB extensions. */
810 #define SMBnttrans       0xA0   /* NT transact */
811 #define SMBnttranss      0xA1   /* NT transact secondary */
812 #define SMBntcreateX     0xA2   /* NT create and X */
813 #define SMBntcancel      0xA4   /* NT cancel */
814
815 /* These are the TRANS2 sub commands */
816 #define TRANSACT2_OPEN                        0
817 #define TRANSACT2_FINDFIRST                   1
818 #define TRANSACT2_FINDNEXT                    2
819 #define TRANSACT2_QFSINFO                     3
820 #define TRANSACT2_SETFSINFO                   4
821 #define TRANSACT2_QPATHINFO                   5
822 #define TRANSACT2_SETPATHINFO                 6
823 #define TRANSACT2_QFILEINFO                   7
824 #define TRANSACT2_SETFILEINFO                 8
825 #define TRANSACT2_FSCTL                       9
826 #define TRANSACT2_IOCTL                     0xA
827 #define TRANSACT2_FINDNOTIFYFIRST           0xB
828 #define TRANSACT2_FINDNOTIFYNEXT            0xC
829 #define TRANSACT2_MKDIR                     0xD
830 #define TRANSACT2_SESSION_SETUP             0xE
831 #define TRANSACT2_GET_DFS_REFERRAL         0x10
832 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
833
834 /* These are the NT transact sub commands. */
835 #define NT_TRANSACT_CREATE                1
836 #define NT_TRANSACT_IOCTL                 2
837 #define NT_TRANSACT_SET_SECURITY_DESC     3
838 #define NT_TRANSACT_NOTIFY_CHANGE         4
839 #define NT_TRANSACT_RENAME                5
840 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
841
842 /* these are the trans2 sub fields for primary requests */
843 #define smb_tpscnt smb_vwv0
844 #define smb_tdscnt smb_vwv1
845 #define smb_mprcnt smb_vwv2
846 #define smb_mdrcnt smb_vwv3
847 #define smb_msrcnt smb_vwv4
848 #define smb_flags smb_vwv5
849 #define smb_timeout smb_vwv6
850 #define smb_pscnt smb_vwv9
851 #define smb_psoff smb_vwv10
852 #define smb_dscnt smb_vwv11
853 #define smb_dsoff smb_vwv12
854 #define smb_suwcnt smb_vwv13
855 #define smb_setup smb_vwv14
856 #define smb_setup0 smb_setup
857 #define smb_setup1 (smb_setup+2)
858 #define smb_setup2 (smb_setup+4)
859
860 /* these are for the secondary requests */
861 #define smb_spscnt smb_vwv2
862 #define smb_spsoff smb_vwv3
863 #define smb_spsdisp smb_vwv4
864 #define smb_sdscnt smb_vwv5
865 #define smb_sdsoff smb_vwv6
866 #define smb_sdsdisp smb_vwv7
867 #define smb_sfid smb_vwv8
868
869 /* and these for responses */
870 #define smb_tprcnt smb_vwv0
871 #define smb_tdrcnt smb_vwv1
872 #define smb_prcnt smb_vwv3
873 #define smb_proff smb_vwv4
874 #define smb_prdisp smb_vwv5
875 #define smb_drcnt smb_vwv6
876 #define smb_droff smb_vwv7
877 #define smb_drdisp smb_vwv8
878
879 /* where to find the base of the SMB packet proper */
880 #define smb_base(buf) (((char *)(buf))+4)
881
882
883 #define SUCCESS 0  /* The request was successful. */
884 #define ERRDOS 0x01 /*  Error is from the core DOS operating system set. */
885 #define ERRSRV 0x02  /* Error is generated by the server network file manager.*/
886 #define ERRHRD 0x03  /* Error is an hardware error. */
887 #define ERRCMD 0xFF  /* Command was not in the "SMB" format. */
888
889 #ifdef __STDC__
890 int Debug1(char *, ...);
891 #else
892 int Debug1();
893 #endif
894
895 #ifdef DFS_AUTH
896 void dfs_unlogin(void);
897 extern int dcelogin_atmost_once;
898 #endif
899
900 #if AJT
901 void ajt_panic(void);
902 #endif
903
904 #ifdef NOSTRDUP
905 char *strdup(char *s);
906 #endif
907
908 #ifdef REPLACE_STRLEN
909 int Strlen(char *);
910 #endif
911
912 #ifdef REPLACE_STRSTR
913 char *Strstr(char *s, char *p);
914 #endif
915
916 #ifndef MIN
917 #define MIN(a,b) ((a)<(b)?(a):(b))
918 #endif
919 #ifndef MAX
920 #define MAX(a,b) ((a)>(b)?(a):(b))
921 #endif
922
923 #ifndef ABS
924 #define ABS(a) ((a)>0?(a):(-(a)))
925 #endif
926
927 #ifndef SIGNAL_CAST
928 #define SIGNAL_CAST
929 #endif
930
931 #ifndef SELECT_CAST
932 #define SELECT_CAST
933 #endif
934
935
936 /* Some POSIX definitions for those without */
937  
938 #ifndef S_IFDIR
939 #define S_IFDIR         0x4000
940 #endif
941 #ifndef S_ISDIR
942 #define S_ISDIR(mode)   ((mode & 0xF000) == S_IFDIR)
943 #endif
944 #ifndef S_IRWXU
945 #define S_IRWXU 00700           /* read, write, execute: owner */
946 #endif
947 #ifndef S_IRUSR
948 #define S_IRUSR 00400           /* read permission: owner */
949 #endif
950 #ifndef S_IWUSR
951 #define S_IWUSR 00200           /* write permission: owner */
952 #endif
953 #ifndef S_IXUSR
954 #define S_IXUSR 00100           /* execute permission: owner */
955 #endif
956 #ifndef S_IRWXG
957 #define S_IRWXG 00070           /* read, write, execute: group */
958 #endif
959 #ifndef S_IRGRP
960 #define S_IRGRP 00040           /* read permission: group */
961 #endif
962 #ifndef S_IWGRP
963 #define S_IWGRP 00020           /* write permission: group */
964 #endif
965 #ifndef S_IXGRP
966 #define S_IXGRP 00010           /* execute permission: group */
967 #endif
968 #ifndef S_IRWXO
969 #define S_IRWXO 00007           /* read, write, execute: other */
970 #endif
971 #ifndef S_IROTH
972 #define S_IROTH 00004           /* read permission: other */
973 #endif
974 #ifndef S_IWOTH
975 #define S_IWOTH 00002           /* write permission: other */
976 #endif
977 #ifndef S_IXOTH
978 #define S_IXOTH 00001           /* execute permission: other */
979 #endif
980
981
982 /* these are used in NetServerEnum to choose what to receive */
983 #define SV_TYPE_WORKSTATION         0x00000001
984 #define SV_TYPE_SERVER              0x00000002
985 #define SV_TYPE_SQLSERVER           0x00000004
986 #define SV_TYPE_DOMAIN_CTRL         0x00000008
987 #define SV_TYPE_DOMAIN_BAKCTRL      0x00000010
988 #define SV_TYPE_TIME_SOURCE         0x00000020
989 #define SV_TYPE_AFP                 0x00000040
990 #define SV_TYPE_NOVELL              0x00000080
991 #define SV_TYPE_DOMAIN_MEMBER       0x00000100
992 #define SV_TYPE_PRINTQ_SERVER       0x00000200
993 #define SV_TYPE_DIALIN_SERVER       0x00000400
994 #define SV_TYPE_SERVER_UNIX         0x00000800
995 #define SV_TYPE_NT                  0x00001000
996 #define SV_TYPE_WFW                 0x00002000
997 #define SV_TYPE_SERVER_MFPN         0x00004000
998 #define SV_TYPE_SERVER_NT           0x00008000
999 #define SV_TYPE_POTENTIAL_BROWSER   0x00010000
1000 #define SV_TYPE_BACKUP_BROWSER      0x00020000
1001 #define SV_TYPE_MASTER_BROWSER      0x00040000
1002 #define SV_TYPE_DOMAIN_MASTER       0x00080000
1003 #define SV_TYPE_SERVER_OSF          0x00100000
1004 #define SV_TYPE_SERVER_VMS          0x00200000
1005 #define SV_TYPE_WIN95_PLUS          0x00400000
1006 #define SV_TYPE_ALTERNATE_XPORT     0x20000000  
1007 #define SV_TYPE_LOCAL_LIST_ONLY     0x40000000  
1008 #define SV_TYPE_DOMAIN_ENUM         0x80000000
1009 #define SV_TYPE_ALL                 0xFFFFFFFF  
1010
1011 /* what server type are we currently  - JHT Says we ARE 4.20 */
1012 /* this was set by JHT in liaison with Jeremy Allison early 1997 */
1013 /* setting to 4.20 at same time as announcing ourselves as NT Server */
1014 /* History: */
1015 /* Version 4.0 - never made public */
1016 /* Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9 */
1017 /*              - Reappeared in 1.9.16p11 with fixed smbd services */
1018 /* Version 4.20 - To indicate that nmbd and browsing now works better */
1019
1020 #define DEFAULT_MAJOR_VERSION 0x04
1021 #define DEFAULT_MINOR_VERSION 0x02
1022
1023 /* Browser Election Values */
1024 #define BROWSER_ELECTION_VERSION        0x010f
1025 #define BROWSER_CONSTANT        0xaa55
1026
1027 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1028    
1029 #define FLAGS2_LONG_PATH_COMPONENTS   0x0001
1030 #define FLAGS2_EXTENDED_ATTRIBUTES    0x0002
1031 #define FLAGS2_DFS_PATHNAMES          0x1000
1032 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1033 #define FLAGS2_32_BIT_ERROR_CODES     0x4000 
1034 #define FLAGS2_UNICODE_STRINGS        0x8000
1035
1036 /* Capabilities.  see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1037
1038 #define CAP_RAW_MODE         0x0001
1039 #define CAP_MPX_MODE         0x0002
1040 #define CAP_UNICODE          0x0004
1041 #define CAP_LARGE_FILES      0x0008
1042 #define CAP_NT_SMBS          0x0010
1043 #define CAP_RPC_REMOTE_APIS  0x0020
1044 #define CAP_STATUS32         0x0040
1045 #define CAP_LEVEL_II_OPLOCKS 0x0080
1046 #define CAP_LOCK_AND_READ    0x0100
1047 #define CAP_NT_FIND          0x0200
1048 #define CAP_DFS              0x1000
1049 #define CAP_LARGE_READX      0x4000
1050
1051 /* protocol types. It assumes that higher protocols include lower protocols
1052    as subsets */
1053 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1054
1055 /* security levels */
1056 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER};
1057
1058 /* printing types */
1059 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1060                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG};
1061
1062 /* Remote architectures we know about. */
1063 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_SAMBA};
1064
1065 /* case handling */
1066 enum case_handling {CASE_LOWER,CASE_UPPER};
1067
1068
1069 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
1070    structures. We cannot define these as actual structures
1071    due to possible differences in structure packing
1072    on different machines/compilers. */
1073
1074 #define SMB_LPID_OFFSET(indx) (10 * (indx))
1075 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
1076 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
1077
1078 /* Macro to cache an error in a write_bmpx_struct */
1079 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
1080                             w->wr_discard = True, -1)
1081 /* Macro to test if an error has been cached for this fnum */
1082 #define HAS_CACHED_ERROR(fnum) (Files[(fnum)].open && \
1083                                 Files[(fnum)].wbmpx_ptr && \
1084                                 Files[(fnum)].wbmpx_ptr->wr_discard)
1085 /* Macro to turn the cached error into an error packet */
1086 #define CACHED_ERROR(fnum) cached_error_packet(inbuf,outbuf,fnum,__LINE__)
1087
1088 /* these are the datagram types */
1089 #define DGRAM_DIRECT_UNIQUE 0x10
1090
1091 #define ERROR(class,x) error_packet(inbuf,outbuf,class,x,__LINE__)
1092
1093 /* this is how errors are generated */
1094 #define UNIXERROR(defclass,deferror) unix_error_packet(inbuf,outbuf,defclass,deferror,__LINE__)
1095
1096 #define ROUNDUP(x,g) (((x)+((g)-1))&~((g)-1))
1097
1098 /*
1099  * Global value meaing that the smb_uid field should be
1100  * ingored (in share level security and protocol level == CORE)
1101  */
1102
1103 #define UID_FIELD_INVALID 0
1104 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1105
1106 /* Defines needed for multi-codepage support. */
1107 #define MSDOS_LATIN_1_CODEPAGE 850
1108 #define KANJI_CODEPAGE 932
1109 #define HANGUL_CODEPAGE 949
1110 #define BIG5_CODEPAGE 950
1111
1112 #ifdef KANJI
1113 /* 
1114  * Default client code page - Japanese 
1115  */
1116 #define DEFAULT_CLIENT_CODE_PAGE KANJI_CODEPAGE
1117 #else /* KANJI */
1118 /* 
1119  * Default client code page - 850 - Western European 
1120  */
1121 #define DEFAULT_CLIENT_CODE_PAGE MSDOS_LATIN_1_CODEPAGE
1122 #endif /* KANJI */
1123
1124 /* 
1125  * Size of buffer to use when moving files across filesystems. 
1126  */
1127 #define COPYBUF_SIZE (8*1024)
1128
1129 /* 
1130  * Integers used to override error codes. 
1131  */
1132 extern int unix_ERR_class;
1133 extern int unix_ERR_code;
1134
1135 /*
1136  * Map the Core and Extended Oplock requesst bits down
1137  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1138  */
1139
1140 /*
1141  * Core protocol.
1142  */
1143 #define CORE_OPLOCK_REQUEST(inbuf) ((CVAL(inbuf,smb_flg)&((1<<5)|(1<<6)))>>5)
1144
1145 /*
1146  * Extended protocol.
1147  */
1148 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1149
1150 /* Lock types. */
1151 #define LOCKING_ANDX_SHARED_LOCK 0x1
1152 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1153 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1154 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1155 #define LOCKING_ANDX_LARGE_FILES 0x10
1156
1157 /* Oplock levels */
1158 #define OPLOCKLEVEL_NONE 0
1159 #define OPLOCKLEVEL_II 1
1160
1161 /*
1162  * Bits we test with.
1163  */
1164 #define EXCLUSIVE_OPLOCK 1
1165 #define BATCH_OPLOCK 2
1166
1167 #define CORE_OPLOCK_GRANTED (1<<5)
1168 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1169
1170 /*
1171  * Loopback command offsets.
1172  */
1173
1174 #define UDP_CMD_LEN_OFFSET 0
1175 #define UDP_CMD_PORT_OFFSET 4
1176 #define UDP_CMD_HEADER_LEN 6
1177
1178 #define UDP_MESSAGE_CMD_OFFSET 0
1179
1180 /*
1181  * Oplock break command code to send over the udp socket.
1182  * 
1183  * Form of this is :
1184  *
1185  *  0     2       6        10       14      18       22
1186  *  +----+--------+--------+--------+-------+--------+
1187  *  | cmd| pid    | dev    | inode  | sec   |  usec  |
1188  *  +----+--------+--------+--------+-------+--------+
1189  */
1190
1191 #define OPLOCK_BREAK_CMD 0x1
1192 #define OPLOCK_BREAK_PID_OFFSET 2
1193 #define OPLOCK_BREAK_DEV_OFFSET 6
1194 #define OPLOCK_BREAK_INODE_OFFSET 10
1195 #define OPLOCK_BREAK_SEC_OFFSET 14
1196 #define OPLOCK_BREAK_USEC_OFFSET 18
1197 #define OPLOCK_BREAK_MSG_LEN 22
1198
1199
1200 #define CMD_REPLY 0x8000
1201
1202 #endif /* _SMB_H */
1203
1204 #include "ntdomain.h"
1205
1206 /* _SMB_H */