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