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