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