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