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