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