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 typedef uint16 smb_ucs2_t;
154 #ifdef WORDS_BIGENDIAN
160 /* turn a 7 bit character into a ucs2 character */
161 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
163 /* return an ascii version of a ucs2 character */
164 #define UCS2_TO_CHAR(c) (((c) >> UCS2_SHIFT) & 0xff)
166 /* Copy into a smb_ucs2_t from a possibly unaligned buffer. Return the copied smb_ucs2_t */
167 #define COPY_UCS2_CHAR(dest,src) (((unsigned char *)(dest))[0] = ((unsigned char *)(src))[0],\
168 ((unsigned char *)(dest))[1] = ((unsigned char *)(src))[1], (dest))
170 /* Large data type for manipulating uint32 unicode codepoints */
171 typedef uint32 codepoint_t;
172 #define INVALID_CODEPOINT ((codepoint_t)-1)
174 /* pipe string names */
175 #define PIPE_LANMAN "\\PIPE\\LANMAN"
177 #define MAX_HOURS_LEN 32
180 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
183 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
185 #define LOOKUP_NAME_NONE 0x00000000
186 #define LOOKUP_NAME_ISOLATED 0x00000001 /* Look up unqualified names */
187 #define LOOKUP_NAME_REMOTE 0x00000002 /* Ask others */
188 #define LOOKUP_NAME_GROUP 0x00000004 /* (unused) This is a NASTY hack for
189 valid users = @foo where foo also
190 exists in as user. */
191 #define LOOKUP_NAME_EXPLICIT 0x00000008 /* Only include
192 explicitly mapped names and not
193 the Unix {User,Group} domain */
194 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
195 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
196 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
197 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
198 |LOOKUP_NAME_BUILTIN\
201 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
203 |LOOKUP_NAME_BUILTIN\
208 * @brief Security Identifier
210 * @sa http://msdn.microsoft.com/library/default.asp?url=/library/en-us/security/accctrl_38yn.asp
212 typedef struct dom_sid DOM_SID;
222 ID_TYPE_NOT_SPECIFIED = 0,
235 enum id_mapping status;
238 #include "librpc/gen_ndr/misc.h"
239 #include "librpc/gen_ndr/security.h"
240 #include "librpc/ndr/libndr.h"
241 #include "librpc/gen_ndr/lsa.h"
242 #include "librpc/gen_ndr/dfs.h"
243 #include "librpc/gen_ndr/winreg.h"
244 #include "librpc/gen_ndr/initshutdown.h"
245 #include "librpc/gen_ndr/eventlog.h"
246 #include "librpc/gen_ndr/srvsvc.h"
247 #include "librpc/gen_ndr/wkssvc.h"
248 #include "librpc/gen_ndr/echo.h"
249 #include "librpc/gen_ndr/svcctl.h"
250 #include "librpc/gen_ndr/netlogon.h"
251 #include "librpc/gen_ndr/samr.h"
252 #include "librpc/gen_ndr/dssetup.h"
253 #include "librpc/gen_ndr/epmapper.h"
254 #include "librpc/gen_ndr/libnet_join.h"
255 #include "librpc/gen_ndr/krb5pac.h"
256 #include "librpc/gen_ndr/ntsvcs.h"
257 #include "librpc/gen_ndr/nbt.h"
258 #include "librpc/gen_ndr/drsuapi.h"
259 #include "librpc/gen_ndr/drsblobs.h"
260 #include "librpc/gen_ndr/spoolss.h"
262 struct lsa_dom_info {
270 struct lsa_name_info {
272 enum lsa_SidType type;
277 /* Some well-known SIDs */
278 extern const DOM_SID global_sid_World_Domain;
279 extern const DOM_SID global_sid_World;
280 extern const DOM_SID global_sid_Creator_Owner_Domain;
281 extern const DOM_SID global_sid_NT_Authority;
282 extern const DOM_SID global_sid_System;
283 extern const DOM_SID global_sid_NULL;
284 extern const DOM_SID global_sid_Authenticated_Users;
285 extern const DOM_SID global_sid_Network;
286 extern const DOM_SID global_sid_Creator_Owner;
287 extern const DOM_SID global_sid_Creator_Group;
288 extern const DOM_SID global_sid_Anonymous;
289 extern const DOM_SID global_sid_Builtin;
290 extern const DOM_SID global_sid_Builtin_Administrators;
291 extern const DOM_SID global_sid_Builtin_Users;
292 extern const DOM_SID global_sid_Builtin_Guests;
293 extern const DOM_SID global_sid_Builtin_Power_Users;
294 extern const DOM_SID global_sid_Builtin_Account_Operators;
295 extern const DOM_SID global_sid_Builtin_Server_Operators;
296 extern const DOM_SID global_sid_Builtin_Print_Operators;
297 extern const DOM_SID global_sid_Builtin_Backup_Operators;
298 extern const DOM_SID global_sid_Builtin_Replicator;
299 extern const DOM_SID global_sid_Builtin_PreWin2kAccess;
300 extern const DOM_SID global_sid_Unix_Users;
301 extern const DOM_SID global_sid_Unix_Groups;
304 * The complete list of SIDS belonging to this user.
305 * Created when a vuid is registered.
306 * The definition of the user_sids array is as follows :
308 * token->user_sids[0] = primary user SID.
309 * token->user_sids[1] = primary group SID.
310 * token->user_sids[2..num_sids] = supplementary group SIDS.
313 #define PRIMARY_USER_SID_INDEX 0
314 #define PRIMARY_GROUP_SID_INDEX 1
316 typedef struct nt_user_token {
322 typedef struct unix_user_token {
329 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
330 typedef struct time_info {
334 typedef struct write_cache {
343 smb_ucs2_t *origname;
344 smb_ucs2_t *filename;
345 SMB_STRUCT_STAT *statinfo;
348 #include "fake_file.h"
353 uint64_t position_information;
355 uint32 private_options; /* NT Create options, but we only look at
356 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
357 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB (Except
358 * for print files *only*, where
359 * DELETE_ON_CLOSE is not stored in the share
362 unsigned long gen_id;
366 struct share_mode_entry;
371 struct rpc_cli_smbd_conn;
373 struct vfs_fsp_data {
374 struct vfs_fsp_data *next;
375 struct vfs_handle_struct *owner;
376 void (*destroy)(void *p_data);
378 /* NOTE: This structure contains four pointers so that we can guarantee
379 * that the end of the structure is always both 4-byte and 8-byte aligned.
383 /* the basic packet size, assuming no words or bytes */
386 struct notify_change {
391 struct notify_mid_map;
394 struct notify_change_request;
395 struct sys_notify_backend;
396 struct sys_notify_context {
397 struct event_context *ev;
398 struct connection_struct *conn;
399 void *private_data; /* For use by the system backend */
402 struct notify_change_buf {
404 * If no requests are pending, changes are queued here. Simple array,
409 * num_changes == -1 means that we have got a catch-all change, when
410 * asked we just return NT_STATUS_OK without specific changes.
413 struct notify_change *changes;
416 * If no changes are around requests are queued here. Using a linked
417 * list, because we have to append at the end and delete from the top.
419 struct notify_change_request *requests;
422 typedef struct files_struct {
423 struct files_struct *next, *prev;
425 struct connection_struct *conn;
426 struct fd_handle *fh;
427 unsigned int num_smb_operations;
428 uint16 rap_print_jobid;
429 struct file_id file_id;
430 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
435 struct timeval open_time;
436 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
437 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
439 bool update_write_time_triggered;
440 struct timed_event *update_write_time_event;
441 bool update_write_time_on_close;
442 struct timespec close_write_time;
443 bool write_time_forced;
446 int sent_oplock_break;
447 struct timed_event *oplock_timeout;
448 struct lock_struct last_lock_failure;
449 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
451 struct share_mode_entry *pending_break_messages;
452 int num_pending_break_messages;
460 bool aio_write_behind;
462 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
466 struct vfs_fsp_data *vfs_extension;
467 struct fake_file_handle *fake_file_handle;
469 struct notify_change_buf *notify;
471 struct files_struct *base_fsp; /* placeholder for delete on close */
474 #include "ntquotas.h"
475 #include "sysquotas.h"
477 struct vuid_cache_entry {
478 struct auth_serversupplied_info *server_info;
485 unsigned int next_entry;
486 struct vuid_cache_entry array[VUID_CACHE_SIZE];
492 } name_compare_entry;
495 struct trans_state *next, *prev;
499 uint32 max_param_return;
500 uint32 max_data_return;
501 uint32 max_setup_return;
503 uint8 cmd; /* SMBtrans or SMBtrans2 */
505 char *name; /* for trans requests */
506 uint16 call; /* for trans2 and nttrans requests */
508 bool close_on_completion;
511 unsigned int setup_count;
514 size_t received_data;
515 size_t received_param;
525 * Info about an alternate data stream
528 struct stream_struct {
530 SMB_OFF_T alloc_size;
534 /* Include VFS stuff */
536 #include "smb_acls.h"
539 struct dfree_cached_info {
540 time_t last_dfree_time;
549 struct share_params {
553 struct share_iterator {
557 typedef struct connection_struct {
558 struct connection_struct *next, *prev;
559 unsigned cnum; /* an index passed over the wire */
560 struct share_params *params;
562 struct vuid_cache vuid_cache;
563 struct dptr_struct *dirptr;
566 bool read_only; /* Attributes for the current user of the share. */
567 bool admin_user; /* Attributes for the current user of the share. */
572 struct vfs_ops vfs; /* Filesystem operations */
573 struct vfs_ops vfs_opaque; /* OPAQUE Filesystem operations */
574 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
577 * This represents the user information on this connection. Depending
578 * on the vuid using this tid, this might change per SMB request.
580 struct auth_serversupplied_info *server_info;
582 char client_address[INET6_ADDRSTRLEN]; /* String version of client IP address. */
584 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
587 time_t lastused_count;
590 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
594 /* Semantics requested by the client or forced by the server config. */
597 bool short_case_preserve;
599 /* Semantics provided by the underlying filesystem. */
602 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
603 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
604 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
605 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
606 struct dfree_cached_info *dfree_info;
607 struct trans_state *pending_trans;
608 struct notify_context *notify_ctx;
611 struct current_user {
612 connection_struct *conn;
615 NT_USER_TOKEN *nt_user_token;
633 * Async handling in the main smb processing loop is directed by
634 * outbuf: reply_xxx routines indicate sync behaviour by putting their
635 * reply into "outbuf". If they leave it as NULL, they take of it
636 * themselves, possibly later.
638 * If async handling is wanted, the reply_xxx routine must make sure
639 * that it talloc_move()s the smb_req somewhere else.
645 connection_struct *conn;
646 struct smb_perfcount_data pcd;
649 * Chained request handling
651 struct files_struct *chain_fsp;
654 * Here we collect the outbufs from the chain handlers
656 uint8_t *chain_outbuf;
659 * state information for async smb handling
664 /* Defines for the sent_oplock_break field above. */
665 #define NO_BREAK_SENT 0
666 #define BREAK_TO_NONE_SENT 1
667 #define LEVEL_II_BREAK_SENT 2
670 fstring smb_name; /* user name from the client */
671 fstring unix_name; /* unix user name of a validated user */
672 fstring domain; /* domain that the client specified */
675 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
677 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
678 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
680 typedef struct _print_queue_struct {
681 int job; /* normally the UNIX jobid -- see note in
682 printing.c:traverse_fn_delete() */
690 } print_queue_struct;
692 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
698 } print_status_struct;
700 /* used for server information: client, nameserv and ipc */
701 struct server_info_struct {
705 fstring domain; /* used ONLY in ipc.c NOT namework.c */
706 bool server_added; /* used ONLY in ipc.c NOT namework.c */
709 /* used for network interfaces */
711 struct interface *next, *prev;
714 struct sockaddr_storage ip;
715 struct sockaddr_storage netmask;
716 struct sockaddr_storage bcast;
719 /* Internal message queue for deferred opens. */
720 struct pending_message_list {
721 struct pending_message_list *next, *prev;
722 struct timeval request_time; /* When was this first issued? */
723 struct timed_event *te;
724 struct smb_perfcount_data pcd;
727 DATA_BLOB private_data;
730 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
732 /* struct returned by get_share_modes */
733 struct share_mode_entry {
734 struct server_id pid;
737 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
738 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
739 uint32 private_options; /* NT Create options, but we only look at
740 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
741 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
742 * smbstatus and swat */
745 unsigned long share_file_id;
746 uint32 uid; /* uid of file opener. */
747 uint16 flags; /* See SHARE_MODE_XX above. */
750 /* oplock break message definition - linearization of share_mode_entry.
753 0 struct server_id pid 4
756 8 uint32 access_mask 4
757 12 uint32 share_access 4
758 16 uint32 private_options 4
760 24 uint32 time usec 4
761 28 SMB_DEV_T dev 8 bytes.
762 36 SMB_INO_T inode 8 bytes
763 44 unsigned long file_id 4 bytes
764 48 uint32 uid 4 bytes
765 52 uint16 flags 2 bytes
769 #ifdef CLUSTER_SUPPORT
770 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 58
772 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 54
775 struct share_mode_lock {
776 const char *servicepath; /* canonicalized. */
777 const char *filename;
780 struct share_mode_entry *share_modes;
781 UNIX_USER_TOKEN *delete_token;
782 bool delete_on_close;
783 struct timespec old_write_time;
784 struct timespec changed_write_time;
787 struct db_record *record;
791 * Internal structure of locking.tdb share mode db.
792 * Used by locking.c and libsmbsharemodes.c
795 struct locking_data {
798 int num_share_mode_entries;
799 bool delete_on_close;
800 struct timespec old_write_time;
801 struct timespec changed_write_time;
802 uint32 delete_token_size; /* Only valid if either of
803 the two previous fields
806 struct share_mode_entry dummy; /* Needed for alignment. */
808 /* The following four entries are implicit
809 struct share_mode_entry modes[num_share_mode_entries];
810 char unix_token[delete_token_size] (divisible by 4).
816 /* Used to store pipe open records for NetFileEnum() */
818 struct pipe_open_rec {
819 struct server_id pid;
826 #define NT_HASH_LEN 16
827 #define LM_HASH_LEN 16
829 /* Password history contants. */
830 #define PW_HISTORY_SALT_LEN 16
831 #define SALTED_MD5_HASH_LEN 16
832 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
833 #define MAX_PW_HISTORY_LEN 24
836 * Flags for account policy.
838 #define AP_MIN_PASSWORD_LEN 1
839 #define AP_PASSWORD_HISTORY 2
840 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
841 #define AP_MAX_PASSWORD_AGE 4
842 #define AP_MIN_PASSWORD_AGE 5
843 #define AP_LOCK_ACCOUNT_DURATION 6
844 #define AP_RESET_COUNT_TIME 7
845 #define AP_BAD_ATTEMPT_LOCKOUT 8
846 #define AP_TIME_TO_LOGOUT 9
847 #define AP_REFUSE_MACHINE_PW_CHANGE 10
850 * Flags for local user manipulation.
853 #define LOCAL_ADD_USER 0x1
854 #define LOCAL_DELETE_USER 0x2
855 #define LOCAL_DISABLE_USER 0x4
856 #define LOCAL_ENABLE_USER 0x8
857 #define LOCAL_TRUST_ACCOUNT 0x10
858 #define LOCAL_SET_NO_PASSWORD 0x20
859 #define LOCAL_SET_PASSWORD 0x40
860 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
861 #define LOCAL_INTERDOM_ACCOUNT 0x100
862 #define LOCAL_AM_ROOT 0x200 /* Act as root */
864 /* key and data in the connections database - used in smbstatus and smbd */
865 struct connections_key {
866 struct server_id pid;
871 struct connections_data {
873 struct server_id pid;
877 char servicename[FSTRING_LEN];
879 char machine[FSTRING_LEN];
881 uint32 bcast_msg_flags;
885 /* the following are used by loadparm for option lists */
887 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
888 P_STRING,P_USTRING,P_ENUM,P_SEP
892 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
905 bool (*special)(int snum, const char *, char **);
906 const struct enum_list *enum_list;
917 /* The following flags are used in SWAT */
918 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
919 #define FLAG_SHARE 0x0002 /* file sharing options */
920 #define FLAG_PRINT 0x0004 /* printing options */
921 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
922 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
923 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
924 #define FLAG_DEVELOPER 0x0040 /* No longer used */
925 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
926 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
927 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
934 /* offsets into message for common items */
941 #define smb_pidhigh 16
942 #define smb_ss_field 18
968 /* flag defines. CIFS spec 3.1.1 */
969 #define FLAG_SUPPORT_LOCKREAD 0x01
970 #define FLAG_CLIENT_BUF_AVAIL 0x02
971 #define FLAG_RESERVED 0x04
972 #define FLAG_CASELESS_PATHNAMES 0x08
973 #define FLAG_CANONICAL_PATHNAMES 0x10
974 #define FLAG_REQUEST_OPLOCK 0x20
975 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
976 #define FLAG_REPLY 0x80
979 #define SMBmkdir 0x00 /* create directory */
980 #define SMBrmdir 0x01 /* delete directory */
981 #define SMBopen 0x02 /* open file */
982 #define SMBcreate 0x03 /* create file */
983 #define SMBclose 0x04 /* close file */
984 #define SMBflush 0x05 /* flush file */
985 #define SMBunlink 0x06 /* delete file */
986 #define SMBmv 0x07 /* rename file */
987 #define SMBgetatr 0x08 /* get file attributes */
988 #define SMBsetatr 0x09 /* set file attributes */
989 #define SMBread 0x0A /* read from file */
990 #define SMBwrite 0x0B /* write to file */
991 #define SMBlock 0x0C /* lock byte range */
992 #define SMBunlock 0x0D /* unlock byte range */
993 #define SMBctemp 0x0E /* create temporary file */
994 #define SMBmknew 0x0F /* make new file */
995 #define SMBcheckpath 0x10 /* check directory path */
996 #define SMBexit 0x11 /* process exit */
997 #define SMBlseek 0x12 /* seek */
998 #define SMBtcon 0x70 /* tree connect */
999 #define SMBtconX 0x75 /* tree connect and X*/
1000 #define SMBtdis 0x71 /* tree disconnect */
1001 #define SMBnegprot 0x72 /* negotiate protocol */
1002 #define SMBdskattr 0x80 /* get disk attributes */
1003 #define SMBsearch 0x81 /* search directory */
1004 #define SMBsplopen 0xC0 /* open print spool file */
1005 #define SMBsplwr 0xC1 /* write to print spool file */
1006 #define SMBsplclose 0xC2 /* close print spool file */
1007 #define SMBsplretq 0xC3 /* return print queue */
1008 #define SMBsends 0xD0 /* send single block message */
1009 #define SMBsendb 0xD1 /* send broadcast message */
1010 #define SMBfwdname 0xD2 /* forward user name */
1011 #define SMBcancelf 0xD3 /* cancel forward */
1012 #define SMBgetmac 0xD4 /* get machine name */
1013 #define SMBsendstrt 0xD5 /* send start of multi-block message */
1014 #define SMBsendend 0xD6 /* send end of multi-block message */
1015 #define SMBsendtxt 0xD7 /* send text of multi-block message */
1017 /* Core+ protocol */
1018 #define SMBlockread 0x13 /* Lock a range and read */
1019 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1020 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
1021 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
1022 #define SMBwritec 0x20 /* secondary write request */
1023 #define SMBwriteclose 0x2c /* write a file then close it */
1025 /* dos extended protocol */
1026 #define SMBreadBraw 0x1A /* read block raw */
1027 #define SMBreadBmpx 0x1B /* read block multiplexed */
1028 #define SMBreadBs 0x1C /* read block (secondary response) */
1029 #define SMBwriteBraw 0x1D /* write block raw */
1030 #define SMBwriteBmpx 0x1E /* write block multiplexed */
1031 #define SMBwriteBs 0x1F /* write block (secondary request) */
1032 #define SMBwriteC 0x20 /* write complete response */
1033 #define SMBsetattrE 0x22 /* set file attributes expanded */
1034 #define SMBgetattrE 0x23 /* get file attributes expanded */
1035 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
1036 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
1037 #define SMBtranss 0x26 /* transaction (secondary request/response) */
1038 #define SMBioctl 0x27 /* IOCTL */
1039 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
1040 #define SMBcopy 0x29 /* copy */
1041 #define SMBmove 0x2A /* move */
1042 #define SMBecho 0x2B /* echo */
1043 #define SMBopenX 0x2D /* open and X */
1044 #define SMBreadX 0x2E /* read and X */
1045 #define SMBwriteX 0x2F /* write and X */
1046 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
1047 #define SMBffirst 0x82 /* find first */
1048 #define SMBfunique 0x83 /* find unique */
1049 #define SMBfclose 0x84 /* find close */
1050 #define SMBkeepalive 0x85 /* keepalive */
1051 #define SMBinvalid 0xFE /* invalid command */
1053 /* Extended 2.0 protocol */
1054 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1055 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1056 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1057 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1058 #define SMBulogoffX 0x74 /* user logoff */
1060 /* NT SMB extensions. */
1061 #define SMBnttrans 0xA0 /* NT transact */
1062 #define SMBnttranss 0xA1 /* NT transact secondary */
1063 #define SMBntcreateX 0xA2 /* NT create and X */
1064 #define SMBntcancel 0xA4 /* NT cancel */
1065 #define SMBntrename 0xA5 /* NT rename */
1067 /* These are the trans subcommands */
1068 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
1069 #define TRANSACT_DCERPCCMD 0x26
1070 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1072 /* These are the TRANS2 sub commands */
1073 #define TRANSACT2_OPEN 0x00
1074 #define TRANSACT2_FINDFIRST 0x01
1075 #define TRANSACT2_FINDNEXT 0x02
1076 #define TRANSACT2_QFSINFO 0x03
1077 #define TRANSACT2_SETFSINFO 0x04
1078 #define TRANSACT2_QPATHINFO 0x05
1079 #define TRANSACT2_SETPATHINFO 0x06
1080 #define TRANSACT2_QFILEINFO 0x07
1081 #define TRANSACT2_SETFILEINFO 0x08
1082 #define TRANSACT2_FSCTL 0x09
1083 #define TRANSACT2_IOCTL 0x0A
1084 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1085 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1086 #define TRANSACT2_MKDIR 0x0D
1087 #define TRANSACT2_SESSION_SETUP 0x0E
1088 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1089 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1091 /* These are the NT transact sub commands. */
1092 #define NT_TRANSACT_CREATE 1
1093 #define NT_TRANSACT_IOCTL 2
1094 #define NT_TRANSACT_SET_SECURITY_DESC 3
1095 #define NT_TRANSACT_NOTIFY_CHANGE 4
1096 #define NT_TRANSACT_RENAME 5
1097 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1098 #define NT_TRANSACT_GET_USER_QUOTA 7
1099 #define NT_TRANSACT_SET_USER_QUOTA 8
1101 /* These are the NT transact_get_user_quota sub commands */
1102 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1103 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1104 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1106 /* Relevant IOCTL codes */
1107 #define IOCTL_QUERY_JOB_INFO 0x530060
1109 /* these are the trans2 sub fields for primary requests */
1110 #define smb_tpscnt smb_vwv0
1111 #define smb_tdscnt smb_vwv1
1112 #define smb_mprcnt smb_vwv2
1113 #define smb_mdrcnt smb_vwv3
1114 #define smb_msrcnt smb_vwv4
1115 #define smb_flags smb_vwv5
1116 #define smb_timeout smb_vwv6
1117 #define smb_pscnt smb_vwv9
1118 #define smb_psoff smb_vwv10
1119 #define smb_dscnt smb_vwv11
1120 #define smb_dsoff smb_vwv12
1121 #define smb_suwcnt smb_vwv13
1122 #define smb_setup smb_vwv14
1123 #define smb_setup0 smb_setup
1124 #define smb_setup1 (smb_setup+2)
1125 #define smb_setup2 (smb_setup+4)
1127 /* these are for the secondary requests */
1128 #define smb_spscnt smb_vwv2
1129 #define smb_spsoff smb_vwv3
1130 #define smb_spsdisp smb_vwv4
1131 #define smb_sdscnt smb_vwv5
1132 #define smb_sdsoff smb_vwv6
1133 #define smb_sdsdisp smb_vwv7
1134 #define smb_sfid smb_vwv8
1136 /* and these for responses */
1137 #define smb_tprcnt smb_vwv0
1138 #define smb_tdrcnt smb_vwv1
1139 #define smb_prcnt smb_vwv3
1140 #define smb_proff smb_vwv4
1141 #define smb_prdisp smb_vwv5
1142 #define smb_drcnt smb_vwv6
1143 #define smb_droff smb_vwv7
1144 #define smb_drdisp smb_vwv8
1146 /* these are for the NT trans primary request. */
1147 #define smb_nt_MaxSetupCount smb_vwv0
1148 #define smb_nt_Flags (smb_vwv0 + 1)
1149 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1150 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1151 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1152 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1153 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1154 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1155 #define smb_nt_DataCount (smb_vwv0 + 27)
1156 #define smb_nt_DataOffset (smb_vwv0 + 31)
1157 #define smb_nt_SetupCount (smb_vwv0 + 35)
1158 #define smb_nt_Function (smb_vwv0 + 36)
1159 #define smb_nt_SetupStart (smb_vwv0 + 38)
1161 /* these are for the NT trans secondary request. */
1162 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1163 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1164 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1165 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1166 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1167 #define smb_nts_DataCount (smb_vwv0 + 23)
1168 #define smb_nts_DataOffset (smb_vwv0 + 27)
1169 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1171 /* these are for the NT trans reply. */
1172 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1173 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1174 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1175 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1176 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1177 #define smb_ntr_DataCount (smb_vwv0 + 23)
1178 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1179 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1181 /* these are for the NT create_and_X */
1182 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1183 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1184 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1185 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1186 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1187 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1188 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1189 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1190 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1191 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1192 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1194 /* this is used on a TConX. I'm not sure the name is very helpful though */
1195 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1196 #define SMB_SHARE_IN_DFS 0x0002
1198 /* Named pipe write mode flags. Used in writeX calls. */
1199 #define PIPE_RAW_MODE 0x4
1200 #define PIPE_START_MESSAGE 0x8
1202 /* File Specific access rights */
1203 #define FILE_READ_DATA 0x00000001
1204 #define FILE_WRITE_DATA 0x00000002
1205 #define FILE_APPEND_DATA 0x00000004
1206 #define FILE_READ_EA 0x00000008 /* File and directory */
1207 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1208 #define FILE_EXECUTE 0x00000020
1209 #define FILE_DELETE_CHILD 0x00000040
1210 #define FILE_READ_ATTRIBUTES 0x00000080
1211 #define FILE_WRITE_ATTRIBUTES 0x00000100
1213 #define FILE_ALL_ACCESS 0x000001FF
1215 /* Directory specific access rights */
1216 #define FILE_LIST_DIRECTORY 0x00000001
1217 #define FILE_ADD_FILE 0x00000002
1218 #define FILE_ADD_SUBDIRECTORY 0x00000004
1219 #define FILE_TRAVERSE 0x00000020
1220 #define FILE_DELETE_CHILD 0x00000040
1222 /* the desired access to use when opening a pipe */
1223 #define DESIRED_ACCESS_PIPE 0x2019f
1225 /* Generic access masks & rights. */
1226 #define DELETE_ACCESS 0x00010000 /* (1L<<16) */
1227 #define READ_CONTROL_ACCESS 0x00020000 /* (1L<<17) */
1228 #define WRITE_DAC_ACCESS 0x00040000 /* (1L<<18) */
1229 #define WRITE_OWNER_ACCESS 0x00080000 /* (1L<<19) */
1230 #define SYNCHRONIZE_ACCESS 0x00100000 /* (1L<<20) */
1232 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1233 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1234 #define GENERIC_ALL_ACCESS 0x10000000 /* (1<<28) */
1235 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1236 #define GENERIC_WRITE_ACCESS 0x40000000 /* (1<<30) */
1237 #define GENERIC_READ_ACCESS ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1239 /* Mapping of generic access rights for files to specific rights. */
1241 /* This maps to 0x1F01FF */
1242 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1244 /* This maps to 0x120089 */
1245 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1246 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1248 /* This maps to 0x120116 */
1249 #define FILE_GENERIC_WRITE (STD_RIGHT_READ_CONTROL_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1250 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1252 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
1253 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1255 /* Share specific rights. */
1256 #define SHARE_ALL_ACCESS FILE_GENERIC_ALL
1257 #define SHARE_READ_ONLY (FILE_GENERIC_READ|FILE_EXECUTE)
1259 /* Mapping of access rights to UNIX perms. */
1260 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1261 #define UNIX_ACCESS_R FILE_GENERIC_READ
1262 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1263 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1265 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1266 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1267 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1268 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1269 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1273 * This is the old mapping we used to use. To get W2KSP2 profiles
1274 * working we need to map to the canonical file perms.
1276 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1277 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1278 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1279 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1280 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1281 FILE_APPEND_DATA|FILE_WRITE_DATA)
1282 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1283 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1286 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1289 #define REQUEST_OPLOCK 2
1290 #define REQUEST_BATCH_OPLOCK 4
1291 #define OPEN_DIRECTORY 8
1292 #define EXTENDED_RESPONSE_REQUIRED 0x10
1294 /* ShareAccess field. */
1295 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1296 #define FILE_SHARE_READ 1
1297 #define FILE_SHARE_WRITE 2
1298 #define FILE_SHARE_DELETE 4
1300 /* FileAttributesField */
1301 #define FILE_ATTRIBUTE_READONLY 0x001L
1302 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1303 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1304 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1305 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1306 #define FILE_ATTRIBUTE_NORMAL 0x080L
1307 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1308 #define FILE_ATTRIBUTE_SPARSE 0x200L
1309 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1310 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1311 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1312 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1313 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1314 #define SAMBA_ATTRIBUTES_MASK 0x7F
1316 /* Flags - combined with attributes. */
1317 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1318 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1319 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1320 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1321 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1322 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1323 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1325 /* CreateDisposition field. */
1326 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1327 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1328 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1329 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1330 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1331 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1333 /* CreateOptions field. */
1334 #define FILE_DIRECTORY_FILE 0x0001
1335 #define FILE_WRITE_THROUGH 0x0002
1336 #define FILE_SEQUENTIAL_ONLY 0x0004
1337 #define FILE_NON_DIRECTORY_FILE 0x0040
1338 #define FILE_NO_EA_KNOWLEDGE 0x0200
1339 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1340 #define FILE_RANDOM_ACCESS 0x0800
1341 #define FILE_DELETE_ON_CLOSE 0x1000
1342 #define FILE_OPEN_BY_FILE_ID 0x2000
1344 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1346 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1349 * Private create options used by the ntcreatex processing code. From Samba4.
1350 * We reuse some ignored flags for private use.
1352 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x00010000
1353 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x00020000
1355 /* Private options for streams support */
1356 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x00040000
1358 /* Responses when opening a file. */
1359 #define FILE_WAS_SUPERSEDED 0
1360 #define FILE_WAS_OPENED 1
1361 #define FILE_WAS_CREATED 2
1362 #define FILE_WAS_OVERWRITTEN 3
1364 /* File type flags */
1365 #define FILE_TYPE_DISK 0
1366 #define FILE_TYPE_BYTE_MODE_PIPE 1
1367 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1368 #define FILE_TYPE_PRINTER 3
1369 #define FILE_TYPE_COMM_DEVICE 4
1370 #define FILE_TYPE_UNKNOWN 0xFFFF
1372 /* Flag for NT transact rename call. */
1373 #define RENAME_REPLACE_IF_EXISTS 1
1375 /* flags for SMBntrename call (from Samba4) */
1376 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1377 #define RENAME_FLAG_HARD_LINK 0x103
1378 #define RENAME_FLAG_RENAME 0x104
1379 #define RENAME_FLAG_COPY 0x105
1381 /* Filesystem Attributes. */
1382 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1383 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1384 #define FILE_UNICODE_ON_DISK 0x00000004
1385 /* According to cifs9f, this is 4, not 8 */
1386 /* Acconding to testing, this actually sets the security attribute! */
1387 #define FILE_PERSISTENT_ACLS 0x00000008
1388 #define FILE_FILE_COMPRESSION 0x00000010
1389 #define FILE_VOLUME_QUOTAS 0x00000020
1390 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1391 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1392 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1393 #define FS_LFN_APIS 0x00004000
1394 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1395 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1396 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1397 #define FILE_NAMED_STREAMS 0x00040000
1398 #define FILE_READ_ONLY_VOLUME 0x00080000
1400 /* ChangeNotify flags. */
1401 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1402 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1403 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1404 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1405 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1406 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1407 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1408 #define FILE_NOTIFY_CHANGE_EA 0x080
1409 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1410 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1411 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1412 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1414 #define FILE_NOTIFY_CHANGE_NAME \
1415 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1417 /* change notify action results */
1418 #define NOTIFY_ACTION_ADDED 1
1419 #define NOTIFY_ACTION_REMOVED 2
1420 #define NOTIFY_ACTION_MODIFIED 3
1421 #define NOTIFY_ACTION_OLD_NAME 4
1422 #define NOTIFY_ACTION_NEW_NAME 5
1423 #define NOTIFY_ACTION_ADDED_STREAM 6
1424 #define NOTIFY_ACTION_REMOVED_STREAM 7
1425 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1428 /* where to find the base of the SMB packet proper */
1429 #define smb_base(buf) (((char *)(buf))+4)
1431 /* we don't allow server strings to be longer than 48 characters as
1432 otherwise NT will not honour the announce packets */
1433 #define MAX_SERVER_STRING_LENGTH 48
1436 #define SMB_SUCCESS 0 /* The request was successful. */
1439 void dfs_unlogin(void);
1440 extern int dcelogin_atmost_once;
1444 char *strdup(char *s);
1448 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1455 /* This was set by JHT in liaison with Jeremy Allison early 1997
1457 * Version 4.0 - never made public
1458 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1459 * - Reappeared in 1.9.16p11 with fixed smbd services
1460 * Version 4.20 - To indicate that nmbd and browsing now works better
1461 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1463 * Note: In the presence of NT4.X do not set above 4.9
1464 * Setting this above 4.9 can have undesired side-effects.
1465 * This may change again in Samba-3.0 after further testing. JHT
1468 #define DEFAULT_MAJOR_VERSION 0x04
1469 #define DEFAULT_MINOR_VERSION 0x09
1471 /* Browser Election Values */
1472 #define BROWSER_ELECTION_VERSION 0x010f
1473 #define BROWSER_CONSTANT 0xaa55
1475 /* Sercurity mode bits. */
1476 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1477 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1478 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1479 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1481 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1483 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1484 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1485 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1486 #define FLAGS2_UNKNOWN_BIT4 0x0010
1487 #define FLAGS2_IS_LONG_NAME 0x0040
1488 #define FLAGS2_EXTENDED_SECURITY 0x0800
1489 #define FLAGS2_DFS_PATHNAMES 0x1000
1490 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1491 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1492 #define FLAGS2_UNICODE_STRINGS 0x8000
1494 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1496 /* TCONX Flag (smb_vwv2). */
1497 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1499 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1501 #define CAP_RAW_MODE 0x0001
1502 #define CAP_MPX_MODE 0x0002
1503 #define CAP_UNICODE 0x0004
1504 #define CAP_LARGE_FILES 0x0008
1505 #define CAP_NT_SMBS 0x0010
1506 #define CAP_RPC_REMOTE_APIS 0x0020
1507 #define CAP_STATUS32 0x0040
1508 #define CAP_LEVEL_II_OPLOCKS 0x0080
1509 #define CAP_LOCK_AND_READ 0x0100
1510 #define CAP_NT_FIND 0x0200
1511 #define CAP_DFS 0x1000
1512 #define CAP_W2K_SMBS 0x2000
1513 #define CAP_LARGE_READX 0x4000
1514 #define CAP_LARGE_WRITEX 0x8000
1515 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1516 #define CAP_EXTENDED_SECURITY 0x80000000
1518 /* protocol types. It assumes that higher protocols include lower protocols
1520 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1522 /* security levels */
1523 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1533 /* printing types */
1534 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1535 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1536 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1537 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1538 ,PRINT_TEST,PRINT_VLP
1539 #endif /* DEVELOPER */
1542 /* LDAP schema types */
1543 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1545 /* LDAP SSL options */
1546 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1548 /* LDAP PASSWD SYNC methods */
1549 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1551 /* Remote architectures we know about. */
1552 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1553 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1554 RA_SAMBA, RA_CIFSFS, RA_WINXP64};
1557 enum case_handling {CASE_LOWER,CASE_UPPER};
1559 /* ACL compatibility */
1560 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1562 * Global value meaing that the smb_uid field should be
1563 * ingored (in share level security and protocol level == CORE)
1566 #define UID_FIELD_INVALID 0
1567 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1570 * Size of buffer to use when moving files across filesystems.
1572 #define COPYBUF_SIZE (8*1024)
1575 * Map the Core and Extended Oplock requesst bits down
1576 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1582 #define CORE_OPLOCK_REQUEST(inbuf) \
1583 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1586 * Extended protocol.
1588 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1591 #define LOCKING_ANDX_SHARED_LOCK 0x1
1592 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1593 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1594 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1595 #define LOCKING_ANDX_LARGE_FILES 0x10
1598 * Bits we test with.
1599 * Note these must fit into 16-bits.
1602 #define NO_OPLOCK 0x0
1603 #define EXCLUSIVE_OPLOCK 0x1
1604 #define BATCH_OPLOCK 0x2
1605 #define LEVEL_II_OPLOCK 0x4
1607 /* The following are Samba-private. */
1608 #define INTERNAL_OPEN_ONLY 0x8
1609 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1610 * inform potential level2 holders on
1612 #define DEFERRED_OPEN_ENTRY 0x20
1613 #define UNUSED_SHARE_MODE_ENTRY 0x40
1614 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1616 /* None of the following should ever appear in fsp->oplock_request. */
1617 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1619 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1620 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1621 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1623 struct inform_level2_message {
1627 unsigned long target_file_id;
1628 unsigned long source_file_id;
1631 /* kernel_oplock_message definition.
1633 struct kernel_oplock_message {
1636 unsigned long file_id;
1640 0 SMB_DEV_T dev 8 bytes.
1641 8 SMB_INO_T inode 8 bytes
1642 16 unsigned long file_id 4 bytes
1646 #define MSG_SMB_KERNEL_BREAK_SIZE 20
1648 /* file_renamed_message definition.
1650 struct file_renamed_message {
1653 char names[1]; A variable area containing sharepath and filename.
1657 0 SMB_DEV_T dev 8 bytes.
1658 8 SMB_INO_T inode 8 bytes
1659 16 char [] name zero terminated namelen bytes
1660 minimum length == 18.
1664 #define MSG_FILE_RENAMED_MIN_SIZE 16
1667 * On the wire return values for oplock types.
1670 #define CORE_OPLOCK_GRANTED (1<<5)
1671 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1673 #define NO_OPLOCK_RETURN 0
1674 #define EXCLUSIVE_OPLOCK_RETURN 1
1675 #define BATCH_OPLOCK_RETURN 2
1676 #define LEVEL_II_OPLOCK_RETURN 3
1679 #define OPLOCKLEVEL_NONE 0
1680 #define OPLOCKLEVEL_II 1
1683 * Capabilities abstracted for different systems.
1686 enum smbd_capability {
1687 KERNEL_OPLOCK_CAPABILITY,
1688 DMAPI_ACCESS_CAPABILITY,
1693 * Kernel oplocks capability flags.
1696 /* Level 2 oplocks are supported natively by kernel oplocks. */
1697 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1699 /* The kernel notifies deferred openers when they can retry the open. */
1700 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1702 /* The kernel notifies smbds when an oplock break times out. */
1703 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1705 /* The kernel notifies smbds when an oplock is broken. */
1706 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1708 struct kernel_oplocks_ops;
1709 struct kernel_oplocks {
1710 const struct kernel_oplocks_ops *ops;
1715 enum level2_contention_type {
1716 LEVEL2_CONTEND_ALLOC_SHRINK,
1717 LEVEL2_CONTEND_ALLOC_GROW,
1718 LEVEL2_CONTEND_SET_FILE_LEN,
1719 LEVEL2_CONTEND_FILL_SPARSE,
1720 LEVEL2_CONTEND_WRITE,
1721 LEVEL2_CONTEND_WINDOWS_BRL,
1722 LEVEL2_CONTEND_POSIX_BRL
1725 /* if a kernel does support oplocks then a structure of the following
1726 typee is used to describe how to interact with the kernel */
1727 struct kernel_oplocks_ops {
1728 bool (*set_oplock)(struct kernel_oplocks *ctx,
1729 files_struct *fsp, int oplock_type);
1730 void (*release_oplock)(struct kernel_oplocks *ctx,
1731 files_struct *fsp, int oplock_type);
1732 void (*contend_level2_oplocks_begin)(files_struct *fsp,
1733 enum level2_contention_type type);
1734 void (*contend_level2_oplocks_end)(files_struct *fsp,
1735 enum level2_contention_type type);
1738 #include "smb_macros.h"
1740 #define MAX_NETBIOSNAME_LEN 16
1741 /* DOS character, NetBIOS namestring. Type used on the wire. */
1742 typedef char nstring[MAX_NETBIOSNAME_LEN];
1743 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1744 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1746 /* A netbios name structure. */
1750 unsigned int name_type;
1753 /* A netbios node status array element. */
1754 typedef struct node_status_ {
1757 unsigned char flags;
1758 } NODE_STATUS_STRUCT;
1760 /* The extra info from a NetBIOS node status query */
1761 struct node_status_extra {
1762 unsigned char mac_addr[6];
1763 /* There really is more here ... */
1773 /* For split krb5 SPNEGO blobs. */
1774 struct pending_auth_data {
1775 struct pending_auth_data *prev, *next;
1776 uint16 vuid; /* Tag for this entry. */
1777 uint16 smbpid; /* Alternate tag for this entry. */
1779 DATA_BLOB partial_data;
1782 typedef struct user_struct {
1783 struct user_struct *next, *prev;
1784 uint16 vuid; /* Tag for this entry. */
1786 char *session_keystr; /* used by utmp and pam session code.
1790 struct auth_serversupplied_info *server_info;
1792 struct auth_ntlmssp_state *auth_ntlmssp_state;
1795 struct unix_error_map {
1803 * Size of new password account encoding string. This is enough space to
1804 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1805 * Do not change unless you are adding new ACB bits!
1808 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1811 Do you want session setups at user level security with a invalid
1812 password to be rejected or allowed in as guest? WinNT rejects them
1813 but it can be a pain as it means "net view" needs to use a password
1815 You have 3 choices in the setting of map_to_guest:
1817 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1818 are rejected. This is the default.
1820 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1821 are rejected, unless the username does not exist, in which case it
1822 is treated as a guest login
1824 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1825 are treated as a guest login
1827 Note that map_to_guest only has an effect in user or server
1831 #define NEVER_MAP_TO_GUEST 0
1832 #define MAP_TO_GUEST_ON_BAD_USER 1
1833 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1834 #define MAP_TO_GUEST_ON_BAD_UID 3
1836 #define SAFE_NETBIOS_CHARS ". -_"
1838 /* generic iconv conversion structure */
1839 typedef struct _smb_iconv_t {
1840 size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
1841 char **outbuf, size_t *outbytesleft);
1842 size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
1843 char **outbuf, size_t *outbytesleft);
1844 size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
1845 char **outbuf, size_t *outbytesleft);
1846 void *cd_direct, *cd_pull, *cd_push;
1847 char *from_name, *to_name;
1850 /* The maximum length of a trust account password.
1851 Used when we randomly create it, 15 char passwords
1852 exceed NT4's max password length */
1854 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1856 #include "popt_common.h"
1860 #define LDAP_PORT 389
1862 #define LDAP_GC_PORT 3268
1864 /* used by the IP comparison function */
1866 struct sockaddr_storage ss;
1870 /* Special name type used to cause a _kerberos DNS lookup. */
1871 #define KDC_NAME_TYPE 0xDCDC
1873 /* Used by the SMB signing functions. */
1875 typedef struct smb_sign_info {
1876 void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1877 bool (*check_incoming_message)(const char *inbuf, struct smb_sign_info *si, bool must_be_ok);
1878 void (*free_signing_context)(struct smb_sign_info *si);
1879 void *signing_context;
1881 bool negotiated_smb_signing;
1882 bool allow_smb_signing;
1884 bool mandatory_signing;
1885 bool seen_valid; /* Have I ever seen a validly signed packet? */
1895 struct ea_list *next, *prev;
1896 struct ea_struct ea;
1899 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1900 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1901 /* EA to use for DOS attributes */
1902 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1903 /* Prefix for DosStreams in the vfs_streams_xattr module */
1904 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1906 #define UUID_SIZE 16
1908 #define UUID_FLAT_SIZE 16
1909 typedef struct uuid_flat {
1910 uint8 info[UUID_FLAT_SIZE];
1913 /* map readonly options */
1914 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1916 /* usershare error codes. */
1917 enum usershare_err {
1919 USERSHARE_MALFORMED_FILE,
1920 USERSHARE_BAD_VERSION,
1921 USERSHARE_MALFORMED_PATH,
1922 USERSHARE_MALFORMED_COMMENT_DEF,
1923 USERSHARE_MALFORMED_ACL_DEF,
1925 USERSHARE_PATH_NOT_ABSOLUTE,
1926 USERSHARE_PATH_IS_DENIED,
1927 USERSHARE_PATH_NOT_ALLOWED,
1928 USERSHARE_PATH_NOT_DIRECTORY,
1932 /* Different reasons for closing a file. */
1933 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1935 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1936 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1937 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1938 struct smb_extended_info {
1939 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1940 uint32 samba_version; /* Major/Minor/Release/Revision */
1941 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1942 NTTIME samba_gitcommitdate;
1943 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1949 #define CFF_DOS_PATH 0x00000001
1952 struct smb_file_time {
1953 struct timespec mtime;
1954 struct timespec atime;
1955 struct timespec create_time;