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