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 #define DIR_STRUCT_SIZE 43
85 #define DOS_OPEN_RDONLY 0
86 #define DOS_OPEN_WRONLY 1
87 #define DOS_OPEN_RDWR 2
88 #define DOS_OPEN_EXEC 3
89 #define DOS_OPEN_FCB 0xF
91 /* define shifts and masks for share and open modes. */
92 #define OPENX_MODE_MASK 0xF
93 #define DENY_MODE_SHIFT 4
94 #define DENY_MODE_MASK 0x7
95 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
96 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
97 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
98 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
100 /* Sync on open file (not sure if used anymore... ?) */
101 #define FILE_SYNC_OPENMODE (1<<14)
102 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
104 /* open disposition values */
105 #define OPENX_FILE_EXISTS_FAIL 0
106 #define OPENX_FILE_EXISTS_OPEN 1
107 #define OPENX_FILE_EXISTS_TRUNCATE 2
109 /* mask for open disposition. */
110 #define OPENX_FILE_OPEN_MASK 0x3
112 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
113 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
115 /* The above can be OR'ed with... */
116 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
117 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
119 typedef union unid_t
{
124 /* pipe string names */
127 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
130 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
132 #include "librpc/gen_ndr/security.h"
135 * The complete list of SIDS belonging to this user.
136 * Created when a vuid is registered.
137 * The definition of the user_sids array is as follows :
139 * token->user_sids[0] = primary user SID.
140 * token->user_sids[1] = primary group SID.
141 * token->user_sids[2..num_sids] = supplementary group SIDS.
144 #define PRIMARY_USER_SID_INDEX 0
145 #define PRIMARY_GROUP_SID_INDEX 1
147 typedef struct write_cache
{
158 uint64_t position_information
;
160 uint32 private_options
; /* NT Create options, but we only look at
161 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
162 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
163 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
164 * for print files *only*, where
165 * DELETE_ON_CLOSE is not stored in the share
168 unsigned long gen_id
;
172 struct share_mode_entry
;
176 struct rpc_cli_smbd_conn
;
177 struct fncall_context
;
179 struct vfs_fsp_data
{
180 struct vfs_fsp_data
*next
;
181 struct vfs_handle_struct
*owner
;
182 void (*destroy
)(void *p_data
);
184 /* NOTE: This structure contains four pointers so that we can guarantee
185 * that the end of the structure is always both 4-byte and 8-byte aligned.
189 /* the basic packet size, assuming no words or bytes */
192 struct notify_change
{
197 struct notify_mid_map
;
200 struct notify_change_request
;
201 struct sys_notify_backend
;
202 struct sys_notify_context
{
203 struct event_context
*ev
;
204 struct connection_struct
*conn
;
205 void *private_data
; /* For use by the system backend */
208 struct notify_change_buf
{
210 * If no requests are pending, changes are queued here. Simple array,
215 * num_changes == -1 means that we have got a catch-all change, when
216 * asked we just return NT_STATUS_OK without specific changes.
219 struct notify_change
*changes
;
222 * If no changes are around requests are queued here. Using a linked
223 * list, because we have to append at the end and delete from the top.
225 struct notify_change_request
*requests
;
228 struct print_file_data
{
232 struct policy_handle handle
;
237 typedef struct files_struct
{
238 struct files_struct
*next
, *prev
;
240 struct connection_struct
*conn
;
241 struct fd_handle
*fh
;
242 unsigned int num_smb_operations
;
243 struct file_id file_id
;
244 uint64_t initial_allocation_size
; /* Faked up initial allocation on disk. */
249 struct timeval open_time
;
250 uint32 access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
251 uint32 share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
253 bool update_write_time_triggered
;
254 struct timed_event
*update_write_time_event
;
255 bool update_write_time_on_close
;
256 struct timespec close_write_time
;
257 bool write_time_forced
;
260 int sent_oplock_break
;
261 struct timed_event
*oplock_timeout
;
262 struct lock_struct last_lock_failure
;
263 int current_lock_count
; /* Count the number of outstanding locks and pending locks. */
265 struct share_mode_entry
*pending_break_messages
;
266 int num_pending_break_messages
;
273 bool aio_write_behind
;
275 bool initial_delete_on_close
; /* Only set at NTCreateX if file was created. */
276 bool delete_on_close
;
279 struct smb_filename
*fsp_name
;
280 uint32_t name_hash
; /* Jenkins hash of full pathname. */
282 struct vfs_fsp_data
*vfs_extension
;
283 struct fake_file_handle
*fake_file_handle
;
285 struct notify_change_buf
*notify
;
287 struct files_struct
*base_fsp
; /* placeholder for delete on close */
290 * Read-only cached brlock record, thrown away when the
291 * brlock.tdb seqnum changes. This avoids fetching data from
292 * the brlock.tdb on every read/write call.
295 struct byte_range_lock
*brlock_rec
;
297 struct dptr_struct
*dptr
;
299 /* if not NULL, means this is a print file */
300 struct print_file_data
*print_file
;
304 #include "ntquotas.h"
305 #include "sysquotas.h"
307 struct vuid_cache_entry
{
308 struct auth_session_info
*session_info
;
314 unsigned int next_entry
;
315 struct vuid_cache_entry array
[VUID_CACHE_SIZE
];
321 } name_compare_entry
;
324 struct trans_state
*next
, *prev
;
328 uint32 max_param_return
;
329 uint32 max_data_return
;
330 uint32 max_setup_return
;
332 uint8 cmd
; /* SMBtrans or SMBtrans2 */
334 char *name
; /* for trans requests */
335 uint16 call
; /* for trans2 and nttrans requests */
337 bool close_on_completion
;
340 unsigned int setup_count
;
343 size_t received_data
;
344 size_t received_param
;
354 * Info about an alternate data stream
357 struct stream_struct
{
359 SMB_OFF_T alloc_size
;
363 /* Include VFS stuff */
365 #include "smb_acls.h"
368 struct dfree_cached_info
{
369 time_t last_dfree_time
;
378 struct share_params
{
382 typedef struct connection_struct
{
383 struct connection_struct
*next
, *prev
;
384 struct smbd_server_connection
*sconn
; /* can be NULL */
385 unsigned cnum
; /* an index passed over the wire */
386 struct share_params
*params
;
388 struct vuid_cache vuid_cache
;
391 bool read_only
; /* Attributes for the current user of the share. */
392 uint32_t share_access
;
393 /* Does this filesystem honor
394 sub second timestamps on files
395 and directories when setting time ? */
396 enum timestamp_set_resolution ts_res
;
400 struct vfs_handle_struct
*vfs_handles
; /* for the new plugins */
403 * This represents the user information on this connection. Depending
404 * on the vuid using this tid, this might change per SMB request.
406 struct auth_session_info
*session_info
;
409 * If the "force group" parameter is set, this is the primary gid that
410 * may be used in the users token, depending on the vuid using this tid.
412 gid_t force_group_gid
;
414 uint16 vuid
; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
417 time_t lastused_count
;
420 unsigned int num_smb_operations
; /* Count of smb operations on this tree. */
424 /* Semantics requested by the client or forced by the server config. */
427 bool short_case_preserve
;
429 /* Semantics provided by the underlying filesystem. */
431 /* Device number of the directory of the share mount.
432 Used to ensure unique FileIndex returns. */
433 SMB_DEV_T base_share_dev
;
435 name_compare_entry
*hide_list
; /* Per-share list of files to return as hidden. */
436 name_compare_entry
*veto_list
; /* Per-share list of files to veto (never show). */
437 name_compare_entry
*veto_oplock_list
; /* Per-share list of files to refuse oplocks on. */
438 name_compare_entry
*aio_write_behind_list
; /* Per-share list of files to use aio write behind on. */
439 struct dfree_cached_info
*dfree_info
;
440 struct trans_state
*pending_trans
;
441 struct notify_context
*notify_ctx
;
443 struct rpc_pipe_client
*spoolss_pipe
;
447 struct current_user
{
448 connection_struct
*conn
;
450 struct security_unix_token ut
;
451 struct security_token
*nt_user_token
;
454 struct smbd_smb2_request
;
460 uint64_t mid
; /* For compatibility with SMB2. */
471 * Async handling in the main smb processing loop is directed by
472 * outbuf: reply_xxx routines indicate sync behaviour by putting their
473 * reply into "outbuf". If they leave it as NULL, they take of it
474 * themselves, possibly later.
476 * If async handling is wanted, the reply_xxx routine must make sure
477 * that it talloc_move()s the smb_req somewhere else.
483 connection_struct
*conn
;
484 struct smbd_server_connection
*sconn
;
485 struct smb_perfcount_data pcd
;
488 * Chained request handling
490 struct files_struct
*chain_fsp
;
493 * Here we collect the outbufs from the chain handlers
495 uint8_t *chain_outbuf
;
498 * state information for async smb handling
505 * Back pointer to smb2 request.
507 struct smbd_smb2_request
*smb2req
;
510 /* Defines for the sent_oplock_break field above. */
511 #define NO_BREAK_SENT 0
512 #define BREAK_TO_NONE_SENT 1
513 #define LEVEL_II_BREAK_SENT 2
516 fstring smb_name
; /* user name from the client */
517 fstring unix_name
; /* unix user name of a validated user */
518 fstring domain
; /* domain that the client specified */
521 /* used for server information: client, nameserv and ipc */
522 struct server_info_struct
{
526 fstring domain
; /* used ONLY in ipc.c NOT namework.c */
527 bool server_added
; /* used ONLY in ipc.c NOT namework.c */
530 /* used for network interfaces */
532 struct interface
*next
, *prev
;
535 struct sockaddr_storage ip
;
536 struct sockaddr_storage netmask
;
537 struct sockaddr_storage bcast
;
540 /* Internal message queue for deferred opens. */
541 struct pending_message_list
{
542 struct pending_message_list
*next
, *prev
;
543 struct timeval request_time
; /* When was this first issued? */
544 struct timed_event
*te
;
545 struct smb_perfcount_data pcd
;
550 DATA_BLOB private_data
;
553 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
555 #include "librpc/gen_ndr/server_id.h"
557 /* struct returned by get_share_modes */
558 struct share_mode_entry
{
559 struct server_id pid
;
560 uint64_t op_mid
; /* For compatibility with SMB2 opens. */
562 uint32 access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
563 uint32 share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
564 uint32 private_options
; /* NT Create options, but we only look at
565 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
566 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
567 * smbstatus and swat */
570 unsigned long share_file_id
;
571 uint32 uid
; /* uid of file opener. */
572 uint16 flags
; /* See SHARE_MODE_XX above. */
573 uint32_t name_hash
; /* Jenkins hash of full pathname. */
576 /* oplock break message definition - linearization of share_mode_entry.
579 0 struct server_id pid 4
582 14 uint32 access_mask 4
583 18 uint32 share_access 4
584 22 uint32 private_options 4
586 30 uint32 time usec 4
587 34 uint64 dev 8 bytes
588 42 uint64 inode 8 bytes
589 50 uint64 extid 8 bytes
590 58 unsigned long file_id 4 bytes
591 62 uint32 uid 4 bytes
592 66 uint16 flags 2 bytes
593 68 uint32 name_hash 4 bytes
598 #define OP_BREAK_MSG_PID_OFFSET 0
599 #define OP_BREAK_MSG_MID_OFFSET 4
600 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
601 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
602 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
603 #define OP_BREAK_MSG_PRIV_OFFSET 22
604 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
605 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
606 #define OP_BREAK_MSG_DEV_OFFSET 34
607 #define OP_BREAK_MSG_INO_OFFSET 42
608 #define OP_BREAK_MSG_EXTID_OFFSET 50
609 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
610 #define OP_BREAK_MSG_UID_OFFSET 62
611 #define OP_BREAK_MSG_FLAGS_OFFSET 66
612 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
614 #define OP_BREAK_MSG_VNN_OFFSET 72
615 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
617 struct delete_token_list
{
618 struct delete_token_list
*next
, *prev
;
620 struct security_unix_token
*delete_token
;
623 struct share_mode_lock
{
624 const char *servicepath
; /* canonicalized. */
625 const char *base_name
;
626 const char *stream_name
;
629 struct share_mode_entry
*share_modes
;
630 struct delete_token_list
*delete_tokens
;
631 struct timespec old_write_time
;
632 struct timespec changed_write_time
;
635 struct db_record
*record
;
639 * Internal structure of locking.tdb share mode db.
640 * Used by locking.c and libsmbsharemodes.c
643 struct locking_data
{
646 int num_share_mode_entries
;
647 struct timespec old_write_time
;
648 struct timespec changed_write_time
;
649 uint32 num_delete_token_entries
;
651 struct share_mode_entry dummy
; /* Needed for alignment. */
653 /* The following four entries are implicit
655 (1) struct share_mode_entry modes[num_share_mode_entries];
657 (2) A num_delete_token_entries of structs {
658 uint32_t len_delete_token;
659 char unix_token[len_delete_token] (divisible by 4).
662 (3) char share_name[];
663 (4) char file_name[];
667 #define NT_HASH_LEN 16
668 #define LM_HASH_LEN 16
670 /* key and data in the connections database - used in smbstatus and smbd */
671 struct connections_key
{
672 struct server_id pid
;
677 struct connections_data
{
679 struct server_id pid
;
683 char servicename
[FSTRING_LEN
];
685 char machine
[FSTRING_LEN
];
689 * This field used to hold the msg_flags. For compatibility reasons,
690 * keep the data structure in the tdb file the same.
692 uint32 unused_compatitibility_field
;
695 #define SMB_MAGIC 0x424D53FF /* 0xFF 'S' 'M' 'B' */
697 /* the basic packet size, assuming no words or bytes. Does not include the NBT header */
698 #define MIN_SMB_SIZE 35
700 /* when using NBT encapsulation every packet has a 4 byte header */
701 #define NBT_HDR_SIZE 4
703 /* offsets into message header for common items - NOTE: These have
704 changed from being offsets from the base of the NBT packet to the base of the SMB packet.
705 this has reduced all these values by 4
713 #define HDR_PIDHIGH 12
714 #define HDR_SS_FIELD 14
722 /* offsets into message for common items */
723 #define smb_com (NBT_HDR_SIZE+HDR_COM)
724 #define smb_rcls (NBT_HDR_SIZE+HDR_RCLS)
725 #define smb_reh (NBT_HDR_SIZE+HDR_REH)
726 #define smb_err (NBT_HDR_SIZE+HDR_ERR)
727 #define smb_flg (NBT_HDR_SIZE+HDR_FLG)
728 #define smb_flg2 (NBT_HDR_SIZE+HDR_FLG2)
729 #define smb_pidhigh (NBT_HDR_SIZE+HDR_PIDHIGH)
730 #define smb_ss_field (NBT_HDR_SIZE+HDR_SS_FIELD)
731 #define smb_tid (NBT_HDR_SIZE+HDR_TID)
732 #define smb_pid (NBT_HDR_SIZE+HDR_PID)
733 #define smb_uid (NBT_HDR_SIZE+HDR_UID)
734 #define smb_mid (NBT_HDR_SIZE+HDR_MID)
735 #define smb_wct (NBT_HDR_SIZE+HDR_WCT)
736 #define smb_vwv (NBT_HDR_SIZE+HDR_VWV)
737 #define smb_vwv0 (smb_vwv+( 0*2))
738 #define smb_vwv1 (smb_vwv+( 1*2))
739 #define smb_vwv2 (smb_vwv+( 2*2))
740 #define smb_vwv3 (smb_vwv+( 3*2))
741 #define smb_vwv4 (smb_vwv+( 4*2))
742 #define smb_vwv5 (smb_vwv+( 5*2))
743 #define smb_vwv6 (smb_vwv+( 6*2))
744 #define smb_vwv7 (smb_vwv+( 7*2))
745 #define smb_vwv8 (smb_vwv+( 8*2))
746 #define smb_vwv9 (smb_vwv+( 9*2))
747 #define smb_vwv10 (smb_vwv+(10*2))
748 #define smb_vwv11 (smb_vwv+(11*2))
749 #define smb_vwv12 (smb_vwv+(12*2))
750 #define smb_vwv13 (smb_vwv+(13*2))
751 #define smb_vwv14 (smb_vwv+(14*2))
752 #define smb_vwv15 (smb_vwv+(15*2))
753 #define smb_vwv16 (smb_vwv+(16*2))
754 #define smb_vwv17 (smb_vwv+(17*2))
756 /* types of buffers in core SMB protocol */
757 #define SMB_DATA_BLOCK 0x1
758 #define SMB_ASCII4 0x4
761 /* flag defines. CIFS spec 3.1.1 */
762 #define FLAG_SUPPORT_LOCKREAD 0x01
763 #define FLAG_CLIENT_BUF_AVAIL 0x02
764 #define FLAG_RESERVED 0x04
765 #define FLAG_CASELESS_PATHNAMES 0x08
766 #define FLAG_CANONICAL_PATHNAMES 0x10
767 #define FLAG_REQUEST_OPLOCK 0x20
768 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
769 #define FLAG_REPLY 0x80
772 #define SMBmkdir 0x00 /* create directory */
773 #define SMBrmdir 0x01 /* delete directory */
774 #define SMBopen 0x02 /* open file */
775 #define SMBcreate 0x03 /* create file */
776 #define SMBclose 0x04 /* close file */
777 #define SMBflush 0x05 /* flush file */
778 #define SMBunlink 0x06 /* delete file */
779 #define SMBmv 0x07 /* rename file */
780 #define SMBgetatr 0x08 /* get file attributes */
781 #define SMBsetatr 0x09 /* set file attributes */
782 #define SMBread 0x0A /* read from file */
783 #define SMBwrite 0x0B /* write to file */
784 #define SMBlock 0x0C /* lock byte range */
785 #define SMBunlock 0x0D /* unlock byte range */
786 #define SMBctemp 0x0E /* create temporary file */
787 #define SMBmknew 0x0F /* make new file */
788 #define SMBcheckpath 0x10 /* check directory path */
789 #define SMBexit 0x11 /* process exit */
790 #define SMBlseek 0x12 /* seek */
791 #define SMBtcon 0x70 /* tree connect */
792 #define SMBtconX 0x75 /* tree connect and X*/
793 #define SMBtdis 0x71 /* tree disconnect */
794 #define SMBnegprot 0x72 /* negotiate protocol */
795 #define SMBdskattr 0x80 /* get disk attributes */
796 #define SMBsearch 0x81 /* search directory */
797 #define SMBsplopen 0xC0 /* open print spool file */
798 #define SMBsplwr 0xC1 /* write to print spool file */
799 #define SMBsplclose 0xC2 /* close print spool file */
800 #define SMBsplretq 0xC3 /* return print queue */
801 #define SMBsends 0xD0 /* send single block message */
802 #define SMBsendb 0xD1 /* send broadcast message */
803 #define SMBfwdname 0xD2 /* forward user name */
804 #define SMBcancelf 0xD3 /* cancel forward */
805 #define SMBgetmac 0xD4 /* get machine name */
806 #define SMBsendstrt 0xD5 /* send start of multi-block message */
807 #define SMBsendend 0xD6 /* send end of multi-block message */
808 #define SMBsendtxt 0xD7 /* send text of multi-block message */
811 #define SMBlockread 0x13 /* Lock a range and read */
812 #define SMBwriteunlock 0x14 /* Unlock a range then write */
813 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
814 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
815 #define SMBwritec 0x20 /* secondary write request */
816 #define SMBwriteclose 0x2c /* write a file then close it */
818 /* dos extended protocol */
819 #define SMBreadBraw 0x1A /* read block raw */
820 #define SMBreadBmpx 0x1B /* read block multiplexed */
821 #define SMBreadBs 0x1C /* read block (secondary response) */
822 #define SMBwriteBraw 0x1D /* write block raw */
823 #define SMBwriteBmpx 0x1E /* write block multiplexed */
824 #define SMBwriteBs 0x1F /* write block (secondary request) */
825 #define SMBwriteC 0x20 /* write complete response */
826 #define SMBsetattrE 0x22 /* set file attributes expanded */
827 #define SMBgetattrE 0x23 /* get file attributes expanded */
828 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
829 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
830 #define SMBtranss 0x26 /* transaction (secondary request/response) */
831 #define SMBioctl 0x27 /* IOCTL */
832 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
833 #define SMBcopy 0x29 /* copy */
834 #define SMBmove 0x2A /* move */
835 #define SMBecho 0x2B /* echo */
836 #define SMBopenX 0x2D /* open and X */
837 #define SMBreadX 0x2E /* read and X */
838 #define SMBwriteX 0x2F /* write and X */
839 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
840 #define SMBffirst 0x82 /* find first */
841 #define SMBfunique 0x83 /* find unique */
842 #define SMBfclose 0x84 /* find close */
843 #define SMBinvalid 0xFE /* invalid command */
845 /* Extended 2.0 protocol */
846 #define SMBtrans2 0x32 /* TRANS2 protocol set */
847 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
848 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
849 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
850 #define SMBulogoffX 0x74 /* user logoff */
852 /* NT SMB extensions. */
853 #define SMBnttrans 0xA0 /* NT transact */
854 #define SMBnttranss 0xA1 /* NT transact secondary */
855 #define SMBntcreateX 0xA2 /* NT create and X */
856 #define SMBntcancel 0xA4 /* NT cancel */
857 #define SMBntrename 0xA5 /* NT rename */
859 /* used to indicate end of chain */
860 #define SMB_CHAIN_NONE 0xFF
862 /* These are the trans subcommands */
863 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
864 #define TRANSACT_DCERPCCMD 0x26
865 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
867 /* These are the TRANS2 sub commands */
868 #define TRANSACT2_OPEN 0x00
869 #define TRANSACT2_FINDFIRST 0x01
870 #define TRANSACT2_FINDNEXT 0x02
871 #define TRANSACT2_QFSINFO 0x03
872 #define TRANSACT2_SETFSINFO 0x04
873 #define TRANSACT2_QPATHINFO 0x05
874 #define TRANSACT2_SETPATHINFO 0x06
875 #define TRANSACT2_QFILEINFO 0x07
876 #define TRANSACT2_SETFILEINFO 0x08
877 #define TRANSACT2_FSCTL 0x09
878 #define TRANSACT2_IOCTL 0x0A
879 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
880 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
881 #define TRANSACT2_MKDIR 0x0D
882 #define TRANSACT2_SESSION_SETUP 0x0E
883 #define TRANSACT2_GET_DFS_REFERRAL 0x10
884 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
886 /* These are the NT transact sub commands. */
887 #define NT_TRANSACT_CREATE 1
888 #define NT_TRANSACT_IOCTL 2
889 #define NT_TRANSACT_SET_SECURITY_DESC 3
890 #define NT_TRANSACT_NOTIFY_CHANGE 4
891 #define NT_TRANSACT_RENAME 5
892 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
893 #define NT_TRANSACT_GET_USER_QUOTA 7
894 #define NT_TRANSACT_SET_USER_QUOTA 8
896 /* These are the NT transact_get_user_quota sub commands */
897 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
898 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
899 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
901 /* Relevant IOCTL codes */
902 #define IOCTL_QUERY_JOB_INFO 0x530060
904 /* these are the trans2 sub fields for primary requests */
905 #define smb_tpscnt smb_vwv0
906 #define smb_tdscnt smb_vwv1
907 #define smb_mprcnt smb_vwv2
908 #define smb_mdrcnt smb_vwv3
909 #define smb_msrcnt smb_vwv4
910 #define smb_flags smb_vwv5
911 #define smb_timeout smb_vwv6
912 #define smb_pscnt smb_vwv9
913 #define smb_psoff smb_vwv10
914 #define smb_dscnt smb_vwv11
915 #define smb_dsoff smb_vwv12
916 #define smb_suwcnt smb_vwv13
917 #define smb_setup smb_vwv14
918 #define smb_setup0 smb_setup
919 #define smb_setup1 (smb_setup+2)
920 #define smb_setup2 (smb_setup+4)
922 /* these are for the secondary requests */
923 #define smb_spscnt smb_vwv2
924 #define smb_spsoff smb_vwv3
925 #define smb_spsdisp smb_vwv4
926 #define smb_sdscnt smb_vwv5
927 #define smb_sdsoff smb_vwv6
928 #define smb_sdsdisp smb_vwv7
929 #define smb_sfid smb_vwv8
931 /* and these for responses */
932 #define smb_tprcnt smb_vwv0
933 #define smb_tdrcnt smb_vwv1
934 #define smb_prcnt smb_vwv3
935 #define smb_proff smb_vwv4
936 #define smb_prdisp smb_vwv5
937 #define smb_drcnt smb_vwv6
938 #define smb_droff smb_vwv7
939 #define smb_drdisp smb_vwv8
941 /* these are for the NT trans primary request. */
942 #define smb_nt_MaxSetupCount smb_vwv0
943 #define smb_nt_Flags (smb_vwv0 + 1)
944 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
945 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
946 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
947 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
948 #define smb_nt_ParameterCount (smb_vwv0 + 19)
949 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
950 #define smb_nt_DataCount (smb_vwv0 + 27)
951 #define smb_nt_DataOffset (smb_vwv0 + 31)
952 #define smb_nt_SetupCount (smb_vwv0 + 35)
953 #define smb_nt_Function (smb_vwv0 + 36)
954 #define smb_nt_SetupStart (smb_vwv0 + 38)
956 /* these are for the NT trans secondary request. */
957 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
958 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
959 #define smb_nts_ParameterCount (smb_vwv0 + 11)
960 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
961 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
962 #define smb_nts_DataCount (smb_vwv0 + 23)
963 #define smb_nts_DataOffset (smb_vwv0 + 27)
964 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
966 /* these are for the NT trans reply. */
967 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
968 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
969 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
970 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
971 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
972 #define smb_ntr_DataCount (smb_vwv0 + 23)
973 #define smb_ntr_DataOffset (smb_vwv0 + 27)
974 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
976 /* these are for the NT create_and_X */
977 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
978 #define smb_ntcreate_Flags (smb_vwv0 + 7)
979 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
980 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
981 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
982 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
983 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
984 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
985 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
986 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
987 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
989 /* this is used on a TConX. I'm not sure the name is very helpful though */
990 #define SMB_SUPPORT_SEARCH_BITS 0x0001
991 #define SMB_SHARE_IN_DFS 0x0002
993 /* Named pipe write mode flags. Used in writeX calls. */
994 #define PIPE_RAW_MODE 0x4
995 #define PIPE_START_MESSAGE 0x8
997 /* the desired access to use when opening a pipe */
998 #define DESIRED_ACCESS_PIPE 0x2019f
1000 /* Mapping of access rights to UNIX perms. */
1001 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1002 #define UNIX_ACCESS_R FILE_GENERIC_READ
1003 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1004 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1006 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1007 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1008 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1009 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1010 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1014 * This is the old mapping we used to use. To get W2KSP2 profiles
1015 * working we need to map to the canonical file perms.
1017 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1018 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1019 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1020 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1021 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1022 FILE_APPEND_DATA|FILE_WRITE_DATA)
1023 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1024 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1027 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1030 #define REQUEST_OPLOCK 2
1031 #define REQUEST_BATCH_OPLOCK 4
1032 #define OPEN_DIRECTORY 8
1033 #define EXTENDED_RESPONSE_REQUIRED 0x10
1035 /* ShareAccess field. */
1036 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1037 #define FILE_SHARE_READ 1
1038 #define FILE_SHARE_WRITE 2
1039 #define FILE_SHARE_DELETE 4
1041 /* Flags - combined with attributes. */
1042 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1043 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1044 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1045 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1046 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1047 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1048 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1050 /* CreateDisposition field. */
1051 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1052 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1053 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1054 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1055 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1056 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1058 /* CreateOptions field. */
1059 #define FILE_DIRECTORY_FILE 0x0001
1060 #define FILE_WRITE_THROUGH 0x0002
1061 #define FILE_SEQUENTIAL_ONLY 0x0004
1062 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1063 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
1064 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
1065 #define FILE_NON_DIRECTORY_FILE 0x0040
1066 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
1067 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
1068 #define FILE_NO_EA_KNOWLEDGE 0x0200
1069 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1070 #define FILE_RANDOM_ACCESS 0x0800
1071 #define FILE_DELETE_ON_CLOSE 0x1000
1072 #define FILE_OPEN_BY_FILE_ID 0x2000
1073 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
1074 #define FILE_NO_COMPRESSION 0x8000
1075 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
1076 #define FILE_OPEN_REPARSE_POINT 0x00200000
1077 #define FILE_OPEN_NO_RECALL 0x00400000
1078 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1080 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1082 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1085 * Private create options used by the ntcreatex processing code. From Samba4.
1086 * We reuse some ignored flags for private use. Passed in the private_flags
1089 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
1090 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
1092 /* Private options for streams support */
1093 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1095 /* Private options for printer support */
1096 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1098 /* Responses when opening a file. */
1099 #define FILE_WAS_SUPERSEDED 0
1100 #define FILE_WAS_OPENED 1
1101 #define FILE_WAS_CREATED 2
1102 #define FILE_WAS_OVERWRITTEN 3
1104 /* Flag for NT transact rename call. */
1105 #define RENAME_REPLACE_IF_EXISTS 1
1107 /* flags for SMBntrename call (from Samba4) */
1108 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1109 #define RENAME_FLAG_HARD_LINK 0x103
1110 #define RENAME_FLAG_RENAME 0x104
1111 #define RENAME_FLAG_COPY 0x105
1113 /* Filesystem Attributes. */
1114 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1115 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1116 #define FILE_UNICODE_ON_DISK 0x00000004
1117 /* According to cifs9f, this is 4, not 8 */
1118 /* Acconding to testing, this actually sets the security attribute! */
1119 #define FILE_PERSISTENT_ACLS 0x00000008
1120 #define FILE_FILE_COMPRESSION 0x00000010
1121 #define FILE_VOLUME_QUOTAS 0x00000020
1122 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1123 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1124 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1125 #define FS_LFN_APIS 0x00004000
1126 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1127 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1128 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1129 #define FILE_NAMED_STREAMS 0x00040000
1130 #define FILE_READ_ONLY_VOLUME 0x00080000
1132 /* ChangeNotify flags. */
1133 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1134 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1135 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1136 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1137 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1138 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1139 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1140 #define FILE_NOTIFY_CHANGE_EA 0x080
1141 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1142 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1143 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1144 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1146 #define FILE_NOTIFY_CHANGE_NAME \
1147 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1149 /* change notify action results */
1150 #define NOTIFY_ACTION_ADDED 1
1151 #define NOTIFY_ACTION_REMOVED 2
1152 #define NOTIFY_ACTION_MODIFIED 3
1153 #define NOTIFY_ACTION_OLD_NAME 4
1154 #define NOTIFY_ACTION_NEW_NAME 5
1155 #define NOTIFY_ACTION_ADDED_STREAM 6
1156 #define NOTIFY_ACTION_REMOVED_STREAM 7
1157 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1160 /* where to find the base of the SMB packet proper */
1161 #define smb_base(buf) (((const char *)(buf))+4)
1163 /* we don't allow server strings to be longer than 48 characters as
1164 otherwise NT will not honour the announce packets */
1165 #define MAX_SERVER_STRING_LENGTH 48
1168 #define SMB_SUCCESS 0 /* The request was successful. */
1171 void dfs_unlogin(void);
1172 extern int dcelogin_atmost_once
;
1176 char *strdup(char *s
);
1183 /* This was set by JHT in liaison with Jeremy Allison early 1997
1185 * Version 4.0 - never made public
1186 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1187 * - Reappeared in 1.9.16p11 with fixed smbd services
1188 * Version 4.20 - To indicate that nmbd and browsing now works better
1189 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1191 * Note: In the presence of NT4.X do not set above 4.9
1192 * Setting this above 4.9 can have undesired side-effects.
1193 * This may change again in Samba-3.0 after further testing. JHT
1196 #define SAMBA_MAJOR_NBT_ANNOUNCE_VERSION 0x04
1197 #define SAMBA_MINOR_NBT_ANNOUNCE_VERSION 0x09
1199 /* Browser Election Values */
1200 #define BROWSER_ELECTION_VERSION 0x010f
1201 #define BROWSER_CONSTANT 0xaa55
1203 /* Sercurity mode bits. */
1204 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1205 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1206 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1207 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1209 /* TCONX Flag (smb_vwv2). */
1210 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1212 /* File Status Flags. See:
1214 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1218 #define NO_SUBSTREAMS 0x2
1219 #define NO_REPARSETAG 0x4
1221 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1223 #define CAP_RAW_MODE 0x0001
1224 #define CAP_MPX_MODE 0x0002
1225 #define CAP_UNICODE 0x0004
1226 #define CAP_LARGE_FILES 0x0008
1227 #define CAP_NT_SMBS 0x0010
1228 #define CAP_RPC_REMOTE_APIS 0x0020
1229 #define CAP_STATUS32 0x0040
1230 #define CAP_LEVEL_II_OPLOCKS 0x0080
1231 #define CAP_LOCK_AND_READ 0x0100
1232 #define CAP_NT_FIND 0x0200
1233 #define CAP_DFS 0x1000
1234 #define CAP_W2K_SMBS 0x2000
1235 #define CAP_LARGE_READX 0x4000
1236 #define CAP_LARGE_WRITEX 0x8000
1237 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1238 #define CAP_EXTENDED_SECURITY 0x80000000
1240 /* printing types */
1241 enum printing_types
{PRINT_BSD
,PRINT_SYSV
,PRINT_AIX
,PRINT_HPUX
,
1242 PRINT_QNX
,PRINT_PLP
,PRINT_LPRNG
,PRINT_SOFTQ
,
1243 PRINT_CUPS
,PRINT_LPRNT
,PRINT_LPROS2
,PRINT_IPRINT
1244 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1245 ,PRINT_TEST
,PRINT_VLP
1246 #endif /* DEVELOPER */
1249 /* LDAP SSL options */
1250 enum ldap_ssl_types
{LDAP_SSL_OFF
, LDAP_SSL_START_TLS
};
1252 /* LDAP PASSWD SYNC methods */
1253 enum ldap_passwd_sync_types
{LDAP_PASSWD_SYNC_ON
, LDAP_PASSWD_SYNC_OFF
, LDAP_PASSWD_SYNC_ONLY
};
1256 * This should be under the HAVE_KRB5 flag but since they're used
1257 * in lp_kerberos_method(), they ned to be always available
1258 * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
1259 * so they remain accurate.
1262 #define KERBEROS_VERIFY_SECRETS 0
1263 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1264 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1265 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1267 /* Remote architectures we know about. */
1268 enum remote_arch_types
{RA_UNKNOWN
, RA_WFWG
, RA_OS2
, RA_WIN95
, RA_WINNT
,
1269 RA_WIN2K
, RA_WINXP
, RA_WIN2K3
, RA_VISTA
,
1270 RA_SAMBA
, RA_CIFSFS
, RA_WINXP64
, RA_OSX
};
1273 enum case_handling
{CASE_LOWER
,CASE_UPPER
};
1275 /* ACL compatibility */
1276 enum acl_compatibility
{ACL_COMPAT_AUTO
, ACL_COMPAT_WINNT
, ACL_COMPAT_WIN2K
};
1278 * Global value meaing that the smb_uid field should be
1279 * ingored (in share level security and protocol level == CORE)
1282 #define UID_FIELD_INVALID 0
1283 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1286 * Size of buffer to use when moving files across filesystems.
1288 #define COPYBUF_SIZE (8*1024)
1291 * Map the Core and Extended Oplock requesst bits down
1292 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1298 #define CORE_OPLOCK_REQUEST(inbuf) \
1299 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1302 * Extended protocol.
1304 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1307 #define LOCKING_ANDX_SHARED_LOCK 0x1
1308 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1309 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1310 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1311 #define LOCKING_ANDX_LARGE_FILES 0x10
1314 * Bits we test with.
1315 * Note these must fit into 16-bits.
1318 #define NO_OPLOCK 0x0
1319 #define EXCLUSIVE_OPLOCK 0x1
1320 #define BATCH_OPLOCK 0x2
1321 #define LEVEL_II_OPLOCK 0x4
1323 /* The following are Samba-private. */
1324 #define INTERNAL_OPEN_ONLY 0x8
1325 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1326 * inform potential level2 holders on
1328 #define DEFERRED_OPEN_ENTRY 0x20
1329 #define UNUSED_SHARE_MODE_ENTRY 0x40
1330 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1332 /* None of the following should ever appear in fsp->oplock_request. */
1333 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1335 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1336 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1337 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1339 /* kernel_oplock_message definition.
1341 struct kernel_oplock_message {
1345 unsigned long file_id;
1349 0 uint64_t dev 8 bytes
1350 8 uint64_t inode 8 bytes
1351 16 uint64_t extid 8 bytes
1352 24 unsigned long file_id 4 bytes
1356 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1358 /* file_renamed_message definition.
1360 struct file_renamed_message {
1363 char names[1]; A variable area containing sharepath and filename.
1367 0 uint64_t dev 8 bytes
1368 8 uint64_t inode 8 bytes
1369 16 unit64_t extid 8 bytes
1370 24 char [] name zero terminated namelen bytes
1371 minimum length == 24.
1375 #define MSG_FILE_RENAMED_MIN_SIZE 24
1378 * On the wire return values for oplock types.
1381 #define CORE_OPLOCK_GRANTED (1<<5)
1382 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1384 #define NO_OPLOCK_RETURN 0
1385 #define EXCLUSIVE_OPLOCK_RETURN 1
1386 #define BATCH_OPLOCK_RETURN 2
1387 #define LEVEL_II_OPLOCK_RETURN 3
1390 #define OPLOCKLEVEL_NONE 0
1391 #define OPLOCKLEVEL_II 1
1394 * Capabilities abstracted for different systems.
1397 enum smbd_capability
{
1398 KERNEL_OPLOCK_CAPABILITY
,
1399 DMAPI_ACCESS_CAPABILITY
,
1404 * Kernel oplocks capability flags.
1407 /* Level 2 oplocks are supported natively by kernel oplocks. */
1408 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1410 /* The kernel notifies deferred openers when they can retry the open. */
1411 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1413 /* The kernel notifies smbds when an oplock break times out. */
1414 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1416 /* The kernel notifies smbds when an oplock is broken. */
1417 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1419 struct kernel_oplocks_ops
;
1420 struct kernel_oplocks
{
1421 const struct kernel_oplocks_ops
*ops
;
1426 enum level2_contention_type
{
1427 LEVEL2_CONTEND_ALLOC_SHRINK
,
1428 LEVEL2_CONTEND_ALLOC_GROW
,
1429 LEVEL2_CONTEND_SET_FILE_LEN
,
1430 LEVEL2_CONTEND_FILL_SPARSE
,
1431 LEVEL2_CONTEND_WRITE
,
1432 LEVEL2_CONTEND_WINDOWS_BRL
,
1433 LEVEL2_CONTEND_POSIX_BRL
1436 /* if a kernel does support oplocks then a structure of the following
1437 typee is used to describe how to interact with the kernel */
1438 struct kernel_oplocks_ops
{
1439 bool (*set_oplock
)(struct kernel_oplocks
*ctx
,
1440 files_struct
*fsp
, int oplock_type
);
1441 void (*release_oplock
)(struct kernel_oplocks
*ctx
,
1442 files_struct
*fsp
, int oplock_type
);
1443 void (*contend_level2_oplocks_begin
)(files_struct
*fsp
,
1444 enum level2_contention_type type
);
1445 void (*contend_level2_oplocks_end
)(files_struct
*fsp
,
1446 enum level2_contention_type type
);
1449 #include "smb_macros.h"
1451 #define MAX_NETBIOSNAME_LEN 16
1452 /* DOS character, NetBIOS namestring. Type used on the wire. */
1453 typedef char nstring
[MAX_NETBIOSNAME_LEN
];
1454 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1455 typedef char unstring
[MAX_NETBIOSNAME_LEN
*4];
1457 /* A netbios name structure. */
1461 unsigned int name_type
;
1464 /* A netbios node status array element. */
1465 struct node_status
{
1468 unsigned char flags
;
1471 /* The extra info from a NetBIOS node status query */
1472 struct node_status_extra
{
1473 unsigned char mac_addr
[6];
1474 /* There really is more here ... */
1477 typedef struct user_struct
{
1478 struct user_struct
*next
, *prev
;
1479 uint16 vuid
; /* Tag for this entry. */
1481 char *session_keystr
; /* used by utmp and pam session code.
1485 struct auth_session_info
*session_info
;
1487 struct auth_ntlmssp_state
*auth_ntlmssp_state
;
1491 Do you want session setups at user level security with a invalid
1492 password to be rejected or allowed in as guest? WinNT rejects them
1493 but it can be a pain as it means "net view" needs to use a password
1495 You have 3 choices in the setting of map_to_guest:
1497 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1498 are rejected. This is the default.
1500 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1501 are rejected, unless the username does not exist, in which case it
1502 is treated as a guest login
1504 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1505 are treated as a guest login
1507 Note that map_to_guest only has an effect in user or server
1511 #define NEVER_MAP_TO_GUEST 0
1512 #define MAP_TO_GUEST_ON_BAD_USER 1
1513 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1514 #define MAP_TO_GUEST_ON_BAD_UID 3
1516 #define SAFE_NETBIOS_CHARS ". -_"
1518 /* The maximum length of a trust account password.
1519 Used when we randomly create it, 15 char passwords
1520 exceed NT4's max password length */
1522 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1526 #define LDAP_PORT 389
1528 #define LDAP_GC_PORT 3268
1530 /* used by the IP comparison function */
1532 struct sockaddr_storage ss
;
1543 struct ea_list
*next
, *prev
;
1544 struct ea_struct ea
;
1547 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1548 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1549 /* EA to use for DOS attributes */
1550 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1551 /* Prefix for DosStreams in the vfs_streams_xattr module */
1552 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1553 /* Prefix for xattrs storing streams. */
1554 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1556 /* map readonly options */
1557 enum mapreadonly_options
{MAP_READONLY_NO
, MAP_READONLY_YES
, MAP_READONLY_PERMISSIONS
};
1559 /* usershare error codes. */
1560 enum usershare_err
{
1562 USERSHARE_MALFORMED_FILE
,
1563 USERSHARE_BAD_VERSION
,
1564 USERSHARE_MALFORMED_PATH
,
1565 USERSHARE_MALFORMED_COMMENT_DEF
,
1566 USERSHARE_MALFORMED_ACL_DEF
,
1568 USERSHARE_PATH_NOT_ABSOLUTE
,
1569 USERSHARE_PATH_IS_DENIED
,
1570 USERSHARE_PATH_NOT_ALLOWED
,
1571 USERSHARE_PATH_NOT_DIRECTORY
,
1572 USERSHARE_POSIX_ERR
,
1573 USERSHARE_MALFORMED_SHARENAME_DEF
,
1574 USERSHARE_BAD_SHARENAME
1577 /* Different reasons for closing a file. */
1578 enum file_close_type
{NORMAL_CLOSE
=0,SHUTDOWN_CLOSE
,ERROR_CLOSE
};
1580 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1581 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1582 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1583 struct smb_extended_info
{
1584 uint32 samba_magic
; /* Always SAMBA_EXTRA_INFO_MAGIC */
1585 uint32 samba_version
; /* Major/Minor/Release/Revision */
1586 uint32 samba_subversion
; /* Prerelease/RC/Vendor patch */
1587 NTTIME samba_gitcommitdate
;
1588 char samba_version_string
[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH
];
1592 struct smb_file_time
{
1593 struct timespec mtime
;
1594 struct timespec atime
;
1595 struct timespec ctime
;
1596 struct timespec create_time
;
1600 * unix_convert_flags
1602 #define UCF_SAVE_LCOMP 0x00000001
1603 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1604 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1605 #define UCF_POSIX_PATHNAMES 0x00000008
1610 struct smb_filename
{
1613 char *original_lcomp
;
1617 /* struct for maintaining the child processes that get spawned from smbd */
1619 struct child_pid
*prev
, *next
;
1623 /* Used to keep track of deferred opens. */
1624 struct deferred_open_record
;
1626 /* Client-side offline caching policy types */
1627 #define CSC_POLICY_MANUAL 0
1628 #define CSC_POLICY_DOCUMENTS 1
1629 #define CSC_POLICY_PROGRAMS 2
1630 #define CSC_POLICY_DISABLE 3
1632 /* Used inside aio code. */
1636 * Reasons for cache flush.
1639 enum flush_reason_enum
{
1644 OPLOCK_RELEASE_FLUSH
,
1648 /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */