r5204: More merges for 3.0.11-final...
[Samba.git] / source / include / smb.h
blobeb7214ecbfed5b9ceab944762044ff2847d1f8b0
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 2 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, write to the Free Software
24 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #ifndef _SMB_H
28 #define _SMB_H
30 #if defined(LARGE_SMB_OFF_T)
31 #define BUFFER_SIZE (128*1024)
32 #else /* no large readwrite possible */
33 #define BUFFER_SIZE (0xFFFF)
34 #endif
36 #define SAFETY_MARGIN 1024
37 #define LARGE_WRITEX_HDR_SIZE 65
39 #define NMB_PORT 137
40 #define DGRAM_PORT 138
41 #define SMB_PORT1 445
42 #define SMB_PORT2 139
43 #define SMB_PORTS "445 139"
45 #define Undefined (-1)
46 #define False (0)
47 #define True (1)
48 #define Auto (2)
49 #define Required (3)
51 #ifndef _BOOL
52 typedef int BOOL;
53 #define _BOOL /* So we don't typedef BOOL again in vfs.h */
54 #endif
56 #define SIZEOFWORD 2
58 #ifndef DEF_CREATE_MASK
59 #define DEF_CREATE_MASK (0755)
60 #endif
62 /* string manipulation flags - see clistr.c and srvstr.c */
63 #define STR_TERMINATE 1
64 #define STR_UPPER 2
65 #define STR_ASCII 4
66 #define STR_UNICODE 8
67 #define STR_NOALIGN 16
68 #define STR_TERMINATE_ASCII 128
70 /* how long to wait for secondary SMB packets (milli-seconds) */
71 #define SMB_SECONDARY_WAIT (60*1000)
73 /* Debugging stuff */
74 #include "debug.h"
76 /* this defines the error codes that receive_smb can put in smb_read_error */
77 #define READ_TIMEOUT 1
78 #define READ_EOF 2
79 #define READ_ERROR 3
80 #define WRITE_ERROR 4 /* This error code can go into the client smb_rw_error. */
81 #define READ_BAD_SIG 5
82 #define DO_NOT_DO_TDIS 6 /* cli_close_connection() check for this when smbfs wants to keep tree connected */
84 #define DIR_STRUCT_SIZE 43
86 /* these define the attribute byte as seen by DOS */
87 #define aRONLY (1L<<0) /* 0x01 */
88 #define aHIDDEN (1L<<1) /* 0x02 */
89 #define aSYSTEM (1L<<2) /* 0x04 */
90 #define aVOLID (1L<<3) /* 0x08 */
91 #define aDIR (1L<<4) /* 0x10 */
92 #define aARCH (1L<<5) /* 0x20 */
94 /* deny modes */
95 #define DENY_DOS 0
96 #define DENY_ALL 1
97 #define DENY_WRITE 2
98 #define DENY_READ 3
99 #define DENY_NONE 4
100 #define DENY_FCB 7
102 /* open modes */
103 #define DOS_OPEN_RDONLY 0
104 #define DOS_OPEN_WRONLY 1
105 #define DOS_OPEN_RDWR 2
106 #define DOS_OPEN_FCB 0xF
108 /* define shifts and masks for share and open modes. */
109 #define OPEN_MODE_MASK 0xF
110 #define SHARE_MODE_SHIFT 4
111 #define SHARE_MODE_MASK 0x7
112 #define GET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
113 #define SET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
114 #define GET_DENY_MODE(x) (((x)>>SHARE_MODE_SHIFT) & SHARE_MODE_MASK)
115 #define SET_DENY_MODE(x) (((x) & SHARE_MODE_MASK) <<SHARE_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 /* allow delete on open file mode (used by NT SMB's). */
122 #define ALLOW_SHARE_DELETE (1<<15)
123 #define GET_ALLOW_SHARE_DELETE(x) (((x) & ALLOW_SHARE_DELETE) ? True : False)
124 #define SET_ALLOW_SHARE_DELETE(x) ((x) ? ALLOW_SHARE_DELETE : 0)
126 /* delete on close flag (used by NT SMB's). */
127 #define DELETE_ON_CLOSE_FLAG (1<<16)
128 #define GET_DELETE_ON_CLOSE_FLAG(x) (((x) & DELETE_ON_CLOSE_FLAG) ? True : False)
129 #define SET_DELETE_ON_CLOSE_FLAG(x) ((x) ? DELETE_ON_CLOSE_FLAG : 0)
131 /* open disposition values */
132 #define FILE_EXISTS_FAIL 0
133 #define FILE_EXISTS_OPEN 1
134 #define FILE_EXISTS_TRUNCATE 2
136 /* mask for open disposition. */
137 #define FILE_OPEN_MASK 0x3
139 #define GET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
140 #define SET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
142 /* The above can be OR'ed with... */
143 #define FILE_CREATE_IF_NOT_EXIST 0x10
144 #define FILE_FAIL_IF_NOT_EXIST 0
146 #define GET_FILE_CREATE_DISPOSITION(x) ((x) & (FILE_CREATE_IF_NOT_EXIST|FILE_FAIL_IF_NOT_EXIST))
148 /* share types */
149 #define STYPE_DISKTREE 0 /* Disk drive */
150 #define STYPE_PRINTQ 1 /* Spooler queue */
151 #define STYPE_DEVICE 2 /* Serial device */
152 #define STYPE_IPC 3 /* Interprocess communication (IPC) */
153 #define STYPE_HIDDEN 0x80000000 /* share is a hidden one (ends with $) */
155 #include "doserr.h"
157 typedef union unid_t {
158 uid_t uid;
159 gid_t gid;
160 } unid_t;
163 * SMB UCS2 (16-bit unicode) internal type.
166 typedef uint16 smb_ucs2_t;
168 /* ucs2 string types. */
169 typedef smb_ucs2_t wpstring[PSTRING_LEN];
170 typedef smb_ucs2_t wfstring[FSTRING_LEN];
172 #ifdef WORDS_BIGENDIAN
173 #define UCS2_SHIFT 8
174 #else
175 #define UCS2_SHIFT 0
176 #endif
178 /* turn a 7 bit character into a ucs2 character */
179 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
181 /* pipe string names */
182 #define PIPE_LANMAN "\\PIPE\\LANMAN"
183 #define PIPE_SRVSVC "\\PIPE\\srvsvc"
184 #define PIPE_SAMR "\\PIPE\\samr"
185 #define PIPE_WINREG "\\PIPE\\winreg"
186 #define PIPE_WKSSVC "\\PIPE\\wkssvc"
187 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
188 #define PIPE_NTLSA "\\PIPE\\ntlsa"
189 #define PIPE_NTSVCS "\\PIPE\\ntsvcs"
190 #define PIPE_LSASS "\\PIPE\\lsass"
191 #define PIPE_LSARPC "\\PIPE\\lsarpc"
192 #define PIPE_SPOOLSS "\\PIPE\\spoolss"
193 #define PIPE_NETDFS "\\PIPE\\netdfs"
194 #define PIPE_ECHO "\\PIPE\\rpcecho"
195 #define PIPE_SHUTDOWN "\\PIPE\\initshutdown"
197 #define PIPE_NETLOGON_PLAIN "\\NETLOGON"
199 #define PI_LSARPC 0
200 #define PI_LSARPC_DS 1
201 #define PI_SAMR 2
202 #define PI_NETLOGON 3
203 #define PI_SRVSVC 4
204 #define PI_WKSSVC 5
205 #define PI_WINREG 6
206 #define PI_SPOOLSS 7
207 #define PI_NETDFS 8
208 #define PI_ECHO 9
209 #define PI_SHUTDOWN 10
210 #define PI_MAX_PIPES 11
212 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
213 typedef struct nttime_info
215 uint32 low;
216 uint32 high;
217 } NTTIME;
220 /* Allowable account control bits */
221 #define ACB_DISABLED 0x0001 /* 1 = User account disabled */
222 #define ACB_HOMDIRREQ 0x0002 /* 1 = Home directory required */
223 #define ACB_PWNOTREQ 0x0004 /* 1 = User password not required */
224 #define ACB_TEMPDUP 0x0008 /* 1 = Temporary duplicate account */
225 #define ACB_NORMAL 0x0010 /* 1 = Normal user account */
226 #define ACB_MNS 0x0020 /* 1 = MNS logon user account */
227 #define ACB_DOMTRUST 0x0040 /* 1 = Interdomain trust account */
228 #define ACB_WSTRUST 0x0080 /* 1 = Workstation trust account */
229 #define ACB_SVRTRUST 0x0100 /* 1 = Server trust account (BDC) */
230 #define ACB_PWNOEXP 0x0200 /* 1 = User password does not expire */
231 #define ACB_AUTOLOCK 0x0400 /* 1 = Account auto locked */
233 #define MAX_HOURS_LEN 32
236 * window during which we must talk to the PDC to avoid
237 * sam sync delays; expressed in seconds (15 minutes is the
238 * default period for SAM replication under Windows NT 4.0
240 #define SAM_SYNC_WINDOW 900
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 /* SID Types */
250 enum SID_NAME_USE
252 SID_NAME_USE_NONE = 0,
253 SID_NAME_USER = 1, /* user */
254 SID_NAME_DOM_GRP, /* domain group */
255 SID_NAME_DOMAIN, /* domain sid */
256 SID_NAME_ALIAS, /* local group */
257 SID_NAME_WKN_GRP, /* well-known group */
258 SID_NAME_DELETED, /* deleted account: needed for c2 rating */
259 SID_NAME_INVALID, /* invalid account */
260 SID_NAME_UNKNOWN, /* unknown sid type */
261 SID_NAME_COMPUTER /* sid for a computer */
265 * @brief Security Identifier
267 * @sa http://msdn.microsoft.com/library/default.asp?url=/library/en-us/security/accctrl_38yn.asp
269 typedef struct sid_info
271 uint8 sid_rev_num; /**< SID revision number */
272 uint8 num_auths; /**< Number of sub-authorities */
273 uint8 id_auth[6]; /**< Identifier Authority */
275 * Pointer to sub-authorities.
277 * @note The values in these uint32's are in *native* byteorder, not
278 * neccessarily little-endian...... JRA.
280 uint32 sub_auths[MAXSUBAUTHS];
282 } DOM_SID;
284 typedef struct sid_list {
285 uint32 count;
286 DOM_SID *list;
287 } SID_LIST;
290 * The complete list of SIDS belonging to this user.
291 * Created when a vuid is registered.
292 * The definition of the user_sids array is as follows :
294 * token->user_sids[0] = primary user SID.
295 * token->user_sids[1] = primary group SID.
296 * token->user_sids[2..num_sids] = supplementary group SIDS.
299 #define PRIMARY_USER_SID_INDEX 0
300 #define PRIMARY_GROUP_SID_INDEX 1
302 typedef struct _nt_user_token {
303 size_t num_sids;
304 DOM_SID *user_sids;
305 SE_PRIV privileges;
306 } NT_USER_TOKEN;
308 /*** query a local group, get a list of these: shows who is in that group ***/
310 /* local group member info */
311 typedef struct local_grp_member_info
313 DOM_SID sid ; /* matches with name */
314 uint8 sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
315 fstring name ; /* matches with sid: must be of the form "DOMAIN\account" */
317 } LOCAL_GRP_MEMBER;
319 /* enumerate these to get list of local groups */
321 /* local group info */
322 typedef struct local_grp_info
324 fstring name;
325 fstring comment;
327 } LOCAL_GRP;
329 /*** enumerate these to get list of domain groups ***/
331 /* domain group member info */
332 typedef struct domain_grp_info
334 fstring name;
335 fstring comment;
336 uint32 rid; /* group rid */
337 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
339 } DOMAIN_GRP;
341 /*** query a domain group, get a list of these: shows who is in that group ***/
343 /* domain group info */
344 typedef struct domain_grp_member_info
346 fstring name;
347 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
349 } DOMAIN_GRP_MEMBER;
351 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
352 typedef struct time_info
354 uint32 time;
355 } UTIME;
357 /* Structure used when SMBwritebmpx is active */
358 typedef struct
360 size_t wr_total_written; /* So we know when to discard this */
361 int32 wr_timeout;
362 int32 wr_errclass;
363 int32 wr_error; /* Cached errors */
364 BOOL wr_mode; /* write through mode) */
365 BOOL wr_discard; /* discard all further data */
366 } write_bmpx_struct;
368 typedef struct write_cache
370 SMB_OFF_T file_size;
371 SMB_OFF_T offset;
372 size_t alloc_size;
373 size_t data_size;
374 char *data;
375 } write_cache;
377 typedef struct
379 smb_ucs2_t *origname;
380 smb_ucs2_t *filename;
381 SMB_STRUCT_STAT *statinfo;
382 } smb_filename;
384 #include "fake_file.h"
386 typedef struct files_struct {
387 struct files_struct *next, *prev;
388 int fnum;
389 struct connection_struct *conn;
390 int fd;
391 uint16 rap_print_jobid;
392 SMB_DEV_T dev;
393 SMB_INO_T inode;
394 BOOL delete_on_close;
395 SMB_OFF_T pos;
396 SMB_BIG_UINT size;
397 SMB_BIG_UINT initial_allocation_size; /* Faked up initial allocation on disk. */
398 SMB_BIG_UINT position_information;
399 mode_t mode;
400 uint16 file_pid;
401 uint16 vuid;
402 write_bmpx_struct *wbmpx_ptr;
403 write_cache *wcp;
404 struct timeval open_time;
405 int share_mode;
406 uint32 desired_access;
407 time_t pending_modtime;
408 int oplock_type;
409 int sent_oplock_break;
410 unsigned long file_id;
411 BOOL can_lock;
412 BOOL can_read;
413 BOOL can_write;
414 BOOL print_file;
415 BOOL modified;
416 BOOL is_directory;
417 BOOL is_stat;
418 BOOL directory_delete_on_close;
419 char *fsp_name;
420 FAKE_FILE_HANDLE *fake_file_handle;
421 } files_struct;
423 #include "ntquotas.h"
424 #include "sysquotas.h"
426 /* used to hold an arbitrary blob of data */
427 typedef struct data_blob
429 uint8 *data;
430 size_t length;
431 void (*free)(struct data_blob *data_blob);
432 } DATA_BLOB;
435 * Structure used to keep directory state information around.
436 * Used in NT change-notify code.
439 typedef struct
441 time_t modify_time;
442 time_t status_time;
443 } dir_status_struct;
445 struct vuid_cache_entry
447 uint16 vuid;
448 BOOL read_only;
449 BOOL admin_user;
452 struct vuid_cache
454 unsigned int entries;
455 struct vuid_cache_entry array[VUID_CACHE_SIZE];
458 typedef struct
460 char *name;
461 BOOL is_wild;
462 } name_compare_entry;
464 /* Include VFS stuff */
466 #include "smb_acls.h"
467 #include "vfs.h"
469 typedef struct connection_struct
471 struct connection_struct *next, *prev;
472 TALLOC_CTX *mem_ctx;
473 unsigned cnum; /* an index passed over the wire */
474 int service;
475 BOOL force_user;
476 BOOL force_group;
477 struct vuid_cache vuid_cache;
478 void *dirptr;
479 BOOL printer;
480 BOOL ipc;
481 BOOL read_only; /* Attributes for the current user of the share. */
482 BOOL admin_user; /* Attributes for the current user of the share. */
483 char *dirpath;
484 char *connectpath;
485 char *origpath;
487 struct vfs_ops vfs; /* Filesystem operations */
488 struct vfs_ops vfs_opaque; /* OPAQUE Filesystem operations */
489 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
491 char *user; /* name of user who *opened* this connection */
492 uid_t uid; /* uid of user who *opened* this connection */
493 gid_t gid; /* gid of user who *opened* this connection */
494 char client_address[18]; /* String version of client IP address. */
496 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
498 /* following groups stuff added by ih */
500 /* This groups info is valid for the user that *opened* the connection */
501 int ngroups;
502 gid_t *groups;
503 NT_USER_TOKEN *nt_user_token;
505 time_t lastused;
506 BOOL used;
507 int num_files_open;
509 BOOL case_sensitive;
510 BOOL case_preserve;
511 BOOL short_case_preserve;
513 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
514 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
515 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
517 } connection_struct;
519 struct current_user
521 connection_struct *conn;
522 uint16 vuid;
523 uid_t uid;
524 gid_t gid;
525 int ngroups;
526 gid_t *groups;
527 NT_USER_TOKEN *nt_user_token;
530 /* Defines for the sent_oplock_break field above. */
531 #define NO_BREAK_SENT 0
532 #define EXCLUSIVE_BREAK_SENT 1
533 #define LEVEL_II_BREAK_SENT 2
535 typedef struct {
536 fstring smb_name; /* user name from the client */
537 fstring unix_name; /* unix user name of a validated user */
538 fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
539 fstring domain; /* domain that the client specified */
540 } userdom_struct;
542 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
544 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
545 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
547 typedef struct _print_queue_struct
549 int job; /* normally the UNIX jobid -- see note in
550 printing.c:traverse_fn_delete() */
551 int size;
552 int page_count;
553 int status;
554 int priority;
555 time_t time;
556 fstring fs_user;
557 fstring fs_file;
558 } print_queue_struct;
560 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
562 typedef struct
564 fstring message;
565 int qcount;
566 int status;
567 } print_status_struct;
569 /* used for server information: client, nameserv and ipc */
570 struct server_info_struct
572 fstring name;
573 uint32 type;
574 fstring comment;
575 fstring domain; /* used ONLY in ipc.c NOT namework.c */
576 BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
580 /* used for network interfaces */
581 struct interface
583 struct interface *next, *prev;
584 struct in_addr ip;
585 struct in_addr bcast;
586 struct in_addr nmask;
589 /* struct used by share mode violation error processing */
590 typedef struct {
591 pid_t pid;
592 uint16 mid;
593 struct timeval time;
594 SMB_DEV_T dev;
595 SMB_INO_T inode;
596 uint16 port;
597 } deferred_open_entry;
599 /* Internal message queue for deferred opens. */
600 struct pending_message_list {
601 struct pending_message_list *next, *prev;
602 struct timeval msg_time; /* The timeout time */
603 DATA_BLOB buf;
604 DATA_BLOB private_data;
607 /* struct returned by get_share_modes */
608 typedef struct {
609 pid_t pid;
610 uint16 op_port;
611 uint16 op_type;
612 int share_mode;
613 uint32 desired_access;
614 struct timeval time;
615 SMB_DEV_T dev;
616 SMB_INO_T inode;
617 unsigned long share_file_id;
618 } share_mode_entry;
621 #define SHAREMODE_FN_CAST() \
622 void (*)(share_mode_entry *, char*)
624 #define SHAREMODE_FN(fn) \
625 void (*fn)(share_mode_entry *, char*)
627 #define NT_HASH_LEN 16
628 #define LM_HASH_LEN 16
630 /* Password history contants. */
631 #define PW_HISTORY_SALT_LEN 16
632 #define SALTED_MD5_HASH_LEN 16
633 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
636 * Flags for account policy.
638 #define AP_MIN_PASSWORD_LEN 1
639 #define AP_PASSWORD_HISTORY 2
640 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
641 #define AP_MAX_PASSWORD_AGE 4
642 #define AP_MIN_PASSWORD_AGE 5
643 #define AP_LOCK_ACCOUNT_DURATION 6
644 #define AP_RESET_COUNT_TIME 7
645 #define AP_BAD_ATTEMPT_LOCKOUT 8
646 #define AP_TIME_TO_LOGOUT 9
647 #define AP_REFUSE_MACHINE_PW_CHANGE 10
650 * Flags for local user manipulation.
653 #define LOCAL_ADD_USER 0x1
654 #define LOCAL_DELETE_USER 0x2
655 #define LOCAL_DISABLE_USER 0x4
656 #define LOCAL_ENABLE_USER 0x8
657 #define LOCAL_TRUST_ACCOUNT 0x10
658 #define LOCAL_SET_NO_PASSWORD 0x20
659 #define LOCAL_SET_PASSWORD 0x40
660 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
661 #define LOCAL_INTERDOM_ACCOUNT 0x100
662 #define LOCAL_AM_ROOT 0x200 /* Act as root */
664 /* key and data in the connections database - used in smbstatus and smbd */
665 struct connections_key {
666 pid_t pid;
667 int cnum;
668 fstring name;
671 struct connections_data {
672 int magic;
673 pid_t pid;
674 int cnum;
675 uid_t uid;
676 gid_t gid;
677 char name[24];
678 char addr[24];
679 char machine[FSTRING_LEN];
680 time_t start;
681 uint32 bcast_msg_flags;
685 /* key and data records in the tdb locking database */
686 struct locking_key {
687 SMB_DEV_T dev;
688 SMB_INO_T inode;
691 /* the following are used by loadparm for option lists */
692 typedef enum {
693 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
694 P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
695 } parm_type;
697 typedef enum {
698 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
699 } parm_class;
701 /* passed to br lock code */
702 enum brl_type {READ_LOCK, WRITE_LOCK, PENDING_LOCK};
704 struct enum_list {
705 int value;
706 const char *name;
709 #define BRLOCK_FN_CAST() \
710 void (*)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
711 enum brl_type lock_type, \
712 br_off start, br_off size)
713 #define BRLOCK_FN(fn) \
714 void (*fn)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
715 enum brl_type lock_type, \
716 br_off start, br_off size)
717 struct parm_struct
719 const char *label;
720 parm_type type;
721 parm_class class;
722 void *ptr;
723 BOOL (*special)(int snum, const char *, char **);
724 const struct enum_list *enum_list;
725 unsigned flags;
726 union {
727 BOOL bvalue;
728 int ivalue;
729 char *svalue;
730 char cvalue;
731 char **lvalue;
732 } def;
735 struct bitmap {
736 uint32 *b;
737 unsigned int n;
740 /* The following flags are used in SWAT */
741 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
742 #define FLAG_SHARE 0x0002 /* file sharing options */
743 #define FLAG_PRINT 0x0004 /* printing options */
744 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
745 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
746 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
747 #define FLAG_DEVELOPER 0x0040 /* No longer used */
748 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
749 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
750 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
752 #ifndef LOCKING_VERSION
753 #define LOCKING_VERSION 4
754 #endif /* LOCKING_VERSION */
757 /* the basic packet size, assuming no words or bytes */
758 #define smb_size 39
760 /* offsets into message for common items */
761 #define smb_com 8
762 #define smb_rcls 9
763 #define smb_reh 10
764 #define smb_err 11
765 #define smb_flg 13
766 #define smb_flg2 14
767 #define smb_pidhigh 16
768 #define smb_ss_field 18
769 #define smb_tid 28
770 #define smb_pid 30
771 #define smb_uid 32
772 #define smb_mid 34
773 #define smb_wct 36
774 #define smb_vwv 37
775 #define smb_vwv0 37
776 #define smb_vwv1 39
777 #define smb_vwv2 41
778 #define smb_vwv3 43
779 #define smb_vwv4 45
780 #define smb_vwv5 47
781 #define smb_vwv6 49
782 #define smb_vwv7 51
783 #define smb_vwv8 53
784 #define smb_vwv9 55
785 #define smb_vwv10 57
786 #define smb_vwv11 59
787 #define smb_vwv12 61
788 #define smb_vwv13 63
789 #define smb_vwv14 65
790 #define smb_vwv15 67
791 #define smb_vwv16 69
792 #define smb_vwv17 71
794 /* flag defines. CIFS spec 3.1.1 */
795 #define FLAG_SUPPORT_LOCKREAD 0x01
796 #define FLAG_CLIENT_BUF_AVAIL 0x02
797 #define FLAG_RESERVED 0x04
798 #define FLAG_CASELESS_PATHNAMES 0x08
799 #define FLAG_CANONICAL_PATHNAMES 0x10
800 #define FLAG_REQUEST_OPLOCK 0x20
801 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
802 #define FLAG_REPLY 0x80
804 /* the complete */
805 #define SMBmkdir 0x00 /* create directory */
806 #define SMBrmdir 0x01 /* delete directory */
807 #define SMBopen 0x02 /* open file */
808 #define SMBcreate 0x03 /* create file */
809 #define SMBclose 0x04 /* close file */
810 #define SMBflush 0x05 /* flush file */
811 #define SMBunlink 0x06 /* delete file */
812 #define SMBmv 0x07 /* rename file */
813 #define SMBgetatr 0x08 /* get file attributes */
814 #define SMBsetatr 0x09 /* set file attributes */
815 #define SMBread 0x0A /* read from file */
816 #define SMBwrite 0x0B /* write to file */
817 #define SMBlock 0x0C /* lock byte range */
818 #define SMBunlock 0x0D /* unlock byte range */
819 #define SMBctemp 0x0E /* create temporary file */
820 #define SMBmknew 0x0F /* make new file */
821 #define SMBchkpth 0x10 /* check directory path */
822 #define SMBexit 0x11 /* process exit */
823 #define SMBlseek 0x12 /* seek */
824 #define SMBtcon 0x70 /* tree connect */
825 #define SMBtconX 0x75 /* tree connect and X*/
826 #define SMBtdis 0x71 /* tree disconnect */
827 #define SMBnegprot 0x72 /* negotiate protocol */
828 #define SMBdskattr 0x80 /* get disk attributes */
829 #define SMBsearch 0x81 /* search directory */
830 #define SMBsplopen 0xC0 /* open print spool file */
831 #define SMBsplwr 0xC1 /* write to print spool file */
832 #define SMBsplclose 0xC2 /* close print spool file */
833 #define SMBsplretq 0xC3 /* return print queue */
834 #define SMBsends 0xD0 /* send single block message */
835 #define SMBsendb 0xD1 /* send broadcast message */
836 #define SMBfwdname 0xD2 /* forward user name */
837 #define SMBcancelf 0xD3 /* cancel forward */
838 #define SMBgetmac 0xD4 /* get machine name */
839 #define SMBsendstrt 0xD5 /* send start of multi-block message */
840 #define SMBsendend 0xD6 /* send end of multi-block message */
841 #define SMBsendtxt 0xD7 /* send text of multi-block message */
843 /* Core+ protocol */
844 #define SMBlockread 0x13 /* Lock a range and read */
845 #define SMBwriteunlock 0x14 /* Unlock a range then write */
846 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
847 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
848 #define SMBwritec 0x20 /* secondary write request */
849 #define SMBwriteclose 0x2c /* write a file then close it */
851 /* dos extended protocol */
852 #define SMBreadBraw 0x1A /* read block raw */
853 #define SMBreadBmpx 0x1B /* read block multiplexed */
854 #define SMBreadBs 0x1C /* read block (secondary response) */
855 #define SMBwriteBraw 0x1D /* write block raw */
856 #define SMBwriteBmpx 0x1E /* write block multiplexed */
857 #define SMBwriteBs 0x1F /* write block (secondary request) */
858 #define SMBwriteC 0x20 /* write complete response */
859 #define SMBsetattrE 0x22 /* set file attributes expanded */
860 #define SMBgetattrE 0x23 /* get file attributes expanded */
861 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
862 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
863 #define SMBtranss 0x26 /* transaction (secondary request/response) */
864 #define SMBioctl 0x27 /* IOCTL */
865 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
866 #define SMBcopy 0x29 /* copy */
867 #define SMBmove 0x2A /* move */
868 #define SMBecho 0x2B /* echo */
869 #define SMBopenX 0x2D /* open and X */
870 #define SMBreadX 0x2E /* read and X */
871 #define SMBwriteX 0x2F /* write and X */
872 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
873 #define SMBffirst 0x82 /* find first */
874 #define SMBfunique 0x83 /* find unique */
875 #define SMBfclose 0x84 /* find close */
876 #define SMBkeepalive 0x85 /* keepalive */
877 #define SMBinvalid 0xFE /* invalid command */
879 /* Extended 2.0 protocol */
880 #define SMBtrans2 0x32 /* TRANS2 protocol set */
881 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
882 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
883 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
884 #define SMBulogoffX 0x74 /* user logoff */
886 /* NT SMB extensions. */
887 #define SMBnttrans 0xA0 /* NT transact */
888 #define SMBnttranss 0xA1 /* NT transact secondary */
889 #define SMBntcreateX 0xA2 /* NT create and X */
890 #define SMBntcancel 0xA4 /* NT cancel */
891 #define SMBntrename 0xA5 /* NT rename */
893 /* These are the trans subcommands */
894 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
895 #define TRANSACT_DCERPCCMD 0x26
896 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
898 /* These are the TRANS2 sub commands */
899 #define TRANSACT2_OPEN 0x00
900 #define TRANSACT2_FINDFIRST 0x01
901 #define TRANSACT2_FINDNEXT 0x02
902 #define TRANSACT2_QFSINFO 0x03
903 #define TRANSACT2_SETFSINFO 0x04
904 #define TRANSACT2_QPATHINFO 0x05
905 #define TRANSACT2_SETPATHINFO 0x06
906 #define TRANSACT2_QFILEINFO 0x07
907 #define TRANSACT2_SETFILEINFO 0x08
908 #define TRANSACT2_FSCTL 0x09
909 #define TRANSACT2_IOCTL 0x0A
910 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
911 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
912 #define TRANSACT2_MKDIR 0x0D
913 #define TRANSACT2_SESSION_SETUP 0x0E
914 #define TRANSACT2_GET_DFS_REFERRAL 0x10
915 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
917 /* These are the NT transact sub commands. */
918 #define NT_TRANSACT_CREATE 1
919 #define NT_TRANSACT_IOCTL 2
920 #define NT_TRANSACT_SET_SECURITY_DESC 3
921 #define NT_TRANSACT_NOTIFY_CHANGE 4
922 #define NT_TRANSACT_RENAME 5
923 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
924 #define NT_TRANSACT_GET_USER_QUOTA 7
925 #define NT_TRANSACT_SET_USER_QUOTA 8
927 /* These are the NT transact_get_user_quota sub commands */
928 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
929 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
930 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
932 /* Relevant IOCTL codes */
933 #define IOCTL_QUERY_JOB_INFO 0x530060
935 /* these are the trans2 sub fields for primary requests */
936 #define smb_tpscnt smb_vwv0
937 #define smb_tdscnt smb_vwv1
938 #define smb_mprcnt smb_vwv2
939 #define smb_mdrcnt smb_vwv3
940 #define smb_msrcnt smb_vwv4
941 #define smb_flags smb_vwv5
942 #define smb_timeout smb_vwv6
943 #define smb_pscnt smb_vwv9
944 #define smb_psoff smb_vwv10
945 #define smb_dscnt smb_vwv11
946 #define smb_dsoff smb_vwv12
947 #define smb_suwcnt smb_vwv13
948 #define smb_setup smb_vwv14
949 #define smb_setup0 smb_setup
950 #define smb_setup1 (smb_setup+2)
951 #define smb_setup2 (smb_setup+4)
953 /* these are for the secondary requests */
954 #define smb_spscnt smb_vwv2
955 #define smb_spsoff smb_vwv3
956 #define smb_spsdisp smb_vwv4
957 #define smb_sdscnt smb_vwv5
958 #define smb_sdsoff smb_vwv6
959 #define smb_sdsdisp smb_vwv7
960 #define smb_sfid smb_vwv8
962 /* and these for responses */
963 #define smb_tprcnt smb_vwv0
964 #define smb_tdrcnt smb_vwv1
965 #define smb_prcnt smb_vwv3
966 #define smb_proff smb_vwv4
967 #define smb_prdisp smb_vwv5
968 #define smb_drcnt smb_vwv6
969 #define smb_droff smb_vwv7
970 #define smb_drdisp smb_vwv8
972 /* these are for the NT trans primary request. */
973 #define smb_nt_MaxSetupCount smb_vwv0
974 #define smb_nt_Flags (smb_vwv0 + 1)
975 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
976 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
977 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
978 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
979 #define smb_nt_ParameterCount (smb_vwv0 + 19)
980 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
981 #define smb_nt_DataCount (smb_vwv0 + 27)
982 #define smb_nt_DataOffset (smb_vwv0 + 31)
983 #define smb_nt_SetupCount (smb_vwv0 + 35)
984 #define smb_nt_Function (smb_vwv0 + 36)
985 #define smb_nt_SetupStart (smb_vwv0 + 38)
987 /* these are for the NT trans secondary request. */
988 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
989 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
990 #define smb_nts_ParameterCount (smb_vwv0 + 11)
991 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
992 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
993 #define smb_nts_DataCount (smb_vwv0 + 23)
994 #define smb_nts_DataOffset (smb_vwv0 + 27)
995 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
997 /* these are for the NT trans reply. */
998 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
999 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1000 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1001 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1002 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1003 #define smb_ntr_DataCount (smb_vwv0 + 23)
1004 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1005 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1007 /* these are for the NT create_and_X */
1008 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1009 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1010 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1011 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1012 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1013 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1014 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1015 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1016 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1017 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1018 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1020 /* this is used on a TConX. I'm not sure the name is very helpful though */
1021 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1022 #define SMB_SHARE_IN_DFS 0x0002
1024 /* Named pipe write mode flags. Used in writeX calls. */
1025 #define PIPE_RAW_MODE 0x4
1026 #define PIPE_START_MESSAGE 0x8
1028 /* File Specific access rights */
1029 #define FILE_READ_DATA 0x00000001
1030 #define FILE_WRITE_DATA 0x00000002
1031 #define FILE_APPEND_DATA 0x00000004
1032 #define FILE_READ_EA 0x00000008 /* File and directory */
1033 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1034 #define FILE_EXECUTE 0x00000020
1035 #define FILE_DELETE_CHILD 0x00000040
1036 #define FILE_READ_ATTRIBUTES 0x00000080
1037 #define FILE_WRITE_ATTRIBUTES 0x00000100
1039 #define FILE_ALL_ACCESS 0x000001FF
1041 /* Directory specific access rights */
1042 #define FILE_LIST_DIRECTORY 0x00000001
1043 #define FILE_ADD_FILE 0x00000002
1044 #define FILE_ADD_SUBDIRECTORY 0x00000004
1045 #define FILE_TRAVERSE 0x00000020
1046 #define FILE_DELETE_CHILD 0x00000040
1048 /* the desired access to use when opening a pipe */
1049 #define DESIRED_ACCESS_PIPE 0x2019f
1051 /* Generic access masks & rights. */
1052 #define DELETE_ACCESS (1L<<16) /* 0x00010000 */
1053 #define READ_CONTROL_ACCESS (1L<<17) /* 0x00020000 */
1054 #define WRITE_DAC_ACCESS (1L<<18) /* 0x00040000 */
1055 #define WRITE_OWNER_ACCESS (1L<<19) /* 0x00080000 */
1056 #define SYNCHRONIZE_ACCESS (1L<<20) /* 0x00100000 */
1058 #define SYSTEM_SECURITY_ACCESS (1L<<24) /* 0x01000000 */
1059 #define MAXIMUM_ALLOWED_ACCESS (1L<<25) /* 0x02000000 */
1060 #define GENERIC_ALL_ACCESS (1<<28) /* 0x10000000 */
1061 #define GENERIC_EXECUTE_ACCESS (1<<29) /* 0x20000000 */
1062 #define GENERIC_WRITE_ACCESS (1<<30) /* 0x40000000 */
1063 #define GENERIC_READ_ACCESS (((unsigned)1)<<31) /* 0x80000000 */
1065 /* Mapping of generic access rights for files to specific rights. */
1067 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1069 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1070 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1072 #define FILE_GENERIC_WRITE (STD_RIGHT_READ_CONTROL_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1073 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1075 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|\
1076 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1078 /* Mapping of access rights to UNIX perms. */
1079 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1080 #define UNIX_ACCESS_R FILE_GENERIC_READ
1081 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1082 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1084 #if 0
1086 * This is the old mapping we used to use. To get W2KSP2 profiles
1087 * working we need to map to the canonical file perms.
1089 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1090 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1091 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1092 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1093 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1094 FILE_APPEND_DATA|FILE_WRITE_DATA)
1095 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1096 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1097 #endif
1099 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1101 /* Flags field. */
1102 #define REQUEST_OPLOCK 2
1103 #define REQUEST_BATCH_OPLOCK 4
1104 #define OPEN_DIRECTORY 8
1105 #define EXTENDED_RESPONSE_REQUIRED 0x10
1107 /* ShareAccess field. */
1108 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1109 #define FILE_SHARE_READ 1
1110 #define FILE_SHARE_WRITE 2
1111 #define FILE_SHARE_DELETE 4
1113 /* FileAttributesField */
1114 #define FILE_ATTRIBUTE_READONLY 0x001L
1115 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1116 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1117 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1118 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1119 #define FILE_ATTRIBUTE_NORMAL 0x080L
1120 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1121 #define FILE_ATTRIBUTE_SPARSE 0x200L
1122 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1123 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1124 #define SAMBA_ATTRIBUTES_MASK 0x7F
1126 /* Flags - combined with attributes. */
1127 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1128 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1129 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1130 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1131 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1132 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1133 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1135 /* CreateDisposition field. */
1136 #define FILE_SUPERSEDE 0
1137 #define FILE_OPEN 1
1138 #define FILE_CREATE 2
1139 #define FILE_OPEN_IF 3
1140 #define FILE_OVERWRITE 4
1141 #define FILE_OVERWRITE_IF 5
1143 /* CreateOptions field. */
1144 #define FILE_DIRECTORY_FILE 0x0001
1145 #define FILE_WRITE_THROUGH 0x0002
1146 #define FILE_SEQUENTIAL_ONLY 0x0004
1147 #define FILE_NON_DIRECTORY_FILE 0x0040
1148 #define FILE_NO_EA_KNOWLEDGE 0x0200
1149 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1150 #define FILE_RANDOM_ACCESS 0x0800
1151 #define FILE_DELETE_ON_CLOSE 0x1000
1152 #define FILE_OPEN_BY_FILE_ID 0x2000
1154 /* Responses when opening a file. */
1155 #define FILE_WAS_SUPERSEDED 0
1156 #define FILE_WAS_OPENED 1
1157 #define FILE_WAS_CREATED 2
1158 #define FILE_WAS_OVERWRITTEN 3
1160 /* File type flags */
1161 #define FILE_TYPE_DISK 0
1162 #define FILE_TYPE_BYTE_MODE_PIPE 1
1163 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1164 #define FILE_TYPE_PRINTER 3
1165 #define FILE_TYPE_COMM_DEVICE 4
1166 #define FILE_TYPE_UNKNOWN 0xFFFF
1168 /* Flag for NT transact rename call. */
1169 #define RENAME_REPLACE_IF_EXISTS 1
1171 /* flags for SMBntrename call (from Samba4) */
1172 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1173 #define RENAME_FLAG_HARD_LINK 0x103
1174 #define RENAME_FLAG_RENAME 0x104
1175 #define RENAME_FLAG_COPY 0x105
1177 /* Filesystem Attributes. */
1178 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1179 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1180 #define FILE_UNICODE_ON_DISK 0x00000004
1181 /* According to cifs9f, this is 4, not 8 */
1182 /* Acconding to testing, this actually sets the security attribute! */
1183 #define FILE_PERSISTENT_ACLS 0x00000008
1184 #define FILE_FILE_COMPRESSION 0x00000010
1185 #define FILE_VOLUME_QUOTAS 0x00000020
1186 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1187 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1188 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1189 #define FS_LFN_APIS 0x00004000
1190 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1191 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1192 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1193 #define FILE_NAMED_STREAMS 0x00040000
1194 #define FILE_READ_ONLY_VOLUME 0x00080000
1196 /* ChangeNotify flags. */
1197 #define FILE_NOTIFY_CHANGE_FILE 0x001
1198 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1199 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1200 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1201 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1202 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1203 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1204 #define FILE_NOTIFY_CHANGE_EA 0x080
1205 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1206 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x200
1208 /* where to find the base of the SMB packet proper */
1209 #define smb_base(buf) (((char *)(buf))+4)
1211 /* we don't allow server strings to be longer than 48 characters as
1212 otherwise NT will not honour the announce packets */
1213 #define MAX_SERVER_STRING_LENGTH 48
1216 #define SMB_SUCCESS 0 /* The request was successful. */
1218 #ifdef WITH_DFS
1219 void dfs_unlogin(void);
1220 extern int dcelogin_atmost_once;
1221 #endif
1223 #ifdef NOSTRDUP
1224 char *strdup(char *s);
1225 #endif
1227 #ifndef SIGNAL_CAST
1228 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1229 #endif
1231 #ifndef SELECT_CAST
1232 #define SELECT_CAST
1233 #endif
1235 /* these are used in NetServerEnum to choose what to receive */
1236 #define SV_TYPE_WORKSTATION 0x00000001
1237 #define SV_TYPE_SERVER 0x00000002
1238 #define SV_TYPE_SQLSERVER 0x00000004
1239 #define SV_TYPE_DOMAIN_CTRL 0x00000008
1240 #define SV_TYPE_DOMAIN_BAKCTRL 0x00000010
1241 #define SV_TYPE_TIME_SOURCE 0x00000020
1242 #define SV_TYPE_AFP 0x00000040
1243 #define SV_TYPE_NOVELL 0x00000080
1244 #define SV_TYPE_DOMAIN_MEMBER 0x00000100
1245 #define SV_TYPE_PRINTQ_SERVER 0x00000200
1246 #define SV_TYPE_DIALIN_SERVER 0x00000400
1247 #define SV_TYPE_SERVER_UNIX 0x00000800
1248 #define SV_TYPE_NT 0x00001000
1249 #define SV_TYPE_WFW 0x00002000
1250 #define SV_TYPE_SERVER_MFPN 0x00004000
1251 #define SV_TYPE_SERVER_NT 0x00008000
1252 #define SV_TYPE_POTENTIAL_BROWSER 0x00010000
1253 #define SV_TYPE_BACKUP_BROWSER 0x00020000
1254 #define SV_TYPE_MASTER_BROWSER 0x00040000
1255 #define SV_TYPE_DOMAIN_MASTER 0x00080000
1256 #define SV_TYPE_SERVER_OSF 0x00100000
1257 #define SV_TYPE_SERVER_VMS 0x00200000
1258 #define SV_TYPE_WIN95_PLUS 0x00400000
1259 #define SV_TYPE_DFS_SERVER 0x00800000
1260 #define SV_TYPE_ALTERNATE_XPORT 0x20000000
1261 #define SV_TYPE_LOCAL_LIST_ONLY 0x40000000
1262 #define SV_TYPE_DOMAIN_ENUM 0x80000000
1263 #define SV_TYPE_ALL 0xFFFFFFFF
1265 /* This was set by JHT in liaison with Jeremy Allison early 1997
1266 * History:
1267 * Version 4.0 - never made public
1268 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1269 * - Reappeared in 1.9.16p11 with fixed smbd services
1270 * Version 4.20 - To indicate that nmbd and browsing now works better
1271 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1273 * Note: In the presence of NT4.X do not set above 4.9
1274 * Setting this above 4.9 can have undesired side-effects.
1275 * This may change again in Samba-3.0 after further testing. JHT
1278 #define DEFAULT_MAJOR_VERSION 0x04
1279 #define DEFAULT_MINOR_VERSION 0x09
1281 /* Browser Election Values */
1282 #define BROWSER_ELECTION_VERSION 0x010f
1283 #define BROWSER_CONSTANT 0xaa55
1285 /* Sercurity mode bits. */
1286 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1287 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1288 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1289 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1291 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1293 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1294 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1295 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1296 #define FLAGS2_IS_LONG_NAME 0x0040
1297 #define FLAGS2_EXTENDED_SECURITY 0x0800
1298 #define FLAGS2_DFS_PATHNAMES 0x1000
1299 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1300 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1301 #define FLAGS2_UNICODE_STRINGS 0x8000
1303 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1305 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1307 #define CAP_RAW_MODE 0x0001
1308 #define CAP_MPX_MODE 0x0002
1309 #define CAP_UNICODE 0x0004
1310 #define CAP_LARGE_FILES 0x0008
1311 #define CAP_NT_SMBS 0x0010
1312 #define CAP_RPC_REMOTE_APIS 0x0020
1313 #define CAP_STATUS32 0x0040
1314 #define CAP_LEVEL_II_OPLOCKS 0x0080
1315 #define CAP_LOCK_AND_READ 0x0100
1316 #define CAP_NT_FIND 0x0200
1317 #define CAP_DFS 0x1000
1318 #define CAP_W2K_SMBS 0x2000
1319 #define CAP_LARGE_READX 0x4000
1320 #define CAP_LARGE_WRITEX 0x8000
1321 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1322 #define CAP_EXTENDED_SECURITY 0x80000000
1324 /* protocol types. It assumes that higher protocols include lower protocols
1325 as subsets */
1326 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1328 /* security levels */
1329 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1331 /* server roles */
1332 enum server_types
1334 ROLE_STANDALONE,
1335 ROLE_DOMAIN_MEMBER,
1336 ROLE_DOMAIN_BDC,
1337 ROLE_DOMAIN_PDC
1340 /* printing types */
1341 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1342 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1343 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2
1344 #ifdef DEVELOPER
1345 ,PRINT_TEST,PRINT_VLP
1346 #endif /* DEVELOPER */
1349 /* LDAP schema types */
1350 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1352 /* LDAP SSL options */
1353 enum ldap_ssl_types {LDAP_SSL_ON, LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1355 /* LDAP PASSWD SYNC methods */
1356 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1358 /* Remote architectures we know about. */
1359 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1360 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_SAMBA, RA_CIFSFS};
1362 /* case handling */
1363 enum case_handling {CASE_LOWER,CASE_UPPER};
1366 * Global value meaing that the smb_uid field should be
1367 * ingored (in share level security and protocol level == CORE)
1370 #define UID_FIELD_INVALID 0
1371 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1374 * Size of buffer to use when moving files across filesystems.
1376 #define COPYBUF_SIZE (8*1024)
1379 * Values used to override error codes.
1381 extern int unix_ERR_class;
1382 extern int unix_ERR_code;
1383 extern NTSTATUS unix_ERR_ntstatus;
1386 * Used in chaining code.
1388 extern int chain_size;
1391 * Map the Core and Extended Oplock requesst bits down
1392 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1396 * Core protocol.
1398 #define CORE_OPLOCK_REQUEST(inbuf) \
1399 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1402 * Extended protocol.
1404 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1406 /* Lock types. */
1407 #define LOCKING_ANDX_SHARED_LOCK 0x1
1408 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1409 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1410 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1411 #define LOCKING_ANDX_LARGE_FILES 0x10
1413 /* Oplock levels */
1414 #define OPLOCKLEVEL_NONE 0
1415 #define OPLOCKLEVEL_II 1
1418 * Bits we test with.
1421 #define NO_OPLOCK 0
1422 #define EXCLUSIVE_OPLOCK 1
1423 #define BATCH_OPLOCK 2
1424 #define LEVEL_II_OPLOCK 4
1425 #define INTERNAL_OPEN_ONLY 8
1427 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1428 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1429 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1431 #define CORE_OPLOCK_GRANTED (1<<5)
1432 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1435 * Return values for oplock types.
1438 #define NO_OPLOCK_RETURN 0
1439 #define EXCLUSIVE_OPLOCK_RETURN 1
1440 #define BATCH_OPLOCK_RETURN 2
1441 #define LEVEL_II_OPLOCK_RETURN 3
1444 * Loopback command offsets.
1447 #define OPBRK_CMD_LEN_OFFSET 0
1448 #define OPBRK_CMD_PORT_OFFSET 4
1449 #define OPBRK_CMD_HEADER_LEN 6
1451 #define OPBRK_MESSAGE_CMD_OFFSET 0
1454 * Oplock break command code to send over the udp socket.
1455 * The same message is sent for both exlusive and level II breaks.
1457 * The form of this is :
1459 * 0 2 2+pid 2+pid+dev 2+pid+dev+ino
1460 * +----+--------+-------+--------+---------+
1461 * | cmd| pid | dev | inode | fileid |
1462 * +----+--------+-------+--------+---------+
1465 #define OPLOCK_BREAK_PID_OFFSET 2
1466 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1467 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1468 #define OPLOCK_BREAK_FILEID_OFFSET (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1469 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1471 /* Message types */
1472 #define OPLOCK_BREAK_CMD 0x1
1473 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1474 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1475 #define ASYNC_LEVEL_II_OPLOCK_BREAK_CMD 0x4
1477 /* Add the "deferred open" message. */
1478 #define RETRY_DEFERRED_OPEN_CMD 0x5
1481 * And the message format for it. Keep the same message length.
1483 * 0 2 2+pid 2+pid+dev 2+pid+dev+ino
1484 * +----+--------+-------+--------+---------+
1485 * | cmd| pid | dev | inode | mid |
1486 * +----+--------+-------+--------+---------+
1489 #define DEFERRED_OPEN_CMD_OFFSET 0
1490 #define DEFERRED_OPEN_PID_OFFSET 2 /* pid we're *sending* from. */
1491 #define DEFERRED_OPEN_DEV_OFFSET (DEFERRED_OPEN_PID_OFFSET + sizeof(pid_t))
1492 #define DEFERRED_OPEN_INODE_OFFSET (DEFERRED_OPEN_DEV_OFFSET + sizeof(SMB_DEV_T))
1493 #define DEFERRED_OPEN_MID_OFFSET (DEFERRED_OPEN_INODE_OFFSET + sizeof(SMB_INO_T))
1494 #define DEFERRED_OPEN_MSG_LEN OPLOCK_BREAK_MSG_LEN
1497 * Capabilities abstracted for different systems.
1500 #define KERNEL_OPLOCK_CAPABILITY 0x1
1503 * Oplock break command code sent via the kernel interface (if it exists).
1505 * Form of this is :
1507 * 0 2 2+devsize 2+devsize+inodesize
1508 * +----+--------+--------+----------+
1509 * | cmd| dev | inode | fileid |
1510 * +----+--------+--------+----------+
1512 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1513 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1514 #define KERNEL_OPLOCK_BREAK_FILEID_OFFSET (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1515 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1518 /* if a kernel does support oplocks then a structure of the following
1519 typee is used to describe how to interact with the kernel */
1520 struct kernel_oplocks {
1521 BOOL (*receive_message)(fd_set *fds, char *buffer, int buffer_len);
1522 BOOL (*set_oplock)(files_struct *fsp, int oplock_type);
1523 void (*release_oplock)(files_struct *fsp);
1524 BOOL (*parse_message)(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev, unsigned long *file_id);
1525 BOOL (*msg_waiting)(fd_set *fds);
1526 int notification_fd;
1530 #define CMD_REPLY 0x8000
1532 /* this structure defines the functions for doing change notify in
1533 various implementations */
1534 struct cnotify_fns {
1535 void * (*register_notify)(connection_struct *conn, char *path, uint32 flags);
1536 BOOL (*check_notify)(connection_struct *conn, uint16 vuid, char *path, uint32 flags, void *data, time_t t);
1537 void (*remove_notify)(void *data);
1538 int select_time;
1543 #include "smb_macros.h"
1545 #define MAX_NETBIOSNAME_LEN 16
1546 /* DOS character, NetBIOS namestring. Type used on the wire. */
1547 typedef char nstring[MAX_NETBIOSNAME_LEN];
1548 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1549 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1551 /* A netbios name structure. */
1552 struct nmb_name {
1553 nstring name;
1554 char scope[64];
1555 unsigned int name_type;
1559 /* A netbios node status array element. */
1560 struct node_status {
1561 nstring name;
1562 unsigned char type;
1563 unsigned char flags;
1566 /* The extra info from a NetBIOS node status query */
1567 struct node_status_extra {
1568 unsigned char mac_addr[6];
1569 /* There really is more here ... */
1572 struct pwd_info
1574 BOOL null_pwd;
1575 BOOL cleartext;
1577 fstring password;
1581 typedef struct user_struct
1583 struct user_struct *next, *prev;
1584 uint16 vuid; /* Tag for this entry. */
1585 uid_t uid; /* uid of a validated user */
1586 gid_t gid; /* gid of a validated user */
1588 userdom_struct user;
1589 char *homedir;
1590 char *unix_homedir;
1591 char *logon_script;
1593 BOOL guest;
1595 /* following groups stuff added by ih */
1596 /* This groups info is needed for when we become_user() for this uid */
1597 int n_groups;
1598 gid_t *groups;
1600 NT_USER_TOKEN *nt_user_token;
1602 DATA_BLOB session_key;
1604 char *session_keystr; /* used by utmp and pam session code.
1605 TDB key string */
1606 int homes_snum;
1608 struct auth_serversupplied_info *server_info;
1610 } user_struct;
1613 struct unix_error_map {
1614 int unix_error;
1615 int dos_class;
1616 int dos_code;
1617 NTSTATUS nt_error;
1621 #include "ntdomain.h"
1623 #include "client.h"
1627 * Size of new password account encoding string. This is enough space to
1628 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1629 * Do not change unless you are adding new ACB bits!
1632 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1635 Do you want session setups at user level security with a invalid
1636 password to be rejected or allowed in as guest? WinNT rejects them
1637 but it can be a pain as it means "net view" needs to use a password
1639 You have 3 choices in the setting of map_to_guest:
1641 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1642 are rejected. This is the default.
1644 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1645 are rejected, unless the username does not exist, in which case it
1646 is treated as a guest login
1648 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1649 are treated as a guest login
1651 Note that map_to_guest only has an effect in user or server
1652 level security.
1655 #define NEVER_MAP_TO_GUEST 0
1656 #define MAP_TO_GUEST_ON_BAD_USER 1
1657 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1659 #define SAFE_NETBIOS_CHARS ". -_"
1661 /* generic iconv conversion structure */
1662 typedef struct _smb_iconv_t {
1663 size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
1664 char **outbuf, size_t *outbytesleft);
1665 size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
1666 char **outbuf, size_t *outbytesleft);
1667 size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
1668 char **outbuf, size_t *outbytesleft);
1669 void *cd_direct, *cd_pull, *cd_push;
1670 char *from_name, *to_name;
1671 } *smb_iconv_t;
1673 /* The maximum length of a trust account password.
1674 Used when we randomly create it, 15 char passwords
1675 exceed NT4's max password length */
1677 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1679 #include "popt_common.h"
1681 #define PORT_NONE 0
1682 #ifndef LDAP_PORT
1683 #define LDAP_PORT 389
1684 #endif
1686 /* used by the IP comparison function */
1687 struct ip_service {
1688 struct in_addr ip;
1689 unsigned port;
1692 /* Used by the SMB signing functions. */
1694 typedef struct smb_sign_info {
1695 void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1696 BOOL (*check_incoming_message)(char *inbuf, struct smb_sign_info *si, BOOL must_be_ok);
1697 void (*free_signing_context)(struct smb_sign_info *si);
1698 void *signing_context;
1700 BOOL negotiated_smb_signing;
1701 BOOL allow_smb_signing;
1702 BOOL doing_signing;
1703 BOOL mandatory_signing;
1704 BOOL seen_valid; /* Have I ever seen a validly signed packet? */
1705 } smb_sign_info;
1707 struct ea_struct {
1708 uint8 flags;
1709 char *name;
1710 DATA_BLOB value;
1713 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1714 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1715 /* EA to use for DOS attributes */
1716 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1718 #endif /* _SMB_H */