trying to get HEAD building again. If you want the code
[Samba/gbeck.git] / source / include / smb.h
blobd2714e78bc87ca6782201dcf8d3e397fbf75cba1
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 False (0)
46 #define True (1)
47 #define Auto (2)
48 #define Required (3)
50 #ifndef _BOOL
51 typedef int BOOL;
52 #define _BOOL /* So we don't typedef BOOL again in vfs.h */
53 #endif
55 /* limiting size of ipc replies */
56 #define REALLOC(ptr,size) Realloc(ptr,MAX((size),4*1024))
58 #define SIZEOFWORD 2
60 #ifndef DEF_CREATE_MASK
61 #define DEF_CREATE_MASK (0755)
62 #endif
64 /* string manipulation flags - see clistr.c and srvstr.c */
65 #define STR_TERMINATE 1
66 #define STR_UPPER 2
67 #define STR_ASCII 4
68 #define STR_UNICODE 8
69 #define STR_NOALIGN 16
70 #define STR_TERMINATE_ASCII 128
72 /* how long to wait for secondary SMB packets (milli-seconds) */
73 #define SMB_SECONDARY_WAIT (60*1000)
75 /* Debugging stuff */
76 #include "debug.h"
78 /* this defines the error codes that receive_smb can put in smb_read_error */
79 #define READ_TIMEOUT 1
80 #define READ_EOF 2
81 #define READ_ERROR 3
83 /* This error code can go into the client smb_rw_error. */
84 #define WRITE_ERROR 4
85 #define READ_BAD_SIG 5
87 #define DIR_STRUCT_SIZE 43
89 /* these define the attribute byte as seen by DOS */
90 #define aRONLY (1L<<0) /* 0x01 */
91 #define aHIDDEN (1L<<1) /* 0x02 */
92 #define aSYSTEM (1L<<2) /* 0x04 */
93 #define aVOLID (1L<<3) /* 0x08 */
94 #define aDIR (1L<<4) /* 0x10 */
95 #define aARCH (1L<<5) /* 0x20 */
97 /* deny modes */
98 #define DENY_DOS 0
99 #define DENY_ALL 1
100 #define DENY_WRITE 2
101 #define DENY_READ 3
102 #define DENY_NONE 4
103 #define DENY_FCB 7
105 /* open modes */
106 #define DOS_OPEN_RDONLY 0
107 #define DOS_OPEN_WRONLY 1
108 #define DOS_OPEN_RDWR 2
109 #define DOS_OPEN_FCB 0xF
111 /* define shifts and masks for share and open modes. */
112 #define OPEN_MODE_MASK 0xF
113 #define SHARE_MODE_SHIFT 4
114 #define SHARE_MODE_MASK 0x7
115 #define GET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
116 #define SET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
117 #define GET_DENY_MODE(x) (((x)>>SHARE_MODE_SHIFT) & SHARE_MODE_MASK)
118 #define SET_DENY_MODE(x) (((x) & SHARE_MODE_MASK) <<SHARE_MODE_SHIFT)
120 /* Sync on open file (not sure if used anymore... ?) */
121 #define FILE_SYNC_OPENMODE (1<<14)
122 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
124 /* allow delete on open file mode (used by NT SMB's). */
125 #define ALLOW_SHARE_DELETE (1<<15)
126 #define GET_ALLOW_SHARE_DELETE(x) (((x) & ALLOW_SHARE_DELETE) ? True : False)
127 #define SET_ALLOW_SHARE_DELETE(x) ((x) ? ALLOW_SHARE_DELETE : 0)
129 /* delete on close flag (used by NT SMB's). */
130 #define DELETE_ON_CLOSE_FLAG (1<<16)
131 #define GET_DELETE_ON_CLOSE_FLAG(x) (((x) & DELETE_ON_CLOSE_FLAG) ? True : False)
132 #define SET_DELETE_ON_CLOSE_FLAG(x) ((x) ? DELETE_ON_CLOSE_FLAG : 0)
134 /* open disposition values */
135 #define FILE_EXISTS_FAIL 0
136 #define FILE_EXISTS_OPEN 1
137 #define FILE_EXISTS_TRUNCATE 2
139 /* mask for open disposition. */
140 #define FILE_OPEN_MASK 0x3
142 #define GET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
143 #define SET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
145 /* The above can be OR'ed with... */
146 #define FILE_CREATE_IF_NOT_EXIST 0x10
147 #define FILE_FAIL_IF_NOT_EXIST 0
149 #define GET_FILE_CREATE_DISPOSITION(x) ((x) & (FILE_CREATE_IF_NOT_EXIST|FILE_FAIL_IF_NOT_EXIST))
151 /* share types */
152 #define STYPE_DISKTREE 0 /* Disk drive */
153 #define STYPE_PRINTQ 1 /* Spooler queue */
154 #define STYPE_DEVICE 2 /* Serial device */
155 #define STYPE_IPC 3 /* Interprocess communication (IPC) */
156 #define STYPE_HIDDEN 0x80000000 /* share is a hidden one (ends with $) */
158 #include "doserr.h"
160 typedef union unid_t {
161 uid_t uid;
162 gid_t gid;
163 } unid_t;
166 * SMB UCS2 (16-bit unicode) internal type.
169 typedef uint16 smb_ucs2_t;
171 /* ucs2 string types. */
172 typedef smb_ucs2_t wpstring[PSTRING_LEN];
173 typedef smb_ucs2_t wfstring[FSTRING_LEN];
175 #ifdef WORDS_BIGENDIAN
176 #define UCS2_SHIFT 8
177 #else
178 #define UCS2_SHIFT 0
179 #endif
181 /* turn a 7 bit character into a ucs2 character */
182 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
184 /* pipe string names */
185 #define PIPE_LANMAN "\\PIPE\\LANMAN"
186 #define PIPE_SRVSVC "\\PIPE\\srvsvc"
187 #define PIPE_SAMR "\\PIPE\\samr"
188 #define PIPE_WINREG "\\PIPE\\winreg"
189 #define PIPE_WKSSVC "\\PIPE\\wkssvc"
190 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
191 #define PIPE_NTLSA "\\PIPE\\ntlsa"
192 #define PIPE_NTSVCS "\\PIPE\\ntsvcs"
193 #define PIPE_LSASS "\\PIPE\\lsass"
194 #define PIPE_LSARPC "\\PIPE\\lsarpc"
195 #define PIPE_SPOOLSS "\\PIPE\\spoolss"
196 #define PIPE_NETDFS "\\PIPE\\netdfs"
197 #define PIPE_ECHO "\\PIPE\\rpcecho"
199 #define PIPE_NETLOGON_PLAIN "\\NETLOGON"
201 #define PI_LSARPC 0
202 #define PI_LSARPC_DS 1
203 #define PI_SAMR 2
204 #define PI_NETLOGON 3
205 #define PI_SRVSVC 4
206 #define PI_WKSSVC 5
207 #define PI_WINREG 6
208 #define PI_SPOOLSS 7
209 #define PI_NETDFS 8
210 #define PI_ECHO 9
211 #define PI_MAX_PIPES 10
213 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
214 typedef struct nttime_info
216 uint32 low;
217 uint32 high;
218 } NTTIME;
221 /* Allowable account control bits */
222 #define ACB_DISABLED 0x0001 /* 1 = User account disabled */
223 #define ACB_HOMDIRREQ 0x0002 /* 1 = Home directory required */
224 #define ACB_PWNOTREQ 0x0004 /* 1 = User password not required */
225 #define ACB_TEMPDUP 0x0008 /* 1 = Temporary duplicate account */
226 #define ACB_NORMAL 0x0010 /* 1 = Normal user account */
227 #define ACB_MNS 0x0020 /* 1 = MNS logon user account */
228 #define ACB_DOMTRUST 0x0040 /* 1 = Interdomain trust account */
229 #define ACB_WSTRUST 0x0080 /* 1 = Workstation trust account */
230 #define ACB_SVRTRUST 0x0100 /* 1 = Server trust account */
231 #define ACB_PWNOEXP 0x0200 /* 1 = User password does not expire */
232 #define ACB_AUTOLOCK 0x0400 /* 1 = Account auto locked */
234 #define MAX_HOURS_LEN 32
237 * window during which we must talk to the PDC to avoid
238 * sam sync delays; expressed in seconds (15 minutes is the
239 * default period for SAM replication under Windows NT 4.0
241 #define SAM_SYNC_WINDOW 900
244 #ifndef MAXSUBAUTHS
245 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
246 #endif
248 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
250 /* SID Types */
251 enum SID_NAME_USE
253 SID_NAME_USE_NONE = 0,
254 SID_NAME_USER = 1, /* user */
255 SID_NAME_DOM_GRP, /* domain group */
256 SID_NAME_DOMAIN, /* domain sid */
257 SID_NAME_ALIAS, /* local group */
258 SID_NAME_WKN_GRP, /* well-known group */
259 SID_NAME_DELETED, /* deleted account: needed for c2 rating */
260 SID_NAME_INVALID, /* invalid account */
261 SID_NAME_UNKNOWN, /* unknown sid type */
262 SID_NAME_COMPUTER /* sid for a computer */
266 * @brief Security Identifier
268 * @sa http://msdn.microsoft.com/library/default.asp?url=/library/en-us/security/accctrl_38yn.asp
270 typedef struct sid_info
272 uint8 sid_rev_num; /**< SID revision number */
273 uint8 num_auths; /**< Number of sub-authorities */
274 uint8 id_auth[6]; /**< Identifier Authority */
276 * Pointer to sub-authorities.
278 * @note The values in these uint32's are in *native* byteorder, not
279 * neccessarily little-endian...... JRA.
281 uint32 sub_auths[MAXSUBAUTHS];
283 } DOM_SID;
286 * The complete list of SIDS belonging to this user.
287 * Created when a vuid is registered.
288 * The definition of the user_sids array is as follows :
290 * token->user_sids[0] = primary user SID.
291 * token->user_sids[1] = primary group SID.
292 * token->user_sids[2..num_sids] = supplementary group SIDS.
295 #define PRIMARY_USER_SID_INDEX 0
296 #define PRIMARY_GROUP_SID_INDEX 1
298 typedef struct _nt_user_token {
299 size_t num_sids;
300 DOM_SID *user_sids;
301 } NT_USER_TOKEN;
303 /*** query a local group, get a list of these: shows who is in that group ***/
305 /* local group member info */
306 typedef struct local_grp_member_info
308 DOM_SID sid ; /* matches with name */
309 uint8 sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
310 fstring name ; /* matches with sid: must be of the form "DOMAIN\account" */
312 } LOCAL_GRP_MEMBER;
314 /* enumerate these to get list of local groups */
316 /* local group info */
317 typedef struct local_grp_info
319 fstring name;
320 fstring comment;
322 } LOCAL_GRP;
324 /*** enumerate these to get list of domain groups ***/
326 /* domain group member info */
327 typedef struct domain_grp_info
329 fstring name;
330 fstring comment;
331 uint32 rid; /* group rid */
332 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
334 } DOMAIN_GRP;
336 /*** query a domain group, get a list of these: shows who is in that group ***/
338 /* domain group info */
339 typedef struct domain_grp_member_info
341 fstring name;
342 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
344 } DOMAIN_GRP_MEMBER;
346 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
347 typedef struct time_info
349 uint32 time;
350 } UTIME;
352 /* Structure used when SMBwritebmpx is active */
353 typedef struct
355 size_t wr_total_written; /* So we know when to discard this */
356 int32 wr_timeout;
357 int32 wr_errclass;
358 int32 wr_error; /* Cached errors */
359 BOOL wr_mode; /* write through mode) */
360 BOOL wr_discard; /* discard all further data */
361 } write_bmpx_struct;
363 typedef struct write_cache
365 SMB_OFF_T file_size;
366 SMB_OFF_T offset;
367 size_t alloc_size;
368 size_t data_size;
369 char *data;
370 } write_cache;
372 typedef struct
374 smb_ucs2_t *origname;
375 smb_ucs2_t *filename;
376 SMB_STRUCT_STAT *statinfo;
377 } smb_filename;
379 #include "fake_file.h"
381 typedef struct files_struct
383 struct files_struct *next, *prev;
384 int fnum;
385 struct connection_struct *conn;
386 int fd;
387 uint16 rap_print_jobid;
388 SMB_DEV_T dev;
389 SMB_INO_T inode;
390 BOOL delete_on_close;
391 SMB_OFF_T pos;
392 SMB_BIG_UINT size;
393 SMB_BIG_UINT initial_allocation_size; /* Faked up initial allocation on disk. */
394 mode_t mode;
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 {
422 uint8 *data;
423 size_t length;
424 void (*free)(struct data_blob *data_blob);
425 } DATA_BLOB;
428 * Structure used to keep directory state information around.
429 * Used in NT change-notify code.
432 typedef struct
434 time_t modify_time;
435 time_t status_time;
436 } dir_status_struct;
438 struct vuid_cache {
439 unsigned int entries;
440 uint16 list[VUID_CACHE_SIZE];
443 typedef struct
445 char *name;
446 BOOL is_wild;
447 } name_compare_entry;
449 /* Include VFS stuff */
451 #include "smb_acls.h"
452 #include "vfs.h"
454 typedef struct connection_struct
456 struct connection_struct *next, *prev;
457 TALLOC_CTX *mem_ctx;
458 unsigned cnum; /* an index passed over the wire */
459 int service;
460 BOOL force_user;
461 BOOL force_group;
462 struct vuid_cache vuid_cache;
463 void *dirptr;
464 BOOL printer;
465 BOOL ipc;
466 BOOL read_only;
467 BOOL admin_user;
468 char *dirpath;
469 char *connectpath;
470 char *origpath;
472 struct vfs_ops vfs; /* Filesystem operations */
473 struct vfs_ops vfs_opaque; /* OPAQUE Filesystem operations */
474 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
476 char *user; /* name of user who *opened* this connection */
477 uid_t uid; /* uid of user who *opened* this connection */
478 gid_t gid; /* gid of user who *opened* this connection */
479 char client_address[18]; /* String version of client IP address. */
481 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
483 /* following groups stuff added by ih */
485 /* This groups info is valid for the user that *opened* the connection */
486 int ngroups;
487 gid_t *groups;
488 NT_USER_TOKEN *nt_user_token;
490 time_t lastused;
491 BOOL used;
492 int num_files_open;
493 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
494 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
495 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
497 } connection_struct;
499 struct current_user
501 connection_struct *conn;
502 uint16 vuid;
503 uid_t uid;
504 gid_t gid;
505 int ngroups;
506 gid_t *groups;
507 NT_USER_TOKEN *nt_user_token;
510 /* Defines for the sent_oplock_break field above. */
511 #define NO_BREAK_SENT 0
512 #define EXCLUSIVE_BREAK_SENT 1
513 #define LEVEL_II_BREAK_SENT 2
515 typedef struct {
516 fstring smb_name; /* user name from the client */
517 fstring unix_name; /* unix user name of a validated user */
518 fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
519 fstring domain; /* domain that the client specified */
520 } userdom_struct;
522 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
524 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
525 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
527 typedef struct _print_queue_struct
529 int job;
530 int size;
531 int page_count;
532 int status;
533 int priority;
534 time_t time;
535 fstring fs_user;
536 fstring fs_file;
537 } print_queue_struct;
539 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
541 typedef struct
543 fstring message;
544 int qcount;
545 int status;
546 } print_status_struct;
548 /* used for server information: client, nameserv and ipc */
549 struct server_info_struct
551 fstring name;
552 uint32 type;
553 fstring comment;
554 fstring domain; /* used ONLY in ipc.c NOT namework.c */
555 BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
559 /* used for network interfaces */
560 struct interface
562 struct interface *next, *prev;
563 struct in_addr ip;
564 struct in_addr bcast;
565 struct in_addr nmask;
568 /* struct returned by get_share_modes */
569 typedef struct {
570 pid_t pid;
571 uint16 op_port;
572 uint16 op_type;
573 int share_mode;
574 uint32 desired_access;
575 struct timeval time;
576 SMB_DEV_T dev;
577 SMB_INO_T inode;
578 unsigned long share_file_id;
579 } share_mode_entry;
582 #define SHAREMODE_FN_CAST() \
583 void (*)(share_mode_entry *, char*)
585 #define SHAREMODE_FN(fn) \
586 void (*fn)(share_mode_entry *, char*)
588 #define NT_HASH_LEN 16
589 #define LM_HASH_LEN 16
592 * Flags for account policy.
594 #define AP_MIN_PASSWORD_LEN 1
595 #define AP_PASSWORD_HISTORY 2
596 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
597 #define AP_MAX_PASSWORD_AGE 4
598 #define AP_MIN_PASSWORD_AGE 5
599 #define AP_LOCK_ACCOUNT_DURATION 6
600 #define AP_RESET_COUNT_TIME 7
601 #define AP_BAD_ATTEMPT_LOCKOUT 8
602 #define AP_TIME_TO_LOGOUT 9
606 * Flags for local user manipulation.
609 #define LOCAL_ADD_USER 0x1
610 #define LOCAL_DELETE_USER 0x2
611 #define LOCAL_DISABLE_USER 0x4
612 #define LOCAL_ENABLE_USER 0x8
613 #define LOCAL_TRUST_ACCOUNT 0x10
614 #define LOCAL_SET_NO_PASSWORD 0x20
615 #define LOCAL_SET_PASSWORD 0x40
616 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
617 #define LOCAL_INTERDOM_ACCOUNT 0x100
618 #define LOCAL_AM_ROOT 0x200 /* Act as root */
620 /* key and data in the connections database - used in smbstatus and smbd */
621 struct connections_key {
622 pid_t pid;
623 int cnum;
624 fstring name;
627 struct connections_data {
628 int magic;
629 pid_t pid;
630 int cnum;
631 uid_t uid;
632 gid_t gid;
633 char name[24];
634 char addr[24];
635 char machine[FSTRING_LEN];
636 time_t start;
637 uint32 bcast_msg_flags;
641 /* key and data records in the tdb locking database */
642 struct locking_key {
643 SMB_DEV_T dev;
644 SMB_INO_T inode;
647 struct locking_data {
648 union {
649 int num_share_mode_entries;
650 share_mode_entry dummy; /* Needed for alignment. */
651 } u;
652 /* the following two entries are implicit
653 share_mode_entry modes[num_share_mode_entries];
654 char file_name[];
659 /* the following are used by loadparm for option lists */
660 typedef enum
662 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
663 P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
664 } parm_type;
666 typedef enum
668 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
669 } parm_class;
671 /* passed to br lock code */
672 enum brl_type {READ_LOCK, WRITE_LOCK, PENDING_LOCK};
674 struct enum_list {
675 int value;
676 const char *name;
679 #define BRLOCK_FN_CAST() \
680 void (*)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
681 enum brl_type lock_type, \
682 br_off start, br_off size)
683 #define BRLOCK_FN(fn) \
684 void (*fn)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
685 enum brl_type lock_type, \
686 br_off start, br_off size)
687 struct parm_struct
689 const char *label;
690 parm_type type;
691 parm_class class;
692 void *ptr;
693 BOOL (*special)(const char *, char **);
694 const struct enum_list *enum_list;
695 unsigned flags;
696 union {
697 BOOL bvalue;
698 int ivalue;
699 char *svalue;
700 char cvalue;
701 char **lvalue;
702 } def;
705 struct bitmap {
706 uint32 *b;
707 unsigned int n;
710 #define FLAG_BASIC 0x0001 /* fundamental options */
711 #define FLAG_SHARE 0x0002 /* file sharing options */
712 #define FLAG_PRINT 0x0004 /* printing options */
713 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
714 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
715 #define FLAG_ADVANCED 0x0020 /* Parameters that the wizard will operate on */
716 #define FLAG_DEVELOPER 0x0040 /* Parameters that the wizard will operate on */
717 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
718 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
719 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
721 #ifndef LOCKING_VERSION
722 #define LOCKING_VERSION 4
723 #endif /* LOCKING_VERSION */
726 /* the basic packet size, assuming no words or bytes */
727 #define smb_size 39
729 /* offsets into message for common items */
730 #define smb_com 8
731 #define smb_rcls 9
732 #define smb_reh 10
733 #define smb_err 11
734 #define smb_flg 13
735 #define smb_flg2 14
736 #define smb_pidhigh 16
737 #define smb_ss_field 18
738 #define smb_tid 28
739 #define smb_pid 30
740 #define smb_uid 32
741 #define smb_mid 34
742 #define smb_wct 36
743 #define smb_vwv 37
744 #define smb_vwv0 37
745 #define smb_vwv1 39
746 #define smb_vwv2 41
747 #define smb_vwv3 43
748 #define smb_vwv4 45
749 #define smb_vwv5 47
750 #define smb_vwv6 49
751 #define smb_vwv7 51
752 #define smb_vwv8 53
753 #define smb_vwv9 55
754 #define smb_vwv10 57
755 #define smb_vwv11 59
756 #define smb_vwv12 61
757 #define smb_vwv13 63
758 #define smb_vwv14 65
759 #define smb_vwv15 67
760 #define smb_vwv16 69
761 #define smb_vwv17 71
763 /* flag defines. CIFS spec 3.1.1 */
764 #define FLAG_SUPPORT_LOCKREAD 0x01
765 #define FLAG_CLIENT_BUF_AVAIL 0x02
766 #define FLAG_RESERVED 0x04
767 #define FLAG_CASELESS_PATHNAMES 0x08
768 #define FLAG_CANONICAL_PATHNAMES 0x10
769 #define FLAG_REQUEST_OPLOCK 0x20
770 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
771 #define FLAG_REPLY 0x80
773 /* the complete */
774 #define SMBmkdir 0x00 /* create directory */
775 #define SMBrmdir 0x01 /* delete directory */
776 #define SMBopen 0x02 /* open file */
777 #define SMBcreate 0x03 /* create file */
778 #define SMBclose 0x04 /* close file */
779 #define SMBflush 0x05 /* flush file */
780 #define SMBunlink 0x06 /* delete file */
781 #define SMBmv 0x07 /* rename file */
782 #define SMBgetatr 0x08 /* get file attributes */
783 #define SMBsetatr 0x09 /* set file attributes */
784 #define SMBread 0x0A /* read from file */
785 #define SMBwrite 0x0B /* write to file */
786 #define SMBlock 0x0C /* lock byte range */
787 #define SMBunlock 0x0D /* unlock byte range */
788 #define SMBctemp 0x0E /* create temporary file */
789 #define SMBmknew 0x0F /* make new file */
790 #define SMBchkpth 0x10 /* check directory path */
791 #define SMBexit 0x11 /* process exit */
792 #define SMBlseek 0x12 /* seek */
793 #define SMBtcon 0x70 /* tree connect */
794 #define SMBtconX 0x75 /* tree connect and X*/
795 #define SMBtdis 0x71 /* tree disconnect */
796 #define SMBnegprot 0x72 /* negotiate protocol */
797 #define SMBdskattr 0x80 /* get disk attributes */
798 #define SMBsearch 0x81 /* search directory */
799 #define SMBsplopen 0xC0 /* open print spool file */
800 #define SMBsplwr 0xC1 /* write to print spool file */
801 #define SMBsplclose 0xC2 /* close print spool file */
802 #define SMBsplretq 0xC3 /* return print queue */
803 #define SMBsends 0xD0 /* send single block message */
804 #define SMBsendb 0xD1 /* send broadcast message */
805 #define SMBfwdname 0xD2 /* forward user name */
806 #define SMBcancelf 0xD3 /* cancel forward */
807 #define SMBgetmac 0xD4 /* get machine name */
808 #define SMBsendstrt 0xD5 /* send start of multi-block message */
809 #define SMBsendend 0xD6 /* send end of multi-block message */
810 #define SMBsendtxt 0xD7 /* send text of multi-block message */
812 /* Core+ protocol */
813 #define SMBlockread 0x13 /* Lock a range and read */
814 #define SMBwriteunlock 0x14 /* Unlock a range then write */
815 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
816 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
817 #define SMBwritec 0x20 /* secondary write request */
818 #define SMBwriteclose 0x2c /* write a file then close it */
820 /* dos extended protocol */
821 #define SMBreadBraw 0x1A /* read block raw */
822 #define SMBreadBmpx 0x1B /* read block multiplexed */
823 #define SMBreadBs 0x1C /* read block (secondary response) */
824 #define SMBwriteBraw 0x1D /* write block raw */
825 #define SMBwriteBmpx 0x1E /* write block multiplexed */
826 #define SMBwriteBs 0x1F /* write block (secondary request) */
827 #define SMBwriteC 0x20 /* write complete response */
828 #define SMBsetattrE 0x22 /* set file attributes expanded */
829 #define SMBgetattrE 0x23 /* get file attributes expanded */
830 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
831 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
832 #define SMBtranss 0x26 /* transaction (secondary request/response) */
833 #define SMBioctl 0x27 /* IOCTL */
834 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
835 #define SMBcopy 0x29 /* copy */
836 #define SMBmove 0x2A /* move */
837 #define SMBecho 0x2B /* echo */
838 #define SMBopenX 0x2D /* open and X */
839 #define SMBreadX 0x2E /* read and X */
840 #define SMBwriteX 0x2F /* write and X */
841 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
842 #define SMBffirst 0x82 /* find first */
843 #define SMBfunique 0x83 /* find unique */
844 #define SMBfclose 0x84 /* find close */
845 #define SMBkeepalive 0x85 /* keepalive */
846 #define SMBinvalid 0xFE /* invalid command */
848 /* Extended 2.0 protocol */
849 #define SMBtrans2 0x32 /* TRANS2 protocol set */
850 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
851 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
852 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
853 #define SMBulogoffX 0x74 /* user logoff */
855 /* NT SMB extensions. */
856 #define SMBnttrans 0xA0 /* NT transact */
857 #define SMBnttranss 0xA1 /* NT transact secondary */
858 #define SMBntcreateX 0xA2 /* NT create and X */
859 #define SMBntcancel 0xA4 /* NT cancel */
861 /* These are the trans subcommands */
862 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
863 #define TRANSACT_DCERPCCMD 0x26
864 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
866 /* These are the TRANS2 sub commands */
867 #define TRANSACT2_OPEN 0x00
868 #define TRANSACT2_FINDFIRST 0x01
869 #define TRANSACT2_FINDNEXT 0x02
870 #define TRANSACT2_QFSINFO 0x03
871 #define TRANSACT2_SETFSINFO 0x04
872 #define TRANSACT2_QPATHINFO 0x05
873 #define TRANSACT2_SETPATHINFO 0x06
874 #define TRANSACT2_QFILEINFO 0x07
875 #define TRANSACT2_SETFILEINFO 0x08
876 #define TRANSACT2_FSCTL 0x09
877 #define TRANSACT2_IOCTL 0x0A
878 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
879 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
880 #define TRANSACT2_MKDIR 0x0D
881 #define TRANSACT2_SESSION_SETUP 0x0E
882 #define TRANSACT2_GET_DFS_REFERRAL 0x10
883 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
885 /* These are the NT transact sub commands. */
886 #define NT_TRANSACT_CREATE 1
887 #define NT_TRANSACT_IOCTL 2
888 #define NT_TRANSACT_SET_SECURITY_DESC 3
889 #define NT_TRANSACT_NOTIFY_CHANGE 4
890 #define NT_TRANSACT_RENAME 5
891 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
892 #define NT_TRANSACT_GET_USER_QUOTA 7
893 #define NT_TRANSACT_SET_USER_QUOTA 8
895 /* These are the NT transact_get_user_quota sub commands */
896 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
897 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
898 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
900 /* Relevant IOCTL codes */
901 #define IOCTL_QUERY_JOB_INFO 0x530060
903 /* these are the trans2 sub fields for primary requests */
904 #define smb_tpscnt smb_vwv0
905 #define smb_tdscnt smb_vwv1
906 #define smb_mprcnt smb_vwv2
907 #define smb_mdrcnt smb_vwv3
908 #define smb_msrcnt smb_vwv4
909 #define smb_flags smb_vwv5
910 #define smb_timeout smb_vwv6
911 #define smb_pscnt smb_vwv9
912 #define smb_psoff smb_vwv10
913 #define smb_dscnt smb_vwv11
914 #define smb_dsoff smb_vwv12
915 #define smb_suwcnt smb_vwv13
916 #define smb_setup smb_vwv14
917 #define smb_setup0 smb_setup
918 #define smb_setup1 (smb_setup+2)
919 #define smb_setup2 (smb_setup+4)
921 /* these are for the secondary requests */
922 #define smb_spscnt smb_vwv2
923 #define smb_spsoff smb_vwv3
924 #define smb_spsdisp smb_vwv4
925 #define smb_sdscnt smb_vwv5
926 #define smb_sdsoff smb_vwv6
927 #define smb_sdsdisp smb_vwv7
928 #define smb_sfid smb_vwv8
930 /* and these for responses */
931 #define smb_tprcnt smb_vwv0
932 #define smb_tdrcnt smb_vwv1
933 #define smb_prcnt smb_vwv3
934 #define smb_proff smb_vwv4
935 #define smb_prdisp smb_vwv5
936 #define smb_drcnt smb_vwv6
937 #define smb_droff smb_vwv7
938 #define smb_drdisp smb_vwv8
940 /* these are for the NT trans primary request. */
941 #define smb_nt_MaxSetupCount smb_vwv0
942 #define smb_nt_Flags (smb_vwv0 + 1)
943 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
944 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
945 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
946 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
947 #define smb_nt_ParameterCount (smb_vwv0 + 19)
948 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
949 #define smb_nt_DataCount (smb_vwv0 + 27)
950 #define smb_nt_DataOffset (smb_vwv0 + 31)
951 #define smb_nt_SetupCount (smb_vwv0 + 35)
952 #define smb_nt_Function (smb_vwv0 + 36)
953 #define smb_nt_SetupStart (smb_vwv0 + 38)
955 /* these are for the NT trans secondary request. */
956 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
957 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
958 #define smb_nts_ParameterCount (smb_vwv0 + 11)
959 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
960 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
961 #define smb_nts_DataCount (smb_vwv0 + 23)
962 #define smb_nts_DataOffset (smb_vwv0 + 27)
963 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
965 /* these are for the NT trans reply. */
966 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
967 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
968 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
969 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
970 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
971 #define smb_ntr_DataCount (smb_vwv0 + 23)
972 #define smb_ntr_DataOffset (smb_vwv0 + 27)
973 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
975 /* these are for the NT create_and_X */
976 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
977 #define smb_ntcreate_Flags (smb_vwv0 + 7)
978 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
979 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
980 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
981 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
982 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
983 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
984 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
985 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
986 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
988 /* this is used on a TConX. I'm not sure the name is very helpful though */
989 #define SMB_SUPPORT_SEARCH_BITS 0x0001
990 #define SMB_SHARE_IN_DFS 0x0002
992 /* Named pipe write mode flags. Used in writeX calls. */
993 #define PIPE_RAW_MODE 0x4
994 #define PIPE_START_MESSAGE 0x8
996 /* File Specific access rights */
997 #define FILE_READ_DATA 0x00000001
998 #define FILE_WRITE_DATA 0x00000002
999 #define FILE_APPEND_DATA 0x00000004
1000 #define FILE_READ_EA 0x00000008 /* File and directory */
1001 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1002 #define FILE_EXECUTE 0x00000020
1003 #define FILE_DELETE_CHILD 0x00000040
1004 #define FILE_READ_ATTRIBUTES 0x00000080
1005 #define FILE_WRITE_ATTRIBUTES 0x00000100
1007 #define FILE_ALL_ACCESS 0x000001FF
1009 /* Directory specific access rights */
1010 #define FILE_LIST_DIRECTORY 0x00000001
1011 #define FILE_ADD_FILE 0x00000002
1012 #define FILE_ADD_SUBDIRECTORY 0x00000004
1013 #define FILE_TRAVERSE 0x00000020
1014 #define FILE_DELETE_CHILD 0x00000040
1016 /* the desired access to use when opening a pipe */
1017 #define DESIRED_ACCESS_PIPE 0x2019f
1019 /* Generic access masks & rights. */
1020 #define DELETE_ACCESS (1L<<16) /* 0x00010000 */
1021 #define READ_CONTROL_ACCESS (1L<<17) /* 0x00020000 */
1022 #define WRITE_DAC_ACCESS (1L<<18) /* 0x00040000 */
1023 #define WRITE_OWNER_ACCESS (1L<<19) /* 0x00080000 */
1024 #define SYNCHRONIZE_ACCESS (1L<<20) /* 0x00100000 */
1026 #define SYSTEM_SECURITY_ACCESS (1L<<24) /* 0x01000000 */
1027 #define MAXIMUM_ALLOWED_ACCESS (1L<<25) /* 0x02000000 */
1028 #define GENERIC_ALL_ACCESS (1<<28) /* 0x10000000 */
1029 #define GENERIC_EXECUTE_ACCESS (1<<29) /* 0x20000000 */
1030 #define GENERIC_WRITE_ACCESS (1<<30) /* 0x40000000 */
1031 #define GENERIC_READ_ACCESS (((unsigned)1)<<31) /* 0x80000000 */
1033 /* Mapping of generic access rights for files to specific rights. */
1035 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1037 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1038 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1040 #define FILE_GENERIC_WRITE (STANDARD_RIGHTS_WRITE_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1041 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1043 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
1044 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1046 /* Mapping of access rights to UNIX perms. */
1047 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1048 #define UNIX_ACCESS_R FILE_GENERIC_READ
1049 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1050 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1052 #if 0
1054 * This is the old mapping we used to use. To get W2KSP2 profiles
1055 * working we need to map to the canonical file perms.
1057 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1058 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1059 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1060 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1061 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1062 FILE_APPEND_DATA|FILE_WRITE_DATA)
1063 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1064 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1065 #endif
1067 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1069 /* Flags field. */
1070 #define REQUEST_OPLOCK 2
1071 #define REQUEST_BATCH_OPLOCK 4
1072 #define OPEN_DIRECTORY 8
1074 /* ShareAccess field. */
1075 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1076 #define FILE_SHARE_READ 1
1077 #define FILE_SHARE_WRITE 2
1078 #define FILE_SHARE_DELETE 4
1080 /* FileAttributesField */
1081 #define FILE_ATTRIBUTE_READONLY 0x001L
1082 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1083 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1084 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1085 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1086 #define FILE_ATTRIBUTE_NORMAL 0x080L
1087 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1088 #define FILE_ATTRIBUTE_SPARSE 0x200L
1089 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1090 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1091 #define SAMBA_ATTRIBUTES_MASK 0x7F
1093 /* Flags - combined with attributes. */
1094 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1095 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1096 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1097 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1098 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1099 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1100 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1102 /* CreateDisposition field. */
1103 #define FILE_SUPERSEDE 0
1104 #define FILE_OPEN 1
1105 #define FILE_CREATE 2
1106 #define FILE_OPEN_IF 3
1107 #define FILE_OVERWRITE 4
1108 #define FILE_OVERWRITE_IF 5
1110 /* CreateOptions field. */
1111 #define FILE_DIRECTORY_FILE 0x0001
1112 #define FILE_WRITE_THROUGH 0x0002
1113 #define FILE_SEQUENTIAL_ONLY 0x0004
1114 #define FILE_NON_DIRECTORY_FILE 0x0040
1115 #define FILE_NO_EA_KNOWLEDGE 0x0200
1116 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1117 #define FILE_RANDOM_ACCESS 0x0800
1118 #define FILE_DELETE_ON_CLOSE 0x1000
1119 #define FILE_OPEN_BY_FILE_ID 0x2000
1121 /* Responses when opening a file. */
1122 #define FILE_WAS_SUPERSEDED 0
1123 #define FILE_WAS_OPENED 1
1124 #define FILE_WAS_CREATED 2
1125 #define FILE_WAS_OVERWRITTEN 3
1127 /* File type flags */
1128 #define FILE_TYPE_DISK 0
1129 #define FILE_TYPE_BYTE_MODE_PIPE 1
1130 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1131 #define FILE_TYPE_PRINTER 3
1132 #define FILE_TYPE_COMM_DEVICE 4
1133 #define FILE_TYPE_UNKNOWN 0xFFFF
1135 /* Flag for NT transact rename call. */
1136 #define RENAME_REPLACE_IF_EXISTS 1
1138 /* Filesystem Attributes. */
1139 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1140 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1141 #define FILE_UNICODE_ON_DISK 0x00000004
1142 /* According to cifs9f, this is 4, not 8 */
1143 /* Acconding to testing, this actually sets the security attribute! */
1144 #define FILE_PERSISTENT_ACLS 0x00000008
1145 #define FILE_FILE_COMPRESSION 0x00000010
1146 #define FILE_VOLUME_QUOTAS 0x00000020
1147 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1148 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1149 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1150 #define FS_LFN_APIS 0x00004000
1151 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1152 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1153 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1154 #define FILE_NAMED_STREAMS 0x00040000
1155 #define FILE_READ_ONLY_VOLUME 0x00080000
1157 /* ChangeNotify flags. */
1158 #define FILE_NOTIFY_CHANGE_FILE 0x001
1159 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1160 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1161 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1162 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1163 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1164 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1165 #define FILE_NOTIFY_CHANGE_EA 0x080
1166 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1167 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x200
1169 /* where to find the base of the SMB packet proper */
1170 #define smb_base(buf) (((char *)(buf))+4)
1172 /* we don't allow server strings to be longer than 48 characters as
1173 otherwise NT will not honour the announce packets */
1174 #define MAX_SERVER_STRING_LENGTH 48
1177 #define SMB_SUCCESS 0 /* The request was successful. */
1179 #ifdef WITH_DFS
1180 void dfs_unlogin(void);
1181 extern int dcelogin_atmost_once;
1182 #endif
1184 #ifdef NOSTRDUP
1185 char *strdup(char *s);
1186 #endif
1188 #ifndef SIGNAL_CAST
1189 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1190 #endif
1192 #ifndef SELECT_CAST
1193 #define SELECT_CAST
1194 #endif
1196 /* these are used in NetServerEnum to choose what to receive */
1197 #define SV_TYPE_WORKSTATION 0x00000001
1198 #define SV_TYPE_SERVER 0x00000002
1199 #define SV_TYPE_SQLSERVER 0x00000004
1200 #define SV_TYPE_DOMAIN_CTRL 0x00000008
1201 #define SV_TYPE_DOMAIN_BAKCTRL 0x00000010
1202 #define SV_TYPE_TIME_SOURCE 0x00000020
1203 #define SV_TYPE_AFP 0x00000040
1204 #define SV_TYPE_NOVELL 0x00000080
1205 #define SV_TYPE_DOMAIN_MEMBER 0x00000100
1206 #define SV_TYPE_PRINTQ_SERVER 0x00000200
1207 #define SV_TYPE_DIALIN_SERVER 0x00000400
1208 #define SV_TYPE_SERVER_UNIX 0x00000800
1209 #define SV_TYPE_NT 0x00001000
1210 #define SV_TYPE_WFW 0x00002000
1211 #define SV_TYPE_SERVER_MFPN 0x00004000
1212 #define SV_TYPE_SERVER_NT 0x00008000
1213 #define SV_TYPE_POTENTIAL_BROWSER 0x00010000
1214 #define SV_TYPE_BACKUP_BROWSER 0x00020000
1215 #define SV_TYPE_MASTER_BROWSER 0x00040000
1216 #define SV_TYPE_DOMAIN_MASTER 0x00080000
1217 #define SV_TYPE_SERVER_OSF 0x00100000
1218 #define SV_TYPE_SERVER_VMS 0x00200000
1219 #define SV_TYPE_WIN95_PLUS 0x00400000
1220 #define SV_TYPE_DFS_SERVER 0x00800000
1221 #define SV_TYPE_ALTERNATE_XPORT 0x20000000
1222 #define SV_TYPE_LOCAL_LIST_ONLY 0x40000000
1223 #define SV_TYPE_DOMAIN_ENUM 0x80000000
1224 #define SV_TYPE_ALL 0xFFFFFFFF
1226 /* This was set by JHT in liaison with Jeremy Allison early 1997
1227 * History:
1228 * Version 4.0 - never made public
1229 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1230 * - Reappeared in 1.9.16p11 with fixed smbd services
1231 * Version 4.20 - To indicate that nmbd and browsing now works better
1232 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1234 * Note: In the presence of NT4.X do not set above 4.9
1235 * Setting this above 4.9 can have undesired side-effects.
1236 * This may change again in Samba-3.0 after further testing. JHT
1239 #define DEFAULT_MAJOR_VERSION 0x04
1240 #define DEFAULT_MINOR_VERSION 0x09
1242 /* Browser Election Values */
1243 #define BROWSER_ELECTION_VERSION 0x010f
1244 #define BROWSER_CONSTANT 0xaa55
1246 /* Sercurity mode bits. */
1247 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1248 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1249 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1250 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1252 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1254 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1255 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1256 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1257 #define FLAGS2_IS_LONG_NAME 0x0040
1258 #define FLAGS2_EXTENDED_SECURITY 0x0800
1259 #define FLAGS2_DFS_PATHNAMES 0x1000
1260 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1261 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1262 #define FLAGS2_UNICODE_STRINGS 0x8000
1264 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1266 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1268 #define CAP_RAW_MODE 0x0001
1269 #define CAP_MPX_MODE 0x0002
1270 #define CAP_UNICODE 0x0004
1271 #define CAP_LARGE_FILES 0x0008
1272 #define CAP_NT_SMBS 0x0010
1273 #define CAP_RPC_REMOTE_APIS 0x0020
1274 #define CAP_STATUS32 0x0040
1275 #define CAP_LEVEL_II_OPLOCKS 0x0080
1276 #define CAP_LOCK_AND_READ 0x0100
1277 #define CAP_NT_FIND 0x0200
1278 #define CAP_DFS 0x1000
1279 #define CAP_W2K_SMBS 0x2000
1280 #define CAP_LARGE_READX 0x4000
1281 #define CAP_LARGE_WRITEX 0x8000
1282 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1283 #define CAP_EXTENDED_SECURITY 0x80000000
1285 /* protocol types. It assumes that higher protocols include lower protocols
1286 as subsets */
1287 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1289 /* security levels */
1290 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1292 /* server roles */
1293 enum server_types
1295 ROLE_STANDALONE,
1296 ROLE_DOMAIN_MEMBER,
1297 ROLE_DOMAIN_BDC,
1298 ROLE_DOMAIN_PDC
1301 /* printing types */
1302 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1303 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1304 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2
1305 #ifdef DEVELOPER
1306 ,PRINT_TEST,PRINT_VLP
1307 #endif /* DEVELOPER */
1310 /* LDAP schema types */
1311 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1313 /* LDAP SSL options */
1314 enum ldap_ssl_types {LDAP_SSL_ON, LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1316 /* LDAP PASSWD SYNC methods */
1317 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1319 /* Remote architectures we know about. */
1320 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_SAMBA};
1322 /* case handling */
1323 enum case_handling {CASE_LOWER,CASE_UPPER};
1326 * Global value meaing that the smb_uid field should be
1327 * ingored (in share level security and protocol level == CORE)
1330 #define UID_FIELD_INVALID 0
1331 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1334 * Size of buffer to use when moving files across filesystems.
1336 #define COPYBUF_SIZE (8*1024)
1339 * Values used to override error codes.
1341 extern int unix_ERR_class;
1342 extern int unix_ERR_code;
1343 extern NTSTATUS unix_ERR_ntstatus;
1346 * Used in chaining code.
1348 extern int chain_size;
1351 * Map the Core and Extended Oplock requesst bits down
1352 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1356 * Core protocol.
1358 #define CORE_OPLOCK_REQUEST(inbuf) \
1359 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1362 * Extended protocol.
1364 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1366 /* Lock types. */
1367 #define LOCKING_ANDX_SHARED_LOCK 0x1
1368 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1369 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1370 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1371 #define LOCKING_ANDX_LARGE_FILES 0x10
1373 /* Oplock levels */
1374 #define OPLOCKLEVEL_NONE 0
1375 #define OPLOCKLEVEL_II 1
1378 * Bits we test with.
1381 #define NO_OPLOCK 0
1382 #define EXCLUSIVE_OPLOCK 1
1383 #define BATCH_OPLOCK 2
1384 #define LEVEL_II_OPLOCK 4
1386 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1387 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1388 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1390 #define CORE_OPLOCK_GRANTED (1<<5)
1391 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1394 * Return values for oplock types.
1397 #define NO_OPLOCK_RETURN 0
1398 #define EXCLUSIVE_OPLOCK_RETURN 1
1399 #define BATCH_OPLOCK_RETURN 2
1400 #define LEVEL_II_OPLOCK_RETURN 3
1403 * Loopback command offsets.
1406 #define OPBRK_CMD_LEN_OFFSET 0
1407 #define OPBRK_CMD_PORT_OFFSET 4
1408 #define OPBRK_CMD_HEADER_LEN 6
1410 #define OPBRK_MESSAGE_CMD_OFFSET 0
1413 * Oplock break command code to send over the udp socket.
1414 * The same message is sent for both exlusive and level II breaks.
1416 * The form of this is :
1418 * 0 2 2+pid 2+pid+dev 2+pid+dev+ino
1419 * +----+--------+-------+--------+---------+
1420 * | cmd| pid | dev | inode | fileid |
1421 * +----+--------+-------+--------+---------+
1424 #define OPLOCK_BREAK_PID_OFFSET 2
1425 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1426 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1427 #define OPLOCK_BREAK_FILEID_OFFSET (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1428 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1430 /* Message types */
1431 #define OPLOCK_BREAK_CMD 0x1
1432 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1433 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1434 #define ASYNC_LEVEL_II_OPLOCK_BREAK_CMD 0x4
1437 * Capabilities abstracted for different systems.
1440 #define KERNEL_OPLOCK_CAPABILITY 0x1
1443 * Oplock break command code sent via the kernel interface (if it exists).
1445 * Form of this is :
1447 * 0 2 2+devsize 2+devsize+inodesize
1448 * +----+--------+--------+----------+
1449 * | cmd| dev | inode | fileid |
1450 * +----+--------+--------+----------+
1452 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1453 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1454 #define KERNEL_OPLOCK_BREAK_FILEID_OFFSET (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1455 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1458 /* if a kernel does support oplocks then a structure of the following
1459 typee is used to describe how to interact with the kernel */
1460 struct kernel_oplocks {
1461 BOOL (*receive_message)(fd_set *fds, char *buffer, int buffer_len);
1462 BOOL (*set_oplock)(files_struct *fsp, int oplock_type);
1463 void (*release_oplock)(files_struct *fsp);
1464 BOOL (*parse_message)(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev, unsigned long *file_id);
1465 BOOL (*msg_waiting)(fd_set *fds);
1466 int notification_fd;
1470 #define CMD_REPLY 0x8000
1472 /* this structure defines the functions for doing change notify in
1473 various implementations */
1474 struct cnotify_fns {
1475 void * (*register_notify)(connection_struct *conn, char *path, uint32 flags);
1476 BOOL (*check_notify)(connection_struct *conn, uint16 vuid, char *path, uint32 flags, void *data, time_t t);
1477 void (*remove_notify)(void *data);
1478 int select_time;
1483 #include "smb_macros.h"
1485 /* A netbios name structure. */
1486 struct nmb_name {
1487 char name[17];
1488 char scope[64];
1489 unsigned int name_type;
1493 /* A netbios node status array element. */
1494 struct node_status {
1495 char name[16];
1496 unsigned char type;
1497 unsigned char flags;
1500 struct pwd_info
1502 BOOL null_pwd;
1503 BOOL cleartext;
1504 BOOL crypted;
1506 fstring password;
1508 uchar smb_lm_pwd[16];
1509 uchar smb_nt_pwd[16];
1511 uchar smb_lm_owf[24];
1512 uchar smb_nt_owf[128];
1513 size_t nt_owf_len;
1515 uchar lm_cli_chal[8];
1516 uchar nt_cli_chal[128];
1517 size_t nt_cli_chal_len;
1519 uchar sess_key[16];
1522 typedef struct user_struct
1524 struct user_struct *next, *prev;
1525 uint16 vuid; /* Tag for this entry. */
1526 uid_t uid; /* uid of a validated user */
1527 gid_t gid; /* gid of a validated user */
1529 userdom_struct user;
1530 char *homedir;
1531 char *unix_homedir;
1532 char *logon_script;
1534 BOOL guest;
1536 /* following groups stuff added by ih */
1537 /* This groups info is needed for when we become_user() for this uid */
1538 int n_groups;
1539 gid_t *groups;
1541 NT_USER_TOKEN *nt_user_token;
1543 uint8 session_key[16];
1545 char *session_keystr; /* used by utmp and pam session code.
1546 TDB key string */
1547 int homes_snum;
1549 struct auth_serversupplied_info *server_info;
1551 } user_struct;
1554 struct unix_error_map {
1555 int unix_error;
1556 int dos_class;
1557 int dos_code;
1558 NTSTATUS nt_error;
1562 #include "ntdomain.h"
1564 #include "client.h"
1568 * Size of new password account encoding string. This is enough space to
1569 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1570 * Do not change unless you are adding new ACB bits!
1573 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1576 Do you want session setups at user level security with a invalid
1577 password to be rejected or allowed in as guest? WinNT rejects them
1578 but it can be a pain as it means "net view" needs to use a password
1580 You have 3 choices in the setting of map_to_guest:
1582 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1583 are rejected. This is the default.
1585 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1586 are rejected, unless the username does not exist, in which case it
1587 is treated as a guest login
1589 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1590 are treated as a guest login
1592 Note that map_to_guest only has an effect in user or server
1593 level security.
1596 #define NEVER_MAP_TO_GUEST 0
1597 #define MAP_TO_GUEST_ON_BAD_USER 1
1598 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1600 #define SAFE_NETBIOS_CHARS ". -_"
1602 /* generic iconv conversion structure */
1603 typedef struct {
1604 size_t (*direct)(void *cd, char **inbuf, size_t *inbytesleft,
1605 char **outbuf, size_t *outbytesleft);
1606 size_t (*pull)(void *cd, char **inbuf, size_t *inbytesleft,
1607 char **outbuf, size_t *outbytesleft);
1608 size_t (*push)(void *cd, char **inbuf, size_t *inbytesleft,
1609 char **outbuf, size_t *outbytesleft);
1610 void *cd_direct, *cd_pull, *cd_push;
1611 char *from_name, *to_name;
1612 } *smb_iconv_t;
1614 /* The maximum length of a trust account password.
1615 Used when we randomly create it, 15 char passwords
1616 exceed NT4's max password length */
1618 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1620 #include "popt_common.h"
1622 #define PORT_NONE 0
1623 #ifndef LDAP_PORT
1624 #define LDAP_PORT 389
1625 #endif
1627 /* used by the IP comparison function */
1628 struct ip_service {
1629 struct in_addr ip;
1630 unsigned port;
1633 #endif /* _SMB_H */