Fix for CVE-2009-2906.
[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         bool processed;
731         DATA_BLOB buf;
732         DATA_BLOB private_data;
733 };
734
735 #define SHARE_MODE_FLAG_POSIX_OPEN      0x1
736
737 /* struct returned by get_share_modes */
738 struct share_mode_entry {
739         struct server_id pid;
740         uint16 op_mid;
741         uint16 op_type;
742         uint32 access_mask;             /* NTCreateX access bits (FILE_READ_DATA etc.) */
743         uint32 share_access;            /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
744         uint32 private_options; /* NT Create options, but we only look at
745                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
746                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
747                                  * smbstatus and swat */
748         struct timeval time;
749         struct file_id id;
750         unsigned long share_file_id;
751         uint32 uid;             /* uid of file opener. */
752         uint16 flags;           /* See SHARE_MODE_XX above. */
753 };
754
755 /* oplock break message definition - linearization of share_mode_entry.
756
757 Offset  Data                    length.
758 0       struct server_id pid    4
759 4       uint16 op_mid           2
760 6       uint16 op_type          2
761 8       uint32 access_mask      4
762 12      uint32 share_access     4
763 16      uint32 private_options  4
764 20      uint32 time sec         4
765 24      uint32 time usec        4
766 28      uint64 dev              8 bytes
767 36      uint64 inode            8 bytes
768 44      uint64 extid            8 bytes
769 52      unsigned long file_id   4 bytes
770 56      uint32 uid              4 bytes
771 60      uint16 flags            2 bytes
772 62
773
774 */
775 #ifdef CLUSTER_SUPPORT
776 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 66
777 #else
778 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 62
779 #endif
780
781 struct share_mode_lock {
782         const char *servicepath; /* canonicalized. */
783         const char *base_name;
784         const char *stream_name;
785         struct file_id id;
786         int num_share_modes;
787         struct share_mode_entry *share_modes;
788         UNIX_USER_TOKEN *delete_token;
789         bool delete_on_close;
790         struct timespec old_write_time;
791         struct timespec changed_write_time;
792         bool fresh;
793         bool modified;
794         struct db_record *record;
795 };
796
797 /*
798  * Internal structure of locking.tdb share mode db.
799  * Used by locking.c and libsmbsharemodes.c
800  */
801
802 struct locking_data {
803         union {
804                 struct {
805                         int num_share_mode_entries;
806                         bool delete_on_close;
807                         struct timespec old_write_time;
808                         struct timespec changed_write_time;
809                         uint32 delete_token_size; /* Only valid if either of
810                                                      the two previous fields
811                                                      are True. */
812                 } s;
813                 struct share_mode_entry dummy; /* Needed for alignment. */
814         } u;
815         /* The following four entries are implicit
816            struct share_mode_entry modes[num_share_mode_entries];
817            char unix_token[delete_token_size] (divisible by 4).
818            char share_name[];
819            char file_name[];
820         */
821 };
822
823 /* Used to store pipe open records for NetFileEnum() */
824
825 struct pipe_open_rec {
826         struct server_id pid;
827         uid_t uid;
828         int pnum;
829         fstring name;
830 };
831
832
833 #define NT_HASH_LEN 16
834 #define LM_HASH_LEN 16
835
836 /* Password history contants. */
837 #define PW_HISTORY_SALT_LEN 16
838 #define SALTED_MD5_HASH_LEN 16
839 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
840 #define MAX_PW_HISTORY_LEN 24
841
842 /*
843  * Flags for local user manipulation.
844  */
845
846 #define LOCAL_ADD_USER 0x1
847 #define LOCAL_DELETE_USER 0x2
848 #define LOCAL_DISABLE_USER 0x4
849 #define LOCAL_ENABLE_USER 0x8
850 #define LOCAL_TRUST_ACCOUNT 0x10
851 #define LOCAL_SET_NO_PASSWORD 0x20
852 #define LOCAL_SET_PASSWORD 0x40
853 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
854 #define LOCAL_INTERDOM_ACCOUNT 0x100
855 #define LOCAL_AM_ROOT 0x200  /* Act as root */
856
857 /* key and data in the connections database - used in smbstatus and smbd */
858 struct connections_key {
859         struct server_id pid;
860         int cnum;
861         fstring name;
862 };
863
864 struct connections_data {
865         int magic;
866         struct server_id pid;
867         int cnum;
868         uid_t uid;
869         gid_t gid;
870         char servicename[FSTRING_LEN];
871         char addr[24];
872         char machine[FSTRING_LEN];
873         time_t start;
874         uint32 bcast_msg_flags;
875 };
876
877
878 /* the following are used by loadparm for option lists */
879 typedef enum {
880         P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
881         P_STRING,P_USTRING,P_ENUM,P_SEP
882 } parm_type;
883
884 typedef enum {
885         P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
886 } parm_class;
887
888 struct enum_list {
889         int value;
890         const char *name;
891 };
892
893 struct parm_struct {
894         const char *label;
895         parm_type type;
896         parm_class p_class;
897         void *ptr;
898         bool (*special)(int snum, const char *, char **);
899         const struct enum_list *enum_list;
900         unsigned flags;
901         union {
902                 bool bvalue;
903                 int ivalue;
904                 char *svalue;
905                 char cvalue;
906                 char **lvalue;
907         } def;
908 };
909
910 /* The following flags are used in SWAT */
911 #define FLAG_BASIC      0x0001 /* Display only in BASIC view */
912 #define FLAG_SHARE      0x0002 /* file sharing options */
913 #define FLAG_PRINT      0x0004 /* printing options */
914 #define FLAG_GLOBAL     0x0008 /* local options that should be globally settable in SWAT */
915 #define FLAG_WIZARD     0x0010 /* Parameters that the wizard will operate on */
916 #define FLAG_ADVANCED   0x0020 /* Parameters that will be visible in advanced view */
917 #define FLAG_DEVELOPER  0x0040 /* No longer used */
918 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
919 #define FLAG_HIDE       0x2000 /* options that should be hidden in SWAT */
920 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
921 #define FLAG_META       0x8000 /* A meta directive - not a real parameter */
922
923 struct bitmap {
924         uint32 *b;
925         unsigned int n;
926 };
927
928 /* offsets into message for common items */
929 #define smb_com 8
930 #define smb_rcls 9
931 #define smb_reh 10
932 #define smb_err 11
933 #define smb_flg 13
934 #define smb_flg2 14
935 #define smb_pidhigh 16
936 #define smb_ss_field 18
937 #define smb_tid 28
938 #define smb_pid 30
939 #define smb_uid 32
940 #define smb_mid 34
941 #define smb_wct 36
942 #define smb_vwv 37
943 #define smb_vwv0 37
944 #define smb_vwv1 39
945 #define smb_vwv2 41
946 #define smb_vwv3 43
947 #define smb_vwv4 45
948 #define smb_vwv5 47
949 #define smb_vwv6 49
950 #define smb_vwv7 51
951 #define smb_vwv8 53
952 #define smb_vwv9 55
953 #define smb_vwv10 57
954 #define smb_vwv11 59
955 #define smb_vwv12 61
956 #define smb_vwv13 63
957 #define smb_vwv14 65
958 #define smb_vwv15 67
959 #define smb_vwv16 69
960 #define smb_vwv17 71
961
962 /* flag defines. CIFS spec 3.1.1 */
963 #define FLAG_SUPPORT_LOCKREAD       0x01
964 #define FLAG_CLIENT_BUF_AVAIL       0x02
965 #define FLAG_RESERVED               0x04
966 #define FLAG_CASELESS_PATHNAMES     0x08
967 #define FLAG_CANONICAL_PATHNAMES    0x10
968 #define FLAG_REQUEST_OPLOCK         0x20
969 #define FLAG_REQUEST_BATCH_OPLOCK   0x40
970 #define FLAG_REPLY                  0x80
971
972 /* the complete */
973 #define SMBmkdir      0x00   /* create directory */
974 #define SMBrmdir      0x01   /* delete directory */
975 #define SMBopen       0x02   /* open file */
976 #define SMBcreate     0x03   /* create file */
977 #define SMBclose      0x04   /* close file */
978 #define SMBflush      0x05   /* flush file */
979 #define SMBunlink     0x06   /* delete file */
980 #define SMBmv         0x07   /* rename file */
981 #define SMBgetatr     0x08   /* get file attributes */
982 #define SMBsetatr     0x09   /* set file attributes */
983 #define SMBread       0x0A   /* read from file */
984 #define SMBwrite      0x0B   /* write to file */
985 #define SMBlock       0x0C   /* lock byte range */
986 #define SMBunlock     0x0D   /* unlock byte range */
987 #define SMBctemp      0x0E   /* create temporary file */
988 #define SMBmknew      0x0F   /* make new file */
989 #define SMBcheckpath  0x10   /* check directory path */
990 #define SMBexit       0x11   /* process exit */
991 #define SMBlseek      0x12   /* seek */
992 #define SMBtcon       0x70   /* tree connect */
993 #define SMBtconX      0x75   /* tree connect and X*/
994 #define SMBtdis       0x71   /* tree disconnect */
995 #define SMBnegprot    0x72   /* negotiate protocol */
996 #define SMBdskattr    0x80   /* get disk attributes */
997 #define SMBsearch     0x81   /* search directory */
998 #define SMBsplopen    0xC0   /* open print spool file */
999 #define SMBsplwr      0xC1   /* write to print spool file */
1000 #define SMBsplclose   0xC2   /* close print spool file */
1001 #define SMBsplretq    0xC3   /* return print queue */
1002 #define SMBsends      0xD0   /* send single block message */
1003 #define SMBsendb      0xD1   /* send broadcast message */
1004 #define SMBfwdname    0xD2   /* forward user name */
1005 #define SMBcancelf    0xD3   /* cancel forward */
1006 #define SMBgetmac     0xD4   /* get machine name */
1007 #define SMBsendstrt   0xD5   /* send start of multi-block message */
1008 #define SMBsendend    0xD6   /* send end of multi-block message */
1009 #define SMBsendtxt    0xD7   /* send text of multi-block message */
1010
1011 /* Core+ protocol */
1012 #define SMBlockread       0x13   /* Lock a range and read */
1013 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1014 #define SMBreadbraw   0x1a  /* read a block of data with no smb header */
1015 #define SMBwritebraw  0x1d  /* write a block of data with no smb header */
1016 #define SMBwritec     0x20  /* secondary write request */
1017 #define SMBwriteclose 0x2c  /* write a file then close it */
1018
1019 /* dos extended protocol */
1020 #define SMBreadBraw      0x1A   /* read block raw */
1021 #define SMBreadBmpx      0x1B   /* read block multiplexed */
1022 #define SMBreadBs        0x1C   /* read block (secondary response) */
1023 #define SMBwriteBraw     0x1D   /* write block raw */
1024 #define SMBwriteBmpx     0x1E   /* write block multiplexed */
1025 #define SMBwriteBs       0x1F   /* write block (secondary request) */
1026 #define SMBwriteC        0x20   /* write complete response */
1027 #define SMBsetattrE      0x22   /* set file attributes expanded */
1028 #define SMBgetattrE      0x23   /* get file attributes expanded */
1029 #define SMBlockingX      0x24   /* lock/unlock byte ranges and X */
1030 #define SMBtrans         0x25   /* transaction - name, bytes in/out */
1031 #define SMBtranss        0x26   /* transaction (secondary request/response) */
1032 #define SMBioctl         0x27   /* IOCTL */
1033 #define SMBioctls        0x28   /* IOCTL  (secondary request/response) */
1034 #define SMBcopy          0x29   /* copy */
1035 #define SMBmove          0x2A   /* move */
1036 #define SMBecho          0x2B   /* echo */
1037 #define SMBopenX         0x2D   /* open and X */
1038 #define SMBreadX         0x2E   /* read and X */
1039 #define SMBwriteX        0x2F   /* write and X */
1040 #define SMBsesssetupX    0x73   /* Session Set Up & X (including User Logon) */
1041 #define SMBffirst        0x82   /* find first */
1042 #define SMBfunique       0x83   /* find unique */
1043 #define SMBfclose        0x84   /* find close */
1044 #define SMBkeepalive     0x85   /* keepalive */
1045 #define SMBinvalid       0xFE   /* invalid command */
1046
1047 /* Extended 2.0 protocol */
1048 #define SMBtrans2        0x32   /* TRANS2 protocol set */
1049 #define SMBtranss2       0x33   /* TRANS2 protocol set, secondary command */
1050 #define SMBfindclose     0x34   /* Terminate a TRANSACT2_FINDFIRST */
1051 #define SMBfindnclose    0x35   /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1052 #define SMBulogoffX      0x74   /* user logoff */
1053
1054 /* NT SMB extensions. */
1055 #define SMBnttrans       0xA0   /* NT transact */
1056 #define SMBnttranss      0xA1   /* NT transact secondary */
1057 #define SMBntcreateX     0xA2   /* NT create and X */
1058 #define SMBntcancel      0xA4   /* NT cancel */
1059 #define SMBntrename      0xA5   /* NT rename */
1060
1061 /* These are the trans subcommands */
1062 #define TRANSACT_SETNAMEDPIPEHANDLESTATE  0x01 
1063 #define TRANSACT_DCERPCCMD                0x26
1064 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1065
1066 /* These are the TRANS2 sub commands */
1067 #define TRANSACT2_OPEN                          0x00
1068 #define TRANSACT2_FINDFIRST                     0x01
1069 #define TRANSACT2_FINDNEXT                      0x02
1070 #define TRANSACT2_QFSINFO                       0x03
1071 #define TRANSACT2_SETFSINFO                     0x04
1072 #define TRANSACT2_QPATHINFO                     0x05
1073 #define TRANSACT2_SETPATHINFO                   0x06
1074 #define TRANSACT2_QFILEINFO                     0x07
1075 #define TRANSACT2_SETFILEINFO                   0x08
1076 #define TRANSACT2_FSCTL                         0x09
1077 #define TRANSACT2_IOCTL                         0x0A
1078 #define TRANSACT2_FINDNOTIFYFIRST               0x0B
1079 #define TRANSACT2_FINDNOTIFYNEXT                0x0C
1080 #define TRANSACT2_MKDIR                         0x0D
1081 #define TRANSACT2_SESSION_SETUP                 0x0E
1082 #define TRANSACT2_GET_DFS_REFERRAL              0x10
1083 #define TRANSACT2_REPORT_DFS_INCONSISTANCY      0x11
1084
1085 /* These are the NT transact sub commands. */
1086 #define NT_TRANSACT_CREATE                1
1087 #define NT_TRANSACT_IOCTL                 2
1088 #define NT_TRANSACT_SET_SECURITY_DESC     3
1089 #define NT_TRANSACT_NOTIFY_CHANGE         4
1090 #define NT_TRANSACT_RENAME                5
1091 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
1092 #define NT_TRANSACT_GET_USER_QUOTA        7
1093 #define NT_TRANSACT_SET_USER_QUOTA        8
1094
1095 /* These are the NT transact_get_user_quota sub commands */
1096 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE   0x0000
1097 #define TRANSACT_GET_USER_QUOTA_LIST_START      0x0100
1098 #define TRANSACT_GET_USER_QUOTA_FOR_SID         0x0101
1099
1100 /* Relevant IOCTL codes */
1101 #define IOCTL_QUERY_JOB_INFO      0x530060
1102
1103 /* these are the trans2 sub fields for primary requests */
1104 #define smb_tpscnt smb_vwv0
1105 #define smb_tdscnt smb_vwv1
1106 #define smb_mprcnt smb_vwv2
1107 #define smb_mdrcnt smb_vwv3
1108 #define smb_msrcnt smb_vwv4
1109 #define smb_flags smb_vwv5
1110 #define smb_timeout smb_vwv6
1111 #define smb_pscnt smb_vwv9
1112 #define smb_psoff smb_vwv10
1113 #define smb_dscnt smb_vwv11
1114 #define smb_dsoff smb_vwv12
1115 #define smb_suwcnt smb_vwv13
1116 #define smb_setup smb_vwv14
1117 #define smb_setup0 smb_setup
1118 #define smb_setup1 (smb_setup+2)
1119 #define smb_setup2 (smb_setup+4)
1120
1121 /* these are for the secondary requests */
1122 #define smb_spscnt smb_vwv2
1123 #define smb_spsoff smb_vwv3
1124 #define smb_spsdisp smb_vwv4
1125 #define smb_sdscnt smb_vwv5
1126 #define smb_sdsoff smb_vwv6
1127 #define smb_sdsdisp smb_vwv7
1128 #define smb_sfid smb_vwv8
1129
1130 /* and these for responses */
1131 #define smb_tprcnt smb_vwv0
1132 #define smb_tdrcnt smb_vwv1
1133 #define smb_prcnt smb_vwv3
1134 #define smb_proff smb_vwv4
1135 #define smb_prdisp smb_vwv5
1136 #define smb_drcnt smb_vwv6
1137 #define smb_droff smb_vwv7
1138 #define smb_drdisp smb_vwv8
1139
1140 /* these are for the NT trans primary request. */
1141 #define smb_nt_MaxSetupCount smb_vwv0
1142 #define smb_nt_Flags (smb_vwv0 + 1)
1143 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1144 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1145 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1146 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1147 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1148 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1149 #define smb_nt_DataCount (smb_vwv0 + 27)
1150 #define smb_nt_DataOffset (smb_vwv0 + 31)
1151 #define smb_nt_SetupCount (smb_vwv0 + 35)
1152 #define smb_nt_Function (smb_vwv0 + 36)
1153 #define smb_nt_SetupStart (smb_vwv0 + 38)
1154
1155 /* these are for the NT trans secondary request. */
1156 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1157 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1158 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1159 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1160 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1161 #define smb_nts_DataCount (smb_vwv0 + 23)
1162 #define smb_nts_DataOffset (smb_vwv0 + 27)
1163 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1164
1165 /* these are for the NT trans reply. */
1166 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1167 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1168 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1169 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1170 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1171 #define smb_ntr_DataCount (smb_vwv0 + 23)
1172 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1173 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1174
1175 /* these are for the NT create_and_X */
1176 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1177 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1178 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1179 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1180 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1181 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1182 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1183 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1184 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1185 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1186 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1187
1188 /* this is used on a TConX. I'm not sure the name is very helpful though */
1189 #define SMB_SUPPORT_SEARCH_BITS        0x0001
1190 #define SMB_SHARE_IN_DFS               0x0002
1191
1192 /* Named pipe write mode flags. Used in writeX calls. */
1193 #define PIPE_RAW_MODE 0x4
1194 #define PIPE_START_MESSAGE 0x8
1195
1196 /* File Specific access rights */
1197 #define FILE_READ_DATA        0x00000001
1198 #define FILE_WRITE_DATA       0x00000002
1199 #define FILE_APPEND_DATA      0x00000004
1200 #define FILE_READ_EA          0x00000008 /* File and directory */
1201 #define FILE_WRITE_EA         0x00000010 /* File and directory */
1202 #define FILE_EXECUTE          0x00000020
1203 #define FILE_DELETE_CHILD     0x00000040
1204 #define FILE_READ_ATTRIBUTES  0x00000080
1205 #define FILE_WRITE_ATTRIBUTES 0x00000100
1206
1207 #define FILE_ALL_ACCESS       0x000001FF
1208
1209 /* Directory specific access rights */
1210 #define FILE_LIST_DIRECTORY   0x00000001
1211 #define FILE_ADD_FILE         0x00000002
1212 #define FILE_ADD_SUBDIRECTORY 0x00000004
1213 #define FILE_TRAVERSE         0x00000020
1214 #define FILE_DELETE_CHILD     0x00000040
1215
1216 /* the desired access to use when opening a pipe */
1217 #define DESIRED_ACCESS_PIPE 0x2019f
1218  
1219 /* Generic access masks & rights. */
1220 #define DELETE_ACCESS        0x00010000 /* (1L<<16) */
1221 #define READ_CONTROL_ACCESS  0x00020000 /* (1L<<17) */
1222 #define WRITE_DAC_ACCESS     0x00040000 /* (1L<<18) */
1223 #define WRITE_OWNER_ACCESS   0x00080000 /* (1L<<19) */
1224 #define SYNCHRONIZE_ACCESS   0x00100000 /* (1L<<20) */
1225
1226 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1227 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1228 #define GENERIC_ALL_ACCESS     0x10000000 /* (1<<28) */
1229 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1230 #define GENERIC_WRITE_ACCESS   0x40000000 /* (1<<30) */
1231 #define GENERIC_READ_ACCESS    ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1232
1233 /* Mapping of generic access rights for files to specific rights. */
1234
1235 /* This maps to 0x1F01FF */
1236 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS|\
1237                           SYNCHRONIZE_ACCESS|\
1238                           FILE_ALL_ACCESS)
1239
1240 /* This maps to 0x120089 */
1241 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|\
1242                            FILE_READ_DATA|\
1243                            FILE_READ_ATTRIBUTES|\
1244                            FILE_READ_EA|\
1245                            SYNCHRONIZE_ACCESS)
1246
1247 /* This maps to 0x120116 */
1248 #define FILE_GENERIC_WRITE (STD_RIGHT_READ_CONTROL_ACCESS|\
1249                             FILE_WRITE_DATA|\
1250                             FILE_WRITE_ATTRIBUTES|\
1251                             FILE_WRITE_EA|\
1252                             FILE_APPEND_DATA|\
1253                             SYNCHRONIZE_ACCESS)
1254
1255 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|\
1256                               FILE_READ_ATTRIBUTES|\
1257                               FILE_EXECUTE|\
1258                               SYNCHRONIZE_ACCESS)
1259
1260 /* Share specific rights. */
1261 #define SHARE_ALL_ACCESS      FILE_GENERIC_ALL
1262 #define SHARE_READ_ONLY       (FILE_GENERIC_READ|FILE_EXECUTE)
1263
1264 /* Mapping of access rights to UNIX perms. */
1265 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
1266 #define UNIX_ACCESS_R           FILE_GENERIC_READ
1267 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
1268 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
1269
1270 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1271 #define UNIX_DIRECTORY_ACCESS_RWX               FILE_GENERIC_ALL
1272 #define UNIX_DIRECTORY_ACCESS_R                 FILE_GENERIC_READ
1273 #define UNIX_DIRECTORY_ACCESS_W                 (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1274 #define UNIX_DIRECTORY_ACCESS_X                 FILE_GENERIC_EXECUTE
1275
1276 #if 0
1277 /*
1278  * This is the old mapping we used to use. To get W2KSP2 profiles
1279  * working we need to map to the canonical file perms.
1280  */
1281 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1282 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1283                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1284 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1285                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1286                         FILE_APPEND_DATA|FILE_WRITE_DATA)
1287 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1288                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1289 #endif
1290
1291 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1292
1293 /* Flags field. */
1294 #define REQUEST_OPLOCK 2
1295 #define REQUEST_BATCH_OPLOCK 4
1296 #define OPEN_DIRECTORY 8
1297 #define EXTENDED_RESPONSE_REQUIRED 0x10
1298
1299 /* ShareAccess field. */
1300 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1301 #define FILE_SHARE_READ 1
1302 #define FILE_SHARE_WRITE 2
1303 #define FILE_SHARE_DELETE 4
1304
1305 /* FileAttributesField */
1306 #define FILE_ATTRIBUTE_READONLY         0x001L
1307 #define FILE_ATTRIBUTE_HIDDEN           0x002L
1308 #define FILE_ATTRIBUTE_SYSTEM           0x004L
1309 #define FILE_ATTRIBUTE_DIRECTORY        0x010L
1310 #define FILE_ATTRIBUTE_ARCHIVE          0x020L
1311 #define FILE_ATTRIBUTE_NORMAL           0x080L
1312 #define FILE_ATTRIBUTE_TEMPORARY        0x100L
1313 #define FILE_ATTRIBUTE_SPARSE           0x200L
1314 #define FILE_ATTRIBUTE_REPARSE_POINT    0x400L
1315 #define FILE_ATTRIBUTE_COMPRESSED       0x800L
1316 #define FILE_ATTRIBUTE_OFFLINE          0x1000L
1317 #define FILE_ATTRIBUTE_NONINDEXED       0x2000L
1318 #define FILE_ATTRIBUTE_ENCRYPTED        0x4000L
1319 #define SAMBA_ATTRIBUTES_MASK           0x7F
1320
1321 /* Flags - combined with attributes. */
1322 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
1323 #define FILE_FLAG_NO_BUFFERING     0x20000000L
1324 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
1325 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
1326 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
1327 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1328 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
1329
1330 /* CreateDisposition field. */
1331 #define FILE_SUPERSEDE 0                /* File exists overwrite/supersede. File not exist create. */
1332 #define FILE_OPEN 1                     /* File exists open. File not exist fail. */
1333 #define FILE_CREATE 2                   /* File exists fail. File not exist create. */
1334 #define FILE_OPEN_IF 3                  /* File exists open. File not exist create. */
1335 #define FILE_OVERWRITE 4                /* File exists overwrite. File not exist fail. */
1336 #define FILE_OVERWRITE_IF 5             /* File exists overwrite. File not exist create. */
1337
1338 /* CreateOptions field. */
1339 #define FILE_DIRECTORY_FILE       0x0001
1340 #define FILE_WRITE_THROUGH        0x0002
1341 #define FILE_SEQUENTIAL_ONLY      0x0004
1342 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1343 #define FILE_SYNCHRONOUS_IO_ALERT      0x0010   /* may be ignored */
1344 #define FILE_SYNCHRONOUS_IO_NONALERT   0x0020   /* may be ignored */
1345 #define FILE_NON_DIRECTORY_FILE   0x0040
1346 #define FILE_CREATE_TREE_CONNECTION    0x0080   /* ignore, should be zero */
1347 #define FILE_COMPLETE_IF_OPLOCKED      0x0100   /* ignore, should be zero */
1348 #define FILE_NO_EA_KNOWLEDGE      0x0200
1349 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1350 #define FILE_RANDOM_ACCESS        0x0800
1351 #define FILE_DELETE_ON_CLOSE      0x1000
1352 #define FILE_OPEN_BY_FILE_ID      0x2000
1353 #define FILE_OPEN_FOR_BACKUP_INTENT    0x4000
1354 #define FILE_NO_COMPRESSION       0x8000
1355 #define FILE_RESERVER_OPFILTER    0x00100000    /* ignore, should be zero */
1356 #define FILE_OPEN_REPARSE_POINT   0x00200000
1357 #define FILE_OPEN_NO_RECALL       0x00400000
1358 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1359
1360 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK      (0x008F0480)
1361
1362 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK    (0xFF100030)
1363
1364 /*
1365  * Private create options used by the ntcreatex processing code. From Samba4.
1366  * We reuse some ignored flags for private use.
1367  */
1368 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS     0x00010000
1369 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB     0x00020000
1370
1371 /* Private options for streams support */
1372 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x00040000
1373
1374 /* Responses when opening a file. */
1375 #define FILE_WAS_SUPERSEDED 0
1376 #define FILE_WAS_OPENED 1
1377 #define FILE_WAS_CREATED 2
1378 #define FILE_WAS_OVERWRITTEN 3
1379
1380 /* File type flags */
1381 #define FILE_TYPE_DISK  0
1382 #define FILE_TYPE_BYTE_MODE_PIPE 1
1383 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1384 #define FILE_TYPE_PRINTER 3
1385 #define FILE_TYPE_COMM_DEVICE 4
1386 #define FILE_TYPE_UNKNOWN 0xFFFF
1387
1388 /* Flag for NT transact rename call. */
1389 #define RENAME_REPLACE_IF_EXISTS 1
1390
1391 /* flags for SMBntrename call (from Samba4) */
1392 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1393 #define RENAME_FLAG_HARD_LINK                0x103
1394 #define RENAME_FLAG_RENAME                   0x104
1395 #define RENAME_FLAG_COPY                     0x105
1396
1397 /* Filesystem Attributes. */
1398 #define FILE_CASE_SENSITIVE_SEARCH      0x00000001
1399 #define FILE_CASE_PRESERVED_NAMES       0x00000002
1400 #define FILE_UNICODE_ON_DISK            0x00000004
1401 /* According to cifs9f, this is 4, not 8 */
1402 /* Acconding to testing, this actually sets the security attribute! */
1403 #define FILE_PERSISTENT_ACLS            0x00000008
1404 #define FILE_FILE_COMPRESSION           0x00000010
1405 #define FILE_VOLUME_QUOTAS              0x00000020
1406 #define FILE_SUPPORTS_SPARSE_FILES      0x00000040
1407 #define FILE_SUPPORTS_REPARSE_POINTS    0x00000080
1408 #define FILE_SUPPORTS_REMOTE_STORAGE    0x00000100
1409 #define FS_LFN_APIS                     0x00004000
1410 #define FILE_VOLUME_IS_COMPRESSED       0x00008000
1411 #define FILE_SUPPORTS_OBJECT_IDS        0x00010000
1412 #define FILE_SUPPORTS_ENCRYPTION        0x00020000
1413 #define FILE_NAMED_STREAMS              0x00040000
1414 #define FILE_READ_ONLY_VOLUME           0x00080000
1415
1416 /* ChangeNotify flags. */
1417 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x001
1418 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
1419 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
1420 #define FILE_NOTIFY_CHANGE_SIZE        0x008
1421 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
1422 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1423 #define FILE_NOTIFY_CHANGE_CREATION    0x040
1424 #define FILE_NOTIFY_CHANGE_EA          0x080
1425 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
1426 #define FILE_NOTIFY_CHANGE_STREAM_NAME  0x00000200
1427 #define FILE_NOTIFY_CHANGE_STREAM_SIZE  0x00000400
1428 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1429
1430 #define FILE_NOTIFY_CHANGE_NAME \
1431         (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1432
1433 /* change notify action results */
1434 #define NOTIFY_ACTION_ADDED 1
1435 #define NOTIFY_ACTION_REMOVED 2
1436 #define NOTIFY_ACTION_MODIFIED 3
1437 #define NOTIFY_ACTION_OLD_NAME 4
1438 #define NOTIFY_ACTION_NEW_NAME 5
1439 #define NOTIFY_ACTION_ADDED_STREAM 6
1440 #define NOTIFY_ACTION_REMOVED_STREAM 7
1441 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1442
1443
1444 /* where to find the base of the SMB packet proper */
1445 #define smb_base(buf) (((char *)(buf))+4)
1446
1447 /* we don't allow server strings to be longer than 48 characters as
1448    otherwise NT will not honour the announce packets */
1449 #define MAX_SERVER_STRING_LENGTH 48
1450
1451
1452 #define SMB_SUCCESS 0  /* The request was successful. */
1453
1454 #ifdef WITH_DFS
1455 void dfs_unlogin(void);
1456 extern int dcelogin_atmost_once;
1457 #endif
1458
1459 #ifdef NOSTRDUP
1460 char *strdup(char *s);
1461 #endif
1462
1463 #ifndef SIGNAL_CAST
1464 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1465 #endif
1466
1467 #ifndef SELECT_CAST
1468 #define SELECT_CAST
1469 #endif
1470
1471 /* This was set by JHT in liaison with Jeremy Allison early 1997
1472  * History:
1473  * Version 4.0 - never made public
1474  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1475  *              - Reappeared in 1.9.16p11 with fixed smbd services
1476  * Version 4.20 - To indicate that nmbd and browsing now works better
1477  * Version 4.50 - Set at release of samba-2.2.0 by JHT
1478  *
1479  *  Note: In the presence of NT4.X do not set above 4.9
1480  *        Setting this above 4.9 can have undesired side-effects.
1481  *        This may change again in Samba-3.0 after further testing. JHT
1482  */
1483  
1484 #define DEFAULT_MAJOR_VERSION 0x04
1485 #define DEFAULT_MINOR_VERSION 0x09
1486
1487 /* Browser Election Values */
1488 #define BROWSER_ELECTION_VERSION        0x010f
1489 #define BROWSER_CONSTANT        0xaa55
1490
1491 /* Sercurity mode bits. */
1492 #define NEGOTIATE_SECURITY_USER_LEVEL           0x01
1493 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE   0x02
1494 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED   0x04
1495 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED  0x08
1496
1497 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1498    
1499 #define FLAGS2_LONG_PATH_COMPONENTS    0x0001
1500 #define FLAGS2_EXTENDED_ATTRIBUTES     0x0002
1501 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1502 #define FLAGS2_UNKNOWN_BIT4            0x0010
1503 #define FLAGS2_IS_LONG_NAME            0x0040
1504 #define FLAGS2_EXTENDED_SECURITY       0x0800 
1505 #define FLAGS2_DFS_PATHNAMES           0x1000
1506 #define FLAGS2_READ_PERMIT_EXECUTE     0x2000
1507 #define FLAGS2_32_BIT_ERROR_CODES      0x4000 
1508 #define FLAGS2_UNICODE_STRINGS         0x8000
1509
1510 #define FLAGS2_WIN2K_SIGNATURE         0xC852 /* Hack alert ! For now... JRA. */
1511
1512 /* TCONX Flag (smb_vwv2). */
1513 #define TCONX_FLAG_EXTENDED_RESPONSE    0x8
1514
1515 /* File Status Flags. See:
1516
1517 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1518 */
1519
1520 #define NO_EAS                  0x1
1521 #define NO_SUBSTREAMS           0x2
1522 #define NO_REPARSETAG           0x4
1523
1524 /* Capabilities.  see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1525
1526 #define CAP_RAW_MODE         0x0001
1527 #define CAP_MPX_MODE         0x0002
1528 #define CAP_UNICODE          0x0004
1529 #define CAP_LARGE_FILES      0x0008
1530 #define CAP_NT_SMBS          0x0010
1531 #define CAP_RPC_REMOTE_APIS  0x0020
1532 #define CAP_STATUS32         0x0040
1533 #define CAP_LEVEL_II_OPLOCKS 0x0080
1534 #define CAP_LOCK_AND_READ    0x0100
1535 #define CAP_NT_FIND          0x0200
1536 #define CAP_DFS              0x1000
1537 #define CAP_W2K_SMBS         0x2000
1538 #define CAP_LARGE_READX      0x4000
1539 #define CAP_LARGE_WRITEX     0x8000
1540 #define CAP_UNIX             0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1541 #define CAP_EXTENDED_SECURITY 0x80000000
1542
1543 /* protocol types. It assumes that higher protocols include lower protocols
1544    as subsets */
1545 enum protocol_types {
1546         PROTOCOL_NONE,
1547         PROTOCOL_CORE,
1548         PROTOCOL_COREPLUS,
1549         PROTOCOL_LANMAN1,
1550         PROTOCOL_LANMAN2,
1551         PROTOCOL_NT1,
1552         PROTOCOL_SMB2
1553 };
1554
1555 /* security levels */
1556 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1557
1558 /* server roles */
1559 enum server_types {
1560         ROLE_STANDALONE,
1561         ROLE_DOMAIN_MEMBER,
1562         ROLE_DOMAIN_BDC,
1563         ROLE_DOMAIN_PDC
1564 };
1565
1566 /* printing types */
1567 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1568                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1569                      PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1570 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1571 ,PRINT_TEST,PRINT_VLP
1572 #endif /* DEVELOPER */
1573 };
1574
1575 /* LDAP schema types */
1576 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1577
1578 /* LDAP SSL options */
1579 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1580
1581 /* LDAP PASSWD SYNC methods */
1582 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1583
1584 /* Remote architectures we know about. */
1585 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1586                         RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1587                         RA_SAMBA, RA_CIFSFS, RA_WINXP64};
1588
1589 /* case handling */
1590 enum case_handling {CASE_LOWER,CASE_UPPER};
1591
1592 /* ACL compatibility */
1593 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1594 /*
1595  * Global value meaing that the smb_uid field should be
1596  * ingored (in share level security and protocol level == CORE)
1597  */
1598
1599 #define UID_FIELD_INVALID 0
1600 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1601
1602 /* 
1603  * Size of buffer to use when moving files across filesystems. 
1604  */
1605 #define COPYBUF_SIZE (8*1024)
1606
1607 /*
1608  * Map the Core and Extended Oplock requesst bits down
1609  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1610  */
1611
1612 /*
1613  * Core protocol.
1614  */
1615 #define CORE_OPLOCK_REQUEST(inbuf) \
1616     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1617
1618 /*
1619  * Extended protocol.
1620  */
1621 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1622
1623 /* Lock types. */
1624 #define LOCKING_ANDX_SHARED_LOCK 0x1
1625 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1626 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1627 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1628 #define LOCKING_ANDX_LARGE_FILES 0x10
1629
1630 /*
1631  * Bits we test with.
1632  * Note these must fit into 16-bits.
1633  */
1634
1635 #define NO_OPLOCK                       0x0
1636 #define EXCLUSIVE_OPLOCK                0x1
1637 #define BATCH_OPLOCK                    0x2
1638 #define LEVEL_II_OPLOCK                 0x4
1639
1640 /* The following are Samba-private. */
1641 #define INTERNAL_OPEN_ONLY              0x8
1642 #define FAKE_LEVEL_II_OPLOCK            0x10    /* Client requested no_oplock, but we have to
1643                                  * inform potential level2 holders on
1644                                  * write. */
1645 #define DEFERRED_OPEN_ENTRY             0x20
1646 #define UNUSED_SHARE_MODE_ENTRY         0x40
1647 #define FORCE_OPLOCK_BREAK_TO_NONE      0x80
1648
1649 /* None of the following should ever appear in fsp->oplock_request. */
1650 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1651
1652 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1653 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1654 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1655
1656 /* kernel_oplock_message definition.
1657
1658 struct kernel_oplock_message {
1659         uint64_t dev;
1660         uint64_t inode;
1661         unit64_t extid;
1662         unsigned long file_id;
1663 };
1664
1665 Offset  Data                  length.
1666 0     uint64_t dev            8 bytes
1667 8     uint64_t inode          8 bytes
1668 16    uint64_t extid          8 bytes
1669 24    unsigned long file_id   4 bytes
1670 28
1671
1672 */
1673 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1674
1675 /* file_renamed_message definition.
1676
1677 struct file_renamed_message {
1678         uint64_t dev;
1679         uint64_t inode;
1680         char names[1]; A variable area containing sharepath and filename.
1681 };
1682
1683 Offset  Data                    length.
1684 0       uint64_t dev            8 bytes
1685 8       uint64_t inode          8 bytes
1686 16      unit64_t extid          8 bytes
1687 24      char [] name            zero terminated namelen bytes
1688 minimum length == 24.
1689
1690 */
1691
1692 #define MSG_FILE_RENAMED_MIN_SIZE 24
1693
1694 /*
1695  * On the wire return values for oplock types.
1696  */
1697
1698 #define CORE_OPLOCK_GRANTED (1<<5)
1699 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1700
1701 #define NO_OPLOCK_RETURN 0
1702 #define EXCLUSIVE_OPLOCK_RETURN 1
1703 #define BATCH_OPLOCK_RETURN 2
1704 #define LEVEL_II_OPLOCK_RETURN 3
1705
1706 /* Oplock levels */
1707 #define OPLOCKLEVEL_NONE 0
1708 #define OPLOCKLEVEL_II 1
1709
1710 /*
1711  * Capabilities abstracted for different systems.
1712  */
1713
1714 enum smbd_capability {
1715     KERNEL_OPLOCK_CAPABILITY,
1716     DMAPI_ACCESS_CAPABILITY,
1717     LEASE_CAPABILITY
1718 };
1719
1720 /*
1721  * Kernel oplocks capability flags.
1722  */
1723
1724 /* Level 2 oplocks are supported natively by kernel oplocks. */
1725 #define KOPLOCKS_LEVEL2_SUPPORTED               0x1
1726
1727 /* The kernel notifies deferred openers when they can retry the open. */
1728 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION     0x2
1729
1730 /* The kernel notifies smbds when an oplock break times out. */
1731 #define KOPLOCKS_TIMEOUT_NOTIFICATION           0x4
1732
1733 /* The kernel notifies smbds when an oplock is broken. */
1734 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION     0x8
1735
1736 struct kernel_oplocks_ops;
1737 struct kernel_oplocks {
1738         const struct kernel_oplocks_ops *ops;
1739         uint32_t flags;
1740         void *private_data;
1741 };
1742
1743 enum level2_contention_type {
1744         LEVEL2_CONTEND_ALLOC_SHRINK,
1745         LEVEL2_CONTEND_ALLOC_GROW,
1746         LEVEL2_CONTEND_SET_FILE_LEN,
1747         LEVEL2_CONTEND_FILL_SPARSE,
1748         LEVEL2_CONTEND_WRITE,
1749         LEVEL2_CONTEND_WINDOWS_BRL,
1750         LEVEL2_CONTEND_POSIX_BRL
1751 };
1752
1753 /* if a kernel does support oplocks then a structure of the following
1754    typee is used to describe how to interact with the kernel */
1755 struct kernel_oplocks_ops {
1756         bool (*set_oplock)(struct kernel_oplocks *ctx,
1757                            files_struct *fsp, int oplock_type);
1758         void (*release_oplock)(struct kernel_oplocks *ctx,
1759                                files_struct *fsp, int oplock_type);
1760         void (*contend_level2_oplocks_begin)(files_struct *fsp,
1761                                              enum level2_contention_type type);
1762         void (*contend_level2_oplocks_end)(files_struct *fsp,
1763                                            enum level2_contention_type type);
1764 };
1765
1766 #include "smb_macros.h"
1767
1768 #define MAX_NETBIOSNAME_LEN 16
1769 /* DOS character, NetBIOS namestring. Type used on the wire. */
1770 typedef char nstring[MAX_NETBIOSNAME_LEN];
1771 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1772 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1773
1774 /* A netbios name structure. */
1775 struct nmb_name {
1776         nstring      name;
1777         char         scope[64];
1778         unsigned int name_type;
1779 };
1780
1781 /* A netbios node status array element. */
1782 typedef struct node_status_ {
1783         nstring name;
1784         unsigned char type;
1785         unsigned char flags;
1786 } NODE_STATUS_STRUCT;
1787
1788 /* The extra info from a NetBIOS node status query */
1789 struct node_status_extra {
1790         unsigned char mac_addr[6];
1791         /* There really is more here ... */ 
1792 };
1793
1794 typedef struct user_struct {
1795         struct user_struct *next, *prev;
1796         uint16 vuid; /* Tag for this entry. */
1797
1798         char *session_keystr; /* used by utmp and pam session code.  
1799                                  TDB key string */
1800         int homes_snum;
1801
1802         struct auth_serversupplied_info *server_info;
1803
1804         struct auth_ntlmssp_state *auth_ntlmssp_state;
1805 } user_struct;
1806
1807 struct unix_error_map {
1808         int unix_error;
1809         int dos_class;
1810         int dos_code;
1811         NTSTATUS nt_error;
1812 };
1813
1814 /*
1815  * Size of new password account encoding string.  This is enough space to
1816  * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1817  * Do not change unless you are adding new ACB bits!
1818  */
1819
1820 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1821
1822 /*
1823    Do you want session setups at user level security with a invalid
1824    password to be rejected or allowed in as guest? WinNT rejects them
1825    but it can be a pain as it means "net view" needs to use a password
1826
1827    You have 3 choices in the setting of map_to_guest:
1828
1829    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1830    are rejected. This is the default.
1831
1832    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1833    are rejected, unless the username does not exist, in which case it
1834    is treated as a guest login
1835
1836    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1837    are treated as a guest login
1838
1839    Note that map_to_guest only has an effect in user or server
1840    level security.
1841 */
1842
1843 #define NEVER_MAP_TO_GUEST              0
1844 #define MAP_TO_GUEST_ON_BAD_USER        1
1845 #define MAP_TO_GUEST_ON_BAD_PASSWORD    2
1846 #define MAP_TO_GUEST_ON_BAD_UID         3
1847
1848 #define SAFE_NETBIOS_CHARS ". -_"
1849
1850 /* The maximum length of a trust account password.
1851    Used when we randomly create it, 15 char passwords
1852    exceed NT4's max password length */
1853
1854 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1855
1856 #include "popt_common.h"
1857
1858 #define PORT_NONE       0
1859 #ifndef LDAP_PORT
1860 #define LDAP_PORT       389
1861 #endif
1862 #define LDAP_GC_PORT    3268
1863
1864 /* used by the IP comparison function */
1865 struct ip_service {
1866         struct sockaddr_storage ss;
1867         unsigned port;
1868 };
1869
1870 /* Special name type used to cause a _kerberos DNS lookup. */
1871 #define KDC_NAME_TYPE 0xDCDC
1872
1873 struct ea_struct {
1874         uint8 flags;
1875         char *name;
1876         DATA_BLOB value;
1877 };
1878
1879 struct ea_list {
1880         struct ea_list *next, *prev;
1881         struct ea_struct ea;
1882 };
1883
1884 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1885 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1886 /* EA to use for DOS attributes */
1887 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1888 /* Prefix for DosStreams in the vfs_streams_xattr module */
1889 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1890 /* Prefix for DOS timestamps. */
1891 #define SAMBA_XATTR_DOSTIMESTAMPS "user.DosTimestamps"
1892
1893 #define UUID_SIZE 16
1894
1895 #define UUID_FLAT_SIZE 16
1896 typedef struct uuid_flat {
1897         uint8 info[UUID_FLAT_SIZE];
1898 } UUID_FLAT;
1899
1900 /* map readonly options */
1901 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1902
1903 /* usershare error codes. */
1904 enum usershare_err {
1905                 USERSHARE_OK=0,
1906                 USERSHARE_MALFORMED_FILE,
1907                 USERSHARE_BAD_VERSION,
1908                 USERSHARE_MALFORMED_PATH,
1909                 USERSHARE_MALFORMED_COMMENT_DEF,
1910                 USERSHARE_MALFORMED_ACL_DEF,
1911                 USERSHARE_ACL_ERR,
1912                 USERSHARE_PATH_NOT_ABSOLUTE,
1913                 USERSHARE_PATH_IS_DENIED,
1914                 USERSHARE_PATH_NOT_ALLOWED,
1915                 USERSHARE_PATH_NOT_DIRECTORY,
1916                 USERSHARE_POSIX_ERR
1917 };
1918
1919 /* Different reasons for closing a file. */
1920 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1921
1922 /* Used in SMB_FS_OBJECTID_INFORMATION requests.  Must be exactly 48 bytes. */
1923 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1924 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1925 struct smb_extended_info {
1926         uint32 samba_magic;             /* Always SAMBA_EXTRA_INFO_MAGIC */
1927         uint32 samba_version;           /* Major/Minor/Release/Revision */
1928         uint32 samba_subversion;        /* Prerelease/RC/Vendor patch */
1929         NTTIME samba_gitcommitdate;
1930         char   samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1931 };
1932
1933 /* time info */
1934 struct smb_file_time {
1935         struct timespec mtime;
1936         struct timespec atime;
1937         struct timespec ctime;
1938         struct timespec create_time;
1939 };
1940
1941 /*
1942  * unix_convert_flags
1943  */
1944 #define UCF_SAVE_LCOMP                  0x00000001
1945 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP    0x00000002
1946 #define UCF_COND_ALLOW_WCARD_LCOMP      0x00000004
1947
1948 /*
1949  * smb_filename
1950  */
1951 struct smb_filename {
1952         char *base_name;
1953         char *stream_name;
1954         char *original_lcomp;
1955         SMB_STRUCT_STAT st;
1956 };
1957
1958 /* struct for maintaining the child processes that get spawned from smbd */
1959 struct child_pid {
1960         struct child_pid *prev, *next;
1961         pid_t pid;
1962 };
1963
1964 #endif /* _SMB_H */