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 */
146 #define PIPE_LANMAN "\\PIPE\\LANMAN"
148 #define MAX_HOURS_LEN 32
151 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
154 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
156 #define LOOKUP_NAME_NONE 0x00000000
157 #define LOOKUP_NAME_ISOLATED 0x00000001 /* Look up unqualified names */
158 #define LOOKUP_NAME_REMOTE 0x00000002 /* Ask others */
159 #define LOOKUP_NAME_GROUP 0x00000004 /* (unused) This is a NASTY hack for
160 valid users = @foo where foo also
161 exists in as user. */
162 #define LOOKUP_NAME_NO_NSS 0x00000008 /* no NSS calls to avoid
163 winbind recursions */
164 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
165 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
166 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
167 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
168 |LOOKUP_NAME_BUILTIN\
171 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
173 |LOOKUP_NAME_BUILTIN\
177 #include "librpc/gen_ndr/epmapper.h"
178 #include "librpc/gen_ndr/dcerpc.h"
179 #include "librpc/gen_ndr/security.h"
181 struct lsa_dom_info {
189 struct lsa_name_info {
191 enum lsa_SidType type;
197 * The complete list of SIDS belonging to this user.
198 * Created when a vuid is registered.
199 * The definition of the user_sids array is as follows :
201 * token->user_sids[0] = primary user SID.
202 * token->user_sids[1] = primary group SID.
203 * token->user_sids[2..num_sids] = supplementary group SIDS.
206 #define PRIMARY_USER_SID_INDEX 0
207 #define PRIMARY_GROUP_SID_INDEX 1
209 typedef struct unix_user_token {
216 typedef struct write_cache {
227 uint64_t position_information;
229 uint32 private_options; /* NT Create options, but we only look at
230 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
231 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
232 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
233 * for print files *only*, where
234 * DELETE_ON_CLOSE is not stored in the share
237 unsigned long gen_id;
241 struct share_mode_entry;
245 struct rpc_cli_smbd_conn;
246 struct fncall_context;
248 struct vfs_fsp_data {
249 struct vfs_fsp_data *next;
250 struct vfs_handle_struct *owner;
251 void (*destroy)(void *p_data);
253 /* NOTE: This structure contains four pointers so that we can guarantee
254 * that the end of the structure is always both 4-byte and 8-byte aligned.
258 /* the basic packet size, assuming no words or bytes */
261 struct notify_change {
266 struct notify_mid_map;
269 struct notify_change_request;
270 struct sys_notify_backend;
271 struct sys_notify_context {
272 struct event_context *ev;
273 struct connection_struct *conn;
274 void *private_data; /* For use by the system backend */
277 struct notify_change_buf {
279 * If no requests are pending, changes are queued here. Simple array,
284 * num_changes == -1 means that we have got a catch-all change, when
285 * asked we just return NT_STATUS_OK without specific changes.
288 struct notify_change *changes;
291 * If no changes are around requests are queued here. Using a linked
292 * list, because we have to append at the end and delete from the top.
294 struct notify_change_request *requests;
297 struct print_file_data {
301 struct policy_handle handle;
306 typedef struct files_struct {
307 struct files_struct *next, *prev;
309 struct connection_struct *conn;
310 struct fd_handle *fh;
311 unsigned int num_smb_operations;
312 struct file_id file_id;
313 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
318 struct timeval open_time;
319 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
320 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
322 bool update_write_time_triggered;
323 struct timed_event *update_write_time_event;
324 bool update_write_time_on_close;
325 struct timespec close_write_time;
326 bool write_time_forced;
329 int sent_oplock_break;
330 struct timed_event *oplock_timeout;
331 struct lock_struct last_lock_failure;
332 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
334 struct share_mode_entry *pending_break_messages;
335 int num_pending_break_messages;
342 bool aio_write_behind;
344 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
345 bool delete_on_close;
348 struct smb_filename *fsp_name;
349 uint32_t name_hash; /* Jenkins hash of full pathname. */
351 struct vfs_fsp_data *vfs_extension;
352 struct fake_file_handle *fake_file_handle;
354 struct notify_change_buf *notify;
356 struct files_struct *base_fsp; /* placeholder for delete on close */
359 * Read-only cached brlock record, thrown away when the
360 * brlock.tdb seqnum changes. This avoids fetching data from
361 * the brlock.tdb on every read/write call.
364 struct byte_range_lock *brlock_rec;
366 struct dptr_struct *dptr;
368 /* if not NULL, means this is a print file */
369 struct print_file_data *print_file;
373 #include "ntquotas.h"
374 #include "sysquotas.h"
376 struct client_address {
377 char addr[INET6_ADDRSTRLEN];
381 struct vuid_cache_entry {
382 struct auth_serversupplied_info *server_info;
388 unsigned int next_entry;
389 struct vuid_cache_entry array[VUID_CACHE_SIZE];
395 } name_compare_entry;
398 struct trans_state *next, *prev;
402 uint32 max_param_return;
403 uint32 max_data_return;
404 uint32 max_setup_return;
406 uint8 cmd; /* SMBtrans or SMBtrans2 */
408 char *name; /* for trans requests */
409 uint16 call; /* for trans2 and nttrans requests */
411 bool close_on_completion;
414 unsigned int setup_count;
417 size_t received_data;
418 size_t received_param;
428 * Info about an alternate data stream
431 struct stream_struct {
433 SMB_OFF_T alloc_size;
437 /* Include VFS stuff */
439 #include "smb_acls.h"
442 struct dfree_cached_info {
443 time_t last_dfree_time;
452 struct share_params {
456 struct share_iterator {
460 typedef struct connection_struct {
461 struct connection_struct *next, *prev;
462 struct smbd_server_connection *sconn; /* can be NULL */
463 unsigned cnum; /* an index passed over the wire */
464 struct share_params *params;
466 struct vuid_cache vuid_cache;
469 bool read_only; /* Attributes for the current user of the share. */
470 /* Does this filesystem honor
471 sub second timestamps on files
472 and directories when setting time ? */
473 enum timestamp_set_resolution ts_res;
477 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
480 * This represents the user information on this connection. Depending
481 * on the vuid using this tid, this might change per SMB request.
483 struct auth_serversupplied_info *server_info;
486 * If the "force group" parameter is set, this is the primary gid that
487 * may be used in the users token, depending on the vuid using this tid.
489 gid_t force_group_gid;
491 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
494 time_t lastused_count;
497 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
501 /* Semantics requested by the client or forced by the server config. */
504 bool short_case_preserve;
506 /* Semantics provided by the underlying filesystem. */
508 /* Device number of the directory of the share mount.
509 Used to ensure unique FileIndex returns. */
510 SMB_DEV_T base_share_dev;
512 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
513 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
514 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
515 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
516 struct dfree_cached_info *dfree_info;
517 struct trans_state *pending_trans;
518 struct notify_context *notify_ctx;
520 struct rpc_pipe_client *spoolss_pipe;
524 struct current_user {
525 connection_struct *conn;
528 struct security_token *nt_user_token;
531 struct smbd_smb2_request;
537 uint64_t mid; /* For compatibility with SMB2. */
548 * Async handling in the main smb processing loop is directed by
549 * outbuf: reply_xxx routines indicate sync behaviour by putting their
550 * reply into "outbuf". If they leave it as NULL, they take of it
551 * themselves, possibly later.
553 * If async handling is wanted, the reply_xxx routine must make sure
554 * that it talloc_move()s the smb_req somewhere else.
560 connection_struct *conn;
561 struct smbd_server_connection *sconn;
562 struct smb_perfcount_data pcd;
565 * Chained request handling
567 struct files_struct *chain_fsp;
570 * Here we collect the outbufs from the chain handlers
572 uint8_t *chain_outbuf;
575 * state information for async smb handling
582 * Back pointer to smb2 request.
584 struct smbd_smb2_request *smb2req;
587 /* Defines for the sent_oplock_break field above. */
588 #define NO_BREAK_SENT 0
589 #define BREAK_TO_NONE_SENT 1
590 #define LEVEL_II_BREAK_SENT 2
593 fstring smb_name; /* user name from the client */
594 fstring unix_name; /* unix user name of a validated user */
595 fstring domain; /* domain that the client specified */
598 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
612 LPQ_USER_INTERVENTION,
614 /* smbd is dooing the file spooling before passing control to spoolss */
618 typedef struct _print_queue_struct {
619 int job; /* normally the UNIX jobid -- see note in
620 printing.c:traverse_fn_delete() */
628 } print_queue_struct;
630 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
636 } print_status_struct;
638 /* used for server information: client, nameserv and ipc */
639 struct server_info_struct {
643 fstring domain; /* used ONLY in ipc.c NOT namework.c */
644 bool server_added; /* used ONLY in ipc.c NOT namework.c */
647 /* used for network interfaces */
649 struct interface *next, *prev;
652 struct sockaddr_storage ip;
653 struct sockaddr_storage netmask;
654 struct sockaddr_storage bcast;
657 /* Internal message queue for deferred opens. */
658 struct pending_message_list {
659 struct pending_message_list *next, *prev;
660 struct timeval request_time; /* When was this first issued? */
661 struct timed_event *te;
662 struct smb_perfcount_data pcd;
667 DATA_BLOB private_data;
670 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
672 /* struct returned by get_share_modes */
673 struct share_mode_entry {
674 struct server_id pid;
675 uint64_t op_mid; /* For compatibility with SMB2 opens. */
677 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
678 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
679 uint32 private_options; /* NT Create options, but we only look at
680 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
681 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
682 * smbstatus and swat */
685 unsigned long share_file_id;
686 uint32 uid; /* uid of file opener. */
687 uint16 flags; /* See SHARE_MODE_XX above. */
690 /* oplock break message definition - linearization of share_mode_entry.
693 0 struct server_id pid 4
696 14 uint32 access_mask 4
697 18 uint32 share_access 4
698 22 uint32 private_options 4
700 30 uint32 time usec 4
701 34 uint64 dev 8 bytes
702 42 uint64 inode 8 bytes
703 50 uint64 extid 8 bytes
704 58 unsigned long file_id 4 bytes
705 62 uint32 uid 4 bytes
706 66 uint16 flags 2 bytes
711 #define OP_BREAK_MSG_PID_OFFSET 0
712 #define OP_BREAK_MSG_MID_OFFSET 4
713 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
714 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
715 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
716 #define OP_BREAK_MSG_PRIV_OFFSET 22
717 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
718 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
719 #define OP_BREAK_MSG_DEV_OFFSET 34
720 #define OP_BREAK_MSG_INO_OFFSET 42
721 #define OP_BREAK_MSG_EXTID_OFFSET 50
722 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
723 #define OP_BREAK_MSG_UID_OFFSET 62
724 #define OP_BREAK_MSG_FLAGS_OFFSET 66
726 #ifdef CLUSTER_SUPPORT
727 #define OP_BREAK_MSG_VNN_OFFSET 68
728 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 72
730 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 68
733 struct share_mode_lock {
734 const char *servicepath; /* canonicalized. */
735 const char *base_name;
736 const char *stream_name;
739 struct share_mode_entry *share_modes;
740 UNIX_USER_TOKEN *delete_token;
741 bool delete_on_close;
742 struct timespec old_write_time;
743 struct timespec changed_write_time;
746 struct db_record *record;
750 * Internal structure of locking.tdb share mode db.
751 * Used by locking.c and libsmbsharemodes.c
754 struct locking_data {
757 int num_share_mode_entries;
758 bool delete_on_close;
759 struct timespec old_write_time;
760 struct timespec changed_write_time;
761 uint32 delete_token_size; /* Only valid if either of
762 the two previous fields
765 struct share_mode_entry dummy; /* Needed for alignment. */
767 /* The following four entries are implicit
768 struct share_mode_entry modes[num_share_mode_entries];
769 char unix_token[delete_token_size] (divisible by 4).
775 /* Used to store pipe open records for NetFileEnum() */
777 struct pipe_open_rec {
778 struct server_id pid;
785 #define NT_HASH_LEN 16
786 #define LM_HASH_LEN 16
788 /* Password history contants. */
789 #define PW_HISTORY_SALT_LEN 16
790 #define SALTED_MD5_HASH_LEN 16
791 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
792 #define MAX_PW_HISTORY_LEN 24
795 * Flags for local user manipulation.
798 #define LOCAL_ADD_USER 0x1
799 #define LOCAL_DELETE_USER 0x2
800 #define LOCAL_DISABLE_USER 0x4
801 #define LOCAL_ENABLE_USER 0x8
802 #define LOCAL_TRUST_ACCOUNT 0x10
803 #define LOCAL_SET_NO_PASSWORD 0x20
804 #define LOCAL_SET_PASSWORD 0x40
805 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
806 #define LOCAL_INTERDOM_ACCOUNT 0x100
807 #define LOCAL_AM_ROOT 0x200 /* Act as root */
809 /* key and data in the connections database - used in smbstatus and smbd */
810 struct connections_key {
811 struct server_id pid;
816 struct connections_data {
818 struct server_id pid;
822 char servicename[FSTRING_LEN];
824 char machine[FSTRING_LEN];
828 * This field used to hold the msg_flags. For compatibility reasons,
829 * keep the data structure in the tdb file the same.
831 uint32 unused_compatitibility_field;
835 /* the following are used by loadparm for option lists */
837 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
838 P_STRING,P_USTRING,P_ENUM,P_SEP
842 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
855 bool (*special)(int snum, const char *, char **);
856 const struct enum_list *enum_list;
867 /* The following flags are used in SWAT */
868 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
869 #define FLAG_SHARE 0x0002 /* file sharing options */
870 #define FLAG_PRINT 0x0004 /* printing options */
871 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
872 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
873 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
874 #define FLAG_DEVELOPER 0x0040 /* No longer used */
875 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
876 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
877 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
878 #define FLAG_META 0x8000 /* A meta directive - not a real parameter */
879 #define FLAG_CMDLINE 0x10000 /* option has been overridden */
886 /* offsets into message for common items */
893 #define smb_pidhigh 16
894 #define smb_ss_field 18
920 /* flag defines. CIFS spec 3.1.1 */
921 #define FLAG_SUPPORT_LOCKREAD 0x01
922 #define FLAG_CLIENT_BUF_AVAIL 0x02
923 #define FLAG_RESERVED 0x04
924 #define FLAG_CASELESS_PATHNAMES 0x08
925 #define FLAG_CANONICAL_PATHNAMES 0x10
926 #define FLAG_REQUEST_OPLOCK 0x20
927 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
928 #define FLAG_REPLY 0x80
931 #define SMBmkdir 0x00 /* create directory */
932 #define SMBrmdir 0x01 /* delete directory */
933 #define SMBopen 0x02 /* open file */
934 #define SMBcreate 0x03 /* create file */
935 #define SMBclose 0x04 /* close file */
936 #define SMBflush 0x05 /* flush file */
937 #define SMBunlink 0x06 /* delete file */
938 #define SMBmv 0x07 /* rename file */
939 #define SMBgetatr 0x08 /* get file attributes */
940 #define SMBsetatr 0x09 /* set file attributes */
941 #define SMBread 0x0A /* read from file */
942 #define SMBwrite 0x0B /* write to file */
943 #define SMBlock 0x0C /* lock byte range */
944 #define SMBunlock 0x0D /* unlock byte range */
945 #define SMBctemp 0x0E /* create temporary file */
946 #define SMBmknew 0x0F /* make new file */
947 #define SMBcheckpath 0x10 /* check directory path */
948 #define SMBexit 0x11 /* process exit */
949 #define SMBlseek 0x12 /* seek */
950 #define SMBtcon 0x70 /* tree connect */
951 #define SMBtconX 0x75 /* tree connect and X*/
952 #define SMBtdis 0x71 /* tree disconnect */
953 #define SMBnegprot 0x72 /* negotiate protocol */
954 #define SMBdskattr 0x80 /* get disk attributes */
955 #define SMBsearch 0x81 /* search directory */
956 #define SMBsplopen 0xC0 /* open print spool file */
957 #define SMBsplwr 0xC1 /* write to print spool file */
958 #define SMBsplclose 0xC2 /* close print spool file */
959 #define SMBsplretq 0xC3 /* return print queue */
960 #define SMBsends 0xD0 /* send single block message */
961 #define SMBsendb 0xD1 /* send broadcast message */
962 #define SMBfwdname 0xD2 /* forward user name */
963 #define SMBcancelf 0xD3 /* cancel forward */
964 #define SMBgetmac 0xD4 /* get machine name */
965 #define SMBsendstrt 0xD5 /* send start of multi-block message */
966 #define SMBsendend 0xD6 /* send end of multi-block message */
967 #define SMBsendtxt 0xD7 /* send text of multi-block message */
970 #define SMBlockread 0x13 /* Lock a range and read */
971 #define SMBwriteunlock 0x14 /* Unlock a range then write */
972 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
973 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
974 #define SMBwritec 0x20 /* secondary write request */
975 #define SMBwriteclose 0x2c /* write a file then close it */
977 /* dos extended protocol */
978 #define SMBreadBraw 0x1A /* read block raw */
979 #define SMBreadBmpx 0x1B /* read block multiplexed */
980 #define SMBreadBs 0x1C /* read block (secondary response) */
981 #define SMBwriteBraw 0x1D /* write block raw */
982 #define SMBwriteBmpx 0x1E /* write block multiplexed */
983 #define SMBwriteBs 0x1F /* write block (secondary request) */
984 #define SMBwriteC 0x20 /* write complete response */
985 #define SMBsetattrE 0x22 /* set file attributes expanded */
986 #define SMBgetattrE 0x23 /* get file attributes expanded */
987 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
988 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
989 #define SMBtranss 0x26 /* transaction (secondary request/response) */
990 #define SMBioctl 0x27 /* IOCTL */
991 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
992 #define SMBcopy 0x29 /* copy */
993 #define SMBmove 0x2A /* move */
994 #define SMBecho 0x2B /* echo */
995 #define SMBopenX 0x2D /* open and X */
996 #define SMBreadX 0x2E /* read and X */
997 #define SMBwriteX 0x2F /* write and X */
998 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
999 #define SMBffirst 0x82 /* find first */
1000 #define SMBfunique 0x83 /* find unique */
1001 #define SMBfclose 0x84 /* find close */
1002 #define SMBkeepalive 0x85 /* keepalive */
1003 #define SMBinvalid 0xFE /* invalid command */
1005 /* Extended 2.0 protocol */
1006 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1007 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1008 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1009 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1010 #define SMBulogoffX 0x74 /* user logoff */
1012 /* NT SMB extensions. */
1013 #define SMBnttrans 0xA0 /* NT transact */
1014 #define SMBnttranss 0xA1 /* NT transact secondary */
1015 #define SMBntcreateX 0xA2 /* NT create and X */
1016 #define SMBntcancel 0xA4 /* NT cancel */
1017 #define SMBntrename 0xA5 /* NT rename */
1019 /* These are the trans subcommands */
1020 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
1021 #define TRANSACT_DCERPCCMD 0x26
1022 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1024 /* These are the TRANS2 sub commands */
1025 #define TRANSACT2_OPEN 0x00
1026 #define TRANSACT2_FINDFIRST 0x01
1027 #define TRANSACT2_FINDNEXT 0x02
1028 #define TRANSACT2_QFSINFO 0x03
1029 #define TRANSACT2_SETFSINFO 0x04
1030 #define TRANSACT2_QPATHINFO 0x05
1031 #define TRANSACT2_SETPATHINFO 0x06
1032 #define TRANSACT2_QFILEINFO 0x07
1033 #define TRANSACT2_SETFILEINFO 0x08
1034 #define TRANSACT2_FSCTL 0x09
1035 #define TRANSACT2_IOCTL 0x0A
1036 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1037 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1038 #define TRANSACT2_MKDIR 0x0D
1039 #define TRANSACT2_SESSION_SETUP 0x0E
1040 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1041 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1043 /* These are the NT transact sub commands. */
1044 #define NT_TRANSACT_CREATE 1
1045 #define NT_TRANSACT_IOCTL 2
1046 #define NT_TRANSACT_SET_SECURITY_DESC 3
1047 #define NT_TRANSACT_NOTIFY_CHANGE 4
1048 #define NT_TRANSACT_RENAME 5
1049 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1050 #define NT_TRANSACT_GET_USER_QUOTA 7
1051 #define NT_TRANSACT_SET_USER_QUOTA 8
1053 /* These are the NT transact_get_user_quota sub commands */
1054 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1055 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1056 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1058 /* Relevant IOCTL codes */
1059 #define IOCTL_QUERY_JOB_INFO 0x530060
1061 /* these are the trans2 sub fields for primary requests */
1062 #define smb_tpscnt smb_vwv0
1063 #define smb_tdscnt smb_vwv1
1064 #define smb_mprcnt smb_vwv2
1065 #define smb_mdrcnt smb_vwv3
1066 #define smb_msrcnt smb_vwv4
1067 #define smb_flags smb_vwv5
1068 #define smb_timeout smb_vwv6
1069 #define smb_pscnt smb_vwv9
1070 #define smb_psoff smb_vwv10
1071 #define smb_dscnt smb_vwv11
1072 #define smb_dsoff smb_vwv12
1073 #define smb_suwcnt smb_vwv13
1074 #define smb_setup smb_vwv14
1075 #define smb_setup0 smb_setup
1076 #define smb_setup1 (smb_setup+2)
1077 #define smb_setup2 (smb_setup+4)
1079 /* these are for the secondary requests */
1080 #define smb_spscnt smb_vwv2
1081 #define smb_spsoff smb_vwv3
1082 #define smb_spsdisp smb_vwv4
1083 #define smb_sdscnt smb_vwv5
1084 #define smb_sdsoff smb_vwv6
1085 #define smb_sdsdisp smb_vwv7
1086 #define smb_sfid smb_vwv8
1088 /* and these for responses */
1089 #define smb_tprcnt smb_vwv0
1090 #define smb_tdrcnt smb_vwv1
1091 #define smb_prcnt smb_vwv3
1092 #define smb_proff smb_vwv4
1093 #define smb_prdisp smb_vwv5
1094 #define smb_drcnt smb_vwv6
1095 #define smb_droff smb_vwv7
1096 #define smb_drdisp smb_vwv8
1098 /* these are for the NT trans primary request. */
1099 #define smb_nt_MaxSetupCount smb_vwv0
1100 #define smb_nt_Flags (smb_vwv0 + 1)
1101 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1102 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1103 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1104 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1105 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1106 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1107 #define smb_nt_DataCount (smb_vwv0 + 27)
1108 #define smb_nt_DataOffset (smb_vwv0 + 31)
1109 #define smb_nt_SetupCount (smb_vwv0 + 35)
1110 #define smb_nt_Function (smb_vwv0 + 36)
1111 #define smb_nt_SetupStart (smb_vwv0 + 38)
1113 /* these are for the NT trans secondary request. */
1114 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1115 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1116 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1117 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1118 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1119 #define smb_nts_DataCount (smb_vwv0 + 23)
1120 #define smb_nts_DataOffset (smb_vwv0 + 27)
1121 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1123 /* these are for the NT trans reply. */
1124 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1125 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1126 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1127 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1128 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1129 #define smb_ntr_DataCount (smb_vwv0 + 23)
1130 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1131 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1133 /* these are for the NT create_and_X */
1134 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1135 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1136 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1137 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1138 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1139 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1140 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1141 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1142 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1143 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1144 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1146 /* this is used on a TConX. I'm not sure the name is very helpful though */
1147 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1148 #define SMB_SHARE_IN_DFS 0x0002
1150 /* Named pipe write mode flags. Used in writeX calls. */
1151 #define PIPE_RAW_MODE 0x4
1152 #define PIPE_START_MESSAGE 0x8
1154 /* the desired access to use when opening a pipe */
1155 #define DESIRED_ACCESS_PIPE 0x2019f
1157 /* Mapping of access rights to UNIX perms. */
1158 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1159 #define UNIX_ACCESS_R FILE_GENERIC_READ
1160 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1161 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1163 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1164 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1165 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1166 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1167 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1171 * This is the old mapping we used to use. To get W2KSP2 profiles
1172 * working we need to map to the canonical file perms.
1174 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1175 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1176 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1177 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1178 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1179 FILE_APPEND_DATA|FILE_WRITE_DATA)
1180 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1181 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1184 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1187 #define REQUEST_OPLOCK 2
1188 #define REQUEST_BATCH_OPLOCK 4
1189 #define OPEN_DIRECTORY 8
1190 #define EXTENDED_RESPONSE_REQUIRED 0x10
1192 /* ShareAccess field. */
1193 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1194 #define FILE_SHARE_READ 1
1195 #define FILE_SHARE_WRITE 2
1196 #define FILE_SHARE_DELETE 4
1198 /* FileAttributesField */
1199 #define FILE_ATTRIBUTE_READONLY 0x001L
1200 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1201 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1202 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1203 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1204 #define FILE_ATTRIBUTE_NORMAL 0x080L
1205 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1206 #define FILE_ATTRIBUTE_SPARSE 0x200L
1207 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1208 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1209 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1210 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1211 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1212 #define SAMBA_ATTRIBUTES_MASK (FILE_ATTRIBUTE_READONLY|\
1213 FILE_ATTRIBUTE_HIDDEN|\
1214 FILE_ATTRIBUTE_SYSTEM|\
1215 FILE_ATTRIBUTE_DIRECTORY|\
1216 FILE_ATTRIBUTE_ARCHIVE)
1218 /* Flags - combined with attributes. */
1219 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1220 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1221 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1222 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1223 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1224 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1225 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1227 /* CreateDisposition field. */
1228 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1229 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1230 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1231 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1232 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1233 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1235 /* CreateOptions field. */
1236 #define FILE_DIRECTORY_FILE 0x0001
1237 #define FILE_WRITE_THROUGH 0x0002
1238 #define FILE_SEQUENTIAL_ONLY 0x0004
1239 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1240 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
1241 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
1242 #define FILE_NON_DIRECTORY_FILE 0x0040
1243 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
1244 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
1245 #define FILE_NO_EA_KNOWLEDGE 0x0200
1246 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1247 #define FILE_RANDOM_ACCESS 0x0800
1248 #define FILE_DELETE_ON_CLOSE 0x1000
1249 #define FILE_OPEN_BY_FILE_ID 0x2000
1250 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
1251 #define FILE_NO_COMPRESSION 0x8000
1252 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
1253 #define FILE_OPEN_REPARSE_POINT 0x00200000
1254 #define FILE_OPEN_NO_RECALL 0x00400000
1255 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1257 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1259 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1262 * Private create options used by the ntcreatex processing code. From Samba4.
1263 * We reuse some ignored flags for private use. Passed in the private_flags
1266 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
1267 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
1269 /* Private options for streams support */
1270 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1272 /* Private options for printer support */
1273 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1275 /* Responses when opening a file. */
1276 #define FILE_WAS_SUPERSEDED 0
1277 #define FILE_WAS_OPENED 1
1278 #define FILE_WAS_CREATED 2
1279 #define FILE_WAS_OVERWRITTEN 3
1281 /* File type flags */
1282 #define FILE_TYPE_DISK 0
1283 #define FILE_TYPE_BYTE_MODE_PIPE 1
1284 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1285 #define FILE_TYPE_PRINTER 3
1286 #define FILE_TYPE_COMM_DEVICE 4
1287 #define FILE_TYPE_UNKNOWN 0xFFFF
1289 /* Flag for NT transact rename call. */
1290 #define RENAME_REPLACE_IF_EXISTS 1
1292 /* flags for SMBntrename call (from Samba4) */
1293 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1294 #define RENAME_FLAG_HARD_LINK 0x103
1295 #define RENAME_FLAG_RENAME 0x104
1296 #define RENAME_FLAG_COPY 0x105
1298 /* Filesystem Attributes. */
1299 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1300 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1301 #define FILE_UNICODE_ON_DISK 0x00000004
1302 /* According to cifs9f, this is 4, not 8 */
1303 /* Acconding to testing, this actually sets the security attribute! */
1304 #define FILE_PERSISTENT_ACLS 0x00000008
1305 #define FILE_FILE_COMPRESSION 0x00000010
1306 #define FILE_VOLUME_QUOTAS 0x00000020
1307 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1308 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1309 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1310 #define FS_LFN_APIS 0x00004000
1311 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1312 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1313 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1314 #define FILE_NAMED_STREAMS 0x00040000
1315 #define FILE_READ_ONLY_VOLUME 0x00080000
1317 /* ChangeNotify flags. */
1318 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1319 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1320 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1321 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1322 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1323 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1324 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1325 #define FILE_NOTIFY_CHANGE_EA 0x080
1326 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1327 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1328 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1329 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1331 #define FILE_NOTIFY_CHANGE_NAME \
1332 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1334 /* change notify action results */
1335 #define NOTIFY_ACTION_ADDED 1
1336 #define NOTIFY_ACTION_REMOVED 2
1337 #define NOTIFY_ACTION_MODIFIED 3
1338 #define NOTIFY_ACTION_OLD_NAME 4
1339 #define NOTIFY_ACTION_NEW_NAME 5
1340 #define NOTIFY_ACTION_ADDED_STREAM 6
1341 #define NOTIFY_ACTION_REMOVED_STREAM 7
1342 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1345 /* where to find the base of the SMB packet proper */
1346 #define smb_base(buf) (((char *)(buf))+4)
1348 /* we don't allow server strings to be longer than 48 characters as
1349 otherwise NT will not honour the announce packets */
1350 #define MAX_SERVER_STRING_LENGTH 48
1353 #define SMB_SUCCESS 0 /* The request was successful. */
1356 void dfs_unlogin(void);
1357 extern int dcelogin_atmost_once;
1361 char *strdup(char *s);
1368 /* This was set by JHT in liaison with Jeremy Allison early 1997
1370 * Version 4.0 - never made public
1371 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1372 * - Reappeared in 1.9.16p11 with fixed smbd services
1373 * Version 4.20 - To indicate that nmbd and browsing now works better
1374 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1376 * Note: In the presence of NT4.X do not set above 4.9
1377 * Setting this above 4.9 can have undesired side-effects.
1378 * This may change again in Samba-3.0 after further testing. JHT
1381 #define DEFAULT_MAJOR_VERSION 0x04
1382 #define DEFAULT_MINOR_VERSION 0x09
1384 /* Browser Election Values */
1385 #define BROWSER_ELECTION_VERSION 0x010f
1386 #define BROWSER_CONSTANT 0xaa55
1388 /* Sercurity mode bits. */
1389 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1390 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1391 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1392 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1394 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1396 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1397 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1398 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1399 #define FLAGS2_UNKNOWN_BIT4 0x0010
1400 #define FLAGS2_IS_LONG_NAME 0x0040
1401 #define FLAGS2_EXTENDED_SECURITY 0x0800
1402 #define FLAGS2_DFS_PATHNAMES 0x1000
1403 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1404 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1405 #define FLAGS2_UNICODE_STRINGS 0x8000
1407 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1409 /* TCONX Flag (smb_vwv2). */
1410 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1412 /* File Status Flags. See:
1414 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1418 #define NO_SUBSTREAMS 0x2
1419 #define NO_REPARSETAG 0x4
1421 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1423 #define CAP_RAW_MODE 0x0001
1424 #define CAP_MPX_MODE 0x0002
1425 #define CAP_UNICODE 0x0004
1426 #define CAP_LARGE_FILES 0x0008
1427 #define CAP_NT_SMBS 0x0010
1428 #define CAP_RPC_REMOTE_APIS 0x0020
1429 #define CAP_STATUS32 0x0040
1430 #define CAP_LEVEL_II_OPLOCKS 0x0080
1431 #define CAP_LOCK_AND_READ 0x0100
1432 #define CAP_NT_FIND 0x0200
1433 #define CAP_DFS 0x1000
1434 #define CAP_W2K_SMBS 0x2000
1435 #define CAP_LARGE_READX 0x4000
1436 #define CAP_LARGE_WRITEX 0x8000
1437 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1438 #define CAP_EXTENDED_SECURITY 0x80000000
1440 /* protocol types. It assumes that higher protocols include lower protocols
1442 enum protocol_types {
1452 /* security levels */
1453 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1463 /* printing types */
1464 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1465 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1466 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1467 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1468 ,PRINT_TEST,PRINT_VLP
1469 #endif /* DEVELOPER */
1472 /* LDAP schema types */
1473 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1475 /* LDAP SSL options */
1476 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1478 /* LDAP PASSWD SYNC methods */
1479 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1482 * This should be under the HAVE_KRB5 flag but since they're used
1483 * in lp_kerberos_method(), they ned to be always available
1484 * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
1485 * so they remain accurate.
1488 #define KERBEROS_VERIFY_SECRETS 0
1489 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1490 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1491 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1493 /* Remote architectures we know about. */
1494 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1495 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1496 RA_SAMBA, RA_CIFSFS, RA_WINXP64};
1499 enum case_handling {CASE_LOWER,CASE_UPPER};
1501 /* ACL compatibility */
1502 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1504 * Global value meaing that the smb_uid field should be
1505 * ingored (in share level security and protocol level == CORE)
1508 #define UID_FIELD_INVALID 0
1509 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1512 * Size of buffer to use when moving files across filesystems.
1514 #define COPYBUF_SIZE (8*1024)
1517 * Map the Core and Extended Oplock requesst bits down
1518 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1524 #define CORE_OPLOCK_REQUEST(inbuf) \
1525 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1528 * Extended protocol.
1530 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1533 #define LOCKING_ANDX_SHARED_LOCK 0x1
1534 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1535 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1536 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1537 #define LOCKING_ANDX_LARGE_FILES 0x10
1540 * Bits we test with.
1541 * Note these must fit into 16-bits.
1544 #define NO_OPLOCK 0x0
1545 #define EXCLUSIVE_OPLOCK 0x1
1546 #define BATCH_OPLOCK 0x2
1547 #define LEVEL_II_OPLOCK 0x4
1549 /* The following are Samba-private. */
1550 #define INTERNAL_OPEN_ONLY 0x8
1551 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1552 * inform potential level2 holders on
1554 #define DEFERRED_OPEN_ENTRY 0x20
1555 #define UNUSED_SHARE_MODE_ENTRY 0x40
1556 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1558 /* None of the following should ever appear in fsp->oplock_request. */
1559 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1561 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1562 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1563 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1565 /* kernel_oplock_message definition.
1567 struct kernel_oplock_message {
1571 unsigned long file_id;
1575 0 uint64_t dev 8 bytes
1576 8 uint64_t inode 8 bytes
1577 16 uint64_t extid 8 bytes
1578 24 unsigned long file_id 4 bytes
1582 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1584 /* file_renamed_message definition.
1586 struct file_renamed_message {
1589 char names[1]; A variable area containing sharepath and filename.
1593 0 uint64_t dev 8 bytes
1594 8 uint64_t inode 8 bytes
1595 16 unit64_t extid 8 bytes
1596 24 char [] name zero terminated namelen bytes
1597 minimum length == 24.
1601 #define MSG_FILE_RENAMED_MIN_SIZE 24
1604 * On the wire return values for oplock types.
1607 #define CORE_OPLOCK_GRANTED (1<<5)
1608 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1610 #define NO_OPLOCK_RETURN 0
1611 #define EXCLUSIVE_OPLOCK_RETURN 1
1612 #define BATCH_OPLOCK_RETURN 2
1613 #define LEVEL_II_OPLOCK_RETURN 3
1616 #define OPLOCKLEVEL_NONE 0
1617 #define OPLOCKLEVEL_II 1
1620 * Capabilities abstracted for different systems.
1623 enum smbd_capability {
1624 KERNEL_OPLOCK_CAPABILITY,
1625 DMAPI_ACCESS_CAPABILITY,
1630 * Kernel oplocks capability flags.
1633 /* Level 2 oplocks are supported natively by kernel oplocks. */
1634 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1636 /* The kernel notifies deferred openers when they can retry the open. */
1637 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1639 /* The kernel notifies smbds when an oplock break times out. */
1640 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1642 /* The kernel notifies smbds when an oplock is broken. */
1643 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1645 struct kernel_oplocks_ops;
1646 struct kernel_oplocks {
1647 const struct kernel_oplocks_ops *ops;
1652 enum level2_contention_type {
1653 LEVEL2_CONTEND_ALLOC_SHRINK,
1654 LEVEL2_CONTEND_ALLOC_GROW,
1655 LEVEL2_CONTEND_SET_FILE_LEN,
1656 LEVEL2_CONTEND_FILL_SPARSE,
1657 LEVEL2_CONTEND_WRITE,
1658 LEVEL2_CONTEND_WINDOWS_BRL,
1659 LEVEL2_CONTEND_POSIX_BRL
1662 /* if a kernel does support oplocks then a structure of the following
1663 typee is used to describe how to interact with the kernel */
1664 struct kernel_oplocks_ops {
1665 bool (*set_oplock)(struct kernel_oplocks *ctx,
1666 files_struct *fsp, int oplock_type);
1667 void (*release_oplock)(struct kernel_oplocks *ctx,
1668 files_struct *fsp, int oplock_type);
1669 void (*contend_level2_oplocks_begin)(files_struct *fsp,
1670 enum level2_contention_type type);
1671 void (*contend_level2_oplocks_end)(files_struct *fsp,
1672 enum level2_contention_type type);
1675 #include "smb_macros.h"
1677 #define MAX_NETBIOSNAME_LEN 16
1678 /* DOS character, NetBIOS namestring. Type used on the wire. */
1679 typedef char nstring[MAX_NETBIOSNAME_LEN];
1680 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1681 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1683 /* A netbios name structure. */
1687 unsigned int name_type;
1690 /* A netbios node status array element. */
1691 struct node_status {
1694 unsigned char flags;
1697 /* The extra info from a NetBIOS node status query */
1698 struct node_status_extra {
1699 unsigned char mac_addr[6];
1700 /* There really is more here ... */
1703 typedef struct user_struct {
1704 struct user_struct *next, *prev;
1705 uint16 vuid; /* Tag for this entry. */
1707 char *session_keystr; /* used by utmp and pam session code.
1711 struct auth_serversupplied_info *server_info;
1713 struct auth_ntlmssp_state *auth_ntlmssp_state;
1716 struct unix_error_map {
1724 * Size of new password account encoding string. This is enough space to
1725 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1726 * Do not change unless you are adding new ACB bits!
1729 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1732 Do you want session setups at user level security with a invalid
1733 password to be rejected or allowed in as guest? WinNT rejects them
1734 but it can be a pain as it means "net view" needs to use a password
1736 You have 3 choices in the setting of map_to_guest:
1738 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1739 are rejected. This is the default.
1741 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1742 are rejected, unless the username does not exist, in which case it
1743 is treated as a guest login
1745 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1746 are treated as a guest login
1748 Note that map_to_guest only has an effect in user or server
1752 #define NEVER_MAP_TO_GUEST 0
1753 #define MAP_TO_GUEST_ON_BAD_USER 1
1754 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1755 #define MAP_TO_GUEST_ON_BAD_UID 3
1757 #define SAFE_NETBIOS_CHARS ". -_"
1759 /* The maximum length of a trust account password.
1760 Used when we randomly create it, 15 char passwords
1761 exceed NT4's max password length */
1763 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1767 #define LDAP_PORT 389
1769 #define LDAP_GC_PORT 3268
1771 /* used by the IP comparison function */
1773 struct sockaddr_storage ss;
1777 /* Special name type used to cause a _kerberos DNS lookup. */
1778 #define KDC_NAME_TYPE 0xDCDC
1787 struct ea_list *next, *prev;
1788 struct ea_struct ea;
1791 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1792 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1793 /* EA to use for DOS attributes */
1794 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1795 /* Prefix for DosStreams in the vfs_streams_xattr module */
1796 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1797 /* Prefix for xattrs storing streams. */
1798 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1800 #define UUID_SIZE 16
1802 #define UUID_FLAT_SIZE 16
1803 typedef struct uuid_flat {
1804 uint8 info[UUID_FLAT_SIZE];
1807 /* map readonly options */
1808 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1810 /* usershare error codes. */
1811 enum usershare_err {
1813 USERSHARE_MALFORMED_FILE,
1814 USERSHARE_BAD_VERSION,
1815 USERSHARE_MALFORMED_PATH,
1816 USERSHARE_MALFORMED_COMMENT_DEF,
1817 USERSHARE_MALFORMED_ACL_DEF,
1819 USERSHARE_PATH_NOT_ABSOLUTE,
1820 USERSHARE_PATH_IS_DENIED,
1821 USERSHARE_PATH_NOT_ALLOWED,
1822 USERSHARE_PATH_NOT_DIRECTORY,
1823 USERSHARE_POSIX_ERR,
1824 USERSHARE_MALFORMED_SHARENAME_DEF,
1825 USERSHARE_BAD_SHARENAME
1828 /* Different reasons for closing a file. */
1829 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1831 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1832 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1833 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1834 struct smb_extended_info {
1835 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1836 uint32 samba_version; /* Major/Minor/Release/Revision */
1837 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1838 NTTIME samba_gitcommitdate;
1839 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1843 struct smb_file_time {
1844 struct timespec mtime;
1845 struct timespec atime;
1846 struct timespec ctime;
1847 struct timespec create_time;
1851 * unix_convert_flags
1853 #define UCF_SAVE_LCOMP 0x00000001
1854 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1855 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1856 #define UCF_POSIX_PATHNAMES 0x00000008
1861 struct smb_filename {
1864 char *original_lcomp;
1868 /* struct for maintaining the child processes that get spawned from smbd */
1870 struct child_pid *prev, *next;
1874 /* Used to keep track of deferred opens. */
1875 struct deferred_open_record;
1877 /* Client-side offline caching policy types */
1878 #define CSC_POLICY_MANUAL 0
1879 #define CSC_POLICY_DOCUMENTS 1
1880 #define CSC_POLICY_PROGRAMS 2
1881 #define CSC_POLICY_DISABLE 3
1883 /* Used inside aio code. */