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