835066e26361e996c6196797511d0fac720533de
[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         PRIVILEGE_SET *privs;
504         
505         time_t lastused;
506         BOOL used;
507         int num_files_open;
508         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
509         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
510         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */       
511
512 } connection_struct;
513
514 struct current_user
515 {
516         connection_struct *conn;
517         uint16 vuid;
518         uid_t uid;
519         gid_t gid;
520         int ngroups;
521         gid_t *groups;
522         NT_USER_TOKEN *nt_user_token;
523         PRIVILEGE_SET *privs;
524 };
525
526 /* Defines for the sent_oplock_break field above. */
527 #define NO_BREAK_SENT 0
528 #define EXCLUSIVE_BREAK_SENT 1
529 #define LEVEL_II_BREAK_SENT 2
530
531 typedef struct {
532         fstring smb_name; /* user name from the client */
533         fstring unix_name; /* unix user name of a validated user */
534         fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
535         fstring domain; /* domain that the client specified */
536 } userdom_struct;
537
538 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
539
540 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
541       LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
542
543 typedef struct _print_queue_struct
544 {
545   int job;              /* normally the SMB jobid -- see note in 
546                            printing.c:traverse_fn_delete() */
547   int size;
548   int page_count;
549   int status;
550   int priority;
551   time_t time;
552   fstring fs_user;
553   fstring fs_file;
554 } print_queue_struct;
555
556 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
557
558 typedef struct
559 {
560   fstring message;
561   int qcount;
562   int status;
563 }  print_status_struct;
564
565 /* used for server information: client, nameserv and ipc */
566 struct server_info_struct
567 {
568   fstring name;
569   uint32 type;
570   fstring comment;
571   fstring domain; /* used ONLY in ipc.c NOT namework.c */
572   BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
573 };
574
575
576 /* used for network interfaces */
577 struct interface
578 {
579         struct interface *next, *prev;
580         struct in_addr ip;
581         struct in_addr bcast;
582         struct in_addr nmask;
583 };
584
585 /* struct returned by get_share_modes */
586 typedef struct {
587         pid_t pid;
588         uint16 op_port;
589         uint16 op_type;
590         int share_mode;
591         uint32 desired_access;
592         struct timeval time;
593         SMB_DEV_T dev;
594         SMB_INO_T inode;
595         unsigned long share_file_id;
596 } share_mode_entry;
597
598
599 #define SHAREMODE_FN_CAST() \
600         void (*)(share_mode_entry *, char*)
601
602 #define SHAREMODE_FN(fn) \
603         void (*fn)(share_mode_entry *, char*)
604
605 #define NT_HASH_LEN 16
606 #define LM_HASH_LEN 16
607
608 /*
609  * Flags for account policy.
610  */
611 #define AP_MIN_PASSWORD_LEN             1
612 #define AP_PASSWORD_HISTORY             2
613 #define AP_USER_MUST_LOGON_TO_CHG_PASS  3
614 #define AP_MAX_PASSWORD_AGE             4
615 #define AP_MIN_PASSWORD_AGE             5
616 #define AP_LOCK_ACCOUNT_DURATION        6
617 #define AP_RESET_COUNT_TIME             7
618 #define AP_BAD_ATTEMPT_LOCKOUT          8
619 #define AP_TIME_TO_LOGOUT               9
620
621
622 /*
623  * Flags for local user manipulation.
624  */
625
626 #define LOCAL_ADD_USER 0x1
627 #define LOCAL_DELETE_USER 0x2
628 #define LOCAL_DISABLE_USER 0x4
629 #define LOCAL_ENABLE_USER 0x8
630 #define LOCAL_TRUST_ACCOUNT 0x10
631 #define LOCAL_SET_NO_PASSWORD 0x20
632 #define LOCAL_SET_PASSWORD 0x40
633 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
634 #define LOCAL_INTERDOM_ACCOUNT 0x100
635 #define LOCAL_AM_ROOT 0x200  /* Act as root */
636
637 /* key and data in the connections database - used in smbstatus and smbd */
638 struct connections_key {
639         pid_t pid;
640         int cnum;
641         fstring name;
642 };
643
644 struct connections_data {
645         int magic;
646         pid_t pid;
647         int cnum;
648         uid_t uid;
649         gid_t gid;
650         char name[24];
651         char addr[24];
652         char machine[FSTRING_LEN];
653         time_t start;
654         uint32 bcast_msg_flags;
655 };
656
657
658 /* key and data records in the tdb locking database */
659 struct locking_key {
660         SMB_DEV_T dev;
661         SMB_INO_T inode;
662 };
663
664 struct locking_data {
665         union {
666                 int num_share_mode_entries;
667                 share_mode_entry dummy; /* Needed for alignment. */
668         } u;
669         /* the following two entries are implicit 
670            share_mode_entry modes[num_share_mode_entries];
671            char file_name[];
672         */
673 };
674
675
676 /* the following are used by loadparm for option lists */
677 typedef enum
678 {
679   P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
680   P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
681 } parm_type;
682
683 typedef enum
684 {
685   P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
686 } parm_class;
687
688 /* passed to br lock code */
689 enum brl_type {READ_LOCK, WRITE_LOCK, PENDING_LOCK};
690
691 struct enum_list {
692         int value;
693         const char *name;
694 };
695
696 #define BRLOCK_FN_CAST() \
697         void (*)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
698                                  enum brl_type lock_type, \
699                                  br_off start, br_off size)
700 #define BRLOCK_FN(fn) \
701         void (*fn)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
702                                  enum brl_type lock_type, \
703                                  br_off start, br_off size)
704 struct parm_struct
705 {
706         const char *label;
707         parm_type type;
708         parm_class class;
709         void *ptr;
710         BOOL (*special)(const char *, char **);
711         const struct enum_list *enum_list;
712         unsigned flags;
713         union {
714                 BOOL bvalue;
715                 int ivalue;
716                 char *svalue;
717                 char cvalue;
718                 char **lvalue;
719         } def;
720 };
721
722 struct bitmap {
723         uint32 *b;
724         unsigned int n;
725 };
726
727 /* The following flags are used in SWAT */
728 #define FLAG_BASIC      0x0001 /* Display only in BASIC view */
729 #define FLAG_SHARE      0x0002 /* file sharing options */
730 #define FLAG_PRINT      0x0004 /* printing options */
731 #define FLAG_GLOBAL     0x0008 /* local options that should be globally settable in SWAT */
732 #define FLAG_WIZARD     0x0010 /* Parameters that the wizard will operate on */
733 #define FLAG_ADVANCED   0x0020 /* Parameters that will be visible in advanced view */
734 #define FLAG_DEVELOPER  0x0040 /* No longer used */
735 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
736 #define FLAG_HIDE       0x2000 /* options that should be hidden in SWAT */
737 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
738
739 #ifndef LOCKING_VERSION
740 #define LOCKING_VERSION 4
741 #endif /* LOCKING_VERSION */
742
743
744 /* the basic packet size, assuming no words or bytes */
745 #define smb_size 39
746
747 /* offsets into message for common items */
748 #define smb_com 8
749 #define smb_rcls 9
750 #define smb_reh 10
751 #define smb_err 11
752 #define smb_flg 13
753 #define smb_flg2 14
754 #define smb_pidhigh 16
755 #define smb_ss_field 18
756 #define smb_tid 28
757 #define smb_pid 30
758 #define smb_uid 32
759 #define smb_mid 34
760 #define smb_wct 36
761 #define smb_vwv 37
762 #define smb_vwv0 37
763 #define smb_vwv1 39
764 #define smb_vwv2 41
765 #define smb_vwv3 43
766 #define smb_vwv4 45
767 #define smb_vwv5 47
768 #define smb_vwv6 49
769 #define smb_vwv7 51
770 #define smb_vwv8 53
771 #define smb_vwv9 55
772 #define smb_vwv10 57
773 #define smb_vwv11 59
774 #define smb_vwv12 61
775 #define smb_vwv13 63
776 #define smb_vwv14 65
777 #define smb_vwv15 67
778 #define smb_vwv16 69
779 #define smb_vwv17 71
780
781 /* flag defines. CIFS spec 3.1.1 */
782 #define FLAG_SUPPORT_LOCKREAD       0x01
783 #define FLAG_CLIENT_BUF_AVAIL       0x02
784 #define FLAG_RESERVED               0x04
785 #define FLAG_CASELESS_PATHNAMES     0x08
786 #define FLAG_CANONICAL_PATHNAMES    0x10
787 #define FLAG_REQUEST_OPLOCK         0x20
788 #define FLAG_REQUEST_BATCH_OPLOCK   0x40
789 #define FLAG_REPLY                  0x80
790
791 /* the complete */
792 #define SMBmkdir      0x00   /* create directory */
793 #define SMBrmdir      0x01   /* delete directory */
794 #define SMBopen       0x02   /* open file */
795 #define SMBcreate     0x03   /* create file */
796 #define SMBclose      0x04   /* close file */
797 #define SMBflush      0x05   /* flush file */
798 #define SMBunlink     0x06   /* delete file */
799 #define SMBmv         0x07   /* rename file */
800 #define SMBgetatr     0x08   /* get file attributes */
801 #define SMBsetatr     0x09   /* set file attributes */
802 #define SMBread       0x0A   /* read from file */
803 #define SMBwrite      0x0B   /* write to file */
804 #define SMBlock       0x0C   /* lock byte range */
805 #define SMBunlock     0x0D   /* unlock byte range */
806 #define SMBctemp      0x0E   /* create temporary file */
807 #define SMBmknew      0x0F   /* make new file */
808 #define SMBchkpth     0x10   /* check directory path */
809 #define SMBexit       0x11   /* process exit */
810 #define SMBlseek      0x12   /* seek */
811 #define SMBtcon       0x70   /* tree connect */
812 #define SMBtconX      0x75   /* tree connect and X*/
813 #define SMBtdis       0x71   /* tree disconnect */
814 #define SMBnegprot    0x72   /* negotiate protocol */
815 #define SMBdskattr    0x80   /* get disk attributes */
816 #define SMBsearch     0x81   /* search directory */
817 #define SMBsplopen    0xC0   /* open print spool file */
818 #define SMBsplwr      0xC1   /* write to print spool file */
819 #define SMBsplclose   0xC2   /* close print spool file */
820 #define SMBsplretq    0xC3   /* return print queue */
821 #define SMBsends      0xD0   /* send single block message */
822 #define SMBsendb      0xD1   /* send broadcast message */
823 #define SMBfwdname    0xD2   /* forward user name */
824 #define SMBcancelf    0xD3   /* cancel forward */
825 #define SMBgetmac     0xD4   /* get machine name */
826 #define SMBsendstrt   0xD5   /* send start of multi-block message */
827 #define SMBsendend    0xD6   /* send end of multi-block message */
828 #define SMBsendtxt    0xD7   /* send text of multi-block message */
829
830 /* Core+ protocol */
831 #define SMBlockread       0x13   /* Lock a range and read */
832 #define SMBwriteunlock 0x14 /* Unlock a range then write */
833 #define SMBreadbraw   0x1a  /* read a block of data with no smb header */
834 #define SMBwritebraw  0x1d  /* write a block of data with no smb header */
835 #define SMBwritec     0x20  /* secondary write request */
836 #define SMBwriteclose 0x2c  /* write a file then close it */
837
838 /* dos extended protocol */
839 #define SMBreadBraw      0x1A   /* read block raw */
840 #define SMBreadBmpx      0x1B   /* read block multiplexed */
841 #define SMBreadBs        0x1C   /* read block (secondary response) */
842 #define SMBwriteBraw     0x1D   /* write block raw */
843 #define SMBwriteBmpx     0x1E   /* write block multiplexed */
844 #define SMBwriteBs       0x1F   /* write block (secondary request) */
845 #define SMBwriteC        0x20   /* write complete response */
846 #define SMBsetattrE      0x22   /* set file attributes expanded */
847 #define SMBgetattrE      0x23   /* get file attributes expanded */
848 #define SMBlockingX      0x24   /* lock/unlock byte ranges and X */
849 #define SMBtrans         0x25   /* transaction - name, bytes in/out */
850 #define SMBtranss        0x26   /* transaction (secondary request/response) */
851 #define SMBioctl         0x27   /* IOCTL */
852 #define SMBioctls        0x28   /* IOCTL  (secondary request/response) */
853 #define SMBcopy          0x29   /* copy */
854 #define SMBmove          0x2A   /* move */
855 #define SMBecho          0x2B   /* echo */
856 #define SMBopenX         0x2D   /* open and X */
857 #define SMBreadX         0x2E   /* read and X */
858 #define SMBwriteX        0x2F   /* write and X */
859 #define SMBsesssetupX    0x73   /* Session Set Up & X (including User Logon) */
860 #define SMBffirst        0x82   /* find first */
861 #define SMBfunique       0x83   /* find unique */
862 #define SMBfclose        0x84   /* find close */
863 #define SMBkeepalive     0x85   /* keepalive */
864 #define SMBinvalid       0xFE   /* invalid command */
865
866 /* Extended 2.0 protocol */
867 #define SMBtrans2        0x32   /* TRANS2 protocol set */
868 #define SMBtranss2       0x33   /* TRANS2 protocol set, secondary command */
869 #define SMBfindclose     0x34   /* Terminate a TRANSACT2_FINDFIRST */
870 #define SMBfindnclose    0x35   /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
871 #define SMBulogoffX      0x74   /* user logoff */
872
873 /* NT SMB extensions. */
874 #define SMBnttrans       0xA0   /* NT transact */
875 #define SMBnttranss      0xA1   /* NT transact secondary */
876 #define SMBntcreateX     0xA2   /* NT create and X */
877 #define SMBntcancel      0xA4   /* NT cancel */
878 #define SMBntrename      0xA5   /* NT rename */
879
880 /* These are the trans subcommands */
881 #define TRANSACT_SETNAMEDPIPEHANDLESTATE  0x01 
882 #define TRANSACT_DCERPCCMD                0x26
883 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
884
885 /* These are the TRANS2 sub commands */
886 #define TRANSACT2_OPEN                          0x00
887 #define TRANSACT2_FINDFIRST                     0x01
888 #define TRANSACT2_FINDNEXT                      0x02
889 #define TRANSACT2_QFSINFO                       0x03
890 #define TRANSACT2_SETFSINFO                     0x04
891 #define TRANSACT2_QPATHINFO                     0x05
892 #define TRANSACT2_SETPATHINFO                   0x06
893 #define TRANSACT2_QFILEINFO                     0x07
894 #define TRANSACT2_SETFILEINFO                   0x08
895 #define TRANSACT2_FSCTL                         0x09
896 #define TRANSACT2_IOCTL                         0x0A
897 #define TRANSACT2_FINDNOTIFYFIRST               0x0B
898 #define TRANSACT2_FINDNOTIFYNEXT                0x0C
899 #define TRANSACT2_MKDIR                         0x0D
900 #define TRANSACT2_SESSION_SETUP                 0x0E
901 #define TRANSACT2_GET_DFS_REFERRAL              0x10
902 #define TRANSACT2_REPORT_DFS_INCONSISTANCY      0x11
903
904 /* These are the NT transact sub commands. */
905 #define NT_TRANSACT_CREATE                1
906 #define NT_TRANSACT_IOCTL                 2
907 #define NT_TRANSACT_SET_SECURITY_DESC     3
908 #define NT_TRANSACT_NOTIFY_CHANGE         4
909 #define NT_TRANSACT_RENAME                5
910 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
911 #define NT_TRANSACT_GET_USER_QUOTA        7
912 #define NT_TRANSACT_SET_USER_QUOTA        8
913
914 /* These are the NT transact_get_user_quota sub commands */
915 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE   0x0000
916 #define TRANSACT_GET_USER_QUOTA_LIST_START      0x0100
917 #define TRANSACT_GET_USER_QUOTA_FOR_SID         0x0101
918
919 /* Relevant IOCTL codes */
920 #define IOCTL_QUERY_JOB_INFO      0x530060
921
922 /* these are the trans2 sub fields for primary requests */
923 #define smb_tpscnt smb_vwv0
924 #define smb_tdscnt smb_vwv1
925 #define smb_mprcnt smb_vwv2
926 #define smb_mdrcnt smb_vwv3
927 #define smb_msrcnt smb_vwv4
928 #define smb_flags smb_vwv5
929 #define smb_timeout smb_vwv6
930 #define smb_pscnt smb_vwv9
931 #define smb_psoff smb_vwv10
932 #define smb_dscnt smb_vwv11
933 #define smb_dsoff smb_vwv12
934 #define smb_suwcnt smb_vwv13
935 #define smb_setup smb_vwv14
936 #define smb_setup0 smb_setup
937 #define smb_setup1 (smb_setup+2)
938 #define smb_setup2 (smb_setup+4)
939
940 /* these are for the secondary requests */
941 #define smb_spscnt smb_vwv2
942 #define smb_spsoff smb_vwv3
943 #define smb_spsdisp smb_vwv4
944 #define smb_sdscnt smb_vwv5
945 #define smb_sdsoff smb_vwv6
946 #define smb_sdsdisp smb_vwv7
947 #define smb_sfid smb_vwv8
948
949 /* and these for responses */
950 #define smb_tprcnt smb_vwv0
951 #define smb_tdrcnt smb_vwv1
952 #define smb_prcnt smb_vwv3
953 #define smb_proff smb_vwv4
954 #define smb_prdisp smb_vwv5
955 #define smb_drcnt smb_vwv6
956 #define smb_droff smb_vwv7
957 #define smb_drdisp smb_vwv8
958
959 /* these are for the NT trans primary request. */
960 #define smb_nt_MaxSetupCount smb_vwv0
961 #define smb_nt_Flags (smb_vwv0 + 1)
962 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
963 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
964 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
965 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
966 #define smb_nt_ParameterCount (smb_vwv0 + 19)
967 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
968 #define smb_nt_DataCount (smb_vwv0 + 27)
969 #define smb_nt_DataOffset (smb_vwv0 + 31)
970 #define smb_nt_SetupCount (smb_vwv0 + 35)
971 #define smb_nt_Function (smb_vwv0 + 36)
972 #define smb_nt_SetupStart (smb_vwv0 + 38)
973
974 /* these are for the NT trans secondary request. */
975 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
976 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
977 #define smb_nts_ParameterCount (smb_vwv0 + 11)
978 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
979 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
980 #define smb_nts_DataCount (smb_vwv0 + 23)
981 #define smb_nts_DataOffset (smb_vwv0 + 27)
982 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
983
984 /* these are for the NT trans reply. */
985 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
986 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
987 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
988 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
989 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
990 #define smb_ntr_DataCount (smb_vwv0 + 23)
991 #define smb_ntr_DataOffset (smb_vwv0 + 27)
992 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
993
994 /* these are for the NT create_and_X */
995 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
996 #define smb_ntcreate_Flags (smb_vwv0 + 7)
997 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
998 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
999 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1000 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1001 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1002 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1003 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1004 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1005 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1006
1007 /* this is used on a TConX. I'm not sure the name is very helpful though */
1008 #define SMB_SUPPORT_SEARCH_BITS        0x0001
1009 #define SMB_SHARE_IN_DFS               0x0002
1010
1011 /* Named pipe write mode flags. Used in writeX calls. */
1012 #define PIPE_RAW_MODE 0x4
1013 #define PIPE_START_MESSAGE 0x8
1014
1015 /* File Specific access rights */
1016 #define FILE_READ_DATA        0x00000001
1017 #define FILE_WRITE_DATA       0x00000002
1018 #define FILE_APPEND_DATA      0x00000004
1019 #define FILE_READ_EA          0x00000008 /* File and directory */
1020 #define FILE_WRITE_EA         0x00000010 /* File and directory */
1021 #define FILE_EXECUTE          0x00000020
1022 #define FILE_DELETE_CHILD     0x00000040
1023 #define FILE_READ_ATTRIBUTES  0x00000080
1024 #define FILE_WRITE_ATTRIBUTES 0x00000100
1025
1026 #define FILE_ALL_ACCESS       0x000001FF
1027
1028 /* Directory specific access rights */
1029 #define FILE_LIST_DIRECTORY   0x00000001
1030 #define FILE_ADD_FILE         0x00000002
1031 #define FILE_ADD_SUBDIRECTORY 0x00000004
1032 #define FILE_TRAVERSE         0x00000020
1033 #define FILE_DELETE_CHILD     0x00000040
1034
1035 /* the desired access to use when opening a pipe */
1036 #define DESIRED_ACCESS_PIPE 0x2019f
1037  
1038 /* Generic access masks & rights. */
1039 #define DELETE_ACCESS        (1L<<16) /* 0x00010000 */
1040 #define READ_CONTROL_ACCESS  (1L<<17) /* 0x00020000 */
1041 #define WRITE_DAC_ACCESS     (1L<<18) /* 0x00040000 */
1042 #define WRITE_OWNER_ACCESS   (1L<<19) /* 0x00080000 */
1043 #define SYNCHRONIZE_ACCESS   (1L<<20) /* 0x00100000 */
1044
1045 #define SYSTEM_SECURITY_ACCESS (1L<<24)           /* 0x01000000 */
1046 #define MAXIMUM_ALLOWED_ACCESS (1L<<25)           /* 0x02000000 */
1047 #define GENERIC_ALL_ACCESS     (1<<28)            /* 0x10000000 */
1048 #define GENERIC_EXECUTE_ACCESS (1<<29)            /* 0x20000000 */
1049 #define GENERIC_WRITE_ACCESS   (1<<30)            /* 0x40000000 */
1050 #define GENERIC_READ_ACCESS   (((unsigned)1)<<31) /* 0x80000000 */
1051
1052 /* Mapping of generic access rights for files to specific rights. */
1053
1054 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1055
1056 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1057                                                         FILE_READ_EA|SYNCHRONIZE_ACCESS)
1058
1059 #define FILE_GENERIC_WRITE (STANDARD_RIGHTS_WRITE_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1060                                                         FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1061
1062 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
1063                                                                 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1064
1065 /* Mapping of access rights to UNIX perms. */
1066 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
1067 #define UNIX_ACCESS_R           FILE_GENERIC_READ
1068 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
1069 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
1070
1071 #if 0
1072 /*
1073  * This is the old mapping we used to use. To get W2KSP2 profiles
1074  * working we need to map to the canonical file perms.
1075  */
1076 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1077 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1078                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1079 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1080                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1081                         FILE_APPEND_DATA|FILE_WRITE_DATA)
1082 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1083                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1084 #endif
1085
1086 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1087
1088 /* Flags field. */
1089 #define REQUEST_OPLOCK 2
1090 #define REQUEST_BATCH_OPLOCK 4
1091 #define OPEN_DIRECTORY 8
1092 #define EXTENDED_RESPONSE_REQUIRED 0x10
1093
1094 /* ShareAccess field. */
1095 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1096 #define FILE_SHARE_READ 1
1097 #define FILE_SHARE_WRITE 2
1098 #define FILE_SHARE_DELETE 4
1099
1100 /* FileAttributesField */
1101 #define FILE_ATTRIBUTE_READONLY         0x001L
1102 #define FILE_ATTRIBUTE_HIDDEN           0x002L
1103 #define FILE_ATTRIBUTE_SYSTEM           0x004L
1104 #define FILE_ATTRIBUTE_DIRECTORY        0x010L
1105 #define FILE_ATTRIBUTE_ARCHIVE          0x020L
1106 #define FILE_ATTRIBUTE_NORMAL           0x080L
1107 #define FILE_ATTRIBUTE_TEMPORARY        0x100L
1108 #define FILE_ATTRIBUTE_SPARSE           0x200L
1109 #define FILE_ATTRIBUTE_COMPRESSED       0x800L
1110 #define FILE_ATTRIBUTE_NONINDEXED       0x2000L
1111 #define SAMBA_ATTRIBUTES_MASK           0x7F
1112
1113 /* Flags - combined with attributes. */
1114 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
1115 #define FILE_FLAG_NO_BUFFERING     0x20000000L
1116 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
1117 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
1118 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
1119 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1120 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
1121
1122 /* CreateDisposition field. */
1123 #define FILE_SUPERSEDE 0
1124 #define FILE_OPEN 1
1125 #define FILE_CREATE 2
1126 #define FILE_OPEN_IF 3
1127 #define FILE_OVERWRITE 4
1128 #define FILE_OVERWRITE_IF 5
1129
1130 /* CreateOptions field. */
1131 #define FILE_DIRECTORY_FILE       0x0001
1132 #define FILE_WRITE_THROUGH        0x0002
1133 #define FILE_SEQUENTIAL_ONLY      0x0004
1134 #define FILE_NON_DIRECTORY_FILE   0x0040
1135 #define FILE_NO_EA_KNOWLEDGE      0x0200
1136 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1137 #define FILE_RANDOM_ACCESS        0x0800
1138 #define FILE_DELETE_ON_CLOSE      0x1000
1139 #define FILE_OPEN_BY_FILE_ID      0x2000
1140
1141 /* Responses when opening a file. */
1142 #define FILE_WAS_SUPERSEDED 0
1143 #define FILE_WAS_OPENED 1
1144 #define FILE_WAS_CREATED 2
1145 #define FILE_WAS_OVERWRITTEN 3
1146
1147 /* File type flags */
1148 #define FILE_TYPE_DISK  0
1149 #define FILE_TYPE_BYTE_MODE_PIPE 1
1150 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1151 #define FILE_TYPE_PRINTER 3
1152 #define FILE_TYPE_COMM_DEVICE 4
1153 #define FILE_TYPE_UNKNOWN 0xFFFF
1154
1155 /* Flag for NT transact rename call. */
1156 #define RENAME_REPLACE_IF_EXISTS 1
1157
1158 /* flags for SMBntrename call (from Samba4) */
1159 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1160 #define RENAME_FLAG_HARD_LINK                0x103
1161 #define RENAME_FLAG_RENAME                   0x104
1162 #define RENAME_FLAG_COPY                     0x105
1163
1164 /* Filesystem Attributes. */
1165 #define FILE_CASE_SENSITIVE_SEARCH      0x00000001
1166 #define FILE_CASE_PRESERVED_NAMES       0x00000002
1167 #define FILE_UNICODE_ON_DISK            0x00000004
1168 /* According to cifs9f, this is 4, not 8 */
1169 /* Acconding to testing, this actually sets the security attribute! */
1170 #define FILE_PERSISTENT_ACLS            0x00000008
1171 #define FILE_FILE_COMPRESSION           0x00000010
1172 #define FILE_VOLUME_QUOTAS              0x00000020
1173 #define FILE_SUPPORTS_SPARSE_FILES      0x00000040
1174 #define FILE_SUPPORTS_REPARSE_POINTS    0x00000080
1175 #define FILE_SUPPORTS_REMOTE_STORAGE    0x00000100
1176 #define FS_LFN_APIS                     0x00004000
1177 #define FILE_VOLUME_IS_COMPRESSED       0x00008000
1178 #define FILE_SUPPORTS_OBJECT_IDS        0x00010000
1179 #define FILE_SUPPORTS_ENCRYPTION        0x00020000
1180 #define FILE_NAMED_STREAMS              0x00040000
1181 #define FILE_READ_ONLY_VOLUME           0x00080000
1182
1183 /* ChangeNotify flags. */
1184 #define FILE_NOTIFY_CHANGE_FILE        0x001
1185 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
1186 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
1187 #define FILE_NOTIFY_CHANGE_SIZE        0x008
1188 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
1189 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1190 #define FILE_NOTIFY_CHANGE_CREATION    0x040
1191 #define FILE_NOTIFY_CHANGE_EA          0x080
1192 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
1193 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x200
1194
1195 /* where to find the base of the SMB packet proper */
1196 #define smb_base(buf) (((char *)(buf))+4)
1197
1198 /* we don't allow server strings to be longer than 48 characters as
1199    otherwise NT will not honour the announce packets */
1200 #define MAX_SERVER_STRING_LENGTH 48
1201
1202
1203 #define SMB_SUCCESS 0  /* The request was successful. */
1204
1205 #ifdef WITH_DFS
1206 void dfs_unlogin(void);
1207 extern int dcelogin_atmost_once;
1208 #endif
1209
1210 #ifdef NOSTRDUP
1211 char *strdup(char *s);
1212 #endif
1213
1214 #ifndef SIGNAL_CAST
1215 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1216 #endif
1217
1218 #ifndef SELECT_CAST
1219 #define SELECT_CAST
1220 #endif
1221
1222 /* these are used in NetServerEnum to choose what to receive */
1223 #define SV_TYPE_WORKSTATION         0x00000001
1224 #define SV_TYPE_SERVER              0x00000002
1225 #define SV_TYPE_SQLSERVER           0x00000004
1226 #define SV_TYPE_DOMAIN_CTRL         0x00000008
1227 #define SV_TYPE_DOMAIN_BAKCTRL      0x00000010
1228 #define SV_TYPE_TIME_SOURCE         0x00000020
1229 #define SV_TYPE_AFP                 0x00000040
1230 #define SV_TYPE_NOVELL              0x00000080
1231 #define SV_TYPE_DOMAIN_MEMBER       0x00000100
1232 #define SV_TYPE_PRINTQ_SERVER       0x00000200
1233 #define SV_TYPE_DIALIN_SERVER       0x00000400
1234 #define SV_TYPE_SERVER_UNIX         0x00000800
1235 #define SV_TYPE_NT                  0x00001000
1236 #define SV_TYPE_WFW                 0x00002000
1237 #define SV_TYPE_SERVER_MFPN         0x00004000
1238 #define SV_TYPE_SERVER_NT           0x00008000
1239 #define SV_TYPE_POTENTIAL_BROWSER   0x00010000
1240 #define SV_TYPE_BACKUP_BROWSER      0x00020000
1241 #define SV_TYPE_MASTER_BROWSER      0x00040000
1242 #define SV_TYPE_DOMAIN_MASTER       0x00080000
1243 #define SV_TYPE_SERVER_OSF          0x00100000
1244 #define SV_TYPE_SERVER_VMS          0x00200000
1245 #define SV_TYPE_WIN95_PLUS          0x00400000
1246 #define SV_TYPE_DFS_SERVER          0x00800000
1247 #define SV_TYPE_ALTERNATE_XPORT     0x20000000  
1248 #define SV_TYPE_LOCAL_LIST_ONLY     0x40000000  
1249 #define SV_TYPE_DOMAIN_ENUM         0x80000000
1250 #define SV_TYPE_ALL                 0xFFFFFFFF  
1251
1252 /* This was set by JHT in liaison with Jeremy Allison early 1997
1253  * History:
1254  * Version 4.0 - never made public
1255  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1256  *              - Reappeared in 1.9.16p11 with fixed smbd services
1257  * Version 4.20 - To indicate that nmbd and browsing now works better
1258  * Version 4.50 - Set at release of samba-2.2.0 by JHT
1259  *
1260  *  Note: In the presence of NT4.X do not set above 4.9
1261  *        Setting this above 4.9 can have undesired side-effects.
1262  *        This may change again in Samba-3.0 after further testing. JHT
1263  */
1264  
1265 #define DEFAULT_MAJOR_VERSION 0x04
1266 #define DEFAULT_MINOR_VERSION 0x09
1267
1268 /* Browser Election Values */
1269 #define BROWSER_ELECTION_VERSION        0x010f
1270 #define BROWSER_CONSTANT        0xaa55
1271
1272 /* Sercurity mode bits. */
1273 #define NEGOTIATE_SECURITY_USER_LEVEL           0x01
1274 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE   0x02
1275 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED   0x04
1276 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED  0x08
1277
1278 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1279    
1280 #define FLAGS2_LONG_PATH_COMPONENTS    0x0001
1281 #define FLAGS2_EXTENDED_ATTRIBUTES     0x0002
1282 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1283 #define FLAGS2_IS_LONG_NAME            0x0040
1284 #define FLAGS2_EXTENDED_SECURITY       0x0800 
1285 #define FLAGS2_DFS_PATHNAMES           0x1000
1286 #define FLAGS2_READ_PERMIT_NO_EXECUTE  0x2000
1287 #define FLAGS2_32_BIT_ERROR_CODES      0x4000 
1288 #define FLAGS2_UNICODE_STRINGS         0x8000
1289
1290 #define FLAGS2_WIN2K_SIGNATURE         0xC852 /* Hack alert ! For now... JRA. */
1291
1292 /* Capabilities.  see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1293
1294 #define CAP_RAW_MODE         0x0001
1295 #define CAP_MPX_MODE         0x0002
1296 #define CAP_UNICODE          0x0004
1297 #define CAP_LARGE_FILES      0x0008
1298 #define CAP_NT_SMBS          0x0010
1299 #define CAP_RPC_REMOTE_APIS  0x0020
1300 #define CAP_STATUS32         0x0040
1301 #define CAP_LEVEL_II_OPLOCKS 0x0080
1302 #define CAP_LOCK_AND_READ    0x0100
1303 #define CAP_NT_FIND          0x0200
1304 #define CAP_DFS              0x1000
1305 #define CAP_W2K_SMBS         0x2000
1306 #define CAP_LARGE_READX      0x4000
1307 #define CAP_LARGE_WRITEX     0x8000
1308 #define CAP_UNIX             0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1309 #define CAP_EXTENDED_SECURITY 0x80000000
1310
1311 /* protocol types. It assumes that higher protocols include lower protocols
1312    as subsets */
1313 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1314
1315 /* security levels */
1316 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1317
1318 /* server roles */
1319 enum server_types
1320 {
1321         ROLE_STANDALONE,
1322         ROLE_DOMAIN_MEMBER,
1323         ROLE_DOMAIN_BDC,
1324         ROLE_DOMAIN_PDC
1325 };
1326
1327 /* printing types */
1328 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1329                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1330                      PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2
1331 #ifdef DEVELOPER
1332 ,PRINT_TEST,PRINT_VLP
1333 #endif /* DEVELOPER */
1334 };
1335
1336 /* LDAP schema types */
1337 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1338
1339 /* LDAP SSL options */
1340 enum ldap_ssl_types {LDAP_SSL_ON, LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1341
1342 /* LDAP PASSWD SYNC methods */
1343 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1344
1345 /* Remote architectures we know about. */
1346 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_SAMBA};
1347
1348 /* case handling */
1349 enum case_handling {CASE_LOWER,CASE_UPPER};
1350
1351 /*
1352  * Global value meaing that the smb_uid field should be
1353  * ingored (in share level security and protocol level == CORE)
1354  */
1355
1356 #define UID_FIELD_INVALID 0
1357 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1358
1359 /* 
1360  * Size of buffer to use when moving files across filesystems. 
1361  */
1362 #define COPYBUF_SIZE (8*1024)
1363
1364 /* 
1365  * Values used to override error codes. 
1366  */
1367 extern int unix_ERR_class;
1368 extern int unix_ERR_code;
1369 extern NTSTATUS unix_ERR_ntstatus;
1370
1371 /*
1372  * Used in chaining code.
1373  */
1374 extern int chain_size;
1375
1376 /*
1377  * Map the Core and Extended Oplock requesst bits down
1378  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1379  */
1380
1381 /*
1382  * Core protocol.
1383  */
1384 #define CORE_OPLOCK_REQUEST(inbuf) \
1385     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1386
1387 /*
1388  * Extended protocol.
1389  */
1390 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1391
1392 /* Lock types. */
1393 #define LOCKING_ANDX_SHARED_LOCK 0x1
1394 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1395 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1396 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1397 #define LOCKING_ANDX_LARGE_FILES 0x10
1398
1399 /* Oplock levels */
1400 #define OPLOCKLEVEL_NONE 0
1401 #define OPLOCKLEVEL_II 1
1402
1403 /*
1404  * Bits we test with.
1405  */
1406
1407 #define NO_OPLOCK 0
1408 #define EXCLUSIVE_OPLOCK 1
1409 #define BATCH_OPLOCK 2
1410 #define LEVEL_II_OPLOCK 4
1411
1412 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1413 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1414 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1415
1416 #define CORE_OPLOCK_GRANTED (1<<5)
1417 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1418
1419 /*
1420  * Return values for oplock types.
1421  */
1422
1423 #define NO_OPLOCK_RETURN 0
1424 #define EXCLUSIVE_OPLOCK_RETURN 1
1425 #define BATCH_OPLOCK_RETURN 2
1426 #define LEVEL_II_OPLOCK_RETURN 3
1427
1428 /*
1429  * Loopback command offsets.
1430  */
1431
1432 #define OPBRK_CMD_LEN_OFFSET 0
1433 #define OPBRK_CMD_PORT_OFFSET 4
1434 #define OPBRK_CMD_HEADER_LEN 6
1435
1436 #define OPBRK_MESSAGE_CMD_OFFSET 0
1437
1438 /*
1439  * Oplock break command code to send over the udp socket.
1440  * The same message is sent for both exlusive and level II breaks. 
1441  * 
1442  * The form of this is :
1443  *
1444  *  0     2       2+pid   2+pid+dev 2+pid+dev+ino
1445  *  +----+--------+-------+--------+---------+
1446  *  | cmd| pid    | dev   |  inode | fileid  |
1447  *  +----+--------+-------+--------+---------+
1448  */
1449
1450 #define OPLOCK_BREAK_PID_OFFSET 2
1451 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1452 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1453 #define OPLOCK_BREAK_FILEID_OFFSET (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1454 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1455
1456 /* Message types */
1457 #define OPLOCK_BREAK_CMD 0x1
1458 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1459 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1460 #define ASYNC_LEVEL_II_OPLOCK_BREAK_CMD 0x4
1461
1462 /*
1463  * Capabilities abstracted for different systems.
1464  */
1465
1466 #define KERNEL_OPLOCK_CAPABILITY 0x1
1467
1468 /*
1469  * Oplock break command code sent via the kernel interface (if it exists).
1470  *
1471  * Form of this is :
1472  *
1473  *  0     2       2+devsize 2+devsize+inodesize
1474  *  +----+--------+--------+----------+
1475  *  | cmd| dev    |  inode |  fileid  |
1476  *  +----+--------+--------+----------+
1477  */
1478 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1479 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1480 #define KERNEL_OPLOCK_BREAK_FILEID_OFFSET (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1481 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1482
1483
1484 /* if a kernel does support oplocks then a structure of the following
1485    typee is used to describe how to interact with the kernel */
1486 struct kernel_oplocks {
1487         BOOL (*receive_message)(fd_set *fds, char *buffer, int buffer_len);
1488         BOOL (*set_oplock)(files_struct *fsp, int oplock_type);
1489         void (*release_oplock)(files_struct *fsp);
1490         BOOL (*parse_message)(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev, unsigned long *file_id);
1491         BOOL (*msg_waiting)(fd_set *fds);
1492         int notification_fd;
1493 };
1494
1495
1496 #define CMD_REPLY 0x8000
1497
1498 /* this structure defines the functions for doing change notify in
1499    various implementations */
1500 struct cnotify_fns {
1501         void * (*register_notify)(connection_struct *conn, char *path, uint32 flags);
1502         BOOL (*check_notify)(connection_struct *conn, uint16 vuid, char *path, uint32 flags, void *data, time_t t);
1503         void (*remove_notify)(void *data);
1504         int select_time;
1505 };
1506
1507
1508
1509 #include "smb_macros.h"
1510
1511 #define MAX_NETBIOSNAME_LEN 16
1512 typedef char nstring[MAX_NETBIOSNAME_LEN];
1513
1514 /* A netbios name structure. */
1515 struct nmb_name {
1516         nstring      name;
1517         char         scope[64];
1518         unsigned int name_type;
1519 };
1520
1521
1522 /* A netbios node status array element. */
1523 struct node_status {
1524         nstring name;
1525         unsigned char type;
1526         unsigned char flags;
1527 };
1528
1529 struct pwd_info
1530 {
1531         BOOL null_pwd;
1532         BOOL cleartext;
1533
1534         fstring password;
1535
1536 };
1537
1538 typedef struct user_struct
1539 {
1540         struct user_struct *next, *prev;
1541         uint16 vuid; /* Tag for this entry. */
1542         uid_t uid; /* uid of a validated user */
1543         gid_t gid; /* gid of a validated user */
1544
1545         userdom_struct user;
1546         char *homedir;
1547         char *unix_homedir;
1548         char *logon_script;
1549         
1550         BOOL guest;
1551
1552         /* following groups stuff added by ih */
1553         /* This groups info is needed for when we become_user() for this uid */
1554         int n_groups;
1555         gid_t *groups;
1556
1557         NT_USER_TOKEN *nt_user_token;
1558         PRIVILEGE_SET *privs;
1559
1560         DATA_BLOB session_key;
1561
1562         char *session_keystr; /* used by utmp and pam session code.  
1563                                  TDB key string */
1564         int homes_snum;
1565
1566         struct auth_serversupplied_info *server_info;
1567
1568 } user_struct;
1569
1570
1571 struct unix_error_map {
1572         int unix_error;
1573         int dos_class;
1574         int dos_code;
1575         NTSTATUS nt_error;
1576 };
1577
1578 /*
1579 #include "ntdomain.h"
1580
1581 #include "client.h"
1582 */
1583
1584 /*
1585  * Size of new password account encoding string.  This is enough space to
1586  * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1587  * Do not change unless you are adding new ACB bits!
1588  */
1589
1590 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1591
1592 /*
1593    Do you want session setups at user level security with a invalid
1594    password to be rejected or allowed in as guest? WinNT rejects them
1595    but it can be a pain as it means "net view" needs to use a password
1596
1597    You have 3 choices in the setting of map_to_guest:
1598
1599    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1600    are rejected. This is the default.
1601
1602    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1603    are rejected, unless the username does not exist, in which case it
1604    is treated as a guest login
1605
1606    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1607    are treated as a guest login
1608
1609    Note that map_to_guest only has an effect in user or server
1610    level security.
1611 */
1612
1613 #define NEVER_MAP_TO_GUEST 0
1614 #define MAP_TO_GUEST_ON_BAD_USER 1
1615 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1616
1617 #define SAFE_NETBIOS_CHARS ". -_"
1618
1619 /* generic iconv conversion structure */
1620 typedef struct {
1621         size_t (*direct)(void *cd, char **inbuf, size_t *inbytesleft,
1622                          char **outbuf, size_t *outbytesleft);
1623         size_t (*pull)(void *cd, char **inbuf, size_t *inbytesleft,
1624                        char **outbuf, size_t *outbytesleft);
1625         size_t (*push)(void *cd, char **inbuf, size_t *inbytesleft,
1626                        char **outbuf, size_t *outbytesleft);
1627         void *cd_direct, *cd_pull, *cd_push;
1628         char *from_name, *to_name;
1629 } *smb_iconv_t;
1630
1631 /* The maximum length of a trust account password.
1632    Used when we randomly create it, 15 char passwords
1633    exceed NT4's max password length */
1634
1635 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1636
1637 #include "popt_common.h"
1638
1639 #define PORT_NONE       0
1640 #ifndef LDAP_PORT
1641 #define LDAP_PORT       389
1642 #endif
1643
1644 /* used by the IP comparison function */
1645 struct ip_service {
1646         struct in_addr ip;
1647         unsigned port;
1648 };
1649
1650 /* Used by the SMB signing functions. */
1651
1652 typedef struct smb_sign_info {
1653         void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1654         BOOL (*check_incoming_message)(char *inbuf, struct smb_sign_info *si, BOOL expected_ok);
1655         void (*free_signing_context)(struct smb_sign_info *si);
1656         void *signing_context;
1657
1658         BOOL negotiated_smb_signing;
1659         BOOL allow_smb_signing;
1660         BOOL doing_signing;
1661         BOOL mandatory_signing;
1662         BOOL seen_valid; /* Have I ever seen a validly signed packet? */
1663 } smb_sign_info;
1664
1665 #endif /* _SMB_H */