s3:include: move struct stream_struct to vfs.h
[mat/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 #include "libcli/smb/smb_common.h"
30 #include "libds/common/roles.h"
31
32 /* logged when starting the various Samba daemons */
33 #define COPYRIGHT_STARTUP_MESSAGE       "Copyright Andrew Tridgell and the Samba Team 1992-2012"
34
35
36 #define BUFFER_SIZE (128*1024)
37
38 #define SAFETY_MARGIN 1024
39 #define LARGE_WRITEX_HDR_SIZE 65
40
41 #define NMB_PORT 137
42 #define DGRAM_PORT 138
43 #define NBT_SMB_PORT  139   /* Port for SMB over NBT transport (IETF STD#19). */
44 #define TCP_SMB_PORT  445   /* Port for SMB over naked TCP transport.         */
45 #define SMB_PORTS "445 139"
46
47 #define Undefined (-1)
48 #define False false
49 #define True true
50 #define Auto (2)
51 #define Required (3)
52
53 #define SIZEOFWORD 2
54
55 #ifndef DEF_CREATE_MASK
56 #define DEF_CREATE_MASK (0755)
57 #endif
58
59 /* string manipulation flags - see clistr.c and srvstr.c */
60 #define STR_TERMINATE 1
61 #define STR_UPPER 2
62 #define STR_ASCII 4
63 #define STR_UNICODE 8
64 #define STR_NOALIGN 16
65 #define STR_TERMINATE_ASCII 128
66
67 /* how long to wait for secondary SMB packets (milli-seconds) */
68 #define SMB_SECONDARY_WAIT (60*1000)
69
70 #define DIR_STRUCT_SIZE 43
71
72 /* deny modes */
73 #define DENY_DOS 0
74 #define DENY_ALL 1
75 #define DENY_WRITE 2
76 #define DENY_READ 3
77 #define DENY_NONE 4
78 #define DENY_FCB 7
79
80 /* open modes */
81 #define DOS_OPEN_RDONLY 0
82 #define DOS_OPEN_WRONLY 1
83 #define DOS_OPEN_RDWR 2
84 #define DOS_OPEN_EXEC 3
85 #define DOS_OPEN_FCB 0xF
86
87 /* define shifts and masks for share and open modes. */
88 #define OPENX_MODE_MASK 0xF
89 #define DENY_MODE_SHIFT 4
90 #define DENY_MODE_MASK 0x7
91 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
92 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
93 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
94 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
95
96 /* Sync on open file (not sure if used anymore... ?) */
97 #define FILE_SYNC_OPENMODE (1<<14)
98 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
99
100 /* open disposition values */
101 #define OPENX_FILE_EXISTS_FAIL 0
102 #define OPENX_FILE_EXISTS_OPEN 1
103 #define OPENX_FILE_EXISTS_TRUNCATE 2
104
105 /* mask for open disposition. */
106 #define OPENX_FILE_OPEN_MASK 0x3
107
108 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
109 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
110
111 /* The above can be OR'ed with... */
112 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
113 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
114
115 /* pipe string names */
116
117 #ifndef MAXSUBAUTHS
118 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
119 #endif
120
121 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
122
123 #include "librpc/gen_ndr/security.h"
124
125 struct idle_event;
126 struct share_mode_entry;
127 struct uuid;
128 struct named_mutex;
129 struct wb_context;
130 struct rpc_cli_smbd_conn;
131 struct fncall_context;
132
133 /* the basic packet size, assuming no words or bytes */
134 #define smb_size 39
135
136 struct notify_change {
137         uint32_t action;
138         const char *name;
139 };
140
141 struct notify_mid_map;
142 struct notify_db_entry;
143 struct notify_event;
144 struct notify_change_request;
145 struct sys_notify_backend;
146 struct sys_notify_context {
147         struct event_context *ev;
148         void *private_data;     /* For use by the system backend */
149 };
150
151 #include "ntquotas.h"
152 #include "sysquotas.h"
153
154 struct vuid_cache_entry {
155         struct auth_session_info *session_info;
156         uint16_t vuid;
157         bool read_only;
158 };
159
160 struct vuid_cache {
161         unsigned int next_entry;
162         struct vuid_cache_entry array[VUID_CACHE_SIZE];
163 };
164
165 typedef struct {
166         char *name;
167         bool is_wild;
168 } name_compare_entry;
169
170 /* Include VFS stuff */
171
172 #include "smb_acls.h"
173 #include "vfs.h"
174
175 struct dfree_cached_info {
176         time_t last_dfree_time;
177         uint64_t dfree_ret;
178         uint64_t bsize;
179         uint64_t dfree;
180         uint64_t dsize;
181 };
182
183 struct dptr_struct;
184
185 struct share_params {
186         int service;
187 };
188
189 typedef struct connection_struct {
190         struct connection_struct *next, *prev;
191         struct smbd_server_connection *sconn; /* can be NULL */
192         unsigned cnum; /* an index passed over the wire */
193         struct share_params *params;
194         bool force_user;
195         struct vuid_cache vuid_cache;
196         bool printer;
197         bool ipc;
198         bool read_only; /* Attributes for the current user of the share. */
199         uint32_t share_access;
200         /* Does this filesystem honor
201            sub second timestamps on files
202            and directories when setting time ? */
203         enum timestamp_set_resolution ts_res;
204         char *connectpath;
205         char *origpath;
206
207         struct vfs_handle_struct *vfs_handles;          /* for the new plugins */
208
209         /*
210          * This represents the user information on this connection. Depending
211          * on the vuid using this tid, this might change per SMB request.
212          */
213         struct auth_session_info *session_info;
214
215         /*
216          * If the "force group" parameter is set, this is the primary gid that
217          * may be used in the users token, depending on the vuid using this tid.
218          */
219         gid_t force_group_gid;
220
221         uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
222
223         time_t lastused;
224         time_t lastused_count;
225         int num_files_open;
226         unsigned int num_smb_operations; /* Count of smb operations on this tree. */
227         int encrypt_level;
228         bool encrypted_tid;
229
230         /* Semantics requested by the client or forced by the server config. */
231         bool case_sensitive;
232         bool case_preserve;
233         bool short_case_preserve;
234
235         /* Semantics provided by the underlying filesystem. */
236         int fs_capabilities;
237         /* Device number of the directory of the share mount.
238            Used to ensure unique FileIndex returns. */
239         SMB_DEV_T base_share_dev;
240
241         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
242         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
243         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */       
244         name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */       
245         struct dfree_cached_info *dfree_info;
246         struct trans_state *pending_trans;
247
248         struct rpc_pipe_client *spoolss_pipe;
249
250 } connection_struct;
251
252 struct current_user {
253         connection_struct *conn;
254         uint16 vuid;
255         struct security_unix_token ut;
256         struct security_token *nt_user_token;
257 };
258
259 struct smbd_smb2_request;
260 struct privilege_paths;
261
262 struct smb_request {
263         uint8_t cmd;
264         uint16 flags2;
265         uint16 smbpid;
266         uint64_t mid; /* For compatibility with SMB2. */
267         uint32_t seqnum;
268         uint16 vuid;
269         uint16 tid;
270         uint8  wct;
271         const uint16_t *vwv;
272         uint16_t buflen;
273         const uint8_t *buf;
274         const uint8 *inbuf;
275
276         /*
277          * Async handling in the main smb processing loop is directed by
278          * outbuf: reply_xxx routines indicate sync behaviour by putting their
279          * reply into "outbuf". If they leave it as NULL, they take care of it
280          * themselves, possibly later.
281          *
282          * If async handling is wanted, the reply_xxx routine must make sure
283          * that it talloc_move()s the smb_req somewhere else.
284          */
285         uint8 *outbuf;
286
287         size_t unread_bytes;
288         bool encrypted;
289         connection_struct *conn;
290         struct smbd_server_connection *sconn;
291         struct smb_perfcount_data pcd;
292
293         /*
294          * Chained request handling
295          */
296         struct files_struct *chain_fsp;
297
298         /*
299          * state information for async smb handling
300          */
301         void *async_priv;
302
303         /*
304          * Back pointer to smb2 request.
305          */
306         struct smbd_smb2_request *smb2req;
307
308         /*
309          * Pathnames used if request done
310          * under privilege.
311          */
312         struct privilege_paths *priv_paths;
313
314         /*
315          * Request list for chained requests, we're part of it.
316          */
317         struct smb_request **chain;
318 };
319
320 /* Defines for the sent_oplock_break field above. */
321 #define NO_BREAK_SENT 0
322 #define BREAK_TO_NONE_SENT 1
323 #define LEVEL_II_BREAK_SENT 2
324
325 typedef struct {
326         fstring smb_name; /* user name from the client */
327         fstring unix_name; /* unix user name of a validated user */
328         fstring domain; /* domain that the client specified */
329 } userdom_struct;
330
331 /* used for network interfaces */
332 struct interface {
333         struct interface *next, *prev;
334         char *name;
335         int flags;
336         struct sockaddr_storage ip;
337         struct sockaddr_storage netmask;
338         struct sockaddr_storage bcast;
339 };
340
341 #define SHARE_MODE_FLAG_POSIX_OPEN      0x1
342
343 #include "librpc/gen_ndr/server_id.h"
344
345 /* oplock break message definition - linearization of share_mode_entry.
346
347 Offset  Data                    length.
348 0       struct server_id pid    4
349 4       uint16 op_mid           8
350 12      uint16 op_type          2
351 14      uint32 access_mask      4
352 18      uint32 share_access     4
353 22      uint32 private_options  4
354 26      uint32 time sec         4
355 30      uint32 time usec        4
356 34      uint64 dev              8 bytes
357 42      uint64 inode            8 bytes
358 50      uint64 extid            8 bytes
359 58      unsigned long file_id   4 bytes
360 62      uint32 uid              4 bytes
361 66      uint16 flags            2 bytes
362 68      uint32 name_hash        4 bytes
363 72
364
365 */
366
367 #define OP_BREAK_MSG_PID_OFFSET 0
368 #define OP_BREAK_MSG_MID_OFFSET 4
369 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
370 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
371 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
372 #define OP_BREAK_MSG_PRIV_OFFSET 22
373 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
374 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
375 #define OP_BREAK_MSG_DEV_OFFSET 34
376 #define OP_BREAK_MSG_INO_OFFSET 42
377 #define OP_BREAK_MSG_EXTID_OFFSET 50
378 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
379 #define OP_BREAK_MSG_UID_OFFSET 62
380 #define OP_BREAK_MSG_FLAGS_OFFSET 66
381 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
382
383 #define OP_BREAK_MSG_VNN_OFFSET 72
384 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
385
386 #define NT_HASH_LEN 16
387 #define LM_HASH_LEN 16
388
389 /* offsets into message for common items */
390 #define smb_com         (NBT_HDR_SIZE+HDR_COM)
391 #define smb_rcls        (NBT_HDR_SIZE+HDR_RCLS)
392 #define smb_reh         (NBT_HDR_SIZE+HDR_REH)
393 #define smb_err         (NBT_HDR_SIZE+HDR_ERR)
394 #define smb_flg         (NBT_HDR_SIZE+HDR_FLG)
395 #define smb_flg2        (NBT_HDR_SIZE+HDR_FLG2)
396 #define smb_pidhigh     (NBT_HDR_SIZE+HDR_PIDHIGH)
397 #define smb_ss_field    (NBT_HDR_SIZE+HDR_SS_FIELD)
398 #define smb_tid         (NBT_HDR_SIZE+HDR_TID)
399 #define smb_pid         (NBT_HDR_SIZE+HDR_PID)
400 #define smb_uid         (NBT_HDR_SIZE+HDR_UID)
401 #define smb_mid         (NBT_HDR_SIZE+HDR_MID)
402 #define smb_wct         (NBT_HDR_SIZE+HDR_WCT)
403 #define smb_vwv         (NBT_HDR_SIZE+HDR_VWV)
404 #define smb_vwv0        (smb_vwv+( 0*2))
405 #define smb_vwv1        (smb_vwv+( 1*2))
406 #define smb_vwv2        (smb_vwv+( 2*2))
407 #define smb_vwv3        (smb_vwv+( 3*2))
408 #define smb_vwv4        (smb_vwv+( 4*2))
409 #define smb_vwv5        (smb_vwv+( 5*2))
410 #define smb_vwv6        (smb_vwv+( 6*2))
411 #define smb_vwv7        (smb_vwv+( 7*2))
412 #define smb_vwv8        (smb_vwv+( 8*2))
413 #define smb_vwv9        (smb_vwv+( 9*2))
414 #define smb_vwv10       (smb_vwv+(10*2))
415 #define smb_vwv11       (smb_vwv+(11*2))
416 #define smb_vwv12       (smb_vwv+(12*2))
417 #define smb_vwv13       (smb_vwv+(13*2))
418 #define smb_vwv14       (smb_vwv+(14*2))
419 #define smb_vwv15       (smb_vwv+(15*2))
420 #define smb_vwv16       (smb_vwv+(16*2))
421 #define smb_vwv17       (smb_vwv+(17*2))
422
423 /* These are the trans subcommands */
424 #define TRANSACT_SETNAMEDPIPEHANDLESTATE  0x01 
425 #define TRANSACT_DCERPCCMD                0x26
426 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
427
428 /* These are the TRANS2 sub commands */
429 #define TRANSACT2_OPEN                          0x00
430 #define TRANSACT2_FINDFIRST                     0x01
431 #define TRANSACT2_FINDNEXT                      0x02
432 #define TRANSACT2_QFSINFO                       0x03
433 #define TRANSACT2_SETFSINFO                     0x04
434 #define TRANSACT2_QPATHINFO                     0x05
435 #define TRANSACT2_SETPATHINFO                   0x06
436 #define TRANSACT2_QFILEINFO                     0x07
437 #define TRANSACT2_SETFILEINFO                   0x08
438 #define TRANSACT2_FSCTL                         0x09
439 #define TRANSACT2_IOCTL                         0x0A
440 #define TRANSACT2_FINDNOTIFYFIRST               0x0B
441 #define TRANSACT2_FINDNOTIFYNEXT                0x0C
442 #define TRANSACT2_MKDIR                         0x0D
443 #define TRANSACT2_SESSION_SETUP                 0x0E
444 #define TRANSACT2_GET_DFS_REFERRAL              0x10
445 #define TRANSACT2_REPORT_DFS_INCONSISTANCY      0x11
446
447 /* These are the NT transact sub commands. */
448 #define NT_TRANSACT_CREATE                1
449 #define NT_TRANSACT_IOCTL                 2
450 #define NT_TRANSACT_SET_SECURITY_DESC     3
451 #define NT_TRANSACT_NOTIFY_CHANGE         4
452 #define NT_TRANSACT_RENAME                5
453 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
454 #define NT_TRANSACT_GET_USER_QUOTA        7
455 #define NT_TRANSACT_SET_USER_QUOTA        8
456
457 /* These are the NT transact_get_user_quota sub commands */
458 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE   0x0000
459 #define TRANSACT_GET_USER_QUOTA_LIST_START      0x0100
460 #define TRANSACT_GET_USER_QUOTA_FOR_SID         0x0101
461
462 /* Relevant IOCTL codes */
463 #define IOCTL_QUERY_JOB_INFO      0x530060
464
465 /* these are the trans2 sub fields for primary requests */
466 #define smb_tpscnt smb_vwv0
467 #define smb_tdscnt smb_vwv1
468 #define smb_mprcnt smb_vwv2
469 #define smb_mdrcnt smb_vwv3
470 #define smb_msrcnt smb_vwv4
471 #define smb_flags smb_vwv5
472 #define smb_timeout smb_vwv6
473 #define smb_pscnt smb_vwv9
474 #define smb_psoff smb_vwv10
475 #define smb_dscnt smb_vwv11
476 #define smb_dsoff smb_vwv12
477 #define smb_suwcnt smb_vwv13
478 #define smb_setup smb_vwv14
479 #define smb_setup0 smb_setup
480 #define smb_setup1 (smb_setup+2)
481 #define smb_setup2 (smb_setup+4)
482
483 /* these are for the secondary requests */
484 #define smb_spscnt smb_vwv2
485 #define smb_spsoff smb_vwv3
486 #define smb_spsdisp smb_vwv4
487 #define smb_sdscnt smb_vwv5
488 #define smb_sdsoff smb_vwv6
489 #define smb_sdsdisp smb_vwv7
490 #define smb_sfid smb_vwv8
491
492 /* and these for responses */
493 #define smb_tprcnt smb_vwv0
494 #define smb_tdrcnt smb_vwv1
495 #define smb_prcnt smb_vwv3
496 #define smb_proff smb_vwv4
497 #define smb_prdisp smb_vwv5
498 #define smb_drcnt smb_vwv6
499 #define smb_droff smb_vwv7
500 #define smb_drdisp smb_vwv8
501
502 /* these are for the NT trans primary request. */
503 #define smb_nt_MaxSetupCount smb_vwv0
504 #define smb_nt_Flags (smb_vwv0 + 1)
505 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
506 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
507 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
508 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
509 #define smb_nt_ParameterCount (smb_vwv0 + 19)
510 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
511 #define smb_nt_DataCount (smb_vwv0 + 27)
512 #define smb_nt_DataOffset (smb_vwv0 + 31)
513 #define smb_nt_SetupCount (smb_vwv0 + 35)
514 #define smb_nt_Function (smb_vwv0 + 36)
515 #define smb_nt_SetupStart (smb_vwv0 + 38)
516
517 /* these are for the NT trans secondary request. */
518 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
519 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
520 #define smb_nts_ParameterCount (smb_vwv0 + 11)
521 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
522 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
523 #define smb_nts_DataCount (smb_vwv0 + 23)
524 #define smb_nts_DataOffset (smb_vwv0 + 27)
525 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
526
527 /* these are for the NT trans reply. */
528 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
529 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
530 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
531 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
532 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
533 #define smb_ntr_DataCount (smb_vwv0 + 23)
534 #define smb_ntr_DataOffset (smb_vwv0 + 27)
535 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
536
537 /* these are for the NT create_and_X */
538 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
539 #define smb_ntcreate_Flags (smb_vwv0 + 7)
540 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
541 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
542 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
543 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
544 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
545 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
546 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
547 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
548 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
549
550 /* this is used on a TConX. I'm not sure the name is very helpful though */
551 #define SMB_SUPPORT_SEARCH_BITS        0x0001
552 #define SMB_SHARE_IN_DFS               0x0002
553
554 /* Named pipe write mode flags. Used in writeX calls. */
555 #define PIPE_RAW_MODE 0x4
556 #define PIPE_START_MESSAGE 0x8
557
558 /* the desired access to use when opening a pipe */
559 #define DESIRED_ACCESS_PIPE 0x2019f
560  
561 /* Mapping of access rights to UNIX perms. */
562 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
563 #define UNIX_ACCESS_R           FILE_GENERIC_READ
564 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
565 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
566
567 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
568 #define UNIX_DIRECTORY_ACCESS_RWX               FILE_GENERIC_ALL
569 #define UNIX_DIRECTORY_ACCESS_R                 FILE_GENERIC_READ
570 #define UNIX_DIRECTORY_ACCESS_W                 (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
571 #define UNIX_DIRECTORY_ACCESS_X                 FILE_GENERIC_EXECUTE
572
573 #if 0
574 /*
575  * This is the old mapping we used to use. To get W2KSP2 profiles
576  * working we need to map to the canonical file perms.
577  */
578 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
579 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
580                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
581 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
582                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
583                         FILE_APPEND_DATA|FILE_WRITE_DATA)
584 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
585                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
586 #endif
587
588 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
589
590 /* Flags field. */
591 #define REQUEST_OPLOCK 2
592 #define REQUEST_BATCH_OPLOCK 4
593 #define OPEN_DIRECTORY 8
594 #define EXTENDED_RESPONSE_REQUIRED 0x10
595
596 /* ShareAccess field. */
597 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
598 #define FILE_SHARE_READ 1
599 #define FILE_SHARE_WRITE 2
600 #define FILE_SHARE_DELETE 4
601
602 /* Flags - combined with attributes. */
603 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
604 #define FILE_FLAG_NO_BUFFERING     0x20000000L
605 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
606 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
607 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
608 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
609 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
610
611 /* CreateDisposition field. */
612 #define FILE_SUPERSEDE 0                /* File exists overwrite/supersede. File not exist create. */
613 #define FILE_OPEN 1                     /* File exists open. File not exist fail. */
614 #define FILE_CREATE 2                   /* File exists fail. File not exist create. */
615 #define FILE_OPEN_IF 3                  /* File exists open. File not exist create. */
616 #define FILE_OVERWRITE 4                /* File exists overwrite. File not exist fail. */
617 #define FILE_OVERWRITE_IF 5             /* File exists overwrite. File not exist create. */
618
619 /* CreateOptions field. */
620 #define FILE_DIRECTORY_FILE       0x0001
621 #define FILE_WRITE_THROUGH        0x0002
622 #define FILE_SEQUENTIAL_ONLY      0x0004
623 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
624 #define FILE_SYNCHRONOUS_IO_ALERT      0x0010   /* may be ignored */
625 #define FILE_SYNCHRONOUS_IO_NONALERT   0x0020   /* may be ignored */
626 #define FILE_NON_DIRECTORY_FILE   0x0040
627 #define FILE_CREATE_TREE_CONNECTION    0x0080   /* ignore, should be zero */
628 #define FILE_COMPLETE_IF_OPLOCKED      0x0100   /* ignore, should be zero */
629 #define FILE_NO_EA_KNOWLEDGE      0x0200
630 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
631 #define FILE_RANDOM_ACCESS        0x0800
632 #define FILE_DELETE_ON_CLOSE      0x1000
633 #define FILE_OPEN_BY_FILE_ID      0x2000
634 #define FILE_OPEN_FOR_BACKUP_INTENT    0x4000
635 #define FILE_NO_COMPRESSION       0x8000
636 #define FILE_RESERVER_OPFILTER    0x00100000    /* ignore, should be zero */
637 #define FILE_OPEN_REPARSE_POINT   0x00200000
638 #define FILE_OPEN_NO_RECALL       0x00400000
639 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
640
641 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK      (0x008F0480)
642
643 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK    (0xFF100030)
644
645 /*
646  * Private create options used by the ntcreatex processing code. From Samba4.
647  * We reuse some ignored flags for private use. Passed in the private_flags
648  * argument.
649  */
650 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS     0x0001
651 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB     0x0002
652
653 /* Private options for streams support */
654 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
655
656 /* Private options for printer support */
657 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
658
659 /* Responses when opening a file. */
660 #define FILE_WAS_SUPERSEDED 0
661 #define FILE_WAS_OPENED 1
662 #define FILE_WAS_CREATED 2
663 #define FILE_WAS_OVERWRITTEN 3
664
665 /* Flag for NT transact rename call. */
666 #define RENAME_REPLACE_IF_EXISTS 1
667
668 /* flags for SMBntrename call (from Samba4) */
669 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
670 #define RENAME_FLAG_HARD_LINK                0x103
671 #define RENAME_FLAG_RENAME                   0x104
672 #define RENAME_FLAG_COPY                     0x105
673
674 /* Filesystem Attributes. */
675 #define FILE_CASE_SENSITIVE_SEARCH      0x00000001
676 #define FILE_CASE_PRESERVED_NAMES       0x00000002
677 #define FILE_UNICODE_ON_DISK            0x00000004
678 /* According to cifs9f, this is 4, not 8 */
679 /* Acconding to testing, this actually sets the security attribute! */
680 #define FILE_PERSISTENT_ACLS            0x00000008
681 #define FILE_FILE_COMPRESSION           0x00000010
682 #define FILE_VOLUME_QUOTAS              0x00000020
683 #define FILE_SUPPORTS_SPARSE_FILES      0x00000040
684 #define FILE_SUPPORTS_REPARSE_POINTS    0x00000080
685 #define FILE_SUPPORTS_REMOTE_STORAGE    0x00000100
686 #define FS_LFN_APIS                     0x00004000
687 #define FILE_VOLUME_IS_COMPRESSED       0x00008000
688 #define FILE_SUPPORTS_OBJECT_IDS        0x00010000
689 #define FILE_SUPPORTS_ENCRYPTION        0x00020000
690 #define FILE_NAMED_STREAMS              0x00040000
691 #define FILE_READ_ONLY_VOLUME           0x00080000
692
693 /* ChangeNotify flags. */
694 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x001
695 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
696 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
697 #define FILE_NOTIFY_CHANGE_SIZE        0x008
698 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
699 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
700 #define FILE_NOTIFY_CHANGE_CREATION    0x040
701 #define FILE_NOTIFY_CHANGE_EA          0x080
702 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
703 #define FILE_NOTIFY_CHANGE_STREAM_NAME  0x00000200
704 #define FILE_NOTIFY_CHANGE_STREAM_SIZE  0x00000400
705 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
706
707 #define FILE_NOTIFY_CHANGE_NAME \
708         (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
709
710 #define FILE_NOTIFY_CHANGE_ALL \
711         (FILE_NOTIFY_CHANGE_FILE_NAME   | FILE_NOTIFY_CHANGE_DIR_NAME | \
712          FILE_NOTIFY_CHANGE_ATTRIBUTES  | FILE_NOTIFY_CHANGE_SIZE | \
713          FILE_NOTIFY_CHANGE_LAST_WRITE  | FILE_NOTIFY_CHANGE_LAST_ACCESS | \
714          FILE_NOTIFY_CHANGE_CREATION    | FILE_NOTIFY_CHANGE_EA | \
715          FILE_NOTIFY_CHANGE_SECURITY    | FILE_NOTIFY_CHANGE_STREAM_NAME | \
716          FILE_NOTIFY_CHANGE_STREAM_SIZE | FILE_NOTIFY_CHANGE_STREAM_WRITE)
717
718 /* change notify action results */
719 #define NOTIFY_ACTION_ADDED 1
720 #define NOTIFY_ACTION_REMOVED 2
721 #define NOTIFY_ACTION_MODIFIED 3
722 #define NOTIFY_ACTION_OLD_NAME 4
723 #define NOTIFY_ACTION_NEW_NAME 5
724 #define NOTIFY_ACTION_ADDED_STREAM 6
725 #define NOTIFY_ACTION_REMOVED_STREAM 7
726 #define NOTIFY_ACTION_MODIFIED_STREAM 8
727
728
729 /* where to find the base of the SMB packet proper */
730 #define smb_base(buf) (((const char *)(buf))+4)
731
732 /* we don't allow server strings to be longer than 48 characters as
733    otherwise NT will not honour the announce packets */
734 #define MAX_SERVER_STRING_LENGTH 48
735
736
737 #define SMB_SUCCESS 0  /* The request was successful. */
738
739 #ifdef WITH_DFS
740 void dfs_unlogin(void);
741 extern int dcelogin_atmost_once;
742 #endif
743
744 #ifdef NOSTRDUP
745 char *strdup(char *s);
746 #endif
747
748 #ifndef SELECT_CAST
749 #define SELECT_CAST
750 #endif
751
752 /* This was set by JHT in liaison with Jeremy Allison early 1997
753  * History:
754  * Version 4.0 - never made public
755  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
756  *              - Reappeared in 1.9.16p11 with fixed smbd services
757  * Version 4.20 - To indicate that nmbd and browsing now works better
758  * Version 4.50 - Set at release of samba-2.2.0 by JHT
759  *
760  *  Note: In the presence of NT4.X do not set above 4.9
761  *        Setting this above 4.9 can have undesired side-effects.
762  *        This may change again in Samba-3.0 after further testing. JHT
763  */
764  
765 #define SAMBA_MAJOR_NBT_ANNOUNCE_VERSION 0x04
766 #define SAMBA_MINOR_NBT_ANNOUNCE_VERSION 0x09
767
768 /* Browser Election Values */
769 #define BROWSER_ELECTION_VERSION        0x010f
770 #define BROWSER_CONSTANT        0xaa55
771
772 /* TCONX Flag (smb_vwv2). */
773 #define TCONX_FLAG_EXTENDED_RESPONSE    0x8
774
775 /* File Status Flags. See:
776
777 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
778 */
779
780 #define NO_EAS                  0x1
781 #define NO_SUBSTREAMS           0x2
782 #define NO_REPARSETAG           0x4
783
784 /* printing types */
785 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
786                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
787                      PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
788 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
789 ,PRINT_TEST,PRINT_VLP
790 #endif /* DEVELOPER */
791 };
792
793 /* LDAP SSL options */
794 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
795
796 /* LDAP PASSWD SYNC methods */
797 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
798
799 /*
800  * This should be under the HAVE_KRB5 flag but since they're used
801  * in lp_kerberos_method(), they ned to be always available
802  * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
803  * so they remain accurate.
804  */
805
806 #define KERBEROS_VERIFY_SECRETS 0
807 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
808 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
809 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
810
811 /* Remote architectures we know about. */
812 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
813                         RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
814                         RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
815
816 /* case handling */
817 enum case_handling {CASE_LOWER,CASE_UPPER};
818
819 /* ACL compatibility */
820 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
821 /*
822  * Global value meaing that the smb_uid field should be
823  * ingored (in share level security and protocol level == CORE)
824  */
825
826 #define UID_FIELD_INVALID 0
827 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
828
829 /* 
830  * Size of buffer to use when moving files across filesystems. 
831  */
832 #define COPYBUF_SIZE (8*1024)
833
834 /*
835  * Map the Core and Extended Oplock requesst bits down
836  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
837  */
838
839 /*
840  * Core protocol.
841  */
842 #define CORE_OPLOCK_REQUEST(inbuf) \
843     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
844
845 /*
846  * Extended protocol.
847  */
848 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
849
850 /*
851  * Bits we test with.
852  * Note these must fit into 16-bits.
853  */
854
855 #define NO_OPLOCK                       OPLOCK_NONE
856 #define EXCLUSIVE_OPLOCK                OPLOCK_EXCLUSIVE
857 #define BATCH_OPLOCK                    OPLOCK_BATCH
858 #define LEVEL_II_OPLOCK                 OPLOCK_LEVEL_II
859
860 /* The following are Samba-private. */
861 #define INTERNAL_OPEN_ONLY              0x8
862 #define FAKE_LEVEL_II_OPLOCK            0x10    /* Client requested no_oplock, but we have to
863                                  * inform potential level2 holders on
864                                  * write. */
865 #define DEFERRED_OPEN_ENTRY             0x20
866 /* #define UNUSED_SHARE_MODE_ENTRY      0x40 */   /* Not used anymore */
867 #define FORCE_OPLOCK_BREAK_TO_NONE      0x80
868
869 /* None of the following should ever appear in fsp->oplock_request. */
870 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
871
872 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
873 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
874 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
875
876 /* kernel_oplock_message definition.
877
878 struct kernel_oplock_message {
879         uint64_t dev;
880         uint64_t inode;
881         unit64_t extid;
882         unsigned long file_id;
883 };
884
885 Offset  Data                  length.
886 0     uint64_t dev            8 bytes
887 8     uint64_t inode          8 bytes
888 16    uint64_t extid          8 bytes
889 24    unsigned long file_id   4 bytes
890 28
891
892 */
893 #define MSG_SMB_KERNEL_BREAK_SIZE 28
894
895 /* file_renamed_message definition.
896
897 struct file_renamed_message {
898         uint64_t dev;
899         uint64_t inode;
900         char names[1]; A variable area containing sharepath and filename.
901 };
902
903 Offset  Data                    length.
904 0       uint64_t dev            8 bytes
905 8       uint64_t inode          8 bytes
906 16      unit64_t extid          8 bytes
907 24      char [] name            zero terminated namelen bytes
908 minimum length == 24.
909
910 */
911
912 #define MSG_FILE_RENAMED_MIN_SIZE 24
913
914 /*
915  * On the wire return values for oplock types.
916  */
917
918 #define CORE_OPLOCK_GRANTED (1<<5)
919 #define EXTENDED_OPLOCK_GRANTED (1<<15)
920
921 #define NO_OPLOCK_RETURN 0
922 #define EXCLUSIVE_OPLOCK_RETURN 1
923 #define BATCH_OPLOCK_RETURN 2
924 #define LEVEL_II_OPLOCK_RETURN 3
925
926 /* Oplock levels */
927 #define OPLOCKLEVEL_NONE 0
928 #define OPLOCKLEVEL_II 1
929
930 /*
931  * Capabilities abstracted for different systems.
932  */
933
934 enum smbd_capability {
935     KERNEL_OPLOCK_CAPABILITY,
936     DMAPI_ACCESS_CAPABILITY,
937     LEASE_CAPABILITY
938 };
939
940 /*
941  * Kernel oplocks capability flags.
942  */
943
944 /* Level 2 oplocks are supported natively by kernel oplocks. */
945 #define KOPLOCKS_LEVEL2_SUPPORTED               0x1
946
947 /* The kernel notifies deferred openers when they can retry the open. */
948 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION     0x2
949
950 /* The kernel notifies smbds when an oplock break times out. */
951 #define KOPLOCKS_TIMEOUT_NOTIFICATION           0x4
952
953 /* The kernel notifies smbds when an oplock is broken. */
954 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION     0x8
955
956 struct kernel_oplocks_ops;
957 struct kernel_oplocks {
958         const struct kernel_oplocks_ops *ops;
959         uint32_t flags;
960         void *private_data;
961 };
962
963 enum level2_contention_type {
964         LEVEL2_CONTEND_ALLOC_SHRINK,
965         LEVEL2_CONTEND_ALLOC_GROW,
966         LEVEL2_CONTEND_SET_FILE_LEN,
967         LEVEL2_CONTEND_FILL_SPARSE,
968         LEVEL2_CONTEND_WRITE,
969         LEVEL2_CONTEND_WINDOWS_BRL,
970         LEVEL2_CONTEND_POSIX_BRL
971 };
972
973 /* if a kernel does support oplocks then a structure of the following
974    typee is used to describe how to interact with the kernel */
975 struct kernel_oplocks_ops {
976         bool (*set_oplock)(struct kernel_oplocks *ctx,
977                            files_struct *fsp, int oplock_type);
978         void (*release_oplock)(struct kernel_oplocks *ctx,
979                                files_struct *fsp, int oplock_type);
980         void (*contend_level2_oplocks_begin)(files_struct *fsp,
981                                              enum level2_contention_type type);
982         void (*contend_level2_oplocks_end)(files_struct *fsp,
983                                            enum level2_contention_type type);
984 };
985
986 #include "smb_macros.h"
987
988 #define MAX_NETBIOSNAME_LEN 16
989 /* DOS character, NetBIOS namestring. Type used on the wire. */
990 typedef char nstring[MAX_NETBIOSNAME_LEN];
991 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
992 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
993
994 /* A netbios name structure. */
995 struct nmb_name {
996         nstring      name;
997         char         scope[64];
998         unsigned int name_type;
999 };
1000
1001 /* A netbios node status array element. */
1002 struct node_status {
1003         nstring name;
1004         unsigned char type;
1005         unsigned char flags;
1006 };
1007
1008 /* The extra info from a NetBIOS node status query */
1009 struct node_status_extra {
1010         unsigned char mac_addr[6];
1011         /* There really is more here ... */ 
1012 };
1013
1014 typedef struct user_struct {
1015         struct user_struct *next, *prev;
1016         uint16 vuid; /* Tag for this entry. */
1017
1018         char *session_keystr; /* used by utmp and pam session code.  
1019                                  TDB key string */
1020         int homes_snum;
1021
1022         struct auth_session_info *session_info;
1023
1024         struct gensec_security *gensec_security;
1025 } user_struct;
1026
1027 /*
1028    Do you want session setups at user level security with a invalid
1029    password to be rejected or allowed in as guest? WinNT rejects them
1030    but it can be a pain as it means "net view" needs to use a password
1031
1032    You have 3 choices in the setting of map_to_guest:
1033
1034    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1035    are rejected. This is the default.
1036
1037    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1038    are rejected, unless the username does not exist, in which case it
1039    is treated as a guest login
1040
1041    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1042    are treated as a guest login
1043
1044    Note that map_to_guest only has an effect in user or server
1045    level security.
1046 */
1047
1048 #define NEVER_MAP_TO_GUEST              0
1049 #define MAP_TO_GUEST_ON_BAD_USER        1
1050 #define MAP_TO_GUEST_ON_BAD_PASSWORD    2
1051 #define MAP_TO_GUEST_ON_BAD_UID         3
1052
1053 #define SAFE_NETBIOS_CHARS ". -_"
1054
1055 /* The maximum length of a trust account password.
1056    Used when we randomly create it, 15 char passwords
1057    exceed NT4's max password length */
1058
1059 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1060
1061 #define PORT_NONE       0
1062 #ifndef LDAP_PORT
1063 #define LDAP_PORT       389
1064 #endif
1065 #define LDAP_GC_PORT    3268
1066
1067 /* used by the IP comparison function */
1068 struct ip_service {
1069         struct sockaddr_storage ss;
1070         unsigned port;
1071 };
1072
1073 struct ea_struct {
1074         uint8 flags;
1075         char *name;
1076         DATA_BLOB value;
1077 };
1078
1079 struct ea_list {
1080         struct ea_list *next, *prev;
1081         struct ea_struct ea;
1082 };
1083
1084 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1085 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1086 /* EA to use for DOS attributes */
1087 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1088 /* Prefix for DosStreams in the vfs_streams_xattr module */
1089 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1090 /* Prefix for xattrs storing streams. */
1091 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1092
1093 /* map readonly options */
1094 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1095
1096 /* usershare error codes. */
1097 enum usershare_err {
1098                 USERSHARE_OK=0,
1099                 USERSHARE_MALFORMED_FILE,
1100                 USERSHARE_BAD_VERSION,
1101                 USERSHARE_MALFORMED_PATH,
1102                 USERSHARE_MALFORMED_COMMENT_DEF,
1103                 USERSHARE_MALFORMED_ACL_DEF,
1104                 USERSHARE_ACL_ERR,
1105                 USERSHARE_PATH_NOT_ABSOLUTE,
1106                 USERSHARE_PATH_IS_DENIED,
1107                 USERSHARE_PATH_NOT_ALLOWED,
1108                 USERSHARE_PATH_NOT_DIRECTORY,
1109                 USERSHARE_POSIX_ERR,
1110                 USERSHARE_MALFORMED_SHARENAME_DEF,
1111                 USERSHARE_BAD_SHARENAME
1112 };
1113
1114 /* Different reasons for closing a file. */
1115 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1116
1117 /* Used in SMB_FS_OBJECTID_INFORMATION requests.  Must be exactly 48 bytes. */
1118 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1119 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1120 struct smb_extended_info {
1121         uint32 samba_magic;             /* Always SAMBA_EXTRA_INFO_MAGIC */
1122         uint32 samba_version;           /* Major/Minor/Release/Revision */
1123         uint32 samba_subversion;        /* Prerelease/RC/Vendor patch */
1124         NTTIME samba_gitcommitdate;
1125         char   samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1126 };
1127
1128 /* time info */
1129 struct smb_file_time {
1130         struct timespec mtime;
1131         struct timespec atime;
1132         struct timespec ctime;
1133         struct timespec create_time;
1134 };
1135
1136 /*
1137  * unix_convert_flags
1138  */
1139 #define UCF_SAVE_LCOMP                  0x00000001
1140 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP    0x00000002
1141 #define UCF_COND_ALLOW_WCARD_LCOMP      0x00000004
1142 #define UCF_POSIX_PATHNAMES             0x00000008
1143 #define UCF_UNIX_NAME_LOOKUP            0x00000010
1144
1145 /*
1146  * smb_filename
1147  */
1148 struct smb_filename {
1149         char *base_name;
1150         char *stream_name;
1151         char *original_lcomp;
1152         SMB_STRUCT_STAT st;
1153 };
1154
1155 /* Used to keep track of deferred opens. */
1156 struct deferred_open_record;
1157
1158 /* Used inside aio code. */
1159 struct aio_extra;
1160
1161 /*
1162  * Reasons for cache flush.
1163  */
1164
1165 enum flush_reason_enum {
1166     SEEK_FLUSH,
1167     READ_FLUSH,
1168     WRITE_FLUSH,
1169     READRAW_FLUSH,
1170     OPLOCK_RELEASE_FLUSH,
1171     CLOSE_FLUSH,
1172     SYNC_FLUSH,
1173     SIZECHANGE_FLUSH,
1174     /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */
1175     NUM_FLUSH_REASONS};
1176
1177 #endif /* _SMB_H */