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 3 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, see <http://www.gnu.org/licenses/>.
29 /* logged when starting the various Samba daemons */
30 #define COPYRIGHT_STARTUP_MESSAGE "Copyright Andrew Tridgell and the Samba Team 1992-2009"
33 #if defined(LARGE_SMB_OFF_T)
34 #define BUFFER_SIZE (128*1024)
35 #else /* no large readwrite possible */
36 #define BUFFER_SIZE (0xFFFF)
39 #define SAFETY_MARGIN 1024
40 #define LARGE_WRITEX_HDR_SIZE 65
43 #define DGRAM_PORT 138
46 #define SMB_PORTS "445 139"
48 #define Undefined (-1)
56 #ifndef DEF_CREATE_MASK
57 #define DEF_CREATE_MASK (0755)
60 /* string manipulation flags - see clistr.c and srvstr.c */
61 #define STR_TERMINATE 1
65 #define STR_NOALIGN 16
66 #define STR_TERMINATE_ASCII 128
68 /* how long to wait for secondary SMB packets (milli-seconds) */
69 #define SMB_SECONDARY_WAIT (60*1000)
74 /* this defines the error codes that receive_smb can put in smb_read_error */
75 enum smb_read_errors {
80 SMB_WRITE_ERROR, /* This error code can go into the client smb_rw_error. */
83 SMB_DO_NOT_DO_TDIS, /* 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 */
106 #define DOS_OPEN_RDONLY 0
107 #define DOS_OPEN_WRONLY 1
108 #define DOS_OPEN_RDWR 2
109 #define DOS_OPEN_EXEC 3
110 #define DOS_OPEN_FCB 0xF
112 /* define shifts and masks for share and open modes. */
113 #define OPENX_MODE_MASK 0xF
114 #define DENY_MODE_SHIFT 4
115 #define DENY_MODE_MASK 0x7
116 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
117 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
118 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
119 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
121 /* Sync on open file (not sure if used anymore... ?) */
122 #define FILE_SYNC_OPENMODE (1<<14)
123 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
125 /* open disposition values */
126 #define OPENX_FILE_EXISTS_FAIL 0
127 #define OPENX_FILE_EXISTS_OPEN 1
128 #define OPENX_FILE_EXISTS_TRUNCATE 2
130 /* mask for open disposition. */
131 #define OPENX_FILE_OPEN_MASK 0x3
133 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
134 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
136 /* The above can be OR'ed with... */
137 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
138 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
142 typedef union unid_t {
148 * SMB UCS2 (16-bit unicode) internal type.
149 * smb_ucs2_t is *always* in little endian format.
152 typedef uint16 smb_ucs2_t;
154 #ifdef WORDS_BIGENDIAN
160 /* turn a 7 bit character into a ucs2 character */
161 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
163 /* return an ascii version of a ucs2 character */
164 #define UCS2_TO_CHAR(c) (((c) >> UCS2_SHIFT) & 0xff)
166 /* Copy into a smb_ucs2_t from a possibly unaligned buffer. Return the copied smb_ucs2_t */
167 #define COPY_UCS2_CHAR(dest,src) (((unsigned char *)(dest))[0] = ((unsigned char *)(src))[0],\
168 ((unsigned char *)(dest))[1] = ((unsigned char *)(src))[1], (dest))
170 /* Large data type for manipulating uint32 unicode codepoints */
171 typedef uint32 codepoint_t;
172 #define INVALID_CODEPOINT ((codepoint_t)-1)
174 /* pipe string names */
175 #define PIPE_LANMAN "\\PIPE\\LANMAN"
177 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
178 typedef uint64_t NTTIME;
180 #define MAX_HOURS_LEN 32
183 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
186 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
188 #define LOOKUP_NAME_NONE 0x00000000
189 #define LOOKUP_NAME_ISOLATED 0x00000001 /* Look up unqualified names */
190 #define LOOKUP_NAME_REMOTE 0x00000002 /* Ask others */
191 #define LOOKUP_NAME_GROUP 0x00000004 /* (unused) This is a NASTY hack for
192 valid users = @foo where foo also
193 exists in as user. */
194 #define LOOKUP_NAME_EXPLICIT 0x00000008 /* Only include
195 explicitly mapped names and not
196 the Unix {User,Group} domain */
197 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
198 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
199 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
200 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
201 |LOOKUP_NAME_BUILTIN\
204 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
206 |LOOKUP_NAME_BUILTIN\
211 * @brief Security Identifier
213 * @sa http://msdn.microsoft.com/library/default.asp?url=/library/en-us/security/accctrl_38yn.asp
215 typedef struct dom_sid {
216 uint8 sid_rev_num; /**< SID revision number */
217 uint8 num_auths; /**< Number of sub-authorities */
218 uint8 id_auth[6]; /**< Identifier Authority */
220 * Pointer to sub-authorities.
222 * @note The values in these uint32's are in *native* byteorder, not
223 * neccessarily little-endian...... JRA.
225 uint32 sub_auths[MAXSUBAUTHS];
236 ID_TYPE_NOT_SPECIFIED = 0,
249 enum id_mapping status;
252 /* used to hold an arbitrary blob of data */
253 typedef struct data_blob {
256 void (*free)(struct data_blob *data_blob);
259 extern const DATA_BLOB data_blob_null;
261 #include "librpc/gen_ndr/misc.h"
262 #include "librpc/gen_ndr/security.h"
263 #include "librpc/ndr/libndr.h"
264 #include "librpc/gen_ndr/lsa.h"
265 #include "librpc/gen_ndr/dfs.h"
266 #include "librpc/gen_ndr/winreg.h"
267 #include "librpc/gen_ndr/initshutdown.h"
268 #include "librpc/gen_ndr/eventlog.h"
269 #include "librpc/gen_ndr/srvsvc.h"
270 #include "librpc/gen_ndr/wkssvc.h"
271 #include "librpc/gen_ndr/echo.h"
272 #include "librpc/gen_ndr/svcctl.h"
273 #include "librpc/gen_ndr/netlogon.h"
274 #include "librpc/gen_ndr/samr.h"
275 #include "librpc/gen_ndr/dssetup.h"
276 #include "librpc/gen_ndr/epmapper.h"
277 #include "librpc/gen_ndr/libnet_join.h"
278 #include "librpc/gen_ndr/krb5pac.h"
279 #include "librpc/gen_ndr/ntsvcs.h"
280 #include "librpc/gen_ndr/nbt.h"
281 #include "librpc/gen_ndr/drsuapi.h"
282 #include "librpc/gen_ndr/drsblobs.h"
284 struct lsa_dom_info {
292 struct lsa_name_info {
294 enum lsa_SidType type;
299 /* Some well-known SIDs */
300 extern const DOM_SID global_sid_World_Domain;
301 extern const DOM_SID global_sid_World;
302 extern const DOM_SID global_sid_Creator_Owner_Domain;
303 extern const DOM_SID global_sid_NT_Authority;
304 extern const DOM_SID global_sid_System;
305 extern const DOM_SID global_sid_NULL;
306 extern const DOM_SID global_sid_Authenticated_Users;
307 extern const DOM_SID global_sid_Network;
308 extern const DOM_SID global_sid_Creator_Owner;
309 extern const DOM_SID global_sid_Creator_Group;
310 extern const DOM_SID global_sid_Anonymous;
311 extern const DOM_SID global_sid_Builtin;
312 extern const DOM_SID global_sid_Builtin_Administrators;
313 extern const DOM_SID global_sid_Builtin_Users;
314 extern const DOM_SID global_sid_Builtin_Guests;
315 extern const DOM_SID global_sid_Builtin_Power_Users;
316 extern const DOM_SID global_sid_Builtin_Account_Operators;
317 extern const DOM_SID global_sid_Builtin_Server_Operators;
318 extern const DOM_SID global_sid_Builtin_Print_Operators;
319 extern const DOM_SID global_sid_Builtin_Backup_Operators;
320 extern const DOM_SID global_sid_Builtin_Replicator;
321 extern const DOM_SID global_sid_Builtin_PreWin2kAccess;
322 extern const DOM_SID global_sid_Unix_Users;
323 extern const DOM_SID global_sid_Unix_Groups;
326 * The complete list of SIDS belonging to this user.
327 * Created when a vuid is registered.
328 * The definition of the user_sids array is as follows :
330 * token->user_sids[0] = primary user SID.
331 * token->user_sids[1] = primary group SID.
332 * token->user_sids[2..num_sids] = supplementary group SIDS.
335 #define PRIMARY_USER_SID_INDEX 0
336 #define PRIMARY_GROUP_SID_INDEX 1
338 typedef struct nt_user_token {
344 typedef struct unix_user_token {
351 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
352 typedef struct time_info {
356 typedef struct write_cache {
365 smb_ucs2_t *origname;
366 smb_ucs2_t *filename;
367 SMB_STRUCT_STAT *statinfo;
370 #include "fake_file.h"
375 SMB_BIG_UINT position_information;
377 uint32 private_options; /* NT Create options, but we only look at
378 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
379 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB (Except
380 * for print files *only*, where
381 * DELETE_ON_CLOSE is not stored in the share
384 unsigned long gen_id;
388 struct share_mode_entry;
393 struct vfs_fsp_data {
394 struct vfs_fsp_data *next;
395 struct vfs_handle_struct *owner;
396 /* NOTE: This structure contains two pointers so that we can guarantee
397 * that the end of the structure is always both 4-byte and 8-byte aligned.
401 /* the basic packet size, assuming no words or bytes */
404 struct notify_change {
409 struct notify_mid_map;
412 struct notify_change_request;
413 struct sys_notify_backend;
414 struct sys_notify_context {
415 struct event_context *ev;
416 struct connection_struct *conn;
417 void *private_data; /* For use by the system backend */
420 struct notify_change_buf {
422 * If no requests are pending, changes are queued here. Simple array,
427 * num_changes == -1 means that we have got a catch-all change, when
428 * asked we just return NT_STATUS_OK without specific changes.
431 struct notify_change *changes;
434 * If no changes are around requests are queued here. Using a linked
435 * list, because we have to append at the end and delete from the top.
437 struct notify_change_request *requests;
440 typedef struct files_struct {
441 struct files_struct *next, *prev;
443 struct connection_struct *conn;
444 struct fd_handle *fh;
445 unsigned int num_smb_operations;
446 uint16 rap_print_jobid;
447 struct file_id file_id;
448 SMB_BIG_UINT initial_allocation_size; /* Faked up initial allocation on disk. */
453 struct timeval open_time;
454 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
455 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
457 bool update_write_time_triggered;
458 struct timed_event *update_write_time_event;
459 bool update_write_time_on_close;
460 struct timespec close_write_time;
461 bool write_time_forced;
464 int sent_oplock_break;
465 struct timed_event *oplock_timeout;
466 struct lock_struct last_lock_failure;
467 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
469 struct share_mode_entry *pending_break_messages;
470 int num_pending_break_messages;
478 bool aio_write_behind;
480 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
484 struct vfs_fsp_data *vfs_extension;
485 struct fake_file_handle *fake_file_handle;
487 struct notify_change_buf *notify;
489 struct files_struct *base_fsp; /* placeholder for delete on close */
492 #include "ntquotas.h"
493 #include "sysquotas.h"
495 struct vuid_cache_entry {
496 struct auth_serversupplied_info *server_info;
503 unsigned int next_entry;
504 struct vuid_cache_entry array[VUID_CACHE_SIZE];
510 } name_compare_entry;
513 struct trans_state *next, *prev;
517 uint32 max_param_return;
518 uint32 max_data_return;
519 uint32 max_setup_return;
521 uint8 cmd; /* SMBtrans or SMBtrans2 */
523 char *name; /* for trans requests */
524 uint16 call; /* for trans2 and nttrans requests */
526 bool close_on_completion;
529 unsigned int setup_count;
532 size_t received_data;
533 size_t received_param;
543 * Info about an alternate data stream
546 struct stream_struct {
548 SMB_OFF_T alloc_size;
552 /* Include VFS stuff */
554 #include "smb_acls.h"
557 struct dfree_cached_info {
558 time_t last_dfree_time;
559 SMB_BIG_UINT dfree_ret;
567 struct share_params {
571 struct share_iterator {
575 typedef struct connection_struct {
576 struct connection_struct *next, *prev;
577 unsigned cnum; /* an index passed over the wire */
578 struct share_params *params;
580 struct vuid_cache vuid_cache;
581 struct dptr_struct *dirptr;
584 bool read_only; /* Attributes for the current user of the share. */
585 bool admin_user; /* Attributes for the current user of the share. */
590 struct vfs_ops vfs; /* Filesystem operations */
591 struct vfs_ops vfs_opaque; /* OPAQUE Filesystem operations */
592 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
595 * This represents the user information on this connection. Depending
596 * on the vuid using this tid, this might change per SMB request.
598 struct auth_serversupplied_info *server_info;
600 char client_address[INET6_ADDRSTRLEN]; /* String version of client IP address. */
602 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
605 time_t lastused_count;
608 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
612 /* Semantics requested by the client or forced by the server config. */
615 bool short_case_preserve;
617 /* Semantics provided by the underlying filesystem. */
620 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
621 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
622 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
623 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
624 struct dfree_cached_info *dfree_info;
625 struct trans_state *pending_trans;
626 struct notify_context *notify_ctx;
629 struct current_user {
630 connection_struct *conn;
633 NT_USER_TOKEN *nt_user_token;
647 connection_struct *conn;
650 /* Defines for the sent_oplock_break field above. */
651 #define NO_BREAK_SENT 0
652 #define BREAK_TO_NONE_SENT 1
653 #define LEVEL_II_BREAK_SENT 2
656 fstring smb_name; /* user name from the client */
657 fstring unix_name; /* unix user name of a validated user */
658 fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
659 fstring domain; /* domain that the client specified */
662 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
664 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
665 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
667 typedef struct _print_queue_struct {
668 int job; /* normally the UNIX jobid -- see note in
669 printing.c:traverse_fn_delete() */
677 } print_queue_struct;
679 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
685 } print_status_struct;
687 /* used for server information: client, nameserv and ipc */
688 struct server_info_struct {
692 fstring domain; /* used ONLY in ipc.c NOT namework.c */
693 bool server_added; /* used ONLY in ipc.c NOT namework.c */
696 /* used for network interfaces */
698 struct interface *next, *prev;
701 struct sockaddr_storage ip;
702 struct sockaddr_storage netmask;
703 struct sockaddr_storage bcast;
706 /* Internal message queue for deferred opens. */
707 struct pending_message_list {
708 struct pending_message_list *next, *prev;
709 struct timeval request_time; /* When was this first issued? */
710 struct timeval end_time; /* When does this time out? */
713 DATA_BLOB private_data;
716 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
718 /* struct returned by get_share_modes */
719 struct share_mode_entry {
720 struct server_id pid;
723 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
724 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
725 uint32 private_options; /* NT Create options, but we only look at
726 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
727 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
728 * smbstatus and swat */
731 unsigned long share_file_id;
732 uint32 uid; /* uid of file opener. */
733 uint16 flags; /* See SHARE_MODE_XX above. */
736 /* oplock break message definition - linearization of share_mode_entry.
739 0 struct server_id pid 4
742 8 uint32 access_mask 4
743 12 uint32 share_access 4
744 16 uint32 private_options 4
746 24 uint32 time usec 4
747 28 SMB_DEV_T dev 8 bytes.
748 36 SMB_INO_T inode 8 bytes
749 44 unsigned long file_id 4 bytes
750 48 uint32 uid 4 bytes
751 52 uint16 flags 2 bytes
755 #ifdef CLUSTER_SUPPORT
756 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 58
758 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 54
761 struct share_mode_lock {
762 const char *servicepath; /* canonicalized. */
763 const char *filename;
766 struct share_mode_entry *share_modes;
767 UNIX_USER_TOKEN *delete_token;
768 bool delete_on_close;
769 struct timespec old_write_time;
770 struct timespec changed_write_time;
773 struct db_record *record;
777 * Internal structure of locking.tdb share mode db.
778 * Used by locking.c and libsmbsharemodes.c
781 struct locking_data {
784 int num_share_mode_entries;
785 bool delete_on_close;
786 struct timespec old_write_time;
787 struct timespec changed_write_time;
788 uint32 delete_token_size; /* Only valid if either of
789 the two previous fields
792 struct share_mode_entry dummy; /* Needed for alignment. */
794 /* The following four entries are implicit
795 struct share_mode_entry modes[num_share_mode_entries];
796 char unix_token[delete_token_size] (divisible by 4).
802 /* Used to store pipe open records for NetFileEnum() */
804 struct pipe_open_rec {
805 struct server_id pid;
812 #define NT_HASH_LEN 16
813 #define LM_HASH_LEN 16
815 /* Password history contants. */
816 #define PW_HISTORY_SALT_LEN 16
817 #define SALTED_MD5_HASH_LEN 16
818 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
819 #define MAX_PW_HISTORY_LEN 24
822 * Flags for account policy.
824 #define AP_MIN_PASSWORD_LEN 1
825 #define AP_PASSWORD_HISTORY 2
826 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
827 #define AP_MAX_PASSWORD_AGE 4
828 #define AP_MIN_PASSWORD_AGE 5
829 #define AP_LOCK_ACCOUNT_DURATION 6
830 #define AP_RESET_COUNT_TIME 7
831 #define AP_BAD_ATTEMPT_LOCKOUT 8
832 #define AP_TIME_TO_LOGOUT 9
833 #define AP_REFUSE_MACHINE_PW_CHANGE 10
836 * Flags for local user manipulation.
839 #define LOCAL_ADD_USER 0x1
840 #define LOCAL_DELETE_USER 0x2
841 #define LOCAL_DISABLE_USER 0x4
842 #define LOCAL_ENABLE_USER 0x8
843 #define LOCAL_TRUST_ACCOUNT 0x10
844 #define LOCAL_SET_NO_PASSWORD 0x20
845 #define LOCAL_SET_PASSWORD 0x40
846 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
847 #define LOCAL_INTERDOM_ACCOUNT 0x100
848 #define LOCAL_AM_ROOT 0x200 /* Act as root */
850 /* key and data in the connections database - used in smbstatus and smbd */
851 struct connections_key {
852 struct server_id pid;
857 struct connections_data {
859 struct server_id pid;
863 char servicename[FSTRING_LEN];
865 char machine[FSTRING_LEN];
867 uint32 bcast_msg_flags;
871 /* the following are used by loadparm for option lists */
873 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
874 P_STRING,P_USTRING,P_ENUM,P_SEP
878 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
891 bool (*special)(int snum, const char *, char **);
892 const struct enum_list *enum_list;
903 /* The following flags are used in SWAT */
904 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
905 #define FLAG_SHARE 0x0002 /* file sharing options */
906 #define FLAG_PRINT 0x0004 /* printing options */
907 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
908 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
909 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
910 #define FLAG_DEVELOPER 0x0040 /* No longer used */
911 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
912 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
913 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
920 /* offsets into message for common items */
927 #define smb_pidhigh 16
928 #define smb_ss_field 18
954 /* flag defines. CIFS spec 3.1.1 */
955 #define FLAG_SUPPORT_LOCKREAD 0x01
956 #define FLAG_CLIENT_BUF_AVAIL 0x02
957 #define FLAG_RESERVED 0x04
958 #define FLAG_CASELESS_PATHNAMES 0x08
959 #define FLAG_CANONICAL_PATHNAMES 0x10
960 #define FLAG_REQUEST_OPLOCK 0x20
961 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
962 #define FLAG_REPLY 0x80
965 #define SMBmkdir 0x00 /* create directory */
966 #define SMBrmdir 0x01 /* delete directory */
967 #define SMBopen 0x02 /* open file */
968 #define SMBcreate 0x03 /* create file */
969 #define SMBclose 0x04 /* close file */
970 #define SMBflush 0x05 /* flush file */
971 #define SMBunlink 0x06 /* delete file */
972 #define SMBmv 0x07 /* rename file */
973 #define SMBgetatr 0x08 /* get file attributes */
974 #define SMBsetatr 0x09 /* set file attributes */
975 #define SMBread 0x0A /* read from file */
976 #define SMBwrite 0x0B /* write to file */
977 #define SMBlock 0x0C /* lock byte range */
978 #define SMBunlock 0x0D /* unlock byte range */
979 #define SMBctemp 0x0E /* create temporary file */
980 #define SMBmknew 0x0F /* make new file */
981 #define SMBcheckpath 0x10 /* check directory path */
982 #define SMBexit 0x11 /* process exit */
983 #define SMBlseek 0x12 /* seek */
984 #define SMBtcon 0x70 /* tree connect */
985 #define SMBtconX 0x75 /* tree connect and X*/
986 #define SMBtdis 0x71 /* tree disconnect */
987 #define SMBnegprot 0x72 /* negotiate protocol */
988 #define SMBdskattr 0x80 /* get disk attributes */
989 #define SMBsearch 0x81 /* search directory */
990 #define SMBsplopen 0xC0 /* open print spool file */
991 #define SMBsplwr 0xC1 /* write to print spool file */
992 #define SMBsplclose 0xC2 /* close print spool file */
993 #define SMBsplretq 0xC3 /* return print queue */
994 #define SMBsends 0xD0 /* send single block message */
995 #define SMBsendb 0xD1 /* send broadcast message */
996 #define SMBfwdname 0xD2 /* forward user name */
997 #define SMBcancelf 0xD3 /* cancel forward */
998 #define SMBgetmac 0xD4 /* get machine name */
999 #define SMBsendstrt 0xD5 /* send start of multi-block message */
1000 #define SMBsendend 0xD6 /* send end of multi-block message */
1001 #define SMBsendtxt 0xD7 /* send text of multi-block message */
1003 /* Core+ protocol */
1004 #define SMBlockread 0x13 /* Lock a range and read */
1005 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1006 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
1007 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
1008 #define SMBwritec 0x20 /* secondary write request */
1009 #define SMBwriteclose 0x2c /* write a file then close it */
1011 /* dos extended protocol */
1012 #define SMBreadBraw 0x1A /* read block raw */
1013 #define SMBreadBmpx 0x1B /* read block multiplexed */
1014 #define SMBreadBs 0x1C /* read block (secondary response) */
1015 #define SMBwriteBraw 0x1D /* write block raw */
1016 #define SMBwriteBmpx 0x1E /* write block multiplexed */
1017 #define SMBwriteBs 0x1F /* write block (secondary request) */
1018 #define SMBwriteC 0x20 /* write complete response */
1019 #define SMBsetattrE 0x22 /* set file attributes expanded */
1020 #define SMBgetattrE 0x23 /* get file attributes expanded */
1021 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
1022 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
1023 #define SMBtranss 0x26 /* transaction (secondary request/response) */
1024 #define SMBioctl 0x27 /* IOCTL */
1025 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
1026 #define SMBcopy 0x29 /* copy */
1027 #define SMBmove 0x2A /* move */
1028 #define SMBecho 0x2B /* echo */
1029 #define SMBopenX 0x2D /* open and X */
1030 #define SMBreadX 0x2E /* read and X */
1031 #define SMBwriteX 0x2F /* write and X */
1032 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
1033 #define SMBffirst 0x82 /* find first */
1034 #define SMBfunique 0x83 /* find unique */
1035 #define SMBfclose 0x84 /* find close */
1036 #define SMBkeepalive 0x85 /* keepalive */
1037 #define SMBinvalid 0xFE /* invalid command */
1039 /* Extended 2.0 protocol */
1040 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1041 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1042 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1043 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1044 #define SMBulogoffX 0x74 /* user logoff */
1046 /* NT SMB extensions. */
1047 #define SMBnttrans 0xA0 /* NT transact */
1048 #define SMBnttranss 0xA1 /* NT transact secondary */
1049 #define SMBntcreateX 0xA2 /* NT create and X */
1050 #define SMBntcancel 0xA4 /* NT cancel */
1051 #define SMBntrename 0xA5 /* NT rename */
1053 /* These are the trans subcommands */
1054 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
1055 #define TRANSACT_DCERPCCMD 0x26
1056 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1058 /* These are the TRANS2 sub commands */
1059 #define TRANSACT2_OPEN 0x00
1060 #define TRANSACT2_FINDFIRST 0x01
1061 #define TRANSACT2_FINDNEXT 0x02
1062 #define TRANSACT2_QFSINFO 0x03
1063 #define TRANSACT2_SETFSINFO 0x04
1064 #define TRANSACT2_QPATHINFO 0x05
1065 #define TRANSACT2_SETPATHINFO 0x06
1066 #define TRANSACT2_QFILEINFO 0x07
1067 #define TRANSACT2_SETFILEINFO 0x08
1068 #define TRANSACT2_FSCTL 0x09
1069 #define TRANSACT2_IOCTL 0x0A
1070 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1071 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1072 #define TRANSACT2_MKDIR 0x0D
1073 #define TRANSACT2_SESSION_SETUP 0x0E
1074 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1075 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1077 /* These are the NT transact sub commands. */
1078 #define NT_TRANSACT_CREATE 1
1079 #define NT_TRANSACT_IOCTL 2
1080 #define NT_TRANSACT_SET_SECURITY_DESC 3
1081 #define NT_TRANSACT_NOTIFY_CHANGE 4
1082 #define NT_TRANSACT_RENAME 5
1083 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1084 #define NT_TRANSACT_GET_USER_QUOTA 7
1085 #define NT_TRANSACT_SET_USER_QUOTA 8
1087 /* These are the NT transact_get_user_quota sub commands */
1088 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1089 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1090 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1092 /* Relevant IOCTL codes */
1093 #define IOCTL_QUERY_JOB_INFO 0x530060
1095 /* these are the trans2 sub fields for primary requests */
1096 #define smb_tpscnt smb_vwv0
1097 #define smb_tdscnt smb_vwv1
1098 #define smb_mprcnt smb_vwv2
1099 #define smb_mdrcnt smb_vwv3
1100 #define smb_msrcnt smb_vwv4
1101 #define smb_flags smb_vwv5
1102 #define smb_timeout smb_vwv6
1103 #define smb_pscnt smb_vwv9
1104 #define smb_psoff smb_vwv10
1105 #define smb_dscnt smb_vwv11
1106 #define smb_dsoff smb_vwv12
1107 #define smb_suwcnt smb_vwv13
1108 #define smb_setup smb_vwv14
1109 #define smb_setup0 smb_setup
1110 #define smb_setup1 (smb_setup+2)
1111 #define smb_setup2 (smb_setup+4)
1113 /* these are for the secondary requests */
1114 #define smb_spscnt smb_vwv2
1115 #define smb_spsoff smb_vwv3
1116 #define smb_spsdisp smb_vwv4
1117 #define smb_sdscnt smb_vwv5
1118 #define smb_sdsoff smb_vwv6
1119 #define smb_sdsdisp smb_vwv7
1120 #define smb_sfid smb_vwv8
1122 /* and these for responses */
1123 #define smb_tprcnt smb_vwv0
1124 #define smb_tdrcnt smb_vwv1
1125 #define smb_prcnt smb_vwv3
1126 #define smb_proff smb_vwv4
1127 #define smb_prdisp smb_vwv5
1128 #define smb_drcnt smb_vwv6
1129 #define smb_droff smb_vwv7
1130 #define smb_drdisp smb_vwv8
1132 /* these are for the NT trans primary request. */
1133 #define smb_nt_MaxSetupCount smb_vwv0
1134 #define smb_nt_Flags (smb_vwv0 + 1)
1135 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1136 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1137 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1138 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1139 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1140 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1141 #define smb_nt_DataCount (smb_vwv0 + 27)
1142 #define smb_nt_DataOffset (smb_vwv0 + 31)
1143 #define smb_nt_SetupCount (smb_vwv0 + 35)
1144 #define smb_nt_Function (smb_vwv0 + 36)
1145 #define smb_nt_SetupStart (smb_vwv0 + 38)
1147 /* these are for the NT trans secondary request. */
1148 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1149 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1150 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1151 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1152 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1153 #define smb_nts_DataCount (smb_vwv0 + 23)
1154 #define smb_nts_DataOffset (smb_vwv0 + 27)
1155 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1157 /* these are for the NT trans reply. */
1158 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1159 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1160 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1161 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1162 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1163 #define smb_ntr_DataCount (smb_vwv0 + 23)
1164 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1165 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1167 /* these are for the NT create_and_X */
1168 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1169 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1170 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1171 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1172 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1173 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1174 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1175 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1176 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1177 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1178 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1180 /* this is used on a TConX. I'm not sure the name is very helpful though */
1181 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1182 #define SMB_SHARE_IN_DFS 0x0002
1184 /* Named pipe write mode flags. Used in writeX calls. */
1185 #define PIPE_RAW_MODE 0x4
1186 #define PIPE_START_MESSAGE 0x8
1188 /* File Specific access rights */
1189 #define FILE_READ_DATA 0x00000001
1190 #define FILE_WRITE_DATA 0x00000002
1191 #define FILE_APPEND_DATA 0x00000004
1192 #define FILE_READ_EA 0x00000008 /* File and directory */
1193 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1194 #define FILE_EXECUTE 0x00000020
1195 #define FILE_DELETE_CHILD 0x00000040
1196 #define FILE_READ_ATTRIBUTES 0x00000080
1197 #define FILE_WRITE_ATTRIBUTES 0x00000100
1199 #define FILE_ALL_ACCESS 0x000001FF
1201 /* Directory specific access rights */
1202 #define FILE_LIST_DIRECTORY 0x00000001
1203 #define FILE_ADD_FILE 0x00000002
1204 #define FILE_ADD_SUBDIRECTORY 0x00000004
1205 #define FILE_TRAVERSE 0x00000020
1206 #define FILE_DELETE_CHILD 0x00000040
1208 /* the desired access to use when opening a pipe */
1209 #define DESIRED_ACCESS_PIPE 0x2019f
1211 /* Generic access masks & rights. */
1212 #define DELETE_ACCESS 0x00010000 /* (1L<<16) */
1213 #define READ_CONTROL_ACCESS 0x00020000 /* (1L<<17) */
1214 #define WRITE_DAC_ACCESS 0x00040000 /* (1L<<18) */
1215 #define WRITE_OWNER_ACCESS 0x00080000 /* (1L<<19) */
1216 #define SYNCHRONIZE_ACCESS 0x00100000 /* (1L<<20) */
1218 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1219 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1220 #define GENERIC_ALL_ACCESS 0x10000000 /* (1<<28) */
1221 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1222 #define GENERIC_WRITE_ACCESS 0x40000000 /* (1<<30) */
1223 #define GENERIC_READ_ACCESS ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1225 /* Mapping of generic access rights for files to specific rights. */
1227 /* This maps to 0x1F01FF */
1228 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1230 /* This maps to 0x120089 */
1231 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1232 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1234 /* This maps to 0x120116 */
1235 #define FILE_GENERIC_WRITE (STD_RIGHT_READ_CONTROL_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1236 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1238 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
1239 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1241 /* Share specific rights. */
1242 #define SHARE_ALL_ACCESS FILE_GENERIC_ALL
1243 #define SHARE_READ_ONLY (FILE_GENERIC_READ|FILE_EXECUTE)
1245 /* Mapping of access rights to UNIX perms. */
1246 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1247 #define UNIX_ACCESS_R FILE_GENERIC_READ
1248 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1249 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1251 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1252 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1253 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1254 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1255 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1259 * This is the old mapping we used to use. To get W2KSP2 profiles
1260 * working we need to map to the canonical file perms.
1262 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1263 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1264 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1265 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1266 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1267 FILE_APPEND_DATA|FILE_WRITE_DATA)
1268 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1269 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1272 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1275 #define REQUEST_OPLOCK 2
1276 #define REQUEST_BATCH_OPLOCK 4
1277 #define OPEN_DIRECTORY 8
1278 #define EXTENDED_RESPONSE_REQUIRED 0x10
1280 /* ShareAccess field. */
1281 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1282 #define FILE_SHARE_READ 1
1283 #define FILE_SHARE_WRITE 2
1284 #define FILE_SHARE_DELETE 4
1286 /* FileAttributesField */
1287 #define FILE_ATTRIBUTE_READONLY 0x001L
1288 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1289 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1290 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1291 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1292 #define FILE_ATTRIBUTE_NORMAL 0x080L
1293 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1294 #define FILE_ATTRIBUTE_SPARSE 0x200L
1295 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1296 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1297 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1298 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1299 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1300 #define SAMBA_ATTRIBUTES_MASK 0x7F
1302 /* Flags - combined with attributes. */
1303 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1304 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1305 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1306 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1307 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1308 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1309 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1311 /* CreateDisposition field. */
1312 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1313 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1314 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1315 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1316 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1317 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1319 /* CreateOptions field. */
1320 #define FILE_DIRECTORY_FILE 0x0001
1321 #define FILE_WRITE_THROUGH 0x0002
1322 #define FILE_SEQUENTIAL_ONLY 0x0004
1323 #define FILE_NON_DIRECTORY_FILE 0x0040
1324 #define FILE_NO_EA_KNOWLEDGE 0x0200
1325 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1326 #define FILE_RANDOM_ACCESS 0x0800
1327 #define FILE_DELETE_ON_CLOSE 0x1000
1328 #define FILE_OPEN_BY_FILE_ID 0x2000
1330 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1332 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1335 * Private create options used by the ntcreatex processing code. From Samba4.
1336 * We reuse some ignored flags for private use.
1338 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x00010000
1339 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x00020000
1341 /* Private options for streams support */
1342 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x00040000
1344 /* Responses when opening a file. */
1345 #define FILE_WAS_SUPERSEDED 0
1346 #define FILE_WAS_OPENED 1
1347 #define FILE_WAS_CREATED 2
1348 #define FILE_WAS_OVERWRITTEN 3
1350 /* File type flags */
1351 #define FILE_TYPE_DISK 0
1352 #define FILE_TYPE_BYTE_MODE_PIPE 1
1353 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1354 #define FILE_TYPE_PRINTER 3
1355 #define FILE_TYPE_COMM_DEVICE 4
1356 #define FILE_TYPE_UNKNOWN 0xFFFF
1358 /* Flag for NT transact rename call. */
1359 #define RENAME_REPLACE_IF_EXISTS 1
1361 /* flags for SMBntrename call (from Samba4) */
1362 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1363 #define RENAME_FLAG_HARD_LINK 0x103
1364 #define RENAME_FLAG_RENAME 0x104
1365 #define RENAME_FLAG_COPY 0x105
1367 /* Filesystem Attributes. */
1368 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1369 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1370 #define FILE_UNICODE_ON_DISK 0x00000004
1371 /* According to cifs9f, this is 4, not 8 */
1372 /* Acconding to testing, this actually sets the security attribute! */
1373 #define FILE_PERSISTENT_ACLS 0x00000008
1374 #define FILE_FILE_COMPRESSION 0x00000010
1375 #define FILE_VOLUME_QUOTAS 0x00000020
1376 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1377 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1378 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1379 #define FS_LFN_APIS 0x00004000
1380 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1381 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1382 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1383 #define FILE_NAMED_STREAMS 0x00040000
1384 #define FILE_READ_ONLY_VOLUME 0x00080000
1386 /* ChangeNotify flags. */
1387 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1388 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1389 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1390 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1391 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1392 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1393 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1394 #define FILE_NOTIFY_CHANGE_EA 0x080
1395 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1396 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1397 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1398 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1400 #define FILE_NOTIFY_CHANGE_NAME \
1401 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1403 /* change notify action results */
1404 #define NOTIFY_ACTION_ADDED 1
1405 #define NOTIFY_ACTION_REMOVED 2
1406 #define NOTIFY_ACTION_MODIFIED 3
1407 #define NOTIFY_ACTION_OLD_NAME 4
1408 #define NOTIFY_ACTION_NEW_NAME 5
1409 #define NOTIFY_ACTION_ADDED_STREAM 6
1410 #define NOTIFY_ACTION_REMOVED_STREAM 7
1411 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1414 /* where to find the base of the SMB packet proper */
1415 #define smb_base(buf) (((char *)(buf))+4)
1417 /* we don't allow server strings to be longer than 48 characters as
1418 otherwise NT will not honour the announce packets */
1419 #define MAX_SERVER_STRING_LENGTH 48
1422 #define SMB_SUCCESS 0 /* The request was successful. */
1425 void dfs_unlogin(void);
1426 extern int dcelogin_atmost_once;
1430 char *strdup(char *s);
1434 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1441 /* This was set by JHT in liaison with Jeremy Allison early 1997
1443 * Version 4.0 - never made public
1444 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1445 * - Reappeared in 1.9.16p11 with fixed smbd services
1446 * Version 4.20 - To indicate that nmbd and browsing now works better
1447 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1449 * Note: In the presence of NT4.X do not set above 4.9
1450 * Setting this above 4.9 can have undesired side-effects.
1451 * This may change again in Samba-3.0 after further testing. JHT
1454 #define DEFAULT_MAJOR_VERSION 0x04
1455 #define DEFAULT_MINOR_VERSION 0x09
1457 /* Browser Election Values */
1458 #define BROWSER_ELECTION_VERSION 0x010f
1459 #define BROWSER_CONSTANT 0xaa55
1461 /* Sercurity mode bits. */
1462 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1463 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1464 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1465 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1467 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1469 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1470 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1471 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1472 #define FLAGS2_UNKNOWN_BIT4 0x0010
1473 #define FLAGS2_IS_LONG_NAME 0x0040
1474 #define FLAGS2_EXTENDED_SECURITY 0x0800
1475 #define FLAGS2_DFS_PATHNAMES 0x1000
1476 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1477 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1478 #define FLAGS2_UNICODE_STRINGS 0x8000
1480 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1482 /* TCONX Flag (smb_vwv2). */
1483 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1485 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1487 #define CAP_RAW_MODE 0x0001
1488 #define CAP_MPX_MODE 0x0002
1489 #define CAP_UNICODE 0x0004
1490 #define CAP_LARGE_FILES 0x0008
1491 #define CAP_NT_SMBS 0x0010
1492 #define CAP_RPC_REMOTE_APIS 0x0020
1493 #define CAP_STATUS32 0x0040
1494 #define CAP_LEVEL_II_OPLOCKS 0x0080
1495 #define CAP_LOCK_AND_READ 0x0100
1496 #define CAP_NT_FIND 0x0200
1497 #define CAP_DFS 0x1000
1498 #define CAP_W2K_SMBS 0x2000
1499 #define CAP_LARGE_READX 0x4000
1500 #define CAP_LARGE_WRITEX 0x8000
1501 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1502 #define CAP_EXTENDED_SECURITY 0x80000000
1504 /* protocol types. It assumes that higher protocols include lower protocols
1506 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1508 /* security levels */
1509 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1519 /* printing types */
1520 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1521 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1522 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1523 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1524 ,PRINT_TEST,PRINT_VLP
1525 #endif /* DEVELOPER */
1528 /* LDAP schema types */
1529 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1531 /* LDAP SSL options */
1532 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1534 /* LDAP PASSWD SYNC methods */
1535 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1537 /* Remote architectures we know about. */
1538 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1539 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1540 RA_SAMBA, RA_CIFSFS, RA_WINXP64};
1543 enum case_handling {CASE_LOWER,CASE_UPPER};
1545 /* ACL compatibility */
1546 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1548 * Global value meaing that the smb_uid field should be
1549 * ingored (in share level security and protocol level == CORE)
1552 #define UID_FIELD_INVALID 0
1553 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1556 * Size of buffer to use when moving files across filesystems.
1558 #define COPYBUF_SIZE (8*1024)
1561 * Used in chaining code.
1563 extern int chain_size;
1566 * Map the Core and Extended Oplock requesst bits down
1567 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1573 #define CORE_OPLOCK_REQUEST(inbuf) \
1574 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1577 * Extended protocol.
1579 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1582 #define LOCKING_ANDX_SHARED_LOCK 0x1
1583 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1584 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1585 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1586 #define LOCKING_ANDX_LARGE_FILES 0x10
1589 * Bits we test with.
1590 * Note these must fit into 16-bits.
1593 #define NO_OPLOCK 0x0
1594 #define EXCLUSIVE_OPLOCK 0x1
1595 #define BATCH_OPLOCK 0x2
1596 #define LEVEL_II_OPLOCK 0x4
1598 /* The following are Samba-private. */
1599 #define INTERNAL_OPEN_ONLY 0x8
1600 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1601 * inform potential level2 holders on
1603 #define DEFERRED_OPEN_ENTRY 0x20
1604 #define UNUSED_SHARE_MODE_ENTRY 0x40
1605 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1607 /* None of the following should ever appear in fsp->oplock_request. */
1608 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1610 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1611 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1612 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1614 struct inform_level2_message {
1618 unsigned long target_file_id;
1619 unsigned long source_file_id;
1622 /* kernel_oplock_message definition.
1624 struct kernel_oplock_message {
1627 unsigned long file_id;
1631 0 SMB_DEV_T dev 8 bytes.
1632 8 SMB_INO_T inode 8 bytes
1633 16 unsigned long file_id 4 bytes
1637 #define MSG_SMB_KERNEL_BREAK_SIZE 20
1639 /* file_renamed_message definition.
1641 struct file_renamed_message {
1644 char names[1]; A variable area containing sharepath and filename.
1648 0 SMB_DEV_T dev 8 bytes.
1649 8 SMB_INO_T inode 8 bytes
1650 16 char [] name zero terminated namelen bytes
1651 minimum length == 18.
1655 #define MSG_FILE_RENAMED_MIN_SIZE 16
1658 * On the wire return values for oplock types.
1661 #define CORE_OPLOCK_GRANTED (1<<5)
1662 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1664 #define NO_OPLOCK_RETURN 0
1665 #define EXCLUSIVE_OPLOCK_RETURN 1
1666 #define BATCH_OPLOCK_RETURN 2
1667 #define LEVEL_II_OPLOCK_RETURN 3
1670 #define OPLOCKLEVEL_NONE 0
1671 #define OPLOCKLEVEL_II 1
1674 * Capabilities abstracted for different systems.
1677 enum smbd_capability {
1678 KERNEL_OPLOCK_CAPABILITY,
1679 DMAPI_ACCESS_CAPABILITY,
1683 /* if a kernel does support oplocks then a structure of the following
1684 typee is used to describe how to interact with the kernel */
1685 struct kernel_oplocks {
1686 files_struct * (*receive_message)(fd_set *fds);
1687 bool (*set_oplock)(files_struct *fsp, int oplock_type);
1688 void (*release_oplock)(files_struct *fsp);
1689 bool (*msg_waiting)(fd_set *fds);
1690 int notification_fd;
1693 #include "smb_macros.h"
1695 #define MAX_NETBIOSNAME_LEN 16
1696 /* DOS character, NetBIOS namestring. Type used on the wire. */
1697 typedef char nstring[MAX_NETBIOSNAME_LEN];
1698 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1699 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1701 /* A netbios name structure. */
1705 unsigned int name_type;
1708 /* A netbios node status array element. */
1709 typedef struct node_status_ {
1712 unsigned char flags;
1713 } NODE_STATUS_STRUCT;
1715 /* The extra info from a NetBIOS node status query */
1716 struct node_status_extra {
1717 unsigned char mac_addr[6];
1718 /* There really is more here ... */
1728 /* For split krb5 SPNEGO blobs. */
1729 struct pending_auth_data {
1730 struct pending_auth_data *prev, *next;
1731 uint16 vuid; /* Tag for this entry. */
1732 uint16 smbpid; /* Alternate tag for this entry. */
1734 DATA_BLOB partial_data;
1737 typedef struct user_struct {
1738 struct user_struct *next, *prev;
1739 uint16 vuid; /* Tag for this entry. */
1741 char *session_keystr; /* used by utmp and pam session code.
1745 struct auth_serversupplied_info *server_info;
1747 struct auth_ntlmssp_state *auth_ntlmssp_state;
1750 struct unix_error_map {
1758 * Size of new password account encoding string. This is enough space to
1759 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1760 * Do not change unless you are adding new ACB bits!
1763 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1766 Do you want session setups at user level security with a invalid
1767 password to be rejected or allowed in as guest? WinNT rejects them
1768 but it can be a pain as it means "net view" needs to use a password
1770 You have 3 choices in the setting of map_to_guest:
1772 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1773 are rejected. This is the default.
1775 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1776 are rejected, unless the username does not exist, in which case it
1777 is treated as a guest login
1779 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1780 are treated as a guest login
1782 Note that map_to_guest only has an effect in user or server
1786 #define NEVER_MAP_TO_GUEST 0
1787 #define MAP_TO_GUEST_ON_BAD_USER 1
1788 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1789 #define MAP_TO_GUEST_ON_BAD_UID 3
1791 #define SAFE_NETBIOS_CHARS ". -_"
1793 /* generic iconv conversion structure */
1794 typedef struct _smb_iconv_t {
1795 size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
1796 char **outbuf, size_t *outbytesleft);
1797 size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
1798 char **outbuf, size_t *outbytesleft);
1799 size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
1800 char **outbuf, size_t *outbytesleft);
1801 void *cd_direct, *cd_pull, *cd_push;
1802 char *from_name, *to_name;
1805 /* The maximum length of a trust account password.
1806 Used when we randomly create it, 15 char passwords
1807 exceed NT4's max password length */
1809 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1811 #include "popt_common.h"
1815 #define LDAP_PORT 389
1817 #define LDAP_GC_PORT 3268
1819 /* used by the IP comparison function */
1821 struct sockaddr_storage ss;
1825 /* Special name type used to cause a _kerberos DNS lookup. */
1826 #define KDC_NAME_TYPE 0xDCDC
1828 /* Used by the SMB signing functions. */
1830 typedef struct smb_sign_info {
1831 void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1832 bool (*check_incoming_message)(const char *inbuf, struct smb_sign_info *si, bool must_be_ok);
1833 void (*free_signing_context)(struct smb_sign_info *si);
1834 void *signing_context;
1836 bool negotiated_smb_signing;
1837 bool allow_smb_signing;
1839 bool mandatory_signing;
1840 bool seen_valid; /* Have I ever seen a validly signed packet? */
1850 struct ea_list *next, *prev;
1851 struct ea_struct ea;
1854 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1855 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1856 /* EA to use for DOS attributes */
1857 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1858 /* Prefix for DosStreams in the vfs_streams_xattr module */
1859 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1861 #define UUID_SIZE 16
1863 #define UUID_FLAT_SIZE 16
1864 typedef struct uuid_flat {
1865 uint8 info[UUID_FLAT_SIZE];
1868 /* map readonly options */
1869 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1871 /* usershare error codes. */
1872 enum usershare_err {
1874 USERSHARE_MALFORMED_FILE,
1875 USERSHARE_BAD_VERSION,
1876 USERSHARE_MALFORMED_PATH,
1877 USERSHARE_MALFORMED_COMMENT_DEF,
1878 USERSHARE_MALFORMED_ACL_DEF,
1880 USERSHARE_PATH_NOT_ABSOLUTE,
1881 USERSHARE_PATH_IS_DENIED,
1882 USERSHARE_PATH_NOT_ALLOWED,
1883 USERSHARE_PATH_NOT_DIRECTORY,
1887 /* Different reasons for closing a file. */
1888 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1890 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1891 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1892 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1893 struct smb_extended_info {
1894 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1895 uint32 samba_version; /* Major/Minor/Release/Revision */
1896 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1897 NTTIME samba_gitcommitdate;
1898 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];