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