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-2010"
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
140 #include "../libcli/util/doserr.h"
142 typedef union unid_t {
147 /* pipe string names */
148 #define PIPE_LANMAN "\\PIPE\\LANMAN"
150 #define MAX_HOURS_LEN 32
153 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
156 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
158 #define LOOKUP_NAME_NONE 0x00000000
159 #define LOOKUP_NAME_ISOLATED 0x00000001 /* Look up unqualified names */
160 #define LOOKUP_NAME_REMOTE 0x00000002 /* Ask others */
161 #define LOOKUP_NAME_GROUP 0x00000004 /* (unused) This is a NASTY hack for
162 valid users = @foo where foo also
163 exists in as user. */
164 #define LOOKUP_NAME_NO_NSS 0x00000008 /* no NSS calls to avoid
165 winbind recursions */
166 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
167 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
168 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
169 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
170 |LOOKUP_NAME_BUILTIN\
173 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
175 |LOOKUP_NAME_BUILTIN\
179 #include "librpc/gen_ndr/idmap.h"
180 #include "librpc/gen_ndr/epmapper.h"
181 #include "librpc/gen_ndr/dcerpc.h"
183 struct lsa_dom_info {
191 struct lsa_name_info {
193 enum lsa_SidType type;
198 /* Some well-known SIDs */
199 extern const struct dom_sid global_sid_World_Domain;
200 extern const struct dom_sid global_sid_World;
201 extern const struct dom_sid global_sid_Creator_Owner_Domain;
202 extern const struct dom_sid global_sid_NT_Authority;
203 extern const struct dom_sid global_sid_System;
204 extern const struct dom_sid global_sid_NULL;
205 extern const struct dom_sid global_sid_Authenticated_Users;
206 extern const struct dom_sid global_sid_Network;
207 extern const struct dom_sid global_sid_Creator_Owner;
208 extern const struct dom_sid global_sid_Creator_Group;
209 extern const struct dom_sid global_sid_Anonymous;
210 extern const struct dom_sid global_sid_Builtin;
211 extern const struct dom_sid global_sid_Builtin_Administrators;
212 extern const struct dom_sid global_sid_Builtin_Users;
213 extern const struct dom_sid global_sid_Builtin_Guests;
214 extern const struct dom_sid global_sid_Builtin_Power_Users;
215 extern const struct dom_sid global_sid_Builtin_Account_Operators;
216 extern const struct dom_sid global_sid_Builtin_Server_Operators;
217 extern const struct dom_sid global_sid_Builtin_Print_Operators;
218 extern const struct dom_sid global_sid_Builtin_Backup_Operators;
219 extern const struct dom_sid global_sid_Builtin_Replicator;
220 extern const struct dom_sid global_sid_Builtin_PreWin2kAccess;
221 extern const struct dom_sid global_sid_Unix_Users;
222 extern const struct dom_sid global_sid_Unix_Groups;
225 * The complete list of SIDS belonging to this user.
226 * Created when a vuid is registered.
227 * The definition of the user_sids array is as follows :
229 * token->user_sids[0] = primary user SID.
230 * token->user_sids[1] = primary group SID.
231 * token->user_sids[2..num_sids] = supplementary group SIDS.
234 #define PRIMARY_USER_SID_INDEX 0
235 #define PRIMARY_GROUP_SID_INDEX 1
237 typedef struct nt_user_token {
239 struct dom_sid *user_sids;
243 typedef struct unix_user_token {
250 typedef struct write_cache {
258 #include "fake_file.h"
263 uint64_t position_information;
265 uint32 private_options; /* NT Create options, but we only look at
266 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
267 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
268 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
269 * for print files *only*, where
270 * DELETE_ON_CLOSE is not stored in the share
273 unsigned long gen_id;
277 struct share_mode_entry;
281 struct rpc_cli_smbd_conn;
282 struct fncall_context;
284 struct vfs_fsp_data {
285 struct vfs_fsp_data *next;
286 struct vfs_handle_struct *owner;
287 void (*destroy)(void *p_data);
289 /* NOTE: This structure contains four pointers so that we can guarantee
290 * that the end of the structure is always both 4-byte and 8-byte aligned.
294 /* the basic packet size, assuming no words or bytes */
297 struct notify_change {
302 struct notify_mid_map;
305 struct notify_change_request;
306 struct sys_notify_backend;
307 struct sys_notify_context {
308 struct event_context *ev;
309 struct connection_struct *conn;
310 void *private_data; /* For use by the system backend */
313 struct notify_change_buf {
315 * If no requests are pending, changes are queued here. Simple array,
320 * num_changes == -1 means that we have got a catch-all change, when
321 * asked we just return NT_STATUS_OK without specific changes.
324 struct notify_change *changes;
327 * If no changes are around requests are queued here. Using a linked
328 * list, because we have to append at the end and delete from the top.
330 struct notify_change_request *requests;
333 struct print_file_data {
337 struct policy_handle handle;
342 typedef struct files_struct {
343 struct files_struct *next, *prev;
345 struct connection_struct *conn;
346 struct fd_handle *fh;
347 unsigned int num_smb_operations;
348 struct file_id file_id;
349 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
354 struct timeval open_time;
355 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
356 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
358 bool update_write_time_triggered;
359 struct timed_event *update_write_time_event;
360 bool update_write_time_on_close;
361 struct timespec close_write_time;
362 bool write_time_forced;
365 int sent_oplock_break;
366 struct timed_event *oplock_timeout;
367 struct lock_struct last_lock_failure;
368 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
370 struct share_mode_entry *pending_break_messages;
371 int num_pending_break_messages;
378 bool aio_write_behind;
380 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
381 bool delete_on_close;
383 struct smb_filename *fsp_name;
385 struct vfs_fsp_data *vfs_extension;
386 struct fake_file_handle *fake_file_handle;
388 struct notify_change_buf *notify;
390 struct files_struct *base_fsp; /* placeholder for delete on close */
393 * Read-only cached brlock record, thrown away when the
394 * brlock.tdb seqnum changes. This avoids fetching data from
395 * the brlock.tdb on every read/write call.
398 struct byte_range_lock *brlock_rec;
400 struct dptr_struct *dptr;
402 /* if not NULL, means this is a print file */
403 struct print_file_data *print_file;
407 #include "ntquotas.h"
408 #include "sysquotas.h"
410 struct client_address {
411 char addr[INET6_ADDRSTRLEN];
415 struct vuid_cache_entry {
416 struct auth_serversupplied_info *server_info;
422 unsigned int next_entry;
423 struct vuid_cache_entry array[VUID_CACHE_SIZE];
429 } name_compare_entry;
432 struct trans_state *next, *prev;
436 uint32 max_param_return;
437 uint32 max_data_return;
438 uint32 max_setup_return;
440 uint8 cmd; /* SMBtrans or SMBtrans2 */
442 char *name; /* for trans requests */
443 uint16 call; /* for trans2 and nttrans requests */
445 bool close_on_completion;
448 unsigned int setup_count;
451 size_t received_data;
452 size_t received_param;
462 * Info about an alternate data stream
465 struct stream_struct {
467 SMB_OFF_T alloc_size;
471 /* Include VFS stuff */
473 #include "smb_acls.h"
476 struct dfree_cached_info {
477 time_t last_dfree_time;
486 struct share_params {
490 struct share_iterator {
494 typedef struct connection_struct {
495 struct connection_struct *next, *prev;
496 struct smbd_server_connection *sconn; /* can be NULL */
497 unsigned cnum; /* an index passed over the wire */
498 struct share_params *params;
500 struct vuid_cache vuid_cache;
503 bool read_only; /* Attributes for the current user of the share. */
504 /* Does this filesystem honor
505 sub second timestamps on files
506 and directories when setting time ? */
507 enum timestamp_set_resolution ts_res;
511 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
514 * This represents the user information on this connection. Depending
515 * on the vuid using this tid, this might change per SMB request.
517 struct auth_serversupplied_info *server_info;
520 * If the "force group" parameter is set, this is the primary gid that
521 * may be used in the users token, depending on the vuid using this tid.
523 gid_t force_group_gid;
525 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
528 time_t lastused_count;
531 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
535 /* Semantics requested by the client or forced by the server config. */
538 bool short_case_preserve;
540 /* Semantics provided by the underlying filesystem. */
542 /* Device number of the directory of the share mount.
543 Used to ensure unique FileIndex returns. */
544 SMB_DEV_T base_share_dev;
546 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
547 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
548 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
549 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
550 struct dfree_cached_info *dfree_info;
551 struct trans_state *pending_trans;
552 struct notify_context *notify_ctx;
554 struct rpc_pipe_client *spoolss_pipe;
558 struct current_user {
559 connection_struct *conn;
562 NT_USER_TOKEN *nt_user_token;
565 struct smbd_smb2_request;
571 uint64_t mid; /* For compatibility with SMB2. */
582 * Async handling in the main smb processing loop is directed by
583 * outbuf: reply_xxx routines indicate sync behaviour by putting their
584 * reply into "outbuf". If they leave it as NULL, they take of it
585 * themselves, possibly later.
587 * If async handling is wanted, the reply_xxx routine must make sure
588 * that it talloc_move()s the smb_req somewhere else.
594 connection_struct *conn;
595 struct smbd_server_connection *sconn;
596 struct smb_perfcount_data pcd;
599 * Chained request handling
601 struct files_struct *chain_fsp;
604 * Here we collect the outbufs from the chain handlers
606 uint8_t *chain_outbuf;
609 * state information for async smb handling
616 * Back pointer to smb2 request.
618 struct smbd_smb2_request *smb2req;
621 /* Defines for the sent_oplock_break field above. */
622 #define NO_BREAK_SENT 0
623 #define BREAK_TO_NONE_SENT 1
624 #define LEVEL_II_BREAK_SENT 2
627 fstring smb_name; /* user name from the client */
628 fstring unix_name; /* unix user name of a validated user */
629 fstring domain; /* domain that the client specified */
632 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
646 LPQ_USER_INTERVENTION,
648 /* smbd is dooing the file spooling before passing control to spoolss */
652 typedef struct _print_queue_struct {
653 int job; /* normally the UNIX jobid -- see note in
654 printing.c:traverse_fn_delete() */
662 } print_queue_struct;
664 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
670 } print_status_struct;
672 /* used for server information: client, nameserv and ipc */
673 struct server_info_struct {
677 fstring domain; /* used ONLY in ipc.c NOT namework.c */
678 bool server_added; /* used ONLY in ipc.c NOT namework.c */
681 /* used for network interfaces */
683 struct interface *next, *prev;
686 struct sockaddr_storage ip;
687 struct sockaddr_storage netmask;
688 struct sockaddr_storage bcast;
691 /* Internal message queue for deferred opens. */
692 struct pending_message_list {
693 struct pending_message_list *next, *prev;
694 struct timeval request_time; /* When was this first issued? */
695 struct timed_event *te;
696 struct smb_perfcount_data pcd;
701 DATA_BLOB private_data;
704 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
706 /* struct returned by get_share_modes */
707 struct share_mode_entry {
708 struct server_id pid;
709 uint64_t op_mid; /* For compatibility with SMB2 opens. */
711 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
712 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
713 uint32 private_options; /* NT Create options, but we only look at
714 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
715 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
716 * smbstatus and swat */
719 unsigned long share_file_id;
720 uint32 uid; /* uid of file opener. */
721 uint16 flags; /* See SHARE_MODE_XX above. */
724 /* oplock break message definition - linearization of share_mode_entry.
727 0 struct server_id pid 4
730 14 uint32 access_mask 4
731 18 uint32 share_access 4
732 22 uint32 private_options 4
734 30 uint32 time usec 4
735 34 uint64 dev 8 bytes
736 42 uint64 inode 8 bytes
737 50 uint64 extid 8 bytes
738 58 unsigned long file_id 4 bytes
739 62 uint32 uid 4 bytes
740 66 uint16 flags 2 bytes
745 #define OP_BREAK_MSG_PID_OFFSET 0
746 #define OP_BREAK_MSG_MID_OFFSET 4
747 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
748 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
749 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
750 #define OP_BREAK_MSG_PRIV_OFFSET 22
751 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
752 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
753 #define OP_BREAK_MSG_DEV_OFFSET 34
754 #define OP_BREAK_MSG_INO_OFFSET 42
755 #define OP_BREAK_MSG_EXTID_OFFSET 50
756 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
757 #define OP_BREAK_MSG_UID_OFFSET 62
758 #define OP_BREAK_MSG_FLAGS_OFFSET 66
760 #ifdef CLUSTER_SUPPORT
761 #define OP_BREAK_MSG_VNN_OFFSET 68
762 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 72
764 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 68
767 struct share_mode_lock {
768 const char *servicepath; /* canonicalized. */
769 const char *base_name;
770 const char *stream_name;
773 struct share_mode_entry *share_modes;
774 UNIX_USER_TOKEN *delete_token;
775 bool delete_on_close;
776 struct timespec old_write_time;
777 struct timespec changed_write_time;
780 struct db_record *record;
784 * Internal structure of locking.tdb share mode db.
785 * Used by locking.c and libsmbsharemodes.c
788 struct locking_data {
791 int num_share_mode_entries;
792 bool delete_on_close;
793 struct timespec old_write_time;
794 struct timespec changed_write_time;
795 uint32 delete_token_size; /* Only valid if either of
796 the two previous fields
799 struct share_mode_entry dummy; /* Needed for alignment. */
801 /* The following four entries are implicit
802 struct share_mode_entry modes[num_share_mode_entries];
803 char unix_token[delete_token_size] (divisible by 4).
809 /* Used to store pipe open records for NetFileEnum() */
811 struct pipe_open_rec {
812 struct server_id pid;
819 #define NT_HASH_LEN 16
820 #define LM_HASH_LEN 16
822 /* Password history contants. */
823 #define PW_HISTORY_SALT_LEN 16
824 #define SALTED_MD5_HASH_LEN 16
825 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
826 #define MAX_PW_HISTORY_LEN 24
829 * Flags for local user manipulation.
832 #define LOCAL_ADD_USER 0x1
833 #define LOCAL_DELETE_USER 0x2
834 #define LOCAL_DISABLE_USER 0x4
835 #define LOCAL_ENABLE_USER 0x8
836 #define LOCAL_TRUST_ACCOUNT 0x10
837 #define LOCAL_SET_NO_PASSWORD 0x20
838 #define LOCAL_SET_PASSWORD 0x40
839 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
840 #define LOCAL_INTERDOM_ACCOUNT 0x100
841 #define LOCAL_AM_ROOT 0x200 /* Act as root */
843 /* key and data in the connections database - used in smbstatus and smbd */
844 struct connections_key {
845 struct server_id pid;
850 struct connections_data {
852 struct server_id pid;
856 char servicename[FSTRING_LEN];
858 char machine[FSTRING_LEN];
862 * This field used to hold the msg_flags. For compatibility reasons,
863 * keep the data structure in the tdb file the same.
865 uint32 unused_compatitibility_field;
869 /* the following are used by loadparm for option lists */
871 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
872 P_STRING,P_USTRING,P_ENUM,P_SEP
876 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
889 bool (*special)(int snum, const char *, char **);
890 const struct enum_list *enum_list;
901 /* The following flags are used in SWAT */
902 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
903 #define FLAG_SHARE 0x0002 /* file sharing options */
904 #define FLAG_PRINT 0x0004 /* printing options */
905 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
906 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
907 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
908 #define FLAG_DEVELOPER 0x0040 /* No longer used */
909 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
910 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
911 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
912 #define FLAG_META 0x8000 /* A meta directive - not a real parameter */
919 /* offsets into message for common items */
926 #define smb_pidhigh 16
927 #define smb_ss_field 18
953 /* flag defines. CIFS spec 3.1.1 */
954 #define FLAG_SUPPORT_LOCKREAD 0x01
955 #define FLAG_CLIENT_BUF_AVAIL 0x02
956 #define FLAG_RESERVED 0x04
957 #define FLAG_CASELESS_PATHNAMES 0x08
958 #define FLAG_CANONICAL_PATHNAMES 0x10
959 #define FLAG_REQUEST_OPLOCK 0x20
960 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
961 #define FLAG_REPLY 0x80
964 #define SMBmkdir 0x00 /* create directory */
965 #define SMBrmdir 0x01 /* delete directory */
966 #define SMBopen 0x02 /* open file */
967 #define SMBcreate 0x03 /* create file */
968 #define SMBclose 0x04 /* close file */
969 #define SMBflush 0x05 /* flush file */
970 #define SMBunlink 0x06 /* delete file */
971 #define SMBmv 0x07 /* rename file */
972 #define SMBgetatr 0x08 /* get file attributes */
973 #define SMBsetatr 0x09 /* set file attributes */
974 #define SMBread 0x0A /* read from file */
975 #define SMBwrite 0x0B /* write to file */
976 #define SMBlock 0x0C /* lock byte range */
977 #define SMBunlock 0x0D /* unlock byte range */
978 #define SMBctemp 0x0E /* create temporary file */
979 #define SMBmknew 0x0F /* make new file */
980 #define SMBcheckpath 0x10 /* check directory path */
981 #define SMBexit 0x11 /* process exit */
982 #define SMBlseek 0x12 /* seek */
983 #define SMBtcon 0x70 /* tree connect */
984 #define SMBtconX 0x75 /* tree connect and X*/
985 #define SMBtdis 0x71 /* tree disconnect */
986 #define SMBnegprot 0x72 /* negotiate protocol */
987 #define SMBdskattr 0x80 /* get disk attributes */
988 #define SMBsearch 0x81 /* search directory */
989 #define SMBsplopen 0xC0 /* open print spool file */
990 #define SMBsplwr 0xC1 /* write to print spool file */
991 #define SMBsplclose 0xC2 /* close print spool file */
992 #define SMBsplretq 0xC3 /* return print queue */
993 #define SMBsends 0xD0 /* send single block message */
994 #define SMBsendb 0xD1 /* send broadcast message */
995 #define SMBfwdname 0xD2 /* forward user name */
996 #define SMBcancelf 0xD3 /* cancel forward */
997 #define SMBgetmac 0xD4 /* get machine name */
998 #define SMBsendstrt 0xD5 /* send start of multi-block message */
999 #define SMBsendend 0xD6 /* send end of multi-block message */
1000 #define SMBsendtxt 0xD7 /* send text of multi-block message */
1002 /* Core+ protocol */
1003 #define SMBlockread 0x13 /* Lock a range and read */
1004 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1005 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
1006 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
1007 #define SMBwritec 0x20 /* secondary write request */
1008 #define SMBwriteclose 0x2c /* write a file then close it */
1010 /* dos extended protocol */
1011 #define SMBreadBraw 0x1A /* read block raw */
1012 #define SMBreadBmpx 0x1B /* read block multiplexed */
1013 #define SMBreadBs 0x1C /* read block (secondary response) */
1014 #define SMBwriteBraw 0x1D /* write block raw */
1015 #define SMBwriteBmpx 0x1E /* write block multiplexed */
1016 #define SMBwriteBs 0x1F /* write block (secondary request) */
1017 #define SMBwriteC 0x20 /* write complete response */
1018 #define SMBsetattrE 0x22 /* set file attributes expanded */
1019 #define SMBgetattrE 0x23 /* get file attributes expanded */
1020 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
1021 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
1022 #define SMBtranss 0x26 /* transaction (secondary request/response) */
1023 #define SMBioctl 0x27 /* IOCTL */
1024 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
1025 #define SMBcopy 0x29 /* copy */
1026 #define SMBmove 0x2A /* move */
1027 #define SMBecho 0x2B /* echo */
1028 #define SMBopenX 0x2D /* open and X */
1029 #define SMBreadX 0x2E /* read and X */
1030 #define SMBwriteX 0x2F /* write and X */
1031 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
1032 #define SMBffirst 0x82 /* find first */
1033 #define SMBfunique 0x83 /* find unique */
1034 #define SMBfclose 0x84 /* find close */
1035 #define SMBkeepalive 0x85 /* keepalive */
1036 #define SMBinvalid 0xFE /* invalid command */
1038 /* Extended 2.0 protocol */
1039 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1040 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1041 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1042 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1043 #define SMBulogoffX 0x74 /* user logoff */
1045 /* NT SMB extensions. */
1046 #define SMBnttrans 0xA0 /* NT transact */
1047 #define SMBnttranss 0xA1 /* NT transact secondary */
1048 #define SMBntcreateX 0xA2 /* NT create and X */
1049 #define SMBntcancel 0xA4 /* NT cancel */
1050 #define SMBntrename 0xA5 /* NT rename */
1052 /* These are the trans subcommands */
1053 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
1054 #define TRANSACT_DCERPCCMD 0x26
1055 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1057 /* These are the TRANS2 sub commands */
1058 #define TRANSACT2_OPEN 0x00
1059 #define TRANSACT2_FINDFIRST 0x01
1060 #define TRANSACT2_FINDNEXT 0x02
1061 #define TRANSACT2_QFSINFO 0x03
1062 #define TRANSACT2_SETFSINFO 0x04
1063 #define TRANSACT2_QPATHINFO 0x05
1064 #define TRANSACT2_SETPATHINFO 0x06
1065 #define TRANSACT2_QFILEINFO 0x07
1066 #define TRANSACT2_SETFILEINFO 0x08
1067 #define TRANSACT2_FSCTL 0x09
1068 #define TRANSACT2_IOCTL 0x0A
1069 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1070 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1071 #define TRANSACT2_MKDIR 0x0D
1072 #define TRANSACT2_SESSION_SETUP 0x0E
1073 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1074 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1076 /* These are the NT transact sub commands. */
1077 #define NT_TRANSACT_CREATE 1
1078 #define NT_TRANSACT_IOCTL 2
1079 #define NT_TRANSACT_SET_SECURITY_DESC 3
1080 #define NT_TRANSACT_NOTIFY_CHANGE 4
1081 #define NT_TRANSACT_RENAME 5
1082 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1083 #define NT_TRANSACT_GET_USER_QUOTA 7
1084 #define NT_TRANSACT_SET_USER_QUOTA 8
1086 /* These are the NT transact_get_user_quota sub commands */
1087 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1088 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1089 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1091 /* Relevant IOCTL codes */
1092 #define IOCTL_QUERY_JOB_INFO 0x530060
1094 /* these are the trans2 sub fields for primary requests */
1095 #define smb_tpscnt smb_vwv0
1096 #define smb_tdscnt smb_vwv1
1097 #define smb_mprcnt smb_vwv2
1098 #define smb_mdrcnt smb_vwv3
1099 #define smb_msrcnt smb_vwv4
1100 #define smb_flags smb_vwv5
1101 #define smb_timeout smb_vwv6
1102 #define smb_pscnt smb_vwv9
1103 #define smb_psoff smb_vwv10
1104 #define smb_dscnt smb_vwv11
1105 #define smb_dsoff smb_vwv12
1106 #define smb_suwcnt smb_vwv13
1107 #define smb_setup smb_vwv14
1108 #define smb_setup0 smb_setup
1109 #define smb_setup1 (smb_setup+2)
1110 #define smb_setup2 (smb_setup+4)
1112 /* these are for the secondary requests */
1113 #define smb_spscnt smb_vwv2
1114 #define smb_spsoff smb_vwv3
1115 #define smb_spsdisp smb_vwv4
1116 #define smb_sdscnt smb_vwv5
1117 #define smb_sdsoff smb_vwv6
1118 #define smb_sdsdisp smb_vwv7
1119 #define smb_sfid smb_vwv8
1121 /* and these for responses */
1122 #define smb_tprcnt smb_vwv0
1123 #define smb_tdrcnt smb_vwv1
1124 #define smb_prcnt smb_vwv3
1125 #define smb_proff smb_vwv4
1126 #define smb_prdisp smb_vwv5
1127 #define smb_drcnt smb_vwv6
1128 #define smb_droff smb_vwv7
1129 #define smb_drdisp smb_vwv8
1131 /* these are for the NT trans primary request. */
1132 #define smb_nt_MaxSetupCount smb_vwv0
1133 #define smb_nt_Flags (smb_vwv0 + 1)
1134 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1135 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1136 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1137 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1138 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1139 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1140 #define smb_nt_DataCount (smb_vwv0 + 27)
1141 #define smb_nt_DataOffset (smb_vwv0 + 31)
1142 #define smb_nt_SetupCount (smb_vwv0 + 35)
1143 #define smb_nt_Function (smb_vwv0 + 36)
1144 #define smb_nt_SetupStart (smb_vwv0 + 38)
1146 /* these are for the NT trans secondary request. */
1147 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1148 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1149 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1150 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1151 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1152 #define smb_nts_DataCount (smb_vwv0 + 23)
1153 #define smb_nts_DataOffset (smb_vwv0 + 27)
1154 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1156 /* these are for the NT trans reply. */
1157 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1158 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1159 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1160 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1161 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1162 #define smb_ntr_DataCount (smb_vwv0 + 23)
1163 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1164 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1166 /* these are for the NT create_and_X */
1167 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1168 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1169 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1170 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1171 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1172 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1173 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1174 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1175 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1176 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1177 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1179 /* this is used on a TConX. I'm not sure the name is very helpful though */
1180 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1181 #define SMB_SHARE_IN_DFS 0x0002
1183 /* Named pipe write mode flags. Used in writeX calls. */
1184 #define PIPE_RAW_MODE 0x4
1185 #define PIPE_START_MESSAGE 0x8
1187 /* File Specific access rights */
1188 #define FILE_READ_DATA 0x00000001
1189 #define FILE_WRITE_DATA 0x00000002
1190 #define FILE_APPEND_DATA 0x00000004
1191 #define FILE_READ_EA 0x00000008 /* File and directory */
1192 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1193 #define FILE_EXECUTE 0x00000020
1194 #define FILE_DELETE_CHILD 0x00000040
1195 #define FILE_READ_ATTRIBUTES 0x00000080
1196 #define FILE_WRITE_ATTRIBUTES 0x00000100
1198 #define FILE_ALL_ACCESS 0x000001FF
1200 /* Directory specific access rights */
1201 #define FILE_LIST_DIRECTORY 0x00000001
1202 #define FILE_ADD_FILE 0x00000002
1203 #define FILE_ADD_SUBDIRECTORY 0x00000004
1204 #define FILE_TRAVERSE 0x00000020
1205 #define FILE_DELETE_CHILD 0x00000040
1207 /* the desired access to use when opening a pipe */
1208 #define DESIRED_ACCESS_PIPE 0x2019f
1210 /* Generic access masks & rights. */
1211 #define DELETE_ACCESS 0x00010000 /* (1L<<16) */
1212 #define READ_CONTROL_ACCESS 0x00020000 /* (1L<<17) */
1213 #define WRITE_DAC_ACCESS 0x00040000 /* (1L<<18) */
1214 #define WRITE_OWNER_ACCESS 0x00080000 /* (1L<<19) */
1215 #define SYNCHRONIZE_ACCESS 0x00100000 /* (1L<<20) */
1217 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1218 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1219 #define GENERIC_ALL_ACCESS 0x10000000 /* (1<<28) */
1220 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1221 #define GENERIC_WRITE_ACCESS 0x40000000 /* (1<<30) */
1222 #define GENERIC_READ_ACCESS ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1224 /* Mapping of generic access rights for files to specific rights. */
1226 /* This maps to 0x1F01FF */
1227 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS|\
1228 SYNCHRONIZE_ACCESS|\
1231 /* This maps to 0x120089 */
1232 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|\
1234 FILE_READ_ATTRIBUTES|\
1238 /* This maps to 0x120116 */
1239 #define FILE_GENERIC_WRITE (SEC_STD_READ_CONTROL|\
1241 FILE_WRITE_ATTRIBUTES|\
1246 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|\
1247 FILE_READ_ATTRIBUTES|\
1251 /* Share specific rights. */
1252 #define SHARE_ALL_ACCESS FILE_GENERIC_ALL
1253 #define SHARE_READ_ONLY (FILE_GENERIC_READ|FILE_EXECUTE)
1255 /* Mapping of access rights to UNIX perms. */
1256 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1257 #define UNIX_ACCESS_R FILE_GENERIC_READ
1258 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1259 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1261 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1262 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1263 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1264 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1265 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1269 * This is the old mapping we used to use. To get W2KSP2 profiles
1270 * working we need to map to the canonical file perms.
1272 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1273 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1274 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1275 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1276 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1277 FILE_APPEND_DATA|FILE_WRITE_DATA)
1278 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1279 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1282 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1285 #define REQUEST_OPLOCK 2
1286 #define REQUEST_BATCH_OPLOCK 4
1287 #define OPEN_DIRECTORY 8
1288 #define EXTENDED_RESPONSE_REQUIRED 0x10
1290 /* ShareAccess field. */
1291 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1292 #define FILE_SHARE_READ 1
1293 #define FILE_SHARE_WRITE 2
1294 #define FILE_SHARE_DELETE 4
1296 /* FileAttributesField */
1297 #define FILE_ATTRIBUTE_READONLY 0x001L
1298 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1299 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1300 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1301 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1302 #define FILE_ATTRIBUTE_NORMAL 0x080L
1303 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1304 #define FILE_ATTRIBUTE_SPARSE 0x200L
1305 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1306 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1307 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1308 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1309 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1310 #define SAMBA_ATTRIBUTES_MASK 0x7F
1312 /* Flags - combined with attributes. */
1313 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1314 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1315 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1316 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1317 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1318 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1319 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1321 /* CreateDisposition field. */
1322 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1323 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1324 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1325 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1326 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1327 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1329 /* CreateOptions field. */
1330 #define FILE_DIRECTORY_FILE 0x0001
1331 #define FILE_WRITE_THROUGH 0x0002
1332 #define FILE_SEQUENTIAL_ONLY 0x0004
1333 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1334 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
1335 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
1336 #define FILE_NON_DIRECTORY_FILE 0x0040
1337 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
1338 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
1339 #define FILE_NO_EA_KNOWLEDGE 0x0200
1340 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1341 #define FILE_RANDOM_ACCESS 0x0800
1342 #define FILE_DELETE_ON_CLOSE 0x1000
1343 #define FILE_OPEN_BY_FILE_ID 0x2000
1344 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
1345 #define FILE_NO_COMPRESSION 0x8000
1346 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
1347 #define FILE_OPEN_REPARSE_POINT 0x00200000
1348 #define FILE_OPEN_NO_RECALL 0x00400000
1349 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1351 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1353 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1356 * Private create options used by the ntcreatex processing code. From Samba4.
1357 * We reuse some ignored flags for private use. Passed in the private_flags
1360 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
1361 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
1363 /* Private options for streams support */
1364 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1366 /* Private options for printer support */
1367 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1369 /* Responses when opening a file. */
1370 #define FILE_WAS_SUPERSEDED 0
1371 #define FILE_WAS_OPENED 1
1372 #define FILE_WAS_CREATED 2
1373 #define FILE_WAS_OVERWRITTEN 3
1375 /* File type flags */
1376 #define FILE_TYPE_DISK 0
1377 #define FILE_TYPE_BYTE_MODE_PIPE 1
1378 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1379 #define FILE_TYPE_PRINTER 3
1380 #define FILE_TYPE_COMM_DEVICE 4
1381 #define FILE_TYPE_UNKNOWN 0xFFFF
1383 /* Flag for NT transact rename call. */
1384 #define RENAME_REPLACE_IF_EXISTS 1
1386 /* flags for SMBntrename call (from Samba4) */
1387 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1388 #define RENAME_FLAG_HARD_LINK 0x103
1389 #define RENAME_FLAG_RENAME 0x104
1390 #define RENAME_FLAG_COPY 0x105
1392 /* Filesystem Attributes. */
1393 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1394 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1395 #define FILE_UNICODE_ON_DISK 0x00000004
1396 /* According to cifs9f, this is 4, not 8 */
1397 /* Acconding to testing, this actually sets the security attribute! */
1398 #define FILE_PERSISTENT_ACLS 0x00000008
1399 #define FILE_FILE_COMPRESSION 0x00000010
1400 #define FILE_VOLUME_QUOTAS 0x00000020
1401 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1402 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1403 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1404 #define FS_LFN_APIS 0x00004000
1405 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1406 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1407 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1408 #define FILE_NAMED_STREAMS 0x00040000
1409 #define FILE_READ_ONLY_VOLUME 0x00080000
1411 /* ChangeNotify flags. */
1412 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1413 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1414 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1415 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1416 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1417 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1418 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1419 #define FILE_NOTIFY_CHANGE_EA 0x080
1420 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1421 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1422 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1423 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1425 #define FILE_NOTIFY_CHANGE_NAME \
1426 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1428 /* change notify action results */
1429 #define NOTIFY_ACTION_ADDED 1
1430 #define NOTIFY_ACTION_REMOVED 2
1431 #define NOTIFY_ACTION_MODIFIED 3
1432 #define NOTIFY_ACTION_OLD_NAME 4
1433 #define NOTIFY_ACTION_NEW_NAME 5
1434 #define NOTIFY_ACTION_ADDED_STREAM 6
1435 #define NOTIFY_ACTION_REMOVED_STREAM 7
1436 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1439 /* where to find the base of the SMB packet proper */
1440 #define smb_base(buf) (((char *)(buf))+4)
1442 /* we don't allow server strings to be longer than 48 characters as
1443 otherwise NT will not honour the announce packets */
1444 #define MAX_SERVER_STRING_LENGTH 48
1447 #define SMB_SUCCESS 0 /* The request was successful. */
1450 void dfs_unlogin(void);
1451 extern int dcelogin_atmost_once;
1455 char *strdup(char *s);
1462 /* This was set by JHT in liaison with Jeremy Allison early 1997
1464 * Version 4.0 - never made public
1465 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1466 * - Reappeared in 1.9.16p11 with fixed smbd services
1467 * Version 4.20 - To indicate that nmbd and browsing now works better
1468 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1470 * Note: In the presence of NT4.X do not set above 4.9
1471 * Setting this above 4.9 can have undesired side-effects.
1472 * This may change again in Samba-3.0 after further testing. JHT
1475 #define DEFAULT_MAJOR_VERSION 0x04
1476 #define DEFAULT_MINOR_VERSION 0x09
1478 /* Browser Election Values */
1479 #define BROWSER_ELECTION_VERSION 0x010f
1480 #define BROWSER_CONSTANT 0xaa55
1482 /* Sercurity mode bits. */
1483 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1484 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1485 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1486 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1488 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1490 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1491 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1492 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1493 #define FLAGS2_UNKNOWN_BIT4 0x0010
1494 #define FLAGS2_IS_LONG_NAME 0x0040
1495 #define FLAGS2_EXTENDED_SECURITY 0x0800
1496 #define FLAGS2_DFS_PATHNAMES 0x1000
1497 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1498 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1499 #define FLAGS2_UNICODE_STRINGS 0x8000
1501 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1503 /* TCONX Flag (smb_vwv2). */
1504 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1506 /* File Status Flags. See:
1508 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1512 #define NO_SUBSTREAMS 0x2
1513 #define NO_REPARSETAG 0x4
1515 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1517 #define CAP_RAW_MODE 0x0001
1518 #define CAP_MPX_MODE 0x0002
1519 #define CAP_UNICODE 0x0004
1520 #define CAP_LARGE_FILES 0x0008
1521 #define CAP_NT_SMBS 0x0010
1522 #define CAP_RPC_REMOTE_APIS 0x0020
1523 #define CAP_STATUS32 0x0040
1524 #define CAP_LEVEL_II_OPLOCKS 0x0080
1525 #define CAP_LOCK_AND_READ 0x0100
1526 #define CAP_NT_FIND 0x0200
1527 #define CAP_DFS 0x1000
1528 #define CAP_W2K_SMBS 0x2000
1529 #define CAP_LARGE_READX 0x4000
1530 #define CAP_LARGE_WRITEX 0x8000
1531 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1532 #define CAP_EXTENDED_SECURITY 0x80000000
1534 /* protocol types. It assumes that higher protocols include lower protocols
1536 enum protocol_types {
1546 /* security levels */
1547 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1557 /* printing types */
1558 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1559 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1560 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1561 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1562 ,PRINT_TEST,PRINT_VLP
1563 #endif /* DEVELOPER */
1566 /* LDAP schema types */
1567 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1569 /* LDAP SSL options */
1570 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1572 /* LDAP PASSWD SYNC methods */
1573 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1576 * This should be under the HAVE_KRB5 flag but since they're used
1577 * in lp_kerberos_method(), they ned to be always available
1578 * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
1579 * so they remain accurate.
1582 #define KERBEROS_VERIFY_SECRETS 0
1583 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1584 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1585 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1587 /* Remote architectures we know about. */
1588 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1589 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1590 RA_SAMBA, RA_CIFSFS, RA_WINXP64};
1593 enum case_handling {CASE_LOWER,CASE_UPPER};
1595 /* ACL compatibility */
1596 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1598 * Global value meaing that the smb_uid field should be
1599 * ingored (in share level security and protocol level == CORE)
1602 #define UID_FIELD_INVALID 0
1603 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1606 * Size of buffer to use when moving files across filesystems.
1608 #define COPYBUF_SIZE (8*1024)
1611 * Map the Core and Extended Oplock requesst bits down
1612 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1618 #define CORE_OPLOCK_REQUEST(inbuf) \
1619 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1622 * Extended protocol.
1624 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1627 #define LOCKING_ANDX_SHARED_LOCK 0x1
1628 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1629 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1630 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1631 #define LOCKING_ANDX_LARGE_FILES 0x10
1634 * Bits we test with.
1635 * Note these must fit into 16-bits.
1638 #define NO_OPLOCK 0x0
1639 #define EXCLUSIVE_OPLOCK 0x1
1640 #define BATCH_OPLOCK 0x2
1641 #define LEVEL_II_OPLOCK 0x4
1643 /* The following are Samba-private. */
1644 #define INTERNAL_OPEN_ONLY 0x8
1645 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1646 * inform potential level2 holders on
1648 #define DEFERRED_OPEN_ENTRY 0x20
1649 #define UNUSED_SHARE_MODE_ENTRY 0x40
1650 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1652 /* None of the following should ever appear in fsp->oplock_request. */
1653 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1655 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1656 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1657 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1659 /* kernel_oplock_message definition.
1661 struct kernel_oplock_message {
1665 unsigned long file_id;
1669 0 uint64_t dev 8 bytes
1670 8 uint64_t inode 8 bytes
1671 16 uint64_t extid 8 bytes
1672 24 unsigned long file_id 4 bytes
1676 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1678 /* file_renamed_message definition.
1680 struct file_renamed_message {
1683 char names[1]; A variable area containing sharepath and filename.
1687 0 uint64_t dev 8 bytes
1688 8 uint64_t inode 8 bytes
1689 16 unit64_t extid 8 bytes
1690 24 char [] name zero terminated namelen bytes
1691 minimum length == 24.
1695 #define MSG_FILE_RENAMED_MIN_SIZE 24
1698 * On the wire return values for oplock types.
1701 #define CORE_OPLOCK_GRANTED (1<<5)
1702 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1704 #define NO_OPLOCK_RETURN 0
1705 #define EXCLUSIVE_OPLOCK_RETURN 1
1706 #define BATCH_OPLOCK_RETURN 2
1707 #define LEVEL_II_OPLOCK_RETURN 3
1710 #define OPLOCKLEVEL_NONE 0
1711 #define OPLOCKLEVEL_II 1
1714 * Capabilities abstracted for different systems.
1717 enum smbd_capability {
1718 KERNEL_OPLOCK_CAPABILITY,
1719 DMAPI_ACCESS_CAPABILITY,
1724 * Kernel oplocks capability flags.
1727 /* Level 2 oplocks are supported natively by kernel oplocks. */
1728 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1730 /* The kernel notifies deferred openers when they can retry the open. */
1731 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1733 /* The kernel notifies smbds when an oplock break times out. */
1734 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1736 /* The kernel notifies smbds when an oplock is broken. */
1737 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1739 struct kernel_oplocks_ops;
1740 struct kernel_oplocks {
1741 const struct kernel_oplocks_ops *ops;
1746 enum level2_contention_type {
1747 LEVEL2_CONTEND_ALLOC_SHRINK,
1748 LEVEL2_CONTEND_ALLOC_GROW,
1749 LEVEL2_CONTEND_SET_FILE_LEN,
1750 LEVEL2_CONTEND_FILL_SPARSE,
1751 LEVEL2_CONTEND_WRITE,
1752 LEVEL2_CONTEND_WINDOWS_BRL,
1753 LEVEL2_CONTEND_POSIX_BRL
1756 /* if a kernel does support oplocks then a structure of the following
1757 typee is used to describe how to interact with the kernel */
1758 struct kernel_oplocks_ops {
1759 bool (*set_oplock)(struct kernel_oplocks *ctx,
1760 files_struct *fsp, int oplock_type);
1761 void (*release_oplock)(struct kernel_oplocks *ctx,
1762 files_struct *fsp, int oplock_type);
1763 void (*contend_level2_oplocks_begin)(files_struct *fsp,
1764 enum level2_contention_type type);
1765 void (*contend_level2_oplocks_end)(files_struct *fsp,
1766 enum level2_contention_type type);
1769 #include "smb_macros.h"
1771 #define MAX_NETBIOSNAME_LEN 16
1772 /* DOS character, NetBIOS namestring. Type used on the wire. */
1773 typedef char nstring[MAX_NETBIOSNAME_LEN];
1774 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1775 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1777 /* A netbios name structure. */
1781 unsigned int name_type;
1784 /* A netbios node status array element. */
1785 typedef struct node_status_ {
1788 unsigned char flags;
1789 } NODE_STATUS_STRUCT;
1791 /* The extra info from a NetBIOS node status query */
1792 struct node_status_extra {
1793 unsigned char mac_addr[6];
1794 /* There really is more here ... */
1797 typedef struct user_struct {
1798 struct user_struct *next, *prev;
1799 uint16 vuid; /* Tag for this entry. */
1801 char *session_keystr; /* used by utmp and pam session code.
1805 struct auth_serversupplied_info *server_info;
1807 struct auth_ntlmssp_state *auth_ntlmssp_state;
1810 struct unix_error_map {
1818 * Size of new password account encoding string. This is enough space to
1819 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1820 * Do not change unless you are adding new ACB bits!
1823 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1826 Do you want session setups at user level security with a invalid
1827 password to be rejected or allowed in as guest? WinNT rejects them
1828 but it can be a pain as it means "net view" needs to use a password
1830 You have 3 choices in the setting of map_to_guest:
1832 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1833 are rejected. This is the default.
1835 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1836 are rejected, unless the username does not exist, in which case it
1837 is treated as a guest login
1839 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1840 are treated as a guest login
1842 Note that map_to_guest only has an effect in user or server
1846 #define NEVER_MAP_TO_GUEST 0
1847 #define MAP_TO_GUEST_ON_BAD_USER 1
1848 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1849 #define MAP_TO_GUEST_ON_BAD_UID 3
1851 #define SAFE_NETBIOS_CHARS ". -_"
1853 /* The maximum length of a trust account password.
1854 Used when we randomly create it, 15 char passwords
1855 exceed NT4's max password length */
1857 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1861 #define LDAP_PORT 389
1863 #define LDAP_GC_PORT 3268
1865 /* used by the IP comparison function */
1867 struct sockaddr_storage ss;
1871 /* Special name type used to cause a _kerberos DNS lookup. */
1872 #define KDC_NAME_TYPE 0xDCDC
1881 struct ea_list *next, *prev;
1882 struct ea_struct ea;
1885 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1886 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1887 /* EA to use for DOS attributes */
1888 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1889 /* Prefix for DosStreams in the vfs_streams_xattr module */
1890 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1891 /* Prefix for xattrs storing streams. */
1892 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1894 #define UUID_SIZE 16
1896 #define UUID_FLAT_SIZE 16
1897 typedef struct uuid_flat {
1898 uint8 info[UUID_FLAT_SIZE];
1901 /* map readonly options */
1902 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1904 /* usershare error codes. */
1905 enum usershare_err {
1907 USERSHARE_MALFORMED_FILE,
1908 USERSHARE_BAD_VERSION,
1909 USERSHARE_MALFORMED_PATH,
1910 USERSHARE_MALFORMED_COMMENT_DEF,
1911 USERSHARE_MALFORMED_ACL_DEF,
1913 USERSHARE_PATH_NOT_ABSOLUTE,
1914 USERSHARE_PATH_IS_DENIED,
1915 USERSHARE_PATH_NOT_ALLOWED,
1916 USERSHARE_PATH_NOT_DIRECTORY,
1917 USERSHARE_POSIX_ERR,
1918 USERSHARE_MALFORMED_SHARENAME_DEF,
1919 USERSHARE_BAD_SHARENAME
1922 /* Different reasons for closing a file. */
1923 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1925 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1926 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1927 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1928 struct smb_extended_info {
1929 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1930 uint32 samba_version; /* Major/Minor/Release/Revision */
1931 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1932 NTTIME samba_gitcommitdate;
1933 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1937 struct smb_file_time {
1938 struct timespec mtime;
1939 struct timespec atime;
1940 struct timespec ctime;
1941 struct timespec create_time;
1945 * unix_convert_flags
1947 #define UCF_SAVE_LCOMP 0x00000001
1948 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1949 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1950 #define UCF_POSIX_PATHNAMES 0x00000008
1955 struct smb_filename {
1958 char *original_lcomp;
1962 /* struct for maintaining the child processes that get spawned from smbd */
1964 struct child_pid *prev, *next;
1968 /* Used to keep track of deferred opens. */
1969 struct deferred_open_record;
1971 /* Client-side offline caching policy types */
1972 #define CSC_POLICY_MANUAL 0
1973 #define CSC_POLICY_DOCUMENTS 1
1974 #define CSC_POLICY_PROGRAMS 2
1975 #define CSC_POLICY_DISABLE 3
1977 /* Used inside aio code. */