r248: Add support for printing out the MAC address on nmblookup.
[Samba/gebeck_regimport.git] / source3 / include / smb.h
blob30eb82ddf56465671b7d210454fe8c43181172a1
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 /* limiting size of ipc replies */
57 #define REALLOC(ptr,size) Realloc(ptr,MAX((size),4*1024))
59 #define SIZEOFWORD 2
61 #ifndef DEF_CREATE_MASK
62 #define DEF_CREATE_MASK (0755)
63 #endif
65 /* string manipulation flags - see clistr.c and srvstr.c */
66 #define STR_TERMINATE 1
67 #define STR_UPPER 2
68 #define STR_ASCII 4
69 #define STR_UNICODE 8
70 #define STR_NOALIGN 16
71 #define STR_TERMINATE_ASCII 128
73 /* how long to wait for secondary SMB packets (milli-seconds) */
74 #define SMB_SECONDARY_WAIT (60*1000)
76 /* Debugging stuff */
77 #include "debug.h"
79 /* this defines the error codes that receive_smb can put in smb_read_error */
80 #define READ_TIMEOUT 1
81 #define READ_EOF 2
82 #define READ_ERROR 3
83 #define WRITE_ERROR 4 /* This error code can go into the client smb_rw_error. */
84 #define READ_BAD_SIG 5
85 #define DO_NOT_DO_TDIS 6 /* cli_close_connection() check for this when smbfs wants to keep tree connected */
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"
198 #define PIPE_SHUTDOWN "\\PIPE\\initshutdown"
200 #define PIPE_NETLOGON_PLAIN "\\NETLOGON"
202 #define PI_LSARPC 0
203 #define PI_LSARPC_DS 1
204 #define PI_SAMR 2
205 #define PI_NETLOGON 3
206 #define PI_SRVSVC 4
207 #define PI_WKSSVC 5
208 #define PI_WINREG 6
209 #define PI_SPOOLSS 7
210 #define PI_NETDFS 8
211 #define PI_ECHO 9
212 #define PI_SHUTDOWN 10
213 #define PI_MAX_PIPES 11
215 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
216 typedef struct nttime_info
218 uint32 low;
219 uint32 high;
220 } NTTIME;
223 /* Allowable account control bits */
224 #define ACB_DISABLED 0x0001 /* 1 = User account disabled */
225 #define ACB_HOMDIRREQ 0x0002 /* 1 = Home directory required */
226 #define ACB_PWNOTREQ 0x0004 /* 1 = User password not required */
227 #define ACB_TEMPDUP 0x0008 /* 1 = Temporary duplicate account */
228 #define ACB_NORMAL 0x0010 /* 1 = Normal user account */
229 #define ACB_MNS 0x0020 /* 1 = MNS logon user account */
230 #define ACB_DOMTRUST 0x0040 /* 1 = Interdomain trust account */
231 #define ACB_WSTRUST 0x0080 /* 1 = Workstation trust account */
232 #define ACB_SVRTRUST 0x0100 /* 1 = Server trust account */
233 #define ACB_PWNOEXP 0x0200 /* 1 = User password does not expire */
234 #define ACB_AUTOLOCK 0x0400 /* 1 = Account auto locked */
236 #define MAX_HOURS_LEN 32
239 * window during which we must talk to the PDC to avoid
240 * sam sync delays; expressed in seconds (15 minutes is the
241 * default period for SAM replication under Windows NT 4.0
243 #define SAM_SYNC_WINDOW 900
246 #ifndef MAXSUBAUTHS
247 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
248 #endif
250 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
252 /* SID Types */
253 enum SID_NAME_USE
255 SID_NAME_USE_NONE = 0,
256 SID_NAME_USER = 1, /* user */
257 SID_NAME_DOM_GRP, /* domain group */
258 SID_NAME_DOMAIN, /* domain sid */
259 SID_NAME_ALIAS, /* local group */
260 SID_NAME_WKN_GRP, /* well-known group */
261 SID_NAME_DELETED, /* deleted account: needed for c2 rating */
262 SID_NAME_INVALID, /* invalid account */
263 SID_NAME_UNKNOWN, /* unknown sid type */
264 SID_NAME_COMPUTER /* sid for a computer */
268 * @brief Security Identifier
270 * @sa http://msdn.microsoft.com/library/default.asp?url=/library/en-us/security/accctrl_38yn.asp
272 typedef struct sid_info
274 uint8 sid_rev_num; /**< SID revision number */
275 uint8 num_auths; /**< Number of sub-authorities */
276 uint8 id_auth[6]; /**< Identifier Authority */
278 * Pointer to sub-authorities.
280 * @note The values in these uint32's are in *native* byteorder, not
281 * neccessarily little-endian...... JRA.
283 uint32 sub_auths[MAXSUBAUTHS];
285 } DOM_SID;
288 * The complete list of SIDS belonging to this user.
289 * Created when a vuid is registered.
290 * The definition of the user_sids array is as follows :
292 * token->user_sids[0] = primary user SID.
293 * token->user_sids[1] = primary group SID.
294 * token->user_sids[2..num_sids] = supplementary group SIDS.
297 #define PRIMARY_USER_SID_INDEX 0
298 #define PRIMARY_GROUP_SID_INDEX 1
300 typedef struct _nt_user_token {
301 size_t num_sids;
302 DOM_SID *user_sids;
303 } NT_USER_TOKEN;
305 /*** query a local group, get a list of these: shows who is in that group ***/
307 /* local group member info */
308 typedef struct local_grp_member_info
310 DOM_SID sid ; /* matches with name */
311 uint8 sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
312 fstring name ; /* matches with sid: must be of the form "DOMAIN\account" */
314 } LOCAL_GRP_MEMBER;
316 /* enumerate these to get list of local groups */
318 /* local group info */
319 typedef struct local_grp_info
321 fstring name;
322 fstring comment;
324 } LOCAL_GRP;
326 /*** enumerate these to get list of domain groups ***/
328 /* domain group member info */
329 typedef struct domain_grp_info
331 fstring name;
332 fstring comment;
333 uint32 rid; /* group rid */
334 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
336 } DOMAIN_GRP;
338 /*** query a domain group, get a list of these: shows who is in that group ***/
340 /* domain group info */
341 typedef struct domain_grp_member_info
343 fstring name;
344 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
346 } DOMAIN_GRP_MEMBER;
348 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
349 typedef struct time_info
351 uint32 time;
352 } UTIME;
354 /* Structure used when SMBwritebmpx is active */
355 typedef struct
357 size_t wr_total_written; /* So we know when to discard this */
358 int32 wr_timeout;
359 int32 wr_errclass;
360 int32 wr_error; /* Cached errors */
361 BOOL wr_mode; /* write through mode) */
362 BOOL wr_discard; /* discard all further data */
363 } write_bmpx_struct;
365 typedef struct write_cache
367 SMB_OFF_T file_size;
368 SMB_OFF_T offset;
369 size_t alloc_size;
370 size_t data_size;
371 char *data;
372 } write_cache;
374 typedef struct
376 smb_ucs2_t *origname;
377 smb_ucs2_t *filename;
378 SMB_STRUCT_STAT *statinfo;
379 } smb_filename;
381 #include "fake_file.h"
383 typedef struct files_struct
385 struct files_struct *next, *prev;
386 int fnum;
387 struct connection_struct *conn;
388 int fd;
389 uint16 rap_print_jobid;
390 SMB_DEV_T dev;
391 SMB_INO_T inode;
392 BOOL delete_on_close;
393 SMB_OFF_T pos;
394 SMB_BIG_UINT size;
395 SMB_BIG_UINT initial_allocation_size; /* Faked up initial allocation on disk. */
396 SMB_BIG_UINT position_information;
397 mode_t mode;
398 uint16 file_pid;
399 uint16 vuid;
400 write_bmpx_struct *wbmpx_ptr;
401 write_cache *wcp;
402 struct timeval open_time;
403 int share_mode;
404 uint32 desired_access;
405 time_t pending_modtime;
406 int oplock_type;
407 int sent_oplock_break;
408 unsigned long file_id;
409 BOOL can_lock;
410 BOOL can_read;
411 BOOL can_write;
412 BOOL print_file;
413 BOOL modified;
414 BOOL is_directory;
415 BOOL is_stat;
416 BOOL directory_delete_on_close;
417 char *fsp_name;
418 FAKE_FILE_HANDLE *fake_file_handle;
419 } files_struct;
421 #include "ntquotas.h"
422 #include "sysquotas.h"
424 /* used to hold an arbitrary blob of data */
425 typedef struct data_blob
427 uint8 *data;
428 size_t length;
429 void (*free)(struct data_blob *data_blob);
430 } DATA_BLOB;
433 * Structure used to keep directory state information around.
434 * Used in NT change-notify code.
437 typedef struct
439 time_t modify_time;
440 time_t status_time;
441 } dir_status_struct;
443 struct vuid_cache_entry
445 uint16 vuid;
446 BOOL read_only;
447 BOOL admin_user;
450 struct vuid_cache
452 unsigned int entries;
453 struct vuid_cache_entry array[VUID_CACHE_SIZE];
456 typedef struct
458 char *name;
459 BOOL is_wild;
460 } name_compare_entry;
462 /* Include VFS stuff */
464 #include "smb_acls.h"
465 #include "vfs.h"
467 typedef struct connection_struct
469 struct connection_struct *next, *prev;
470 TALLOC_CTX *mem_ctx;
471 unsigned cnum; /* an index passed over the wire */
472 int service;
473 BOOL force_user;
474 BOOL force_group;
475 struct vuid_cache vuid_cache;
476 void *dirptr;
477 BOOL printer;
478 BOOL ipc;
479 BOOL read_only; /* Attributes for the current user of the share. */
480 BOOL admin_user; /* Attributes for the current user of the share. */
481 char *dirpath;
482 char *connectpath;
483 char *origpath;
485 struct vfs_ops vfs; /* Filesystem operations */
486 struct vfs_ops vfs_opaque; /* OPAQUE Filesystem operations */
487 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
489 char *user; /* name of user who *opened* this connection */
490 uid_t uid; /* uid of user who *opened* this connection */
491 gid_t gid; /* gid of user who *opened* this connection */
492 char client_address[18]; /* String version of client IP address. */
494 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
496 /* following groups stuff added by ih */
498 /* This groups info is valid for the user that *opened* the connection */
499 int ngroups;
500 gid_t *groups;
501 NT_USER_TOKEN *nt_user_token;
503 time_t lastused;
504 BOOL used;
505 int num_files_open;
506 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
507 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
508 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
510 } connection_struct;
512 struct current_user
514 connection_struct *conn;
515 uint16 vuid;
516 uid_t uid;
517 gid_t gid;
518 int ngroups;
519 gid_t *groups;
520 NT_USER_TOKEN *nt_user_token;
523 /* Defines for the sent_oplock_break field above. */
524 #define NO_BREAK_SENT 0
525 #define EXCLUSIVE_BREAK_SENT 1
526 #define LEVEL_II_BREAK_SENT 2
528 typedef struct {
529 fstring smb_name; /* user name from the client */
530 fstring unix_name; /* unix user name of a validated user */
531 fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
532 fstring domain; /* domain that the client specified */
533 } userdom_struct;
535 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
537 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
538 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
540 typedef struct _print_queue_struct
542 int job; /* normally the UNIX jobid -- see note in
543 printing.c:traverse_fn_delete() */
544 int size;
545 int page_count;
546 int status;
547 int priority;
548 time_t time;
549 fstring fs_user;
550 fstring fs_file;
551 } print_queue_struct;
553 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
555 typedef struct
557 fstring message;
558 int qcount;
559 int status;
560 } print_status_struct;
562 /* used for server information: client, nameserv and ipc */
563 struct server_info_struct
565 fstring name;
566 uint32 type;
567 fstring comment;
568 fstring domain; /* used ONLY in ipc.c NOT namework.c */
569 BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
573 /* used for network interfaces */
574 struct interface
576 struct interface *next, *prev;
577 struct in_addr ip;
578 struct in_addr bcast;
579 struct in_addr nmask;
582 /* struct returned by get_share_modes */
583 typedef struct {
584 pid_t pid;
585 uint16 op_port;
586 uint16 op_type;
587 int share_mode;
588 uint32 desired_access;
589 struct timeval time;
590 SMB_DEV_T dev;
591 SMB_INO_T inode;
592 unsigned long share_file_id;
593 } share_mode_entry;
596 #define SHAREMODE_FN_CAST() \
597 void (*)(share_mode_entry *, char*)
599 #define SHAREMODE_FN(fn) \
600 void (*fn)(share_mode_entry *, char*)
602 #define NT_HASH_LEN 16
603 #define LM_HASH_LEN 16
606 * Flags for account policy.
608 #define AP_MIN_PASSWORD_LEN 1
609 #define AP_PASSWORD_HISTORY 2
610 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
611 #define AP_MAX_PASSWORD_AGE 4
612 #define AP_MIN_PASSWORD_AGE 5
613 #define AP_LOCK_ACCOUNT_DURATION 6
614 #define AP_RESET_COUNT_TIME 7
615 #define AP_BAD_ATTEMPT_LOCKOUT 8
616 #define AP_TIME_TO_LOGOUT 9
620 * Flags for local user manipulation.
623 #define LOCAL_ADD_USER 0x1
624 #define LOCAL_DELETE_USER 0x2
625 #define LOCAL_DISABLE_USER 0x4
626 #define LOCAL_ENABLE_USER 0x8
627 #define LOCAL_TRUST_ACCOUNT 0x10
628 #define LOCAL_SET_NO_PASSWORD 0x20
629 #define LOCAL_SET_PASSWORD 0x40
630 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
631 #define LOCAL_INTERDOM_ACCOUNT 0x100
632 #define LOCAL_AM_ROOT 0x200 /* Act as root */
634 /* key and data in the connections database - used in smbstatus and smbd */
635 struct connections_key {
636 pid_t pid;
637 int cnum;
638 fstring name;
641 struct connections_data {
642 int magic;
643 pid_t pid;
644 int cnum;
645 uid_t uid;
646 gid_t gid;
647 char name[24];
648 char addr[24];
649 char machine[FSTRING_LEN];
650 time_t start;
651 uint32 bcast_msg_flags;
655 /* key and data records in the tdb locking database */
656 struct locking_key {
657 SMB_DEV_T dev;
658 SMB_INO_T inode;
661 struct locking_data {
662 union {
663 int num_share_mode_entries;
664 share_mode_entry dummy; /* Needed for alignment. */
665 } u;
666 /* the following two entries are implicit
667 share_mode_entry modes[num_share_mode_entries];
668 char file_name[];
673 /* the following are used by loadparm for option lists */
674 typedef enum
676 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
677 P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
678 } parm_type;
680 typedef enum
682 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
683 } parm_class;
685 /* passed to br lock code */
686 enum brl_type {READ_LOCK, WRITE_LOCK, PENDING_LOCK};
688 struct enum_list {
689 int value;
690 const char *name;
693 #define BRLOCK_FN_CAST() \
694 void (*)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
695 enum brl_type lock_type, \
696 br_off start, br_off size)
697 #define BRLOCK_FN(fn) \
698 void (*fn)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
699 enum brl_type lock_type, \
700 br_off start, br_off size)
701 struct parm_struct
703 const char *label;
704 parm_type type;
705 parm_class class;
706 void *ptr;
707 BOOL (*special)(int snum, const char *, char **);
708 const struct enum_list *enum_list;
709 unsigned flags;
710 union {
711 BOOL bvalue;
712 int ivalue;
713 char *svalue;
714 char cvalue;
715 char **lvalue;
716 } def;
719 struct bitmap {
720 uint32 *b;
721 unsigned int n;
724 /* The following flags are used in SWAT */
725 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
726 #define FLAG_SHARE 0x0002 /* file sharing options */
727 #define FLAG_PRINT 0x0004 /* printing options */
728 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
729 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
730 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
731 #define FLAG_DEVELOPER 0x0040 /* No longer used */
732 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
733 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
734 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
736 #ifndef LOCKING_VERSION
737 #define LOCKING_VERSION 4
738 #endif /* LOCKING_VERSION */
741 /* the basic packet size, assuming no words or bytes */
742 #define smb_size 39
744 /* offsets into message for common items */
745 #define smb_com 8
746 #define smb_rcls 9
747 #define smb_reh 10
748 #define smb_err 11
749 #define smb_flg 13
750 #define smb_flg2 14
751 #define smb_pidhigh 16
752 #define smb_ss_field 18
753 #define smb_tid 28
754 #define smb_pid 30
755 #define smb_uid 32
756 #define smb_mid 34
757 #define smb_wct 36
758 #define smb_vwv 37
759 #define smb_vwv0 37
760 #define smb_vwv1 39
761 #define smb_vwv2 41
762 #define smb_vwv3 43
763 #define smb_vwv4 45
764 #define smb_vwv5 47
765 #define smb_vwv6 49
766 #define smb_vwv7 51
767 #define smb_vwv8 53
768 #define smb_vwv9 55
769 #define smb_vwv10 57
770 #define smb_vwv11 59
771 #define smb_vwv12 61
772 #define smb_vwv13 63
773 #define smb_vwv14 65
774 #define smb_vwv15 67
775 #define smb_vwv16 69
776 #define smb_vwv17 71
778 /* flag defines. CIFS spec 3.1.1 */
779 #define FLAG_SUPPORT_LOCKREAD 0x01
780 #define FLAG_CLIENT_BUF_AVAIL 0x02
781 #define FLAG_RESERVED 0x04
782 #define FLAG_CASELESS_PATHNAMES 0x08
783 #define FLAG_CANONICAL_PATHNAMES 0x10
784 #define FLAG_REQUEST_OPLOCK 0x20
785 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
786 #define FLAG_REPLY 0x80
788 /* the complete */
789 #define SMBmkdir 0x00 /* create directory */
790 #define SMBrmdir 0x01 /* delete directory */
791 #define SMBopen 0x02 /* open file */
792 #define SMBcreate 0x03 /* create file */
793 #define SMBclose 0x04 /* close file */
794 #define SMBflush 0x05 /* flush file */
795 #define SMBunlink 0x06 /* delete file */
796 #define SMBmv 0x07 /* rename file */
797 #define SMBgetatr 0x08 /* get file attributes */
798 #define SMBsetatr 0x09 /* set file attributes */
799 #define SMBread 0x0A /* read from file */
800 #define SMBwrite 0x0B /* write to file */
801 #define SMBlock 0x0C /* lock byte range */
802 #define SMBunlock 0x0D /* unlock byte range */
803 #define SMBctemp 0x0E /* create temporary file */
804 #define SMBmknew 0x0F /* make new file */
805 #define SMBchkpth 0x10 /* check directory path */
806 #define SMBexit 0x11 /* process exit */
807 #define SMBlseek 0x12 /* seek */
808 #define SMBtcon 0x70 /* tree connect */
809 #define SMBtconX 0x75 /* tree connect and X*/
810 #define SMBtdis 0x71 /* tree disconnect */
811 #define SMBnegprot 0x72 /* negotiate protocol */
812 #define SMBdskattr 0x80 /* get disk attributes */
813 #define SMBsearch 0x81 /* search directory */
814 #define SMBsplopen 0xC0 /* open print spool file */
815 #define SMBsplwr 0xC1 /* write to print spool file */
816 #define SMBsplclose 0xC2 /* close print spool file */
817 #define SMBsplretq 0xC3 /* return print queue */
818 #define SMBsends 0xD0 /* send single block message */
819 #define SMBsendb 0xD1 /* send broadcast message */
820 #define SMBfwdname 0xD2 /* forward user name */
821 #define SMBcancelf 0xD3 /* cancel forward */
822 #define SMBgetmac 0xD4 /* get machine name */
823 #define SMBsendstrt 0xD5 /* send start of multi-block message */
824 #define SMBsendend 0xD6 /* send end of multi-block message */
825 #define SMBsendtxt 0xD7 /* send text of multi-block message */
827 /* Core+ protocol */
828 #define SMBlockread 0x13 /* Lock a range and read */
829 #define SMBwriteunlock 0x14 /* Unlock a range then write */
830 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
831 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
832 #define SMBwritec 0x20 /* secondary write request */
833 #define SMBwriteclose 0x2c /* write a file then close it */
835 /* dos extended protocol */
836 #define SMBreadBraw 0x1A /* read block raw */
837 #define SMBreadBmpx 0x1B /* read block multiplexed */
838 #define SMBreadBs 0x1C /* read block (secondary response) */
839 #define SMBwriteBraw 0x1D /* write block raw */
840 #define SMBwriteBmpx 0x1E /* write block multiplexed */
841 #define SMBwriteBs 0x1F /* write block (secondary request) */
842 #define SMBwriteC 0x20 /* write complete response */
843 #define SMBsetattrE 0x22 /* set file attributes expanded */
844 #define SMBgetattrE 0x23 /* get file attributes expanded */
845 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
846 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
847 #define SMBtranss 0x26 /* transaction (secondary request/response) */
848 #define SMBioctl 0x27 /* IOCTL */
849 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
850 #define SMBcopy 0x29 /* copy */
851 #define SMBmove 0x2A /* move */
852 #define SMBecho 0x2B /* echo */
853 #define SMBopenX 0x2D /* open and X */
854 #define SMBreadX 0x2E /* read and X */
855 #define SMBwriteX 0x2F /* write and X */
856 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
857 #define SMBffirst 0x82 /* find first */
858 #define SMBfunique 0x83 /* find unique */
859 #define SMBfclose 0x84 /* find close */
860 #define SMBkeepalive 0x85 /* keepalive */
861 #define SMBinvalid 0xFE /* invalid command */
863 /* Extended 2.0 protocol */
864 #define SMBtrans2 0x32 /* TRANS2 protocol set */
865 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
866 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
867 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
868 #define SMBulogoffX 0x74 /* user logoff */
870 /* NT SMB extensions. */
871 #define SMBnttrans 0xA0 /* NT transact */
872 #define SMBnttranss 0xA1 /* NT transact secondary */
873 #define SMBntcreateX 0xA2 /* NT create and X */
874 #define SMBntcancel 0xA4 /* NT cancel */
875 #define SMBntrename 0xA5 /* NT rename */
877 /* These are the trans subcommands */
878 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
879 #define TRANSACT_DCERPCCMD 0x26
880 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
882 /* These are the TRANS2 sub commands */
883 #define TRANSACT2_OPEN 0x00
884 #define TRANSACT2_FINDFIRST 0x01
885 #define TRANSACT2_FINDNEXT 0x02
886 #define TRANSACT2_QFSINFO 0x03
887 #define TRANSACT2_SETFSINFO 0x04
888 #define TRANSACT2_QPATHINFO 0x05
889 #define TRANSACT2_SETPATHINFO 0x06
890 #define TRANSACT2_QFILEINFO 0x07
891 #define TRANSACT2_SETFILEINFO 0x08
892 #define TRANSACT2_FSCTL 0x09
893 #define TRANSACT2_IOCTL 0x0A
894 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
895 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
896 #define TRANSACT2_MKDIR 0x0D
897 #define TRANSACT2_SESSION_SETUP 0x0E
898 #define TRANSACT2_GET_DFS_REFERRAL 0x10
899 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
901 /* These are the NT transact sub commands. */
902 #define NT_TRANSACT_CREATE 1
903 #define NT_TRANSACT_IOCTL 2
904 #define NT_TRANSACT_SET_SECURITY_DESC 3
905 #define NT_TRANSACT_NOTIFY_CHANGE 4
906 #define NT_TRANSACT_RENAME 5
907 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
908 #define NT_TRANSACT_GET_USER_QUOTA 7
909 #define NT_TRANSACT_SET_USER_QUOTA 8
911 /* These are the NT transact_get_user_quota sub commands */
912 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
913 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
914 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
916 /* Relevant IOCTL codes */
917 #define IOCTL_QUERY_JOB_INFO 0x530060
919 /* these are the trans2 sub fields for primary requests */
920 #define smb_tpscnt smb_vwv0
921 #define smb_tdscnt smb_vwv1
922 #define smb_mprcnt smb_vwv2
923 #define smb_mdrcnt smb_vwv3
924 #define smb_msrcnt smb_vwv4
925 #define smb_flags smb_vwv5
926 #define smb_timeout smb_vwv6
927 #define smb_pscnt smb_vwv9
928 #define smb_psoff smb_vwv10
929 #define smb_dscnt smb_vwv11
930 #define smb_dsoff smb_vwv12
931 #define smb_suwcnt smb_vwv13
932 #define smb_setup smb_vwv14
933 #define smb_setup0 smb_setup
934 #define smb_setup1 (smb_setup+2)
935 #define smb_setup2 (smb_setup+4)
937 /* these are for the secondary requests */
938 #define smb_spscnt smb_vwv2
939 #define smb_spsoff smb_vwv3
940 #define smb_spsdisp smb_vwv4
941 #define smb_sdscnt smb_vwv5
942 #define smb_sdsoff smb_vwv6
943 #define smb_sdsdisp smb_vwv7
944 #define smb_sfid smb_vwv8
946 /* and these for responses */
947 #define smb_tprcnt smb_vwv0
948 #define smb_tdrcnt smb_vwv1
949 #define smb_prcnt smb_vwv3
950 #define smb_proff smb_vwv4
951 #define smb_prdisp smb_vwv5
952 #define smb_drcnt smb_vwv6
953 #define smb_droff smb_vwv7
954 #define smb_drdisp smb_vwv8
956 /* these are for the NT trans primary request. */
957 #define smb_nt_MaxSetupCount smb_vwv0
958 #define smb_nt_Flags (smb_vwv0 + 1)
959 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
960 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
961 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
962 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
963 #define smb_nt_ParameterCount (smb_vwv0 + 19)
964 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
965 #define smb_nt_DataCount (smb_vwv0 + 27)
966 #define smb_nt_DataOffset (smb_vwv0 + 31)
967 #define smb_nt_SetupCount (smb_vwv0 + 35)
968 #define smb_nt_Function (smb_vwv0 + 36)
969 #define smb_nt_SetupStart (smb_vwv0 + 38)
971 /* these are for the NT trans secondary request. */
972 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
973 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
974 #define smb_nts_ParameterCount (smb_vwv0 + 11)
975 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
976 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
977 #define smb_nts_DataCount (smb_vwv0 + 23)
978 #define smb_nts_DataOffset (smb_vwv0 + 27)
979 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
981 /* these are for the NT trans reply. */
982 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
983 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
984 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
985 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
986 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
987 #define smb_ntr_DataCount (smb_vwv0 + 23)
988 #define smb_ntr_DataOffset (smb_vwv0 + 27)
989 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
991 /* these are for the NT create_and_X */
992 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
993 #define smb_ntcreate_Flags (smb_vwv0 + 7)
994 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
995 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
996 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
997 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
998 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
999 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1000 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1001 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1002 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1004 /* this is used on a TConX. I'm not sure the name is very helpful though */
1005 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1006 #define SMB_SHARE_IN_DFS 0x0002
1008 /* Named pipe write mode flags. Used in writeX calls. */
1009 #define PIPE_RAW_MODE 0x4
1010 #define PIPE_START_MESSAGE 0x8
1012 /* File Specific access rights */
1013 #define FILE_READ_DATA 0x00000001
1014 #define FILE_WRITE_DATA 0x00000002
1015 #define FILE_APPEND_DATA 0x00000004
1016 #define FILE_READ_EA 0x00000008 /* File and directory */
1017 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1018 #define FILE_EXECUTE 0x00000020
1019 #define FILE_DELETE_CHILD 0x00000040
1020 #define FILE_READ_ATTRIBUTES 0x00000080
1021 #define FILE_WRITE_ATTRIBUTES 0x00000100
1023 #define FILE_ALL_ACCESS 0x000001FF
1025 /* Directory specific access rights */
1026 #define FILE_LIST_DIRECTORY 0x00000001
1027 #define FILE_ADD_FILE 0x00000002
1028 #define FILE_ADD_SUBDIRECTORY 0x00000004
1029 #define FILE_TRAVERSE 0x00000020
1030 #define FILE_DELETE_CHILD 0x00000040
1032 /* the desired access to use when opening a pipe */
1033 #define DESIRED_ACCESS_PIPE 0x2019f
1035 /* Generic access masks & rights. */
1036 #define DELETE_ACCESS (1L<<16) /* 0x00010000 */
1037 #define READ_CONTROL_ACCESS (1L<<17) /* 0x00020000 */
1038 #define WRITE_DAC_ACCESS (1L<<18) /* 0x00040000 */
1039 #define WRITE_OWNER_ACCESS (1L<<19) /* 0x00080000 */
1040 #define SYNCHRONIZE_ACCESS (1L<<20) /* 0x00100000 */
1042 #define SYSTEM_SECURITY_ACCESS (1L<<24) /* 0x01000000 */
1043 #define MAXIMUM_ALLOWED_ACCESS (1L<<25) /* 0x02000000 */
1044 #define GENERIC_ALL_ACCESS (1<<28) /* 0x10000000 */
1045 #define GENERIC_EXECUTE_ACCESS (1<<29) /* 0x20000000 */
1046 #define GENERIC_WRITE_ACCESS (1<<30) /* 0x40000000 */
1047 #define GENERIC_READ_ACCESS (((unsigned)1)<<31) /* 0x80000000 */
1049 /* Mapping of generic access rights for files to specific rights. */
1051 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1053 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1054 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1056 #define FILE_GENERIC_WRITE (STANDARD_RIGHTS_WRITE_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1057 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1059 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
1060 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1062 /* Mapping of access rights to UNIX perms. */
1063 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1064 #define UNIX_ACCESS_R FILE_GENERIC_READ
1065 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1066 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1068 #if 0
1070 * This is the old mapping we used to use. To get W2KSP2 profiles
1071 * working we need to map to the canonical file perms.
1073 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1074 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1075 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1076 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1077 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1078 FILE_APPEND_DATA|FILE_WRITE_DATA)
1079 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1080 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1081 #endif
1083 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1085 /* Flags field. */
1086 #define REQUEST_OPLOCK 2
1087 #define REQUEST_BATCH_OPLOCK 4
1088 #define OPEN_DIRECTORY 8
1089 #define EXTENDED_RESPONSE_REQUIRED 0x10
1091 /* ShareAccess field. */
1092 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1093 #define FILE_SHARE_READ 1
1094 #define FILE_SHARE_WRITE 2
1095 #define FILE_SHARE_DELETE 4
1097 /* FileAttributesField */
1098 #define FILE_ATTRIBUTE_READONLY 0x001L
1099 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1100 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1101 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1102 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1103 #define FILE_ATTRIBUTE_NORMAL 0x080L
1104 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1105 #define FILE_ATTRIBUTE_SPARSE 0x200L
1106 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1107 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1108 #define SAMBA_ATTRIBUTES_MASK 0x7F
1110 /* Flags - combined with attributes. */
1111 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1112 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1113 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1114 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1115 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1116 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1117 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1119 /* CreateDisposition field. */
1120 #define FILE_SUPERSEDE 0
1121 #define FILE_OPEN 1
1122 #define FILE_CREATE 2
1123 #define FILE_OPEN_IF 3
1124 #define FILE_OVERWRITE 4
1125 #define FILE_OVERWRITE_IF 5
1127 /* CreateOptions field. */
1128 #define FILE_DIRECTORY_FILE 0x0001
1129 #define FILE_WRITE_THROUGH 0x0002
1130 #define FILE_SEQUENTIAL_ONLY 0x0004
1131 #define FILE_NON_DIRECTORY_FILE 0x0040
1132 #define FILE_NO_EA_KNOWLEDGE 0x0200
1133 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1134 #define FILE_RANDOM_ACCESS 0x0800
1135 #define FILE_DELETE_ON_CLOSE 0x1000
1136 #define FILE_OPEN_BY_FILE_ID 0x2000
1138 /* Responses when opening a file. */
1139 #define FILE_WAS_SUPERSEDED 0
1140 #define FILE_WAS_OPENED 1
1141 #define FILE_WAS_CREATED 2
1142 #define FILE_WAS_OVERWRITTEN 3
1144 /* File type flags */
1145 #define FILE_TYPE_DISK 0
1146 #define FILE_TYPE_BYTE_MODE_PIPE 1
1147 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1148 #define FILE_TYPE_PRINTER 3
1149 #define FILE_TYPE_COMM_DEVICE 4
1150 #define FILE_TYPE_UNKNOWN 0xFFFF
1152 /* Flag for NT transact rename call. */
1153 #define RENAME_REPLACE_IF_EXISTS 1
1155 /* flags for SMBntrename call (from Samba4) */
1156 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1157 #define RENAME_FLAG_HARD_LINK 0x103
1158 #define RENAME_FLAG_RENAME 0x104
1159 #define RENAME_FLAG_COPY 0x105
1161 /* Filesystem Attributes. */
1162 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1163 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1164 #define FILE_UNICODE_ON_DISK 0x00000004
1165 /* According to cifs9f, this is 4, not 8 */
1166 /* Acconding to testing, this actually sets the security attribute! */
1167 #define FILE_PERSISTENT_ACLS 0x00000008
1168 #define FILE_FILE_COMPRESSION 0x00000010
1169 #define FILE_VOLUME_QUOTAS 0x00000020
1170 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1171 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1172 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1173 #define FS_LFN_APIS 0x00004000
1174 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1175 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1176 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1177 #define FILE_NAMED_STREAMS 0x00040000
1178 #define FILE_READ_ONLY_VOLUME 0x00080000
1180 /* ChangeNotify flags. */
1181 #define FILE_NOTIFY_CHANGE_FILE 0x001
1182 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1183 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1184 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1185 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1186 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1187 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1188 #define FILE_NOTIFY_CHANGE_EA 0x080
1189 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1190 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x200
1192 /* where to find the base of the SMB packet proper */
1193 #define smb_base(buf) (((char *)(buf))+4)
1195 /* we don't allow server strings to be longer than 48 characters as
1196 otherwise NT will not honour the announce packets */
1197 #define MAX_SERVER_STRING_LENGTH 48
1200 #define SMB_SUCCESS 0 /* The request was successful. */
1202 #ifdef WITH_DFS
1203 void dfs_unlogin(void);
1204 extern int dcelogin_atmost_once;
1205 #endif
1207 #ifdef NOSTRDUP
1208 char *strdup(char *s);
1209 #endif
1211 #ifndef SIGNAL_CAST
1212 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1213 #endif
1215 #ifndef SELECT_CAST
1216 #define SELECT_CAST
1217 #endif
1219 /* these are used in NetServerEnum to choose what to receive */
1220 #define SV_TYPE_WORKSTATION 0x00000001
1221 #define SV_TYPE_SERVER 0x00000002
1222 #define SV_TYPE_SQLSERVER 0x00000004
1223 #define SV_TYPE_DOMAIN_CTRL 0x00000008
1224 #define SV_TYPE_DOMAIN_BAKCTRL 0x00000010
1225 #define SV_TYPE_TIME_SOURCE 0x00000020
1226 #define SV_TYPE_AFP 0x00000040
1227 #define SV_TYPE_NOVELL 0x00000080
1228 #define SV_TYPE_DOMAIN_MEMBER 0x00000100
1229 #define SV_TYPE_PRINTQ_SERVER 0x00000200
1230 #define SV_TYPE_DIALIN_SERVER 0x00000400
1231 #define SV_TYPE_SERVER_UNIX 0x00000800
1232 #define SV_TYPE_NT 0x00001000
1233 #define SV_TYPE_WFW 0x00002000
1234 #define SV_TYPE_SERVER_MFPN 0x00004000
1235 #define SV_TYPE_SERVER_NT 0x00008000
1236 #define SV_TYPE_POTENTIAL_BROWSER 0x00010000
1237 #define SV_TYPE_BACKUP_BROWSER 0x00020000
1238 #define SV_TYPE_MASTER_BROWSER 0x00040000
1239 #define SV_TYPE_DOMAIN_MASTER 0x00080000
1240 #define SV_TYPE_SERVER_OSF 0x00100000
1241 #define SV_TYPE_SERVER_VMS 0x00200000
1242 #define SV_TYPE_WIN95_PLUS 0x00400000
1243 #define SV_TYPE_DFS_SERVER 0x00800000
1244 #define SV_TYPE_ALTERNATE_XPORT 0x20000000
1245 #define SV_TYPE_LOCAL_LIST_ONLY 0x40000000
1246 #define SV_TYPE_DOMAIN_ENUM 0x80000000
1247 #define SV_TYPE_ALL 0xFFFFFFFF
1249 /* This was set by JHT in liaison with Jeremy Allison early 1997
1250 * History:
1251 * Version 4.0 - never made public
1252 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1253 * - Reappeared in 1.9.16p11 with fixed smbd services
1254 * Version 4.20 - To indicate that nmbd and browsing now works better
1255 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1257 * Note: In the presence of NT4.X do not set above 4.9
1258 * Setting this above 4.9 can have undesired side-effects.
1259 * This may change again in Samba-3.0 after further testing. JHT
1262 #define DEFAULT_MAJOR_VERSION 0x04
1263 #define DEFAULT_MINOR_VERSION 0x09
1265 /* Browser Election Values */
1266 #define BROWSER_ELECTION_VERSION 0x010f
1267 #define BROWSER_CONSTANT 0xaa55
1269 /* Sercurity mode bits. */
1270 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1271 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1272 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1273 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1275 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1277 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1278 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1279 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1280 #define FLAGS2_IS_LONG_NAME 0x0040
1281 #define FLAGS2_EXTENDED_SECURITY 0x0800
1282 #define FLAGS2_DFS_PATHNAMES 0x1000
1283 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1284 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1285 #define FLAGS2_UNICODE_STRINGS 0x8000
1287 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1289 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1291 #define CAP_RAW_MODE 0x0001
1292 #define CAP_MPX_MODE 0x0002
1293 #define CAP_UNICODE 0x0004
1294 #define CAP_LARGE_FILES 0x0008
1295 #define CAP_NT_SMBS 0x0010
1296 #define CAP_RPC_REMOTE_APIS 0x0020
1297 #define CAP_STATUS32 0x0040
1298 #define CAP_LEVEL_II_OPLOCKS 0x0080
1299 #define CAP_LOCK_AND_READ 0x0100
1300 #define CAP_NT_FIND 0x0200
1301 #define CAP_DFS 0x1000
1302 #define CAP_W2K_SMBS 0x2000
1303 #define CAP_LARGE_READX 0x4000
1304 #define CAP_LARGE_WRITEX 0x8000
1305 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1306 #define CAP_EXTENDED_SECURITY 0x80000000
1308 /* protocol types. It assumes that higher protocols include lower protocols
1309 as subsets */
1310 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1312 /* security levels */
1313 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1315 /* server roles */
1316 enum server_types
1318 ROLE_STANDALONE,
1319 ROLE_DOMAIN_MEMBER,
1320 ROLE_DOMAIN_BDC,
1321 ROLE_DOMAIN_PDC
1324 /* printing types */
1325 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1326 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1327 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2
1328 #ifdef DEVELOPER
1329 ,PRINT_TEST,PRINT_VLP
1330 #endif /* DEVELOPER */
1333 /* LDAP schema types */
1334 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1336 /* LDAP SSL options */
1337 enum ldap_ssl_types {LDAP_SSL_ON, LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1339 /* LDAP PASSWD SYNC methods */
1340 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1342 /* Remote architectures we know about. */
1343 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_SAMBA};
1345 /* case handling */
1346 enum case_handling {CASE_LOWER,CASE_UPPER};
1349 * Global value meaing that the smb_uid field should be
1350 * ingored (in share level security and protocol level == CORE)
1353 #define UID_FIELD_INVALID 0
1354 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1357 * Size of buffer to use when moving files across filesystems.
1359 #define COPYBUF_SIZE (8*1024)
1362 * Values used to override error codes.
1364 extern int unix_ERR_class;
1365 extern int unix_ERR_code;
1366 extern NTSTATUS unix_ERR_ntstatus;
1369 * Used in chaining code.
1371 extern int chain_size;
1374 * Map the Core and Extended Oplock requesst bits down
1375 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1379 * Core protocol.
1381 #define CORE_OPLOCK_REQUEST(inbuf) \
1382 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1385 * Extended protocol.
1387 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1389 /* Lock types. */
1390 #define LOCKING_ANDX_SHARED_LOCK 0x1
1391 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1392 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1393 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1394 #define LOCKING_ANDX_LARGE_FILES 0x10
1396 /* Oplock levels */
1397 #define OPLOCKLEVEL_NONE 0
1398 #define OPLOCKLEVEL_II 1
1401 * Bits we test with.
1404 #define NO_OPLOCK 0
1405 #define EXCLUSIVE_OPLOCK 1
1406 #define BATCH_OPLOCK 2
1407 #define LEVEL_II_OPLOCK 4
1409 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1410 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1411 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1413 #define CORE_OPLOCK_GRANTED (1<<5)
1414 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1417 * Return values for oplock types.
1420 #define NO_OPLOCK_RETURN 0
1421 #define EXCLUSIVE_OPLOCK_RETURN 1
1422 #define BATCH_OPLOCK_RETURN 2
1423 #define LEVEL_II_OPLOCK_RETURN 3
1426 * Loopback command offsets.
1429 #define OPBRK_CMD_LEN_OFFSET 0
1430 #define OPBRK_CMD_PORT_OFFSET 4
1431 #define OPBRK_CMD_HEADER_LEN 6
1433 #define OPBRK_MESSAGE_CMD_OFFSET 0
1436 * Oplock break command code to send over the udp socket.
1437 * The same message is sent for both exlusive and level II breaks.
1439 * The form of this is :
1441 * 0 2 2+pid 2+pid+dev 2+pid+dev+ino
1442 * +----+--------+-------+--------+---------+
1443 * | cmd| pid | dev | inode | fileid |
1444 * +----+--------+-------+--------+---------+
1447 #define OPLOCK_BREAK_PID_OFFSET 2
1448 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1449 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1450 #define OPLOCK_BREAK_FILEID_OFFSET (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1451 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1453 /* Message types */
1454 #define OPLOCK_BREAK_CMD 0x1
1455 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1456 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1457 #define ASYNC_LEVEL_II_OPLOCK_BREAK_CMD 0x4
1460 * Capabilities abstracted for different systems.
1463 #define KERNEL_OPLOCK_CAPABILITY 0x1
1466 * Oplock break command code sent via the kernel interface (if it exists).
1468 * Form of this is :
1470 * 0 2 2+devsize 2+devsize+inodesize
1471 * +----+--------+--------+----------+
1472 * | cmd| dev | inode | fileid |
1473 * +----+--------+--------+----------+
1475 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1476 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1477 #define KERNEL_OPLOCK_BREAK_FILEID_OFFSET (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1478 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1481 /* if a kernel does support oplocks then a structure of the following
1482 typee is used to describe how to interact with the kernel */
1483 struct kernel_oplocks {
1484 BOOL (*receive_message)(fd_set *fds, char *buffer, int buffer_len);
1485 BOOL (*set_oplock)(files_struct *fsp, int oplock_type);
1486 void (*release_oplock)(files_struct *fsp);
1487 BOOL (*parse_message)(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev, unsigned long *file_id);
1488 BOOL (*msg_waiting)(fd_set *fds);
1489 int notification_fd;
1493 #define CMD_REPLY 0x8000
1495 /* this structure defines the functions for doing change notify in
1496 various implementations */
1497 struct cnotify_fns {
1498 void * (*register_notify)(connection_struct *conn, char *path, uint32 flags);
1499 BOOL (*check_notify)(connection_struct *conn, uint16 vuid, char *path, uint32 flags, void *data, time_t t);
1500 void (*remove_notify)(void *data);
1501 int select_time;
1506 #include "smb_macros.h"
1508 #define MAX_NETBIOSNAME_LEN 16
1509 /* DOS character, NetBIOS namestring. Type used on the wire. */
1510 typedef char nstring[MAX_NETBIOSNAME_LEN];
1511 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1512 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1514 /* A netbios name structure. */
1515 struct nmb_name {
1516 nstring name;
1517 char scope[64];
1518 unsigned int name_type;
1522 /* A netbios node status array element. */
1523 struct node_status {
1524 nstring name;
1525 unsigned char type;
1526 unsigned char flags;
1529 /* The extra info from a NetBIOS node status query */
1530 struct node_status_extra {
1531 unsigned char mac_addr[6];
1532 /* There really is more here ... */
1535 struct pwd_info
1537 BOOL null_pwd;
1538 BOOL cleartext;
1540 fstring password;
1544 typedef struct user_struct
1546 struct user_struct *next, *prev;
1547 uint16 vuid; /* Tag for this entry. */
1548 uid_t uid; /* uid of a validated user */
1549 gid_t gid; /* gid of a validated user */
1551 userdom_struct user;
1552 char *homedir;
1553 char *unix_homedir;
1554 char *logon_script;
1556 BOOL guest;
1558 /* following groups stuff added by ih */
1559 /* This groups info is needed for when we become_user() for this uid */
1560 int n_groups;
1561 gid_t *groups;
1563 NT_USER_TOKEN *nt_user_token;
1565 DATA_BLOB session_key;
1567 char *session_keystr; /* used by utmp and pam session code.
1568 TDB key string */
1569 int homes_snum;
1571 struct auth_serversupplied_info *server_info;
1573 } user_struct;
1576 struct unix_error_map {
1577 int unix_error;
1578 int dos_class;
1579 int dos_code;
1580 NTSTATUS nt_error;
1584 #include "ntdomain.h"
1586 #include "client.h"
1590 * Size of new password account encoding string. This is enough space to
1591 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1592 * Do not change unless you are adding new ACB bits!
1595 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1598 Do you want session setups at user level security with a invalid
1599 password to be rejected or allowed in as guest? WinNT rejects them
1600 but it can be a pain as it means "net view" needs to use a password
1602 You have 3 choices in the setting of map_to_guest:
1604 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1605 are rejected. This is the default.
1607 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1608 are rejected, unless the username does not exist, in which case it
1609 is treated as a guest login
1611 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1612 are treated as a guest login
1614 Note that map_to_guest only has an effect in user or server
1615 level security.
1618 #define NEVER_MAP_TO_GUEST 0
1619 #define MAP_TO_GUEST_ON_BAD_USER 1
1620 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1622 #define SAFE_NETBIOS_CHARS ". -_"
1624 /* generic iconv conversion structure */
1625 typedef struct {
1626 size_t (*direct)(void *cd, char **inbuf, size_t *inbytesleft,
1627 char **outbuf, size_t *outbytesleft);
1628 size_t (*pull)(void *cd, char **inbuf, size_t *inbytesleft,
1629 char **outbuf, size_t *outbytesleft);
1630 size_t (*push)(void *cd, char **inbuf, size_t *inbytesleft,
1631 char **outbuf, size_t *outbytesleft);
1632 void *cd_direct, *cd_pull, *cd_push;
1633 char *from_name, *to_name;
1634 } *smb_iconv_t;
1636 /* The maximum length of a trust account password.
1637 Used when we randomly create it, 15 char passwords
1638 exceed NT4's max password length */
1640 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1642 #include "popt_common.h"
1644 #define PORT_NONE 0
1645 #ifndef LDAP_PORT
1646 #define LDAP_PORT 389
1647 #endif
1649 /* used by the IP comparison function */
1650 struct ip_service {
1651 struct in_addr ip;
1652 unsigned port;
1655 /* Used by the SMB signing functions. */
1657 typedef struct smb_sign_info {
1658 void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1659 BOOL (*check_incoming_message)(char *inbuf, struct smb_sign_info *si, BOOL must_be_ok);
1660 void (*free_signing_context)(struct smb_sign_info *si);
1661 void *signing_context;
1663 BOOL negotiated_smb_signing;
1664 BOOL allow_smb_signing;
1665 BOOL doing_signing;
1666 BOOL mandatory_signing;
1667 BOOL seen_valid; /* Have I ever seen a validly signed packet? */
1668 } smb_sign_info;
1670 struct ea_struct {
1671 uint8 flags;
1672 char *name;
1673 DATA_BLOB value;
1676 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1677 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1678 /* EA to use for DOS attributes */
1679 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1681 #endif /* _SMB_H */