a big one:
[ira/wip.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-2000
6    Copyright (C) John H Terpstra              1996-2000
7    Copyright (C) Luke Kenneth Casson Leighton 1996-2000
8    Copyright (C) Paul Ashton                  1998-2000
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
25 #ifndef _SMB_H
26 #define _SMB_H
27
28 #define BUFFER_SIZE (0xFFFF)
29 #define SAFETY_MARGIN 1024
30 #define LARGE_WRITEX_HDR_SIZE 65
31
32 #define NMB_PORT 137
33 #define DGRAM_PORT 138
34 #define SMB_PORT 139
35
36 #define False (0)
37 #define True (1)
38 #define Auto (2)
39
40 #ifndef _BOOL
41 typedef int BOOL;
42 #define _BOOL       /* So we don't typedef BOOL again in vfs.h */
43 #endif
44
45 /* limiting size of ipc replies */
46 #define REALLOC(ptr,size) Realloc(ptr,MAX((size),4*1024))
47
48 #define SIZEOFWORD 2
49
50 #ifndef DEF_CREATE_MASK
51 #define DEF_CREATE_MASK (0755)
52 #endif
53
54 /* string manipulation flags - see clistr.c and srvstr.c */
55 #define STR_TERMINATE 1
56 #define STR_UPPER 2
57 #define STR_ASCII 4
58 #define STR_UNICODE 8
59 #define STR_NOALIGN 16
60
61 /* how long to wait for secondary SMB packets (milli-seconds) */
62 #define SMB_SECONDARY_WAIT (60*1000)
63
64 /* Debugging stuff */
65 #include "debug.h"
66
67 /* this defines the error codes that receive_smb can put in smb_read_error */
68 #define READ_TIMEOUT 1
69 #define READ_EOF 2
70 #define READ_ERROR 3
71
72
73 #define DIR_STRUCT_SIZE 43
74
75 /* these define all the command types recognised by the server - there
76 are lots of gaps so probably there are some rare commands that are not
77 implemented */
78
79 #define pSETDIR '\377'
80
81 /* these define the attribute byte as seen by DOS */
82 #define aRONLY (1L<<0)
83 #define aHIDDEN (1L<<1)
84 #define aSYSTEM (1L<<2)
85 #define aVOLID (1L<<3)
86 #define aDIR (1L<<4)
87 #define aARCH (1L<<5)
88
89 /* deny modes */
90 #define DENY_DOS 0
91 #define DENY_ALL 1
92 #define DENY_WRITE 2
93 #define DENY_READ 3
94 #define DENY_NONE 4
95 #define DENY_FCB 7
96
97 /* open modes */
98 #define DOS_OPEN_RDONLY 0
99 #define DOS_OPEN_WRONLY 1
100 #define DOS_OPEN_RDWR 2
101 #define DOS_OPEN_FCB 0xF
102
103 /* define shifts and masks for share and open modes. */
104 #define OPEN_MODE_MASK 0xF
105 #define SHARE_MODE_SHIFT 4
106 #define SHARE_MODE_MASK 0x7
107 #define GET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
108 #define SET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
109 #define GET_DENY_MODE(x) (((x)>>SHARE_MODE_SHIFT) & SHARE_MODE_MASK)
110 #define SET_DENY_MODE(x) (((x) & SHARE_MODE_MASK) <<SHARE_MODE_SHIFT)
111
112 /* Sync on open file (not sure if used anymore... ?) */
113 #define FILE_SYNC_OPENMODE (1<<14)
114 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
115
116 /* allow delete on open file mode (used by NT SMB's). */
117 #define ALLOW_SHARE_DELETE (1<<15)
118 #define GET_ALLOW_SHARE_DELETE(x) (((x) & ALLOW_SHARE_DELETE) ? True : False)
119 #define SET_ALLOW_SHARE_DELETE(x) ((x) ? ALLOW_SHARE_DELETE : 0)
120
121 /* delete on close flag (used by NT SMB's). */
122 #define DELETE_ON_CLOSE_FLAG (1<<16)
123 #define GET_DELETE_ON_CLOSE_FLAG(x) (((x) & DELETE_ON_CLOSE_FLAG) ? True : False)
124 #define SET_DELETE_ON_CLOSE_FLAG(x) ((x) ? DELETE_ON_CLOSE_FLAG : 0)
125
126 /* was delete access requested in NT open ? */
127 #define DELETE_ACCESS_REQUESTED (1<<17)
128 #define GET_DELETE_ACCESS_REQUESTED(x) (((x) & DELETE_ACCESS_REQUESTED) ? True : False)
129 #define SET_DELETE_ACCESS_REQUESTED(x) ((x) ? DELETE_ACCESS_REQUESTED : 0)
130
131 /* open disposition values */
132 #define FILE_EXISTS_FAIL 0
133 #define FILE_EXISTS_OPEN 1
134 #define FILE_EXISTS_TRUNCATE 2
135
136 /* mask for open disposition. */
137 #define FILE_OPEN_MASK 0x3
138
139 #define GET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
140 #define SET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
141
142 /* The above can be OR'ed with... */
143 #define FILE_CREATE_IF_NOT_EXIST 0x10
144 #define FILE_FAIL_IF_NOT_EXIST 0
145
146 #define GET_FILE_CREATE_DISPOSITION(x) ((x) & (FILE_CREATE_IF_NOT_EXIST|FILE_FAIL_IF_NOT_EXIST))
147
148 /* share types */
149 #define STYPE_DISKTREE  0       /* Disk drive */
150 #define STYPE_PRINTQ    1       /* Spooler queue */
151 #define STYPE_DEVICE    2       /* Serial device */
152 #define STYPE_IPC       3       /* Interprocess communication (IPC) */
153 #define STYPE_HIDDEN    0x80000000 /* share is a hidden one (ends with $) */
154
155 #include "doserr.h"
156
157 #ifndef _PSTRING
158
159 #define PSTRING_LEN 1024
160 #define FSTRING_LEN 256
161
162 typedef char pstring[PSTRING_LEN];
163 typedef char fstring[FSTRING_LEN];
164
165 #define _PSTRING
166
167 #endif
168
169 /*
170  * SMB UCS2 (16-bit unicode) internal type.
171  */
172
173 typedef uint16 smb_ucs2_t;
174
175 /* ucs2 string types. */
176 typedef smb_ucs2_t wpstring[PSTRING_LEN];
177 typedef smb_ucs2_t wfstring[FSTRING_LEN];
178
179
180 #ifdef WORDS_BIGENDIAN
181 #define UCS2_SHIFT 8
182 #else
183 #define UCS2_SHIFT 0
184 #endif
185
186 /* turn a 7 bit character into a ucs2 character */
187 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
188
189 /* pipe string names */
190 #define PIPE_LANMAN   "\\PIPE\\LANMAN"
191 #define PIPE_SRVSVC   "\\PIPE\\srvsvc"
192 #define PIPE_SAMR     "\\PIPE\\samr"
193 #define PIPE_WINREG   "\\PIPE\\winreg"
194 #define PIPE_WKSSVC   "\\PIPE\\wkssvc"
195 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
196 #define PIPE_NTLSA    "\\PIPE\\ntlsa"
197 #define PIPE_NTSVCS   "\\PIPE\\ntsvcs"
198 #define PIPE_LSASS    "\\PIPE\\lsass"
199 #define PIPE_LSARPC   "\\PIPE\\lsarpc"
200 #define PIPE_SPOOLSS  "\\PIPE\\spoolss"
201 #define PIPE_NETDFS   "\\PIPE\\netdfs"
202
203 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
204 typedef struct nttime_info
205 {
206   uint32 low;
207   uint32 high;
208 } NTTIME;
209
210
211 /* the following rather strange looking definitions of NTSTATUS and WERROR
212    and there in order to catch common coding errors where different error types
213    are mixed up. This is especially important as we slowly convert Samba
214    from using BOOL for internal functions 
215 */
216 #if defined(HAVE_IMMEDIATE_STRUCTURES)
217 typedef struct {uint32 v;} NTSTATUS;
218 #define NT_STATUS(x) ((NTSTATUS) { x })
219 #define NT_STATUS_V(x) ((x).v)
220 #else
221 typedef uint32 NTSTATUS;
222 #define NT_STATUS(x) (x)
223 #define NT_STATUS_V(x) (x)
224 #endif
225
226 #if defined(HAVE_IMMEDIATE_STRUCTURES)
227 typedef struct {uint32 v;} WERROR;
228 #define W_ERROR(x) ((WERROR) { x })
229 #define W_ERROR_V(x) ((x).v)
230 #else
231 typedef uint32 WERROR;
232 #define W_ERROR(x) (x)
233 #define W_ERROR_V(x) (x)
234 #endif
235
236 #define NT_STATUS_IS_OK(x) (NT_STATUS_V(x) == 0)
237 #define NT_STATUS_IS_ERR(x) ((NT_STATUS_V(x) & 0xc0000000) == 0xc0000000)
238 #define NT_STATUS_EQUAL(x,y) (NT_STATUS_V(x) == NT_STATUS_V(y))
239 #define W_ERROR_IS_OK(x) (W_ERROR_V(x) == 0)
240
241
242 /* Allowable account control bits */
243 #define ACB_DISABLED   0x0001  /* 1 = User account disabled */
244 #define ACB_HOMDIRREQ  0x0002  /* 1 = Home directory required */
245 #define ACB_PWNOTREQ   0x0004  /* 1 = User password not required */
246 #define ACB_TEMPDUP    0x0008  /* 1 = Temporary duplicate account */
247 #define ACB_NORMAL     0x0010  /* 1 = Normal user account */
248 #define ACB_MNS        0x0020  /* 1 = MNS logon user account */
249 #define ACB_DOMTRUST   0x0040  /* 1 = Interdomain trust account */
250 #define ACB_WSTRUST    0x0080  /* 1 = Workstation trust account */
251 #define ACB_SVRTRUST   0x0100  /* 1 = Server trust account */
252 #define ACB_PWNOEXP    0x0200  /* 1 = User password does not expire */
253 #define ACB_AUTOLOCK   0x0400  /* 1 = Account auto locked */
254  
255 #define MAX_HOURS_LEN 32
256
257 typedef struct
258 {
259         uint32 pid;
260         uint16 vuid;
261
262 }
263 vuser_key;
264
265
266 struct use_info
267 {
268         BOOL connected;
269         char *srv_name;
270         vuser_key key;
271         char *user_name;
272         char *domain;
273 };
274
275 #ifndef MAXSUBAUTHS
276 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
277 #endif
278
279 #ifndef _DOM_SID
280 /* DOM_SID - security id */
281 typedef struct sid_info
282 {
283   uint8  sid_rev_num;             /* SID revision number */
284   uint8  num_auths;               /* number of sub-authorities */
285   uint8  id_auth[6];              /* Identifier Authority */
286   /*
287    * Note that the values in these uint32's are in *native* byteorder,
288    * not neccessarily little-endian...... JRA.
289    */
290   uint32 sub_auths[MAXSUBAUTHS];  /* pointer to sub-authorities. */
291
292 } DOM_SID;
293 #define _DOM_SID
294 #endif
295
296 /*
297  * The complete list of SIDS belonging to this user.
298  * Created when a vuid is registered.
299  * The definition of the user_sids array is as follows :
300  *
301  * token->user_sids[0] = primary user SID.
302  * token->user_sids[1] = primary group SID.
303  * token->user_sids[2-num_sids] = supplementary group SIDS.
304  */
305
306 #define PRIMARY_USER_SID_INDEX 0
307 #define PRIMARY_GROUP_SID_INDEX 1
308
309 #ifndef _NT_USER_TOKEN
310 typedef struct _nt_user_token {
311         size_t num_sids;
312         DOM_SID *user_sids;
313 } NT_USER_TOKEN;
314 #define _NT_USER_TOKEN
315 #endif
316
317 /*** query a local group, get a list of these: shows who is in that group ***/
318
319 /* local group member info */
320 typedef struct local_grp_member_info
321 {
322         DOM_SID sid    ; /* matches with name */
323         uint8   sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
324         fstring name   ; /* matches with sid: must be of the form "DOMAIN\account" */
325
326 } LOCAL_GRP_MEMBER;
327
328 /* enumerate these to get list of local groups */
329
330 /* local group info */
331 typedef struct local_grp_info
332 {
333         fstring name;
334         fstring comment;
335
336 } LOCAL_GRP;
337
338 /*** enumerate these to get list of domain groups ***/
339
340 /* domain group member info */
341 typedef struct domain_grp_info
342 {
343         fstring name;
344         fstring comment;
345         uint32  rid; /* group rid */
346         uint8   attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
347
348 } DOMAIN_GRP;
349
350 /*** query a domain group, get a list of these: shows who is in that group ***/
351
352 /* domain group info */
353 typedef struct domain_grp_member_info
354 {
355         fstring name;
356         uint8   attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
357
358 } DOMAIN_GRP_MEMBER;
359
360 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
361 typedef struct time_info
362 {
363   uint32 time;
364 } UTIME;
365
366 /* Structure used when SMBwritebmpx is active */
367 typedef struct
368 {
369   size_t wr_total_written; /* So we know when to discard this */
370   int32 wr_timeout;
371   int32 wr_errclass;
372   int32 wr_error; /* Cached errors */
373   BOOL  wr_mode; /* write through mode) */
374   BOOL  wr_discard; /* discard all further data */
375 } write_bmpx_struct;
376
377 typedef struct write_cache
378 {
379     SMB_OFF_T file_size;
380     SMB_OFF_T offset;
381     size_t alloc_size;
382     size_t data_size;
383     char *data;
384 } write_cache;
385
386 typedef struct
387 {
388         smb_ucs2_t *path;
389         smb_ucs2_t *name;
390         smb_ucs2_t *unixname;
391         smb_ucs2_t *dosname;
392         SMB_STRUCT_STAT *statinfo;
393 } smb_filename;
394
395
396 typedef struct files_struct
397 {
398         struct files_struct *next, *prev;
399         int fnum;
400         struct connection_struct *conn;
401         int fd;
402         int print_jobid;
403         SMB_DEV_T dev;
404         SMB_INO_T inode;
405         BOOL delete_on_close;
406         SMB_OFF_T pos;
407         SMB_OFF_T size;
408         mode_t mode;
409         uint16 vuid;
410         write_bmpx_struct *wbmpx_ptr;
411         write_cache *wcp;
412         struct timeval open_time;
413         int share_mode;
414         time_t pending_modtime;
415         int oplock_type;
416         int sent_oplock_break;
417         unsigned long file_id;
418         BOOL can_lock;
419         BOOL can_read;
420         BOOL can_write;
421         BOOL print_file;
422         BOOL modified;
423         BOOL is_directory;
424         BOOL directory_delete_on_close;
425         BOOL stat_open;
426         char *fsp_name;
427 } files_struct;
428
429 /*
430  * Structure used to keep directory state information around.
431  * Used in NT change-notify code.
432  */
433
434 typedef struct
435 {
436   time_t modify_time;
437   time_t status_time;
438 } dir_status_struct;
439
440 struct uid_cache {
441   int entries;
442   uid_t list[UID_CACHE_SIZE];
443 };
444
445 typedef struct
446 {
447   char *name;
448   BOOL is_wild;
449 } name_compare_entry;
450
451 /* Include VFS stuff */
452
453 #include "vfs.h"
454
455 typedef struct connection_struct
456 {
457         struct connection_struct *next, *prev;
458         unsigned cnum; /* an index passed over the wire */
459         int service;
460         BOOL force_user;
461         struct uid_cache uid_cache;
462         void *dirptr;
463         BOOL printer;
464         BOOL ipc;
465         BOOL read_only;
466         BOOL admin_user;
467         char *dirpath;
468         char *connectpath;
469         char *origpath;
470
471         struct vfs_ops vfs_ops;                   /* Filesystem operations */
472         /* Handle on dlopen() call */
473         void *dl_handle;
474
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         char client_address[18]; /* String version of client IP address. */
479
480         uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
481
482         /* following groups stuff added by ih */
483
484         /* This groups info is valid for the user that *opened* the connection */
485         int ngroups;
486         gid_t *groups;
487         NT_USER_TOKEN *nt_user_token;
488         
489         time_t lastused;
490         BOOL used;
491         int num_files_open;
492         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
493         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
494         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */       
495
496 } connection_struct;
497
498 struct current_user
499 {
500         connection_struct *conn;
501         uint16 vuid;
502         uid_t uid;
503         gid_t gid;
504         int ngroups;
505         gid_t *groups;
506         NT_USER_TOKEN *nt_user_token;
507 };
508
509 /* Defines for the sent_oplock_break field above. */
510 #define NO_BREAK_SENT 0
511 #define EXCLUSIVE_BREAK_SENT 1
512 #define LEVEL_II_BREAK_SENT 2
513
514 typedef struct {
515         fstring smb_name; /* user name from the client */
516         fstring unix_name; /* unix user name of a validated user */
517         fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
518         fstring domain; /* domain that the client specified */
519 } userdom_struct;
520
521 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
522
523 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
524       LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
525
526 typedef struct _print_queue_struct
527 {
528   int job;
529   int size;
530   int status;
531   int priority;
532   time_t time;
533   fstring user;
534   fstring file;
535 } print_queue_struct;
536
537 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
538
539 typedef struct
540 {
541   fstring message;
542   int qcount;
543   int status;
544 }  print_status_struct;
545
546 /* used for server information: client, nameserv and ipc */
547 struct server_info_struct
548 {
549   fstring name;
550   uint32 type;
551   fstring comment;
552   fstring domain; /* used ONLY in ipc.c NOT namework.c */
553   BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
554 };
555
556
557 /* used for network interfaces */
558 struct interface
559 {
560         struct interface *next, *prev;
561         struct in_addr ip;
562         struct in_addr bcast;
563         struct in_addr nmask;
564 };
565
566 /* struct returned by get_share_modes */
567 typedef struct {
568         pid_t pid;
569         uint16 op_port;
570         uint16 op_type;
571         int share_mode;
572         struct timeval time;
573         SMB_DEV_T dev;
574         SMB_INO_T inode;
575         unsigned long share_file_id;
576 } share_mode_entry;
577
578
579 #define SHAREMODE_FN_CAST() \
580         void (*)(share_mode_entry *, char*)
581
582 #define SHAREMODE_FN(fn) \
583         void (*fn)(share_mode_entry *, char*)
584
585 typedef struct sam_passwd
586 {
587         time_t logon_time;            /* logon time */
588         time_t logoff_time;           /* logoff time */
589         time_t kickoff_time;          /* kickoff time */
590         time_t pass_last_set_time;    /* password last set time */
591         time_t pass_can_change_time;  /* password can change time */
592         time_t pass_must_change_time; /* password must change time */
593
594         pstring username;     /* UNIX username string */
595         pstring domain;       /* Windows Domain name */
596         pstring nt_username;  /* Windows username string */
597         pstring full_name;    /* user's full name string */
598         pstring home_dir;     /* home directory string */
599         pstring dir_drive;    /* home directory drive string */
600         pstring logon_script; /* logon script string */
601         pstring profile_path; /* profile path string */
602         pstring acct_desc  ;  /* user description string */
603         pstring workstations; /* login from workstations string */
604         pstring unknown_str ; /* don't know what this is, yet. */
605         pstring munged_dial ; /* munged path name and dial-back tel number */
606
607         uid_t *uid;          /* this is a pointer to the unix uid_t */
608         gid_t *gid;          /* this is a pointer to the unix gid_t */
609         uint32 user_rid;    /* Primary User ID */
610         uint32 group_rid;   /* Primary Group ID */
611
612         unsigned char *lm_pw; /* Null if no password */
613         unsigned char *nt_pw; /* Null if no password */
614
615         uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
616         uint32 unknown_3; /* 0x00ff ffff */
617
618         uint16 logon_divs; /* 168 - number of hours in a week */
619         uint32 hours_len; /* normally 21 bytes */
620         uint8 hours[MAX_HOURS_LEN];
621
622         uint32 unknown_5; /* 0x0002 0000 */
623         uint32 unknown_6; /* 0x0000 04ec */
624         
625 } SAM_ACCOUNT;
626
627 /*
628  * Flags for local user manipulation.
629  */
630
631 #define LOCAL_ADD_USER 0x1
632 #define LOCAL_DELETE_USER 0x2
633 #define LOCAL_DISABLE_USER 0x4
634 #define LOCAL_ENABLE_USER 0x8
635 #define LOCAL_TRUST_ACCOUNT 0x10
636 #define LOCAL_SET_NO_PASSWORD 0x20
637 #define LOCAL_SET_PASSWORD 0x40
638
639 /* key and data in the connections database - used in smbstatus and smbd */
640 struct connections_key {
641         pid_t pid;
642         int cnum;
643         fstring name;
644 };
645
646 struct connections_data {
647         int magic;
648         pid_t pid;
649         int cnum;
650         uid_t uid;
651         gid_t gid;
652         char name[24];
653         char addr[24];
654         char machine[FSTRING_LEN];
655         time_t start;
656 };
657
658
659 /* key and data records in the tdb locking database */
660 struct locking_key {
661         SMB_DEV_T dev;
662         SMB_INO_T inode;
663 };
664
665 struct locking_data {
666         union {
667                 int num_share_mode_entries;
668                 share_mode_entry dummy; /* Needed for alignment. */
669         } u;
670         /* the following two entries are implicit 
671            share_mode_entry modes[num_share_mode_entries];
672            char file_name[];
673         */
674 };
675
676
677 /* the following are used by loadparm for option lists */
678 typedef enum
679 {
680   P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
681   P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
682 } parm_type;
683
684 typedef enum
685 {
686   P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
687 } parm_class;
688
689 /* passed to br lock code */
690 enum brl_type {READ_LOCK, WRITE_LOCK};
691
692 struct enum_list {
693         int value;
694         char *name;
695 };
696
697 #define BRLOCK_FN_CAST() \
698         void (*)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
699                                  enum brl_type lock_type, \
700                                  br_off start, br_off size)
701 #define BRLOCK_FN(fn) \
702         void (*fn)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
703                                  enum brl_type lock_type, \
704                                  br_off start, br_off size)
705 struct parm_struct
706 {
707         char *label;
708         parm_type type;
709         parm_class class;
710         void *ptr;
711         BOOL (*special)(char *, char **);
712         struct enum_list *enum_list;
713         unsigned flags;
714         union {
715                 BOOL bvalue;
716                 int ivalue;
717                 char *svalue;
718                 char cvalue;
719                 char **lvalue;
720         } def;
721 };
722
723 struct bitmap {
724         uint32 *b;
725         int n;
726 };
727
728 #define FLAG_BASIC      0x01 /* fundamental options */
729 #define FLAG_SHARE      0x02 /* file sharing options */
730 #define FLAG_PRINT      0x04 /* printing options */
731 #define FLAG_GLOBAL     0x08 /* local options that should be globally settable in SWAT */
732 #define FLAG_DEPRECATED 0x10 /* options that should no longer be used */
733 #define FLAG_HIDE       0x20 /* options that should be hidden in SWAT */
734
735 #ifndef LOCKING_VERSION
736 #define LOCKING_VERSION 4
737 #endif /* LOCKING_VERSION */
738
739
740 /* the basic packet size, assuming no words or bytes */
741 #define smb_size 39
742
743 /* offsets into message for common items */
744 #define smb_com 8
745 #define smb_rcls 9
746 #define smb_reh 10
747 #define smb_err 11
748 #define smb_flg 13
749 #define smb_flg2 14
750 #define smb_reb 13
751 #define smb_tid 28
752 #define smb_pid 30
753 #define smb_uid 32
754 #define smb_mid 34
755 #define smb_wct 36
756 #define smb_vwv 37
757 #define smb_vwv0 37
758 #define smb_vwv1 39
759 #define smb_vwv2 41
760 #define smb_vwv3 43
761 #define smb_vwv4 45
762 #define smb_vwv5 47
763 #define smb_vwv6 49
764 #define smb_vwv7 51
765 #define smb_vwv8 53
766 #define smb_vwv9 55
767 #define smb_vwv10 57
768 #define smb_vwv11 59
769 #define smb_vwv12 61
770 #define smb_vwv13 63
771 #define smb_vwv14 65
772 #define smb_vwv15 67
773 #define smb_vwv16 69
774 #define smb_vwv17 71
775
776 /* flag defines. CIFS spec 3.1.1 */
777 #define FLAG_SUPPORT_LOCKREAD       0x01
778 #define FLAG_CLIENT_BUF_AVAIL       0x02
779 #define FLAG_RESERVED               0x04
780 #define FLAG_CASELESS_PATHNAMES     0x08
781 #define FLAG_CANONICAL_PATHNAMES    0x10
782 #define FLAG_REQUEST_OPLOCK         0x20
783 #define FLAG_REQUEST_BATCH_OPLOCK   0x40
784 #define FLAG_REPLY                  0x80
785
786 /* the complete */
787 #define SMBmkdir      0x00   /* create directory */
788 #define SMBrmdir      0x01   /* delete directory */
789 #define SMBopen       0x02   /* open file */
790 #define SMBcreate     0x03   /* create file */
791 #define SMBclose      0x04   /* close file */
792 #define SMBflush      0x05   /* flush file */
793 #define SMBunlink     0x06   /* delete file */
794 #define SMBmv         0x07   /* rename file */
795 #define SMBgetatr     0x08   /* get file attributes */
796 #define SMBsetatr     0x09   /* set file attributes */
797 #define SMBread       0x0A   /* read from file */
798 #define SMBwrite      0x0B   /* write to file */
799 #define SMBlock       0x0C   /* lock byte range */
800 #define SMBunlock     0x0D   /* unlock byte range */
801 #define SMBctemp      0x0E   /* create temporary file */
802 #define SMBmknew      0x0F   /* make new file */
803 #define SMBchkpth     0x10   /* check directory path */
804 #define SMBexit       0x11   /* process exit */
805 #define SMBlseek      0x12   /* seek */
806 #define SMBtcon       0x70   /* tree connect */
807 #define SMBtconX      0x75   /* tree connect and X*/
808 #define SMBtdis       0x71   /* tree disconnect */
809 #define SMBnegprot    0x72   /* negotiate protocol */
810 #define SMBdskattr    0x80   /* get disk attributes */
811 #define SMBsearch     0x81   /* search directory */
812 #define SMBsplopen    0xC0   /* open print spool file */
813 #define SMBsplwr      0xC1   /* write to print spool file */
814 #define SMBsplclose   0xC2   /* close print spool file */
815 #define SMBsplretq    0xC3   /* return print queue */
816 #define SMBsends      0xD0   /* send single block message */
817 #define SMBsendb      0xD1   /* send broadcast message */
818 #define SMBfwdname    0xD2   /* forward user name */
819 #define SMBcancelf    0xD3   /* cancel forward */
820 #define SMBgetmac     0xD4   /* get machine name */
821 #define SMBsendstrt   0xD5   /* send start of multi-block message */
822 #define SMBsendend    0xD6   /* send end of multi-block message */
823 #define SMBsendtxt    0xD7   /* send text of multi-block message */
824
825 /* Core+ protocol */
826 #define SMBlockread       0x13   /* Lock a range and read */
827 #define SMBwriteunlock 0x14 /* Unlock a range then write */
828 #define SMBreadbraw   0x1a  /* read a block of data with no smb header */
829 #define SMBwritebraw  0x1d  /* write a block of data with no smb header */
830 #define SMBwritec     0x20  /* secondary write request */
831 #define SMBwriteclose 0x2c  /* write a file then close it */
832
833 /* dos extended protocol */
834 #define SMBreadBraw      0x1A   /* read block raw */
835 #define SMBreadBmpx      0x1B   /* read block multiplexed */
836 #define SMBreadBs        0x1C   /* read block (secondary response) */
837 #define SMBwriteBraw     0x1D   /* write block raw */
838 #define SMBwriteBmpx     0x1E   /* write block multiplexed */
839 #define SMBwriteBs       0x1F   /* write block (secondary request) */
840 #define SMBwriteC        0x20   /* write complete response */
841 #define SMBsetattrE      0x22   /* set file attributes expanded */
842 #define SMBgetattrE      0x23   /* get file attributes expanded */
843 #define SMBlockingX      0x24   /* lock/unlock byte ranges and X */
844 #define SMBtrans         0x25   /* transaction - name, bytes in/out */
845 #define SMBtranss        0x26   /* transaction (secondary request/response) */
846 #define SMBioctl         0x27   /* IOCTL */
847 #define SMBioctls        0x28   /* IOCTL  (secondary request/response) */
848 #define SMBcopy          0x29   /* copy */
849 #define SMBmove          0x2A   /* move */
850 #define SMBecho          0x2B   /* echo */
851 #define SMBopenX         0x2D   /* open and X */
852 #define SMBreadX         0x2E   /* read and X */
853 #define SMBwriteX        0x2F   /* write and X */
854 #define SMBsesssetupX    0x73   /* Session Set Up & X (including User Logon) */
855 #define SMBffirst        0x82   /* find first */
856 #define SMBfunique       0x83   /* find unique */
857 #define SMBfclose        0x84   /* find close */
858 #define SMBkeepalive     0x85   /* keepalive */
859 #define SMBinvalid       0xFE   /* invalid command */
860
861 /* Extended 2.0 protocol */
862 #define SMBtrans2        0x32   /* TRANS2 protocol set */
863 #define SMBtranss2       0x33   /* TRANS2 protocol set, secondary command */
864 #define SMBfindclose     0x34   /* Terminate a TRANSACT2_FINDFIRST */
865 #define SMBfindnclose    0x35   /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
866 #define SMBulogoffX      0x74   /* user logoff */
867
868 /* NT SMB extensions. */
869 #define SMBnttrans       0xA0   /* NT transact */
870 #define SMBnttranss      0xA1   /* NT transact secondary */
871 #define SMBntcreateX     0xA2   /* NT create and X */
872 #define SMBntcancel      0xA4   /* NT cancel */
873
874 /* These are the TRANS2 sub commands */
875 #define TRANSACT2_OPEN                        0
876 #define TRANSACT2_FINDFIRST                   1
877 #define TRANSACT2_FINDNEXT                    2
878 #define TRANSACT2_QFSINFO                     3
879 #define TRANSACT2_SETFSINFO                   4
880 #define TRANSACT2_QPATHINFO                   5
881 #define TRANSACT2_SETPATHINFO                 6
882 #define TRANSACT2_QFILEINFO                   7
883 #define TRANSACT2_SETFILEINFO                 8
884 #define TRANSACT2_FSCTL                       9
885 #define TRANSACT2_IOCTL                     0xA
886 #define TRANSACT2_FINDNOTIFYFIRST           0xB
887 #define TRANSACT2_FINDNOTIFYNEXT            0xC
888 #define TRANSACT2_MKDIR                     0xD
889 #define TRANSACT2_SESSION_SETUP             0xE
890 #define TRANSACT2_GET_DFS_REFERRAL         0x10
891 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
892
893 /* These are the NT transact sub commands. */
894 #define NT_TRANSACT_CREATE                1
895 #define NT_TRANSACT_IOCTL                 2
896 #define NT_TRANSACT_SET_SECURITY_DESC     3
897 #define NT_TRANSACT_NOTIFY_CHANGE         4
898 #define NT_TRANSACT_RENAME                5
899 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
900
901 /* Relevant IOCTL codes */
902 #define IOCTL_QUERY_JOB_INFO      0x530060
903
904 /* these are the trans2 sub fields for primary requests */
905 #define smb_tpscnt smb_vwv0
906 #define smb_tdscnt smb_vwv1
907 #define smb_mprcnt smb_vwv2
908 #define smb_mdrcnt smb_vwv3
909 #define smb_msrcnt smb_vwv4
910 #define smb_flags smb_vwv5
911 #define smb_timeout smb_vwv6
912 #define smb_pscnt smb_vwv9
913 #define smb_psoff smb_vwv10
914 #define smb_dscnt smb_vwv11
915 #define smb_dsoff smb_vwv12
916 #define smb_suwcnt smb_vwv13
917 #define smb_setup smb_vwv14
918 #define smb_setup0 smb_setup
919 #define smb_setup1 (smb_setup+2)
920 #define smb_setup2 (smb_setup+4)
921
922 /* these are for the secondary requests */
923 #define smb_spscnt smb_vwv2
924 #define smb_spsoff smb_vwv3
925 #define smb_spsdisp smb_vwv4
926 #define smb_sdscnt smb_vwv5
927 #define smb_sdsoff smb_vwv6
928 #define smb_sdsdisp smb_vwv7
929 #define smb_sfid smb_vwv8
930
931 /* and these for responses */
932 #define smb_tprcnt smb_vwv0
933 #define smb_tdrcnt smb_vwv1
934 #define smb_prcnt smb_vwv3
935 #define smb_proff smb_vwv4
936 #define smb_prdisp smb_vwv5
937 #define smb_drcnt smb_vwv6
938 #define smb_droff smb_vwv7
939 #define smb_drdisp smb_vwv8
940
941 /* these are for the NT trans primary request. */
942 #define smb_nt_MaxSetupCount smb_vwv0
943 #define smb_nt_Flags (smb_vwv0 + 1)
944 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
945 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
946 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
947 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
948 #define smb_nt_ParameterCount (smb_vwv0 + 19)
949 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
950 #define smb_nt_DataCount (smb_vwv0 + 27)
951 #define smb_nt_DataOffset (smb_vwv0 + 31)
952 #define smb_nt_SetupCount (smb_vwv0 + 35)
953 #define smb_nt_Function (smb_vwv0 + 36)
954 #define smb_nt_SetupStart (smb_vwv0 + 38)
955
956 /* these are for the NT trans secondary request. */
957 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
958 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
959 #define smb_nts_ParameterCount (smb_vwv0 + 11)
960 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
961 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
962 #define smb_nts_DataCount (smb_vwv0 + 23)
963 #define smb_nts_DataOffset (smb_vwv0 + 27)
964 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
965
966 /* these are for the NT trans reply. */
967 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
968 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
969 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
970 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
971 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
972 #define smb_ntr_DataCount (smb_vwv0 + 23)
973 #define smb_ntr_DataOffset (smb_vwv0 + 27)
974 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
975
976 /* these are for the NT create_and_X */
977 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
978 #define smb_ntcreate_Flags (smb_vwv0 + 7)
979 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
980 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
981 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
982 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
983 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
984 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
985 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
986 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
987 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
988
989 /* this is used on a TConX. I'm not sure the name is very helpful though */
990 #define SMB_SUPPORT_SEARCH_BITS        0x0001
991 #define SMB_SHARE_IN_DFS               0x0002
992
993 /* Named pipe write mode flags. Used in writeX calls. */
994 #define PIPE_RAW_MODE 0x4
995 #define PIPE_START_MESSAGE 0x8
996
997 /* these are the constants used in the above call. */
998 /* DesiredAccess */
999 /* File Specific access rights. */
1000 #define FILE_READ_DATA        0x001
1001 #define FILE_WRITE_DATA       0x002
1002 #define FILE_APPEND_DATA      0x004
1003 #define FILE_READ_EA          0x008
1004 #define FILE_WRITE_EA         0x010
1005 #define FILE_EXECUTE          0x020
1006 #define FILE_DELETE_CHILD     0x040
1007 #define FILE_READ_ATTRIBUTES  0x080
1008 #define FILE_WRITE_ATTRIBUTES 0x100
1009
1010 #define FILE_ALL_ACCESS       0x1FF
1011
1012 /* the desired access to use when opening a pipe */
1013 #define DESIRED_ACCESS_PIPE 0x2019f
1014  
1015 /* Generic access masks & rights. */
1016 #define SPECIFIC_RIGHTS_MASK 0x00FFFFL
1017 #define STANDARD_RIGHTS_MASK 0xFF0000L
1018 #define DELETE_ACCESS        (1L<<16)
1019 #define READ_CONTROL_ACCESS  (1L<<17)
1020 #define WRITE_DAC_ACCESS     (1L<<18)
1021 #define WRITE_OWNER_ACCESS   (1L<<19)
1022 #define SYNCHRONIZE_ACCESS   (1L<<20)
1023
1024 /* Combinations of standard masks. */
1025 #define STANDARD_RIGHTS_ALL_ACCESS (DELETE_ACCESS|READ_CONTROL_ACCESS|WRITE_DAC_ACCESS|WRITE_OWNER_ACCESS|SYNCHRONIZE_ACCESS)
1026 #define STANDARD_RIGHTS_EXECUTE_ACCESS (READ_CONTROL_ACCESS)
1027 #define STANDARD_RIGHTS_READ_ACCESS (READ_CONTROL_ACCESS)
1028 #define STANDARD_RIGHTS_REQUIRED_ACCESS (DELETE_ACCESS|READ_CONTROL_ACCESS|WRITE_DAC_ACCESS|WRITE_OWNER_ACCESS)
1029 #define STANDARD_RIGHTS_WRITE_ACCESS (READ_CONTROL_ACCESS)
1030
1031 #define SYSTEM_SECURITY_ACCESS (1L<<24)
1032 #define MAXIMUM_ALLOWED_ACCESS (1L<<25)
1033 #define GENERIC_ALL_ACCESS   (1<<28)
1034 #define GENERIC_EXECUTE_ACCESS  (1<<29)
1035 #define GENERIC_WRITE_ACCESS   (1<<30)
1036 #define GENERIC_READ_ACCESS   (((unsigned)1)<<31)
1037
1038 /* Mapping of generic access rights for files to specific rights. */
1039
1040 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1041
1042 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1043                                                         FILE_READ_EA|SYNCHRONIZE_ACCESS)
1044
1045 #define FILE_GENERIC_WRITE (STANDARD_RIGHTS_WRITE_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1046                                                         FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1047
1048 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
1049                                                                 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1050
1051 /* Mapping of access rights to UNIX perms. */
1052 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
1053 #define UNIX_ACCESS_R           FILE_GENERIC_READ
1054 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
1055 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
1056
1057 #if 0
1058 /*
1059  * This is the old mapping we used to use. To get W2KSP2 profiles
1060  * working we need to map to the canonical file perms.
1061  */
1062 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1063 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1064                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1065 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1066                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1067                         FILE_APPEND_DATA|FILE_WRITE_DATA)
1068 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1069                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1070 #endif
1071
1072 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1073
1074 /* Flags field. */
1075 #define REQUEST_OPLOCK 2
1076 #define REQUEST_BATCH_OPLOCK 4
1077 #define OPEN_DIRECTORY 8
1078
1079 /* ShareAccess field. */
1080 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1081 #define FILE_SHARE_READ 1
1082 #define FILE_SHARE_WRITE 2
1083 #define FILE_SHARE_DELETE 4
1084
1085 /* FileAttributesField */
1086 #define FILE_ATTRIBUTE_READONLY aRONLY
1087 #define FILE_ATTRIBUTE_HIDDEN aHIDDEN
1088 #define FILE_ATTRIBUTE_SYSTEM aSYSTEM
1089 #define FILE_ATTRIBUTE_DIRECTORY aDIR
1090 #define FILE_ATTRIBUTE_ARCHIVE aARCH
1091 #define FILE_ATTRIBUTE_NORMAL 0x80L
1092 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1093 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1094 #define SAMBA_ATTRIBUTES_MASK 0x7F
1095
1096 /* Flags - combined with attributes. */
1097 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
1098 #define FILE_FLAG_NO_BUFFERING     0x20000000L
1099 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
1100 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
1101 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
1102 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1103 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
1104
1105 /* CreateDisposition field. */
1106 #define FILE_SUPERSEDE 0
1107 #define FILE_OPEN 1
1108 #define FILE_CREATE 2
1109 #define FILE_OPEN_IF 3
1110 #define FILE_OVERWRITE 4
1111 #define FILE_OVERWRITE_IF 5
1112
1113 /* CreateOptions field. */
1114 #define FILE_DIRECTORY_FILE       0x0001
1115 #define FILE_WRITE_THROUGH        0x0002
1116 #define FILE_SEQUENTIAL_ONLY      0x0004
1117 #define FILE_NON_DIRECTORY_FILE   0x0040
1118 #define FILE_NO_EA_KNOWLEDGE      0x0200
1119 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1120 #define FILE_RANDOM_ACCESS        0x0800
1121 #define FILE_DELETE_ON_CLOSE      0x1000
1122
1123 /* Responses when opening a file. */
1124 #define FILE_WAS_OPENED 1
1125 #define FILE_WAS_CREATED 2
1126 #define FILE_WAS_OVERWRITTEN 3
1127
1128 /* File type flags */
1129 #define FILE_TYPE_DISK  0
1130 #define FILE_TYPE_BYTE_MODE_PIPE 1
1131 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1132 #define FILE_TYPE_PRINTER 3
1133 #define FILE_TYPE_COMM_DEVICE 4
1134 #define FILE_TYPE_UNKNOWN 0xFFFF
1135
1136 /* Flag for NT transact rename call. */
1137 #define RENAME_REPLACE_IF_EXISTS 1
1138
1139 /* Filesystem Attributes. */
1140 #define FILE_CASE_SENSITIVE_SEARCH 0x01
1141 #define FILE_CASE_PRESERVED_NAMES 0x02
1142 #define FILE_UNICODE_ON_DISK 0x04
1143 /* According to cifs9f, this is 4, not 8 */
1144 /* Acconding to testing, this actually sets the security attribute! */
1145 #define FILE_PERSISTENT_ACLS 0x08
1146 /* These entries added from cifs9f --tsb */
1147 #define FILE_FILE_COMPRESSION 0x08
1148 #define FILE_VOLUME_QUOTAS 0x10
1149 #define FILE_DEVICE_IS_MOUNTED 0x20
1150 #define FILE_VOLUME_IS_COMPRESSED 0x8000
1151
1152 /* ChangeNotify flags. */
1153 #define FILE_NOTIFY_CHANGE_FILE        0x001
1154 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
1155 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
1156 #define FILE_NOTIFY_CHANGE_SIZE        0x008
1157 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
1158 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1159 #define FILE_NOTIFY_CHANGE_CREATION    0x040
1160 #define FILE_NOTIFY_CHANGE_EA          0x080
1161 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
1162 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x200
1163
1164 /* where to find the base of the SMB packet proper */
1165 #define smb_base(buf) (((char *)(buf))+4)
1166
1167 /* we don't allow server strings to be longer than 48 characters as
1168    otherwise NT will not honour the announce packets */
1169 #define MAX_SERVER_STRING_LENGTH 48
1170
1171
1172 #define SMB_SUCCESS 0  /* The request was successful. */
1173
1174 #ifdef WITH_DFS
1175 void dfs_unlogin(void);
1176 extern int dcelogin_atmost_once;
1177 #endif
1178
1179 #ifdef NOSTRDUP
1180 char *strdup(char *s);
1181 #endif
1182
1183 #ifndef SIGNAL_CAST
1184 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1185 #endif
1186
1187 #ifndef SELECT_CAST
1188 #define SELECT_CAST
1189 #endif
1190
1191 /* these are used in NetServerEnum to choose what to receive */
1192 #define SV_TYPE_WORKSTATION         0x00000001
1193 #define SV_TYPE_SERVER              0x00000002
1194 #define SV_TYPE_SQLSERVER           0x00000004
1195 #define SV_TYPE_DOMAIN_CTRL         0x00000008
1196 #define SV_TYPE_DOMAIN_BAKCTRL      0x00000010
1197 #define SV_TYPE_TIME_SOURCE         0x00000020
1198 #define SV_TYPE_AFP                 0x00000040
1199 #define SV_TYPE_NOVELL              0x00000080
1200 #define SV_TYPE_DOMAIN_MEMBER       0x00000100
1201 #define SV_TYPE_PRINTQ_SERVER       0x00000200
1202 #define SV_TYPE_DIALIN_SERVER       0x00000400
1203 #define SV_TYPE_SERVER_UNIX         0x00000800
1204 #define SV_TYPE_NT                  0x00001000
1205 #define SV_TYPE_WFW                 0x00002000
1206 #define SV_TYPE_SERVER_MFPN         0x00004000
1207 #define SV_TYPE_SERVER_NT           0x00008000
1208 #define SV_TYPE_POTENTIAL_BROWSER   0x00010000
1209 #define SV_TYPE_BACKUP_BROWSER      0x00020000
1210 #define SV_TYPE_MASTER_BROWSER      0x00040000
1211 #define SV_TYPE_DOMAIN_MASTER       0x00080000
1212 #define SV_TYPE_SERVER_OSF          0x00100000
1213 #define SV_TYPE_SERVER_VMS          0x00200000
1214 #define SV_TYPE_WIN95_PLUS          0x00400000
1215 #define SV_TYPE_DFS_SERVER          0x00800000
1216 #define SV_TYPE_ALTERNATE_XPORT     0x20000000  
1217 #define SV_TYPE_LOCAL_LIST_ONLY     0x40000000  
1218 #define SV_TYPE_DOMAIN_ENUM         0x80000000
1219 #define SV_TYPE_ALL                 0xFFFFFFFF  
1220
1221 /* This was set by JHT in liaison with Jeremy Allison early 1997
1222  * History:
1223  * Version 4.0 - never made public
1224  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1225  *              - Reappeared in 1.9.16p11 with fixed smbd services
1226  * Version 4.20 - To indicate that nmbd and browsing now works better
1227  * Version 4.50 - Set at release of samba-2.2.0 by JHT
1228  *
1229  *  Note: In the presence of NT4.X do not set above 4.9
1230  *        Setting this above 4.9 can have undesired side-effects.
1231  *        This may change again in Samba-3.0 after further testing. JHT
1232  */
1233  
1234 #define DEFAULT_MAJOR_VERSION 0x04
1235 #define DEFAULT_MINOR_VERSION 0x05
1236
1237 /* Browser Election Values */
1238 #define BROWSER_ELECTION_VERSION        0x010f
1239 #define BROWSER_CONSTANT        0xaa55
1240
1241 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1242    
1243 #define FLAGS2_LONG_PATH_COMPONENTS   0x0001
1244 #define FLAGS2_EXTENDED_ATTRIBUTES    0x0002
1245 #define FLAGS2_EXTENDED_SECURITY      0x0800 
1246 #define FLAGS2_DFS_PATHNAMES          0x1000
1247 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1248 #define FLAGS2_32_BIT_ERROR_CODES     0x4000 
1249 #define FLAGS2_UNICODE_STRINGS        0x8000
1250
1251 #define FLAGS2_WIN2K_SIGNATURE        0xC852 /* Hack alert ! For now... JRA. */
1252
1253 /* Capabilities.  see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1254
1255 #define CAP_RAW_MODE         0x0001
1256 #define CAP_MPX_MODE         0x0002
1257 #define CAP_UNICODE          0x0004
1258 #define CAP_LARGE_FILES      0x0008
1259 #define CAP_NT_SMBS          0x0010
1260 #define CAP_RPC_REMOTE_APIS  0x0020
1261 #define CAP_STATUS32         0x0040
1262 #define CAP_LEVEL_II_OPLOCKS 0x0080
1263 #define CAP_LOCK_AND_READ    0x0100
1264 #define CAP_NT_FIND          0x0200
1265 #define CAP_DFS              0x1000
1266 #define CAP_W2K_SMBS         0x2000
1267 #define CAP_LARGE_READX      0x4000
1268 #define CAP_LARGE_WRITEX     0x8000
1269 #define CAP_EXTENDED_SECURITY 0x80000000
1270
1271 /* protocol types. It assumes that higher protocols include lower protocols
1272    as subsets */
1273 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1274
1275 /* security levels */
1276 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN};
1277
1278 /* server roles */
1279 enum server_types
1280 {
1281         ROLE_STANDALONE,
1282         ROLE_DOMAIN_MEMBER,
1283         ROLE_DOMAIN_BDC,
1284         ROLE_DOMAIN_PDC
1285 };
1286
1287 /* printing types */
1288 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1289                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1290                      PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2
1291 #ifdef DEVELOPER
1292 ,PRINT_TEST,PRINT_VLP
1293 #endif /* DEVELOPER */
1294 };
1295
1296 /* Remote architectures we know about. */
1297 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_WIN2K, RA_SAMBA};
1298
1299 /* case handling */
1300 enum case_handling {CASE_LOWER,CASE_UPPER};
1301
1302 #ifdef WITH_SSL
1303 /* SSL version options */
1304 enum ssl_version_enum {SMB_SSL_V2,SMB_SSL_V3,SMB_SSL_V23,SMB_SSL_TLS1};
1305 #endif /* WITH_SSL */
1306
1307 /*
1308  * Global value meaing that the smb_uid field should be
1309  * ingored (in share level security and protocol level == CORE)
1310  */
1311
1312 #define UID_FIELD_INVALID 0
1313 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1314
1315 /* Defines needed for multi-codepage support. */
1316 #define MSDOS_LATIN_1_CODEPAGE 850
1317 #define KANJI_CODEPAGE 932
1318 #define HANGUL_CODEPAGE 949
1319 #define BIG5_CODEPAGE 950
1320 #define SIMPLIFIED_CHINESE_CODEPAGE 936
1321
1322 #ifdef KANJI
1323 /* 
1324  * Default client code page - Japanese 
1325  */
1326 #define DEFAULT_CLIENT_CODE_PAGE KANJI_CODEPAGE
1327 #else /* KANJI */
1328 /* 
1329  * Default client code page - 850 - Western European 
1330  */
1331 #define DEFAULT_CLIENT_CODE_PAGE MSDOS_LATIN_1_CODEPAGE
1332 #endif /* KANJI */
1333
1334 /* Global val set if multibyte codepage. */
1335 extern int global_is_multibyte_codepage;
1336
1337 #define get_character_len(x) (global_is_multibyte_codepage ? skip_multibyte_char((x)) : 0)
1338
1339 /* 
1340  * Size of buffer to use when moving files across filesystems. 
1341  */
1342 #define COPYBUF_SIZE (8*1024)
1343
1344 /* 
1345  * Integers used to override error codes. 
1346  */
1347 extern int unix_ERR_class;
1348 extern int unix_ERR_code;
1349
1350 /*
1351  * Used in chaining code.
1352  */
1353 extern int chain_size;
1354
1355 /*
1356  * Map the Core and Extended Oplock requesst bits down
1357  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1358  */
1359
1360 /*
1361  * Core protocol.
1362  */
1363 #define CORE_OPLOCK_REQUEST(inbuf) \
1364     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1365
1366 /*
1367  * Extended protocol.
1368  */
1369 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1370
1371 /* Lock types. */
1372 #define LOCKING_ANDX_SHARED_LOCK 0x1
1373 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1374 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1375 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1376 #define LOCKING_ANDX_LARGE_FILES 0x10
1377
1378 /* Oplock levels */
1379 #define OPLOCKLEVEL_NONE 0
1380 #define OPLOCKLEVEL_II 1
1381
1382 /*
1383  * Bits we test with.
1384  */
1385
1386 #define NO_OPLOCK 0
1387 #define EXCLUSIVE_OPLOCK 1
1388 #define BATCH_OPLOCK 2
1389 #define LEVEL_II_OPLOCK 4
1390
1391 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1392 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1393 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1394
1395 #define CORE_OPLOCK_GRANTED (1<<5)
1396 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1397
1398 /*
1399  * Return values for oplock types.
1400  */
1401
1402 #define NO_OPLOCK_RETURN 0
1403 #define EXCLUSIVE_OPLOCK_RETURN 1
1404 #define BATCH_OPLOCK_RETURN 2
1405 #define LEVEL_II_OPLOCK_RETURN 3
1406
1407 /*
1408  * Loopback command offsets.
1409  */
1410
1411 #define OPBRK_CMD_LEN_OFFSET 0
1412 #define OPBRK_CMD_PORT_OFFSET 4
1413 #define OPBRK_CMD_HEADER_LEN 6
1414
1415 #define OPBRK_MESSAGE_CMD_OFFSET 0
1416
1417 /*
1418  * Oplock break command code to send over the udp socket.
1419  * The same message is sent for both exlusive and level II breaks. 
1420  * 
1421  * The form of this is :
1422  *
1423  *  0     2       2+pid   2+pid+dev 2+pid+dev+ino
1424  *  +----+--------+-------+--------+---------+
1425  *  | cmd| pid    | dev   |  inode | fileid  |
1426  *  +----+--------+-------+--------+---------+
1427  */
1428
1429 #define OPLOCK_BREAK_CMD 0x1
1430 #define OPLOCK_BREAK_PID_OFFSET 2
1431 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1432 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1433 #define OPLOCK_BREAK_FILEID_OFFSET (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1434 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1435
1436 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1437 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1438
1439 /*
1440  * Capabilities abstracted for different systems.
1441  */
1442
1443 #define KERNEL_OPLOCK_CAPABILITY 0x1
1444
1445 /*
1446  * Oplock break command code sent via the kernel interface (if it exists).
1447  *
1448  * Form of this is :
1449  *
1450  *  0     2       2+devsize 2+devsize+inodesize
1451  *  +----+--------+--------+----------+
1452  *  | cmd| dev    |  inode |  fileid  |
1453  *  +----+--------+--------+----------+
1454  */
1455 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1456 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1457 #define KERNEL_OPLOCK_BREAK_FILEID_OFFSET (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1458 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1459
1460
1461 /* if a kernel does support oplocks then a structure of the following
1462    typee is used to describe how to interact with the kernel */
1463 struct kernel_oplocks {
1464         BOOL (*receive_message)(fd_set *fds, char *buffer, int buffer_len);
1465         BOOL (*set_oplock)(files_struct *fsp, int oplock_type);
1466         void (*release_oplock)(files_struct *fsp);
1467         BOOL (*parse_message)(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev, unsigned long *file_id);
1468         BOOL (*msg_waiting)(fd_set *fds);
1469         int notification_fd;
1470 };
1471
1472
1473 #define CMD_REPLY 0x8000
1474
1475 /* this structure defines the functions for doing change notify in
1476    various implementations */
1477 struct cnotify_fns {
1478         void * (*register_notify)(connection_struct *conn, char *path, uint32 flags);
1479         BOOL (*check_notify)(connection_struct *conn, uint16 vuid, char *path, uint32 flags, void *data, time_t t);
1480         void (*remove_notify)(void *data);
1481         int select_time;
1482 };
1483
1484
1485
1486 #include "smb_macros.h"
1487
1488 /* A netbios name structure. */
1489 struct nmb_name {
1490   char         name[17];
1491   char         scope[64];
1492   unsigned int name_type;
1493 };
1494
1495
1496 /* A netbios node status array element. */
1497 struct node_status {
1498         char name[16];
1499         unsigned char type;
1500         unsigned char flags;
1501 };
1502
1503
1504
1505 #define AGENT_CMD_CON       0
1506 #define AGENT_CMD_CON_ANON  2
1507 #define AGENT_CMD_CON_REUSE 1
1508
1509 struct pwd_info
1510 {
1511         BOOL null_pwd;
1512         BOOL cleartext;
1513         BOOL crypted;
1514
1515         fstring password;
1516
1517         uchar smb_lm_pwd[16];
1518         uchar smb_nt_pwd[16];
1519
1520         uchar smb_lm_owf[24];
1521         uchar smb_nt_owf[128];
1522         size_t nt_owf_len;
1523
1524         uchar lm_cli_chal[8];
1525         uchar nt_cli_chal[128];
1526         size_t nt_cli_chal_len;
1527
1528         uchar sess_key[16];
1529 };
1530
1531 /*
1532  * Network Computing Architechture Context Name Named Pipe
1533  * See MSDN docs for more information
1534  */
1535 struct ncacn_np
1536 {
1537         fstring pipe_name;
1538         struct cli_state *smb;
1539         uint16 fnum;
1540         BOOL initialised;
1541 };
1542
1543 #include "rpc_creds.h"
1544 #include "rpc_misc.h"
1545 #include "rpc_secdes.h"
1546 #include "nt_printing.h"
1547
1548 typedef struct user_struct
1549 {
1550         struct user_struct *next, *prev;
1551         uint16 vuid; /* Tag for this entry. */
1552         uid_t uid; /* uid of a validated user */
1553         gid_t gid; /* gid of a validated user */
1554
1555         userdom_struct user;
1556         BOOL guest;
1557
1558         /* following groups stuff added by ih */
1559         /* This groups info is needed for when we become_user() for this uid */
1560         int n_groups;
1561         gid_t *groups;
1562
1563         NT_USER_TOKEN *nt_user_token;
1564
1565         int session_id; /* used by utmp and pam session code */
1566 } user_struct;
1567
1568 /* used to hold an arbitrary blob of data */
1569 typedef struct {
1570         uint8 *data;
1571         size_t length;
1572 } DATA_BLOB;
1573
1574
1575 #include "ntdomain.h"
1576
1577 #include "client.h"
1578
1579 /*
1580  * Size of new password account encoding string.  This is enough space to
1581  * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1582  * Do not change unless you are adding new ACB bits!
1583  */
1584
1585 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1586
1587 /*
1588    Do you want session setups at user level security with a invalid
1589    password to be rejected or allowed in as guest? WinNT rejects them
1590    but it can be a pain as it means "net view" needs to use a password
1591
1592    You have 3 choices in the setting of map_to_guest:
1593
1594    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1595    are rejected. This is the default.
1596
1597    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1598    are rejected, unless the username does not exist, in which case it
1599    is treated as a guest login
1600
1601    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1602    are treated as a guest login
1603
1604    Note that map_to_guest only has an effect in user or server
1605    level security.
1606 */
1607
1608 #define NEVER_MAP_TO_GUEST 0
1609 #define MAP_TO_GUEST_ON_BAD_USER 1
1610 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1611
1612 #define SAFE_NETBIOS_CHARS ". -_"
1613
1614 #include "nsswitch/winbindd_nss.h"
1615 #include "smb_acls.h"
1616
1617 /* generic iconv conversion structure */
1618 typedef struct {
1619         size_t (*direct)(void *cd, char **inbuf, size_t *inbytesleft,
1620                          char **outbuf, size_t *outbytesleft);
1621         size_t (*pull)(void *cd, char **inbuf, size_t *inbytesleft,
1622                        char **outbuf, size_t *outbytesleft);
1623         size_t (*push)(void *cd, char **inbuf, size_t *inbytesleft,
1624                        char **outbuf, size_t *outbytesleft);
1625         void *cd_direct, *cd_pull, *cd_push;
1626 } *smb_iconv_t;
1627
1628 #endif /* _SMB_H */