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