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