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