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-2009"
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_EXPLICIT 0x00000008 /* Only include
186 explicitly mapped names and not
187 the Unix {User,Group} domain */
188 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
189 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
190 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
191 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
192 |LOOKUP_NAME_BUILTIN\
195 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
197 |LOOKUP_NAME_BUILTIN\
202 * @brief Security Identifier
204 * @sa http://msdn.microsoft.com/library/default.asp?url=/library/en-us/security/accctrl_38yn.asp
206 typedef struct dom_sid DOM_SID
;
216 ID_TYPE_NOT_SPECIFIED
= 0,
229 enum id_mapping status
;
232 #include "librpc/gen_ndr/misc.h"
233 #include "librpc/gen_ndr/security.h"
234 #include "librpc/ndr/libndr.h"
235 #include "librpc/gen_ndr/lsa.h"
236 #include "librpc/gen_ndr/dfs.h"
237 #include "librpc/gen_ndr/winreg.h"
238 #include "librpc/gen_ndr/initshutdown.h"
239 #include "librpc/gen_ndr/eventlog.h"
240 #include "librpc/gen_ndr/srvsvc.h"
241 #include "librpc/gen_ndr/wkssvc.h"
242 #include "librpc/gen_ndr/echo.h"
243 #include "librpc/gen_ndr/svcctl.h"
244 #include "librpc/gen_ndr/netlogon.h"
245 #include "librpc/gen_ndr/samr.h"
246 #include "librpc/gen_ndr/dssetup.h"
247 #include "librpc/gen_ndr/epmapper.h"
248 #include "librpc/gen_ndr/libnet_join.h"
249 #include "librpc/gen_ndr/krb5pac.h"
250 #include "librpc/gen_ndr/ntsvcs.h"
251 #include "librpc/gen_ndr/nbt.h"
252 #include "librpc/gen_ndr/drsuapi.h"
253 #include "librpc/gen_ndr/drsblobs.h"
254 #include "librpc/gen_ndr/spoolss.h"
255 #include "librpc/gen_ndr/dcerpc.h"
256 #include "librpc/gen_ndr/ndr_dcerpc.h"
258 struct lsa_dom_info
{
266 struct lsa_name_info
{
268 enum lsa_SidType type
;
273 /* Some well-known SIDs */
274 extern const DOM_SID global_sid_World_Domain
;
275 extern const DOM_SID global_sid_World
;
276 extern const DOM_SID global_sid_Creator_Owner_Domain
;
277 extern const DOM_SID global_sid_NT_Authority
;
278 extern const DOM_SID global_sid_System
;
279 extern const DOM_SID global_sid_NULL
;
280 extern const DOM_SID global_sid_Authenticated_Users
;
281 extern const DOM_SID global_sid_Network
;
282 extern const DOM_SID global_sid_Creator_Owner
;
283 extern const DOM_SID global_sid_Creator_Group
;
284 extern const DOM_SID global_sid_Anonymous
;
285 extern const DOM_SID global_sid_Builtin
;
286 extern const DOM_SID global_sid_Builtin_Administrators
;
287 extern const DOM_SID global_sid_Builtin_Users
;
288 extern const DOM_SID global_sid_Builtin_Guests
;
289 extern const DOM_SID global_sid_Builtin_Power_Users
;
290 extern const DOM_SID global_sid_Builtin_Account_Operators
;
291 extern const DOM_SID global_sid_Builtin_Server_Operators
;
292 extern const DOM_SID global_sid_Builtin_Print_Operators
;
293 extern const DOM_SID global_sid_Builtin_Backup_Operators
;
294 extern const DOM_SID global_sid_Builtin_Replicator
;
295 extern const DOM_SID global_sid_Builtin_PreWin2kAccess
;
296 extern const DOM_SID global_sid_Unix_Users
;
297 extern const DOM_SID global_sid_Unix_Groups
;
300 * The complete list of SIDS belonging to this user.
301 * Created when a vuid is registered.
302 * The definition of the user_sids array is as follows :
304 * token->user_sids[0] = primary user SID.
305 * token->user_sids[1] = primary group SID.
306 * token->user_sids[2..num_sids] = supplementary group SIDS.
309 #define PRIMARY_USER_SID_INDEX 0
310 #define PRIMARY_GROUP_SID_INDEX 1
312 typedef struct nt_user_token
{
318 typedef struct unix_user_token
{
325 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
326 typedef struct time_info
{
330 typedef struct write_cache
{
339 smb_ucs2_t
*origname
;
340 smb_ucs2_t
*filename
;
341 SMB_STRUCT_STAT
*statinfo
;
344 #include "fake_file.h"
349 uint64_t position_information
;
351 uint32 private_options
; /* NT Create options, but we only look at
352 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
353 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB (Except
354 * for print files *only*, where
355 * DELETE_ON_CLOSE is not stored in the share
358 unsigned long gen_id
;
362 struct share_mode_entry
;
367 struct rpc_cli_smbd_conn
;
368 struct fncall_context
;
370 struct vfs_fsp_data
{
371 struct vfs_fsp_data
*next
;
372 struct vfs_handle_struct
*owner
;
373 void (*destroy
)(void *p_data
);
375 /* NOTE: This structure contains four pointers so that we can guarantee
376 * that the end of the structure is always both 4-byte and 8-byte aligned.
380 /* the basic packet size, assuming no words or bytes */
383 struct notify_change
{
388 struct notify_mid_map
;
391 struct notify_change_request
;
392 struct sys_notify_backend
;
393 struct sys_notify_context
{
394 struct event_context
*ev
;
395 struct connection_struct
*conn
;
396 void *private_data
; /* For use by the system backend */
399 struct notify_change_buf
{
401 * If no requests are pending, changes are queued here. Simple array,
406 * num_changes == -1 means that we have got a catch-all change, when
407 * asked we just return NT_STATUS_OK without specific changes.
410 struct notify_change
*changes
;
413 * If no changes are around requests are queued here. Using a linked
414 * list, because we have to append at the end and delete from the top.
416 struct notify_change_request
*requests
;
419 typedef struct files_struct
{
420 struct files_struct
*next
, *prev
;
422 struct connection_struct
*conn
;
423 struct fd_handle
*fh
;
424 unsigned int num_smb_operations
;
425 uint16 rap_print_jobid
;
426 struct file_id file_id
;
427 uint64_t initial_allocation_size
; /* Faked up initial allocation on disk. */
432 struct timeval open_time
;
433 uint32 access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
434 uint32 share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
436 bool update_write_time_triggered
;
437 struct timed_event
*update_write_time_event
;
438 bool update_write_time_on_close
;
439 struct timespec close_write_time
;
440 bool write_time_forced
;
443 int sent_oplock_break
;
444 struct timed_event
*oplock_timeout
;
445 struct lock_struct last_lock_failure
;
446 int current_lock_count
; /* Count the number of outstanding locks and pending locks. */
448 struct share_mode_entry
*pending_break_messages
;
449 int num_pending_break_messages
;
457 bool aio_write_behind
;
459 bool initial_delete_on_close
; /* Only set at NTCreateX if file was created. */
463 struct vfs_fsp_data
*vfs_extension
;
464 struct fake_file_handle
*fake_file_handle
;
466 struct notify_change_buf
*notify
;
468 struct files_struct
*base_fsp
; /* placeholder for delete on close */
471 #include "ntquotas.h"
472 #include "sysquotas.h"
474 struct vuid_cache_entry
{
475 struct auth_serversupplied_info
*server_info
;
482 unsigned int next_entry
;
483 struct vuid_cache_entry array
[VUID_CACHE_SIZE
];
489 } name_compare_entry
;
492 struct trans_state
*next
, *prev
;
496 uint32 max_param_return
;
497 uint32 max_data_return
;
498 uint32 max_setup_return
;
500 uint8 cmd
; /* SMBtrans or SMBtrans2 */
502 char *name
; /* for trans requests */
503 uint16 call
; /* for trans2 and nttrans requests */
505 bool close_on_completion
;
508 unsigned int setup_count
;
511 size_t received_data
;
512 size_t received_param
;
522 * Info about an alternate data stream
525 struct stream_struct
{
527 SMB_OFF_T alloc_size
;
531 /* Include VFS stuff */
533 #include "smb_acls.h"
536 struct dfree_cached_info
{
537 time_t last_dfree_time
;
546 struct share_params
{
550 struct share_iterator
{
554 typedef struct connection_struct
{
555 struct connection_struct
*next
, *prev
;
556 unsigned cnum
; /* an index passed over the wire */
557 struct share_params
*params
;
559 struct vuid_cache vuid_cache
;
560 struct dptr_struct
*dirptr
;
563 bool read_only
; /* Attributes for the current user of the share. */
564 bool admin_user
; /* Attributes for the current user of the share. */
569 struct vfs_ops vfs
; /* Filesystem operations */
570 struct vfs_ops vfs_opaque
; /* OPAQUE Filesystem operations */
571 struct vfs_handle_struct
*vfs_handles
; /* for the new plugins */
574 * This represents the user information on this connection. Depending
575 * on the vuid using this tid, this might change per SMB request.
577 struct auth_serversupplied_info
*server_info
;
580 * If the "force group" parameter is set, this is the primary gid that
581 * may be used in the users token, depending on the vuid using this tid.
583 gid_t force_group_gid
;
585 char client_address
[INET6_ADDRSTRLEN
]; /* String version of client IP address. */
587 uint16 vuid
; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
590 time_t lastused_count
;
593 unsigned int num_smb_operations
; /* Count of smb operations on this tree. */
597 /* Semantics requested by the client or forced by the server config. */
600 bool short_case_preserve
;
602 /* Semantics provided by the underlying filesystem. */
605 name_compare_entry
*hide_list
; /* Per-share list of files to return as hidden. */
606 name_compare_entry
*veto_list
; /* Per-share list of files to veto (never show). */
607 name_compare_entry
*veto_oplock_list
; /* Per-share list of files to refuse oplocks on. */
608 name_compare_entry
*aio_write_behind_list
; /* Per-share list of files to use aio write behind on. */
609 struct dfree_cached_info
*dfree_info
;
610 struct trans_state
*pending_trans
;
611 struct notify_context
*notify_ctx
;
614 struct current_user
{
615 connection_struct
*conn
;
618 NT_USER_TOKEN
*nt_user_token
;
637 * Async handling in the main smb processing loop is directed by
638 * outbuf: reply_xxx routines indicate sync behaviour by putting their
639 * reply into "outbuf". If they leave it as NULL, they take of it
640 * themselves, possibly later.
642 * If async handling is wanted, the reply_xxx routine must make sure
643 * that it talloc_move()s the smb_req somewhere else.
649 connection_struct
*conn
;
650 struct smb_perfcount_data pcd
;
653 * Chained request handling
655 struct files_struct
*chain_fsp
;
658 * Here we collect the outbufs from the chain handlers
660 uint8_t *chain_outbuf
;
663 * state information for async smb handling
668 /* Defines for the sent_oplock_break field above. */
669 #define NO_BREAK_SENT 0
670 #define BREAK_TO_NONE_SENT 1
671 #define LEVEL_II_BREAK_SENT 2
674 fstring smb_name
; /* user name from the client */
675 fstring unix_name
; /* unix user name of a validated user */
676 fstring domain
; /* domain that the client specified */
679 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
681 enum {LPQ_QUEUED
=0,LPQ_PAUSED
,LPQ_SPOOLING
,LPQ_PRINTING
,LPQ_ERROR
,LPQ_DELETING
,
682 LPQ_OFFLINE
,LPQ_PAPEROUT
,LPQ_PRINTED
,LPQ_DELETED
,LPQ_BLOCKED
,LPQ_USER_INTERVENTION
};
684 typedef struct _print_queue_struct
{
685 int job
; /* normally the UNIX jobid -- see note in
686 printing.c:traverse_fn_delete() */
694 } print_queue_struct
;
696 enum {LPSTAT_OK
, LPSTAT_STOPPED
, LPSTAT_ERROR
};
702 } print_status_struct
;
704 /* used for server information: client, nameserv and ipc */
705 struct server_info_struct
{
709 fstring domain
; /* used ONLY in ipc.c NOT namework.c */
710 bool server_added
; /* used ONLY in ipc.c NOT namework.c */
713 /* used for network interfaces */
715 struct interface
*next
, *prev
;
718 struct sockaddr_storage ip
;
719 struct sockaddr_storage netmask
;
720 struct sockaddr_storage bcast
;
723 /* Internal message queue for deferred opens. */
724 struct pending_message_list
{
725 struct pending_message_list
*next
, *prev
;
726 struct timeval request_time
; /* When was this first issued? */
727 struct timed_event
*te
;
728 struct smb_perfcount_data pcd
;
732 DATA_BLOB private_data
;
735 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
737 /* struct returned by get_share_modes */
738 struct share_mode_entry
{
739 struct server_id pid
;
742 uint32 access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
743 uint32 share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
744 uint32 private_options
; /* NT Create options, but we only look at
745 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
746 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
747 * smbstatus and swat */
750 unsigned long share_file_id
;
751 uint32 uid
; /* uid of file opener. */
752 uint16 flags
; /* See SHARE_MODE_XX above. */
755 /* oplock break message definition - linearization of share_mode_entry.
758 0 struct server_id pid 4
761 8 uint32 access_mask 4
762 12 uint32 share_access 4
763 16 uint32 private_options 4
765 24 uint32 time usec 4
766 28 uint64 dev 8 bytes
767 36 uint64 inode 8 bytes
768 44 uint64 extid 8 bytes
769 52 unsigned long file_id 4 bytes
770 56 uint32 uid 4 bytes
771 60 uint16 flags 2 bytes
775 #ifdef CLUSTER_SUPPORT
776 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 66
778 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 62
781 struct share_mode_lock
{
782 const char *servicepath
; /* canonicalized. */
783 const char *filename
;
786 struct share_mode_entry
*share_modes
;
787 UNIX_USER_TOKEN
*delete_token
;
788 bool delete_on_close
;
789 struct timespec old_write_time
;
790 struct timespec changed_write_time
;
793 struct db_record
*record
;
797 * Internal structure of locking.tdb share mode db.
798 * Used by locking.c and libsmbsharemodes.c
801 struct locking_data
{
804 int num_share_mode_entries
;
805 bool delete_on_close
;
806 struct timespec old_write_time
;
807 struct timespec changed_write_time
;
808 uint32 delete_token_size
; /* Only valid if either of
809 the two previous fields
812 struct share_mode_entry dummy
; /* Needed for alignment. */
814 /* The following four entries are implicit
815 struct share_mode_entry modes[num_share_mode_entries];
816 char unix_token[delete_token_size] (divisible by 4).
822 /* Used to store pipe open records for NetFileEnum() */
824 struct pipe_open_rec
{
825 struct server_id pid
;
832 #define NT_HASH_LEN 16
833 #define LM_HASH_LEN 16
835 /* Password history contants. */
836 #define PW_HISTORY_SALT_LEN 16
837 #define SALTED_MD5_HASH_LEN 16
838 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
839 #define MAX_PW_HISTORY_LEN 24
842 * Flags for account policy.
844 #define AP_MIN_PASSWORD_LEN 1
845 #define AP_PASSWORD_HISTORY 2
846 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
847 #define AP_MAX_PASSWORD_AGE 4
848 #define AP_MIN_PASSWORD_AGE 5
849 #define AP_LOCK_ACCOUNT_DURATION 6
850 #define AP_RESET_COUNT_TIME 7
851 #define AP_BAD_ATTEMPT_LOCKOUT 8
852 #define AP_TIME_TO_LOGOUT 9
853 #define AP_REFUSE_MACHINE_PW_CHANGE 10
856 * Flags for local user manipulation.
859 #define LOCAL_ADD_USER 0x1
860 #define LOCAL_DELETE_USER 0x2
861 #define LOCAL_DISABLE_USER 0x4
862 #define LOCAL_ENABLE_USER 0x8
863 #define LOCAL_TRUST_ACCOUNT 0x10
864 #define LOCAL_SET_NO_PASSWORD 0x20
865 #define LOCAL_SET_PASSWORD 0x40
866 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
867 #define LOCAL_INTERDOM_ACCOUNT 0x100
868 #define LOCAL_AM_ROOT 0x200 /* Act as root */
870 /* key and data in the connections database - used in smbstatus and smbd */
871 struct connections_key
{
872 struct server_id pid
;
877 struct connections_data
{
879 struct server_id pid
;
883 char servicename
[FSTRING_LEN
];
885 char machine
[FSTRING_LEN
];
887 uint32 bcast_msg_flags
;
891 /* the following are used by loadparm for option lists */
893 P_BOOL
,P_BOOLREV
,P_CHAR
,P_INTEGER
,P_OCTAL
,P_LIST
,
894 P_STRING
,P_USTRING
,P_ENUM
,P_SEP
898 P_LOCAL
,P_GLOBAL
,P_SEPARATOR
,P_NONE
911 bool (*special
)(int snum
, const char *, char **);
912 const struct enum_list
*enum_list
;
923 /* The following flags are used in SWAT */
924 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
925 #define FLAG_SHARE 0x0002 /* file sharing options */
926 #define FLAG_PRINT 0x0004 /* printing options */
927 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
928 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
929 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
930 #define FLAG_DEVELOPER 0x0040 /* No longer used */
931 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
932 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
933 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
940 /* offsets into message for common items */
947 #define smb_pidhigh 16
948 #define smb_ss_field 18
974 /* flag defines. CIFS spec 3.1.1 */
975 #define FLAG_SUPPORT_LOCKREAD 0x01
976 #define FLAG_CLIENT_BUF_AVAIL 0x02
977 #define FLAG_RESERVED 0x04
978 #define FLAG_CASELESS_PATHNAMES 0x08
979 #define FLAG_CANONICAL_PATHNAMES 0x10
980 #define FLAG_REQUEST_OPLOCK 0x20
981 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
982 #define FLAG_REPLY 0x80
985 #define SMBmkdir 0x00 /* create directory */
986 #define SMBrmdir 0x01 /* delete directory */
987 #define SMBopen 0x02 /* open file */
988 #define SMBcreate 0x03 /* create file */
989 #define SMBclose 0x04 /* close file */
990 #define SMBflush 0x05 /* flush file */
991 #define SMBunlink 0x06 /* delete file */
992 #define SMBmv 0x07 /* rename file */
993 #define SMBgetatr 0x08 /* get file attributes */
994 #define SMBsetatr 0x09 /* set file attributes */
995 #define SMBread 0x0A /* read from file */
996 #define SMBwrite 0x0B /* write to file */
997 #define SMBlock 0x0C /* lock byte range */
998 #define SMBunlock 0x0D /* unlock byte range */
999 #define SMBctemp 0x0E /* create temporary file */
1000 #define SMBmknew 0x0F /* make new file */
1001 #define SMBcheckpath 0x10 /* check directory path */
1002 #define SMBexit 0x11 /* process exit */
1003 #define SMBlseek 0x12 /* seek */
1004 #define SMBtcon 0x70 /* tree connect */
1005 #define SMBtconX 0x75 /* tree connect and X*/
1006 #define SMBtdis 0x71 /* tree disconnect */
1007 #define SMBnegprot 0x72 /* negotiate protocol */
1008 #define SMBdskattr 0x80 /* get disk attributes */
1009 #define SMBsearch 0x81 /* search directory */
1010 #define SMBsplopen 0xC0 /* open print spool file */
1011 #define SMBsplwr 0xC1 /* write to print spool file */
1012 #define SMBsplclose 0xC2 /* close print spool file */
1013 #define SMBsplretq 0xC3 /* return print queue */
1014 #define SMBsends 0xD0 /* send single block message */
1015 #define SMBsendb 0xD1 /* send broadcast message */
1016 #define SMBfwdname 0xD2 /* forward user name */
1017 #define SMBcancelf 0xD3 /* cancel forward */
1018 #define SMBgetmac 0xD4 /* get machine name */
1019 #define SMBsendstrt 0xD5 /* send start of multi-block message */
1020 #define SMBsendend 0xD6 /* send end of multi-block message */
1021 #define SMBsendtxt 0xD7 /* send text of multi-block message */
1023 /* Core+ protocol */
1024 #define SMBlockread 0x13 /* Lock a range and read */
1025 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1026 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
1027 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
1028 #define SMBwritec 0x20 /* secondary write request */
1029 #define SMBwriteclose 0x2c /* write a file then close it */
1031 /* dos extended protocol */
1032 #define SMBreadBraw 0x1A /* read block raw */
1033 #define SMBreadBmpx 0x1B /* read block multiplexed */
1034 #define SMBreadBs 0x1C /* read block (secondary response) */
1035 #define SMBwriteBraw 0x1D /* write block raw */
1036 #define SMBwriteBmpx 0x1E /* write block multiplexed */
1037 #define SMBwriteBs 0x1F /* write block (secondary request) */
1038 #define SMBwriteC 0x20 /* write complete response */
1039 #define SMBsetattrE 0x22 /* set file attributes expanded */
1040 #define SMBgetattrE 0x23 /* get file attributes expanded */
1041 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
1042 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
1043 #define SMBtranss 0x26 /* transaction (secondary request/response) */
1044 #define SMBioctl 0x27 /* IOCTL */
1045 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
1046 #define SMBcopy 0x29 /* copy */
1047 #define SMBmove 0x2A /* move */
1048 #define SMBecho 0x2B /* echo */
1049 #define SMBopenX 0x2D /* open and X */
1050 #define SMBreadX 0x2E /* read and X */
1051 #define SMBwriteX 0x2F /* write and X */
1052 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
1053 #define SMBffirst 0x82 /* find first */
1054 #define SMBfunique 0x83 /* find unique */
1055 #define SMBfclose 0x84 /* find close */
1056 #define SMBkeepalive 0x85 /* keepalive */
1057 #define SMBinvalid 0xFE /* invalid command */
1059 /* Extended 2.0 protocol */
1060 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1061 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1062 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1063 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1064 #define SMBulogoffX 0x74 /* user logoff */
1066 /* NT SMB extensions. */
1067 #define SMBnttrans 0xA0 /* NT transact */
1068 #define SMBnttranss 0xA1 /* NT transact secondary */
1069 #define SMBntcreateX 0xA2 /* NT create and X */
1070 #define SMBntcancel 0xA4 /* NT cancel */
1071 #define SMBntrename 0xA5 /* NT rename */
1073 /* These are the trans subcommands */
1074 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
1075 #define TRANSACT_DCERPCCMD 0x26
1076 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1078 /* These are the TRANS2 sub commands */
1079 #define TRANSACT2_OPEN 0x00
1080 #define TRANSACT2_FINDFIRST 0x01
1081 #define TRANSACT2_FINDNEXT 0x02
1082 #define TRANSACT2_QFSINFO 0x03
1083 #define TRANSACT2_SETFSINFO 0x04
1084 #define TRANSACT2_QPATHINFO 0x05
1085 #define TRANSACT2_SETPATHINFO 0x06
1086 #define TRANSACT2_QFILEINFO 0x07
1087 #define TRANSACT2_SETFILEINFO 0x08
1088 #define TRANSACT2_FSCTL 0x09
1089 #define TRANSACT2_IOCTL 0x0A
1090 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1091 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1092 #define TRANSACT2_MKDIR 0x0D
1093 #define TRANSACT2_SESSION_SETUP 0x0E
1094 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1095 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1097 /* These are the NT transact sub commands. */
1098 #define NT_TRANSACT_CREATE 1
1099 #define NT_TRANSACT_IOCTL 2
1100 #define NT_TRANSACT_SET_SECURITY_DESC 3
1101 #define NT_TRANSACT_NOTIFY_CHANGE 4
1102 #define NT_TRANSACT_RENAME 5
1103 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1104 #define NT_TRANSACT_GET_USER_QUOTA 7
1105 #define NT_TRANSACT_SET_USER_QUOTA 8
1107 /* These are the NT transact_get_user_quota sub commands */
1108 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1109 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1110 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1112 /* Relevant IOCTL codes */
1113 #define IOCTL_QUERY_JOB_INFO 0x530060
1115 /* these are the trans2 sub fields for primary requests */
1116 #define smb_tpscnt smb_vwv0
1117 #define smb_tdscnt smb_vwv1
1118 #define smb_mprcnt smb_vwv2
1119 #define smb_mdrcnt smb_vwv3
1120 #define smb_msrcnt smb_vwv4
1121 #define smb_flags smb_vwv5
1122 #define smb_timeout smb_vwv6
1123 #define smb_pscnt smb_vwv9
1124 #define smb_psoff smb_vwv10
1125 #define smb_dscnt smb_vwv11
1126 #define smb_dsoff smb_vwv12
1127 #define smb_suwcnt smb_vwv13
1128 #define smb_setup smb_vwv14
1129 #define smb_setup0 smb_setup
1130 #define smb_setup1 (smb_setup+2)
1131 #define smb_setup2 (smb_setup+4)
1133 /* these are for the secondary requests */
1134 #define smb_spscnt smb_vwv2
1135 #define smb_spsoff smb_vwv3
1136 #define smb_spsdisp smb_vwv4
1137 #define smb_sdscnt smb_vwv5
1138 #define smb_sdsoff smb_vwv6
1139 #define smb_sdsdisp smb_vwv7
1140 #define smb_sfid smb_vwv8
1142 /* and these for responses */
1143 #define smb_tprcnt smb_vwv0
1144 #define smb_tdrcnt smb_vwv1
1145 #define smb_prcnt smb_vwv3
1146 #define smb_proff smb_vwv4
1147 #define smb_prdisp smb_vwv5
1148 #define smb_drcnt smb_vwv6
1149 #define smb_droff smb_vwv7
1150 #define smb_drdisp smb_vwv8
1152 /* these are for the NT trans primary request. */
1153 #define smb_nt_MaxSetupCount smb_vwv0
1154 #define smb_nt_Flags (smb_vwv0 + 1)
1155 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1156 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1157 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1158 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1159 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1160 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1161 #define smb_nt_DataCount (smb_vwv0 + 27)
1162 #define smb_nt_DataOffset (smb_vwv0 + 31)
1163 #define smb_nt_SetupCount (smb_vwv0 + 35)
1164 #define smb_nt_Function (smb_vwv0 + 36)
1165 #define smb_nt_SetupStart (smb_vwv0 + 38)
1167 /* these are for the NT trans secondary request. */
1168 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1169 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1170 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1171 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1172 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1173 #define smb_nts_DataCount (smb_vwv0 + 23)
1174 #define smb_nts_DataOffset (smb_vwv0 + 27)
1175 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1177 /* these are for the NT trans reply. */
1178 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1179 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1180 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1181 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1182 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1183 #define smb_ntr_DataCount (smb_vwv0 + 23)
1184 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1185 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1187 /* these are for the NT create_and_X */
1188 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1189 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1190 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1191 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1192 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1193 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1194 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1195 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1196 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1197 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1198 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1200 /* this is used on a TConX. I'm not sure the name is very helpful though */
1201 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1202 #define SMB_SHARE_IN_DFS 0x0002
1204 /* Named pipe write mode flags. Used in writeX calls. */
1205 #define PIPE_RAW_MODE 0x4
1206 #define PIPE_START_MESSAGE 0x8
1208 /* File Specific access rights */
1209 #define FILE_READ_DATA 0x00000001
1210 #define FILE_WRITE_DATA 0x00000002
1211 #define FILE_APPEND_DATA 0x00000004
1212 #define FILE_READ_EA 0x00000008 /* File and directory */
1213 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1214 #define FILE_EXECUTE 0x00000020
1215 #define FILE_DELETE_CHILD 0x00000040
1216 #define FILE_READ_ATTRIBUTES 0x00000080
1217 #define FILE_WRITE_ATTRIBUTES 0x00000100
1219 #define FILE_ALL_ACCESS 0x000001FF
1221 /* Directory specific access rights */
1222 #define FILE_LIST_DIRECTORY 0x00000001
1223 #define FILE_ADD_FILE 0x00000002
1224 #define FILE_ADD_SUBDIRECTORY 0x00000004
1225 #define FILE_TRAVERSE 0x00000020
1226 #define FILE_DELETE_CHILD 0x00000040
1228 /* the desired access to use when opening a pipe */
1229 #define DESIRED_ACCESS_PIPE 0x2019f
1231 /* Generic access masks & rights. */
1232 #define DELETE_ACCESS 0x00010000 /* (1L<<16) */
1233 #define READ_CONTROL_ACCESS 0x00020000 /* (1L<<17) */
1234 #define WRITE_DAC_ACCESS 0x00040000 /* (1L<<18) */
1235 #define WRITE_OWNER_ACCESS 0x00080000 /* (1L<<19) */
1236 #define SYNCHRONIZE_ACCESS 0x00100000 /* (1L<<20) */
1238 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1239 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1240 #define GENERIC_ALL_ACCESS 0x10000000 /* (1<<28) */
1241 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1242 #define GENERIC_WRITE_ACCESS 0x40000000 /* (1<<30) */
1243 #define GENERIC_READ_ACCESS ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1245 /* Mapping of generic access rights for files to specific rights. */
1247 /* This maps to 0x1F01FF */
1248 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1250 /* This maps to 0x120089 */
1251 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1252 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1254 /* This maps to 0x120116 */
1255 #define FILE_GENERIC_WRITE (STD_RIGHT_READ_CONTROL_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1256 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1258 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
1259 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1261 /* Share specific rights. */
1262 #define SHARE_ALL_ACCESS FILE_GENERIC_ALL
1263 #define SHARE_READ_ONLY (FILE_GENERIC_READ|FILE_EXECUTE)
1265 /* Mapping of access rights to UNIX perms. */
1266 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1267 #define UNIX_ACCESS_R FILE_GENERIC_READ
1268 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1269 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1271 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1272 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1273 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1274 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1275 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1279 * This is the old mapping we used to use. To get W2KSP2 profiles
1280 * working we need to map to the canonical file perms.
1282 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1283 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1284 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1285 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1286 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1287 FILE_APPEND_DATA|FILE_WRITE_DATA)
1288 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1289 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1292 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1295 #define REQUEST_OPLOCK 2
1296 #define REQUEST_BATCH_OPLOCK 4
1297 #define OPEN_DIRECTORY 8
1298 #define EXTENDED_RESPONSE_REQUIRED 0x10
1300 /* ShareAccess field. */
1301 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1302 #define FILE_SHARE_READ 1
1303 #define FILE_SHARE_WRITE 2
1304 #define FILE_SHARE_DELETE 4
1306 /* FileAttributesField */
1307 #define FILE_ATTRIBUTE_READONLY 0x001L
1308 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1309 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1310 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1311 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1312 #define FILE_ATTRIBUTE_NORMAL 0x080L
1313 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1314 #define FILE_ATTRIBUTE_SPARSE 0x200L
1315 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1316 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1317 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1318 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1319 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1320 #define SAMBA_ATTRIBUTES_MASK 0x7F
1322 /* Flags - combined with attributes. */
1323 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1324 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1325 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1326 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1327 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1328 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1329 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1331 /* CreateDisposition field. */
1332 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1333 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1334 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1335 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1336 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1337 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1339 /* CreateOptions field. */
1340 #define FILE_DIRECTORY_FILE 0x0001
1341 #define FILE_WRITE_THROUGH 0x0002
1342 #define FILE_SEQUENTIAL_ONLY 0x0004
1343 #define FILE_NON_DIRECTORY_FILE 0x0040
1344 #define FILE_NO_EA_KNOWLEDGE 0x0200
1345 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1346 #define FILE_RANDOM_ACCESS 0x0800
1347 #define FILE_DELETE_ON_CLOSE 0x1000
1348 #define FILE_OPEN_BY_FILE_ID 0x2000
1350 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1352 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1355 * Private create options used by the ntcreatex processing code. From Samba4.
1356 * We reuse some ignored flags for private use.
1358 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x00010000
1359 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x00020000
1361 /* Private options for streams support */
1362 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x00040000
1364 /* Responses when opening a file. */
1365 #define FILE_WAS_SUPERSEDED 0
1366 #define FILE_WAS_OPENED 1
1367 #define FILE_WAS_CREATED 2
1368 #define FILE_WAS_OVERWRITTEN 3
1370 /* File type flags */
1371 #define FILE_TYPE_DISK 0
1372 #define FILE_TYPE_BYTE_MODE_PIPE 1
1373 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1374 #define FILE_TYPE_PRINTER 3
1375 #define FILE_TYPE_COMM_DEVICE 4
1376 #define FILE_TYPE_UNKNOWN 0xFFFF
1378 /* Flag for NT transact rename call. */
1379 #define RENAME_REPLACE_IF_EXISTS 1
1381 /* flags for SMBntrename call (from Samba4) */
1382 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1383 #define RENAME_FLAG_HARD_LINK 0x103
1384 #define RENAME_FLAG_RENAME 0x104
1385 #define RENAME_FLAG_COPY 0x105
1387 /* Filesystem Attributes. */
1388 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1389 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1390 #define FILE_UNICODE_ON_DISK 0x00000004
1391 /* According to cifs9f, this is 4, not 8 */
1392 /* Acconding to testing, this actually sets the security attribute! */
1393 #define FILE_PERSISTENT_ACLS 0x00000008
1394 #define FILE_FILE_COMPRESSION 0x00000010
1395 #define FILE_VOLUME_QUOTAS 0x00000020
1396 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1397 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1398 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1399 #define FS_LFN_APIS 0x00004000
1400 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1401 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1402 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1403 #define FILE_NAMED_STREAMS 0x00040000
1404 #define FILE_READ_ONLY_VOLUME 0x00080000
1406 /* ChangeNotify flags. */
1407 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1408 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1409 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1410 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1411 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1412 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1413 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1414 #define FILE_NOTIFY_CHANGE_EA 0x080
1415 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1416 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1417 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1418 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1420 #define FILE_NOTIFY_CHANGE_NAME \
1421 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1423 /* change notify action results */
1424 #define NOTIFY_ACTION_ADDED 1
1425 #define NOTIFY_ACTION_REMOVED 2
1426 #define NOTIFY_ACTION_MODIFIED 3
1427 #define NOTIFY_ACTION_OLD_NAME 4
1428 #define NOTIFY_ACTION_NEW_NAME 5
1429 #define NOTIFY_ACTION_ADDED_STREAM 6
1430 #define NOTIFY_ACTION_REMOVED_STREAM 7
1431 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1434 /* where to find the base of the SMB packet proper */
1435 #define smb_base(buf) (((char *)(buf))+4)
1437 /* we don't allow server strings to be longer than 48 characters as
1438 otherwise NT will not honour the announce packets */
1439 #define MAX_SERVER_STRING_LENGTH 48
1442 #define SMB_SUCCESS 0 /* The request was successful. */
1445 void dfs_unlogin(void);
1446 extern int dcelogin_atmost_once
;
1450 char *strdup(char *s
);
1454 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1461 /* This was set by JHT in liaison with Jeremy Allison early 1997
1463 * Version 4.0 - never made public
1464 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1465 * - Reappeared in 1.9.16p11 with fixed smbd services
1466 * Version 4.20 - To indicate that nmbd and browsing now works better
1467 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1469 * Note: In the presence of NT4.X do not set above 4.9
1470 * Setting this above 4.9 can have undesired side-effects.
1471 * This may change again in Samba-3.0 after further testing. JHT
1474 #define DEFAULT_MAJOR_VERSION 0x04
1475 #define DEFAULT_MINOR_VERSION 0x09
1477 /* Browser Election Values */
1478 #define BROWSER_ELECTION_VERSION 0x010f
1479 #define BROWSER_CONSTANT 0xaa55
1481 /* Sercurity mode bits. */
1482 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1483 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1484 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1485 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1487 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1489 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1490 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1491 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1492 #define FLAGS2_UNKNOWN_BIT4 0x0010
1493 #define FLAGS2_IS_LONG_NAME 0x0040
1494 #define FLAGS2_EXTENDED_SECURITY 0x0800
1495 #define FLAGS2_DFS_PATHNAMES 0x1000
1496 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1497 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1498 #define FLAGS2_UNICODE_STRINGS 0x8000
1500 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1502 /* TCONX Flag (smb_vwv2). */
1503 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1505 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1507 #define CAP_RAW_MODE 0x0001
1508 #define CAP_MPX_MODE 0x0002
1509 #define CAP_UNICODE 0x0004
1510 #define CAP_LARGE_FILES 0x0008
1511 #define CAP_NT_SMBS 0x0010
1512 #define CAP_RPC_REMOTE_APIS 0x0020
1513 #define CAP_STATUS32 0x0040
1514 #define CAP_LEVEL_II_OPLOCKS 0x0080
1515 #define CAP_LOCK_AND_READ 0x0100
1516 #define CAP_NT_FIND 0x0200
1517 #define CAP_DFS 0x1000
1518 #define CAP_W2K_SMBS 0x2000
1519 #define CAP_LARGE_READX 0x4000
1520 #define CAP_LARGE_WRITEX 0x8000
1521 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1522 #define CAP_EXTENDED_SECURITY 0x80000000
1524 /* protocol types. It assumes that higher protocols include lower protocols
1526 enum protocol_types
{PROTOCOL_NONE
,PROTOCOL_CORE
,PROTOCOL_COREPLUS
,PROTOCOL_LANMAN1
,PROTOCOL_LANMAN2
,PROTOCOL_NT1
};
1528 /* security levels */
1529 enum security_types
{SEC_SHARE
,SEC_USER
,SEC_SERVER
,SEC_DOMAIN
,SEC_ADS
};
1539 /* printing types */
1540 enum printing_types
{PRINT_BSD
,PRINT_SYSV
,PRINT_AIX
,PRINT_HPUX
,
1541 PRINT_QNX
,PRINT_PLP
,PRINT_LPRNG
,PRINT_SOFTQ
,
1542 PRINT_CUPS
,PRINT_LPRNT
,PRINT_LPROS2
,PRINT_IPRINT
1543 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1544 ,PRINT_TEST
,PRINT_VLP
1545 #endif /* DEVELOPER */
1548 /* LDAP schema types */
1549 enum schema_types
{SCHEMA_COMPAT
, SCHEMA_AD
, SCHEMA_SAMBA
};
1551 /* LDAP SSL options */
1552 enum ldap_ssl_types
{LDAP_SSL_OFF
, LDAP_SSL_START_TLS
};
1554 /* LDAP PASSWD SYNC methods */
1555 enum ldap_passwd_sync_types
{LDAP_PASSWD_SYNC_ON
, LDAP_PASSWD_SYNC_OFF
, LDAP_PASSWD_SYNC_ONLY
};
1557 /* Remote architectures we know about. */
1558 enum remote_arch_types
{RA_UNKNOWN
, RA_WFWG
, RA_OS2
, RA_WIN95
, RA_WINNT
,
1559 RA_WIN2K
, RA_WINXP
, RA_WIN2K3
, RA_VISTA
,
1560 RA_SAMBA
, RA_CIFSFS
, RA_WINXP64
};
1563 enum case_handling
{CASE_LOWER
,CASE_UPPER
};
1565 /* ACL compatibility */
1566 enum acl_compatibility
{ACL_COMPAT_AUTO
, ACL_COMPAT_WINNT
, ACL_COMPAT_WIN2K
};
1568 * Global value meaing that the smb_uid field should be
1569 * ingored (in share level security and protocol level == CORE)
1572 #define UID_FIELD_INVALID 0
1573 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1576 * Size of buffer to use when moving files across filesystems.
1578 #define COPYBUF_SIZE (8*1024)
1581 * Map the Core and Extended Oplock requesst bits down
1582 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1588 #define CORE_OPLOCK_REQUEST(inbuf) \
1589 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1592 * Extended protocol.
1594 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1597 #define LOCKING_ANDX_SHARED_LOCK 0x1
1598 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1599 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1600 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1601 #define LOCKING_ANDX_LARGE_FILES 0x10
1604 * Bits we test with.
1605 * Note these must fit into 16-bits.
1608 #define NO_OPLOCK 0x0
1609 #define EXCLUSIVE_OPLOCK 0x1
1610 #define BATCH_OPLOCK 0x2
1611 #define LEVEL_II_OPLOCK 0x4
1613 /* The following are Samba-private. */
1614 #define INTERNAL_OPEN_ONLY 0x8
1615 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1616 * inform potential level2 holders on
1618 #define DEFERRED_OPEN_ENTRY 0x20
1619 #define UNUSED_SHARE_MODE_ENTRY 0x40
1620 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1622 /* None of the following should ever appear in fsp->oplock_request. */
1623 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1625 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1626 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1627 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1629 /* kernel_oplock_message definition.
1631 struct kernel_oplock_message {
1635 unsigned long file_id;
1639 0 uint64_t dev 8 bytes
1640 8 uint64_t inode 8 bytes
1641 16 uint64_t extid 8 bytes
1642 24 unsigned long file_id 4 bytes
1646 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1648 /* file_renamed_message definition.
1650 struct file_renamed_message {
1653 char names[1]; A variable area containing sharepath and filename.
1657 0 uint64_t dev 8 bytes
1658 8 uint64_t inode 8 bytes
1659 16 unit64_t extid 8 bytes
1660 24 char [] name zero terminated namelen bytes
1661 minimum length == 24.
1665 #define MSG_FILE_RENAMED_MIN_SIZE 24
1668 * On the wire return values for oplock types.
1671 #define CORE_OPLOCK_GRANTED (1<<5)
1672 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1674 #define NO_OPLOCK_RETURN 0
1675 #define EXCLUSIVE_OPLOCK_RETURN 1
1676 #define BATCH_OPLOCK_RETURN 2
1677 #define LEVEL_II_OPLOCK_RETURN 3
1680 #define OPLOCKLEVEL_NONE 0
1681 #define OPLOCKLEVEL_II 1
1684 * Capabilities abstracted for different systems.
1687 enum smbd_capability
{
1688 KERNEL_OPLOCK_CAPABILITY
,
1689 DMAPI_ACCESS_CAPABILITY
,
1694 * Kernel oplocks capability flags.
1697 /* Level 2 oplocks are supported natively by kernel oplocks. */
1698 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1700 /* The kernel notifies deferred openers when they can retry the open. */
1701 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1703 /* The kernel notifies smbds when an oplock break times out. */
1704 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1706 /* The kernel notifies smbds when an oplock is broken. */
1707 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1709 struct kernel_oplocks_ops
;
1710 struct kernel_oplocks
{
1711 const struct kernel_oplocks_ops
*ops
;
1716 enum level2_contention_type
{
1717 LEVEL2_CONTEND_ALLOC_SHRINK
,
1718 LEVEL2_CONTEND_ALLOC_GROW
,
1719 LEVEL2_CONTEND_SET_FILE_LEN
,
1720 LEVEL2_CONTEND_FILL_SPARSE
,
1721 LEVEL2_CONTEND_WRITE
,
1722 LEVEL2_CONTEND_WINDOWS_BRL
,
1723 LEVEL2_CONTEND_POSIX_BRL
1726 /* if a kernel does support oplocks then a structure of the following
1727 typee is used to describe how to interact with the kernel */
1728 struct kernel_oplocks_ops
{
1729 bool (*set_oplock
)(struct kernel_oplocks
*ctx
,
1730 files_struct
*fsp
, int oplock_type
);
1731 void (*release_oplock
)(struct kernel_oplocks
*ctx
,
1732 files_struct
*fsp
, int oplock_type
);
1733 void (*contend_level2_oplocks_begin
)(files_struct
*fsp
,
1734 enum level2_contention_type type
);
1735 void (*contend_level2_oplocks_end
)(files_struct
*fsp
,
1736 enum level2_contention_type type
);
1739 #include "smb_macros.h"
1741 #define MAX_NETBIOSNAME_LEN 16
1742 /* DOS character, NetBIOS namestring. Type used on the wire. */
1743 typedef char nstring
[MAX_NETBIOSNAME_LEN
];
1744 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1745 typedef char unstring
[MAX_NETBIOSNAME_LEN
*4];
1747 /* A netbios name structure. */
1751 unsigned int name_type
;
1754 /* A netbios node status array element. */
1755 typedef struct node_status_
{
1758 unsigned char flags
;
1759 } NODE_STATUS_STRUCT
;
1761 /* The extra info from a NetBIOS node status query */
1762 struct node_status_extra
{
1763 unsigned char mac_addr
[6];
1764 /* There really is more here ... */
1767 /* For split krb5 SPNEGO blobs. */
1768 struct pending_auth_data
{
1769 struct pending_auth_data
*prev
, *next
;
1770 uint16 vuid
; /* Tag for this entry. */
1771 uint16 smbpid
; /* Alternate tag for this entry. */
1773 DATA_BLOB partial_data
;
1776 typedef struct user_struct
{
1777 struct user_struct
*next
, *prev
;
1778 uint16 vuid
; /* Tag for this entry. */
1780 char *session_keystr
; /* used by utmp and pam session code.
1784 struct auth_serversupplied_info
*server_info
;
1786 struct auth_ntlmssp_state
*auth_ntlmssp_state
;
1789 struct unix_error_map
{
1797 * Size of new password account encoding string. This is enough space to
1798 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1799 * Do not change unless you are adding new ACB bits!
1802 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1805 Do you want session setups at user level security with a invalid
1806 password to be rejected or allowed in as guest? WinNT rejects them
1807 but it can be a pain as it means "net view" needs to use a password
1809 You have 3 choices in the setting of map_to_guest:
1811 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1812 are rejected. This is the default.
1814 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1815 are rejected, unless the username does not exist, in which case it
1816 is treated as a guest login
1818 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1819 are treated as a guest login
1821 Note that map_to_guest only has an effect in user or server
1825 #define NEVER_MAP_TO_GUEST 0
1826 #define MAP_TO_GUEST_ON_BAD_USER 1
1827 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1828 #define MAP_TO_GUEST_ON_BAD_UID 3
1830 #define SAFE_NETBIOS_CHARS ". -_"
1832 /* The maximum length of a trust account password.
1833 Used when we randomly create it, 15 char passwords
1834 exceed NT4's max password length */
1836 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1838 #include "popt_common.h"
1842 #define LDAP_PORT 389
1844 #define LDAP_GC_PORT 3268
1846 /* used by the IP comparison function */
1848 struct sockaddr_storage ss
;
1852 /* Special name type used to cause a _kerberos DNS lookup. */
1853 #define KDC_NAME_TYPE 0xDCDC
1862 struct ea_list
*next
, *prev
;
1863 struct ea_struct ea
;
1866 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1867 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1868 /* EA to use for DOS attributes */
1869 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1870 /* Prefix for DosStreams in the vfs_streams_xattr module */
1871 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1873 #define UUID_SIZE 16
1875 #define UUID_FLAT_SIZE 16
1876 typedef struct uuid_flat
{
1877 uint8 info
[UUID_FLAT_SIZE
];
1880 /* map readonly options */
1881 enum mapreadonly_options
{MAP_READONLY_NO
, MAP_READONLY_YES
, MAP_READONLY_PERMISSIONS
};
1883 /* usershare error codes. */
1884 enum usershare_err
{
1886 USERSHARE_MALFORMED_FILE
,
1887 USERSHARE_BAD_VERSION
,
1888 USERSHARE_MALFORMED_PATH
,
1889 USERSHARE_MALFORMED_COMMENT_DEF
,
1890 USERSHARE_MALFORMED_ACL_DEF
,
1892 USERSHARE_PATH_NOT_ABSOLUTE
,
1893 USERSHARE_PATH_IS_DENIED
,
1894 USERSHARE_PATH_NOT_ALLOWED
,
1895 USERSHARE_PATH_NOT_DIRECTORY
,
1899 /* Different reasons for closing a file. */
1900 enum file_close_type
{NORMAL_CLOSE
=0,SHUTDOWN_CLOSE
,ERROR_CLOSE
};
1902 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1903 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1904 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1905 struct smb_extended_info
{
1906 uint32 samba_magic
; /* Always SAMBA_EXTRA_INFO_MAGIC */
1907 uint32 samba_version
; /* Major/Minor/Release/Revision */
1908 uint32 samba_subversion
; /* Prerelease/RC/Vendor patch */
1909 NTTIME samba_gitcommitdate
;
1910 char samba_version_string
[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH
];
1916 #define CFF_DOS_PATH 0x00000001
1919 struct smb_file_time
{
1920 struct timespec mtime
;
1921 struct timespec atime
;
1922 struct timespec create_time
;