First round of merging various UUID structures.
[Samba/gebeck_regimport.git] / source / include / smb.h
blob689e6ebe1d304877cd874b5b57a37a8c3844a819
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
86 #define DIR_STRUCT_SIZE 43
88 /* these define the attribute byte as seen by DOS */
89 #define aRONLY (1L<<0) /* 0x01 */
90 #define aHIDDEN (1L<<1) /* 0x02 */
91 #define aSYSTEM (1L<<2) /* 0x04 */
92 #define aVOLID (1L<<3) /* 0x08 */
93 #define aDIR (1L<<4) /* 0x10 */
94 #define aARCH (1L<<5) /* 0x20 */
96 /* deny modes */
97 #define DENY_DOS 0
98 #define DENY_ALL 1
99 #define DENY_WRITE 2
100 #define DENY_READ 3
101 #define DENY_NONE 4
102 #define DENY_FCB 7
104 /* open modes */
105 #define DOS_OPEN_RDONLY 0
106 #define DOS_OPEN_WRONLY 1
107 #define DOS_OPEN_RDWR 2
108 #define DOS_OPEN_FCB 0xF
110 /* define shifts and masks for share and open modes. */
111 #define OPEN_MODE_MASK 0xF
112 #define SHARE_MODE_SHIFT 4
113 #define SHARE_MODE_MASK 0x7
114 #define GET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
115 #define SET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
116 #define GET_DENY_MODE(x) (((x)>>SHARE_MODE_SHIFT) & SHARE_MODE_MASK)
117 #define SET_DENY_MODE(x) (((x) & SHARE_MODE_MASK) <<SHARE_MODE_SHIFT)
119 /* Sync on open file (not sure if used anymore... ?) */
120 #define FILE_SYNC_OPENMODE (1<<14)
121 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
123 /* allow delete on open file mode (used by NT SMB's). */
124 #define ALLOW_SHARE_DELETE (1<<15)
125 #define GET_ALLOW_SHARE_DELETE(x) (((x) & ALLOW_SHARE_DELETE) ? True : False)
126 #define SET_ALLOW_SHARE_DELETE(x) ((x) ? ALLOW_SHARE_DELETE : 0)
128 /* delete on close flag (used by NT SMB's). */
129 #define DELETE_ON_CLOSE_FLAG (1<<16)
130 #define GET_DELETE_ON_CLOSE_FLAG(x) (((x) & DELETE_ON_CLOSE_FLAG) ? True : False)
131 #define SET_DELETE_ON_CLOSE_FLAG(x) ((x) ? DELETE_ON_CLOSE_FLAG : 0)
133 /* open disposition values */
134 #define FILE_EXISTS_FAIL 0
135 #define FILE_EXISTS_OPEN 1
136 #define FILE_EXISTS_TRUNCATE 2
138 /* mask for open disposition. */
139 #define FILE_OPEN_MASK 0x3
141 #define GET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
142 #define SET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
144 /* The above can be OR'ed with... */
145 #define FILE_CREATE_IF_NOT_EXIST 0x10
146 #define FILE_FAIL_IF_NOT_EXIST 0
148 #define GET_FILE_CREATE_DISPOSITION(x) ((x) & (FILE_CREATE_IF_NOT_EXIST|FILE_FAIL_IF_NOT_EXIST))
150 /* share types */
151 #define STYPE_DISKTREE 0 /* Disk drive */
152 #define STYPE_PRINTQ 1 /* Spooler queue */
153 #define STYPE_DEVICE 2 /* Serial device */
154 #define STYPE_IPC 3 /* Interprocess communication (IPC) */
155 #define STYPE_HIDDEN 0x80000000 /* share is a hidden one (ends with $) */
157 #include "doserr.h"
159 typedef union unid_t {
160 uid_t uid;
161 gid_t gid;
162 } unid_t;
165 * SMB UCS2 (16-bit unicode) internal type.
168 typedef uint16 smb_ucs2_t;
170 /* ucs2 string types. */
171 typedef smb_ucs2_t wpstring[PSTRING_LEN];
172 typedef smb_ucs2_t wfstring[FSTRING_LEN];
174 #ifdef WORDS_BIGENDIAN
175 #define UCS2_SHIFT 8
176 #else
177 #define UCS2_SHIFT 0
178 #endif
180 /* turn a 7 bit character into a ucs2 character */
181 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
183 /* pipe string names */
184 #define PIPE_LANMAN "\\PIPE\\LANMAN"
185 #define PIPE_SRVSVC "\\PIPE\\srvsvc"
186 #define PIPE_SAMR "\\PIPE\\samr"
187 #define PIPE_WINREG "\\PIPE\\winreg"
188 #define PIPE_WKSSVC "\\PIPE\\wkssvc"
189 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
190 #define PIPE_NTLSA "\\PIPE\\ntlsa"
191 #define PIPE_NTSVCS "\\PIPE\\ntsvcs"
192 #define PIPE_LSASS "\\PIPE\\lsass"
193 #define PIPE_LSARPC "\\PIPE\\lsarpc"
194 #define PIPE_SPOOLSS "\\PIPE\\spoolss"
195 #define PIPE_NETDFS "\\PIPE\\netdfs"
196 #define PIPE_ECHO "\\PIPE\\rpcecho"
197 #define PIPE_SHUTDOWN "\\PIPE\\initshutdown"
198 #define PIPE_EPM "\\PIPE\\epmapper"
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_EPM 11
214 #define PI_MAX_PIPES 12
216 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
217 typedef struct nttime_info
219 uint32 low;
220 uint32 high;
221 } NTTIME;
224 /* Allowable account control bits */
225 #define ACB_DISABLED 0x0001 /* 1 = User account disabled */
226 #define ACB_HOMDIRREQ 0x0002 /* 1 = Home directory required */
227 #define ACB_PWNOTREQ 0x0004 /* 1 = User password not required */
228 #define ACB_TEMPDUP 0x0008 /* 1 = Temporary duplicate account */
229 #define ACB_NORMAL 0x0010 /* 1 = Normal user account */
230 #define ACB_MNS 0x0020 /* 1 = MNS logon user account */
231 #define ACB_DOMTRUST 0x0040 /* 1 = Interdomain trust account */
232 #define ACB_WSTRUST 0x0080 /* 1 = Workstation trust account */
233 #define ACB_SVRTRUST 0x0100 /* 1 = Server trust account */
234 #define ACB_PWNOEXP 0x0200 /* 1 = User password does not expire */
235 #define ACB_AUTOLOCK 0x0400 /* 1 = Account auto locked */
237 #define MAX_HOURS_LEN 32
240 * window during which we must talk to the PDC to avoid
241 * sam sync delays; expressed in seconds (15 minutes is the
242 * default period for SAM replication under Windows NT 4.0
244 #define SAM_SYNC_WINDOW 900
247 #ifndef MAXSUBAUTHS
248 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
249 #endif
251 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
253 /* SID Types */
254 enum SID_NAME_USE
256 SID_NAME_USE_NONE = 0,
257 SID_NAME_USER = 1, /* user */
258 SID_NAME_DOM_GRP, /* domain group */
259 SID_NAME_DOMAIN, /* domain sid */
260 SID_NAME_ALIAS, /* local group */
261 SID_NAME_WKN_GRP, /* well-known group */
262 SID_NAME_DELETED, /* deleted account: needed for c2 rating */
263 SID_NAME_INVALID, /* invalid account */
264 SID_NAME_UNKNOWN, /* unknown sid type */
265 SID_NAME_COMPUTER /* sid for a computer */
269 * @brief Security Identifier
271 * @sa http://msdn.microsoft.com/library/default.asp?url=/library/en-us/security/accctrl_38yn.asp
273 typedef struct sid_info
275 uint8 sid_rev_num; /**< SID revision number */
276 uint8 num_auths; /**< Number of sub-authorities */
277 uint8 id_auth[6]; /**< Identifier Authority */
279 * Pointer to sub-authorities.
281 * @note The values in these uint32's are in *native* byteorder, not
282 * neccessarily little-endian...... JRA.
284 uint32 sub_auths[MAXSUBAUTHS];
286 } DOM_SID;
289 * The complete list of SIDS belonging to this user.
290 * Created when a vuid is registered.
291 * The definition of the user_sids array is as follows :
293 * token->user_sids[0] = primary user SID.
294 * token->user_sids[1] = primary group SID.
295 * token->user_sids[2..num_sids] = supplementary group SIDS.
298 #define PRIMARY_USER_SID_INDEX 0
299 #define PRIMARY_GROUP_SID_INDEX 1
301 typedef struct _nt_user_token {
302 size_t num_sids;
303 DOM_SID *user_sids;
304 } NT_USER_TOKEN;
306 /*** query a local group, get a list of these: shows who is in that group ***/
308 /* local group member info */
309 typedef struct local_grp_member_info
311 DOM_SID sid ; /* matches with name */
312 uint8 sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
313 fstring name ; /* matches with sid: must be of the form "DOMAIN\account" */
315 } LOCAL_GRP_MEMBER;
317 /* enumerate these to get list of local groups */
319 /* local group info */
320 typedef struct local_grp_info
322 fstring name;
323 fstring comment;
325 } LOCAL_GRP;
327 /*** enumerate these to get list of domain groups ***/
329 /* domain group member info */
330 typedef struct domain_grp_info
332 fstring name;
333 fstring comment;
334 uint32 rid; /* group rid */
335 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
337 } DOMAIN_GRP;
339 /*** query a domain group, get a list of these: shows who is in that group ***/
341 /* domain group info */
342 typedef struct domain_grp_member_info
344 fstring name;
345 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
347 } DOMAIN_GRP_MEMBER;
349 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
350 typedef struct time_info
352 uint32 time;
353 } UTIME;
355 /* Structure used when SMBwritebmpx is active */
356 typedef struct
358 size_t wr_total_written; /* So we know when to discard this */
359 int32 wr_timeout;
360 int32 wr_errclass;
361 int32 wr_error; /* Cached errors */
362 BOOL wr_mode; /* write through mode) */
363 BOOL wr_discard; /* discard all further data */
364 } write_bmpx_struct;
366 typedef struct write_cache
368 SMB_OFF_T file_size;
369 SMB_OFF_T offset;
370 size_t alloc_size;
371 size_t data_size;
372 char *data;
373 } write_cache;
375 typedef struct
377 smb_ucs2_t *origname;
378 smb_ucs2_t *filename;
379 SMB_STRUCT_STAT *statinfo;
380 } smb_filename;
382 #include "fake_file.h"
384 typedef struct files_struct
386 struct files_struct *next, *prev;
387 int fnum;
388 struct connection_struct *conn;
389 int fd;
390 uint16 rap_print_jobid;
391 SMB_DEV_T dev;
392 SMB_INO_T inode;
393 BOOL delete_on_close;
394 SMB_OFF_T pos;
395 SMB_BIG_UINT size;
396 SMB_BIG_UINT initial_allocation_size; /* Faked up initial allocation on disk. */
397 SMB_BIG_UINT position_information;
398 mode_t mode;
399 uint16 file_pid;
400 uint16 vuid;
401 write_bmpx_struct *wbmpx_ptr;
402 write_cache *wcp;
403 struct timeval open_time;
404 int share_mode;
405 uint32 desired_access;
406 time_t pending_modtime;
407 int oplock_type;
408 int sent_oplock_break;
409 unsigned long file_id;
410 BOOL can_lock;
411 BOOL can_read;
412 BOOL can_write;
413 BOOL print_file;
414 BOOL modified;
415 BOOL is_directory;
416 BOOL is_stat;
417 BOOL directory_delete_on_close;
418 char *fsp_name;
419 FAKE_FILE_HANDLE *fake_file_handle;
420 } files_struct;
422 #include "ntquotas.h"
423 #include "sysquotas.h"
425 /* used to hold an arbitrary blob of data */
426 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 {
444 unsigned int entries;
445 uint16 list[VUID_CACHE_SIZE];
448 typedef struct
450 char *name;
451 BOOL is_wild;
452 } name_compare_entry;
454 /* Include VFS stuff */
456 #include "smb_acls.h"
457 #include "vfs.h"
459 typedef struct connection_struct
461 struct connection_struct *next, *prev;
462 TALLOC_CTX *mem_ctx;
463 unsigned cnum; /* an index passed over the wire */
464 int service;
465 BOOL force_user;
466 BOOL force_group;
467 struct vuid_cache vuid_cache;
468 void *dirptr;
469 BOOL printer;
470 BOOL ipc;
471 BOOL read_only;
472 BOOL admin_user;
473 char *dirpath;
474 char *connectpath;
475 char *origpath;
477 struct vfs_ops vfs; /* Filesystem operations */
478 struct vfs_ops vfs_opaque; /* OPAQUE Filesystem operations */
479 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
481 char *user; /* name of user who *opened* this connection */
482 uid_t uid; /* uid of user who *opened* this connection */
483 gid_t gid; /* gid of user who *opened* this connection */
484 char client_address[18]; /* String version of client IP address. */
486 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
488 /* following groups stuff added by ih */
490 /* This groups info is valid for the user that *opened* the connection */
491 int ngroups;
492 gid_t *groups;
493 NT_USER_TOKEN *nt_user_token;
495 time_t lastused;
496 BOOL used;
497 int num_files_open;
498 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
499 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
500 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
502 } connection_struct;
504 struct current_user
506 connection_struct *conn;
507 uint16 vuid;
508 uid_t uid;
509 gid_t gid;
510 int ngroups;
511 gid_t *groups;
512 NT_USER_TOKEN *nt_user_token;
515 /* Defines for the sent_oplock_break field above. */
516 #define NO_BREAK_SENT 0
517 #define EXCLUSIVE_BREAK_SENT 1
518 #define LEVEL_II_BREAK_SENT 2
520 typedef struct {
521 fstring smb_name; /* user name from the client */
522 fstring unix_name; /* unix user name of a validated user */
523 fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
524 fstring domain; /* domain that the client specified */
525 } userdom_struct;
527 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
529 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
530 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
532 typedef struct _print_queue_struct
534 int job;
535 int size;
536 int page_count;
537 int status;
538 int priority;
539 time_t time;
540 fstring fs_user;
541 fstring fs_file;
542 } print_queue_struct;
544 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
546 typedef struct
548 fstring message;
549 int qcount;
550 int status;
551 } print_status_struct;
553 /* used for server information: client, nameserv and ipc */
554 struct server_info_struct
556 fstring name;
557 uint32 type;
558 fstring comment;
559 fstring domain; /* used ONLY in ipc.c NOT namework.c */
560 BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
564 /* used for network interfaces */
565 struct interface
567 struct interface *next, *prev;
568 struct in_addr ip;
569 struct in_addr bcast;
570 struct in_addr nmask;
573 /* struct returned by get_share_modes */
574 typedef struct {
575 pid_t pid;
576 uint16 op_port;
577 uint16 op_type;
578 int share_mode;
579 uint32 desired_access;
580 struct timeval time;
581 SMB_DEV_T dev;
582 SMB_INO_T inode;
583 unsigned long share_file_id;
584 } share_mode_entry;
587 #define SHAREMODE_FN_CAST() \
588 void (*)(share_mode_entry *, char*)
590 #define SHAREMODE_FN(fn) \
591 void (*fn)(share_mode_entry *, char*)
593 #define NT_HASH_LEN 16
594 #define LM_HASH_LEN 16
597 * Flags for account policy.
599 #define AP_MIN_PASSWORD_LEN 1
600 #define AP_PASSWORD_HISTORY 2
601 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
602 #define AP_MAX_PASSWORD_AGE 4
603 #define AP_MIN_PASSWORD_AGE 5
604 #define AP_LOCK_ACCOUNT_DURATION 6
605 #define AP_RESET_COUNT_TIME 7
606 #define AP_BAD_ATTEMPT_LOCKOUT 8
607 #define AP_TIME_TO_LOGOUT 9
611 * Flags for local user manipulation.
614 #define LOCAL_ADD_USER 0x1
615 #define LOCAL_DELETE_USER 0x2
616 #define LOCAL_DISABLE_USER 0x4
617 #define LOCAL_ENABLE_USER 0x8
618 #define LOCAL_TRUST_ACCOUNT 0x10
619 #define LOCAL_SET_NO_PASSWORD 0x20
620 #define LOCAL_SET_PASSWORD 0x40
621 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
622 #define LOCAL_INTERDOM_ACCOUNT 0x100
623 #define LOCAL_AM_ROOT 0x200 /* Act as root */
625 /* key and data in the connections database - used in smbstatus and smbd */
626 struct connections_key {
627 pid_t pid;
628 int cnum;
629 fstring name;
632 struct connections_data {
633 int magic;
634 pid_t pid;
635 int cnum;
636 uid_t uid;
637 gid_t gid;
638 char name[24];
639 char addr[24];
640 char machine[FSTRING_LEN];
641 time_t start;
642 uint32 bcast_msg_flags;
646 /* key and data records in the tdb locking database */
647 struct locking_key {
648 SMB_DEV_T dev;
649 SMB_INO_T inode;
652 struct locking_data {
653 union {
654 int num_share_mode_entries;
655 share_mode_entry dummy; /* Needed for alignment. */
656 } u;
657 /* the following two entries are implicit
658 share_mode_entry modes[num_share_mode_entries];
659 char file_name[];
664 /* the following are used by loadparm for option lists */
665 typedef enum
667 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
668 P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
669 } parm_type;
671 typedef enum
673 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
674 } parm_class;
676 /* passed to br lock code */
677 enum brl_type {READ_LOCK, WRITE_LOCK, PENDING_LOCK};
679 struct enum_list {
680 int value;
681 const char *name;
684 #define BRLOCK_FN_CAST() \
685 void (*)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
686 enum brl_type lock_type, \
687 br_off start, br_off size)
688 #define BRLOCK_FN(fn) \
689 void (*fn)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
690 enum brl_type lock_type, \
691 br_off start, br_off size)
692 struct parm_struct
694 const char *label;
695 parm_type type;
696 parm_class class;
697 void *ptr;
698 BOOL (*special)(const char *, char **);
699 const struct enum_list *enum_list;
700 unsigned flags;
701 union {
702 BOOL bvalue;
703 int ivalue;
704 char *svalue;
705 char cvalue;
706 char **lvalue;
707 } def;
710 struct bitmap {
711 uint32 *b;
712 unsigned int n;
715 /* The following flags are used in SWAT */
716 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
717 #define FLAG_SHARE 0x0002 /* file sharing options */
718 #define FLAG_PRINT 0x0004 /* printing options */
719 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
720 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
721 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
722 #define FLAG_DEVELOPER 0x0040 /* No longer used */
723 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
724 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
725 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
727 #ifndef LOCKING_VERSION
728 #define LOCKING_VERSION 4
729 #endif /* LOCKING_VERSION */
732 /* the basic packet size, assuming no words or bytes */
733 #define smb_size 39
735 /* offsets into message for common items */
736 #define smb_com 8
737 #define smb_rcls 9
738 #define smb_reh 10
739 #define smb_err 11
740 #define smb_flg 13
741 #define smb_flg2 14
742 #define smb_pidhigh 16
743 #define smb_ss_field 18
744 #define smb_tid 28
745 #define smb_pid 30
746 #define smb_uid 32
747 #define smb_mid 34
748 #define smb_wct 36
749 #define smb_vwv 37
750 #define smb_vwv0 37
751 #define smb_vwv1 39
752 #define smb_vwv2 41
753 #define smb_vwv3 43
754 #define smb_vwv4 45
755 #define smb_vwv5 47
756 #define smb_vwv6 49
757 #define smb_vwv7 51
758 #define smb_vwv8 53
759 #define smb_vwv9 55
760 #define smb_vwv10 57
761 #define smb_vwv11 59
762 #define smb_vwv12 61
763 #define smb_vwv13 63
764 #define smb_vwv14 65
765 #define smb_vwv15 67
766 #define smb_vwv16 69
767 #define smb_vwv17 71
769 /* flag defines. CIFS spec 3.1.1 */
770 #define FLAG_SUPPORT_LOCKREAD 0x01
771 #define FLAG_CLIENT_BUF_AVAIL 0x02
772 #define FLAG_RESERVED 0x04
773 #define FLAG_CASELESS_PATHNAMES 0x08
774 #define FLAG_CANONICAL_PATHNAMES 0x10
775 #define FLAG_REQUEST_OPLOCK 0x20
776 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
777 #define FLAG_REPLY 0x80
779 /* the complete */
780 #define SMBmkdir 0x00 /* create directory */
781 #define SMBrmdir 0x01 /* delete directory */
782 #define SMBopen 0x02 /* open file */
783 #define SMBcreate 0x03 /* create file */
784 #define SMBclose 0x04 /* close file */
785 #define SMBflush 0x05 /* flush file */
786 #define SMBunlink 0x06 /* delete file */
787 #define SMBmv 0x07 /* rename file */
788 #define SMBgetatr 0x08 /* get file attributes */
789 #define SMBsetatr 0x09 /* set file attributes */
790 #define SMBread 0x0A /* read from file */
791 #define SMBwrite 0x0B /* write to file */
792 #define SMBlock 0x0C /* lock byte range */
793 #define SMBunlock 0x0D /* unlock byte range */
794 #define SMBctemp 0x0E /* create temporary file */
795 #define SMBmknew 0x0F /* make new file */
796 #define SMBchkpth 0x10 /* check directory path */
797 #define SMBexit 0x11 /* process exit */
798 #define SMBlseek 0x12 /* seek */
799 #define SMBtcon 0x70 /* tree connect */
800 #define SMBtconX 0x75 /* tree connect and X*/
801 #define SMBtdis 0x71 /* tree disconnect */
802 #define SMBnegprot 0x72 /* negotiate protocol */
803 #define SMBdskattr 0x80 /* get disk attributes */
804 #define SMBsearch 0x81 /* search directory */
805 #define SMBsplopen 0xC0 /* open print spool file */
806 #define SMBsplwr 0xC1 /* write to print spool file */
807 #define SMBsplclose 0xC2 /* close print spool file */
808 #define SMBsplretq 0xC3 /* return print queue */
809 #define SMBsends 0xD0 /* send single block message */
810 #define SMBsendb 0xD1 /* send broadcast message */
811 #define SMBfwdname 0xD2 /* forward user name */
812 #define SMBcancelf 0xD3 /* cancel forward */
813 #define SMBgetmac 0xD4 /* get machine name */
814 #define SMBsendstrt 0xD5 /* send start of multi-block message */
815 #define SMBsendend 0xD6 /* send end of multi-block message */
816 #define SMBsendtxt 0xD7 /* send text of multi-block message */
818 /* Core+ protocol */
819 #define SMBlockread 0x13 /* Lock a range and read */
820 #define SMBwriteunlock 0x14 /* Unlock a range then write */
821 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
822 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
823 #define SMBwritec 0x20 /* secondary write request */
824 #define SMBwriteclose 0x2c /* write a file then close it */
826 /* dos extended protocol */
827 #define SMBreadBraw 0x1A /* read block raw */
828 #define SMBreadBmpx 0x1B /* read block multiplexed */
829 #define SMBreadBs 0x1C /* read block (secondary response) */
830 #define SMBwriteBraw 0x1D /* write block raw */
831 #define SMBwriteBmpx 0x1E /* write block multiplexed */
832 #define SMBwriteBs 0x1F /* write block (secondary request) */
833 #define SMBwriteC 0x20 /* write complete response */
834 #define SMBsetattrE 0x22 /* set file attributes expanded */
835 #define SMBgetattrE 0x23 /* get file attributes expanded */
836 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
837 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
838 #define SMBtranss 0x26 /* transaction (secondary request/response) */
839 #define SMBioctl 0x27 /* IOCTL */
840 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
841 #define SMBcopy 0x29 /* copy */
842 #define SMBmove 0x2A /* move */
843 #define SMBecho 0x2B /* echo */
844 #define SMBopenX 0x2D /* open and X */
845 #define SMBreadX 0x2E /* read and X */
846 #define SMBwriteX 0x2F /* write and X */
847 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
848 #define SMBffirst 0x82 /* find first */
849 #define SMBfunique 0x83 /* find unique */
850 #define SMBfclose 0x84 /* find close */
851 #define SMBkeepalive 0x85 /* keepalive */
852 #define SMBinvalid 0xFE /* invalid command */
854 /* Extended 2.0 protocol */
855 #define SMBtrans2 0x32 /* TRANS2 protocol set */
856 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
857 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
858 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
859 #define SMBulogoffX 0x74 /* user logoff */
861 /* NT SMB extensions. */
862 #define SMBnttrans 0xA0 /* NT transact */
863 #define SMBnttranss 0xA1 /* NT transact secondary */
864 #define SMBntcreateX 0xA2 /* NT create and X */
865 #define SMBntcancel 0xA4 /* NT cancel */
867 /* These are the trans subcommands */
868 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
869 #define TRANSACT_DCERPCCMD 0x26
870 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
872 /* These are the TRANS2 sub commands */
873 #define TRANSACT2_OPEN 0x00
874 #define TRANSACT2_FINDFIRST 0x01
875 #define TRANSACT2_FINDNEXT 0x02
876 #define TRANSACT2_QFSINFO 0x03
877 #define TRANSACT2_SETFSINFO 0x04
878 #define TRANSACT2_QPATHINFO 0x05
879 #define TRANSACT2_SETPATHINFO 0x06
880 #define TRANSACT2_QFILEINFO 0x07
881 #define TRANSACT2_SETFILEINFO 0x08
882 #define TRANSACT2_FSCTL 0x09
883 #define TRANSACT2_IOCTL 0x0A
884 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
885 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
886 #define TRANSACT2_MKDIR 0x0D
887 #define TRANSACT2_SESSION_SETUP 0x0E
888 #define TRANSACT2_GET_DFS_REFERRAL 0x10
889 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
891 /* These are the NT transact sub commands. */
892 #define NT_TRANSACT_CREATE 1
893 #define NT_TRANSACT_IOCTL 2
894 #define NT_TRANSACT_SET_SECURITY_DESC 3
895 #define NT_TRANSACT_NOTIFY_CHANGE 4
896 #define NT_TRANSACT_RENAME 5
897 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
898 #define NT_TRANSACT_GET_USER_QUOTA 7
899 #define NT_TRANSACT_SET_USER_QUOTA 8
901 /* These are the NT transact_get_user_quota sub commands */
902 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
903 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
904 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
906 /* Relevant IOCTL codes */
907 #define IOCTL_QUERY_JOB_INFO 0x530060
909 /* these are the trans2 sub fields for primary requests */
910 #define smb_tpscnt smb_vwv0
911 #define smb_tdscnt smb_vwv1
912 #define smb_mprcnt smb_vwv2
913 #define smb_mdrcnt smb_vwv3
914 #define smb_msrcnt smb_vwv4
915 #define smb_flags smb_vwv5
916 #define smb_timeout smb_vwv6
917 #define smb_pscnt smb_vwv9
918 #define smb_psoff smb_vwv10
919 #define smb_dscnt smb_vwv11
920 #define smb_dsoff smb_vwv12
921 #define smb_suwcnt smb_vwv13
922 #define smb_setup smb_vwv14
923 #define smb_setup0 smb_setup
924 #define smb_setup1 (smb_setup+2)
925 #define smb_setup2 (smb_setup+4)
927 /* these are for the secondary requests */
928 #define smb_spscnt smb_vwv2
929 #define smb_spsoff smb_vwv3
930 #define smb_spsdisp smb_vwv4
931 #define smb_sdscnt smb_vwv5
932 #define smb_sdsoff smb_vwv6
933 #define smb_sdsdisp smb_vwv7
934 #define smb_sfid smb_vwv8
936 /* and these for responses */
937 #define smb_tprcnt smb_vwv0
938 #define smb_tdrcnt smb_vwv1
939 #define smb_prcnt smb_vwv3
940 #define smb_proff smb_vwv4
941 #define smb_prdisp smb_vwv5
942 #define smb_drcnt smb_vwv6
943 #define smb_droff smb_vwv7
944 #define smb_drdisp smb_vwv8
946 /* these are for the NT trans primary request. */
947 #define smb_nt_MaxSetupCount smb_vwv0
948 #define smb_nt_Flags (smb_vwv0 + 1)
949 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
950 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
951 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
952 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
953 #define smb_nt_ParameterCount (smb_vwv0 + 19)
954 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
955 #define smb_nt_DataCount (smb_vwv0 + 27)
956 #define smb_nt_DataOffset (smb_vwv0 + 31)
957 #define smb_nt_SetupCount (smb_vwv0 + 35)
958 #define smb_nt_Function (smb_vwv0 + 36)
959 #define smb_nt_SetupStart (smb_vwv0 + 38)
961 /* these are for the NT trans secondary request. */
962 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
963 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
964 #define smb_nts_ParameterCount (smb_vwv0 + 11)
965 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
966 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
967 #define smb_nts_DataCount (smb_vwv0 + 23)
968 #define smb_nts_DataOffset (smb_vwv0 + 27)
969 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
971 /* these are for the NT trans reply. */
972 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
973 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
974 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
975 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
976 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
977 #define smb_ntr_DataCount (smb_vwv0 + 23)
978 #define smb_ntr_DataOffset (smb_vwv0 + 27)
979 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
981 /* these are for the NT create_and_X */
982 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
983 #define smb_ntcreate_Flags (smb_vwv0 + 7)
984 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
985 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
986 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
987 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
988 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
989 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
990 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
991 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
992 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
994 /* this is used on a TConX. I'm not sure the name is very helpful though */
995 #define SMB_SUPPORT_SEARCH_BITS 0x0001
996 #define SMB_SHARE_IN_DFS 0x0002
998 /* Named pipe write mode flags. Used in writeX calls. */
999 #define PIPE_RAW_MODE 0x4
1000 #define PIPE_START_MESSAGE 0x8
1002 /* File Specific access rights */
1003 #define FILE_READ_DATA 0x00000001
1004 #define FILE_WRITE_DATA 0x00000002
1005 #define FILE_APPEND_DATA 0x00000004
1006 #define FILE_READ_EA 0x00000008 /* File and directory */
1007 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1008 #define FILE_EXECUTE 0x00000020
1009 #define FILE_DELETE_CHILD 0x00000040
1010 #define FILE_READ_ATTRIBUTES 0x00000080
1011 #define FILE_WRITE_ATTRIBUTES 0x00000100
1013 #define FILE_ALL_ACCESS 0x000001FF
1015 /* Directory specific access rights */
1016 #define FILE_LIST_DIRECTORY 0x00000001
1017 #define FILE_ADD_FILE 0x00000002
1018 #define FILE_ADD_SUBDIRECTORY 0x00000004
1019 #define FILE_TRAVERSE 0x00000020
1020 #define FILE_DELETE_CHILD 0x00000040
1022 /* the desired access to use when opening a pipe */
1023 #define DESIRED_ACCESS_PIPE 0x2019f
1025 /* Generic access masks & rights. */
1026 #define DELETE_ACCESS (1L<<16) /* 0x00010000 */
1027 #define READ_CONTROL_ACCESS (1L<<17) /* 0x00020000 */
1028 #define WRITE_DAC_ACCESS (1L<<18) /* 0x00040000 */
1029 #define WRITE_OWNER_ACCESS (1L<<19) /* 0x00080000 */
1030 #define SYNCHRONIZE_ACCESS (1L<<20) /* 0x00100000 */
1032 #define SYSTEM_SECURITY_ACCESS (1L<<24) /* 0x01000000 */
1033 #define MAXIMUM_ALLOWED_ACCESS (1L<<25) /* 0x02000000 */
1034 #define GENERIC_ALL_ACCESS (1<<28) /* 0x10000000 */
1035 #define GENERIC_EXECUTE_ACCESS (1<<29) /* 0x20000000 */
1036 #define GENERIC_WRITE_ACCESS (1<<30) /* 0x40000000 */
1037 #define GENERIC_READ_ACCESS (((unsigned)1)<<31) /* 0x80000000 */
1039 /* Mapping of generic access rights for files to specific rights. */
1041 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1043 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1044 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1046 #define FILE_GENERIC_WRITE (STANDARD_RIGHTS_WRITE_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1047 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1049 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
1050 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1052 /* Mapping of access rights to UNIX perms. */
1053 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1054 #define UNIX_ACCESS_R FILE_GENERIC_READ
1055 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1056 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1058 #if 0
1060 * This is the old mapping we used to use. To get W2KSP2 profiles
1061 * working we need to map to the canonical file perms.
1063 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1064 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1065 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1066 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1067 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1068 FILE_APPEND_DATA|FILE_WRITE_DATA)
1069 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1070 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1071 #endif
1073 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1075 /* Flags field. */
1076 #define REQUEST_OPLOCK 2
1077 #define REQUEST_BATCH_OPLOCK 4
1078 #define OPEN_DIRECTORY 8
1080 /* ShareAccess field. */
1081 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1082 #define FILE_SHARE_READ 1
1083 #define FILE_SHARE_WRITE 2
1084 #define FILE_SHARE_DELETE 4
1086 /* FileAttributesField */
1087 #define FILE_ATTRIBUTE_READONLY 0x001L
1088 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1089 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1090 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1091 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1092 #define FILE_ATTRIBUTE_NORMAL 0x080L
1093 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1094 #define FILE_ATTRIBUTE_SPARSE 0x200L
1095 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1096 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1097 #define SAMBA_ATTRIBUTES_MASK 0x7F
1099 /* Flags - combined with attributes. */
1100 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1101 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1102 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1103 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1104 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1105 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1106 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1108 /* CreateDisposition field. */
1109 #define FILE_SUPERSEDE 0
1110 #define FILE_OPEN 1
1111 #define FILE_CREATE 2
1112 #define FILE_OPEN_IF 3
1113 #define FILE_OVERWRITE 4
1114 #define FILE_OVERWRITE_IF 5
1116 /* CreateOptions field. */
1117 #define FILE_DIRECTORY_FILE 0x0001
1118 #define FILE_WRITE_THROUGH 0x0002
1119 #define FILE_SEQUENTIAL_ONLY 0x0004
1120 #define FILE_NON_DIRECTORY_FILE 0x0040
1121 #define FILE_NO_EA_KNOWLEDGE 0x0200
1122 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1123 #define FILE_RANDOM_ACCESS 0x0800
1124 #define FILE_DELETE_ON_CLOSE 0x1000
1125 #define FILE_OPEN_BY_FILE_ID 0x2000
1127 /* Responses when opening a file. */
1128 #define FILE_WAS_SUPERSEDED 0
1129 #define FILE_WAS_OPENED 1
1130 #define FILE_WAS_CREATED 2
1131 #define FILE_WAS_OVERWRITTEN 3
1133 /* File type flags */
1134 #define FILE_TYPE_DISK 0
1135 #define FILE_TYPE_BYTE_MODE_PIPE 1
1136 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1137 #define FILE_TYPE_PRINTER 3
1138 #define FILE_TYPE_COMM_DEVICE 4
1139 #define FILE_TYPE_UNKNOWN 0xFFFF
1141 /* Flag for NT transact rename call. */
1142 #define RENAME_REPLACE_IF_EXISTS 1
1144 /* Filesystem Attributes. */
1145 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1146 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1147 #define FILE_UNICODE_ON_DISK 0x00000004
1148 /* According to cifs9f, this is 4, not 8 */
1149 /* Acconding to testing, this actually sets the security attribute! */
1150 #define FILE_PERSISTENT_ACLS 0x00000008
1151 #define FILE_FILE_COMPRESSION 0x00000010
1152 #define FILE_VOLUME_QUOTAS 0x00000020
1153 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1154 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1155 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1156 #define FS_LFN_APIS 0x00004000
1157 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1158 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1159 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1160 #define FILE_NAMED_STREAMS 0x00040000
1161 #define FILE_READ_ONLY_VOLUME 0x00080000
1163 /* ChangeNotify flags. */
1164 #define FILE_NOTIFY_CHANGE_FILE 0x001
1165 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1166 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1167 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1168 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1169 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1170 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1171 #define FILE_NOTIFY_CHANGE_EA 0x080
1172 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1173 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x200
1175 /* where to find the base of the SMB packet proper */
1176 #define smb_base(buf) (((char *)(buf))+4)
1178 /* we don't allow server strings to be longer than 48 characters as
1179 otherwise NT will not honour the announce packets */
1180 #define MAX_SERVER_STRING_LENGTH 48
1183 #define SMB_SUCCESS 0 /* The request was successful. */
1185 #ifdef WITH_DFS
1186 void dfs_unlogin(void);
1187 extern int dcelogin_atmost_once;
1188 #endif
1190 #ifdef NOSTRDUP
1191 char *strdup(char *s);
1192 #endif
1194 #ifndef SIGNAL_CAST
1195 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1196 #endif
1198 #ifndef SELECT_CAST
1199 #define SELECT_CAST
1200 #endif
1202 /* these are used in NetServerEnum to choose what to receive */
1203 #define SV_TYPE_WORKSTATION 0x00000001
1204 #define SV_TYPE_SERVER 0x00000002
1205 #define SV_TYPE_SQLSERVER 0x00000004
1206 #define SV_TYPE_DOMAIN_CTRL 0x00000008
1207 #define SV_TYPE_DOMAIN_BAKCTRL 0x00000010
1208 #define SV_TYPE_TIME_SOURCE 0x00000020
1209 #define SV_TYPE_AFP 0x00000040
1210 #define SV_TYPE_NOVELL 0x00000080
1211 #define SV_TYPE_DOMAIN_MEMBER 0x00000100
1212 #define SV_TYPE_PRINTQ_SERVER 0x00000200
1213 #define SV_TYPE_DIALIN_SERVER 0x00000400
1214 #define SV_TYPE_SERVER_UNIX 0x00000800
1215 #define SV_TYPE_NT 0x00001000
1216 #define SV_TYPE_WFW 0x00002000
1217 #define SV_TYPE_SERVER_MFPN 0x00004000
1218 #define SV_TYPE_SERVER_NT 0x00008000
1219 #define SV_TYPE_POTENTIAL_BROWSER 0x00010000
1220 #define SV_TYPE_BACKUP_BROWSER 0x00020000
1221 #define SV_TYPE_MASTER_BROWSER 0x00040000
1222 #define SV_TYPE_DOMAIN_MASTER 0x00080000
1223 #define SV_TYPE_SERVER_OSF 0x00100000
1224 #define SV_TYPE_SERVER_VMS 0x00200000
1225 #define SV_TYPE_WIN95_PLUS 0x00400000
1226 #define SV_TYPE_DFS_SERVER 0x00800000
1227 #define SV_TYPE_ALTERNATE_XPORT 0x20000000
1228 #define SV_TYPE_LOCAL_LIST_ONLY 0x40000000
1229 #define SV_TYPE_DOMAIN_ENUM 0x80000000
1230 #define SV_TYPE_ALL 0xFFFFFFFF
1232 /* This was set by JHT in liaison with Jeremy Allison early 1997
1233 * History:
1234 * Version 4.0 - never made public
1235 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1236 * - Reappeared in 1.9.16p11 with fixed smbd services
1237 * Version 4.20 - To indicate that nmbd and browsing now works better
1238 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1240 * Note: In the presence of NT4.X do not set above 4.9
1241 * Setting this above 4.9 can have undesired side-effects.
1242 * This may change again in Samba-3.0 after further testing. JHT
1245 #define DEFAULT_MAJOR_VERSION 0x04
1246 #define DEFAULT_MINOR_VERSION 0x09
1248 /* Browser Election Values */
1249 #define BROWSER_ELECTION_VERSION 0x010f
1250 #define BROWSER_CONSTANT 0xaa55
1252 /* Sercurity mode bits. */
1253 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1254 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1255 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1256 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1258 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1260 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1261 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1262 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1263 #define FLAGS2_IS_LONG_NAME 0x0040
1264 #define FLAGS2_EXTENDED_SECURITY 0x0800
1265 #define FLAGS2_DFS_PATHNAMES 0x1000
1266 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1267 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1268 #define FLAGS2_UNICODE_STRINGS 0x8000
1270 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1272 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1274 #define CAP_RAW_MODE 0x0001
1275 #define CAP_MPX_MODE 0x0002
1276 #define CAP_UNICODE 0x0004
1277 #define CAP_LARGE_FILES 0x0008
1278 #define CAP_NT_SMBS 0x0010
1279 #define CAP_RPC_REMOTE_APIS 0x0020
1280 #define CAP_STATUS32 0x0040
1281 #define CAP_LEVEL_II_OPLOCKS 0x0080
1282 #define CAP_LOCK_AND_READ 0x0100
1283 #define CAP_NT_FIND 0x0200
1284 #define CAP_DFS 0x1000
1285 #define CAP_W2K_SMBS 0x2000
1286 #define CAP_LARGE_READX 0x4000
1287 #define CAP_LARGE_WRITEX 0x8000
1288 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1289 #define CAP_EXTENDED_SECURITY 0x80000000
1291 /* protocol types. It assumes that higher protocols include lower protocols
1292 as subsets */
1293 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1295 /* security levels */
1296 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1298 /* server roles */
1299 enum server_types
1301 ROLE_STANDALONE,
1302 ROLE_DOMAIN_MEMBER,
1303 ROLE_DOMAIN_BDC,
1304 ROLE_DOMAIN_PDC
1307 /* printing types */
1308 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1309 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1310 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2
1311 #ifdef DEVELOPER
1312 ,PRINT_TEST,PRINT_VLP
1313 #endif /* DEVELOPER */
1316 /* LDAP schema types */
1317 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1319 /* LDAP SSL options */
1320 enum ldap_ssl_types {LDAP_SSL_ON, LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1322 /* LDAP PASSWD SYNC methods */
1323 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1325 /* Remote architectures we know about. */
1326 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_SAMBA};
1328 /* case handling */
1329 enum case_handling {CASE_LOWER,CASE_UPPER};
1332 * Global value meaing that the smb_uid field should be
1333 * ingored (in share level security and protocol level == CORE)
1336 #define UID_FIELD_INVALID 0
1337 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1340 * Size of buffer to use when moving files across filesystems.
1342 #define COPYBUF_SIZE (8*1024)
1345 * Values used to override error codes.
1347 extern int unix_ERR_class;
1348 extern int unix_ERR_code;
1349 extern NTSTATUS unix_ERR_ntstatus;
1352 * Used in chaining code.
1354 extern int chain_size;
1357 * Map the Core and Extended Oplock requesst bits down
1358 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1362 * Core protocol.
1364 #define CORE_OPLOCK_REQUEST(inbuf) \
1365 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1368 * Extended protocol.
1370 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1372 /* Lock types. */
1373 #define LOCKING_ANDX_SHARED_LOCK 0x1
1374 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1375 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1376 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1377 #define LOCKING_ANDX_LARGE_FILES 0x10
1379 /* Oplock levels */
1380 #define OPLOCKLEVEL_NONE 0
1381 #define OPLOCKLEVEL_II 1
1384 * Bits we test with.
1387 #define NO_OPLOCK 0
1388 #define EXCLUSIVE_OPLOCK 1
1389 #define BATCH_OPLOCK 2
1390 #define LEVEL_II_OPLOCK 4
1392 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1393 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1394 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1396 #define CORE_OPLOCK_GRANTED (1<<5)
1397 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1400 * Return values for oplock types.
1403 #define NO_OPLOCK_RETURN 0
1404 #define EXCLUSIVE_OPLOCK_RETURN 1
1405 #define BATCH_OPLOCK_RETURN 2
1406 #define LEVEL_II_OPLOCK_RETURN 3
1409 * Loopback command offsets.
1412 #define OPBRK_CMD_LEN_OFFSET 0
1413 #define OPBRK_CMD_PORT_OFFSET 4
1414 #define OPBRK_CMD_HEADER_LEN 6
1416 #define OPBRK_MESSAGE_CMD_OFFSET 0
1419 * Oplock break command code to send over the udp socket.
1420 * The same message is sent for both exlusive and level II breaks.
1422 * The form of this is :
1424 * 0 2 2+pid 2+pid+dev 2+pid+dev+ino
1425 * +----+--------+-------+--------+---------+
1426 * | cmd| pid | dev | inode | fileid |
1427 * +----+--------+-------+--------+---------+
1430 #define OPLOCK_BREAK_PID_OFFSET 2
1431 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1432 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1433 #define OPLOCK_BREAK_FILEID_OFFSET (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1434 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1436 /* Message types */
1437 #define OPLOCK_BREAK_CMD 0x1
1438 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1439 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1440 #define ASYNC_LEVEL_II_OPLOCK_BREAK_CMD 0x4
1443 * Capabilities abstracted for different systems.
1446 #define KERNEL_OPLOCK_CAPABILITY 0x1
1449 * Oplock break command code sent via the kernel interface (if it exists).
1451 * Form of this is :
1453 * 0 2 2+devsize 2+devsize+inodesize
1454 * +----+--------+--------+----------+
1455 * | cmd| dev | inode | fileid |
1456 * +----+--------+--------+----------+
1458 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1459 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1460 #define KERNEL_OPLOCK_BREAK_FILEID_OFFSET (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1461 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
1464 /* if a kernel does support oplocks then a structure of the following
1465 typee is used to describe how to interact with the kernel */
1466 struct kernel_oplocks {
1467 BOOL (*receive_message)(fd_set *fds, char *buffer, int buffer_len);
1468 BOOL (*set_oplock)(files_struct *fsp, int oplock_type);
1469 void (*release_oplock)(files_struct *fsp);
1470 BOOL (*parse_message)(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev, unsigned long *file_id);
1471 BOOL (*msg_waiting)(fd_set *fds);
1472 int notification_fd;
1476 #define CMD_REPLY 0x8000
1478 /* this structure defines the functions for doing change notify in
1479 various implementations */
1480 struct cnotify_fns {
1481 void * (*register_notify)(connection_struct *conn, char *path, uint32 flags);
1482 BOOL (*check_notify)(connection_struct *conn, uint16 vuid, char *path, uint32 flags, void *data, time_t t);
1483 void (*remove_notify)(void *data);
1484 int select_time;
1489 #include "smb_macros.h"
1491 typedef char nstring[16];
1493 /* A netbios name structure. */
1494 struct nmb_name {
1495 nstring name;
1496 char scope[64];
1497 unsigned int name_type;
1501 /* A netbios node status array element. */
1502 struct node_status {
1503 nstring name;
1504 unsigned char type;
1505 unsigned char flags;
1508 struct pwd_info
1510 BOOL null_pwd;
1511 BOOL cleartext;
1512 BOOL crypted;
1514 fstring password;
1516 uchar smb_lm_pwd[16];
1517 uchar smb_nt_pwd[16];
1519 uchar smb_lm_owf[24];
1520 uchar smb_nt_owf[128];
1521 size_t nt_owf_len;
1523 uchar lm_cli_chal[8];
1524 uchar nt_cli_chal[128];
1525 size_t nt_cli_chal_len;
1527 uchar sess_key[16];
1530 typedef struct user_struct
1532 struct user_struct *next, *prev;
1533 uint16 vuid; /* Tag for this entry. */
1534 uid_t uid; /* uid of a validated user */
1535 gid_t gid; /* gid of a validated user */
1537 userdom_struct user;
1538 char *homedir;
1539 char *unix_homedir;
1540 char *logon_script;
1542 BOOL guest;
1544 /* following groups stuff added by ih */
1545 /* This groups info is needed for when we become_user() for this uid */
1546 int n_groups;
1547 gid_t *groups;
1549 NT_USER_TOKEN *nt_user_token;
1551 uint8 session_key[16];
1553 char *session_keystr; /* used by utmp and pam session code.
1554 TDB key string */
1555 int homes_snum;
1557 struct auth_serversupplied_info *server_info;
1559 } user_struct;
1562 struct unix_error_map {
1563 int unix_error;
1564 int dos_class;
1565 int dos_code;
1566 NTSTATUS nt_error;
1570 #include "ntdomain.h"
1572 #include "client.h"
1576 * Size of new password account encoding string. This is enough space to
1577 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1578 * Do not change unless you are adding new ACB bits!
1581 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1584 Do you want session setups at user level security with a invalid
1585 password to be rejected or allowed in as guest? WinNT rejects them
1586 but it can be a pain as it means "net view" needs to use a password
1588 You have 3 choices in the setting of map_to_guest:
1590 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1591 are rejected. This is the default.
1593 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1594 are rejected, unless the username does not exist, in which case it
1595 is treated as a guest login
1597 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1598 are treated as a guest login
1600 Note that map_to_guest only has an effect in user or server
1601 level security.
1604 #define NEVER_MAP_TO_GUEST 0
1605 #define MAP_TO_GUEST_ON_BAD_USER 1
1606 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1608 #define SAFE_NETBIOS_CHARS ". -_"
1610 /* generic iconv conversion structure */
1611 typedef struct {
1612 size_t (*direct)(void *cd, char **inbuf, size_t *inbytesleft,
1613 char **outbuf, size_t *outbytesleft);
1614 size_t (*pull)(void *cd, char **inbuf, size_t *inbytesleft,
1615 char **outbuf, size_t *outbytesleft);
1616 size_t (*push)(void *cd, char **inbuf, size_t *inbytesleft,
1617 char **outbuf, size_t *outbytesleft);
1618 void *cd_direct, *cd_pull, *cd_push;
1619 char *from_name, *to_name;
1620 } *smb_iconv_t;
1622 /* The maximum length of a trust account password.
1623 Used when we randomly create it, 15 char passwords
1624 exceed NT4's max password length */
1626 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1628 #include "popt_common.h"
1630 #define PORT_NONE 0
1631 #ifndef LDAP_PORT
1632 #define LDAP_PORT 389
1633 #endif
1635 /* used by the IP comparison function */
1636 struct ip_service {
1637 struct in_addr ip;
1638 unsigned port;
1641 /* Used by the SMB signing functions. */
1643 typedef struct smb_sign_info {
1644 void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1645 BOOL (*check_incoming_message)(char *inbuf, struct smb_sign_info *si);
1646 void (*free_signing_context)(struct smb_sign_info *si);
1647 void *signing_context;
1649 BOOL negotiated_smb_signing;
1650 BOOL allow_smb_signing;
1651 BOOL doing_signing;
1652 BOOL mandatory_signing;
1653 } smb_sign_info;
1655 #endif /* _SMB_H */