docs: Fix a bogus )
[Samba.git] / source3 / include / smb.h
blob8ebde2f4adc132c4c6452626ca942d7725902a09
1 /*
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/>.
26 #ifndef _SMB_H
27 #define _SMB_H
29 #include "libcli/smb/smb_common.h"
31 /* logged when starting the various Samba daemons */
32 #define COPYRIGHT_STARTUP_MESSAGE "Copyright Andrew Tridgell and the Samba Team 1992-2011"
35 #if defined(LARGE_SMB_OFF_T)
36 #define BUFFER_SIZE (128*1024)
37 #else /* no large readwrite possible */
38 #define BUFFER_SIZE (0xFFFF)
39 #endif
41 #define SAFETY_MARGIN 1024
42 #define LARGE_WRITEX_HDR_SIZE 65
44 #define NMB_PORT 137
45 #define DGRAM_PORT 138
46 #define SMB_PORT1 445
47 #define SMB_PORT2 139
48 #define SMB_PORTS "445 139"
50 #define Undefined (-1)
51 #define False false
52 #define True true
53 #define Auto (2)
54 #define Required (3)
56 #define SIZEOFWORD 2
58 #ifndef DEF_CREATE_MASK
59 #define DEF_CREATE_MASK (0755)
60 #endif
62 /* string manipulation flags - see clistr.c and srvstr.c */
63 #define STR_TERMINATE 1
64 #define STR_UPPER 2
65 #define STR_ASCII 4
66 #define STR_UNICODE 8
67 #define STR_NOALIGN 16
68 #define STR_TERMINATE_ASCII 128
70 /* how long to wait for secondary SMB packets (milli-seconds) */
71 #define SMB_SECONDARY_WAIT (60*1000)
73 /* this defines the error codes that receive_smb can put in smb_read_error */
74 enum smb_read_errors {
75 SMB_READ_OK = 0,
76 SMB_READ_TIMEOUT,
77 SMB_READ_EOF,
78 SMB_READ_ERROR,
79 SMB_WRITE_ERROR, /* This error code can go into the client smb_rw_error. */
80 SMB_READ_BAD_SIG,
81 SMB_NO_MEMORY,
82 SMB_DO_NOT_DO_TDIS, /* cli_close_connection() check for this when smbfs wants to keep tree connected */
83 SMB_READ_BAD_DECRYPT
86 #define DIR_STRUCT_SIZE 43
88 /* these define the attribute byte as seen by DOS */
89 #define aRONLY (1L<<0) /* 0x01 */
90 #define aHIDDEN (1L<<1) /* 0x02 */
91 #define aSYSTEM (1L<<2) /* 0x04 */
92 #define aVOLID (1L<<3) /* 0x08 */
93 #define aDIR (1L<<4) /* 0x10 */
94 #define aARCH (1L<<5) /* 0x20 */
96 /* deny modes */
97 #define DENY_DOS 0
98 #define DENY_ALL 1
99 #define DENY_WRITE 2
100 #define DENY_READ 3
101 #define DENY_NONE 4
102 #define DENY_FCB 7
104 /* open modes */
105 #define DOS_OPEN_RDONLY 0
106 #define DOS_OPEN_WRONLY 1
107 #define DOS_OPEN_RDWR 2
108 #define DOS_OPEN_EXEC 3
109 #define DOS_OPEN_FCB 0xF
111 /* define shifts and masks for share and open modes. */
112 #define OPENX_MODE_MASK 0xF
113 #define DENY_MODE_SHIFT 4
114 #define DENY_MODE_MASK 0x7
115 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
116 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
117 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
118 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
120 /* Sync on open file (not sure if used anymore... ?) */
121 #define FILE_SYNC_OPENMODE (1<<14)
122 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
124 /* open disposition values */
125 #define OPENX_FILE_EXISTS_FAIL 0
126 #define OPENX_FILE_EXISTS_OPEN 1
127 #define OPENX_FILE_EXISTS_TRUNCATE 2
129 /* mask for open disposition. */
130 #define OPENX_FILE_OPEN_MASK 0x3
132 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
133 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
135 /* The above can be OR'ed with... */
136 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
137 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
139 typedef union unid_t {
140 uid_t uid;
141 gid_t gid;
142 } unid_t;
144 /* pipe string names */
146 #ifndef MAXSUBAUTHS
147 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
148 #endif
150 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
152 #include "librpc/gen_ndr/security.h"
155 * The complete list of SIDS belonging to this user.
156 * Created when a vuid is registered.
157 * The definition of the user_sids array is as follows :
159 * token->user_sids[0] = primary user SID.
160 * token->user_sids[1] = primary group SID.
161 * token->user_sids[2..num_sids] = supplementary group SIDS.
164 #define PRIMARY_USER_SID_INDEX 0
165 #define PRIMARY_GROUP_SID_INDEX 1
167 typedef struct write_cache {
168 SMB_OFF_T file_size;
169 SMB_OFF_T offset;
170 size_t alloc_size;
171 size_t data_size;
172 char *data;
173 } write_cache;
175 struct fd_handle {
176 size_t ref_count;
177 int fd;
178 uint64_t position_information;
179 SMB_OFF_T pos;
180 uint32 private_options; /* NT Create options, but we only look at
181 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
182 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
183 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
184 * for print files *only*, where
185 * DELETE_ON_CLOSE is not stored in the share
186 * mode database.
188 unsigned long gen_id;
191 struct idle_event;
192 struct share_mode_entry;
193 struct uuid;
194 struct named_mutex;
195 struct wb_context;
196 struct rpc_cli_smbd_conn;
197 struct fncall_context;
199 struct vfs_fsp_data {
200 struct vfs_fsp_data *next;
201 struct vfs_handle_struct *owner;
202 void (*destroy)(void *p_data);
203 void *_dummy_;
204 /* NOTE: This structure contains four pointers so that we can guarantee
205 * that the end of the structure is always both 4-byte and 8-byte aligned.
209 /* the basic packet size, assuming no words or bytes */
210 #define smb_size 39
212 struct notify_change {
213 uint32_t action;
214 const char *name;
217 struct notify_mid_map;
218 struct notify_entry;
219 struct notify_event;
220 struct notify_change_request;
221 struct sys_notify_backend;
222 struct sys_notify_context {
223 struct event_context *ev;
224 struct connection_struct *conn;
225 void *private_data; /* For use by the system backend */
228 struct notify_change_buf {
230 * If no requests are pending, changes are queued here. Simple array,
231 * we only append.
235 * num_changes == -1 means that we have got a catch-all change, when
236 * asked we just return NT_STATUS_OK without specific changes.
238 int num_changes;
239 struct notify_change *changes;
242 * If no changes are around requests are queued here. Using a linked
243 * list, because we have to append at the end and delete from the top.
245 struct notify_change_request *requests;
248 struct print_file_data {
249 char *svcname;
250 char *docname;
251 char *filename;
252 struct policy_handle handle;
253 uint32_t jobid;
254 uint16 rap_jobid;
257 typedef struct files_struct {
258 struct files_struct *next, *prev;
259 int fnum;
260 struct connection_struct *conn;
261 struct fd_handle *fh;
262 unsigned int num_smb_operations;
263 struct file_id file_id;
264 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
265 mode_t mode;
266 uint16 file_pid;
267 uint16 vuid;
268 write_cache *wcp;
269 struct timeval open_time;
270 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
271 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
273 bool update_write_time_triggered;
274 struct timed_event *update_write_time_event;
275 bool update_write_time_on_close;
276 struct timespec close_write_time;
277 bool write_time_forced;
279 int oplock_type;
280 int sent_oplock_break;
281 struct timed_event *oplock_timeout;
282 struct lock_struct last_lock_failure;
283 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
285 struct share_mode_entry *pending_break_messages;
286 int num_pending_break_messages;
288 bool can_lock;
289 bool can_read;
290 bool can_write;
291 bool modified;
292 bool is_directory;
293 bool aio_write_behind;
294 bool lockdb_clean;
295 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
296 bool delete_on_close;
297 bool posix_open;
298 bool is_sparse;
299 struct smb_filename *fsp_name;
300 uint32_t name_hash; /* Jenkins hash of full pathname. */
302 struct vfs_fsp_data *vfs_extension;
303 struct fake_file_handle *fake_file_handle;
305 struct notify_change_buf *notify;
307 struct files_struct *base_fsp; /* placeholder for delete on close */
310 * Read-only cached brlock record, thrown away when the
311 * brlock.tdb seqnum changes. This avoids fetching data from
312 * the brlock.tdb on every read/write call.
314 int brlock_seqnum;
315 struct byte_range_lock *brlock_rec;
317 struct dptr_struct *dptr;
319 /* if not NULL, means this is a print file */
320 struct print_file_data *print_file;
322 } files_struct;
324 #include "ntquotas.h"
325 #include "sysquotas.h"
327 struct client_address {
328 char addr[INET6_ADDRSTRLEN];
329 const char *name;
332 struct vuid_cache_entry {
333 struct auth_serversupplied_info *session_info;
334 uint16_t vuid;
335 bool read_only;
338 struct vuid_cache {
339 unsigned int next_entry;
340 struct vuid_cache_entry array[VUID_CACHE_SIZE];
343 typedef struct {
344 char *name;
345 bool is_wild;
346 } name_compare_entry;
348 struct trans_state {
349 struct trans_state *next, *prev;
350 uint16 vuid;
351 uint64_t mid;
353 uint32 max_param_return;
354 uint32 max_data_return;
355 uint32 max_setup_return;
357 uint8 cmd; /* SMBtrans or SMBtrans2 */
359 char *name; /* for trans requests */
360 uint16 call; /* for trans2 and nttrans requests */
362 bool close_on_completion;
363 bool one_way;
365 unsigned int setup_count;
366 uint16 *setup;
368 size_t received_data;
369 size_t received_param;
371 size_t total_param;
372 char *param;
374 size_t total_data;
375 char *data;
379 * Info about an alternate data stream
382 struct stream_struct {
383 SMB_OFF_T size;
384 SMB_OFF_T alloc_size;
385 char *name;
388 /* Include VFS stuff */
390 #include "smb_acls.h"
391 #include "vfs.h"
393 struct dfree_cached_info {
394 time_t last_dfree_time;
395 uint64_t dfree_ret;
396 uint64_t bsize;
397 uint64_t dfree;
398 uint64_t dsize;
401 struct dptr_struct;
403 struct share_params {
404 int service;
407 struct share_iterator {
408 int next_id;
411 typedef struct connection_struct {
412 struct connection_struct *next, *prev;
413 struct smbd_server_connection *sconn; /* can be NULL */
414 unsigned cnum; /* an index passed over the wire */
415 struct share_params *params;
416 bool force_user;
417 struct vuid_cache vuid_cache;
418 bool printer;
419 bool ipc;
420 bool read_only; /* Attributes for the current user of the share. */
421 /* Does this filesystem honor
422 sub second timestamps on files
423 and directories when setting time ? */
424 enum timestamp_set_resolution ts_res;
425 char *connectpath;
426 char *origpath;
428 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
431 * This represents the user information on this connection. Depending
432 * on the vuid using this tid, this might change per SMB request.
434 struct auth_serversupplied_info *session_info;
437 * If the "force group" parameter is set, this is the primary gid that
438 * may be used in the users token, depending on the vuid using this tid.
440 gid_t force_group_gid;
442 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
444 time_t lastused;
445 time_t lastused_count;
446 bool used;
447 int num_files_open;
448 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
449 int encrypt_level;
450 bool encrypted_tid;
452 /* Semantics requested by the client or forced by the server config. */
453 bool case_sensitive;
454 bool case_preserve;
455 bool short_case_preserve;
457 /* Semantics provided by the underlying filesystem. */
458 int fs_capabilities;
459 /* Device number of the directory of the share mount.
460 Used to ensure unique FileIndex returns. */
461 SMB_DEV_T base_share_dev;
463 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
464 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
465 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
466 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
467 struct dfree_cached_info *dfree_info;
468 struct trans_state *pending_trans;
469 struct notify_context *notify_ctx;
471 struct rpc_pipe_client *spoolss_pipe;
473 } connection_struct;
475 struct current_user {
476 connection_struct *conn;
477 uint16 vuid;
478 struct security_unix_token ut;
479 struct security_token *nt_user_token;
482 struct smbd_smb2_request;
484 struct smb_request {
485 uint8_t cmd;
486 uint16 flags2;
487 uint16 smbpid;
488 uint64_t mid; /* For compatibility with SMB2. */
489 uint32_t seqnum;
490 uint16 vuid;
491 uint16 tid;
492 uint8 wct;
493 uint16_t *vwv;
494 uint16_t buflen;
495 const uint8_t *buf;
496 const uint8 *inbuf;
499 * Async handling in the main smb processing loop is directed by
500 * outbuf: reply_xxx routines indicate sync behaviour by putting their
501 * reply into "outbuf". If they leave it as NULL, they take of it
502 * themselves, possibly later.
504 * If async handling is wanted, the reply_xxx routine must make sure
505 * that it talloc_move()s the smb_req somewhere else.
507 uint8 *outbuf;
509 size_t unread_bytes;
510 bool encrypted;
511 connection_struct *conn;
512 struct smbd_server_connection *sconn;
513 struct smb_perfcount_data pcd;
516 * Chained request handling
518 struct files_struct *chain_fsp;
521 * Here we collect the outbufs from the chain handlers
523 uint8_t *chain_outbuf;
526 * state information for async smb handling
528 void *async_priv;
530 bool done;
533 * Back pointer to smb2 request.
535 struct smbd_smb2_request *smb2req;
538 /* Defines for the sent_oplock_break field above. */
539 #define NO_BREAK_SENT 0
540 #define BREAK_TO_NONE_SENT 1
541 #define LEVEL_II_BREAK_SENT 2
543 typedef struct {
544 fstring smb_name; /* user name from the client */
545 fstring unix_name; /* unix user name of a validated user */
546 fstring domain; /* domain that the client specified */
547 } userdom_struct;
549 /* used for server information: client, nameserv and ipc */
550 struct server_info_struct {
551 fstring name;
552 uint32 type;
553 fstring comment;
554 fstring domain; /* used ONLY in ipc.c NOT namework.c */
555 bool server_added; /* used ONLY in ipc.c NOT namework.c */
558 /* used for network interfaces */
559 struct interface {
560 struct interface *next, *prev;
561 char *name;
562 int flags;
563 struct sockaddr_storage ip;
564 struct sockaddr_storage netmask;
565 struct sockaddr_storage bcast;
568 /* Internal message queue for deferred opens. */
569 struct pending_message_list {
570 struct pending_message_list *next, *prev;
571 struct timeval request_time; /* When was this first issued? */
572 struct timed_event *te;
573 struct smb_perfcount_data pcd;
574 uint32_t seqnum;
575 bool encrypted;
576 bool processed;
577 DATA_BLOB buf;
578 DATA_BLOB private_data;
581 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
583 #include "librpc/gen_ndr/server_id.h"
585 /* struct returned by get_share_modes */
586 struct share_mode_entry {
587 struct server_id pid;
588 uint64_t op_mid; /* For compatibility with SMB2 opens. */
589 uint16 op_type;
590 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
591 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
592 uint32 private_options; /* NT Create options, but we only look at
593 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
594 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
595 * smbstatus and swat */
596 struct timeval time;
597 struct file_id id;
598 unsigned long share_file_id;
599 uint32 uid; /* uid of file opener. */
600 uint16 flags; /* See SHARE_MODE_XX above. */
601 uint32_t name_hash; /* Jenkins hash of full pathname. */
604 /* oplock break message definition - linearization of share_mode_entry.
606 Offset Data length.
607 0 struct server_id pid 4
608 4 uint16 op_mid 8
609 12 uint16 op_type 2
610 14 uint32 access_mask 4
611 18 uint32 share_access 4
612 22 uint32 private_options 4
613 26 uint32 time sec 4
614 30 uint32 time usec 4
615 34 uint64 dev 8 bytes
616 42 uint64 inode 8 bytes
617 50 uint64 extid 8 bytes
618 58 unsigned long file_id 4 bytes
619 62 uint32 uid 4 bytes
620 66 uint16 flags 2 bytes
621 68 uint32 name_hash 4 bytes
626 #define OP_BREAK_MSG_PID_OFFSET 0
627 #define OP_BREAK_MSG_MID_OFFSET 4
628 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
629 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
630 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
631 #define OP_BREAK_MSG_PRIV_OFFSET 22
632 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
633 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
634 #define OP_BREAK_MSG_DEV_OFFSET 34
635 #define OP_BREAK_MSG_INO_OFFSET 42
636 #define OP_BREAK_MSG_EXTID_OFFSET 50
637 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
638 #define OP_BREAK_MSG_UID_OFFSET 62
639 #define OP_BREAK_MSG_FLAGS_OFFSET 66
640 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
642 #define OP_BREAK_MSG_VNN_OFFSET 72
643 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
645 struct delete_token_list {
646 struct delete_token_list *next, *prev;
647 uint32_t name_hash;
648 struct security_unix_token *delete_token;
651 struct share_mode_lock {
652 const char *servicepath; /* canonicalized. */
653 const char *base_name;
654 const char *stream_name;
655 struct file_id id;
656 int num_share_modes;
657 struct share_mode_entry *share_modes;
658 struct delete_token_list *delete_tokens;
659 struct timespec old_write_time;
660 struct timespec changed_write_time;
661 bool fresh;
662 bool modified;
663 struct db_record *record;
667 * Internal structure of locking.tdb share mode db.
668 * Used by locking.c and libsmbsharemodes.c
671 struct locking_data {
672 union {
673 struct {
674 int num_share_mode_entries;
675 struct timespec old_write_time;
676 struct timespec changed_write_time;
677 uint32 num_delete_token_entries;
678 } s;
679 struct share_mode_entry dummy; /* Needed for alignment. */
680 } u;
681 /* The following four entries are implicit
683 (1) struct share_mode_entry modes[num_share_mode_entries];
685 (2) A num_delete_token_entries of structs {
686 uint32_t len_delete_token;
687 char unix_token[len_delete_token] (divisible by 4).
690 (3) char share_name[];
691 (4) char file_name[];
695 #define NT_HASH_LEN 16
696 #define LM_HASH_LEN 16
698 /* key and data in the connections database - used in smbstatus and smbd */
699 struct connections_key {
700 struct server_id pid;
701 int cnum;
702 fstring name;
705 struct connections_data {
706 int magic;
707 struct server_id pid;
708 int cnum;
709 uid_t uid;
710 gid_t gid;
711 char servicename[FSTRING_LEN];
712 char addr[24];
713 char machine[FSTRING_LEN];
714 time_t start;
717 * This field used to hold the msg_flags. For compatibility reasons,
718 * keep the data structure in the tdb file the same.
720 uint32 unused_compatitibility_field;
724 /* the following are used by loadparm for option lists */
725 typedef enum {
726 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
727 P_STRING,P_USTRING,P_ENUM,P_SEP
728 } parm_type;
730 typedef enum {
731 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
732 } parm_class;
734 struct enum_list {
735 int value;
736 const char *name;
739 struct parm_struct {
740 const char *label;
741 parm_type type;
742 parm_class p_class;
743 void *ptr;
744 bool (*special)(int snum, const char *, char **);
745 const struct enum_list *enum_list;
746 unsigned flags;
747 union {
748 bool bvalue;
749 int ivalue;
750 char *svalue;
751 char cvalue;
752 char **lvalue;
753 } def;
756 /* The following flags are used in SWAT */
757 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
758 #define FLAG_SHARE 0x0002 /* file sharing options */
759 #define FLAG_PRINT 0x0004 /* printing options */
760 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
761 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
762 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
763 #define FLAG_DEVELOPER 0x0040 /* No longer used */
764 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
765 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
766 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
767 #define FLAG_META 0x8000 /* A meta directive - not a real parameter */
768 #define FLAG_CMDLINE 0x10000 /* option has been overridden */
770 struct bitmap {
771 uint32 *b;
772 unsigned int n;
775 /* offsets into message for common items */
776 #define smb_com 8
777 #define smb_rcls 9
778 #define smb_reh 10
779 #define smb_err 11
780 #define smb_flg 13
781 #define smb_flg2 14
782 #define smb_pidhigh 16
783 #define smb_ss_field 18
784 #define smb_tid 28
785 #define smb_pid 30
786 #define smb_uid 32
787 #define smb_mid 34
788 #define smb_wct 36
789 #define smb_vwv 37
790 #define smb_vwv0 37
791 #define smb_vwv1 39
792 #define smb_vwv2 41
793 #define smb_vwv3 43
794 #define smb_vwv4 45
795 #define smb_vwv5 47
796 #define smb_vwv6 49
797 #define smb_vwv7 51
798 #define smb_vwv8 53
799 #define smb_vwv9 55
800 #define smb_vwv10 57
801 #define smb_vwv11 59
802 #define smb_vwv12 61
803 #define smb_vwv13 63
804 #define smb_vwv14 65
805 #define smb_vwv15 67
806 #define smb_vwv16 69
807 #define smb_vwv17 71
809 /* flag defines. CIFS spec 3.1.1 */
810 #define FLAG_SUPPORT_LOCKREAD 0x01
811 #define FLAG_CLIENT_BUF_AVAIL 0x02
812 #define FLAG_RESERVED 0x04
813 #define FLAG_CASELESS_PATHNAMES 0x08
814 #define FLAG_CANONICAL_PATHNAMES 0x10
815 #define FLAG_REQUEST_OPLOCK 0x20
816 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
817 #define FLAG_REPLY 0x80
819 /* the complete */
820 #define SMBmkdir 0x00 /* create directory */
821 #define SMBrmdir 0x01 /* delete directory */
822 #define SMBopen 0x02 /* open file */
823 #define SMBcreate 0x03 /* create file */
824 #define SMBclose 0x04 /* close file */
825 #define SMBflush 0x05 /* flush file */
826 #define SMBunlink 0x06 /* delete file */
827 #define SMBmv 0x07 /* rename file */
828 #define SMBgetatr 0x08 /* get file attributes */
829 #define SMBsetatr 0x09 /* set file attributes */
830 #define SMBread 0x0A /* read from file */
831 #define SMBwrite 0x0B /* write to file */
832 #define SMBlock 0x0C /* lock byte range */
833 #define SMBunlock 0x0D /* unlock byte range */
834 #define SMBctemp 0x0E /* create temporary file */
835 #define SMBmknew 0x0F /* make new file */
836 #define SMBcheckpath 0x10 /* check directory path */
837 #define SMBexit 0x11 /* process exit */
838 #define SMBlseek 0x12 /* seek */
839 #define SMBtcon 0x70 /* tree connect */
840 #define SMBtconX 0x75 /* tree connect and X*/
841 #define SMBtdis 0x71 /* tree disconnect */
842 #define SMBnegprot 0x72 /* negotiate protocol */
843 #define SMBdskattr 0x80 /* get disk attributes */
844 #define SMBsearch 0x81 /* search directory */
845 #define SMBsplopen 0xC0 /* open print spool file */
846 #define SMBsplwr 0xC1 /* write to print spool file */
847 #define SMBsplclose 0xC2 /* close print spool file */
848 #define SMBsplretq 0xC3 /* return print queue */
849 #define SMBsends 0xD0 /* send single block message */
850 #define SMBsendb 0xD1 /* send broadcast message */
851 #define SMBfwdname 0xD2 /* forward user name */
852 #define SMBcancelf 0xD3 /* cancel forward */
853 #define SMBgetmac 0xD4 /* get machine name */
854 #define SMBsendstrt 0xD5 /* send start of multi-block message */
855 #define SMBsendend 0xD6 /* send end of multi-block message */
856 #define SMBsendtxt 0xD7 /* send text of multi-block message */
858 /* Core+ protocol */
859 #define SMBlockread 0x13 /* Lock a range and read */
860 #define SMBwriteunlock 0x14 /* Unlock a range then write */
861 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
862 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
863 #define SMBwritec 0x20 /* secondary write request */
864 #define SMBwriteclose 0x2c /* write a file then close it */
866 /* dos extended protocol */
867 #define SMBreadBraw 0x1A /* read block raw */
868 #define SMBreadBmpx 0x1B /* read block multiplexed */
869 #define SMBreadBs 0x1C /* read block (secondary response) */
870 #define SMBwriteBraw 0x1D /* write block raw */
871 #define SMBwriteBmpx 0x1E /* write block multiplexed */
872 #define SMBwriteBs 0x1F /* write block (secondary request) */
873 #define SMBwriteC 0x20 /* write complete response */
874 #define SMBsetattrE 0x22 /* set file attributes expanded */
875 #define SMBgetattrE 0x23 /* get file attributes expanded */
876 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
877 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
878 #define SMBtranss 0x26 /* transaction (secondary request/response) */
879 #define SMBioctl 0x27 /* IOCTL */
880 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
881 #define SMBcopy 0x29 /* copy */
882 #define SMBmove 0x2A /* move */
883 #define SMBecho 0x2B /* echo */
884 #define SMBopenX 0x2D /* open and X */
885 #define SMBreadX 0x2E /* read and X */
886 #define SMBwriteX 0x2F /* write and X */
887 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
888 #define SMBffirst 0x82 /* find first */
889 #define SMBfunique 0x83 /* find unique */
890 #define SMBfclose 0x84 /* find close */
891 #define SMBkeepalive 0x85 /* keepalive */
892 #define SMBinvalid 0xFE /* invalid command */
894 /* Extended 2.0 protocol */
895 #define SMBtrans2 0x32 /* TRANS2 protocol set */
896 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
897 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
898 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
899 #define SMBulogoffX 0x74 /* user logoff */
901 /* NT SMB extensions. */
902 #define SMBnttrans 0xA0 /* NT transact */
903 #define SMBnttranss 0xA1 /* NT transact secondary */
904 #define SMBntcreateX 0xA2 /* NT create and X */
905 #define SMBntcancel 0xA4 /* NT cancel */
906 #define SMBntrename 0xA5 /* NT rename */
908 /* These are the trans subcommands */
909 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
910 #define TRANSACT_DCERPCCMD 0x26
911 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
913 /* These are the TRANS2 sub commands */
914 #define TRANSACT2_OPEN 0x00
915 #define TRANSACT2_FINDFIRST 0x01
916 #define TRANSACT2_FINDNEXT 0x02
917 #define TRANSACT2_QFSINFO 0x03
918 #define TRANSACT2_SETFSINFO 0x04
919 #define TRANSACT2_QPATHINFO 0x05
920 #define TRANSACT2_SETPATHINFO 0x06
921 #define TRANSACT2_QFILEINFO 0x07
922 #define TRANSACT2_SETFILEINFO 0x08
923 #define TRANSACT2_FSCTL 0x09
924 #define TRANSACT2_IOCTL 0x0A
925 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
926 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
927 #define TRANSACT2_MKDIR 0x0D
928 #define TRANSACT2_SESSION_SETUP 0x0E
929 #define TRANSACT2_GET_DFS_REFERRAL 0x10
930 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
932 /* These are the NT transact sub commands. */
933 #define NT_TRANSACT_CREATE 1
934 #define NT_TRANSACT_IOCTL 2
935 #define NT_TRANSACT_SET_SECURITY_DESC 3
936 #define NT_TRANSACT_NOTIFY_CHANGE 4
937 #define NT_TRANSACT_RENAME 5
938 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
939 #define NT_TRANSACT_GET_USER_QUOTA 7
940 #define NT_TRANSACT_SET_USER_QUOTA 8
942 /* These are the NT transact_get_user_quota sub commands */
943 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
944 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
945 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
947 /* Relevant IOCTL codes */
948 #define IOCTL_QUERY_JOB_INFO 0x530060
950 /* these are the trans2 sub fields for primary requests */
951 #define smb_tpscnt smb_vwv0
952 #define smb_tdscnt smb_vwv1
953 #define smb_mprcnt smb_vwv2
954 #define smb_mdrcnt smb_vwv3
955 #define smb_msrcnt smb_vwv4
956 #define smb_flags smb_vwv5
957 #define smb_timeout smb_vwv6
958 #define smb_pscnt smb_vwv9
959 #define smb_psoff smb_vwv10
960 #define smb_dscnt smb_vwv11
961 #define smb_dsoff smb_vwv12
962 #define smb_suwcnt smb_vwv13
963 #define smb_setup smb_vwv14
964 #define smb_setup0 smb_setup
965 #define smb_setup1 (smb_setup+2)
966 #define smb_setup2 (smb_setup+4)
968 /* these are for the secondary requests */
969 #define smb_spscnt smb_vwv2
970 #define smb_spsoff smb_vwv3
971 #define smb_spsdisp smb_vwv4
972 #define smb_sdscnt smb_vwv5
973 #define smb_sdsoff smb_vwv6
974 #define smb_sdsdisp smb_vwv7
975 #define smb_sfid smb_vwv8
977 /* and these for responses */
978 #define smb_tprcnt smb_vwv0
979 #define smb_tdrcnt smb_vwv1
980 #define smb_prcnt smb_vwv3
981 #define smb_proff smb_vwv4
982 #define smb_prdisp smb_vwv5
983 #define smb_drcnt smb_vwv6
984 #define smb_droff smb_vwv7
985 #define smb_drdisp smb_vwv8
987 /* these are for the NT trans primary request. */
988 #define smb_nt_MaxSetupCount smb_vwv0
989 #define smb_nt_Flags (smb_vwv0 + 1)
990 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
991 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
992 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
993 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
994 #define smb_nt_ParameterCount (smb_vwv0 + 19)
995 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
996 #define smb_nt_DataCount (smb_vwv0 + 27)
997 #define smb_nt_DataOffset (smb_vwv0 + 31)
998 #define smb_nt_SetupCount (smb_vwv0 + 35)
999 #define smb_nt_Function (smb_vwv0 + 36)
1000 #define smb_nt_SetupStart (smb_vwv0 + 38)
1002 /* these are for the NT trans secondary request. */
1003 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1004 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1005 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1006 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1007 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1008 #define smb_nts_DataCount (smb_vwv0 + 23)
1009 #define smb_nts_DataOffset (smb_vwv0 + 27)
1010 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1012 /* these are for the NT trans reply. */
1013 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1014 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1015 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1016 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1017 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1018 #define smb_ntr_DataCount (smb_vwv0 + 23)
1019 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1020 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1022 /* these are for the NT create_and_X */
1023 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1024 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1025 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1026 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1027 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1028 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1029 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1030 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1031 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1032 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1033 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1035 /* this is used on a TConX. I'm not sure the name is very helpful though */
1036 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1037 #define SMB_SHARE_IN_DFS 0x0002
1039 /* Named pipe write mode flags. Used in writeX calls. */
1040 #define PIPE_RAW_MODE 0x4
1041 #define PIPE_START_MESSAGE 0x8
1043 /* the desired access to use when opening a pipe */
1044 #define DESIRED_ACCESS_PIPE 0x2019f
1046 /* Mapping of access rights to UNIX perms. */
1047 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1048 #define UNIX_ACCESS_R FILE_GENERIC_READ
1049 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1050 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1052 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1053 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1054 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1055 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1056 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1058 #if 0
1060 * This is the old mapping we used to use. To get W2KSP2 profiles
1061 * working we need to map to the canonical file perms.
1063 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1064 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1065 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1066 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1067 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1068 FILE_APPEND_DATA|FILE_WRITE_DATA)
1069 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1070 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1071 #endif
1073 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1075 /* Flags field. */
1076 #define REQUEST_OPLOCK 2
1077 #define REQUEST_BATCH_OPLOCK 4
1078 #define OPEN_DIRECTORY 8
1079 #define EXTENDED_RESPONSE_REQUIRED 0x10
1081 /* ShareAccess field. */
1082 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1083 #define FILE_SHARE_READ 1
1084 #define FILE_SHARE_WRITE 2
1085 #define FILE_SHARE_DELETE 4
1087 /* FileAttributesField */
1088 #define FILE_ATTRIBUTE_READONLY 0x001L
1089 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1090 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1091 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1092 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1093 #define FILE_ATTRIBUTE_NORMAL 0x080L
1094 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1095 #define FILE_ATTRIBUTE_SPARSE 0x200L
1096 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1097 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1098 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1099 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1100 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1101 #define SAMBA_ATTRIBUTES_MASK (FILE_ATTRIBUTE_READONLY|\
1102 FILE_ATTRIBUTE_HIDDEN|\
1103 FILE_ATTRIBUTE_SYSTEM|\
1104 FILE_ATTRIBUTE_DIRECTORY|\
1105 FILE_ATTRIBUTE_ARCHIVE)
1107 /* Flags - combined with attributes. */
1108 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1109 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1110 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1111 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1112 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1113 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1114 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1116 /* CreateDisposition field. */
1117 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1118 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1119 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1120 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1121 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1122 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1124 /* CreateOptions field. */
1125 #define FILE_DIRECTORY_FILE 0x0001
1126 #define FILE_WRITE_THROUGH 0x0002
1127 #define FILE_SEQUENTIAL_ONLY 0x0004
1128 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1129 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
1130 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
1131 #define FILE_NON_DIRECTORY_FILE 0x0040
1132 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
1133 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
1134 #define FILE_NO_EA_KNOWLEDGE 0x0200
1135 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1136 #define FILE_RANDOM_ACCESS 0x0800
1137 #define FILE_DELETE_ON_CLOSE 0x1000
1138 #define FILE_OPEN_BY_FILE_ID 0x2000
1139 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
1140 #define FILE_NO_COMPRESSION 0x8000
1141 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
1142 #define FILE_OPEN_REPARSE_POINT 0x00200000
1143 #define FILE_OPEN_NO_RECALL 0x00400000
1144 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1146 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1148 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1151 * Private create options used by the ntcreatex processing code. From Samba4.
1152 * We reuse some ignored flags for private use. Passed in the private_flags
1153 * argument.
1155 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
1156 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
1158 /* Private options for streams support */
1159 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1161 /* Private options for printer support */
1162 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1164 /* Responses when opening a file. */
1165 #define FILE_WAS_SUPERSEDED 0
1166 #define FILE_WAS_OPENED 1
1167 #define FILE_WAS_CREATED 2
1168 #define FILE_WAS_OVERWRITTEN 3
1170 /* File type flags */
1171 #define FILE_TYPE_DISK 0
1172 #define FILE_TYPE_BYTE_MODE_PIPE 1
1173 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1174 #define FILE_TYPE_PRINTER 3
1175 #define FILE_TYPE_COMM_DEVICE 4
1176 #define FILE_TYPE_UNKNOWN 0xFFFF
1178 /* Flag for NT transact rename call. */
1179 #define RENAME_REPLACE_IF_EXISTS 1
1181 /* flags for SMBntrename call (from Samba4) */
1182 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1183 #define RENAME_FLAG_HARD_LINK 0x103
1184 #define RENAME_FLAG_RENAME 0x104
1185 #define RENAME_FLAG_COPY 0x105
1187 /* Filesystem Attributes. */
1188 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1189 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1190 #define FILE_UNICODE_ON_DISK 0x00000004
1191 /* According to cifs9f, this is 4, not 8 */
1192 /* Acconding to testing, this actually sets the security attribute! */
1193 #define FILE_PERSISTENT_ACLS 0x00000008
1194 #define FILE_FILE_COMPRESSION 0x00000010
1195 #define FILE_VOLUME_QUOTAS 0x00000020
1196 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1197 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1198 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1199 #define FS_LFN_APIS 0x00004000
1200 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1201 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1202 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1203 #define FILE_NAMED_STREAMS 0x00040000
1204 #define FILE_READ_ONLY_VOLUME 0x00080000
1206 /* ChangeNotify flags. */
1207 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1208 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1209 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1210 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1211 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1212 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1213 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1214 #define FILE_NOTIFY_CHANGE_EA 0x080
1215 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1216 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1217 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1218 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1220 #define FILE_NOTIFY_CHANGE_NAME \
1221 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1223 /* change notify action results */
1224 #define NOTIFY_ACTION_ADDED 1
1225 #define NOTIFY_ACTION_REMOVED 2
1226 #define NOTIFY_ACTION_MODIFIED 3
1227 #define NOTIFY_ACTION_OLD_NAME 4
1228 #define NOTIFY_ACTION_NEW_NAME 5
1229 #define NOTIFY_ACTION_ADDED_STREAM 6
1230 #define NOTIFY_ACTION_REMOVED_STREAM 7
1231 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1234 /* where to find the base of the SMB packet proper */
1235 #define smb_base(buf) (((char *)(buf))+4)
1237 /* we don't allow server strings to be longer than 48 characters as
1238 otherwise NT will not honour the announce packets */
1239 #define MAX_SERVER_STRING_LENGTH 48
1242 #define SMB_SUCCESS 0 /* The request was successful. */
1244 #ifdef WITH_DFS
1245 void dfs_unlogin(void);
1246 extern int dcelogin_atmost_once;
1247 #endif
1249 #ifdef NOSTRDUP
1250 char *strdup(char *s);
1251 #endif
1253 #ifndef SELECT_CAST
1254 #define SELECT_CAST
1255 #endif
1257 /* This was set by JHT in liaison with Jeremy Allison early 1997
1258 * History:
1259 * Version 4.0 - never made public
1260 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1261 * - Reappeared in 1.9.16p11 with fixed smbd services
1262 * Version 4.20 - To indicate that nmbd and browsing now works better
1263 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1265 * Note: In the presence of NT4.X do not set above 4.9
1266 * Setting this above 4.9 can have undesired side-effects.
1267 * This may change again in Samba-3.0 after further testing. JHT
1270 #define DEFAULT_MAJOR_VERSION 0x04
1271 #define DEFAULT_MINOR_VERSION 0x09
1273 /* Browser Election Values */
1274 #define BROWSER_ELECTION_VERSION 0x010f
1275 #define BROWSER_CONSTANT 0xaa55
1277 /* Sercurity mode bits. */
1278 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1279 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1280 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1281 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1283 /* TCONX Flag (smb_vwv2). */
1284 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1286 /* File Status Flags. See:
1288 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1291 #define NO_EAS 0x1
1292 #define NO_SUBSTREAMS 0x2
1293 #define NO_REPARSETAG 0x4
1295 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1297 #define CAP_RAW_MODE 0x0001
1298 #define CAP_MPX_MODE 0x0002
1299 #define CAP_UNICODE 0x0004
1300 #define CAP_LARGE_FILES 0x0008
1301 #define CAP_NT_SMBS 0x0010
1302 #define CAP_RPC_REMOTE_APIS 0x0020
1303 #define CAP_STATUS32 0x0040
1304 #define CAP_LEVEL_II_OPLOCKS 0x0080
1305 #define CAP_LOCK_AND_READ 0x0100
1306 #define CAP_NT_FIND 0x0200
1307 #define CAP_DFS 0x1000
1308 #define CAP_W2K_SMBS 0x2000
1309 #define CAP_LARGE_READX 0x4000
1310 #define CAP_LARGE_WRITEX 0x8000
1311 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1312 #define CAP_EXTENDED_SECURITY 0x80000000
1314 /* protocol types. It assumes that higher protocols include lower protocols
1315 as subsets */
1316 enum protocol_types {
1317 PROTOCOL_NONE,
1318 PROTOCOL_CORE,
1319 PROTOCOL_COREPLUS,
1320 PROTOCOL_LANMAN1,
1321 PROTOCOL_LANMAN2,
1322 PROTOCOL_NT1,
1323 PROTOCOL_SMB2
1326 /* security levels */
1327 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1329 /* server roles */
1330 enum server_types {
1331 ROLE_STANDALONE,
1332 ROLE_DOMAIN_MEMBER,
1333 ROLE_DOMAIN_BDC,
1334 ROLE_DOMAIN_PDC
1337 /* printing types */
1338 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1339 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1340 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1341 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1342 ,PRINT_TEST,PRINT_VLP
1343 #endif /* DEVELOPER */
1346 /* LDAP SSL options */
1347 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1349 /* LDAP PASSWD SYNC methods */
1350 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1353 * This should be under the HAVE_KRB5 flag but since they're used
1354 * in lp_kerberos_method(), they ned to be always available
1355 * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
1356 * so they remain accurate.
1359 #define KERBEROS_VERIFY_SECRETS 0
1360 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1361 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1362 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1364 /* Remote architectures we know about. */
1365 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1366 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1367 RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
1369 /* case handling */
1370 enum case_handling {CASE_LOWER,CASE_UPPER};
1372 /* ACL compatibility */
1373 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1375 * Global value meaing that the smb_uid field should be
1376 * ingored (in share level security and protocol level == CORE)
1379 #define UID_FIELD_INVALID 0
1380 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1383 * Size of buffer to use when moving files across filesystems.
1385 #define COPYBUF_SIZE (8*1024)
1388 * Map the Core and Extended Oplock requesst bits down
1389 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1393 * Core protocol.
1395 #define CORE_OPLOCK_REQUEST(inbuf) \
1396 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1399 * Extended protocol.
1401 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1403 /* Lock types. */
1404 #define LOCKING_ANDX_SHARED_LOCK 0x1
1405 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1406 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1407 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1408 #define LOCKING_ANDX_LARGE_FILES 0x10
1411 * Bits we test with.
1412 * Note these must fit into 16-bits.
1415 #define NO_OPLOCK 0x0
1416 #define EXCLUSIVE_OPLOCK 0x1
1417 #define BATCH_OPLOCK 0x2
1418 #define LEVEL_II_OPLOCK 0x4
1420 /* The following are Samba-private. */
1421 #define INTERNAL_OPEN_ONLY 0x8
1422 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1423 * inform potential level2 holders on
1424 * write. */
1425 #define DEFERRED_OPEN_ENTRY 0x20
1426 #define UNUSED_SHARE_MODE_ENTRY 0x40
1427 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1429 /* None of the following should ever appear in fsp->oplock_request. */
1430 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1432 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1433 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1434 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1436 /* kernel_oplock_message definition.
1438 struct kernel_oplock_message {
1439 uint64_t dev;
1440 uint64_t inode;
1441 unit64_t extid;
1442 unsigned long file_id;
1445 Offset Data length.
1446 0 uint64_t dev 8 bytes
1447 8 uint64_t inode 8 bytes
1448 16 uint64_t extid 8 bytes
1449 24 unsigned long file_id 4 bytes
1453 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1455 /* file_renamed_message definition.
1457 struct file_renamed_message {
1458 uint64_t dev;
1459 uint64_t inode;
1460 char names[1]; A variable area containing sharepath and filename.
1463 Offset Data length.
1464 0 uint64_t dev 8 bytes
1465 8 uint64_t inode 8 bytes
1466 16 unit64_t extid 8 bytes
1467 24 char [] name zero terminated namelen bytes
1468 minimum length == 24.
1472 #define MSG_FILE_RENAMED_MIN_SIZE 24
1475 * On the wire return values for oplock types.
1478 #define CORE_OPLOCK_GRANTED (1<<5)
1479 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1481 #define NO_OPLOCK_RETURN 0
1482 #define EXCLUSIVE_OPLOCK_RETURN 1
1483 #define BATCH_OPLOCK_RETURN 2
1484 #define LEVEL_II_OPLOCK_RETURN 3
1486 /* Oplock levels */
1487 #define OPLOCKLEVEL_NONE 0
1488 #define OPLOCKLEVEL_II 1
1491 * Capabilities abstracted for different systems.
1494 enum smbd_capability {
1495 KERNEL_OPLOCK_CAPABILITY,
1496 DMAPI_ACCESS_CAPABILITY,
1497 LEASE_CAPABILITY
1501 * Kernel oplocks capability flags.
1504 /* Level 2 oplocks are supported natively by kernel oplocks. */
1505 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1507 /* The kernel notifies deferred openers when they can retry the open. */
1508 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1510 /* The kernel notifies smbds when an oplock break times out. */
1511 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1513 /* The kernel notifies smbds when an oplock is broken. */
1514 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1516 struct kernel_oplocks_ops;
1517 struct kernel_oplocks {
1518 const struct kernel_oplocks_ops *ops;
1519 uint32_t flags;
1520 void *private_data;
1523 enum level2_contention_type {
1524 LEVEL2_CONTEND_ALLOC_SHRINK,
1525 LEVEL2_CONTEND_ALLOC_GROW,
1526 LEVEL2_CONTEND_SET_FILE_LEN,
1527 LEVEL2_CONTEND_FILL_SPARSE,
1528 LEVEL2_CONTEND_WRITE,
1529 LEVEL2_CONTEND_WINDOWS_BRL,
1530 LEVEL2_CONTEND_POSIX_BRL
1533 /* if a kernel does support oplocks then a structure of the following
1534 typee is used to describe how to interact with the kernel */
1535 struct kernel_oplocks_ops {
1536 bool (*set_oplock)(struct kernel_oplocks *ctx,
1537 files_struct *fsp, int oplock_type);
1538 void (*release_oplock)(struct kernel_oplocks *ctx,
1539 files_struct *fsp, int oplock_type);
1540 void (*contend_level2_oplocks_begin)(files_struct *fsp,
1541 enum level2_contention_type type);
1542 void (*contend_level2_oplocks_end)(files_struct *fsp,
1543 enum level2_contention_type type);
1546 #include "smb_macros.h"
1548 #define MAX_NETBIOSNAME_LEN 16
1549 /* DOS character, NetBIOS namestring. Type used on the wire. */
1550 typedef char nstring[MAX_NETBIOSNAME_LEN];
1551 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1552 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1554 /* A netbios name structure. */
1555 struct nmb_name {
1556 nstring name;
1557 char scope[64];
1558 unsigned int name_type;
1561 /* A netbios node status array element. */
1562 struct node_status {
1563 nstring name;
1564 unsigned char type;
1565 unsigned char flags;
1568 /* The extra info from a NetBIOS node status query */
1569 struct node_status_extra {
1570 unsigned char mac_addr[6];
1571 /* There really is more here ... */
1574 typedef struct user_struct {
1575 struct user_struct *next, *prev;
1576 uint16 vuid; /* Tag for this entry. */
1578 char *session_keystr; /* used by utmp and pam session code.
1579 TDB key string */
1580 int homes_snum;
1582 struct auth_serversupplied_info *session_info;
1584 struct auth_ntlmssp_state *auth_ntlmssp_state;
1585 } user_struct;
1587 struct unix_error_map {
1588 int unix_error;
1589 int dos_class;
1590 int dos_code;
1591 NTSTATUS nt_error;
1595 Do you want session setups at user level security with a invalid
1596 password to be rejected or allowed in as guest? WinNT rejects them
1597 but it can be a pain as it means "net view" needs to use a password
1599 You have 3 choices in the setting of map_to_guest:
1601 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1602 are rejected. This is the default.
1604 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1605 are rejected, unless the username does not exist, in which case it
1606 is treated as a guest login
1608 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1609 are treated as a guest login
1611 Note that map_to_guest only has an effect in user or server
1612 level security.
1615 #define NEVER_MAP_TO_GUEST 0
1616 #define MAP_TO_GUEST_ON_BAD_USER 1
1617 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1618 #define MAP_TO_GUEST_ON_BAD_UID 3
1620 #define SAFE_NETBIOS_CHARS ". -_"
1622 /* The maximum length of a trust account password.
1623 Used when we randomly create it, 15 char passwords
1624 exceed NT4's max password length */
1626 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1628 #define PORT_NONE 0
1629 #ifndef LDAP_PORT
1630 #define LDAP_PORT 389
1631 #endif
1632 #define LDAP_GC_PORT 3268
1634 /* used by the IP comparison function */
1635 struct ip_service {
1636 struct sockaddr_storage ss;
1637 unsigned port;
1640 struct ea_struct {
1641 uint8 flags;
1642 char *name;
1643 DATA_BLOB value;
1646 struct ea_list {
1647 struct ea_list *next, *prev;
1648 struct ea_struct ea;
1651 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1652 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1653 /* EA to use for DOS attributes */
1654 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1655 /* Prefix for DosStreams in the vfs_streams_xattr module */
1656 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1657 /* Prefix for xattrs storing streams. */
1658 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1660 /* map readonly options */
1661 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1663 /* usershare error codes. */
1664 enum usershare_err {
1665 USERSHARE_OK=0,
1666 USERSHARE_MALFORMED_FILE,
1667 USERSHARE_BAD_VERSION,
1668 USERSHARE_MALFORMED_PATH,
1669 USERSHARE_MALFORMED_COMMENT_DEF,
1670 USERSHARE_MALFORMED_ACL_DEF,
1671 USERSHARE_ACL_ERR,
1672 USERSHARE_PATH_NOT_ABSOLUTE,
1673 USERSHARE_PATH_IS_DENIED,
1674 USERSHARE_PATH_NOT_ALLOWED,
1675 USERSHARE_PATH_NOT_DIRECTORY,
1676 USERSHARE_POSIX_ERR,
1677 USERSHARE_MALFORMED_SHARENAME_DEF,
1678 USERSHARE_BAD_SHARENAME
1681 /* Different reasons for closing a file. */
1682 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1684 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1685 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1686 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1687 struct smb_extended_info {
1688 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1689 uint32 samba_version; /* Major/Minor/Release/Revision */
1690 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1691 NTTIME samba_gitcommitdate;
1692 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1695 /* time info */
1696 struct smb_file_time {
1697 struct timespec mtime;
1698 struct timespec atime;
1699 struct timespec ctime;
1700 struct timespec create_time;
1704 * unix_convert_flags
1706 #define UCF_SAVE_LCOMP 0x00000001
1707 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1708 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1709 #define UCF_POSIX_PATHNAMES 0x00000008
1712 * smb_filename
1714 struct smb_filename {
1715 char *base_name;
1716 char *stream_name;
1717 char *original_lcomp;
1718 SMB_STRUCT_STAT st;
1721 /* struct for maintaining the child processes that get spawned from smbd */
1722 struct child_pid {
1723 struct child_pid *prev, *next;
1724 pid_t pid;
1727 /* Used to keep track of deferred opens. */
1728 struct deferred_open_record;
1730 /* Client-side offline caching policy types */
1731 #define CSC_POLICY_MANUAL 0
1732 #define CSC_POLICY_DOCUMENTS 1
1733 #define CSC_POLICY_PROGRAMS 2
1734 #define CSC_POLICY_DISABLE 3
1736 /* Used inside aio code. */
1737 struct aio_extra;
1739 #endif /* _SMB_H */