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