2 Unix SMB/CIFS implementation.
3 SMB parameters and setup, plus a whole lot more.
5 Copyright (C) Andrew Tridgell 1992-2000
6 Copyright (C) John H Terpstra 1996-2002
7 Copyright (C) Luke Kenneth Casson Leighton 1996-2000
8 Copyright (C) Paul Ashton 1998-2000
9 Copyright (C) Simo Sorce 2001-2002
10 Copyright (C) Martin Pool 2002
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 3 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
29 /* logged when starting the various Samba daemons */
30 #define COPYRIGHT_STARTUP_MESSAGE "Copyright Andrew Tridgell and the Samba Team 1992-2010"
33 #if defined(LARGE_SMB_OFF_T)
34 #define BUFFER_SIZE (128*1024)
35 #else /* no large readwrite possible */
36 #define BUFFER_SIZE (0xFFFF)
39 #define SAFETY_MARGIN 1024
40 #define LARGE_WRITEX_HDR_SIZE 65
43 #define DGRAM_PORT 138
46 #define SMB_PORTS "445 139"
48 #define Undefined (-1)
56 #ifndef DEF_CREATE_MASK
57 #define DEF_CREATE_MASK (0755)
60 /* string manipulation flags - see clistr.c and srvstr.c */
61 #define STR_TERMINATE 1
65 #define STR_NOALIGN 16
66 #define STR_TERMINATE_ASCII 128
68 /* how long to wait for secondary SMB packets (milli-seconds) */
69 #define SMB_SECONDARY_WAIT (60*1000)
74 /* this defines the error codes that receive_smb can put in smb_read_error */
75 enum smb_read_errors
{
80 SMB_WRITE_ERROR
, /* This error code can go into the client smb_rw_error. */
83 SMB_DO_NOT_DO_TDIS
, /* cli_close_connection() check for this when smbfs wants to keep tree connected */
87 #define DIR_STRUCT_SIZE 43
89 /* these define the attribute byte as seen by DOS */
90 #define aRONLY (1L<<0) /* 0x01 */
91 #define aHIDDEN (1L<<1) /* 0x02 */
92 #define aSYSTEM (1L<<2) /* 0x04 */
93 #define aVOLID (1L<<3) /* 0x08 */
94 #define aDIR (1L<<4) /* 0x10 */
95 #define aARCH (1L<<5) /* 0x20 */
106 #define DOS_OPEN_RDONLY 0
107 #define DOS_OPEN_WRONLY 1
108 #define DOS_OPEN_RDWR 2
109 #define DOS_OPEN_EXEC 3
110 #define DOS_OPEN_FCB 0xF
112 /* define shifts and masks for share and open modes. */
113 #define OPENX_MODE_MASK 0xF
114 #define DENY_MODE_SHIFT 4
115 #define DENY_MODE_MASK 0x7
116 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
117 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
118 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
119 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
121 /* Sync on open file (not sure if used anymore... ?) */
122 #define FILE_SYNC_OPENMODE (1<<14)
123 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
125 /* open disposition values */
126 #define OPENX_FILE_EXISTS_FAIL 0
127 #define OPENX_FILE_EXISTS_OPEN 1
128 #define OPENX_FILE_EXISTS_TRUNCATE 2
130 /* mask for open disposition. */
131 #define OPENX_FILE_OPEN_MASK 0x3
133 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
134 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
136 /* The above can be OR'ed with... */
137 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
138 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
140 #include "../libcli/util/doserr.h"
142 typedef union unid_t
{
148 * SMB UCS2 (16-bit unicode) internal type.
149 * smb_ucs2_t is *always* in little endian format.
152 #ifdef WORDS_BIGENDIAN
158 /* turn a 7 bit character into a ucs2 character */
159 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
161 /* return an ascii version of a ucs2 character */
162 #define UCS2_TO_CHAR(c) (((c) >> UCS2_SHIFT) & 0xff)
164 /* Copy into a smb_ucs2_t from a possibly unaligned buffer. Return the copied smb_ucs2_t */
165 #define COPY_UCS2_CHAR(dest,src) (((unsigned char *)(dest))[0] = ((unsigned char *)(src))[0],\
166 ((unsigned char *)(dest))[1] = ((unsigned char *)(src))[1], (dest))
168 /* pipe string names */
169 #define PIPE_LANMAN "\\PIPE\\LANMAN"
171 #define MAX_HOURS_LEN 32
174 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
177 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
179 #define LOOKUP_NAME_NONE 0x00000000
180 #define LOOKUP_NAME_ISOLATED 0x00000001 /* Look up unqualified names */
181 #define LOOKUP_NAME_REMOTE 0x00000002 /* Ask others */
182 #define LOOKUP_NAME_GROUP 0x00000004 /* (unused) This is a NASTY hack for
183 valid users = @foo where foo also
184 exists in as user. */
185 #define LOOKUP_NAME_NO_NSS 0x00000008 /* no NSS calls to avoid
186 winbind recursions */
187 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
188 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
189 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
190 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
191 |LOOKUP_NAME_BUILTIN\
194 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
196 |LOOKUP_NAME_BUILTIN\
200 #include "librpc/gen_ndr/idmap.h"
201 #include "librpc/gen_ndr/epmapper.h"
202 #include "librpc/gen_ndr/krb5pac.h"
203 #include "librpc/gen_ndr/dcerpc.h"
205 struct lsa_dom_info
{
213 struct lsa_name_info
{
215 enum lsa_SidType type
;
220 /* Some well-known SIDs */
221 extern const struct dom_sid global_sid_World_Domain
;
222 extern const struct dom_sid global_sid_World
;
223 extern const struct dom_sid global_sid_Creator_Owner_Domain
;
224 extern const struct dom_sid global_sid_NT_Authority
;
225 extern const struct dom_sid global_sid_System
;
226 extern const struct dom_sid global_sid_NULL
;
227 extern const struct dom_sid global_sid_Authenticated_Users
;
228 extern const struct dom_sid global_sid_Network
;
229 extern const struct dom_sid global_sid_Creator_Owner
;
230 extern const struct dom_sid global_sid_Creator_Group
;
231 extern const struct dom_sid global_sid_Anonymous
;
232 extern const struct dom_sid global_sid_Builtin
;
233 extern const struct dom_sid global_sid_Builtin_Administrators
;
234 extern const struct dom_sid global_sid_Builtin_Users
;
235 extern const struct dom_sid global_sid_Builtin_Guests
;
236 extern const struct dom_sid global_sid_Builtin_Power_Users
;
237 extern const struct dom_sid global_sid_Builtin_Account_Operators
;
238 extern const struct dom_sid global_sid_Builtin_Server_Operators
;
239 extern const struct dom_sid global_sid_Builtin_Print_Operators
;
240 extern const struct dom_sid global_sid_Builtin_Backup_Operators
;
241 extern const struct dom_sid global_sid_Builtin_Replicator
;
242 extern const struct dom_sid global_sid_Builtin_PreWin2kAccess
;
243 extern const struct dom_sid global_sid_Unix_Users
;
244 extern const struct dom_sid global_sid_Unix_Groups
;
247 * The complete list of SIDS belonging to this user.
248 * Created when a vuid is registered.
249 * The definition of the user_sids array is as follows :
251 * token->user_sids[0] = primary user SID.
252 * token->user_sids[1] = primary group SID.
253 * token->user_sids[2..num_sids] = supplementary group SIDS.
256 #define PRIMARY_USER_SID_INDEX 0
257 #define PRIMARY_GROUP_SID_INDEX 1
259 typedef struct nt_user_token
{
261 struct dom_sid
*user_sids
;
265 typedef struct unix_user_token
{
272 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
273 typedef struct time_info
{
277 typedef struct write_cache
{
285 #include "fake_file.h"
290 uint64_t position_information
;
292 uint32 private_options
; /* NT Create options, but we only look at
293 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
294 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
295 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
296 * for print files *only*, where
297 * DELETE_ON_CLOSE is not stored in the share
300 unsigned long gen_id
;
304 struct share_mode_entry
;
308 struct rpc_cli_smbd_conn
;
309 struct fncall_context
;
311 struct vfs_fsp_data
{
312 struct vfs_fsp_data
*next
;
313 struct vfs_handle_struct
*owner
;
314 void (*destroy
)(void *p_data
);
316 /* NOTE: This structure contains four pointers so that we can guarantee
317 * that the end of the structure is always both 4-byte and 8-byte aligned.
321 /* the basic packet size, assuming no words or bytes */
324 struct notify_change
{
329 struct notify_mid_map
;
332 struct notify_change_request
;
333 struct sys_notify_backend
;
334 struct sys_notify_context
{
335 struct event_context
*ev
;
336 struct connection_struct
*conn
;
337 void *private_data
; /* For use by the system backend */
340 struct notify_change_buf
{
342 * If no requests are pending, changes are queued here. Simple array,
347 * num_changes == -1 means that we have got a catch-all change, when
348 * asked we just return NT_STATUS_OK without specific changes.
351 struct notify_change
*changes
;
354 * If no changes are around requests are queued here. Using a linked
355 * list, because we have to append at the end and delete from the top.
357 struct notify_change_request
*requests
;
360 struct print_file_data
{
364 typedef struct files_struct
{
365 struct files_struct
*next
, *prev
;
367 struct connection_struct
*conn
;
368 struct fd_handle
*fh
;
369 unsigned int num_smb_operations
;
370 struct file_id file_id
;
371 uint64_t initial_allocation_size
; /* Faked up initial allocation on disk. */
376 struct timeval open_time
;
377 uint32 access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
378 uint32 share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
380 bool update_write_time_triggered
;
381 struct timed_event
*update_write_time_event
;
382 bool update_write_time_on_close
;
383 struct timespec close_write_time
;
384 bool write_time_forced
;
387 int sent_oplock_break
;
388 struct timed_event
*oplock_timeout
;
389 struct lock_struct last_lock_failure
;
390 int current_lock_count
; /* Count the number of outstanding locks and pending locks. */
392 struct share_mode_entry
*pending_break_messages
;
393 int num_pending_break_messages
;
400 bool aio_write_behind
;
402 bool initial_delete_on_close
; /* Only set at NTCreateX if file was created. */
403 bool delete_on_close
;
405 struct smb_filename
*fsp_name
;
407 struct vfs_fsp_data
*vfs_extension
;
408 struct fake_file_handle
*fake_file_handle
;
410 struct notify_change_buf
*notify
;
412 struct files_struct
*base_fsp
; /* placeholder for delete on close */
415 * Read-only cached brlock record, thrown away when the
416 * brlock.tdb seqnum changes. This avoids fetching data from
417 * the brlock.tdb on every read/write call.
420 struct byte_range_lock
*brlock_rec
;
422 struct dptr_struct
*dptr
;
424 /* if not NULL, means this is a print file */
425 struct print_file_data
*print_file
;
429 #include "ntquotas.h"
430 #include "sysquotas.h"
432 struct vuid_cache_entry
{
433 struct auth_serversupplied_info
*server_info
;
439 unsigned int next_entry
;
440 struct vuid_cache_entry array
[VUID_CACHE_SIZE
];
446 } name_compare_entry
;
449 struct trans_state
*next
, *prev
;
453 uint32 max_param_return
;
454 uint32 max_data_return
;
455 uint32 max_setup_return
;
457 uint8 cmd
; /* SMBtrans or SMBtrans2 */
459 char *name
; /* for trans requests */
460 uint16 call
; /* for trans2 and nttrans requests */
462 bool close_on_completion
;
465 unsigned int setup_count
;
468 size_t received_data
;
469 size_t received_param
;
479 * Info about an alternate data stream
482 struct stream_struct
{
484 SMB_OFF_T alloc_size
;
488 /* Include VFS stuff */
490 #include "smb_acls.h"
493 struct dfree_cached_info
{
494 time_t last_dfree_time
;
503 struct share_params
{
507 struct share_iterator
{
511 typedef struct connection_struct
{
512 struct connection_struct
*next
, *prev
;
513 struct smbd_server_connection
*sconn
; /* can be NULL */
514 unsigned cnum
; /* an index passed over the wire */
515 struct share_params
*params
;
517 struct vuid_cache vuid_cache
;
520 bool read_only
; /* Attributes for the current user of the share. */
521 /* Does this filesystem honor
522 sub second timestamps on files
523 and directories when setting time ? */
524 enum timestamp_set_resolution ts_res
;
528 struct vfs_handle_struct
*vfs_handles
; /* for the new plugins */
531 * This represents the user information on this connection. Depending
532 * on the vuid using this tid, this might change per SMB request.
534 struct auth_serversupplied_info
*server_info
;
537 * If the "force group" parameter is set, this is the primary gid that
538 * may be used in the users token, depending on the vuid using this tid.
540 gid_t force_group_gid
;
542 char client_address
[INET6_ADDRSTRLEN
]; /* String version of client IP address. */
544 uint16 vuid
; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
547 time_t lastused_count
;
550 unsigned int num_smb_operations
; /* Count of smb operations on this tree. */
554 /* Semantics requested by the client or forced by the server config. */
557 bool short_case_preserve
;
559 /* Semantics provided by the underlying filesystem. */
561 /* Device number of the directory of the share mount.
562 Used to ensure unique FileIndex returns. */
563 SMB_DEV_T base_share_dev
;
565 name_compare_entry
*hide_list
; /* Per-share list of files to return as hidden. */
566 name_compare_entry
*veto_list
; /* Per-share list of files to veto (never show). */
567 name_compare_entry
*veto_oplock_list
; /* Per-share list of files to refuse oplocks on. */
568 name_compare_entry
*aio_write_behind_list
; /* Per-share list of files to use aio write behind on. */
569 struct dfree_cached_info
*dfree_info
;
570 struct trans_state
*pending_trans
;
571 struct notify_context
*notify_ctx
;
573 struct rpc_pipe_client
*spoolss_pipe
;
577 struct current_user
{
578 connection_struct
*conn
;
581 NT_USER_TOKEN
*nt_user_token
;
584 struct smbd_smb2_request
;
590 uint64_t mid
; /* For compatibility with SMB2. */
601 * Async handling in the main smb processing loop is directed by
602 * outbuf: reply_xxx routines indicate sync behaviour by putting their
603 * reply into "outbuf". If they leave it as NULL, they take of it
604 * themselves, possibly later.
606 * If async handling is wanted, the reply_xxx routine must make sure
607 * that it talloc_move()s the smb_req somewhere else.
613 connection_struct
*conn
;
614 struct smb_perfcount_data pcd
;
617 * Chained request handling
619 struct files_struct
*chain_fsp
;
622 * Here we collect the outbufs from the chain handlers
624 uint8_t *chain_outbuf
;
627 * state information for async smb handling
634 * Back pointer to smb2 request.
636 struct smbd_smb2_request
*smb2req
;
639 /* Defines for the sent_oplock_break field above. */
640 #define NO_BREAK_SENT 0
641 #define BREAK_TO_NONE_SENT 1
642 #define LEVEL_II_BREAK_SENT 2
645 fstring smb_name
; /* user name from the client */
646 fstring unix_name
; /* unix user name of a validated user */
647 fstring domain
; /* domain that the client specified */
650 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
652 enum {LPQ_QUEUED
=0,LPQ_PAUSED
,LPQ_SPOOLING
,LPQ_PRINTING
,LPQ_ERROR
,LPQ_DELETING
,
653 LPQ_OFFLINE
,LPQ_PAPEROUT
,LPQ_PRINTED
,LPQ_DELETED
,LPQ_BLOCKED
,LPQ_USER_INTERVENTION
};
655 typedef struct _print_queue_struct
{
656 int job
; /* normally the UNIX jobid -- see note in
657 printing.c:traverse_fn_delete() */
665 } print_queue_struct
;
667 enum {LPSTAT_OK
, LPSTAT_STOPPED
, LPSTAT_ERROR
};
673 } print_status_struct
;
675 /* used for server information: client, nameserv and ipc */
676 struct server_info_struct
{
680 fstring domain
; /* used ONLY in ipc.c NOT namework.c */
681 bool server_added
; /* used ONLY in ipc.c NOT namework.c */
684 /* used for network interfaces */
686 struct interface
*next
, *prev
;
689 struct sockaddr_storage ip
;
690 struct sockaddr_storage netmask
;
691 struct sockaddr_storage bcast
;
694 /* Internal message queue for deferred opens. */
695 struct pending_message_list
{
696 struct pending_message_list
*next
, *prev
;
697 struct timeval request_time
; /* When was this first issued? */
698 struct timed_event
*te
;
699 struct smb_perfcount_data pcd
;
704 DATA_BLOB private_data
;
707 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
709 /* struct returned by get_share_modes */
710 struct share_mode_entry
{
711 struct server_id pid
;
712 uint64_t op_mid
; /* For compatibility with SMB2 opens. */
714 uint32 access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
715 uint32 share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
716 uint32 private_options
; /* NT Create options, but we only look at
717 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
718 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
719 * smbstatus and swat */
722 unsigned long share_file_id
;
723 uint32 uid
; /* uid of file opener. */
724 uint16 flags
; /* See SHARE_MODE_XX above. */
727 /* oplock break message definition - linearization of share_mode_entry.
730 0 struct server_id pid 4
733 14 uint32 access_mask 4
734 18 uint32 share_access 4
735 22 uint32 private_options 4
737 30 uint32 time usec 4
738 34 uint64 dev 8 bytes
739 42 uint64 inode 8 bytes
740 50 uint64 extid 8 bytes
741 58 unsigned long file_id 4 bytes
742 62 uint32 uid 4 bytes
743 66 uint16 flags 2 bytes
748 #define OP_BREAK_MSG_PID_OFFSET 0
749 #define OP_BREAK_MSG_MID_OFFSET 4
750 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
751 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
752 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
753 #define OP_BREAK_MSG_PRIV_OFFSET 22
754 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
755 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
756 #define OP_BREAK_MSG_DEV_OFFSET 34
757 #define OP_BREAK_MSG_INO_OFFSET 42
758 #define OP_BREAK_MSG_EXTID_OFFSET 50
759 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
760 #define OP_BREAK_MSG_UID_OFFSET 62
761 #define OP_BREAK_MSG_FLAGS_OFFSET 66
763 #ifdef CLUSTER_SUPPORT
764 #define OP_BREAK_MSG_VNN_OFFSET 68
765 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 72
767 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 68
770 struct share_mode_lock
{
771 const char *servicepath
; /* canonicalized. */
772 const char *base_name
;
773 const char *stream_name
;
776 struct share_mode_entry
*share_modes
;
777 UNIX_USER_TOKEN
*delete_token
;
778 bool delete_on_close
;
779 struct timespec old_write_time
;
780 struct timespec changed_write_time
;
783 struct db_record
*record
;
787 * Internal structure of locking.tdb share mode db.
788 * Used by locking.c and libsmbsharemodes.c
791 struct locking_data
{
794 int num_share_mode_entries
;
795 bool delete_on_close
;
796 struct timespec old_write_time
;
797 struct timespec changed_write_time
;
798 uint32 delete_token_size
; /* Only valid if either of
799 the two previous fields
802 struct share_mode_entry dummy
; /* Needed for alignment. */
804 /* The following four entries are implicit
805 struct share_mode_entry modes[num_share_mode_entries];
806 char unix_token[delete_token_size] (divisible by 4).
812 /* Used to store pipe open records for NetFileEnum() */
814 struct pipe_open_rec
{
815 struct server_id pid
;
822 #define NT_HASH_LEN 16
823 #define LM_HASH_LEN 16
825 /* Password history contants. */
826 #define PW_HISTORY_SALT_LEN 16
827 #define SALTED_MD5_HASH_LEN 16
828 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
829 #define MAX_PW_HISTORY_LEN 24
832 * Flags for local user manipulation.
835 #define LOCAL_ADD_USER 0x1
836 #define LOCAL_DELETE_USER 0x2
837 #define LOCAL_DISABLE_USER 0x4
838 #define LOCAL_ENABLE_USER 0x8
839 #define LOCAL_TRUST_ACCOUNT 0x10
840 #define LOCAL_SET_NO_PASSWORD 0x20
841 #define LOCAL_SET_PASSWORD 0x40
842 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
843 #define LOCAL_INTERDOM_ACCOUNT 0x100
844 #define LOCAL_AM_ROOT 0x200 /* Act as root */
846 /* key and data in the connections database - used in smbstatus and smbd */
847 struct connections_key
{
848 struct server_id pid
;
853 struct connections_data
{
855 struct server_id pid
;
859 char servicename
[FSTRING_LEN
];
861 char machine
[FSTRING_LEN
];
863 uint32 bcast_msg_flags
;
867 /* the following are used by loadparm for option lists */
869 P_BOOL
,P_BOOLREV
,P_CHAR
,P_INTEGER
,P_OCTAL
,P_LIST
,
870 P_STRING
,P_USTRING
,P_ENUM
,P_SEP
874 P_LOCAL
,P_GLOBAL
,P_SEPARATOR
,P_NONE
887 bool (*special
)(int snum
, const char *, char **);
888 const struct enum_list
*enum_list
;
899 /* The following flags are used in SWAT */
900 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
901 #define FLAG_SHARE 0x0002 /* file sharing options */
902 #define FLAG_PRINT 0x0004 /* printing options */
903 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
904 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
905 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
906 #define FLAG_DEVELOPER 0x0040 /* No longer used */
907 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
908 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
909 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
910 #define FLAG_META 0x8000 /* A meta directive - not a real parameter */
917 /* offsets into message for common items */
924 #define smb_pidhigh 16
925 #define smb_ss_field 18
951 /* flag defines. CIFS spec 3.1.1 */
952 #define FLAG_SUPPORT_LOCKREAD 0x01
953 #define FLAG_CLIENT_BUF_AVAIL 0x02
954 #define FLAG_RESERVED 0x04
955 #define FLAG_CASELESS_PATHNAMES 0x08
956 #define FLAG_CANONICAL_PATHNAMES 0x10
957 #define FLAG_REQUEST_OPLOCK 0x20
958 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
959 #define FLAG_REPLY 0x80
962 #define SMBmkdir 0x00 /* create directory */
963 #define SMBrmdir 0x01 /* delete directory */
964 #define SMBopen 0x02 /* open file */
965 #define SMBcreate 0x03 /* create file */
966 #define SMBclose 0x04 /* close file */
967 #define SMBflush 0x05 /* flush file */
968 #define SMBunlink 0x06 /* delete file */
969 #define SMBmv 0x07 /* rename file */
970 #define SMBgetatr 0x08 /* get file attributes */
971 #define SMBsetatr 0x09 /* set file attributes */
972 #define SMBread 0x0A /* read from file */
973 #define SMBwrite 0x0B /* write to file */
974 #define SMBlock 0x0C /* lock byte range */
975 #define SMBunlock 0x0D /* unlock byte range */
976 #define SMBctemp 0x0E /* create temporary file */
977 #define SMBmknew 0x0F /* make new file */
978 #define SMBcheckpath 0x10 /* check directory path */
979 #define SMBexit 0x11 /* process exit */
980 #define SMBlseek 0x12 /* seek */
981 #define SMBtcon 0x70 /* tree connect */
982 #define SMBtconX 0x75 /* tree connect and X*/
983 #define SMBtdis 0x71 /* tree disconnect */
984 #define SMBnegprot 0x72 /* negotiate protocol */
985 #define SMBdskattr 0x80 /* get disk attributes */
986 #define SMBsearch 0x81 /* search directory */
987 #define SMBsplopen 0xC0 /* open print spool file */
988 #define SMBsplwr 0xC1 /* write to print spool file */
989 #define SMBsplclose 0xC2 /* close print spool file */
990 #define SMBsplretq 0xC3 /* return print queue */
991 #define SMBsends 0xD0 /* send single block message */
992 #define SMBsendb 0xD1 /* send broadcast message */
993 #define SMBfwdname 0xD2 /* forward user name */
994 #define SMBcancelf 0xD3 /* cancel forward */
995 #define SMBgetmac 0xD4 /* get machine name */
996 #define SMBsendstrt 0xD5 /* send start of multi-block message */
997 #define SMBsendend 0xD6 /* send end of multi-block message */
998 #define SMBsendtxt 0xD7 /* send text of multi-block message */
1000 /* Core+ protocol */
1001 #define SMBlockread 0x13 /* Lock a range and read */
1002 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1003 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
1004 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
1005 #define SMBwritec 0x20 /* secondary write request */
1006 #define SMBwriteclose 0x2c /* write a file then close it */
1008 /* dos extended protocol */
1009 #define SMBreadBraw 0x1A /* read block raw */
1010 #define SMBreadBmpx 0x1B /* read block multiplexed */
1011 #define SMBreadBs 0x1C /* read block (secondary response) */
1012 #define SMBwriteBraw 0x1D /* write block raw */
1013 #define SMBwriteBmpx 0x1E /* write block multiplexed */
1014 #define SMBwriteBs 0x1F /* write block (secondary request) */
1015 #define SMBwriteC 0x20 /* write complete response */
1016 #define SMBsetattrE 0x22 /* set file attributes expanded */
1017 #define SMBgetattrE 0x23 /* get file attributes expanded */
1018 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
1019 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
1020 #define SMBtranss 0x26 /* transaction (secondary request/response) */
1021 #define SMBioctl 0x27 /* IOCTL */
1022 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
1023 #define SMBcopy 0x29 /* copy */
1024 #define SMBmove 0x2A /* move */
1025 #define SMBecho 0x2B /* echo */
1026 #define SMBopenX 0x2D /* open and X */
1027 #define SMBreadX 0x2E /* read and X */
1028 #define SMBwriteX 0x2F /* write and X */
1029 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
1030 #define SMBffirst 0x82 /* find first */
1031 #define SMBfunique 0x83 /* find unique */
1032 #define SMBfclose 0x84 /* find close */
1033 #define SMBkeepalive 0x85 /* keepalive */
1034 #define SMBinvalid 0xFE /* invalid command */
1036 /* Extended 2.0 protocol */
1037 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1038 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1039 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1040 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1041 #define SMBulogoffX 0x74 /* user logoff */
1043 /* NT SMB extensions. */
1044 #define SMBnttrans 0xA0 /* NT transact */
1045 #define SMBnttranss 0xA1 /* NT transact secondary */
1046 #define SMBntcreateX 0xA2 /* NT create and X */
1047 #define SMBntcancel 0xA4 /* NT cancel */
1048 #define SMBntrename 0xA5 /* NT rename */
1050 /* These are the trans subcommands */
1051 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
1052 #define TRANSACT_DCERPCCMD 0x26
1053 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1055 /* These are the TRANS2 sub commands */
1056 #define TRANSACT2_OPEN 0x00
1057 #define TRANSACT2_FINDFIRST 0x01
1058 #define TRANSACT2_FINDNEXT 0x02
1059 #define TRANSACT2_QFSINFO 0x03
1060 #define TRANSACT2_SETFSINFO 0x04
1061 #define TRANSACT2_QPATHINFO 0x05
1062 #define TRANSACT2_SETPATHINFO 0x06
1063 #define TRANSACT2_QFILEINFO 0x07
1064 #define TRANSACT2_SETFILEINFO 0x08
1065 #define TRANSACT2_FSCTL 0x09
1066 #define TRANSACT2_IOCTL 0x0A
1067 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1068 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1069 #define TRANSACT2_MKDIR 0x0D
1070 #define TRANSACT2_SESSION_SETUP 0x0E
1071 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1072 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1074 /* These are the NT transact sub commands. */
1075 #define NT_TRANSACT_CREATE 1
1076 #define NT_TRANSACT_IOCTL 2
1077 #define NT_TRANSACT_SET_SECURITY_DESC 3
1078 #define NT_TRANSACT_NOTIFY_CHANGE 4
1079 #define NT_TRANSACT_RENAME 5
1080 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1081 #define NT_TRANSACT_GET_USER_QUOTA 7
1082 #define NT_TRANSACT_SET_USER_QUOTA 8
1084 /* These are the NT transact_get_user_quota sub commands */
1085 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1086 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1087 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1089 /* Relevant IOCTL codes */
1090 #define IOCTL_QUERY_JOB_INFO 0x530060
1092 /* these are the trans2 sub fields for primary requests */
1093 #define smb_tpscnt smb_vwv0
1094 #define smb_tdscnt smb_vwv1
1095 #define smb_mprcnt smb_vwv2
1096 #define smb_mdrcnt smb_vwv3
1097 #define smb_msrcnt smb_vwv4
1098 #define smb_flags smb_vwv5
1099 #define smb_timeout smb_vwv6
1100 #define smb_pscnt smb_vwv9
1101 #define smb_psoff smb_vwv10
1102 #define smb_dscnt smb_vwv11
1103 #define smb_dsoff smb_vwv12
1104 #define smb_suwcnt smb_vwv13
1105 #define smb_setup smb_vwv14
1106 #define smb_setup0 smb_setup
1107 #define smb_setup1 (smb_setup+2)
1108 #define smb_setup2 (smb_setup+4)
1110 /* these are for the secondary requests */
1111 #define smb_spscnt smb_vwv2
1112 #define smb_spsoff smb_vwv3
1113 #define smb_spsdisp smb_vwv4
1114 #define smb_sdscnt smb_vwv5
1115 #define smb_sdsoff smb_vwv6
1116 #define smb_sdsdisp smb_vwv7
1117 #define smb_sfid smb_vwv8
1119 /* and these for responses */
1120 #define smb_tprcnt smb_vwv0
1121 #define smb_tdrcnt smb_vwv1
1122 #define smb_prcnt smb_vwv3
1123 #define smb_proff smb_vwv4
1124 #define smb_prdisp smb_vwv5
1125 #define smb_drcnt smb_vwv6
1126 #define smb_droff smb_vwv7
1127 #define smb_drdisp smb_vwv8
1129 /* these are for the NT trans primary request. */
1130 #define smb_nt_MaxSetupCount smb_vwv0
1131 #define smb_nt_Flags (smb_vwv0 + 1)
1132 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1133 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1134 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1135 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1136 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1137 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1138 #define smb_nt_DataCount (smb_vwv0 + 27)
1139 #define smb_nt_DataOffset (smb_vwv0 + 31)
1140 #define smb_nt_SetupCount (smb_vwv0 + 35)
1141 #define smb_nt_Function (smb_vwv0 + 36)
1142 #define smb_nt_SetupStart (smb_vwv0 + 38)
1144 /* these are for the NT trans secondary request. */
1145 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1146 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1147 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1148 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1149 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1150 #define smb_nts_DataCount (smb_vwv0 + 23)
1151 #define smb_nts_DataOffset (smb_vwv0 + 27)
1152 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1154 /* these are for the NT trans reply. */
1155 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1156 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1157 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1158 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1159 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1160 #define smb_ntr_DataCount (smb_vwv0 + 23)
1161 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1162 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1164 /* these are for the NT create_and_X */
1165 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1166 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1167 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1168 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1169 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1170 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1171 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1172 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1173 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1174 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1175 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1177 /* this is used on a TConX. I'm not sure the name is very helpful though */
1178 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1179 #define SMB_SHARE_IN_DFS 0x0002
1181 /* Named pipe write mode flags. Used in writeX calls. */
1182 #define PIPE_RAW_MODE 0x4
1183 #define PIPE_START_MESSAGE 0x8
1185 /* File Specific access rights */
1186 #define FILE_READ_DATA 0x00000001
1187 #define FILE_WRITE_DATA 0x00000002
1188 #define FILE_APPEND_DATA 0x00000004
1189 #define FILE_READ_EA 0x00000008 /* File and directory */
1190 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1191 #define FILE_EXECUTE 0x00000020
1192 #define FILE_DELETE_CHILD 0x00000040
1193 #define FILE_READ_ATTRIBUTES 0x00000080
1194 #define FILE_WRITE_ATTRIBUTES 0x00000100
1196 #define FILE_ALL_ACCESS 0x000001FF
1198 /* Directory specific access rights */
1199 #define FILE_LIST_DIRECTORY 0x00000001
1200 #define FILE_ADD_FILE 0x00000002
1201 #define FILE_ADD_SUBDIRECTORY 0x00000004
1202 #define FILE_TRAVERSE 0x00000020
1203 #define FILE_DELETE_CHILD 0x00000040
1205 /* the desired access to use when opening a pipe */
1206 #define DESIRED_ACCESS_PIPE 0x2019f
1208 /* Generic access masks & rights. */
1209 #define DELETE_ACCESS 0x00010000 /* (1L<<16) */
1210 #define READ_CONTROL_ACCESS 0x00020000 /* (1L<<17) */
1211 #define WRITE_DAC_ACCESS 0x00040000 /* (1L<<18) */
1212 #define WRITE_OWNER_ACCESS 0x00080000 /* (1L<<19) */
1213 #define SYNCHRONIZE_ACCESS 0x00100000 /* (1L<<20) */
1215 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1216 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1217 #define GENERIC_ALL_ACCESS 0x10000000 /* (1<<28) */
1218 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1219 #define GENERIC_WRITE_ACCESS 0x40000000 /* (1<<30) */
1220 #define GENERIC_READ_ACCESS ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1222 /* Mapping of generic access rights for files to specific rights. */
1224 /* This maps to 0x1F01FF */
1225 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS|\
1226 SYNCHRONIZE_ACCESS|\
1229 /* This maps to 0x120089 */
1230 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|\
1232 FILE_READ_ATTRIBUTES|\
1236 /* This maps to 0x120116 */
1237 #define FILE_GENERIC_WRITE (SEC_STD_READ_CONTROL|\
1239 FILE_WRITE_ATTRIBUTES|\
1244 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|\
1245 FILE_READ_ATTRIBUTES|\
1249 /* Share specific rights. */
1250 #define SHARE_ALL_ACCESS FILE_GENERIC_ALL
1251 #define SHARE_READ_ONLY (FILE_GENERIC_READ|FILE_EXECUTE)
1253 /* Mapping of access rights to UNIX perms. */
1254 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1255 #define UNIX_ACCESS_R FILE_GENERIC_READ
1256 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1257 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1259 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1260 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1261 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1262 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1263 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1267 * This is the old mapping we used to use. To get W2KSP2 profiles
1268 * working we need to map to the canonical file perms.
1270 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1271 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1272 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1273 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1274 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1275 FILE_APPEND_DATA|FILE_WRITE_DATA)
1276 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1277 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1280 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1283 #define REQUEST_OPLOCK 2
1284 #define REQUEST_BATCH_OPLOCK 4
1285 #define OPEN_DIRECTORY 8
1286 #define EXTENDED_RESPONSE_REQUIRED 0x10
1288 /* ShareAccess field. */
1289 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1290 #define FILE_SHARE_READ 1
1291 #define FILE_SHARE_WRITE 2
1292 #define FILE_SHARE_DELETE 4
1294 /* FileAttributesField */
1295 #define FILE_ATTRIBUTE_READONLY 0x001L
1296 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1297 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1298 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1299 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1300 #define FILE_ATTRIBUTE_NORMAL 0x080L
1301 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1302 #define FILE_ATTRIBUTE_SPARSE 0x200L
1303 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1304 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1305 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1306 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1307 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1308 #define SAMBA_ATTRIBUTES_MASK 0x7F
1310 /* Flags - combined with attributes. */
1311 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1312 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1313 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1314 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1315 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1316 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1317 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1319 /* CreateDisposition field. */
1320 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1321 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1322 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1323 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1324 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1325 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1327 /* CreateOptions field. */
1328 #define FILE_DIRECTORY_FILE 0x0001
1329 #define FILE_WRITE_THROUGH 0x0002
1330 #define FILE_SEQUENTIAL_ONLY 0x0004
1331 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1332 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
1333 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
1334 #define FILE_NON_DIRECTORY_FILE 0x0040
1335 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
1336 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
1337 #define FILE_NO_EA_KNOWLEDGE 0x0200
1338 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1339 #define FILE_RANDOM_ACCESS 0x0800
1340 #define FILE_DELETE_ON_CLOSE 0x1000
1341 #define FILE_OPEN_BY_FILE_ID 0x2000
1342 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
1343 #define FILE_NO_COMPRESSION 0x8000
1344 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
1345 #define FILE_OPEN_REPARSE_POINT 0x00200000
1346 #define FILE_OPEN_NO_RECALL 0x00400000
1347 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1349 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1351 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1354 * Private create options used by the ntcreatex processing code. From Samba4.
1355 * We reuse some ignored flags for private use. Passed in the private_flags
1358 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
1359 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
1361 /* Private options for streams support */
1362 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1364 /* Private options for printer support */
1365 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1367 /* Responses when opening a file. */
1368 #define FILE_WAS_SUPERSEDED 0
1369 #define FILE_WAS_OPENED 1
1370 #define FILE_WAS_CREATED 2
1371 #define FILE_WAS_OVERWRITTEN 3
1373 /* File type flags */
1374 #define FILE_TYPE_DISK 0
1375 #define FILE_TYPE_BYTE_MODE_PIPE 1
1376 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1377 #define FILE_TYPE_PRINTER 3
1378 #define FILE_TYPE_COMM_DEVICE 4
1379 #define FILE_TYPE_UNKNOWN 0xFFFF
1381 /* Flag for NT transact rename call. */
1382 #define RENAME_REPLACE_IF_EXISTS 1
1384 /* flags for SMBntrename call (from Samba4) */
1385 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1386 #define RENAME_FLAG_HARD_LINK 0x103
1387 #define RENAME_FLAG_RENAME 0x104
1388 #define RENAME_FLAG_COPY 0x105
1390 /* Filesystem Attributes. */
1391 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1392 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1393 #define FILE_UNICODE_ON_DISK 0x00000004
1394 /* According to cifs9f, this is 4, not 8 */
1395 /* Acconding to testing, this actually sets the security attribute! */
1396 #define FILE_PERSISTENT_ACLS 0x00000008
1397 #define FILE_FILE_COMPRESSION 0x00000010
1398 #define FILE_VOLUME_QUOTAS 0x00000020
1399 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1400 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1401 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1402 #define FS_LFN_APIS 0x00004000
1403 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1404 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1405 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1406 #define FILE_NAMED_STREAMS 0x00040000
1407 #define FILE_READ_ONLY_VOLUME 0x00080000
1409 /* ChangeNotify flags. */
1410 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1411 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1412 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1413 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1414 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1415 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1416 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1417 #define FILE_NOTIFY_CHANGE_EA 0x080
1418 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1419 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1420 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1421 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1423 #define FILE_NOTIFY_CHANGE_NAME \
1424 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1426 /* change notify action results */
1427 #define NOTIFY_ACTION_ADDED 1
1428 #define NOTIFY_ACTION_REMOVED 2
1429 #define NOTIFY_ACTION_MODIFIED 3
1430 #define NOTIFY_ACTION_OLD_NAME 4
1431 #define NOTIFY_ACTION_NEW_NAME 5
1432 #define NOTIFY_ACTION_ADDED_STREAM 6
1433 #define NOTIFY_ACTION_REMOVED_STREAM 7
1434 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1437 /* where to find the base of the SMB packet proper */
1438 #define smb_base(buf) (((char *)(buf))+4)
1440 /* we don't allow server strings to be longer than 48 characters as
1441 otherwise NT will not honour the announce packets */
1442 #define MAX_SERVER_STRING_LENGTH 48
1445 #define SMB_SUCCESS 0 /* The request was successful. */
1448 void dfs_unlogin(void);
1449 extern int dcelogin_atmost_once
;
1453 char *strdup(char *s
);
1460 /* This was set by JHT in liaison with Jeremy Allison early 1997
1462 * Version 4.0 - never made public
1463 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1464 * - Reappeared in 1.9.16p11 with fixed smbd services
1465 * Version 4.20 - To indicate that nmbd and browsing now works better
1466 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1468 * Note: In the presence of NT4.X do not set above 4.9
1469 * Setting this above 4.9 can have undesired side-effects.
1470 * This may change again in Samba-3.0 after further testing. JHT
1473 #define DEFAULT_MAJOR_VERSION 0x04
1474 #define DEFAULT_MINOR_VERSION 0x09
1476 /* Browser Election Values */
1477 #define BROWSER_ELECTION_VERSION 0x010f
1478 #define BROWSER_CONSTANT 0xaa55
1480 /* Sercurity mode bits. */
1481 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1482 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1483 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1484 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1486 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1488 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1489 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1490 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1491 #define FLAGS2_UNKNOWN_BIT4 0x0010
1492 #define FLAGS2_IS_LONG_NAME 0x0040
1493 #define FLAGS2_EXTENDED_SECURITY 0x0800
1494 #define FLAGS2_DFS_PATHNAMES 0x1000
1495 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1496 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1497 #define FLAGS2_UNICODE_STRINGS 0x8000
1499 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1501 /* TCONX Flag (smb_vwv2). */
1502 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1504 /* File Status Flags. See:
1506 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1510 #define NO_SUBSTREAMS 0x2
1511 #define NO_REPARSETAG 0x4
1513 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1515 #define CAP_RAW_MODE 0x0001
1516 #define CAP_MPX_MODE 0x0002
1517 #define CAP_UNICODE 0x0004
1518 #define CAP_LARGE_FILES 0x0008
1519 #define CAP_NT_SMBS 0x0010
1520 #define CAP_RPC_REMOTE_APIS 0x0020
1521 #define CAP_STATUS32 0x0040
1522 #define CAP_LEVEL_II_OPLOCKS 0x0080
1523 #define CAP_LOCK_AND_READ 0x0100
1524 #define CAP_NT_FIND 0x0200
1525 #define CAP_DFS 0x1000
1526 #define CAP_W2K_SMBS 0x2000
1527 #define CAP_LARGE_READX 0x4000
1528 #define CAP_LARGE_WRITEX 0x8000
1529 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1530 #define CAP_EXTENDED_SECURITY 0x80000000
1532 /* protocol types. It assumes that higher protocols include lower protocols
1534 enum protocol_types
{
1544 /* security levels */
1545 enum security_types
{SEC_SHARE
,SEC_USER
,SEC_SERVER
,SEC_DOMAIN
,SEC_ADS
};
1555 /* printing types */
1556 enum printing_types
{PRINT_BSD
,PRINT_SYSV
,PRINT_AIX
,PRINT_HPUX
,
1557 PRINT_QNX
,PRINT_PLP
,PRINT_LPRNG
,PRINT_SOFTQ
,
1558 PRINT_CUPS
,PRINT_LPRNT
,PRINT_LPROS2
,PRINT_IPRINT
1559 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1560 ,PRINT_TEST
,PRINT_VLP
1561 #endif /* DEVELOPER */
1564 /* LDAP schema types */
1565 enum schema_types
{SCHEMA_COMPAT
, SCHEMA_AD
, SCHEMA_SAMBA
};
1567 /* LDAP SSL options */
1568 enum ldap_ssl_types
{LDAP_SSL_OFF
, LDAP_SSL_START_TLS
};
1570 /* LDAP PASSWD SYNC methods */
1571 enum ldap_passwd_sync_types
{LDAP_PASSWD_SYNC_ON
, LDAP_PASSWD_SYNC_OFF
, LDAP_PASSWD_SYNC_ONLY
};
1573 /* Remote architectures we know about. */
1574 enum remote_arch_types
{RA_UNKNOWN
, RA_WFWG
, RA_OS2
, RA_WIN95
, RA_WINNT
,
1575 RA_WIN2K
, RA_WINXP
, RA_WIN2K3
, RA_VISTA
,
1576 RA_SAMBA
, RA_CIFSFS
, RA_WINXP64
};
1579 enum case_handling
{CASE_LOWER
,CASE_UPPER
};
1581 /* ACL compatibility */
1582 enum acl_compatibility
{ACL_COMPAT_AUTO
, ACL_COMPAT_WINNT
, ACL_COMPAT_WIN2K
};
1584 * Global value meaing that the smb_uid field should be
1585 * ingored (in share level security and protocol level == CORE)
1588 #define UID_FIELD_INVALID 0
1589 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1592 * Size of buffer to use when moving files across filesystems.
1594 #define COPYBUF_SIZE (8*1024)
1597 * Map the Core and Extended Oplock requesst bits down
1598 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1604 #define CORE_OPLOCK_REQUEST(inbuf) \
1605 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1608 * Extended protocol.
1610 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1613 #define LOCKING_ANDX_SHARED_LOCK 0x1
1614 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1615 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1616 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1617 #define LOCKING_ANDX_LARGE_FILES 0x10
1620 * Bits we test with.
1621 * Note these must fit into 16-bits.
1624 #define NO_OPLOCK 0x0
1625 #define EXCLUSIVE_OPLOCK 0x1
1626 #define BATCH_OPLOCK 0x2
1627 #define LEVEL_II_OPLOCK 0x4
1629 /* The following are Samba-private. */
1630 #define INTERNAL_OPEN_ONLY 0x8
1631 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1632 * inform potential level2 holders on
1634 #define DEFERRED_OPEN_ENTRY 0x20
1635 #define UNUSED_SHARE_MODE_ENTRY 0x40
1636 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1638 /* None of the following should ever appear in fsp->oplock_request. */
1639 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1641 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1642 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1643 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1645 /* kernel_oplock_message definition.
1647 struct kernel_oplock_message {
1651 unsigned long file_id;
1655 0 uint64_t dev 8 bytes
1656 8 uint64_t inode 8 bytes
1657 16 uint64_t extid 8 bytes
1658 24 unsigned long file_id 4 bytes
1662 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1664 /* file_renamed_message definition.
1666 struct file_renamed_message {
1669 char names[1]; A variable area containing sharepath and filename.
1673 0 uint64_t dev 8 bytes
1674 8 uint64_t inode 8 bytes
1675 16 unit64_t extid 8 bytes
1676 24 char [] name zero terminated namelen bytes
1677 minimum length == 24.
1681 #define MSG_FILE_RENAMED_MIN_SIZE 24
1684 * On the wire return values for oplock types.
1687 #define CORE_OPLOCK_GRANTED (1<<5)
1688 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1690 #define NO_OPLOCK_RETURN 0
1691 #define EXCLUSIVE_OPLOCK_RETURN 1
1692 #define BATCH_OPLOCK_RETURN 2
1693 #define LEVEL_II_OPLOCK_RETURN 3
1696 #define OPLOCKLEVEL_NONE 0
1697 #define OPLOCKLEVEL_II 1
1700 * Capabilities abstracted for different systems.
1703 enum smbd_capability
{
1704 KERNEL_OPLOCK_CAPABILITY
,
1705 DMAPI_ACCESS_CAPABILITY
,
1710 * Kernel oplocks capability flags.
1713 /* Level 2 oplocks are supported natively by kernel oplocks. */
1714 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1716 /* The kernel notifies deferred openers when they can retry the open. */
1717 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1719 /* The kernel notifies smbds when an oplock break times out. */
1720 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1722 /* The kernel notifies smbds when an oplock is broken. */
1723 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1725 struct kernel_oplocks_ops
;
1726 struct kernel_oplocks
{
1727 const struct kernel_oplocks_ops
*ops
;
1732 enum level2_contention_type
{
1733 LEVEL2_CONTEND_ALLOC_SHRINK
,
1734 LEVEL2_CONTEND_ALLOC_GROW
,
1735 LEVEL2_CONTEND_SET_FILE_LEN
,
1736 LEVEL2_CONTEND_FILL_SPARSE
,
1737 LEVEL2_CONTEND_WRITE
,
1738 LEVEL2_CONTEND_WINDOWS_BRL
,
1739 LEVEL2_CONTEND_POSIX_BRL
1742 /* if a kernel does support oplocks then a structure of the following
1743 typee is used to describe how to interact with the kernel */
1744 struct kernel_oplocks_ops
{
1745 bool (*set_oplock
)(struct kernel_oplocks
*ctx
,
1746 files_struct
*fsp
, int oplock_type
);
1747 void (*release_oplock
)(struct kernel_oplocks
*ctx
,
1748 files_struct
*fsp
, int oplock_type
);
1749 void (*contend_level2_oplocks_begin
)(files_struct
*fsp
,
1750 enum level2_contention_type type
);
1751 void (*contend_level2_oplocks_end
)(files_struct
*fsp
,
1752 enum level2_contention_type type
);
1755 #include "smb_macros.h"
1757 #define MAX_NETBIOSNAME_LEN 16
1758 /* DOS character, NetBIOS namestring. Type used on the wire. */
1759 typedef char nstring
[MAX_NETBIOSNAME_LEN
];
1760 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1761 typedef char unstring
[MAX_NETBIOSNAME_LEN
*4];
1763 /* A netbios name structure. */
1767 unsigned int name_type
;
1770 /* A netbios node status array element. */
1771 typedef struct node_status_
{
1774 unsigned char flags
;
1775 } NODE_STATUS_STRUCT
;
1777 /* The extra info from a NetBIOS node status query */
1778 struct node_status_extra
{
1779 unsigned char mac_addr
[6];
1780 /* There really is more here ... */
1783 typedef struct user_struct
{
1784 struct user_struct
*next
, *prev
;
1785 uint16 vuid
; /* Tag for this entry. */
1787 char *session_keystr
; /* used by utmp and pam session code.
1791 struct auth_serversupplied_info
*server_info
;
1793 struct auth_ntlmssp_state
*auth_ntlmssp_state
;
1796 struct unix_error_map
{
1804 * Size of new password account encoding string. This is enough space to
1805 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1806 * Do not change unless you are adding new ACB bits!
1809 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1812 Do you want session setups at user level security with a invalid
1813 password to be rejected or allowed in as guest? WinNT rejects them
1814 but it can be a pain as it means "net view" needs to use a password
1816 You have 3 choices in the setting of map_to_guest:
1818 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1819 are rejected. This is the default.
1821 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1822 are rejected, unless the username does not exist, in which case it
1823 is treated as a guest login
1825 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1826 are treated as a guest login
1828 Note that map_to_guest only has an effect in user or server
1832 #define NEVER_MAP_TO_GUEST 0
1833 #define MAP_TO_GUEST_ON_BAD_USER 1
1834 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1835 #define MAP_TO_GUEST_ON_BAD_UID 3
1837 #define SAFE_NETBIOS_CHARS ". -_"
1839 /* The maximum length of a trust account password.
1840 Used when we randomly create it, 15 char passwords
1841 exceed NT4's max password length */
1843 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1845 #include "popt_common.h"
1849 #define LDAP_PORT 389
1851 #define LDAP_GC_PORT 3268
1853 /* used by the IP comparison function */
1855 struct sockaddr_storage ss
;
1859 /* Special name type used to cause a _kerberos DNS lookup. */
1860 #define KDC_NAME_TYPE 0xDCDC
1869 struct ea_list
*next
, *prev
;
1870 struct ea_struct ea
;
1873 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1874 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1875 /* EA to use for DOS attributes */
1876 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1877 /* Prefix for DosStreams in the vfs_streams_xattr module */
1878 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1879 /* Prefix for xattrs storing streams. */
1880 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1882 #define UUID_SIZE 16
1884 #define UUID_FLAT_SIZE 16
1885 typedef struct uuid_flat
{
1886 uint8 info
[UUID_FLAT_SIZE
];
1889 /* map readonly options */
1890 enum mapreadonly_options
{MAP_READONLY_NO
, MAP_READONLY_YES
, MAP_READONLY_PERMISSIONS
};
1892 /* usershare error codes. */
1893 enum usershare_err
{
1895 USERSHARE_MALFORMED_FILE
,
1896 USERSHARE_BAD_VERSION
,
1897 USERSHARE_MALFORMED_PATH
,
1898 USERSHARE_MALFORMED_COMMENT_DEF
,
1899 USERSHARE_MALFORMED_ACL_DEF
,
1901 USERSHARE_PATH_NOT_ABSOLUTE
,
1902 USERSHARE_PATH_IS_DENIED
,
1903 USERSHARE_PATH_NOT_ALLOWED
,
1904 USERSHARE_PATH_NOT_DIRECTORY
,
1905 USERSHARE_POSIX_ERR
,
1906 USERSHARE_MALFORMED_SHARENAME_DEF
,
1907 USERSHARE_BAD_SHARENAME
1910 /* Different reasons for closing a file. */
1911 enum file_close_type
{NORMAL_CLOSE
=0,SHUTDOWN_CLOSE
,ERROR_CLOSE
};
1913 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1914 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1915 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1916 struct smb_extended_info
{
1917 uint32 samba_magic
; /* Always SAMBA_EXTRA_INFO_MAGIC */
1918 uint32 samba_version
; /* Major/Minor/Release/Revision */
1919 uint32 samba_subversion
; /* Prerelease/RC/Vendor patch */
1920 NTTIME samba_gitcommitdate
;
1921 char samba_version_string
[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH
];
1925 struct smb_file_time
{
1926 struct timespec mtime
;
1927 struct timespec atime
;
1928 struct timespec ctime
;
1929 struct timespec create_time
;
1933 * unix_convert_flags
1935 #define UCF_SAVE_LCOMP 0x00000001
1936 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1937 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1938 #define UCF_POSIX_PATHNAMES 0x00000008
1943 struct smb_filename
{
1946 char *original_lcomp
;
1950 /* struct for maintaining the child processes that get spawned from smbd */
1952 struct child_pid
*prev
, *next
;
1956 /* Used to keep track of deferred opens. */
1957 struct deferred_open_record
;
1959 /* Client-side offline caching policy types */
1960 #define CSC_POLICY_MANUAL 0
1961 #define CSC_POLICY_DOCUMENTS 1
1962 #define CSC_POLICY_PROGRAMS 2
1963 #define CSC_POLICY_DISABLE 3