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