r4516: current with 3.0 as of r4514. Updated release notes
[Samba.git] / source / include / smb.h
bloba7db0c0a868dca21ee938d384061eae3a94340a0
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 */
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;
285 * The complete list of SIDS belonging to this user.
286 * Created when a vuid is registered.
287 * The definition of the user_sids array is as follows :
289 * token->user_sids[0] = primary user SID.
290 * token->user_sids[1] = primary group SID.
291 * token->user_sids[2..num_sids] = supplementary group SIDS.
294 #define PRIMARY_USER_SID_INDEX 0
295 #define PRIMARY_GROUP_SID_INDEX 1
297 typedef struct _nt_user_token {
298 size_t num_sids;
299 DOM_SID *user_sids;
300 } NT_USER_TOKEN;
302 /*** query a local group, get a list of these: shows who is in that group ***/
304 /* local group member info */
305 typedef struct local_grp_member_info
307 DOM_SID sid ; /* matches with name */
308 uint8 sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
309 fstring name ; /* matches with sid: must be of the form "DOMAIN\account" */
311 } LOCAL_GRP_MEMBER;
313 /* enumerate these to get list of local groups */
315 /* local group info */
316 typedef struct local_grp_info
318 fstring name;
319 fstring comment;
321 } LOCAL_GRP;
323 /*** enumerate these to get list of domain groups ***/
325 /* domain group member info */
326 typedef struct domain_grp_info
328 fstring name;
329 fstring comment;
330 uint32 rid; /* group rid */
331 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
333 } DOMAIN_GRP;
335 /*** query a domain group, get a list of these: shows who is in that group ***/
337 /* domain group info */
338 typedef struct domain_grp_member_info
340 fstring name;
341 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
343 } DOMAIN_GRP_MEMBER;
345 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
346 typedef struct time_info
348 uint32 time;
349 } UTIME;
351 /* Structure used when SMBwritebmpx is active */
352 typedef struct
354 size_t wr_total_written; /* So we know when to discard this */
355 int32 wr_timeout;
356 int32 wr_errclass;
357 int32 wr_error; /* Cached errors */
358 BOOL wr_mode; /* write through mode) */
359 BOOL wr_discard; /* discard all further data */
360 } write_bmpx_struct;
362 typedef struct write_cache
364 SMB_OFF_T file_size;
365 SMB_OFF_T offset;
366 size_t alloc_size;
367 size_t data_size;
368 char *data;
369 } write_cache;
371 typedef struct
373 smb_ucs2_t *origname;
374 smb_ucs2_t *filename;
375 SMB_STRUCT_STAT *statinfo;
376 } smb_filename;
378 #include "fake_file.h"
380 typedef struct files_struct {
381 struct files_struct *next, *prev;
382 int fnum;
383 struct connection_struct *conn;
384 int fd;
385 uint16 rap_print_jobid;
386 SMB_DEV_T dev;
387 SMB_INO_T inode;
388 BOOL delete_on_close;
389 SMB_OFF_T pos;
390 SMB_BIG_UINT size;
391 SMB_BIG_UINT initial_allocation_size; /* Faked up initial allocation on disk. */
392 SMB_BIG_UINT position_information;
393 mode_t mode;
394 uint16 file_pid;
395 uint16 vuid;
396 write_bmpx_struct *wbmpx_ptr;
397 write_cache *wcp;
398 struct timeval open_time;
399 int share_mode;
400 uint32 desired_access;
401 time_t pending_modtime;
402 int oplock_type;
403 int sent_oplock_break;
404 unsigned long file_id;
405 BOOL can_lock;
406 BOOL can_read;
407 BOOL can_write;
408 BOOL print_file;
409 BOOL modified;
410 BOOL is_directory;
411 BOOL is_stat;
412 BOOL directory_delete_on_close;
413 char *fsp_name;
414 FAKE_FILE_HANDLE *fake_file_handle;
415 } files_struct;
417 #include "ntquotas.h"
418 #include "sysquotas.h"
420 /* used to hold an arbitrary blob of data */
421 typedef struct data_blob
423 uint8 *data;
424 size_t length;
425 void (*free)(struct data_blob *data_blob);
426 } DATA_BLOB;
429 * Structure used to keep directory state information around.
430 * Used in NT change-notify code.
433 typedef struct
435 time_t modify_time;
436 time_t status_time;
437 } dir_status_struct;
439 struct vuid_cache_entry
441 uint16 vuid;
442 BOOL read_only;
443 BOOL admin_user;
446 struct vuid_cache
448 unsigned int entries;
449 struct vuid_cache_entry array[VUID_CACHE_SIZE];
452 typedef struct
454 char *name;
455 BOOL is_wild;
456 } name_compare_entry;
458 /* Include VFS stuff */
460 #include "smb_acls.h"
461 #include "vfs.h"
463 typedef struct connection_struct
465 struct connection_struct *next, *prev;
466 TALLOC_CTX *mem_ctx;
467 unsigned cnum; /* an index passed over the wire */
468 int service;
469 BOOL force_user;
470 BOOL force_group;
471 struct vuid_cache vuid_cache;
472 void *dirptr;
473 BOOL printer;
474 BOOL ipc;
475 BOOL read_only; /* Attributes for the current user of the share. */
476 BOOL admin_user; /* Attributes for the current user of the share. */
477 char *dirpath;
478 char *connectpath;
479 char *origpath;
481 struct vfs_ops vfs; /* Filesystem operations */
482 struct vfs_ops vfs_opaque; /* OPAQUE Filesystem operations */
483 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
485 char *user; /* name of user who *opened* this connection */
486 uid_t uid; /* uid of user who *opened* this connection */
487 gid_t gid; /* gid of user who *opened* this connection */
488 char client_address[18]; /* String version of client IP address. */
490 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
492 /* following groups stuff added by ih */
494 /* This groups info is valid for the user that *opened* the connection */
495 int ngroups;
496 gid_t *groups;
497 NT_USER_TOKEN *nt_user_token;
499 time_t lastused;
500 BOOL used;
501 int num_files_open;
503 BOOL case_sensitive;
504 BOOL case_preserve;
505 BOOL short_case_preserve;
507 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
508 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
509 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
511 } connection_struct;
513 struct current_user
515 connection_struct *conn;
516 uint16 vuid;
517 uid_t uid;
518 gid_t gid;
519 int ngroups;
520 gid_t *groups;
521 NT_USER_TOKEN *nt_user_token;
524 /* Defines for the sent_oplock_break field above. */
525 #define NO_BREAK_SENT 0
526 #define EXCLUSIVE_BREAK_SENT 1
527 #define LEVEL_II_BREAK_SENT 2
529 typedef struct {
530 fstring smb_name; /* user name from the client */
531 fstring unix_name; /* unix user name of a validated user */
532 fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
533 fstring domain; /* domain that the client specified */
534 } userdom_struct;
536 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
538 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
539 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
541 typedef struct _print_queue_struct
543 int job; /* normally the UNIX jobid -- see note in
544 printing.c:traverse_fn_delete() */
545 int size;
546 int page_count;
547 int status;
548 int priority;
549 time_t time;
550 fstring fs_user;
551 fstring fs_file;
552 } print_queue_struct;
554 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
556 typedef struct
558 fstring message;
559 int qcount;
560 int status;
561 } print_status_struct;
563 /* used for server information: client, nameserv and ipc */
564 struct server_info_struct
566 fstring name;
567 uint32 type;
568 fstring comment;
569 fstring domain; /* used ONLY in ipc.c NOT namework.c */
570 BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
574 /* used for network interfaces */
575 struct interface
577 struct interface *next, *prev;
578 struct in_addr ip;
579 struct in_addr bcast;
580 struct in_addr nmask;
583 /* struct used by share mode violation error processing */
584 typedef struct {
585 pid_t pid;
586 uint16 mid;
587 struct timeval time;
588 SMB_DEV_T dev;
589 SMB_INO_T inode;
590 uint16 port;
591 } deferred_open_entry;
593 /* Internal message queue for deferred opens. */
594 struct pending_message_list {
595 struct pending_message_list *next, *prev;
596 struct timeval msg_time; /* The timeout time */
597 DATA_BLOB buf;
598 DATA_BLOB private_data;
601 /* struct returned by get_share_modes */
602 typedef struct {
603 pid_t pid;
604 uint16 op_port;
605 uint16 op_type;
606 int share_mode;
607 uint32 desired_access;
608 struct timeval time;
609 SMB_DEV_T dev;
610 SMB_INO_T inode;
611 unsigned long share_file_id;
612 } share_mode_entry;
615 #define SHAREMODE_FN_CAST() \
616 void (*)(share_mode_entry *, char*)
618 #define SHAREMODE_FN(fn) \
619 void (*fn)(share_mode_entry *, char*)
621 #define NT_HASH_LEN 16
622 #define LM_HASH_LEN 16
624 /* Password history contants. */
625 #define PW_HISTORY_SALT_LEN 16
626 #define SALTED_MD5_HASH_LEN 16
627 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
630 * Flags for account policy.
632 #define AP_MIN_PASSWORD_LEN 1
633 #define AP_PASSWORD_HISTORY 2
634 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
635 #define AP_MAX_PASSWORD_AGE 4
636 #define AP_MIN_PASSWORD_AGE 5
637 #define AP_LOCK_ACCOUNT_DURATION 6
638 #define AP_RESET_COUNT_TIME 7
639 #define AP_BAD_ATTEMPT_LOCKOUT 8
640 #define AP_TIME_TO_LOGOUT 9
644 * Flags for local user manipulation.
647 #define LOCAL_ADD_USER 0x1
648 #define LOCAL_DELETE_USER 0x2
649 #define LOCAL_DISABLE_USER 0x4
650 #define LOCAL_ENABLE_USER 0x8
651 #define LOCAL_TRUST_ACCOUNT 0x10
652 #define LOCAL_SET_NO_PASSWORD 0x20
653 #define LOCAL_SET_PASSWORD 0x40
654 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
655 #define LOCAL_INTERDOM_ACCOUNT 0x100
656 #define LOCAL_AM_ROOT 0x200 /* Act as root */
658 /* key and data in the connections database - used in smbstatus and smbd */
659 struct connections_key {
660 pid_t pid;
661 int cnum;
662 fstring name;
665 struct connections_data {
666 int magic;
667 pid_t pid;
668 int cnum;
669 uid_t uid;
670 gid_t gid;
671 char name[24];
672 char addr[24];
673 char machine[FSTRING_LEN];
674 time_t start;
675 uint32 bcast_msg_flags;
679 /* key and data records in the tdb locking database */
680 struct locking_key {
681 SMB_DEV_T dev;
682 SMB_INO_T inode;
685 /* the following are used by loadparm for option lists */
686 typedef enum {
687 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
688 P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
689 } parm_type;
691 typedef enum {
692 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
693 } parm_class;
695 /* passed to br lock code */
696 enum brl_type {READ_LOCK, WRITE_LOCK, PENDING_LOCK};
698 struct enum_list {
699 int value;
700 const char *name;
703 #define BRLOCK_FN_CAST() \
704 void (*)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
705 enum brl_type lock_type, \
706 br_off start, br_off size)
707 #define BRLOCK_FN(fn) \
708 void (*fn)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
709 enum brl_type lock_type, \
710 br_off start, br_off size)
711 struct parm_struct
713 const char *label;
714 parm_type type;
715 parm_class class;
716 void *ptr;
717 BOOL (*special)(int snum, const char *, char **);
718 const struct enum_list *enum_list;
719 unsigned flags;
720 union {
721 BOOL bvalue;
722 int ivalue;
723 char *svalue;
724 char cvalue;
725 char **lvalue;
726 } def;
729 struct bitmap {
730 uint32 *b;
731 unsigned int n;
734 /* The following flags are used in SWAT */
735 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
736 #define FLAG_SHARE 0x0002 /* file sharing options */
737 #define FLAG_PRINT 0x0004 /* printing options */
738 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
739 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
740 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
741 #define FLAG_DEVELOPER 0x0040 /* No longer used */
742 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
743 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
744 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
746 #ifndef LOCKING_VERSION
747 #define LOCKING_VERSION 4
748 #endif /* LOCKING_VERSION */
751 /* the basic packet size, assuming no words or bytes */
752 #define smb_size 39
754 /* offsets into message for common items */
755 #define smb_com 8
756 #define smb_rcls 9
757 #define smb_reh 10
758 #define smb_err 11
759 #define smb_flg 13
760 #define smb_flg2 14
761 #define smb_pidhigh 16
762 #define smb_ss_field 18
763 #define smb_tid 28
764 #define smb_pid 30
765 #define smb_uid 32
766 #define smb_mid 34
767 #define smb_wct 36
768 #define smb_vwv 37
769 #define smb_vwv0 37
770 #define smb_vwv1 39
771 #define smb_vwv2 41
772 #define smb_vwv3 43
773 #define smb_vwv4 45
774 #define smb_vwv5 47
775 #define smb_vwv6 49
776 #define smb_vwv7 51
777 #define smb_vwv8 53
778 #define smb_vwv9 55
779 #define smb_vwv10 57
780 #define smb_vwv11 59
781 #define smb_vwv12 61
782 #define smb_vwv13 63
783 #define smb_vwv14 65
784 #define smb_vwv15 67
785 #define smb_vwv16 69
786 #define smb_vwv17 71
788 /* flag defines. CIFS spec 3.1.1 */
789 #define FLAG_SUPPORT_LOCKREAD 0x01
790 #define FLAG_CLIENT_BUF_AVAIL 0x02
791 #define FLAG_RESERVED 0x04
792 #define FLAG_CASELESS_PATHNAMES 0x08
793 #define FLAG_CANONICAL_PATHNAMES 0x10
794 #define FLAG_REQUEST_OPLOCK 0x20
795 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
796 #define FLAG_REPLY 0x80
798 /* the complete */
799 #define SMBmkdir 0x00 /* create directory */
800 #define SMBrmdir 0x01 /* delete directory */
801 #define SMBopen 0x02 /* open file */
802 #define SMBcreate 0x03 /* create file */
803 #define SMBclose 0x04 /* close file */
804 #define SMBflush 0x05 /* flush file */
805 #define SMBunlink 0x06 /* delete file */
806 #define SMBmv 0x07 /* rename file */
807 #define SMBgetatr 0x08 /* get file attributes */
808 #define SMBsetatr 0x09 /* set file attributes */
809 #define SMBread 0x0A /* read from file */
810 #define SMBwrite 0x0B /* write to file */
811 #define SMBlock 0x0C /* lock byte range */
812 #define SMBunlock 0x0D /* unlock byte range */
813 #define SMBctemp 0x0E /* create temporary file */
814 #define SMBmknew 0x0F /* make new file */
815 #define SMBchkpth 0x10 /* check directory path */
816 #define SMBexit 0x11 /* process exit */
817 #define SMBlseek 0x12 /* seek */
818 #define SMBtcon 0x70 /* tree connect */
819 #define SMBtconX 0x75 /* tree connect and X*/
820 #define SMBtdis 0x71 /* tree disconnect */
821 #define SMBnegprot 0x72 /* negotiate protocol */
822 #define SMBdskattr 0x80 /* get disk attributes */
823 #define SMBsearch 0x81 /* search directory */
824 #define SMBsplopen 0xC0 /* open print spool file */
825 #define SMBsplwr 0xC1 /* write to print spool file */
826 #define SMBsplclose 0xC2 /* close print spool file */
827 #define SMBsplretq 0xC3 /* return print queue */
828 #define SMBsends 0xD0 /* send single block message */
829 #define SMBsendb 0xD1 /* send broadcast message */
830 #define SMBfwdname 0xD2 /* forward user name */
831 #define SMBcancelf 0xD3 /* cancel forward */
832 #define SMBgetmac 0xD4 /* get machine name */
833 #define SMBsendstrt 0xD5 /* send start of multi-block message */
834 #define SMBsendend 0xD6 /* send end of multi-block message */
835 #define SMBsendtxt 0xD7 /* send text of multi-block message */
837 /* Core+ protocol */
838 #define SMBlockread 0x13 /* Lock a range and read */
839 #define SMBwriteunlock 0x14 /* Unlock a range then write */
840 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
841 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
842 #define SMBwritec 0x20 /* secondary write request */
843 #define SMBwriteclose 0x2c /* write a file then close it */
845 /* dos extended protocol */
846 #define SMBreadBraw 0x1A /* read block raw */
847 #define SMBreadBmpx 0x1B /* read block multiplexed */
848 #define SMBreadBs 0x1C /* read block (secondary response) */
849 #define SMBwriteBraw 0x1D /* write block raw */
850 #define SMBwriteBmpx 0x1E /* write block multiplexed */
851 #define SMBwriteBs 0x1F /* write block (secondary request) */
852 #define SMBwriteC 0x20 /* write complete response */
853 #define SMBsetattrE 0x22 /* set file attributes expanded */
854 #define SMBgetattrE 0x23 /* get file attributes expanded */
855 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
856 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
857 #define SMBtranss 0x26 /* transaction (secondary request/response) */
858 #define SMBioctl 0x27 /* IOCTL */
859 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
860 #define SMBcopy 0x29 /* copy */
861 #define SMBmove 0x2A /* move */
862 #define SMBecho 0x2B /* echo */
863 #define SMBopenX 0x2D /* open and X */
864 #define SMBreadX 0x2E /* read and X */
865 #define SMBwriteX 0x2F /* write and X */
866 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
867 #define SMBffirst 0x82 /* find first */
868 #define SMBfunique 0x83 /* find unique */
869 #define SMBfclose 0x84 /* find close */
870 #define SMBkeepalive 0x85 /* keepalive */
871 #define SMBinvalid 0xFE /* invalid command */
873 /* Extended 2.0 protocol */
874 #define SMBtrans2 0x32 /* TRANS2 protocol set */
875 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
876 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
877 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
878 #define SMBulogoffX 0x74 /* user logoff */
880 /* NT SMB extensions. */
881 #define SMBnttrans 0xA0 /* NT transact */
882 #define SMBnttranss 0xA1 /* NT transact secondary */
883 #define SMBntcreateX 0xA2 /* NT create and X */
884 #define SMBntcancel 0xA4 /* NT cancel */
885 #define SMBntrename 0xA5 /* NT rename */
887 /* These are the trans subcommands */
888 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
889 #define TRANSACT_DCERPCCMD 0x26
890 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
892 /* These are the TRANS2 sub commands */
893 #define TRANSACT2_OPEN 0x00
894 #define TRANSACT2_FINDFIRST 0x01
895 #define TRANSACT2_FINDNEXT 0x02
896 #define TRANSACT2_QFSINFO 0x03
897 #define TRANSACT2_SETFSINFO 0x04
898 #define TRANSACT2_QPATHINFO 0x05
899 #define TRANSACT2_SETPATHINFO 0x06
900 #define TRANSACT2_QFILEINFO 0x07
901 #define TRANSACT2_SETFILEINFO 0x08
902 #define TRANSACT2_FSCTL 0x09
903 #define TRANSACT2_IOCTL 0x0A
904 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
905 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
906 #define TRANSACT2_MKDIR 0x0D
907 #define TRANSACT2_SESSION_SETUP 0x0E
908 #define TRANSACT2_GET_DFS_REFERRAL 0x10
909 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
911 /* These are the NT transact sub commands. */
912 #define NT_TRANSACT_CREATE 1
913 #define NT_TRANSACT_IOCTL 2
914 #define NT_TRANSACT_SET_SECURITY_DESC 3
915 #define NT_TRANSACT_NOTIFY_CHANGE 4
916 #define NT_TRANSACT_RENAME 5
917 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
918 #define NT_TRANSACT_GET_USER_QUOTA 7
919 #define NT_TRANSACT_SET_USER_QUOTA 8
921 /* These are the NT transact_get_user_quota sub commands */
922 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
923 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
924 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
926 /* Relevant IOCTL codes */
927 #define IOCTL_QUERY_JOB_INFO 0x530060
929 /* these are the trans2 sub fields for primary requests */
930 #define smb_tpscnt smb_vwv0
931 #define smb_tdscnt smb_vwv1
932 #define smb_mprcnt smb_vwv2
933 #define smb_mdrcnt smb_vwv3
934 #define smb_msrcnt smb_vwv4
935 #define smb_flags smb_vwv5
936 #define smb_timeout smb_vwv6
937 #define smb_pscnt smb_vwv9
938 #define smb_psoff smb_vwv10
939 #define smb_dscnt smb_vwv11
940 #define smb_dsoff smb_vwv12
941 #define smb_suwcnt smb_vwv13
942 #define smb_setup smb_vwv14
943 #define smb_setup0 smb_setup
944 #define smb_setup1 (smb_setup+2)
945 #define smb_setup2 (smb_setup+4)
947 /* these are for the secondary requests */
948 #define smb_spscnt smb_vwv2
949 #define smb_spsoff smb_vwv3
950 #define smb_spsdisp smb_vwv4
951 #define smb_sdscnt smb_vwv5
952 #define smb_sdsoff smb_vwv6
953 #define smb_sdsdisp smb_vwv7
954 #define smb_sfid smb_vwv8
956 /* and these for responses */
957 #define smb_tprcnt smb_vwv0
958 #define smb_tdrcnt smb_vwv1
959 #define smb_prcnt smb_vwv3
960 #define smb_proff smb_vwv4
961 #define smb_prdisp smb_vwv5
962 #define smb_drcnt smb_vwv6
963 #define smb_droff smb_vwv7
964 #define smb_drdisp smb_vwv8
966 /* these are for the NT trans primary request. */
967 #define smb_nt_MaxSetupCount smb_vwv0
968 #define smb_nt_Flags (smb_vwv0 + 1)
969 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
970 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
971 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
972 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
973 #define smb_nt_ParameterCount (smb_vwv0 + 19)
974 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
975 #define smb_nt_DataCount (smb_vwv0 + 27)
976 #define smb_nt_DataOffset (smb_vwv0 + 31)
977 #define smb_nt_SetupCount (smb_vwv0 + 35)
978 #define smb_nt_Function (smb_vwv0 + 36)
979 #define smb_nt_SetupStart (smb_vwv0 + 38)
981 /* these are for the NT trans secondary request. */
982 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
983 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
984 #define smb_nts_ParameterCount (smb_vwv0 + 11)
985 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
986 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
987 #define smb_nts_DataCount (smb_vwv0 + 23)
988 #define smb_nts_DataOffset (smb_vwv0 + 27)
989 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
991 /* these are for the NT trans reply. */
992 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
993 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
994 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
995 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
996 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
997 #define smb_ntr_DataCount (smb_vwv0 + 23)
998 #define smb_ntr_DataOffset (smb_vwv0 + 27)
999 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1001 /* these are for the NT create_and_X */
1002 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1003 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1004 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1005 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1006 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1007 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1008 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1009 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1010 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1011 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1012 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1014 /* this is used on a TConX. I'm not sure the name is very helpful though */
1015 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1016 #define SMB_SHARE_IN_DFS 0x0002
1018 /* Named pipe write mode flags. Used in writeX calls. */
1019 #define PIPE_RAW_MODE 0x4
1020 #define PIPE_START_MESSAGE 0x8
1022 /* File Specific access rights */
1023 #define FILE_READ_DATA 0x00000001
1024 #define FILE_WRITE_DATA 0x00000002
1025 #define FILE_APPEND_DATA 0x00000004
1026 #define FILE_READ_EA 0x00000008 /* File and directory */
1027 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1028 #define FILE_EXECUTE 0x00000020
1029 #define FILE_DELETE_CHILD 0x00000040
1030 #define FILE_READ_ATTRIBUTES 0x00000080
1031 #define FILE_WRITE_ATTRIBUTES 0x00000100
1033 #define FILE_ALL_ACCESS 0x000001FF
1035 /* Directory specific access rights */
1036 #define FILE_LIST_DIRECTORY 0x00000001
1037 #define FILE_ADD_FILE 0x00000002
1038 #define FILE_ADD_SUBDIRECTORY 0x00000004
1039 #define FILE_TRAVERSE 0x00000020
1040 #define FILE_DELETE_CHILD 0x00000040
1042 /* the desired access to use when opening a pipe */
1043 #define DESIRED_ACCESS_PIPE 0x2019f
1045 /* Generic access masks & rights. */
1046 #define DELETE_ACCESS (1L<<16) /* 0x00010000 */
1047 #define READ_CONTROL_ACCESS (1L<<17) /* 0x00020000 */
1048 #define WRITE_DAC_ACCESS (1L<<18) /* 0x00040000 */
1049 #define WRITE_OWNER_ACCESS (1L<<19) /* 0x00080000 */
1050 #define SYNCHRONIZE_ACCESS (1L<<20) /* 0x00100000 */
1052 #define SYSTEM_SECURITY_ACCESS (1L<<24) /* 0x01000000 */
1053 #define MAXIMUM_ALLOWED_ACCESS (1L<<25) /* 0x02000000 */
1054 #define GENERIC_ALL_ACCESS (1<<28) /* 0x10000000 */
1055 #define GENERIC_EXECUTE_ACCESS (1<<29) /* 0x20000000 */
1056 #define GENERIC_WRITE_ACCESS (1<<30) /* 0x40000000 */
1057 #define GENERIC_READ_ACCESS (((unsigned)1)<<31) /* 0x80000000 */
1059 /* Mapping of generic access rights for files to specific rights. */
1061 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1063 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1064 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1066 #define FILE_GENERIC_WRITE (STANDARD_RIGHTS_WRITE_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1067 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1069 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|\
1070 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1072 /* Mapping of access rights to UNIX perms. */
1073 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1074 #define UNIX_ACCESS_R FILE_GENERIC_READ
1075 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1076 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1078 #if 0
1080 * This is the old mapping we used to use. To get W2KSP2 profiles
1081 * working we need to map to the canonical file perms.
1083 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1084 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1085 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1086 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1087 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1088 FILE_APPEND_DATA|FILE_WRITE_DATA)
1089 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1090 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1091 #endif
1093 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1095 /* Flags field. */
1096 #define REQUEST_OPLOCK 2
1097 #define REQUEST_BATCH_OPLOCK 4
1098 #define OPEN_DIRECTORY 8
1099 #define EXTENDED_RESPONSE_REQUIRED 0x10
1101 /* ShareAccess field. */
1102 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1103 #define FILE_SHARE_READ 1
1104 #define FILE_SHARE_WRITE 2
1105 #define FILE_SHARE_DELETE 4
1107 /* FileAttributesField */
1108 #define FILE_ATTRIBUTE_READONLY 0x001L
1109 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1110 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1111 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1112 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1113 #define FILE_ATTRIBUTE_NORMAL 0x080L
1114 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1115 #define FILE_ATTRIBUTE_SPARSE 0x200L
1116 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1117 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1118 #define SAMBA_ATTRIBUTES_MASK 0x7F
1120 /* Flags - combined with attributes. */
1121 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1122 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1123 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1124 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1125 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1126 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1127 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1129 /* CreateDisposition field. */
1130 #define FILE_SUPERSEDE 0
1131 #define FILE_OPEN 1
1132 #define FILE_CREATE 2
1133 #define FILE_OPEN_IF 3
1134 #define FILE_OVERWRITE 4
1135 #define FILE_OVERWRITE_IF 5
1137 /* CreateOptions field. */
1138 #define FILE_DIRECTORY_FILE 0x0001
1139 #define FILE_WRITE_THROUGH 0x0002
1140 #define FILE_SEQUENTIAL_ONLY 0x0004
1141 #define FILE_NON_DIRECTORY_FILE 0x0040
1142 #define FILE_NO_EA_KNOWLEDGE 0x0200
1143 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1144 #define FILE_RANDOM_ACCESS 0x0800
1145 #define FILE_DELETE_ON_CLOSE 0x1000
1146 #define FILE_OPEN_BY_FILE_ID 0x2000
1148 /* Responses when opening a file. */
1149 #define FILE_WAS_SUPERSEDED 0
1150 #define FILE_WAS_OPENED 1
1151 #define FILE_WAS_CREATED 2
1152 #define FILE_WAS_OVERWRITTEN 3
1154 /* File type flags */
1155 #define FILE_TYPE_DISK 0
1156 #define FILE_TYPE_BYTE_MODE_PIPE 1
1157 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1158 #define FILE_TYPE_PRINTER 3
1159 #define FILE_TYPE_COMM_DEVICE 4
1160 #define FILE_TYPE_UNKNOWN 0xFFFF
1162 /* Flag for NT transact rename call. */
1163 #define RENAME_REPLACE_IF_EXISTS 1
1165 /* flags for SMBntrename call (from Samba4) */
1166 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1167 #define RENAME_FLAG_HARD_LINK 0x103
1168 #define RENAME_FLAG_RENAME 0x104
1169 #define RENAME_FLAG_COPY 0x105
1171 /* Filesystem Attributes. */
1172 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1173 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1174 #define FILE_UNICODE_ON_DISK 0x00000004
1175 /* According to cifs9f, this is 4, not 8 */
1176 /* Acconding to testing, this actually sets the security attribute! */
1177 #define FILE_PERSISTENT_ACLS 0x00000008
1178 #define FILE_FILE_COMPRESSION 0x00000010
1179 #define FILE_VOLUME_QUOTAS 0x00000020
1180 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1181 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1182 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1183 #define FS_LFN_APIS 0x00004000
1184 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1185 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1186 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1187 #define FILE_NAMED_STREAMS 0x00040000
1188 #define FILE_READ_ONLY_VOLUME 0x00080000
1190 /* ChangeNotify flags. */
1191 #define FILE_NOTIFY_CHANGE_FILE 0x001
1192 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1193 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1194 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1195 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1196 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1197 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1198 #define FILE_NOTIFY_CHANGE_EA 0x080
1199 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1200 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x200
1202 /* where to find the base of the SMB packet proper */
1203 #define smb_base(buf) (((char *)(buf))+4)
1205 /* we don't allow server strings to be longer than 48 characters as
1206 otherwise NT will not honour the announce packets */
1207 #define MAX_SERVER_STRING_LENGTH 48
1210 #define SMB_SUCCESS 0 /* The request was successful. */
1212 #ifdef WITH_DFS
1213 void dfs_unlogin(void);
1214 extern int dcelogin_atmost_once;
1215 #endif
1217 #ifdef NOSTRDUP
1218 char *strdup(char *s);
1219 #endif
1221 #ifndef SIGNAL_CAST
1222 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1223 #endif
1225 #ifndef SELECT_CAST
1226 #define SELECT_CAST
1227 #endif
1229 /* these are used in NetServerEnum to choose what to receive */
1230 #define SV_TYPE_WORKSTATION 0x00000001
1231 #define SV_TYPE_SERVER 0x00000002
1232 #define SV_TYPE_SQLSERVER 0x00000004
1233 #define SV_TYPE_DOMAIN_CTRL 0x00000008
1234 #define SV_TYPE_DOMAIN_BAKCTRL 0x00000010
1235 #define SV_TYPE_TIME_SOURCE 0x00000020
1236 #define SV_TYPE_AFP 0x00000040
1237 #define SV_TYPE_NOVELL 0x00000080
1238 #define SV_TYPE_DOMAIN_MEMBER 0x00000100
1239 #define SV_TYPE_PRINTQ_SERVER 0x00000200
1240 #define SV_TYPE_DIALIN_SERVER 0x00000400
1241 #define SV_TYPE_SERVER_UNIX 0x00000800
1242 #define SV_TYPE_NT 0x00001000
1243 #define SV_TYPE_WFW 0x00002000
1244 #define SV_TYPE_SERVER_MFPN 0x00004000
1245 #define SV_TYPE_SERVER_NT 0x00008000
1246 #define SV_TYPE_POTENTIAL_BROWSER 0x00010000
1247 #define SV_TYPE_BACKUP_BROWSER 0x00020000
1248 #define SV_TYPE_MASTER_BROWSER 0x00040000
1249 #define SV_TYPE_DOMAIN_MASTER 0x00080000
1250 #define SV_TYPE_SERVER_OSF 0x00100000
1251 #define SV_TYPE_SERVER_VMS 0x00200000
1252 #define SV_TYPE_WIN95_PLUS 0x00400000
1253 #define SV_TYPE_DFS_SERVER 0x00800000
1254 #define SV_TYPE_ALTERNATE_XPORT 0x20000000
1255 #define SV_TYPE_LOCAL_LIST_ONLY 0x40000000
1256 #define SV_TYPE_DOMAIN_ENUM 0x80000000
1257 #define SV_TYPE_ALL 0xFFFFFFFF
1259 /* This was set by JHT in liaison with Jeremy Allison early 1997
1260 * History:
1261 * Version 4.0 - never made public
1262 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1263 * - Reappeared in 1.9.16p11 with fixed smbd services
1264 * Version 4.20 - To indicate that nmbd and browsing now works better
1265 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1267 * Note: In the presence of NT4.X do not set above 4.9
1268 * Setting this above 4.9 can have undesired side-effects.
1269 * This may change again in Samba-3.0 after further testing. JHT
1272 #define DEFAULT_MAJOR_VERSION 0x04
1273 #define DEFAULT_MINOR_VERSION 0x09
1275 /* Browser Election Values */
1276 #define BROWSER_ELECTION_VERSION 0x010f
1277 #define BROWSER_CONSTANT 0xaa55
1279 /* Sercurity mode bits. */
1280 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1281 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1282 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1283 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1285 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1287 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1288 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1289 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1290 #define FLAGS2_IS_LONG_NAME 0x0040
1291 #define FLAGS2_EXTENDED_SECURITY 0x0800
1292 #define FLAGS2_DFS_PATHNAMES 0x1000
1293 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1294 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1295 #define FLAGS2_UNICODE_STRINGS 0x8000
1297 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1299 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1301 #define CAP_RAW_MODE 0x0001
1302 #define CAP_MPX_MODE 0x0002
1303 #define CAP_UNICODE 0x0004
1304 #define CAP_LARGE_FILES 0x0008
1305 #define CAP_NT_SMBS 0x0010
1306 #define CAP_RPC_REMOTE_APIS 0x0020
1307 #define CAP_STATUS32 0x0040
1308 #define CAP_LEVEL_II_OPLOCKS 0x0080
1309 #define CAP_LOCK_AND_READ 0x0100
1310 #define CAP_NT_FIND 0x0200
1311 #define CAP_DFS 0x1000
1312 #define CAP_W2K_SMBS 0x2000
1313 #define CAP_LARGE_READX 0x4000
1314 #define CAP_LARGE_WRITEX 0x8000
1315 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1316 #define CAP_EXTENDED_SECURITY 0x80000000
1318 /* protocol types. It assumes that higher protocols include lower protocols
1319 as subsets */
1320 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1322 /* security levels */
1323 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1325 /* server roles */
1326 enum server_types
1328 ROLE_STANDALONE,
1329 ROLE_DOMAIN_MEMBER,
1330 ROLE_DOMAIN_BDC,
1331 ROLE_DOMAIN_PDC
1334 /* printing types */
1335 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1336 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1337 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2
1338 #ifdef DEVELOPER
1339 ,PRINT_TEST,PRINT_VLP
1340 #endif /* DEVELOPER */
1343 /* LDAP schema types */
1344 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1346 /* LDAP SSL options */
1347 enum ldap_ssl_types {LDAP_SSL_ON, LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1349 /* LDAP PASSWD SYNC methods */
1350 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1352 /* Remote architectures we know about. */
1353 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1354 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_SAMBA, RA_CIFSFS};
1356 /* case handling */
1357 enum case_handling {CASE_LOWER,CASE_UPPER};
1360 * Global value meaing that the smb_uid field should be
1361 * ingored (in share level security and protocol level == CORE)
1364 #define UID_FIELD_INVALID 0
1365 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1368 * Size of buffer to use when moving files across filesystems.
1370 #define COPYBUF_SIZE (8*1024)
1373 * Values used to override error codes.
1375 extern int unix_ERR_class;
1376 extern int unix_ERR_code;
1377 extern NTSTATUS unix_ERR_ntstatus;
1380 * Used in chaining code.
1382 extern int chain_size;
1385 * Map the Core and Extended Oplock requesst bits down
1386 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1390 * Core protocol.
1392 #define CORE_OPLOCK_REQUEST(inbuf) \
1393 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1396 * Extended protocol.
1398 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1400 /* Lock types. */
1401 #define LOCKING_ANDX_SHARED_LOCK 0x1
1402 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1403 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1404 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1405 #define LOCKING_ANDX_LARGE_FILES 0x10
1407 /* Oplock levels */
1408 #define OPLOCKLEVEL_NONE 0
1409 #define OPLOCKLEVEL_II 1
1412 * Bits we test with.
1415 #define NO_OPLOCK 0
1416 #define EXCLUSIVE_OPLOCK 1
1417 #define BATCH_OPLOCK 2
1418 #define LEVEL_II_OPLOCK 4
1419 #define INTERNAL_OPEN_ONLY 8
1421 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1422 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1423 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1425 #define CORE_OPLOCK_GRANTED (1<<5)
1426 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1429 * Return values for oplock types.
1432 #define NO_OPLOCK_RETURN 0
1433 #define EXCLUSIVE_OPLOCK_RETURN 1
1434 #define BATCH_OPLOCK_RETURN 2
1435 #define LEVEL_II_OPLOCK_RETURN 3
1438 * Loopback command offsets.
1441 #define OPBRK_CMD_LEN_OFFSET 0
1442 #define OPBRK_CMD_PORT_OFFSET 4
1443 #define OPBRK_CMD_HEADER_LEN 6
1445 #define OPBRK_MESSAGE_CMD_OFFSET 0
1448 * Oplock break command code to send over the udp socket.
1449 * The same message is sent for both exlusive and level II breaks.
1451 * The form of this is :
1453 * 0 2 2+pid 2+pid+dev 2+pid+dev+ino
1454 * +----+--------+-------+--------+---------+
1455 * | cmd| pid | dev | inode | fileid |
1456 * +----+--------+-------+--------+---------+
1459 #define OPLOCK_BREAK_PID_OFFSET 2
1460 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1461 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1462 #define OPLOCK_BREAK_FILEID_OFFSET (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1463 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1465 /* Message types */
1466 #define OPLOCK_BREAK_CMD 0x1
1467 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1468 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1469 #define ASYNC_LEVEL_II_OPLOCK_BREAK_CMD 0x4
1471 /* Add the "deferred open" message. */
1472 #define RETRY_DEFERRED_OPEN_CMD 0x5
1475 * And the message format for it. Keep the same message length.
1477 * 0 2 2+pid 2+pid+dev 2+pid+dev+ino
1478 * +----+--------+-------+--------+---------+
1479 * | cmd| pid | dev | inode | mid |
1480 * +----+--------+-------+--------+---------+
1483 #define DEFERRED_OPEN_CMD_OFFSET 0
1484 #define DEFERRED_OPEN_PID_OFFSET 2 /* pid we're *sending* from. */
1485 #define DEFERRED_OPEN_DEV_OFFSET (DEFERRED_OPEN_PID_OFFSET + sizeof(pid_t))
1486 #define DEFERRED_OPEN_INODE_OFFSET (DEFERRED_OPEN_DEV_OFFSET + sizeof(SMB_DEV_T))
1487 #define DEFERRED_OPEN_MID_OFFSET (DEFERRED_OPEN_INODE_OFFSET + sizeof(SMB_INO_T))
1488 #define DEFERRED_OPEN_MSG_LEN OPLOCK_BREAK_MSG_LEN
1491 * Capabilities abstracted for different systems.
1494 #define KERNEL_OPLOCK_CAPABILITY 0x1
1497 * Oplock break command code sent via the kernel interface (if it exists).
1499 * Form of this is :
1501 * 0 2 2+devsize 2+devsize+inodesize
1502 * +----+--------+--------+----------+
1503 * | cmd| dev | inode | fileid |
1504 * +----+--------+--------+----------+
1506 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1507 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1508 #define KERNEL_OPLOCK_BREAK_FILEID_OFFSET (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1509 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1512 /* if a kernel does support oplocks then a structure of the following
1513 typee is used to describe how to interact with the kernel */
1514 struct kernel_oplocks {
1515 BOOL (*receive_message)(fd_set *fds, char *buffer, int buffer_len);
1516 BOOL (*set_oplock)(files_struct *fsp, int oplock_type);
1517 void (*release_oplock)(files_struct *fsp);
1518 BOOL (*parse_message)(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev, unsigned long *file_id);
1519 BOOL (*msg_waiting)(fd_set *fds);
1520 int notification_fd;
1524 #define CMD_REPLY 0x8000
1526 /* this structure defines the functions for doing change notify in
1527 various implementations */
1528 struct cnotify_fns {
1529 void * (*register_notify)(connection_struct *conn, char *path, uint32 flags);
1530 BOOL (*check_notify)(connection_struct *conn, uint16 vuid, char *path, uint32 flags, void *data, time_t t);
1531 void (*remove_notify)(void *data);
1532 int select_time;
1537 #include "smb_macros.h"
1539 #define MAX_NETBIOSNAME_LEN 16
1540 /* DOS character, NetBIOS namestring. Type used on the wire. */
1541 typedef char nstring[MAX_NETBIOSNAME_LEN];
1542 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1543 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1545 /* A netbios name structure. */
1546 struct nmb_name {
1547 nstring name;
1548 char scope[64];
1549 unsigned int name_type;
1553 /* A netbios node status array element. */
1554 struct node_status {
1555 nstring name;
1556 unsigned char type;
1557 unsigned char flags;
1560 /* The extra info from a NetBIOS node status query */
1561 struct node_status_extra {
1562 unsigned char mac_addr[6];
1563 /* There really is more here ... */
1566 struct pwd_info
1568 BOOL null_pwd;
1569 BOOL cleartext;
1571 fstring password;
1575 typedef struct user_struct
1577 struct user_struct *next, *prev;
1578 uint16 vuid; /* Tag for this entry. */
1579 uid_t uid; /* uid of a validated user */
1580 gid_t gid; /* gid of a validated user */
1582 userdom_struct user;
1583 char *homedir;
1584 char *unix_homedir;
1585 char *logon_script;
1587 BOOL guest;
1589 /* following groups stuff added by ih */
1590 /* This groups info is needed for when we become_user() for this uid */
1591 int n_groups;
1592 gid_t *groups;
1594 NT_USER_TOKEN *nt_user_token;
1596 DATA_BLOB session_key;
1598 char *session_keystr; /* used by utmp and pam session code.
1599 TDB key string */
1600 int homes_snum;
1602 struct auth_serversupplied_info *server_info;
1604 } user_struct;
1607 struct unix_error_map {
1608 int unix_error;
1609 int dos_class;
1610 int dos_code;
1611 NTSTATUS nt_error;
1615 #include "ntdomain.h"
1617 #include "client.h"
1621 * Size of new password account encoding string. This is enough space to
1622 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1623 * Do not change unless you are adding new ACB bits!
1626 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1629 Do you want session setups at user level security with a invalid
1630 password to be rejected or allowed in as guest? WinNT rejects them
1631 but it can be a pain as it means "net view" needs to use a password
1633 You have 3 choices in the setting of map_to_guest:
1635 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1636 are rejected. This is the default.
1638 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1639 are rejected, unless the username does not exist, in which case it
1640 is treated as a guest login
1642 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1643 are treated as a guest login
1645 Note that map_to_guest only has an effect in user or server
1646 level security.
1649 #define NEVER_MAP_TO_GUEST 0
1650 #define MAP_TO_GUEST_ON_BAD_USER 1
1651 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1653 #define SAFE_NETBIOS_CHARS ". -_"
1655 /* generic iconv conversion structure */
1656 typedef struct _smb_iconv_t {
1657 size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
1658 char **outbuf, size_t *outbytesleft);
1659 size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
1660 char **outbuf, size_t *outbytesleft);
1661 size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
1662 char **outbuf, size_t *outbytesleft);
1663 void *cd_direct, *cd_pull, *cd_push;
1664 char *from_name, *to_name;
1665 } *smb_iconv_t;
1667 /* The maximum length of a trust account password.
1668 Used when we randomly create it, 15 char passwords
1669 exceed NT4's max password length */
1671 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1673 #include "popt_common.h"
1675 #define PORT_NONE 0
1676 #ifndef LDAP_PORT
1677 #define LDAP_PORT 389
1678 #endif
1680 /* used by the IP comparison function */
1681 struct ip_service {
1682 struct in_addr ip;
1683 unsigned port;
1686 /* Used by the SMB signing functions. */
1688 typedef struct smb_sign_info {
1689 void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1690 BOOL (*check_incoming_message)(char *inbuf, struct smb_sign_info *si, BOOL must_be_ok);
1691 void (*free_signing_context)(struct smb_sign_info *si);
1692 void *signing_context;
1694 BOOL negotiated_smb_signing;
1695 BOOL allow_smb_signing;
1696 BOOL doing_signing;
1697 BOOL mandatory_signing;
1698 BOOL seen_valid; /* Have I ever seen a validly signed packet? */
1699 } smb_sign_info;
1701 struct ea_struct {
1702 uint8 flags;
1703 char *name;
1704 DATA_BLOB value;
1707 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1708 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1709 /* EA to use for DOS attributes */
1710 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1712 #endif /* _SMB_H */