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