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