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 #include "libcli/smb/smb_common.h"
30 #include "libds/common/roles.h"
32 /* logged when starting the various Samba daemons */
33 #define COPYRIGHT_STARTUP_MESSAGE "Copyright Andrew Tridgell and the Samba Team 1992-2011"
36 #if defined(LARGE_SMB_OFF_T)
37 #define BUFFER_SIZE (128*1024)
38 #else /* no large readwrite possible */
39 #define BUFFER_SIZE (0xFFFF)
42 #define SAFETY_MARGIN 1024
43 #define LARGE_WRITEX_HDR_SIZE 65
46 #define DGRAM_PORT 138
49 #define SMB_PORTS "445 139"
51 #define Undefined (-1)
59 #ifndef DEF_CREATE_MASK
60 #define DEF_CREATE_MASK (0755)
63 /* string manipulation flags - see clistr.c and srvstr.c */
64 #define STR_TERMINATE 1
68 #define STR_NOALIGN 16
69 #define STR_TERMINATE_ASCII 128
71 /* how long to wait for secondary SMB packets (milli-seconds) */
72 #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
98 #define DOS_OPEN_RDONLY 0
99 #define DOS_OPEN_WRONLY 1
100 #define DOS_OPEN_RDWR 2
101 #define DOS_OPEN_EXEC 3
102 #define DOS_OPEN_FCB 0xF
104 /* define shifts and masks for share and open modes. */
105 #define OPENX_MODE_MASK 0xF
106 #define DENY_MODE_SHIFT 4
107 #define DENY_MODE_MASK 0x7
108 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
109 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
110 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
111 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
113 /* Sync on open file (not sure if used anymore... ?) */
114 #define FILE_SYNC_OPENMODE (1<<14)
115 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
117 /* open disposition values */
118 #define OPENX_FILE_EXISTS_FAIL 0
119 #define OPENX_FILE_EXISTS_OPEN 1
120 #define OPENX_FILE_EXISTS_TRUNCATE 2
122 /* mask for open disposition. */
123 #define OPENX_FILE_OPEN_MASK 0x3
125 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
126 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
128 /* The above can be OR'ed with... */
129 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
130 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
132 typedef union unid_t {
137 /* pipe string names */
140 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
143 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
145 #include "librpc/gen_ndr/security.h"
148 * The complete list of SIDS belonging to this user.
149 * Created when a vuid is registered.
150 * The definition of the user_sids array is as follows :
152 * token->user_sids[0] = primary user SID.
153 * token->user_sids[1] = primary group SID.
154 * token->user_sids[2..num_sids] = supplementary group SIDS.
157 #define PRIMARY_USER_SID_INDEX 0
158 #define PRIMARY_GROUP_SID_INDEX 1
160 typedef struct write_cache {
171 uint64_t position_information;
173 uint32 private_options; /* NT Create options, but we only look at
174 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
175 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
176 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
177 * for print files *only*, where
178 * DELETE_ON_CLOSE is not stored in the share
181 unsigned long gen_id;
185 struct share_mode_entry;
189 struct rpc_cli_smbd_conn;
190 struct fncall_context;
192 struct vfs_fsp_data {
193 struct vfs_fsp_data *next;
194 struct vfs_handle_struct *owner;
195 void (*destroy)(void *p_data);
197 /* NOTE: This structure contains four pointers so that we can guarantee
198 * that the end of the structure is always both 4-byte and 8-byte aligned.
202 /* the basic packet size, assuming no words or bytes */
205 struct notify_change {
210 struct notify_mid_map;
213 struct notify_change_request;
214 struct sys_notify_backend;
215 struct sys_notify_context {
216 struct event_context *ev;
217 struct connection_struct *conn;
218 void *private_data; /* For use by the system backend */
221 struct notify_change_buf {
223 * If no requests are pending, changes are queued here. Simple array,
228 * num_changes == -1 means that we have got a catch-all change, when
229 * asked we just return NT_STATUS_OK without specific changes.
232 struct notify_change *changes;
235 * If no changes are around requests are queued here. Using a linked
236 * list, because we have to append at the end and delete from the top.
238 struct notify_change_request *requests;
241 struct print_file_data {
245 struct policy_handle handle;
250 typedef struct files_struct {
251 struct files_struct *next, *prev;
253 struct connection_struct *conn;
254 struct fd_handle *fh;
255 unsigned int num_smb_operations;
256 struct file_id file_id;
257 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
262 struct timeval open_time;
263 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
264 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
266 bool update_write_time_triggered;
267 struct timed_event *update_write_time_event;
268 bool update_write_time_on_close;
269 struct timespec close_write_time;
270 bool write_time_forced;
273 int sent_oplock_break;
274 struct timed_event *oplock_timeout;
275 struct lock_struct last_lock_failure;
276 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
278 struct share_mode_entry *pending_break_messages;
279 int num_pending_break_messages;
286 bool aio_write_behind;
288 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
289 bool delete_on_close;
292 struct smb_filename *fsp_name;
293 uint32_t name_hash; /* Jenkins hash of full pathname. */
295 struct vfs_fsp_data *vfs_extension;
296 struct fake_file_handle *fake_file_handle;
298 struct notify_change_buf *notify;
300 struct files_struct *base_fsp; /* placeholder for delete on close */
303 * Read-only cached brlock record, thrown away when the
304 * brlock.tdb seqnum changes. This avoids fetching data from
305 * the brlock.tdb on every read/write call.
308 struct byte_range_lock *brlock_rec;
310 struct dptr_struct *dptr;
312 /* if not NULL, means this is a print file */
313 struct print_file_data *print_file;
317 #include "ntquotas.h"
318 #include "sysquotas.h"
320 struct client_address {
321 char addr[INET6_ADDRSTRLEN];
325 struct vuid_cache_entry {
326 struct auth_serversupplied_info *session_info;
332 unsigned int next_entry;
333 struct vuid_cache_entry array[VUID_CACHE_SIZE];
339 } name_compare_entry;
342 struct trans_state *next, *prev;
346 uint32 max_param_return;
347 uint32 max_data_return;
348 uint32 max_setup_return;
350 uint8 cmd; /* SMBtrans or SMBtrans2 */
352 char *name; /* for trans requests */
353 uint16 call; /* for trans2 and nttrans requests */
355 bool close_on_completion;
358 unsigned int setup_count;
361 size_t received_data;
362 size_t received_param;
372 * Info about an alternate data stream
375 struct stream_struct {
377 SMB_OFF_T alloc_size;
381 /* Include VFS stuff */
383 #include "smb_acls.h"
386 struct dfree_cached_info {
387 time_t last_dfree_time;
396 struct share_params {
400 typedef struct connection_struct {
401 struct connection_struct *next, *prev;
402 struct smbd_server_connection *sconn; /* can be NULL */
403 unsigned cnum; /* an index passed over the wire */
404 struct share_params *params;
406 struct vuid_cache vuid_cache;
409 bool read_only; /* Attributes for the current user of the share. */
410 /* Does this filesystem honor
411 sub second timestamps on files
412 and directories when setting time ? */
413 enum timestamp_set_resolution ts_res;
417 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
420 * This represents the user information on this connection. Depending
421 * on the vuid using this tid, this might change per SMB request.
423 struct auth_serversupplied_info *session_info;
426 * If the "force group" parameter is set, this is the primary gid that
427 * may be used in the users token, depending on the vuid using this tid.
429 gid_t force_group_gid;
431 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
434 time_t lastused_count;
437 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
441 /* Semantics requested by the client or forced by the server config. */
444 bool short_case_preserve;
446 /* Semantics provided by the underlying filesystem. */
448 /* Device number of the directory of the share mount.
449 Used to ensure unique FileIndex returns. */
450 SMB_DEV_T base_share_dev;
452 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
453 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
454 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
455 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
456 struct dfree_cached_info *dfree_info;
457 struct trans_state *pending_trans;
458 struct notify_context *notify_ctx;
460 struct rpc_pipe_client *spoolss_pipe;
464 struct current_user {
465 connection_struct *conn;
467 struct security_unix_token ut;
468 struct security_token *nt_user_token;
471 struct smbd_smb2_request;
477 uint64_t mid; /* For compatibility with SMB2. */
488 * Async handling in the main smb processing loop is directed by
489 * outbuf: reply_xxx routines indicate sync behaviour by putting their
490 * reply into "outbuf". If they leave it as NULL, they take of it
491 * themselves, possibly later.
493 * If async handling is wanted, the reply_xxx routine must make sure
494 * that it talloc_move()s the smb_req somewhere else.
500 connection_struct *conn;
501 struct smbd_server_connection *sconn;
502 struct smb_perfcount_data pcd;
505 * Chained request handling
507 struct files_struct *chain_fsp;
510 * Here we collect the outbufs from the chain handlers
512 uint8_t *chain_outbuf;
515 * state information for async smb handling
522 * Back pointer to smb2 request.
524 struct smbd_smb2_request *smb2req;
527 /* Defines for the sent_oplock_break field above. */
528 #define NO_BREAK_SENT 0
529 #define BREAK_TO_NONE_SENT 1
530 #define LEVEL_II_BREAK_SENT 2
533 fstring smb_name; /* user name from the client */
534 fstring unix_name; /* unix user name of a validated user */
535 fstring domain; /* domain that the client specified */
538 /* used for server information: client, nameserv and ipc */
539 struct server_info_struct {
543 fstring domain; /* used ONLY in ipc.c NOT namework.c */
544 bool server_added; /* used ONLY in ipc.c NOT namework.c */
547 /* used for network interfaces */
549 struct interface *next, *prev;
552 struct sockaddr_storage ip;
553 struct sockaddr_storage netmask;
554 struct sockaddr_storage bcast;
557 /* Internal message queue for deferred opens. */
558 struct pending_message_list {
559 struct pending_message_list *next, *prev;
560 struct timeval request_time; /* When was this first issued? */
561 struct timed_event *te;
562 struct smb_perfcount_data pcd;
567 DATA_BLOB private_data;
570 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
572 #include "librpc/gen_ndr/server_id.h"
574 /* struct returned by get_share_modes */
575 struct share_mode_entry {
576 struct server_id pid;
577 uint64_t op_mid; /* For compatibility with SMB2 opens. */
579 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
580 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
581 uint32 private_options; /* NT Create options, but we only look at
582 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
583 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
584 * smbstatus and swat */
587 unsigned long share_file_id;
588 uint32 uid; /* uid of file opener. */
589 uint16 flags; /* See SHARE_MODE_XX above. */
590 uint32_t name_hash; /* Jenkins hash of full pathname. */
593 /* oplock break message definition - linearization of share_mode_entry.
596 0 struct server_id pid 4
599 14 uint32 access_mask 4
600 18 uint32 share_access 4
601 22 uint32 private_options 4
603 30 uint32 time usec 4
604 34 uint64 dev 8 bytes
605 42 uint64 inode 8 bytes
606 50 uint64 extid 8 bytes
607 58 unsigned long file_id 4 bytes
608 62 uint32 uid 4 bytes
609 66 uint16 flags 2 bytes
610 68 uint32 name_hash 4 bytes
615 #define OP_BREAK_MSG_PID_OFFSET 0
616 #define OP_BREAK_MSG_MID_OFFSET 4
617 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
618 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
619 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
620 #define OP_BREAK_MSG_PRIV_OFFSET 22
621 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
622 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
623 #define OP_BREAK_MSG_DEV_OFFSET 34
624 #define OP_BREAK_MSG_INO_OFFSET 42
625 #define OP_BREAK_MSG_EXTID_OFFSET 50
626 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
627 #define OP_BREAK_MSG_UID_OFFSET 62
628 #define OP_BREAK_MSG_FLAGS_OFFSET 66
629 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
631 #define OP_BREAK_MSG_VNN_OFFSET 72
632 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
634 struct delete_token_list {
635 struct delete_token_list *next, *prev;
637 struct security_unix_token *delete_token;
640 struct share_mode_lock {
641 const char *servicepath; /* canonicalized. */
642 const char *base_name;
643 const char *stream_name;
646 struct share_mode_entry *share_modes;
647 struct delete_token_list *delete_tokens;
648 struct timespec old_write_time;
649 struct timespec changed_write_time;
652 struct db_record *record;
656 * Internal structure of locking.tdb share mode db.
657 * Used by locking.c and libsmbsharemodes.c
660 struct locking_data {
663 int num_share_mode_entries;
664 struct timespec old_write_time;
665 struct timespec changed_write_time;
666 uint32 num_delete_token_entries;
668 struct share_mode_entry dummy; /* Needed for alignment. */
670 /* The following four entries are implicit
672 (1) struct share_mode_entry modes[num_share_mode_entries];
674 (2) A num_delete_token_entries of structs {
675 uint32_t len_delete_token;
676 char unix_token[len_delete_token] (divisible by 4).
679 (3) char share_name[];
680 (4) char file_name[];
684 #define NT_HASH_LEN 16
685 #define LM_HASH_LEN 16
687 /* key and data in the connections database - used in smbstatus and smbd */
688 struct connections_key {
689 struct server_id pid;
694 struct connections_data {
696 struct server_id pid;
700 char servicename[FSTRING_LEN];
702 char machine[FSTRING_LEN];
706 * This field used to hold the msg_flags. For compatibility reasons,
707 * keep the data structure in the tdb file the same.
709 uint32 unused_compatitibility_field;
713 /* the following are used by loadparm for option lists */
715 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
716 P_STRING,P_USTRING,P_ENUM,P_SEP
720 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
728 struct loadparm_service;
735 bool (*special)(int snum, const char *, char **);
736 const struct enum_list *enum_list;
747 /* The following flags are used in SWAT */
748 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
749 #define FLAG_SHARE 0x0002 /* file sharing options */
750 #define FLAG_PRINT 0x0004 /* printing options */
751 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
752 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
753 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
754 #define FLAG_DEVELOPER 0x0040 /* No longer used */
755 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
756 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
757 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
758 #define FLAG_META 0x8000 /* A meta directive - not a real parameter */
759 #define FLAG_CMDLINE 0x10000 /* option has been overridden */
766 /* offsets into message for common items */
773 #define smb_pidhigh 16
774 #define smb_ss_field 18
800 /* flag defines. CIFS spec 3.1.1 */
801 #define FLAG_SUPPORT_LOCKREAD 0x01
802 #define FLAG_CLIENT_BUF_AVAIL 0x02
803 #define FLAG_RESERVED 0x04
804 #define FLAG_CASELESS_PATHNAMES 0x08
805 #define FLAG_CANONICAL_PATHNAMES 0x10
806 #define FLAG_REQUEST_OPLOCK 0x20
807 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
808 #define FLAG_REPLY 0x80
811 #define SMBmkdir 0x00 /* create directory */
812 #define SMBrmdir 0x01 /* delete directory */
813 #define SMBopen 0x02 /* open file */
814 #define SMBcreate 0x03 /* create file */
815 #define SMBclose 0x04 /* close file */
816 #define SMBflush 0x05 /* flush file */
817 #define SMBunlink 0x06 /* delete file */
818 #define SMBmv 0x07 /* rename file */
819 #define SMBgetatr 0x08 /* get file attributes */
820 #define SMBsetatr 0x09 /* set file attributes */
821 #define SMBread 0x0A /* read from file */
822 #define SMBwrite 0x0B /* write to file */
823 #define SMBlock 0x0C /* lock byte range */
824 #define SMBunlock 0x0D /* unlock byte range */
825 #define SMBctemp 0x0E /* create temporary file */
826 #define SMBmknew 0x0F /* make new file */
827 #define SMBcheckpath 0x10 /* check directory path */
828 #define SMBexit 0x11 /* process exit */
829 #define SMBlseek 0x12 /* seek */
830 #define SMBtcon 0x70 /* tree connect */
831 #define SMBtconX 0x75 /* tree connect and X*/
832 #define SMBtdis 0x71 /* tree disconnect */
833 #define SMBnegprot 0x72 /* negotiate protocol */
834 #define SMBdskattr 0x80 /* get disk attributes */
835 #define SMBsearch 0x81 /* search directory */
836 #define SMBsplopen 0xC0 /* open print spool file */
837 #define SMBsplwr 0xC1 /* write to print spool file */
838 #define SMBsplclose 0xC2 /* close print spool file */
839 #define SMBsplretq 0xC3 /* return print queue */
840 #define SMBsends 0xD0 /* send single block message */
841 #define SMBsendb 0xD1 /* send broadcast message */
842 #define SMBfwdname 0xD2 /* forward user name */
843 #define SMBcancelf 0xD3 /* cancel forward */
844 #define SMBgetmac 0xD4 /* get machine name */
845 #define SMBsendstrt 0xD5 /* send start of multi-block message */
846 #define SMBsendend 0xD6 /* send end of multi-block message */
847 #define SMBsendtxt 0xD7 /* send text of multi-block message */
850 #define SMBlockread 0x13 /* Lock a range and read */
851 #define SMBwriteunlock 0x14 /* Unlock a range then write */
852 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
853 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
854 #define SMBwritec 0x20 /* secondary write request */
855 #define SMBwriteclose 0x2c /* write a file then close it */
857 /* dos extended protocol */
858 #define SMBreadBraw 0x1A /* read block raw */
859 #define SMBreadBmpx 0x1B /* read block multiplexed */
860 #define SMBreadBs 0x1C /* read block (secondary response) */
861 #define SMBwriteBraw 0x1D /* write block raw */
862 #define SMBwriteBmpx 0x1E /* write block multiplexed */
863 #define SMBwriteBs 0x1F /* write block (secondary request) */
864 #define SMBwriteC 0x20 /* write complete response */
865 #define SMBsetattrE 0x22 /* set file attributes expanded */
866 #define SMBgetattrE 0x23 /* get file attributes expanded */
867 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
868 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
869 #define SMBtranss 0x26 /* transaction (secondary request/response) */
870 #define SMBioctl 0x27 /* IOCTL */
871 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
872 #define SMBcopy 0x29 /* copy */
873 #define SMBmove 0x2A /* move */
874 #define SMBecho 0x2B /* echo */
875 #define SMBopenX 0x2D /* open and X */
876 #define SMBreadX 0x2E /* read and X */
877 #define SMBwriteX 0x2F /* write and X */
878 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
879 #define SMBffirst 0x82 /* find first */
880 #define SMBfunique 0x83 /* find unique */
881 #define SMBfclose 0x84 /* find close */
882 #define SMBkeepalive 0x85 /* keepalive */
883 #define SMBinvalid 0xFE /* invalid command */
885 /* Extended 2.0 protocol */
886 #define SMBtrans2 0x32 /* TRANS2 protocol set */
887 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
888 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
889 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
890 #define SMBulogoffX 0x74 /* user logoff */
892 /* NT SMB extensions. */
893 #define SMBnttrans 0xA0 /* NT transact */
894 #define SMBnttranss 0xA1 /* NT transact secondary */
895 #define SMBntcreateX 0xA2 /* NT create and X */
896 #define SMBntcancel 0xA4 /* NT cancel */
897 #define SMBntrename 0xA5 /* NT rename */
899 /* These are the trans subcommands */
900 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
901 #define TRANSACT_DCERPCCMD 0x26
902 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
904 /* These are the TRANS2 sub commands */
905 #define TRANSACT2_OPEN 0x00
906 #define TRANSACT2_FINDFIRST 0x01
907 #define TRANSACT2_FINDNEXT 0x02
908 #define TRANSACT2_QFSINFO 0x03
909 #define TRANSACT2_SETFSINFO 0x04
910 #define TRANSACT2_QPATHINFO 0x05
911 #define TRANSACT2_SETPATHINFO 0x06
912 #define TRANSACT2_QFILEINFO 0x07
913 #define TRANSACT2_SETFILEINFO 0x08
914 #define TRANSACT2_FSCTL 0x09
915 #define TRANSACT2_IOCTL 0x0A
916 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
917 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
918 #define TRANSACT2_MKDIR 0x0D
919 #define TRANSACT2_SESSION_SETUP 0x0E
920 #define TRANSACT2_GET_DFS_REFERRAL 0x10
921 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
923 /* These are the NT transact sub commands. */
924 #define NT_TRANSACT_CREATE 1
925 #define NT_TRANSACT_IOCTL 2
926 #define NT_TRANSACT_SET_SECURITY_DESC 3
927 #define NT_TRANSACT_NOTIFY_CHANGE 4
928 #define NT_TRANSACT_RENAME 5
929 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
930 #define NT_TRANSACT_GET_USER_QUOTA 7
931 #define NT_TRANSACT_SET_USER_QUOTA 8
933 /* These are the NT transact_get_user_quota sub commands */
934 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
935 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
936 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
938 /* Relevant IOCTL codes */
939 #define IOCTL_QUERY_JOB_INFO 0x530060
941 /* these are the trans2 sub fields for primary requests */
942 #define smb_tpscnt smb_vwv0
943 #define smb_tdscnt smb_vwv1
944 #define smb_mprcnt smb_vwv2
945 #define smb_mdrcnt smb_vwv3
946 #define smb_msrcnt smb_vwv4
947 #define smb_flags smb_vwv5
948 #define smb_timeout smb_vwv6
949 #define smb_pscnt smb_vwv9
950 #define smb_psoff smb_vwv10
951 #define smb_dscnt smb_vwv11
952 #define smb_dsoff smb_vwv12
953 #define smb_suwcnt smb_vwv13
954 #define smb_setup smb_vwv14
955 #define smb_setup0 smb_setup
956 #define smb_setup1 (smb_setup+2)
957 #define smb_setup2 (smb_setup+4)
959 /* these are for the secondary requests */
960 #define smb_spscnt smb_vwv2
961 #define smb_spsoff smb_vwv3
962 #define smb_spsdisp smb_vwv4
963 #define smb_sdscnt smb_vwv5
964 #define smb_sdsoff smb_vwv6
965 #define smb_sdsdisp smb_vwv7
966 #define smb_sfid smb_vwv8
968 /* and these for responses */
969 #define smb_tprcnt smb_vwv0
970 #define smb_tdrcnt smb_vwv1
971 #define smb_prcnt smb_vwv3
972 #define smb_proff smb_vwv4
973 #define smb_prdisp smb_vwv5
974 #define smb_drcnt smb_vwv6
975 #define smb_droff smb_vwv7
976 #define smb_drdisp smb_vwv8
978 /* these are for the NT trans primary request. */
979 #define smb_nt_MaxSetupCount smb_vwv0
980 #define smb_nt_Flags (smb_vwv0 + 1)
981 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
982 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
983 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
984 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
985 #define smb_nt_ParameterCount (smb_vwv0 + 19)
986 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
987 #define smb_nt_DataCount (smb_vwv0 + 27)
988 #define smb_nt_DataOffset (smb_vwv0 + 31)
989 #define smb_nt_SetupCount (smb_vwv0 + 35)
990 #define smb_nt_Function (smb_vwv0 + 36)
991 #define smb_nt_SetupStart (smb_vwv0 + 38)
993 /* these are for the NT trans secondary request. */
994 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
995 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
996 #define smb_nts_ParameterCount (smb_vwv0 + 11)
997 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
998 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
999 #define smb_nts_DataCount (smb_vwv0 + 23)
1000 #define smb_nts_DataOffset (smb_vwv0 + 27)
1001 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1003 /* these are for the NT trans reply. */
1004 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1005 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1006 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1007 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1008 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1009 #define smb_ntr_DataCount (smb_vwv0 + 23)
1010 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1011 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1013 /* these are for the NT create_and_X */
1014 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1015 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1016 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1017 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1018 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1019 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1020 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1021 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1022 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1023 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1024 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1026 /* this is used on a TConX. I'm not sure the name is very helpful though */
1027 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1028 #define SMB_SHARE_IN_DFS 0x0002
1030 /* Named pipe write mode flags. Used in writeX calls. */
1031 #define PIPE_RAW_MODE 0x4
1032 #define PIPE_START_MESSAGE 0x8
1034 /* the desired access to use when opening a pipe */
1035 #define DESIRED_ACCESS_PIPE 0x2019f
1037 /* Mapping of access rights to UNIX perms. */
1038 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1039 #define UNIX_ACCESS_R FILE_GENERIC_READ
1040 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1041 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1043 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1044 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1045 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1046 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1047 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1051 * This is the old mapping we used to use. To get W2KSP2 profiles
1052 * working we need to map to the canonical file perms.
1054 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1055 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1056 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1057 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1058 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1059 FILE_APPEND_DATA|FILE_WRITE_DATA)
1060 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1061 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1064 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1067 #define REQUEST_OPLOCK 2
1068 #define REQUEST_BATCH_OPLOCK 4
1069 #define OPEN_DIRECTORY 8
1070 #define EXTENDED_RESPONSE_REQUIRED 0x10
1072 /* ShareAccess field. */
1073 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1074 #define FILE_SHARE_READ 1
1075 #define FILE_SHARE_WRITE 2
1076 #define FILE_SHARE_DELETE 4
1078 /* Flags - combined with attributes. */
1079 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1080 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1081 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1082 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1083 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1084 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1085 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1087 /* CreateDisposition field. */
1088 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1089 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1090 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1091 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1092 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1093 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1095 /* CreateOptions field. */
1096 #define FILE_DIRECTORY_FILE 0x0001
1097 #define FILE_WRITE_THROUGH 0x0002
1098 #define FILE_SEQUENTIAL_ONLY 0x0004
1099 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1100 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
1101 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
1102 #define FILE_NON_DIRECTORY_FILE 0x0040
1103 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
1104 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
1105 #define FILE_NO_EA_KNOWLEDGE 0x0200
1106 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1107 #define FILE_RANDOM_ACCESS 0x0800
1108 #define FILE_DELETE_ON_CLOSE 0x1000
1109 #define FILE_OPEN_BY_FILE_ID 0x2000
1110 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
1111 #define FILE_NO_COMPRESSION 0x8000
1112 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
1113 #define FILE_OPEN_REPARSE_POINT 0x00200000
1114 #define FILE_OPEN_NO_RECALL 0x00400000
1115 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1117 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1119 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1122 * Private create options used by the ntcreatex processing code. From Samba4.
1123 * We reuse some ignored flags for private use. Passed in the private_flags
1126 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
1127 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
1129 /* Private options for streams support */
1130 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1132 /* Private options for printer support */
1133 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1135 /* Responses when opening a file. */
1136 #define FILE_WAS_SUPERSEDED 0
1137 #define FILE_WAS_OPENED 1
1138 #define FILE_WAS_CREATED 2
1139 #define FILE_WAS_OVERWRITTEN 3
1141 /* File type flags */
1142 #define FILE_TYPE_DISK 0
1143 #define FILE_TYPE_BYTE_MODE_PIPE 1
1144 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1145 #define FILE_TYPE_PRINTER 3
1146 #define FILE_TYPE_COMM_DEVICE 4
1147 #define FILE_TYPE_UNKNOWN 0xFFFF
1149 /* Flag for NT transact rename call. */
1150 #define RENAME_REPLACE_IF_EXISTS 1
1152 /* flags for SMBntrename call (from Samba4) */
1153 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1154 #define RENAME_FLAG_HARD_LINK 0x103
1155 #define RENAME_FLAG_RENAME 0x104
1156 #define RENAME_FLAG_COPY 0x105
1158 /* Filesystem Attributes. */
1159 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1160 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1161 #define FILE_UNICODE_ON_DISK 0x00000004
1162 /* According to cifs9f, this is 4, not 8 */
1163 /* Acconding to testing, this actually sets the security attribute! */
1164 #define FILE_PERSISTENT_ACLS 0x00000008
1165 #define FILE_FILE_COMPRESSION 0x00000010
1166 #define FILE_VOLUME_QUOTAS 0x00000020
1167 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1168 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1169 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1170 #define FS_LFN_APIS 0x00004000
1171 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1172 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1173 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1174 #define FILE_NAMED_STREAMS 0x00040000
1175 #define FILE_READ_ONLY_VOLUME 0x00080000
1177 /* ChangeNotify flags. */
1178 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1179 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1180 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1181 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1182 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1183 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1184 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1185 #define FILE_NOTIFY_CHANGE_EA 0x080
1186 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1187 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1188 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1189 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1191 #define FILE_NOTIFY_CHANGE_NAME \
1192 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1194 /* change notify action results */
1195 #define NOTIFY_ACTION_ADDED 1
1196 #define NOTIFY_ACTION_REMOVED 2
1197 #define NOTIFY_ACTION_MODIFIED 3
1198 #define NOTIFY_ACTION_OLD_NAME 4
1199 #define NOTIFY_ACTION_NEW_NAME 5
1200 #define NOTIFY_ACTION_ADDED_STREAM 6
1201 #define NOTIFY_ACTION_REMOVED_STREAM 7
1202 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1205 /* where to find the base of the SMB packet proper */
1206 #define smb_base(buf) (((const char *)(buf))+4)
1208 /* we don't allow server strings to be longer than 48 characters as
1209 otherwise NT will not honour the announce packets */
1210 #define MAX_SERVER_STRING_LENGTH 48
1213 #define SMB_SUCCESS 0 /* The request was successful. */
1216 void dfs_unlogin(void);
1217 extern int dcelogin_atmost_once;
1221 char *strdup(char *s);
1228 /* This was set by JHT in liaison with Jeremy Allison early 1997
1230 * Version 4.0 - never made public
1231 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1232 * - Reappeared in 1.9.16p11 with fixed smbd services
1233 * Version 4.20 - To indicate that nmbd and browsing now works better
1234 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1236 * Note: In the presence of NT4.X do not set above 4.9
1237 * Setting this above 4.9 can have undesired side-effects.
1238 * This may change again in Samba-3.0 after further testing. JHT
1241 #define SAMBA_MAJOR_NBT_ANNOUNCE_VERSION 0x04
1242 #define SAMBA_MINOR_NBT_ANNOUNCE_VERSION 0x09
1244 /* Browser Election Values */
1245 #define BROWSER_ELECTION_VERSION 0x010f
1246 #define BROWSER_CONSTANT 0xaa55
1248 /* Sercurity mode bits. */
1249 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1250 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1251 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1252 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1254 /* TCONX Flag (smb_vwv2). */
1255 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1257 /* File Status Flags. See:
1259 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1263 #define NO_SUBSTREAMS 0x2
1264 #define NO_REPARSETAG 0x4
1266 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1268 #define CAP_RAW_MODE 0x0001
1269 #define CAP_MPX_MODE 0x0002
1270 #define CAP_UNICODE 0x0004
1271 #define CAP_LARGE_FILES 0x0008
1272 #define CAP_NT_SMBS 0x0010
1273 #define CAP_RPC_REMOTE_APIS 0x0020
1274 #define CAP_STATUS32 0x0040
1275 #define CAP_LEVEL_II_OPLOCKS 0x0080
1276 #define CAP_LOCK_AND_READ 0x0100
1277 #define CAP_NT_FIND 0x0200
1278 #define CAP_DFS 0x1000
1279 #define CAP_W2K_SMBS 0x2000
1280 #define CAP_LARGE_READX 0x4000
1281 #define CAP_LARGE_WRITEX 0x8000
1282 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1283 #define CAP_EXTENDED_SECURITY 0x80000000
1285 /* protocol types. It assumes that higher protocols include lower protocols
1287 enum protocol_types {
1297 /* printing types */
1298 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1299 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1300 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1301 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1302 ,PRINT_TEST,PRINT_VLP
1303 #endif /* DEVELOPER */
1306 /* LDAP SSL options */
1307 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1309 /* LDAP PASSWD SYNC methods */
1310 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1313 * This should be under the HAVE_KRB5 flag but since they're used
1314 * in lp_kerberos_method(), they ned to be always available
1315 * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
1316 * so they remain accurate.
1319 #define KERBEROS_VERIFY_SECRETS 0
1320 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1321 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1322 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1324 /* Remote architectures we know about. */
1325 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1326 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1327 RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
1330 enum case_handling {CASE_LOWER,CASE_UPPER};
1332 /* ACL compatibility */
1333 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1335 * Global value meaing that the smb_uid field should be
1336 * ingored (in share level security and protocol level == CORE)
1339 #define UID_FIELD_INVALID 0
1340 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1343 * Size of buffer to use when moving files across filesystems.
1345 #define COPYBUF_SIZE (8*1024)
1348 * Map the Core and Extended Oplock requesst bits down
1349 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1355 #define CORE_OPLOCK_REQUEST(inbuf) \
1356 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1359 * Extended protocol.
1361 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1364 #define LOCKING_ANDX_SHARED_LOCK 0x1
1365 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1366 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1367 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1368 #define LOCKING_ANDX_LARGE_FILES 0x10
1371 * Bits we test with.
1372 * Note these must fit into 16-bits.
1375 #define NO_OPLOCK 0x0
1376 #define EXCLUSIVE_OPLOCK 0x1
1377 #define BATCH_OPLOCK 0x2
1378 #define LEVEL_II_OPLOCK 0x4
1380 /* The following are Samba-private. */
1381 #define INTERNAL_OPEN_ONLY 0x8
1382 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1383 * inform potential level2 holders on
1385 #define DEFERRED_OPEN_ENTRY 0x20
1386 #define UNUSED_SHARE_MODE_ENTRY 0x40
1387 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1389 /* None of the following should ever appear in fsp->oplock_request. */
1390 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1392 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1393 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1394 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1396 /* kernel_oplock_message definition.
1398 struct kernel_oplock_message {
1402 unsigned long file_id;
1406 0 uint64_t dev 8 bytes
1407 8 uint64_t inode 8 bytes
1408 16 uint64_t extid 8 bytes
1409 24 unsigned long file_id 4 bytes
1413 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1415 /* file_renamed_message definition.
1417 struct file_renamed_message {
1420 char names[1]; A variable area containing sharepath and filename.
1424 0 uint64_t dev 8 bytes
1425 8 uint64_t inode 8 bytes
1426 16 unit64_t extid 8 bytes
1427 24 char [] name zero terminated namelen bytes
1428 minimum length == 24.
1432 #define MSG_FILE_RENAMED_MIN_SIZE 24
1435 * On the wire return values for oplock types.
1438 #define CORE_OPLOCK_GRANTED (1<<5)
1439 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1441 #define NO_OPLOCK_RETURN 0
1442 #define EXCLUSIVE_OPLOCK_RETURN 1
1443 #define BATCH_OPLOCK_RETURN 2
1444 #define LEVEL_II_OPLOCK_RETURN 3
1447 #define OPLOCKLEVEL_NONE 0
1448 #define OPLOCKLEVEL_II 1
1451 * Capabilities abstracted for different systems.
1454 enum smbd_capability {
1455 KERNEL_OPLOCK_CAPABILITY,
1456 DMAPI_ACCESS_CAPABILITY,
1461 * Kernel oplocks capability flags.
1464 /* Level 2 oplocks are supported natively by kernel oplocks. */
1465 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1467 /* The kernel notifies deferred openers when they can retry the open. */
1468 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1470 /* The kernel notifies smbds when an oplock break times out. */
1471 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1473 /* The kernel notifies smbds when an oplock is broken. */
1474 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1476 struct kernel_oplocks_ops;
1477 struct kernel_oplocks {
1478 const struct kernel_oplocks_ops *ops;
1483 enum level2_contention_type {
1484 LEVEL2_CONTEND_ALLOC_SHRINK,
1485 LEVEL2_CONTEND_ALLOC_GROW,
1486 LEVEL2_CONTEND_SET_FILE_LEN,
1487 LEVEL2_CONTEND_FILL_SPARSE,
1488 LEVEL2_CONTEND_WRITE,
1489 LEVEL2_CONTEND_WINDOWS_BRL,
1490 LEVEL2_CONTEND_POSIX_BRL
1493 /* if a kernel does support oplocks then a structure of the following
1494 typee is used to describe how to interact with the kernel */
1495 struct kernel_oplocks_ops {
1496 bool (*set_oplock)(struct kernel_oplocks *ctx,
1497 files_struct *fsp, int oplock_type);
1498 void (*release_oplock)(struct kernel_oplocks *ctx,
1499 files_struct *fsp, int oplock_type);
1500 void (*contend_level2_oplocks_begin)(files_struct *fsp,
1501 enum level2_contention_type type);
1502 void (*contend_level2_oplocks_end)(files_struct *fsp,
1503 enum level2_contention_type type);
1506 #include "smb_macros.h"
1508 #define MAX_NETBIOSNAME_LEN 16
1509 /* DOS character, NetBIOS namestring. Type used on the wire. */
1510 typedef char nstring[MAX_NETBIOSNAME_LEN];
1511 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1512 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1514 /* A netbios name structure. */
1518 unsigned int name_type;
1521 /* A netbios node status array element. */
1522 struct node_status {
1525 unsigned char flags;
1528 /* The extra info from a NetBIOS node status query */
1529 struct node_status_extra {
1530 unsigned char mac_addr[6];
1531 /* There really is more here ... */
1534 typedef struct user_struct {
1535 struct user_struct *next, *prev;
1536 uint16 vuid; /* Tag for this entry. */
1538 char *session_keystr; /* used by utmp and pam session code.
1542 struct auth_serversupplied_info *session_info;
1544 struct auth_ntlmssp_state *auth_ntlmssp_state;
1548 Do you want session setups at user level security with a invalid
1549 password to be rejected or allowed in as guest? WinNT rejects them
1550 but it can be a pain as it means "net view" needs to use a password
1552 You have 3 choices in the setting of map_to_guest:
1554 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1555 are rejected. This is the default.
1557 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1558 are rejected, unless the username does not exist, in which case it
1559 is treated as a guest login
1561 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1562 are treated as a guest login
1564 Note that map_to_guest only has an effect in user or server
1568 #define NEVER_MAP_TO_GUEST 0
1569 #define MAP_TO_GUEST_ON_BAD_USER 1
1570 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1571 #define MAP_TO_GUEST_ON_BAD_UID 3
1573 #define SAFE_NETBIOS_CHARS ". -_"
1575 /* The maximum length of a trust account password.
1576 Used when we randomly create it, 15 char passwords
1577 exceed NT4's max password length */
1579 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1583 #define LDAP_PORT 389
1585 #define LDAP_GC_PORT 3268
1587 /* used by the IP comparison function */
1589 struct sockaddr_storage ss;
1600 struct ea_list *next, *prev;
1601 struct ea_struct ea;
1604 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1605 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1606 /* EA to use for DOS attributes */
1607 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1608 /* Prefix for DosStreams in the vfs_streams_xattr module */
1609 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1610 /* Prefix for xattrs storing streams. */
1611 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1613 /* map readonly options */
1614 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1616 /* usershare error codes. */
1617 enum usershare_err {
1619 USERSHARE_MALFORMED_FILE,
1620 USERSHARE_BAD_VERSION,
1621 USERSHARE_MALFORMED_PATH,
1622 USERSHARE_MALFORMED_COMMENT_DEF,
1623 USERSHARE_MALFORMED_ACL_DEF,
1625 USERSHARE_PATH_NOT_ABSOLUTE,
1626 USERSHARE_PATH_IS_DENIED,
1627 USERSHARE_PATH_NOT_ALLOWED,
1628 USERSHARE_PATH_NOT_DIRECTORY,
1629 USERSHARE_POSIX_ERR,
1630 USERSHARE_MALFORMED_SHARENAME_DEF,
1631 USERSHARE_BAD_SHARENAME
1634 /* Different reasons for closing a file. */
1635 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1637 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1638 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1639 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1640 struct smb_extended_info {
1641 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1642 uint32 samba_version; /* Major/Minor/Release/Revision */
1643 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1644 NTTIME samba_gitcommitdate;
1645 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1649 struct smb_file_time {
1650 struct timespec mtime;
1651 struct timespec atime;
1652 struct timespec ctime;
1653 struct timespec create_time;
1657 * unix_convert_flags
1659 #define UCF_SAVE_LCOMP 0x00000001
1660 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1661 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1662 #define UCF_POSIX_PATHNAMES 0x00000008
1667 struct smb_filename {
1670 char *original_lcomp;
1674 /* struct for maintaining the child processes that get spawned from smbd */
1676 struct child_pid *prev, *next;
1680 /* Used to keep track of deferred opens. */
1681 struct deferred_open_record;
1683 /* Client-side offline caching policy types */
1684 #define CSC_POLICY_MANUAL 0
1685 #define CSC_POLICY_DOCUMENTS 1
1686 #define CSC_POLICY_PROGRAMS 2
1687 #define CSC_POLICY_DISABLE 3
1689 /* Used inside aio code. */
1693 * Reasons for cache flush.
1696 enum flush_reason_enum {
1701 OPLOCK_RELEASE_FLUSH,
1705 /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */