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