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