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