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)
72 #include "lib/util/debug.h"
73 #include "lib/util/debug_s3.h"
75 /* this defines the error codes that receive_smb can put in smb_read_error */
76 enum smb_read_errors
{
81 SMB_WRITE_ERROR
, /* This error code can go into the client smb_rw_error. */
84 SMB_DO_NOT_DO_TDIS
, /* cli_close_connection() check for this when smbfs wants to keep tree connected */
88 #define DIR_STRUCT_SIZE 43
90 /* these define the attribute byte as seen by DOS */
91 #define aRONLY (1L<<0) /* 0x01 */
92 #define aHIDDEN (1L<<1) /* 0x02 */
93 #define aSYSTEM (1L<<2) /* 0x04 */
94 #define aVOLID (1L<<3) /* 0x08 */
95 #define aDIR (1L<<4) /* 0x10 */
96 #define aARCH (1L<<5) /* 0x20 */
107 #define DOS_OPEN_RDONLY 0
108 #define DOS_OPEN_WRONLY 1
109 #define DOS_OPEN_RDWR 2
110 #define DOS_OPEN_EXEC 3
111 #define DOS_OPEN_FCB 0xF
113 /* define shifts and masks for share and open modes. */
114 #define OPENX_MODE_MASK 0xF
115 #define DENY_MODE_SHIFT 4
116 #define DENY_MODE_MASK 0x7
117 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
118 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
119 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
120 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
122 /* Sync on open file (not sure if used anymore... ?) */
123 #define FILE_SYNC_OPENMODE (1<<14)
124 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
126 /* open disposition values */
127 #define OPENX_FILE_EXISTS_FAIL 0
128 #define OPENX_FILE_EXISTS_OPEN 1
129 #define OPENX_FILE_EXISTS_TRUNCATE 2
131 /* mask for open disposition. */
132 #define OPENX_FILE_OPEN_MASK 0x3
134 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
135 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
137 /* The above can be OR'ed with... */
138 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
139 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
141 typedef union unid_t
{
146 /* pipe string names */
149 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
152 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
154 #define LOOKUP_NAME_NONE 0x00000000
155 #define LOOKUP_NAME_ISOLATED 0x00000001 /* Look up unqualified names */
156 #define LOOKUP_NAME_REMOTE 0x00000002 /* Ask others */
157 #define LOOKUP_NAME_GROUP 0x00000004 /* (unused) This is a NASTY hack for
158 valid users = @foo where foo also
159 exists in as user. */
160 #define LOOKUP_NAME_NO_NSS 0x00000008 /* no NSS calls to avoid
161 winbind recursions */
162 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
163 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
164 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
165 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
166 |LOOKUP_NAME_BUILTIN\
169 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
171 |LOOKUP_NAME_BUILTIN\
175 #include "librpc/gen_ndr/dcerpc.h"
176 #include "librpc/gen_ndr/security.h"
178 struct lsa_dom_info
{
186 struct lsa_name_info
{
188 enum lsa_SidType type
;
194 * The complete list of SIDS belonging to this user.
195 * Created when a vuid is registered.
196 * The definition of the user_sids array is as follows :
198 * token->user_sids[0] = primary user SID.
199 * token->user_sids[1] = primary group SID.
200 * token->user_sids[2..num_sids] = supplementary group SIDS.
203 #define PRIMARY_USER_SID_INDEX 0
204 #define PRIMARY_GROUP_SID_INDEX 1
206 typedef struct unix_user_token
{
213 typedef struct write_cache
{
224 uint64_t position_information
;
226 uint32 private_options
; /* NT Create options, but we only look at
227 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
228 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
229 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
230 * for print files *only*, where
231 * DELETE_ON_CLOSE is not stored in the share
234 unsigned long gen_id
;
238 struct share_mode_entry
;
242 struct rpc_cli_smbd_conn
;
243 struct fncall_context
;
245 struct vfs_fsp_data
{
246 struct vfs_fsp_data
*next
;
247 struct vfs_handle_struct
*owner
;
248 void (*destroy
)(void *p_data
);
250 /* NOTE: This structure contains four pointers so that we can guarantee
251 * that the end of the structure is always both 4-byte and 8-byte aligned.
255 /* the basic packet size, assuming no words or bytes */
258 struct notify_change
{
263 struct notify_mid_map
;
266 struct notify_change_request
;
267 struct sys_notify_backend
;
268 struct sys_notify_context
{
269 struct event_context
*ev
;
270 struct connection_struct
*conn
;
271 void *private_data
; /* For use by the system backend */
274 struct notify_change_buf
{
276 * If no requests are pending, changes are queued here. Simple array,
281 * num_changes == -1 means that we have got a catch-all change, when
282 * asked we just return NT_STATUS_OK without specific changes.
285 struct notify_change
*changes
;
288 * If no changes are around requests are queued here. Using a linked
289 * list, because we have to append at the end and delete from the top.
291 struct notify_change_request
*requests
;
294 struct print_file_data
{
298 struct policy_handle handle
;
303 typedef struct files_struct
{
304 struct files_struct
*next
, *prev
;
306 struct connection_struct
*conn
;
307 struct fd_handle
*fh
;
308 unsigned int num_smb_operations
;
309 struct file_id file_id
;
310 uint64_t initial_allocation_size
; /* Faked up initial allocation on disk. */
315 struct timeval open_time
;
316 uint32 access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
317 uint32 share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
319 bool update_write_time_triggered
;
320 struct timed_event
*update_write_time_event
;
321 bool update_write_time_on_close
;
322 struct timespec close_write_time
;
323 bool write_time_forced
;
326 int sent_oplock_break
;
327 struct timed_event
*oplock_timeout
;
328 struct lock_struct last_lock_failure
;
329 int current_lock_count
; /* Count the number of outstanding locks and pending locks. */
331 struct share_mode_entry
*pending_break_messages
;
332 int num_pending_break_messages
;
339 bool aio_write_behind
;
341 bool initial_delete_on_close
; /* Only set at NTCreateX if file was created. */
342 bool delete_on_close
;
345 struct smb_filename
*fsp_name
;
346 uint32_t name_hash
; /* Jenkins hash of full pathname. */
348 struct vfs_fsp_data
*vfs_extension
;
349 struct fake_file_handle
*fake_file_handle
;
351 struct notify_change_buf
*notify
;
353 struct files_struct
*base_fsp
; /* placeholder for delete on close */
356 * Read-only cached brlock record, thrown away when the
357 * brlock.tdb seqnum changes. This avoids fetching data from
358 * the brlock.tdb on every read/write call.
361 struct byte_range_lock
*brlock_rec
;
363 struct dptr_struct
*dptr
;
365 /* if not NULL, means this is a print file */
366 struct print_file_data
*print_file
;
370 #include "ntquotas.h"
371 #include "sysquotas.h"
373 struct client_address
{
374 char addr
[INET6_ADDRSTRLEN
];
378 struct vuid_cache_entry
{
379 struct auth_serversupplied_info
*session_info
;
385 unsigned int next_entry
;
386 struct vuid_cache_entry array
[VUID_CACHE_SIZE
];
392 } name_compare_entry
;
395 struct trans_state
*next
, *prev
;
399 uint32 max_param_return
;
400 uint32 max_data_return
;
401 uint32 max_setup_return
;
403 uint8 cmd
; /* SMBtrans or SMBtrans2 */
405 char *name
; /* for trans requests */
406 uint16 call
; /* for trans2 and nttrans requests */
408 bool close_on_completion
;
411 unsigned int setup_count
;
414 size_t received_data
;
415 size_t received_param
;
425 * Info about an alternate data stream
428 struct stream_struct
{
430 SMB_OFF_T alloc_size
;
434 /* Include VFS stuff */
436 #include "smb_acls.h"
439 struct dfree_cached_info
{
440 time_t last_dfree_time
;
449 struct share_params
{
453 struct share_iterator
{
457 typedef struct connection_struct
{
458 struct connection_struct
*next
, *prev
;
459 struct smbd_server_connection
*sconn
; /* can be NULL */
460 unsigned cnum
; /* an index passed over the wire */
461 struct share_params
*params
;
463 struct vuid_cache vuid_cache
;
466 bool read_only
; /* Attributes for the current user of the share. */
467 /* Does this filesystem honor
468 sub second timestamps on files
469 and directories when setting time ? */
470 enum timestamp_set_resolution ts_res
;
474 struct vfs_handle_struct
*vfs_handles
; /* for the new plugins */
477 * This represents the user information on this connection. Depending
478 * on the vuid using this tid, this might change per SMB request.
480 struct auth_serversupplied_info
*session_info
;
483 * If the "force group" parameter is set, this is the primary gid that
484 * may be used in the users token, depending on the vuid using this tid.
486 gid_t force_group_gid
;
488 uint16 vuid
; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
491 time_t lastused_count
;
494 unsigned int num_smb_operations
; /* Count of smb operations on this tree. */
498 /* Semantics requested by the client or forced by the server config. */
501 bool short_case_preserve
;
503 /* Semantics provided by the underlying filesystem. */
505 /* Device number of the directory of the share mount.
506 Used to ensure unique FileIndex returns. */
507 SMB_DEV_T base_share_dev
;
509 name_compare_entry
*hide_list
; /* Per-share list of files to return as hidden. */
510 name_compare_entry
*veto_list
; /* Per-share list of files to veto (never show). */
511 name_compare_entry
*veto_oplock_list
; /* Per-share list of files to refuse oplocks on. */
512 name_compare_entry
*aio_write_behind_list
; /* Per-share list of files to use aio write behind on. */
513 struct dfree_cached_info
*dfree_info
;
514 struct trans_state
*pending_trans
;
515 struct notify_context
*notify_ctx
;
517 struct rpc_pipe_client
*spoolss_pipe
;
521 struct current_user
{
522 connection_struct
*conn
;
525 struct security_token
*nt_user_token
;
528 struct smbd_smb2_request
;
534 uint64_t mid
; /* For compatibility with SMB2. */
545 * Async handling in the main smb processing loop is directed by
546 * outbuf: reply_xxx routines indicate sync behaviour by putting their
547 * reply into "outbuf". If they leave it as NULL, they take of it
548 * themselves, possibly later.
550 * If async handling is wanted, the reply_xxx routine must make sure
551 * that it talloc_move()s the smb_req somewhere else.
557 connection_struct
*conn
;
558 struct smbd_server_connection
*sconn
;
559 struct smb_perfcount_data pcd
;
562 * Chained request handling
564 struct files_struct
*chain_fsp
;
567 * Here we collect the outbufs from the chain handlers
569 uint8_t *chain_outbuf
;
572 * state information for async smb handling
579 * Back pointer to smb2 request.
581 struct smbd_smb2_request
*smb2req
;
584 /* Defines for the sent_oplock_break field above. */
585 #define NO_BREAK_SENT 0
586 #define BREAK_TO_NONE_SENT 1
587 #define LEVEL_II_BREAK_SENT 2
590 fstring smb_name
; /* user name from the client */
591 fstring unix_name
; /* unix user name of a validated user */
592 fstring domain
; /* domain that the client specified */
595 /* used for server information: client, nameserv and ipc */
596 struct server_info_struct
{
600 fstring domain
; /* used ONLY in ipc.c NOT namework.c */
601 bool server_added
; /* used ONLY in ipc.c NOT namework.c */
604 /* used for network interfaces */
606 struct interface
*next
, *prev
;
609 struct sockaddr_storage ip
;
610 struct sockaddr_storage netmask
;
611 struct sockaddr_storage bcast
;
614 /* Internal message queue for deferred opens. */
615 struct pending_message_list
{
616 struct pending_message_list
*next
, *prev
;
617 struct timeval request_time
; /* When was this first issued? */
618 struct timed_event
*te
;
619 struct smb_perfcount_data pcd
;
624 DATA_BLOB private_data
;
627 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
629 /* struct returned by get_share_modes */
630 struct share_mode_entry
{
631 struct server_id pid
;
632 uint64_t op_mid
; /* For compatibility with SMB2 opens. */
634 uint32 access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
635 uint32 share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
636 uint32 private_options
; /* NT Create options, but we only look at
637 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
638 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
639 * smbstatus and swat */
642 unsigned long share_file_id
;
643 uint32 uid
; /* uid of file opener. */
644 uint16 flags
; /* See SHARE_MODE_XX above. */
645 uint32_t name_hash
; /* Jenkins hash of full pathname. */
648 /* oplock break message definition - linearization of share_mode_entry.
651 0 struct server_id pid 4
654 14 uint32 access_mask 4
655 18 uint32 share_access 4
656 22 uint32 private_options 4
658 30 uint32 time usec 4
659 34 uint64 dev 8 bytes
660 42 uint64 inode 8 bytes
661 50 uint64 extid 8 bytes
662 58 unsigned long file_id 4 bytes
663 62 uint32 uid 4 bytes
664 66 uint16 flags 2 bytes
665 68 uint32 name_hash 4 bytes
670 #define OP_BREAK_MSG_PID_OFFSET 0
671 #define OP_BREAK_MSG_MID_OFFSET 4
672 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
673 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
674 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
675 #define OP_BREAK_MSG_PRIV_OFFSET 22
676 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
677 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
678 #define OP_BREAK_MSG_DEV_OFFSET 34
679 #define OP_BREAK_MSG_INO_OFFSET 42
680 #define OP_BREAK_MSG_EXTID_OFFSET 50
681 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
682 #define OP_BREAK_MSG_UID_OFFSET 62
683 #define OP_BREAK_MSG_FLAGS_OFFSET 66
684 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
686 #define OP_BREAK_MSG_VNN_OFFSET 72
687 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
689 struct delete_token_list
{
690 struct delete_token_list
*next
, *prev
;
692 UNIX_USER_TOKEN
*delete_token
;
695 struct share_mode_lock
{
696 const char *servicepath
; /* canonicalized. */
697 const char *base_name
;
698 const char *stream_name
;
701 struct share_mode_entry
*share_modes
;
702 struct delete_token_list
*delete_tokens
;
703 struct timespec old_write_time
;
704 struct timespec changed_write_time
;
707 struct db_record
*record
;
711 * Internal structure of locking.tdb share mode db.
712 * Used by locking.c and libsmbsharemodes.c
715 struct locking_data
{
718 int num_share_mode_entries
;
719 struct timespec old_write_time
;
720 struct timespec changed_write_time
;
721 uint32 num_delete_token_entries
;
723 struct share_mode_entry dummy
; /* Needed for alignment. */
725 /* The following four entries are implicit
727 (1) struct share_mode_entry modes[num_share_mode_entries];
729 (2) A num_delete_token_entries of structs {
730 uint32_t len_delete_token;
731 char unix_token[len_delete_token] (divisible by 4).
734 (3) char share_name[];
735 (4) char file_name[];
739 /* Used to store pipe open records for NetFileEnum() */
741 struct pipe_open_rec
{
742 struct server_id pid
;
749 #define NT_HASH_LEN 16
750 #define LM_HASH_LEN 16
752 /* Password history contants. */
753 #define PW_HISTORY_SALT_LEN 16
754 #define SALTED_MD5_HASH_LEN 16
755 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
756 #define MAX_PW_HISTORY_LEN 24
759 * Flags for local user manipulation.
762 #define LOCAL_ADD_USER 0x1
763 #define LOCAL_DELETE_USER 0x2
764 #define LOCAL_DISABLE_USER 0x4
765 #define LOCAL_ENABLE_USER 0x8
766 #define LOCAL_TRUST_ACCOUNT 0x10
767 #define LOCAL_SET_NO_PASSWORD 0x20
768 #define LOCAL_SET_PASSWORD 0x40
769 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
770 #define LOCAL_INTERDOM_ACCOUNT 0x100
771 #define LOCAL_AM_ROOT 0x200 /* Act as root */
773 /* key and data in the connections database - used in smbstatus and smbd */
774 struct connections_key
{
775 struct server_id pid
;
780 struct connections_data
{
782 struct server_id pid
;
786 char servicename
[FSTRING_LEN
];
788 char machine
[FSTRING_LEN
];
792 * This field used to hold the msg_flags. For compatibility reasons,
793 * keep the data structure in the tdb file the same.
795 uint32 unused_compatitibility_field
;
799 /* the following are used by loadparm for option lists */
801 P_BOOL
,P_BOOLREV
,P_CHAR
,P_INTEGER
,P_OCTAL
,P_LIST
,
802 P_STRING
,P_USTRING
,P_ENUM
,P_SEP
806 P_LOCAL
,P_GLOBAL
,P_SEPARATOR
,P_NONE
819 bool (*special
)(int snum
, const char *, char **);
820 const struct enum_list
*enum_list
;
831 /* The following flags are used in SWAT */
832 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
833 #define FLAG_SHARE 0x0002 /* file sharing options */
834 #define FLAG_PRINT 0x0004 /* printing options */
835 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
836 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
837 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
838 #define FLAG_DEVELOPER 0x0040 /* No longer used */
839 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
840 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
841 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
842 #define FLAG_META 0x8000 /* A meta directive - not a real parameter */
843 #define FLAG_CMDLINE 0x10000 /* option has been overridden */
850 /* offsets into message for common items */
857 #define smb_pidhigh 16
858 #define smb_ss_field 18
884 /* flag defines. CIFS spec 3.1.1 */
885 #define FLAG_SUPPORT_LOCKREAD 0x01
886 #define FLAG_CLIENT_BUF_AVAIL 0x02
887 #define FLAG_RESERVED 0x04
888 #define FLAG_CASELESS_PATHNAMES 0x08
889 #define FLAG_CANONICAL_PATHNAMES 0x10
890 #define FLAG_REQUEST_OPLOCK 0x20
891 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
892 #define FLAG_REPLY 0x80
895 #define SMBmkdir 0x00 /* create directory */
896 #define SMBrmdir 0x01 /* delete directory */
897 #define SMBopen 0x02 /* open file */
898 #define SMBcreate 0x03 /* create file */
899 #define SMBclose 0x04 /* close file */
900 #define SMBflush 0x05 /* flush file */
901 #define SMBunlink 0x06 /* delete file */
902 #define SMBmv 0x07 /* rename file */
903 #define SMBgetatr 0x08 /* get file attributes */
904 #define SMBsetatr 0x09 /* set file attributes */
905 #define SMBread 0x0A /* read from file */
906 #define SMBwrite 0x0B /* write to file */
907 #define SMBlock 0x0C /* lock byte range */
908 #define SMBunlock 0x0D /* unlock byte range */
909 #define SMBctemp 0x0E /* create temporary file */
910 #define SMBmknew 0x0F /* make new file */
911 #define SMBcheckpath 0x10 /* check directory path */
912 #define SMBexit 0x11 /* process exit */
913 #define SMBlseek 0x12 /* seek */
914 #define SMBtcon 0x70 /* tree connect */
915 #define SMBtconX 0x75 /* tree connect and X*/
916 #define SMBtdis 0x71 /* tree disconnect */
917 #define SMBnegprot 0x72 /* negotiate protocol */
918 #define SMBdskattr 0x80 /* get disk attributes */
919 #define SMBsearch 0x81 /* search directory */
920 #define SMBsplopen 0xC0 /* open print spool file */
921 #define SMBsplwr 0xC1 /* write to print spool file */
922 #define SMBsplclose 0xC2 /* close print spool file */
923 #define SMBsplretq 0xC3 /* return print queue */
924 #define SMBsends 0xD0 /* send single block message */
925 #define SMBsendb 0xD1 /* send broadcast message */
926 #define SMBfwdname 0xD2 /* forward user name */
927 #define SMBcancelf 0xD3 /* cancel forward */
928 #define SMBgetmac 0xD4 /* get machine name */
929 #define SMBsendstrt 0xD5 /* send start of multi-block message */
930 #define SMBsendend 0xD6 /* send end of multi-block message */
931 #define SMBsendtxt 0xD7 /* send text of multi-block message */
934 #define SMBlockread 0x13 /* Lock a range and read */
935 #define SMBwriteunlock 0x14 /* Unlock a range then write */
936 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
937 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
938 #define SMBwritec 0x20 /* secondary write request */
939 #define SMBwriteclose 0x2c /* write a file then close it */
941 /* dos extended protocol */
942 #define SMBreadBraw 0x1A /* read block raw */
943 #define SMBreadBmpx 0x1B /* read block multiplexed */
944 #define SMBreadBs 0x1C /* read block (secondary response) */
945 #define SMBwriteBraw 0x1D /* write block raw */
946 #define SMBwriteBmpx 0x1E /* write block multiplexed */
947 #define SMBwriteBs 0x1F /* write block (secondary request) */
948 #define SMBwriteC 0x20 /* write complete response */
949 #define SMBsetattrE 0x22 /* set file attributes expanded */
950 #define SMBgetattrE 0x23 /* get file attributes expanded */
951 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
952 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
953 #define SMBtranss 0x26 /* transaction (secondary request/response) */
954 #define SMBioctl 0x27 /* IOCTL */
955 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
956 #define SMBcopy 0x29 /* copy */
957 #define SMBmove 0x2A /* move */
958 #define SMBecho 0x2B /* echo */
959 #define SMBopenX 0x2D /* open and X */
960 #define SMBreadX 0x2E /* read and X */
961 #define SMBwriteX 0x2F /* write and X */
962 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
963 #define SMBffirst 0x82 /* find first */
964 #define SMBfunique 0x83 /* find unique */
965 #define SMBfclose 0x84 /* find close */
966 #define SMBkeepalive 0x85 /* keepalive */
967 #define SMBinvalid 0xFE /* invalid command */
969 /* Extended 2.0 protocol */
970 #define SMBtrans2 0x32 /* TRANS2 protocol set */
971 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
972 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
973 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
974 #define SMBulogoffX 0x74 /* user logoff */
976 /* NT SMB extensions. */
977 #define SMBnttrans 0xA0 /* NT transact */
978 #define SMBnttranss 0xA1 /* NT transact secondary */
979 #define SMBntcreateX 0xA2 /* NT create and X */
980 #define SMBntcancel 0xA4 /* NT cancel */
981 #define SMBntrename 0xA5 /* NT rename */
983 /* These are the trans subcommands */
984 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
985 #define TRANSACT_DCERPCCMD 0x26
986 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
988 /* These are the TRANS2 sub commands */
989 #define TRANSACT2_OPEN 0x00
990 #define TRANSACT2_FINDFIRST 0x01
991 #define TRANSACT2_FINDNEXT 0x02
992 #define TRANSACT2_QFSINFO 0x03
993 #define TRANSACT2_SETFSINFO 0x04
994 #define TRANSACT2_QPATHINFO 0x05
995 #define TRANSACT2_SETPATHINFO 0x06
996 #define TRANSACT2_QFILEINFO 0x07
997 #define TRANSACT2_SETFILEINFO 0x08
998 #define TRANSACT2_FSCTL 0x09
999 #define TRANSACT2_IOCTL 0x0A
1000 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1001 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1002 #define TRANSACT2_MKDIR 0x0D
1003 #define TRANSACT2_SESSION_SETUP 0x0E
1004 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1005 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1007 /* These are the NT transact sub commands. */
1008 #define NT_TRANSACT_CREATE 1
1009 #define NT_TRANSACT_IOCTL 2
1010 #define NT_TRANSACT_SET_SECURITY_DESC 3
1011 #define NT_TRANSACT_NOTIFY_CHANGE 4
1012 #define NT_TRANSACT_RENAME 5
1013 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1014 #define NT_TRANSACT_GET_USER_QUOTA 7
1015 #define NT_TRANSACT_SET_USER_QUOTA 8
1017 /* These are the NT transact_get_user_quota sub commands */
1018 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1019 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1020 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1022 /* Relevant IOCTL codes */
1023 #define IOCTL_QUERY_JOB_INFO 0x530060
1025 /* these are the trans2 sub fields for primary requests */
1026 #define smb_tpscnt smb_vwv0
1027 #define smb_tdscnt smb_vwv1
1028 #define smb_mprcnt smb_vwv2
1029 #define smb_mdrcnt smb_vwv3
1030 #define smb_msrcnt smb_vwv4
1031 #define smb_flags smb_vwv5
1032 #define smb_timeout smb_vwv6
1033 #define smb_pscnt smb_vwv9
1034 #define smb_psoff smb_vwv10
1035 #define smb_dscnt smb_vwv11
1036 #define smb_dsoff smb_vwv12
1037 #define smb_suwcnt smb_vwv13
1038 #define smb_setup smb_vwv14
1039 #define smb_setup0 smb_setup
1040 #define smb_setup1 (smb_setup+2)
1041 #define smb_setup2 (smb_setup+4)
1043 /* these are for the secondary requests */
1044 #define smb_spscnt smb_vwv2
1045 #define smb_spsoff smb_vwv3
1046 #define smb_spsdisp smb_vwv4
1047 #define smb_sdscnt smb_vwv5
1048 #define smb_sdsoff smb_vwv6
1049 #define smb_sdsdisp smb_vwv7
1050 #define smb_sfid smb_vwv8
1052 /* and these for responses */
1053 #define smb_tprcnt smb_vwv0
1054 #define smb_tdrcnt smb_vwv1
1055 #define smb_prcnt smb_vwv3
1056 #define smb_proff smb_vwv4
1057 #define smb_prdisp smb_vwv5
1058 #define smb_drcnt smb_vwv6
1059 #define smb_droff smb_vwv7
1060 #define smb_drdisp smb_vwv8
1062 /* these are for the NT trans primary request. */
1063 #define smb_nt_MaxSetupCount smb_vwv0
1064 #define smb_nt_Flags (smb_vwv0 + 1)
1065 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1066 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1067 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1068 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1069 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1070 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1071 #define smb_nt_DataCount (smb_vwv0 + 27)
1072 #define smb_nt_DataOffset (smb_vwv0 + 31)
1073 #define smb_nt_SetupCount (smb_vwv0 + 35)
1074 #define smb_nt_Function (smb_vwv0 + 36)
1075 #define smb_nt_SetupStart (smb_vwv0 + 38)
1077 /* these are for the NT trans secondary request. */
1078 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1079 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1080 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1081 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1082 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1083 #define smb_nts_DataCount (smb_vwv0 + 23)
1084 #define smb_nts_DataOffset (smb_vwv0 + 27)
1085 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1087 /* these are for the NT trans reply. */
1088 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1089 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1090 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1091 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1092 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1093 #define smb_ntr_DataCount (smb_vwv0 + 23)
1094 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1095 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1097 /* these are for the NT create_and_X */
1098 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1099 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1100 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1101 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1102 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1103 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1104 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1105 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1106 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1107 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1108 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1110 /* this is used on a TConX. I'm not sure the name is very helpful though */
1111 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1112 #define SMB_SHARE_IN_DFS 0x0002
1114 /* Named pipe write mode flags. Used in writeX calls. */
1115 #define PIPE_RAW_MODE 0x4
1116 #define PIPE_START_MESSAGE 0x8
1118 /* the desired access to use when opening a pipe */
1119 #define DESIRED_ACCESS_PIPE 0x2019f
1121 /* Mapping of access rights to UNIX perms. */
1122 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1123 #define UNIX_ACCESS_R FILE_GENERIC_READ
1124 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1125 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1127 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1128 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1129 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1130 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1131 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1135 * This is the old mapping we used to use. To get W2KSP2 profiles
1136 * working we need to map to the canonical file perms.
1138 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1139 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1140 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1141 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1142 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1143 FILE_APPEND_DATA|FILE_WRITE_DATA)
1144 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1145 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1148 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1151 #define REQUEST_OPLOCK 2
1152 #define REQUEST_BATCH_OPLOCK 4
1153 #define OPEN_DIRECTORY 8
1154 #define EXTENDED_RESPONSE_REQUIRED 0x10
1156 /* ShareAccess field. */
1157 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1158 #define FILE_SHARE_READ 1
1159 #define FILE_SHARE_WRITE 2
1160 #define FILE_SHARE_DELETE 4
1162 /* FileAttributesField */
1163 #define FILE_ATTRIBUTE_READONLY 0x001L
1164 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1165 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1166 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1167 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1168 #define FILE_ATTRIBUTE_NORMAL 0x080L
1169 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1170 #define FILE_ATTRIBUTE_SPARSE 0x200L
1171 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1172 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1173 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1174 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1175 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1176 #define SAMBA_ATTRIBUTES_MASK (FILE_ATTRIBUTE_READONLY|\
1177 FILE_ATTRIBUTE_HIDDEN|\
1178 FILE_ATTRIBUTE_SYSTEM|\
1179 FILE_ATTRIBUTE_DIRECTORY|\
1180 FILE_ATTRIBUTE_ARCHIVE)
1182 /* Flags - combined with attributes. */
1183 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1184 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1185 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1186 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1187 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1188 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1189 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1191 /* CreateDisposition field. */
1192 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1193 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1194 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1195 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1196 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1197 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1199 /* CreateOptions field. */
1200 #define FILE_DIRECTORY_FILE 0x0001
1201 #define FILE_WRITE_THROUGH 0x0002
1202 #define FILE_SEQUENTIAL_ONLY 0x0004
1203 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1204 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
1205 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
1206 #define FILE_NON_DIRECTORY_FILE 0x0040
1207 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
1208 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
1209 #define FILE_NO_EA_KNOWLEDGE 0x0200
1210 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1211 #define FILE_RANDOM_ACCESS 0x0800
1212 #define FILE_DELETE_ON_CLOSE 0x1000
1213 #define FILE_OPEN_BY_FILE_ID 0x2000
1214 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
1215 #define FILE_NO_COMPRESSION 0x8000
1216 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
1217 #define FILE_OPEN_REPARSE_POINT 0x00200000
1218 #define FILE_OPEN_NO_RECALL 0x00400000
1219 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1221 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1223 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1226 * Private create options used by the ntcreatex processing code. From Samba4.
1227 * We reuse some ignored flags for private use. Passed in the private_flags
1230 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
1231 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
1233 /* Private options for streams support */
1234 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1236 /* Private options for printer support */
1237 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1239 /* Responses when opening a file. */
1240 #define FILE_WAS_SUPERSEDED 0
1241 #define FILE_WAS_OPENED 1
1242 #define FILE_WAS_CREATED 2
1243 #define FILE_WAS_OVERWRITTEN 3
1245 /* File type flags */
1246 #define FILE_TYPE_DISK 0
1247 #define FILE_TYPE_BYTE_MODE_PIPE 1
1248 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1249 #define FILE_TYPE_PRINTER 3
1250 #define FILE_TYPE_COMM_DEVICE 4
1251 #define FILE_TYPE_UNKNOWN 0xFFFF
1253 /* Flag for NT transact rename call. */
1254 #define RENAME_REPLACE_IF_EXISTS 1
1256 /* flags for SMBntrename call (from Samba4) */
1257 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1258 #define RENAME_FLAG_HARD_LINK 0x103
1259 #define RENAME_FLAG_RENAME 0x104
1260 #define RENAME_FLAG_COPY 0x105
1262 /* Filesystem Attributes. */
1263 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1264 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1265 #define FILE_UNICODE_ON_DISK 0x00000004
1266 /* According to cifs9f, this is 4, not 8 */
1267 /* Acconding to testing, this actually sets the security attribute! */
1268 #define FILE_PERSISTENT_ACLS 0x00000008
1269 #define FILE_FILE_COMPRESSION 0x00000010
1270 #define FILE_VOLUME_QUOTAS 0x00000020
1271 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1272 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1273 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1274 #define FS_LFN_APIS 0x00004000
1275 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1276 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1277 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1278 #define FILE_NAMED_STREAMS 0x00040000
1279 #define FILE_READ_ONLY_VOLUME 0x00080000
1281 /* ChangeNotify flags. */
1282 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1283 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1284 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1285 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1286 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1287 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1288 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1289 #define FILE_NOTIFY_CHANGE_EA 0x080
1290 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1291 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1292 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1293 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1295 #define FILE_NOTIFY_CHANGE_NAME \
1296 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1298 /* change notify action results */
1299 #define NOTIFY_ACTION_ADDED 1
1300 #define NOTIFY_ACTION_REMOVED 2
1301 #define NOTIFY_ACTION_MODIFIED 3
1302 #define NOTIFY_ACTION_OLD_NAME 4
1303 #define NOTIFY_ACTION_NEW_NAME 5
1304 #define NOTIFY_ACTION_ADDED_STREAM 6
1305 #define NOTIFY_ACTION_REMOVED_STREAM 7
1306 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1309 /* where to find the base of the SMB packet proper */
1310 #define smb_base(buf) (((char *)(buf))+4)
1312 /* we don't allow server strings to be longer than 48 characters as
1313 otherwise NT will not honour the announce packets */
1314 #define MAX_SERVER_STRING_LENGTH 48
1317 #define SMB_SUCCESS 0 /* The request was successful. */
1320 void dfs_unlogin(void);
1321 extern int dcelogin_atmost_once
;
1325 char *strdup(char *s
);
1332 /* This was set by JHT in liaison with Jeremy Allison early 1997
1334 * Version 4.0 - never made public
1335 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1336 * - Reappeared in 1.9.16p11 with fixed smbd services
1337 * Version 4.20 - To indicate that nmbd and browsing now works better
1338 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1340 * Note: In the presence of NT4.X do not set above 4.9
1341 * Setting this above 4.9 can have undesired side-effects.
1342 * This may change again in Samba-3.0 after further testing. JHT
1345 #define DEFAULT_MAJOR_VERSION 0x04
1346 #define DEFAULT_MINOR_VERSION 0x09
1348 /* Browser Election Values */
1349 #define BROWSER_ELECTION_VERSION 0x010f
1350 #define BROWSER_CONSTANT 0xaa55
1352 /* Sercurity mode bits. */
1353 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1354 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1355 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1356 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1358 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1360 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1361 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1362 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1363 #define FLAGS2_UNKNOWN_BIT4 0x0010
1364 #define FLAGS2_IS_LONG_NAME 0x0040
1365 #define FLAGS2_EXTENDED_SECURITY 0x0800
1366 #define FLAGS2_DFS_PATHNAMES 0x1000
1367 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1368 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1369 #define FLAGS2_UNICODE_STRINGS 0x8000
1371 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1373 /* TCONX Flag (smb_vwv2). */
1374 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1376 /* File Status Flags. See:
1378 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1382 #define NO_SUBSTREAMS 0x2
1383 #define NO_REPARSETAG 0x4
1385 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1387 #define CAP_RAW_MODE 0x0001
1388 #define CAP_MPX_MODE 0x0002
1389 #define CAP_UNICODE 0x0004
1390 #define CAP_LARGE_FILES 0x0008
1391 #define CAP_NT_SMBS 0x0010
1392 #define CAP_RPC_REMOTE_APIS 0x0020
1393 #define CAP_STATUS32 0x0040
1394 #define CAP_LEVEL_II_OPLOCKS 0x0080
1395 #define CAP_LOCK_AND_READ 0x0100
1396 #define CAP_NT_FIND 0x0200
1397 #define CAP_DFS 0x1000
1398 #define CAP_W2K_SMBS 0x2000
1399 #define CAP_LARGE_READX 0x4000
1400 #define CAP_LARGE_WRITEX 0x8000
1401 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1402 #define CAP_EXTENDED_SECURITY 0x80000000
1404 /* protocol types. It assumes that higher protocols include lower protocols
1406 enum protocol_types
{
1416 /* security levels */
1417 enum security_types
{SEC_SHARE
,SEC_USER
,SEC_SERVER
,SEC_DOMAIN
,SEC_ADS
};
1427 /* printing types */
1428 enum printing_types
{PRINT_BSD
,PRINT_SYSV
,PRINT_AIX
,PRINT_HPUX
,
1429 PRINT_QNX
,PRINT_PLP
,PRINT_LPRNG
,PRINT_SOFTQ
,
1430 PRINT_CUPS
,PRINT_LPRNT
,PRINT_LPROS2
,PRINT_IPRINT
1431 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1432 ,PRINT_TEST
,PRINT_VLP
1433 #endif /* DEVELOPER */
1436 /* LDAP schema types */
1437 enum schema_types
{SCHEMA_COMPAT
, SCHEMA_AD
, SCHEMA_SAMBA
};
1439 /* LDAP SSL options */
1440 enum ldap_ssl_types
{LDAP_SSL_OFF
, LDAP_SSL_START_TLS
};
1442 /* LDAP PASSWD SYNC methods */
1443 enum ldap_passwd_sync_types
{LDAP_PASSWD_SYNC_ON
, LDAP_PASSWD_SYNC_OFF
, LDAP_PASSWD_SYNC_ONLY
};
1446 * This should be under the HAVE_KRB5 flag but since they're used
1447 * in lp_kerberos_method(), they ned to be always available
1448 * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
1449 * so they remain accurate.
1452 #define KERBEROS_VERIFY_SECRETS 0
1453 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1454 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1455 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1457 /* Remote architectures we know about. */
1458 enum remote_arch_types
{RA_UNKNOWN
, RA_WFWG
, RA_OS2
, RA_WIN95
, RA_WINNT
,
1459 RA_WIN2K
, RA_WINXP
, RA_WIN2K3
, RA_VISTA
,
1460 RA_SAMBA
, RA_CIFSFS
, RA_WINXP64
, RA_OSX
};
1463 enum case_handling
{CASE_LOWER
,CASE_UPPER
};
1465 /* ACL compatibility */
1466 enum acl_compatibility
{ACL_COMPAT_AUTO
, ACL_COMPAT_WINNT
, ACL_COMPAT_WIN2K
};
1468 * Global value meaing that the smb_uid field should be
1469 * ingored (in share level security and protocol level == CORE)
1472 #define UID_FIELD_INVALID 0
1473 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1476 * Size of buffer to use when moving files across filesystems.
1478 #define COPYBUF_SIZE (8*1024)
1481 * Map the Core and Extended Oplock requesst bits down
1482 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1488 #define CORE_OPLOCK_REQUEST(inbuf) \
1489 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1492 * Extended protocol.
1494 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1497 #define LOCKING_ANDX_SHARED_LOCK 0x1
1498 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1499 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1500 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1501 #define LOCKING_ANDX_LARGE_FILES 0x10
1504 * Bits we test with.
1505 * Note these must fit into 16-bits.
1508 #define NO_OPLOCK 0x0
1509 #define EXCLUSIVE_OPLOCK 0x1
1510 #define BATCH_OPLOCK 0x2
1511 #define LEVEL_II_OPLOCK 0x4
1513 /* The following are Samba-private. */
1514 #define INTERNAL_OPEN_ONLY 0x8
1515 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1516 * inform potential level2 holders on
1518 #define DEFERRED_OPEN_ENTRY 0x20
1519 #define UNUSED_SHARE_MODE_ENTRY 0x40
1520 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1522 /* None of the following should ever appear in fsp->oplock_request. */
1523 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1525 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1526 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1527 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1529 /* kernel_oplock_message definition.
1531 struct kernel_oplock_message {
1535 unsigned long file_id;
1539 0 uint64_t dev 8 bytes
1540 8 uint64_t inode 8 bytes
1541 16 uint64_t extid 8 bytes
1542 24 unsigned long file_id 4 bytes
1546 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1548 /* file_renamed_message definition.
1550 struct file_renamed_message {
1553 char names[1]; A variable area containing sharepath and filename.
1557 0 uint64_t dev 8 bytes
1558 8 uint64_t inode 8 bytes
1559 16 unit64_t extid 8 bytes
1560 24 char [] name zero terminated namelen bytes
1561 minimum length == 24.
1565 #define MSG_FILE_RENAMED_MIN_SIZE 24
1568 * On the wire return values for oplock types.
1571 #define CORE_OPLOCK_GRANTED (1<<5)
1572 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1574 #define NO_OPLOCK_RETURN 0
1575 #define EXCLUSIVE_OPLOCK_RETURN 1
1576 #define BATCH_OPLOCK_RETURN 2
1577 #define LEVEL_II_OPLOCK_RETURN 3
1580 #define OPLOCKLEVEL_NONE 0
1581 #define OPLOCKLEVEL_II 1
1584 * Capabilities abstracted for different systems.
1587 enum smbd_capability
{
1588 KERNEL_OPLOCK_CAPABILITY
,
1589 DMAPI_ACCESS_CAPABILITY
,
1594 * Kernel oplocks capability flags.
1597 /* Level 2 oplocks are supported natively by kernel oplocks. */
1598 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1600 /* The kernel notifies deferred openers when they can retry the open. */
1601 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1603 /* The kernel notifies smbds when an oplock break times out. */
1604 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1606 /* The kernel notifies smbds when an oplock is broken. */
1607 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1609 struct kernel_oplocks_ops
;
1610 struct kernel_oplocks
{
1611 const struct kernel_oplocks_ops
*ops
;
1616 enum level2_contention_type
{
1617 LEVEL2_CONTEND_ALLOC_SHRINK
,
1618 LEVEL2_CONTEND_ALLOC_GROW
,
1619 LEVEL2_CONTEND_SET_FILE_LEN
,
1620 LEVEL2_CONTEND_FILL_SPARSE
,
1621 LEVEL2_CONTEND_WRITE
,
1622 LEVEL2_CONTEND_WINDOWS_BRL
,
1623 LEVEL2_CONTEND_POSIX_BRL
1626 /* if a kernel does support oplocks then a structure of the following
1627 typee is used to describe how to interact with the kernel */
1628 struct kernel_oplocks_ops
{
1629 bool (*set_oplock
)(struct kernel_oplocks
*ctx
,
1630 files_struct
*fsp
, int oplock_type
);
1631 void (*release_oplock
)(struct kernel_oplocks
*ctx
,
1632 files_struct
*fsp
, int oplock_type
);
1633 void (*contend_level2_oplocks_begin
)(files_struct
*fsp
,
1634 enum level2_contention_type type
);
1635 void (*contend_level2_oplocks_end
)(files_struct
*fsp
,
1636 enum level2_contention_type type
);
1639 #include "smb_macros.h"
1641 #define MAX_NETBIOSNAME_LEN 16
1642 /* DOS character, NetBIOS namestring. Type used on the wire. */
1643 typedef char nstring
[MAX_NETBIOSNAME_LEN
];
1644 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1645 typedef char unstring
[MAX_NETBIOSNAME_LEN
*4];
1647 /* A netbios name structure. */
1651 unsigned int name_type
;
1654 /* A netbios node status array element. */
1655 struct node_status
{
1658 unsigned char flags
;
1661 /* The extra info from a NetBIOS node status query */
1662 struct node_status_extra
{
1663 unsigned char mac_addr
[6];
1664 /* There really is more here ... */
1667 typedef struct user_struct
{
1668 struct user_struct
*next
, *prev
;
1669 uint16 vuid
; /* Tag for this entry. */
1671 char *session_keystr
; /* used by utmp and pam session code.
1675 struct auth_serversupplied_info
*session_info
;
1677 struct auth_ntlmssp_state
*auth_ntlmssp_state
;
1680 struct unix_error_map
{
1688 * Size of new password account encoding string. This is enough space to
1689 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1690 * Do not change unless you are adding new ACB bits!
1693 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1696 Do you want session setups at user level security with a invalid
1697 password to be rejected or allowed in as guest? WinNT rejects them
1698 but it can be a pain as it means "net view" needs to use a password
1700 You have 3 choices in the setting of map_to_guest:
1702 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1703 are rejected. This is the default.
1705 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1706 are rejected, unless the username does not exist, in which case it
1707 is treated as a guest login
1709 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1710 are treated as a guest login
1712 Note that map_to_guest only has an effect in user or server
1716 #define NEVER_MAP_TO_GUEST 0
1717 #define MAP_TO_GUEST_ON_BAD_USER 1
1718 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1719 #define MAP_TO_GUEST_ON_BAD_UID 3
1721 #define SAFE_NETBIOS_CHARS ". -_"
1723 /* The maximum length of a trust account password.
1724 Used when we randomly create it, 15 char passwords
1725 exceed NT4's max password length */
1727 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1731 #define LDAP_PORT 389
1733 #define LDAP_GC_PORT 3268
1735 /* used by the IP comparison function */
1737 struct sockaddr_storage ss
;
1748 struct ea_list
*next
, *prev
;
1749 struct ea_struct ea
;
1752 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1753 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1754 /* EA to use for DOS attributes */
1755 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1756 /* Prefix for DosStreams in the vfs_streams_xattr module */
1757 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1758 /* Prefix for xattrs storing streams. */
1759 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1761 /* map readonly options */
1762 enum mapreadonly_options
{MAP_READONLY_NO
, MAP_READONLY_YES
, MAP_READONLY_PERMISSIONS
};
1764 /* usershare error codes. */
1765 enum usershare_err
{
1767 USERSHARE_MALFORMED_FILE
,
1768 USERSHARE_BAD_VERSION
,
1769 USERSHARE_MALFORMED_PATH
,
1770 USERSHARE_MALFORMED_COMMENT_DEF
,
1771 USERSHARE_MALFORMED_ACL_DEF
,
1773 USERSHARE_PATH_NOT_ABSOLUTE
,
1774 USERSHARE_PATH_IS_DENIED
,
1775 USERSHARE_PATH_NOT_ALLOWED
,
1776 USERSHARE_PATH_NOT_DIRECTORY
,
1777 USERSHARE_POSIX_ERR
,
1778 USERSHARE_MALFORMED_SHARENAME_DEF
,
1779 USERSHARE_BAD_SHARENAME
1782 /* Different reasons for closing a file. */
1783 enum file_close_type
{NORMAL_CLOSE
=0,SHUTDOWN_CLOSE
,ERROR_CLOSE
};
1785 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1786 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1787 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1788 struct smb_extended_info
{
1789 uint32 samba_magic
; /* Always SAMBA_EXTRA_INFO_MAGIC */
1790 uint32 samba_version
; /* Major/Minor/Release/Revision */
1791 uint32 samba_subversion
; /* Prerelease/RC/Vendor patch */
1792 NTTIME samba_gitcommitdate
;
1793 char samba_version_string
[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH
];
1797 struct smb_file_time
{
1798 struct timespec mtime
;
1799 struct timespec atime
;
1800 struct timespec ctime
;
1801 struct timespec create_time
;
1805 * unix_convert_flags
1807 #define UCF_SAVE_LCOMP 0x00000001
1808 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1809 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1810 #define UCF_POSIX_PATHNAMES 0x00000008
1815 struct smb_filename
{
1818 char *original_lcomp
;
1822 /* struct for maintaining the child processes that get spawned from smbd */
1824 struct child_pid
*prev
, *next
;
1828 /* Used to keep track of deferred opens. */
1829 struct deferred_open_record
;
1831 /* Client-side offline caching policy types */
1832 #define CSC_POLICY_MANUAL 0
1833 #define CSC_POLICY_DOCUMENTS 1
1834 #define CSC_POLICY_PROGRAMS 2
1835 #define CSC_POLICY_DISABLE 3
1837 /* Used inside aio code. */