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