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