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-2011"
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 typedef union unid_t {
145 /* pipe string names */
148 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
151 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
153 #define LOOKUP_NAME_NONE 0x00000000
154 #define LOOKUP_NAME_ISOLATED 0x00000001 /* Look up unqualified names */
155 #define LOOKUP_NAME_REMOTE 0x00000002 /* Ask others */
156 #define LOOKUP_NAME_GROUP 0x00000004 /* (unused) This is a NASTY hack for
157 valid users = @foo where foo also
158 exists in as user. */
159 #define LOOKUP_NAME_NO_NSS 0x00000008 /* no NSS calls to avoid
160 winbind recursions */
161 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
162 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
163 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
164 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
165 |LOOKUP_NAME_BUILTIN\
168 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
170 |LOOKUP_NAME_BUILTIN\
174 #include "librpc/gen_ndr/dcerpc.h"
175 #include "librpc/gen_ndr/security.h"
177 struct lsa_dom_info {
185 struct lsa_name_info {
187 enum lsa_SidType type;
193 * The complete list of SIDS belonging to this user.
194 * Created when a vuid is registered.
195 * The definition of the user_sids array is as follows :
197 * token->user_sids[0] = primary user SID.
198 * token->user_sids[1] = primary group SID.
199 * token->user_sids[2..num_sids] = supplementary group SIDS.
202 #define PRIMARY_USER_SID_INDEX 0
203 #define PRIMARY_GROUP_SID_INDEX 1
205 typedef struct unix_user_token {
212 typedef struct write_cache {
223 uint64_t position_information;
225 uint32 private_options; /* NT Create options, but we only look at
226 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
227 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
228 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
229 * for print files *only*, where
230 * DELETE_ON_CLOSE is not stored in the share
233 unsigned long gen_id;
237 struct share_mode_entry;
241 struct rpc_cli_smbd_conn;
242 struct fncall_context;
244 struct vfs_fsp_data {
245 struct vfs_fsp_data *next;
246 struct vfs_handle_struct *owner;
247 void (*destroy)(void *p_data);
249 /* NOTE: This structure contains four pointers so that we can guarantee
250 * that the end of the structure is always both 4-byte and 8-byte aligned.
254 /* the basic packet size, assuming no words or bytes */
257 struct notify_change {
262 struct notify_mid_map;
265 struct notify_change_request;
266 struct sys_notify_backend;
267 struct sys_notify_context {
268 struct event_context *ev;
269 struct connection_struct *conn;
270 void *private_data; /* For use by the system backend */
273 struct notify_change_buf {
275 * If no requests are pending, changes are queued here. Simple array,
280 * num_changes == -1 means that we have got a catch-all change, when
281 * asked we just return NT_STATUS_OK without specific changes.
284 struct notify_change *changes;
287 * If no changes are around requests are queued here. Using a linked
288 * list, because we have to append at the end and delete from the top.
290 struct notify_change_request *requests;
293 struct print_file_data {
297 struct policy_handle handle;
302 typedef struct files_struct {
303 struct files_struct *next, *prev;
305 struct connection_struct *conn;
306 struct fd_handle *fh;
307 unsigned int num_smb_operations;
308 struct file_id file_id;
309 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
314 struct timeval open_time;
315 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
316 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
318 bool update_write_time_triggered;
319 struct timed_event *update_write_time_event;
320 bool update_write_time_on_close;
321 struct timespec close_write_time;
322 bool write_time_forced;
325 int sent_oplock_break;
326 struct timed_event *oplock_timeout;
327 struct lock_struct last_lock_failure;
328 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
330 struct share_mode_entry *pending_break_messages;
331 int num_pending_break_messages;
338 bool aio_write_behind;
340 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
341 bool delete_on_close;
344 struct smb_filename *fsp_name;
345 uint32_t name_hash; /* Jenkins hash of full pathname. */
347 struct vfs_fsp_data *vfs_extension;
348 struct fake_file_handle *fake_file_handle;
350 struct notify_change_buf *notify;
352 struct files_struct *base_fsp; /* placeholder for delete on close */
355 * Read-only cached brlock record, thrown away when the
356 * brlock.tdb seqnum changes. This avoids fetching data from
357 * the brlock.tdb on every read/write call.
360 struct byte_range_lock *brlock_rec;
362 struct dptr_struct *dptr;
364 /* if not NULL, means this is a print file */
365 struct print_file_data *print_file;
369 #include "ntquotas.h"
370 #include "sysquotas.h"
372 struct client_address {
373 char addr[INET6_ADDRSTRLEN];
377 struct vuid_cache_entry {
378 struct auth_serversupplied_info *session_info;
384 unsigned int next_entry;
385 struct vuid_cache_entry array[VUID_CACHE_SIZE];
391 } name_compare_entry;
394 struct trans_state *next, *prev;
398 uint32 max_param_return;
399 uint32 max_data_return;
400 uint32 max_setup_return;
402 uint8 cmd; /* SMBtrans or SMBtrans2 */
404 char *name; /* for trans requests */
405 uint16 call; /* for trans2 and nttrans requests */
407 bool close_on_completion;
410 unsigned int setup_count;
413 size_t received_data;
414 size_t received_param;
424 * Info about an alternate data stream
427 struct stream_struct {
429 SMB_OFF_T alloc_size;
433 /* Include VFS stuff */
435 #include "smb_acls.h"
438 struct dfree_cached_info {
439 time_t last_dfree_time;
448 struct share_params {
452 struct share_iterator {
456 typedef struct connection_struct {
457 struct connection_struct *next, *prev;
458 struct smbd_server_connection *sconn; /* can be NULL */
459 unsigned cnum; /* an index passed over the wire */
460 struct share_params *params;
462 struct vuid_cache vuid_cache;
465 bool read_only; /* Attributes for the current user of the share. */
466 /* Does this filesystem honor
467 sub second timestamps on files
468 and directories when setting time ? */
469 enum timestamp_set_resolution ts_res;
473 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
476 * This represents the user information on this connection. Depending
477 * on the vuid using this tid, this might change per SMB request.
479 struct auth_serversupplied_info *session_info;
482 * If the "force group" parameter is set, this is the primary gid that
483 * may be used in the users token, depending on the vuid using this tid.
485 gid_t force_group_gid;
487 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
490 time_t lastused_count;
493 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
497 /* Semantics requested by the client or forced by the server config. */
500 bool short_case_preserve;
502 /* Semantics provided by the underlying filesystem. */
504 /* Device number of the directory of the share mount.
505 Used to ensure unique FileIndex returns. */
506 SMB_DEV_T base_share_dev;
508 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
509 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
510 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
511 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
512 struct dfree_cached_info *dfree_info;
513 struct trans_state *pending_trans;
514 struct notify_context *notify_ctx;
516 struct rpc_pipe_client *spoolss_pipe;
520 struct current_user {
521 connection_struct *conn;
524 struct security_token *nt_user_token;
527 struct smbd_smb2_request;
533 uint64_t mid; /* For compatibility with SMB2. */
544 * Async handling in the main smb processing loop is directed by
545 * outbuf: reply_xxx routines indicate sync behaviour by putting their
546 * reply into "outbuf". If they leave it as NULL, they take of it
547 * themselves, possibly later.
549 * If async handling is wanted, the reply_xxx routine must make sure
550 * that it talloc_move()s the smb_req somewhere else.
556 connection_struct *conn;
557 struct smbd_server_connection *sconn;
558 struct smb_perfcount_data pcd;
561 * Chained request handling
563 struct files_struct *chain_fsp;
566 * Here we collect the outbufs from the chain handlers
568 uint8_t *chain_outbuf;
571 * state information for async smb handling
578 * Back pointer to smb2 request.
580 struct smbd_smb2_request *smb2req;
583 /* Defines for the sent_oplock_break field above. */
584 #define NO_BREAK_SENT 0
585 #define BREAK_TO_NONE_SENT 1
586 #define LEVEL_II_BREAK_SENT 2
589 fstring smb_name; /* user name from the client */
590 fstring unix_name; /* unix user name of a validated user */
591 fstring domain; /* domain that the client specified */
594 /* used for server information: client, nameserv and ipc */
595 struct server_info_struct {
599 fstring domain; /* used ONLY in ipc.c NOT namework.c */
600 bool server_added; /* used ONLY in ipc.c NOT namework.c */
603 /* used for network interfaces */
605 struct interface *next, *prev;
608 struct sockaddr_storage ip;
609 struct sockaddr_storage netmask;
610 struct sockaddr_storage bcast;
613 /* Internal message queue for deferred opens. */
614 struct pending_message_list {
615 struct pending_message_list *next, *prev;
616 struct timeval request_time; /* When was this first issued? */
617 struct timed_event *te;
618 struct smb_perfcount_data pcd;
623 DATA_BLOB private_data;
626 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
628 /* struct returned by get_share_modes */
629 struct share_mode_entry {
630 struct server_id pid;
631 uint64_t op_mid; /* For compatibility with SMB2 opens. */
633 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
634 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
635 uint32 private_options; /* NT Create options, but we only look at
636 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
637 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
638 * smbstatus and swat */
641 unsigned long share_file_id;
642 uint32 uid; /* uid of file opener. */
643 uint16 flags; /* See SHARE_MODE_XX above. */
644 uint32_t name_hash; /* Jenkins hash of full pathname. */
647 /* oplock break message definition - linearization of share_mode_entry.
650 0 struct server_id pid 4
653 14 uint32 access_mask 4
654 18 uint32 share_access 4
655 22 uint32 private_options 4
657 30 uint32 time usec 4
658 34 uint64 dev 8 bytes
659 42 uint64 inode 8 bytes
660 50 uint64 extid 8 bytes
661 58 unsigned long file_id 4 bytes
662 62 uint32 uid 4 bytes
663 66 uint16 flags 2 bytes
664 68 uint32 name_hash 4 bytes
669 #define OP_BREAK_MSG_PID_OFFSET 0
670 #define OP_BREAK_MSG_MID_OFFSET 4
671 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
672 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
673 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
674 #define OP_BREAK_MSG_PRIV_OFFSET 22
675 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
676 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
677 #define OP_BREAK_MSG_DEV_OFFSET 34
678 #define OP_BREAK_MSG_INO_OFFSET 42
679 #define OP_BREAK_MSG_EXTID_OFFSET 50
680 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
681 #define OP_BREAK_MSG_UID_OFFSET 62
682 #define OP_BREAK_MSG_FLAGS_OFFSET 66
683 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
685 #define OP_BREAK_MSG_VNN_OFFSET 72
686 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
688 struct delete_token_list {
689 struct delete_token_list *next, *prev;
691 UNIX_USER_TOKEN *delete_token;
694 struct share_mode_lock {
695 const char *servicepath; /* canonicalized. */
696 const char *base_name;
697 const char *stream_name;
700 struct share_mode_entry *share_modes;
701 struct delete_token_list *delete_tokens;
702 struct timespec old_write_time;
703 struct timespec changed_write_time;
706 struct db_record *record;
710 * Internal structure of locking.tdb share mode db.
711 * Used by locking.c and libsmbsharemodes.c
714 struct locking_data {
717 int num_share_mode_entries;
718 struct timespec old_write_time;
719 struct timespec changed_write_time;
720 uint32 num_delete_token_entries;
722 struct share_mode_entry dummy; /* Needed for alignment. */
724 /* The following four entries are implicit
726 (1) struct share_mode_entry modes[num_share_mode_entries];
728 (2) A num_delete_token_entries of structs {
729 uint32_t len_delete_token;
730 char unix_token[len_delete_token] (divisible by 4).
733 (3) char share_name[];
734 (4) char file_name[];
738 /* Used to store pipe open records for NetFileEnum() */
740 struct pipe_open_rec {
741 struct server_id pid;
748 #define NT_HASH_LEN 16
749 #define LM_HASH_LEN 16
751 /* Password history contants. */
752 #define PW_HISTORY_SALT_LEN 16
753 #define SALTED_MD5_HASH_LEN 16
754 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
755 #define MAX_PW_HISTORY_LEN 24
758 * Flags for local user manipulation.
761 #define LOCAL_ADD_USER 0x1
762 #define LOCAL_DELETE_USER 0x2
763 #define LOCAL_DISABLE_USER 0x4
764 #define LOCAL_ENABLE_USER 0x8
765 #define LOCAL_TRUST_ACCOUNT 0x10
766 #define LOCAL_SET_NO_PASSWORD 0x20
767 #define LOCAL_SET_PASSWORD 0x40
768 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
769 #define LOCAL_INTERDOM_ACCOUNT 0x100
770 #define LOCAL_AM_ROOT 0x200 /* Act as root */
772 /* key and data in the connections database - used in smbstatus and smbd */
773 struct connections_key {
774 struct server_id pid;
779 struct connections_data {
781 struct server_id pid;
785 char servicename[FSTRING_LEN];
787 char machine[FSTRING_LEN];
791 * This field used to hold the msg_flags. For compatibility reasons,
792 * keep the data structure in the tdb file the same.
794 uint32 unused_compatitibility_field;
798 /* the following are used by loadparm for option lists */
800 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
801 P_STRING,P_USTRING,P_ENUM,P_SEP
805 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
818 bool (*special)(int snum, const char *, char **);
819 const struct enum_list *enum_list;
830 /* The following flags are used in SWAT */
831 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
832 #define FLAG_SHARE 0x0002 /* file sharing options */
833 #define FLAG_PRINT 0x0004 /* printing options */
834 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
835 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
836 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
837 #define FLAG_DEVELOPER 0x0040 /* No longer used */
838 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
839 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
840 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
841 #define FLAG_META 0x8000 /* A meta directive - not a real parameter */
842 #define FLAG_CMDLINE 0x10000 /* option has been overridden */
849 /* offsets into message for common items */
856 #define smb_pidhigh 16
857 #define smb_ss_field 18
883 /* flag defines. CIFS spec 3.1.1 */
884 #define FLAG_SUPPORT_LOCKREAD 0x01
885 #define FLAG_CLIENT_BUF_AVAIL 0x02
886 #define FLAG_RESERVED 0x04
887 #define FLAG_CASELESS_PATHNAMES 0x08
888 #define FLAG_CANONICAL_PATHNAMES 0x10
889 #define FLAG_REQUEST_OPLOCK 0x20
890 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
891 #define FLAG_REPLY 0x80
894 #define SMBmkdir 0x00 /* create directory */
895 #define SMBrmdir 0x01 /* delete directory */
896 #define SMBopen 0x02 /* open file */
897 #define SMBcreate 0x03 /* create file */
898 #define SMBclose 0x04 /* close file */
899 #define SMBflush 0x05 /* flush file */
900 #define SMBunlink 0x06 /* delete file */
901 #define SMBmv 0x07 /* rename file */
902 #define SMBgetatr 0x08 /* get file attributes */
903 #define SMBsetatr 0x09 /* set file attributes */
904 #define SMBread 0x0A /* read from file */
905 #define SMBwrite 0x0B /* write to file */
906 #define SMBlock 0x0C /* lock byte range */
907 #define SMBunlock 0x0D /* unlock byte range */
908 #define SMBctemp 0x0E /* create temporary file */
909 #define SMBmknew 0x0F /* make new file */
910 #define SMBcheckpath 0x10 /* check directory path */
911 #define SMBexit 0x11 /* process exit */
912 #define SMBlseek 0x12 /* seek */
913 #define SMBtcon 0x70 /* tree connect */
914 #define SMBtconX 0x75 /* tree connect and X*/
915 #define SMBtdis 0x71 /* tree disconnect */
916 #define SMBnegprot 0x72 /* negotiate protocol */
917 #define SMBdskattr 0x80 /* get disk attributes */
918 #define SMBsearch 0x81 /* search directory */
919 #define SMBsplopen 0xC0 /* open print spool file */
920 #define SMBsplwr 0xC1 /* write to print spool file */
921 #define SMBsplclose 0xC2 /* close print spool file */
922 #define SMBsplretq 0xC3 /* return print queue */
923 #define SMBsends 0xD0 /* send single block message */
924 #define SMBsendb 0xD1 /* send broadcast message */
925 #define SMBfwdname 0xD2 /* forward user name */
926 #define SMBcancelf 0xD3 /* cancel forward */
927 #define SMBgetmac 0xD4 /* get machine name */
928 #define SMBsendstrt 0xD5 /* send start of multi-block message */
929 #define SMBsendend 0xD6 /* send end of multi-block message */
930 #define SMBsendtxt 0xD7 /* send text of multi-block message */
933 #define SMBlockread 0x13 /* Lock a range and read */
934 #define SMBwriteunlock 0x14 /* Unlock a range then write */
935 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
936 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
937 #define SMBwritec 0x20 /* secondary write request */
938 #define SMBwriteclose 0x2c /* write a file then close it */
940 /* dos extended protocol */
941 #define SMBreadBraw 0x1A /* read block raw */
942 #define SMBreadBmpx 0x1B /* read block multiplexed */
943 #define SMBreadBs 0x1C /* read block (secondary response) */
944 #define SMBwriteBraw 0x1D /* write block raw */
945 #define SMBwriteBmpx 0x1E /* write block multiplexed */
946 #define SMBwriteBs 0x1F /* write block (secondary request) */
947 #define SMBwriteC 0x20 /* write complete response */
948 #define SMBsetattrE 0x22 /* set file attributes expanded */
949 #define SMBgetattrE 0x23 /* get file attributes expanded */
950 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
951 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
952 #define SMBtranss 0x26 /* transaction (secondary request/response) */
953 #define SMBioctl 0x27 /* IOCTL */
954 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
955 #define SMBcopy 0x29 /* copy */
956 #define SMBmove 0x2A /* move */
957 #define SMBecho 0x2B /* echo */
958 #define SMBopenX 0x2D /* open and X */
959 #define SMBreadX 0x2E /* read and X */
960 #define SMBwriteX 0x2F /* write and X */
961 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
962 #define SMBffirst 0x82 /* find first */
963 #define SMBfunique 0x83 /* find unique */
964 #define SMBfclose 0x84 /* find close */
965 #define SMBkeepalive 0x85 /* keepalive */
966 #define SMBinvalid 0xFE /* invalid command */
968 /* Extended 2.0 protocol */
969 #define SMBtrans2 0x32 /* TRANS2 protocol set */
970 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
971 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
972 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
973 #define SMBulogoffX 0x74 /* user logoff */
975 /* NT SMB extensions. */
976 #define SMBnttrans 0xA0 /* NT transact */
977 #define SMBnttranss 0xA1 /* NT transact secondary */
978 #define SMBntcreateX 0xA2 /* NT create and X */
979 #define SMBntcancel 0xA4 /* NT cancel */
980 #define SMBntrename 0xA5 /* NT rename */
982 /* These are the trans subcommands */
983 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
984 #define TRANSACT_DCERPCCMD 0x26
985 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
987 /* These are the TRANS2 sub commands */
988 #define TRANSACT2_OPEN 0x00
989 #define TRANSACT2_FINDFIRST 0x01
990 #define TRANSACT2_FINDNEXT 0x02
991 #define TRANSACT2_QFSINFO 0x03
992 #define TRANSACT2_SETFSINFO 0x04
993 #define TRANSACT2_QPATHINFO 0x05
994 #define TRANSACT2_SETPATHINFO 0x06
995 #define TRANSACT2_QFILEINFO 0x07
996 #define TRANSACT2_SETFILEINFO 0x08
997 #define TRANSACT2_FSCTL 0x09
998 #define TRANSACT2_IOCTL 0x0A
999 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1000 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1001 #define TRANSACT2_MKDIR 0x0D
1002 #define TRANSACT2_SESSION_SETUP 0x0E
1003 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1004 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1006 /* These are the NT transact sub commands. */
1007 #define NT_TRANSACT_CREATE 1
1008 #define NT_TRANSACT_IOCTL 2
1009 #define NT_TRANSACT_SET_SECURITY_DESC 3
1010 #define NT_TRANSACT_NOTIFY_CHANGE 4
1011 #define NT_TRANSACT_RENAME 5
1012 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1013 #define NT_TRANSACT_GET_USER_QUOTA 7
1014 #define NT_TRANSACT_SET_USER_QUOTA 8
1016 /* These are the NT transact_get_user_quota sub commands */
1017 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1018 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1019 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1021 /* Relevant IOCTL codes */
1022 #define IOCTL_QUERY_JOB_INFO 0x530060
1024 /* these are the trans2 sub fields for primary requests */
1025 #define smb_tpscnt smb_vwv0
1026 #define smb_tdscnt smb_vwv1
1027 #define smb_mprcnt smb_vwv2
1028 #define smb_mdrcnt smb_vwv3
1029 #define smb_msrcnt smb_vwv4
1030 #define smb_flags smb_vwv5
1031 #define smb_timeout smb_vwv6
1032 #define smb_pscnt smb_vwv9
1033 #define smb_psoff smb_vwv10
1034 #define smb_dscnt smb_vwv11
1035 #define smb_dsoff smb_vwv12
1036 #define smb_suwcnt smb_vwv13
1037 #define smb_setup smb_vwv14
1038 #define smb_setup0 smb_setup
1039 #define smb_setup1 (smb_setup+2)
1040 #define smb_setup2 (smb_setup+4)
1042 /* these are for the secondary requests */
1043 #define smb_spscnt smb_vwv2
1044 #define smb_spsoff smb_vwv3
1045 #define smb_spsdisp smb_vwv4
1046 #define smb_sdscnt smb_vwv5
1047 #define smb_sdsoff smb_vwv6
1048 #define smb_sdsdisp smb_vwv7
1049 #define smb_sfid smb_vwv8
1051 /* and these for responses */
1052 #define smb_tprcnt smb_vwv0
1053 #define smb_tdrcnt smb_vwv1
1054 #define smb_prcnt smb_vwv3
1055 #define smb_proff smb_vwv4
1056 #define smb_prdisp smb_vwv5
1057 #define smb_drcnt smb_vwv6
1058 #define smb_droff smb_vwv7
1059 #define smb_drdisp smb_vwv8
1061 /* these are for the NT trans primary request. */
1062 #define smb_nt_MaxSetupCount smb_vwv0
1063 #define smb_nt_Flags (smb_vwv0 + 1)
1064 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1065 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1066 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1067 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1068 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1069 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1070 #define smb_nt_DataCount (smb_vwv0 + 27)
1071 #define smb_nt_DataOffset (smb_vwv0 + 31)
1072 #define smb_nt_SetupCount (smb_vwv0 + 35)
1073 #define smb_nt_Function (smb_vwv0 + 36)
1074 #define smb_nt_SetupStart (smb_vwv0 + 38)
1076 /* these are for the NT trans secondary request. */
1077 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1078 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1079 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1080 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1081 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1082 #define smb_nts_DataCount (smb_vwv0 + 23)
1083 #define smb_nts_DataOffset (smb_vwv0 + 27)
1084 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1086 /* these are for the NT trans reply. */
1087 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1088 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1089 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1090 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1091 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1092 #define smb_ntr_DataCount (smb_vwv0 + 23)
1093 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1094 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1096 /* these are for the NT create_and_X */
1097 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1098 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1099 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1100 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1101 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1102 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1103 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1104 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1105 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1106 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1107 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1109 /* this is used on a TConX. I'm not sure the name is very helpful though */
1110 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1111 #define SMB_SHARE_IN_DFS 0x0002
1113 /* Named pipe write mode flags. Used in writeX calls. */
1114 #define PIPE_RAW_MODE 0x4
1115 #define PIPE_START_MESSAGE 0x8
1117 /* the desired access to use when opening a pipe */
1118 #define DESIRED_ACCESS_PIPE 0x2019f
1120 /* Mapping of access rights to UNIX perms. */
1121 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1122 #define UNIX_ACCESS_R FILE_GENERIC_READ
1123 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1124 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1126 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1127 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1128 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1129 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1130 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1134 * This is the old mapping we used to use. To get W2KSP2 profiles
1135 * working we need to map to the canonical file perms.
1137 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1138 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1139 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1140 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1141 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1142 FILE_APPEND_DATA|FILE_WRITE_DATA)
1143 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1144 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1147 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1150 #define REQUEST_OPLOCK 2
1151 #define REQUEST_BATCH_OPLOCK 4
1152 #define OPEN_DIRECTORY 8
1153 #define EXTENDED_RESPONSE_REQUIRED 0x10
1155 /* ShareAccess field. */
1156 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1157 #define FILE_SHARE_READ 1
1158 #define FILE_SHARE_WRITE 2
1159 #define FILE_SHARE_DELETE 4
1161 /* FileAttributesField */
1162 #define FILE_ATTRIBUTE_READONLY 0x001L
1163 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1164 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1165 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1166 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1167 #define FILE_ATTRIBUTE_NORMAL 0x080L
1168 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1169 #define FILE_ATTRIBUTE_SPARSE 0x200L
1170 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1171 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1172 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1173 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1174 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1175 #define SAMBA_ATTRIBUTES_MASK (FILE_ATTRIBUTE_READONLY|\
1176 FILE_ATTRIBUTE_HIDDEN|\
1177 FILE_ATTRIBUTE_SYSTEM|\
1178 FILE_ATTRIBUTE_DIRECTORY|\
1179 FILE_ATTRIBUTE_ARCHIVE)
1181 /* Flags - combined with attributes. */
1182 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1183 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1184 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1185 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1186 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1187 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1188 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1190 /* CreateDisposition field. */
1191 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1192 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1193 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1194 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1195 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1196 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1198 /* CreateOptions field. */
1199 #define FILE_DIRECTORY_FILE 0x0001
1200 #define FILE_WRITE_THROUGH 0x0002
1201 #define FILE_SEQUENTIAL_ONLY 0x0004
1202 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1203 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
1204 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
1205 #define FILE_NON_DIRECTORY_FILE 0x0040
1206 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
1207 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
1208 #define FILE_NO_EA_KNOWLEDGE 0x0200
1209 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1210 #define FILE_RANDOM_ACCESS 0x0800
1211 #define FILE_DELETE_ON_CLOSE 0x1000
1212 #define FILE_OPEN_BY_FILE_ID 0x2000
1213 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
1214 #define FILE_NO_COMPRESSION 0x8000
1215 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
1216 #define FILE_OPEN_REPARSE_POINT 0x00200000
1217 #define FILE_OPEN_NO_RECALL 0x00400000
1218 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1220 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1222 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1225 * Private create options used by the ntcreatex processing code. From Samba4.
1226 * We reuse some ignored flags for private use. Passed in the private_flags
1229 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
1230 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
1232 /* Private options for streams support */
1233 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1235 /* Private options for printer support */
1236 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1238 /* Responses when opening a file. */
1239 #define FILE_WAS_SUPERSEDED 0
1240 #define FILE_WAS_OPENED 1
1241 #define FILE_WAS_CREATED 2
1242 #define FILE_WAS_OVERWRITTEN 3
1244 /* File type flags */
1245 #define FILE_TYPE_DISK 0
1246 #define FILE_TYPE_BYTE_MODE_PIPE 1
1247 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1248 #define FILE_TYPE_PRINTER 3
1249 #define FILE_TYPE_COMM_DEVICE 4
1250 #define FILE_TYPE_UNKNOWN 0xFFFF
1252 /* Flag for NT transact rename call. */
1253 #define RENAME_REPLACE_IF_EXISTS 1
1255 /* flags for SMBntrename call (from Samba4) */
1256 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1257 #define RENAME_FLAG_HARD_LINK 0x103
1258 #define RENAME_FLAG_RENAME 0x104
1259 #define RENAME_FLAG_COPY 0x105
1261 /* Filesystem Attributes. */
1262 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1263 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1264 #define FILE_UNICODE_ON_DISK 0x00000004
1265 /* According to cifs9f, this is 4, not 8 */
1266 /* Acconding to testing, this actually sets the security attribute! */
1267 #define FILE_PERSISTENT_ACLS 0x00000008
1268 #define FILE_FILE_COMPRESSION 0x00000010
1269 #define FILE_VOLUME_QUOTAS 0x00000020
1270 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1271 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1272 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1273 #define FS_LFN_APIS 0x00004000
1274 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1275 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1276 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1277 #define FILE_NAMED_STREAMS 0x00040000
1278 #define FILE_READ_ONLY_VOLUME 0x00080000
1280 /* ChangeNotify flags. */
1281 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1282 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1283 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1284 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1285 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1286 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1287 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1288 #define FILE_NOTIFY_CHANGE_EA 0x080
1289 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1290 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1291 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1292 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1294 #define FILE_NOTIFY_CHANGE_NAME \
1295 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1297 /* change notify action results */
1298 #define NOTIFY_ACTION_ADDED 1
1299 #define NOTIFY_ACTION_REMOVED 2
1300 #define NOTIFY_ACTION_MODIFIED 3
1301 #define NOTIFY_ACTION_OLD_NAME 4
1302 #define NOTIFY_ACTION_NEW_NAME 5
1303 #define NOTIFY_ACTION_ADDED_STREAM 6
1304 #define NOTIFY_ACTION_REMOVED_STREAM 7
1305 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1308 /* where to find the base of the SMB packet proper */
1309 #define smb_base(buf) (((char *)(buf))+4)
1311 /* we don't allow server strings to be longer than 48 characters as
1312 otherwise NT will not honour the announce packets */
1313 #define MAX_SERVER_STRING_LENGTH 48
1316 #define SMB_SUCCESS 0 /* The request was successful. */
1319 void dfs_unlogin(void);
1320 extern int dcelogin_atmost_once;
1324 char *strdup(char *s);
1331 /* This was set by JHT in liaison with Jeremy Allison early 1997
1333 * Version 4.0 - never made public
1334 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1335 * - Reappeared in 1.9.16p11 with fixed smbd services
1336 * Version 4.20 - To indicate that nmbd and browsing now works better
1337 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1339 * Note: In the presence of NT4.X do not set above 4.9
1340 * Setting this above 4.9 can have undesired side-effects.
1341 * This may change again in Samba-3.0 after further testing. JHT
1344 #define DEFAULT_MAJOR_VERSION 0x04
1345 #define DEFAULT_MINOR_VERSION 0x09
1347 /* Browser Election Values */
1348 #define BROWSER_ELECTION_VERSION 0x010f
1349 #define BROWSER_CONSTANT 0xaa55
1351 /* Sercurity mode bits. */
1352 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1353 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1354 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1355 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1357 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1359 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1360 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1361 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1362 #define FLAGS2_UNKNOWN_BIT4 0x0010
1363 #define FLAGS2_IS_LONG_NAME 0x0040
1364 #define FLAGS2_EXTENDED_SECURITY 0x0800
1365 #define FLAGS2_DFS_PATHNAMES 0x1000
1366 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1367 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1368 #define FLAGS2_UNICODE_STRINGS 0x8000
1370 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1372 /* TCONX Flag (smb_vwv2). */
1373 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1375 /* File Status Flags. See:
1377 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1381 #define NO_SUBSTREAMS 0x2
1382 #define NO_REPARSETAG 0x4
1384 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1386 #define CAP_RAW_MODE 0x0001
1387 #define CAP_MPX_MODE 0x0002
1388 #define CAP_UNICODE 0x0004
1389 #define CAP_LARGE_FILES 0x0008
1390 #define CAP_NT_SMBS 0x0010
1391 #define CAP_RPC_REMOTE_APIS 0x0020
1392 #define CAP_STATUS32 0x0040
1393 #define CAP_LEVEL_II_OPLOCKS 0x0080
1394 #define CAP_LOCK_AND_READ 0x0100
1395 #define CAP_NT_FIND 0x0200
1396 #define CAP_DFS 0x1000
1397 #define CAP_W2K_SMBS 0x2000
1398 #define CAP_LARGE_READX 0x4000
1399 #define CAP_LARGE_WRITEX 0x8000
1400 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1401 #define CAP_EXTENDED_SECURITY 0x80000000
1403 /* protocol types. It assumes that higher protocols include lower protocols
1405 enum protocol_types {
1415 /* security levels */
1416 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1426 /* printing types */
1427 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1428 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1429 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1430 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1431 ,PRINT_TEST,PRINT_VLP
1432 #endif /* DEVELOPER */
1435 /* LDAP schema types */
1436 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1438 /* LDAP SSL options */
1439 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1441 /* LDAP PASSWD SYNC methods */
1442 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1445 * This should be under the HAVE_KRB5 flag but since they're used
1446 * in lp_kerberos_method(), they ned to be always available
1447 * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
1448 * so they remain accurate.
1451 #define KERBEROS_VERIFY_SECRETS 0
1452 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1453 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1454 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1456 /* Remote architectures we know about. */
1457 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1458 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1459 RA_SAMBA, RA_CIFSFS, RA_WINXP64};
1462 enum case_handling {CASE_LOWER,CASE_UPPER};
1464 /* ACL compatibility */
1465 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1467 * Global value meaing that the smb_uid field should be
1468 * ingored (in share level security and protocol level == CORE)
1471 #define UID_FIELD_INVALID 0
1472 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1475 * Size of buffer to use when moving files across filesystems.
1477 #define COPYBUF_SIZE (8*1024)
1480 * Map the Core and Extended Oplock requesst bits down
1481 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1487 #define CORE_OPLOCK_REQUEST(inbuf) \
1488 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1491 * Extended protocol.
1493 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1496 #define LOCKING_ANDX_SHARED_LOCK 0x1
1497 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1498 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1499 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1500 #define LOCKING_ANDX_LARGE_FILES 0x10
1503 * Bits we test with.
1504 * Note these must fit into 16-bits.
1507 #define NO_OPLOCK 0x0
1508 #define EXCLUSIVE_OPLOCK 0x1
1509 #define BATCH_OPLOCK 0x2
1510 #define LEVEL_II_OPLOCK 0x4
1512 /* The following are Samba-private. */
1513 #define INTERNAL_OPEN_ONLY 0x8
1514 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1515 * inform potential level2 holders on
1517 #define DEFERRED_OPEN_ENTRY 0x20
1518 #define UNUSED_SHARE_MODE_ENTRY 0x40
1519 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1521 /* None of the following should ever appear in fsp->oplock_request. */
1522 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1524 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1525 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1526 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1528 /* kernel_oplock_message definition.
1530 struct kernel_oplock_message {
1534 unsigned long file_id;
1538 0 uint64_t dev 8 bytes
1539 8 uint64_t inode 8 bytes
1540 16 uint64_t extid 8 bytes
1541 24 unsigned long file_id 4 bytes
1545 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1547 /* file_renamed_message definition.
1549 struct file_renamed_message {
1552 char names[1]; A variable area containing sharepath and filename.
1556 0 uint64_t dev 8 bytes
1557 8 uint64_t inode 8 bytes
1558 16 unit64_t extid 8 bytes
1559 24 char [] name zero terminated namelen bytes
1560 minimum length == 24.
1564 #define MSG_FILE_RENAMED_MIN_SIZE 24
1567 * On the wire return values for oplock types.
1570 #define CORE_OPLOCK_GRANTED (1<<5)
1571 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1573 #define NO_OPLOCK_RETURN 0
1574 #define EXCLUSIVE_OPLOCK_RETURN 1
1575 #define BATCH_OPLOCK_RETURN 2
1576 #define LEVEL_II_OPLOCK_RETURN 3
1579 #define OPLOCKLEVEL_NONE 0
1580 #define OPLOCKLEVEL_II 1
1583 * Capabilities abstracted for different systems.
1586 enum smbd_capability {
1587 KERNEL_OPLOCK_CAPABILITY,
1588 DMAPI_ACCESS_CAPABILITY,
1593 * Kernel oplocks capability flags.
1596 /* Level 2 oplocks are supported natively by kernel oplocks. */
1597 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1599 /* The kernel notifies deferred openers when they can retry the open. */
1600 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1602 /* The kernel notifies smbds when an oplock break times out. */
1603 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1605 /* The kernel notifies smbds when an oplock is broken. */
1606 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1608 struct kernel_oplocks_ops;
1609 struct kernel_oplocks {
1610 const struct kernel_oplocks_ops *ops;
1615 enum level2_contention_type {
1616 LEVEL2_CONTEND_ALLOC_SHRINK,
1617 LEVEL2_CONTEND_ALLOC_GROW,
1618 LEVEL2_CONTEND_SET_FILE_LEN,
1619 LEVEL2_CONTEND_FILL_SPARSE,
1620 LEVEL2_CONTEND_WRITE,
1621 LEVEL2_CONTEND_WINDOWS_BRL,
1622 LEVEL2_CONTEND_POSIX_BRL
1625 /* if a kernel does support oplocks then a structure of the following
1626 typee is used to describe how to interact with the kernel */
1627 struct kernel_oplocks_ops {
1628 bool (*set_oplock)(struct kernel_oplocks *ctx,
1629 files_struct *fsp, int oplock_type);
1630 void (*release_oplock)(struct kernel_oplocks *ctx,
1631 files_struct *fsp, int oplock_type);
1632 void (*contend_level2_oplocks_begin)(files_struct *fsp,
1633 enum level2_contention_type type);
1634 void (*contend_level2_oplocks_end)(files_struct *fsp,
1635 enum level2_contention_type type);
1638 #include "smb_macros.h"
1640 #define MAX_NETBIOSNAME_LEN 16
1641 /* DOS character, NetBIOS namestring. Type used on the wire. */
1642 typedef char nstring[MAX_NETBIOSNAME_LEN];
1643 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1644 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1646 /* A netbios name structure. */
1650 unsigned int name_type;
1653 /* A netbios node status array element. */
1654 struct node_status {
1657 unsigned char flags;
1660 /* The extra info from a NetBIOS node status query */
1661 struct node_status_extra {
1662 unsigned char mac_addr[6];
1663 /* There really is more here ... */
1666 typedef struct user_struct {
1667 struct user_struct *next, *prev;
1668 uint16 vuid; /* Tag for this entry. */
1670 char *session_keystr; /* used by utmp and pam session code.
1674 struct auth_serversupplied_info *session_info;
1676 struct auth_ntlmssp_state *auth_ntlmssp_state;
1679 struct unix_error_map {
1687 * Size of new password account encoding string. This is enough space to
1688 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1689 * Do not change unless you are adding new ACB bits!
1692 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1695 Do you want session setups at user level security with a invalid
1696 password to be rejected or allowed in as guest? WinNT rejects them
1697 but it can be a pain as it means "net view" needs to use a password
1699 You have 3 choices in the setting of map_to_guest:
1701 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1702 are rejected. This is the default.
1704 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1705 are rejected, unless the username does not exist, in which case it
1706 is treated as a guest login
1708 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1709 are treated as a guest login
1711 Note that map_to_guest only has an effect in user or server
1715 #define NEVER_MAP_TO_GUEST 0
1716 #define MAP_TO_GUEST_ON_BAD_USER 1
1717 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1718 #define MAP_TO_GUEST_ON_BAD_UID 3
1720 #define SAFE_NETBIOS_CHARS ". -_"
1722 /* The maximum length of a trust account password.
1723 Used when we randomly create it, 15 char passwords
1724 exceed NT4's max password length */
1726 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1730 #define LDAP_PORT 389
1732 #define LDAP_GC_PORT 3268
1734 /* used by the IP comparison function */
1736 struct sockaddr_storage ss;
1747 struct ea_list *next, *prev;
1748 struct ea_struct ea;
1751 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1752 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1753 /* EA to use for DOS attributes */
1754 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1755 /* Prefix for DosStreams in the vfs_streams_xattr module */
1756 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1757 /* Prefix for xattrs storing streams. */
1758 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1760 /* map readonly options */
1761 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1763 /* usershare error codes. */
1764 enum usershare_err {
1766 USERSHARE_MALFORMED_FILE,
1767 USERSHARE_BAD_VERSION,
1768 USERSHARE_MALFORMED_PATH,
1769 USERSHARE_MALFORMED_COMMENT_DEF,
1770 USERSHARE_MALFORMED_ACL_DEF,
1772 USERSHARE_PATH_NOT_ABSOLUTE,
1773 USERSHARE_PATH_IS_DENIED,
1774 USERSHARE_PATH_NOT_ALLOWED,
1775 USERSHARE_PATH_NOT_DIRECTORY,
1776 USERSHARE_POSIX_ERR,
1777 USERSHARE_MALFORMED_SHARENAME_DEF,
1778 USERSHARE_BAD_SHARENAME
1781 /* Different reasons for closing a file. */
1782 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1784 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1785 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1786 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1787 struct smb_extended_info {
1788 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1789 uint32 samba_version; /* Major/Minor/Release/Revision */
1790 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1791 NTTIME samba_gitcommitdate;
1792 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1796 struct smb_file_time {
1797 struct timespec mtime;
1798 struct timespec atime;
1799 struct timespec ctime;
1800 struct timespec create_time;
1804 * unix_convert_flags
1806 #define UCF_SAVE_LCOMP 0x00000001
1807 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1808 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1809 #define UCF_POSIX_PATHNAMES 0x00000008
1814 struct smb_filename {
1817 char *original_lcomp;
1821 /* struct for maintaining the child processes that get spawned from smbd */
1823 struct child_pid *prev, *next;
1827 /* Used to keep track of deferred opens. */
1828 struct deferred_open_record;
1830 /* Client-side offline caching policy types */
1831 #define CSC_POLICY_MANUAL 0
1832 #define CSC_POLICY_DOCUMENTS 1
1833 #define CSC_POLICY_PROGRAMS 2
1834 #define CSC_POLICY_DISABLE 3
1836 /* Used inside aio code. */