s4:libcli/raw: remove unused SMB_SIGNING_AUTO handling
[Samba/gebeck_regimport.git] / source3 / include / smb.h
blob22575be4694b2a4cd55232b903026fa8e1d48ef6
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"
30 #include "libds/common/roles.h"
32 /* logged when starting the various Samba daemons */
33 #define COPYRIGHT_STARTUP_MESSAGE "Copyright Andrew Tridgell and the Samba Team 1992-2011"
36 #if defined(LARGE_SMB_OFF_T)
37 #define BUFFER_SIZE (128*1024)
38 #else /* no large readwrite possible */
39 #define BUFFER_SIZE (0xFFFF)
40 #endif
42 #define SAFETY_MARGIN 1024
43 #define LARGE_WRITEX_HDR_SIZE 65
45 #define NMB_PORT 137
46 #define DGRAM_PORT 138
47 #define SMB_PORT1 445
48 #define SMB_PORT2 139
49 #define SMB_PORTS "445 139"
51 #define Undefined (-1)
52 #define False false
53 #define True true
54 #define Auto (2)
55 #define Required (3)
57 #define SIZEOFWORD 2
59 #ifndef DEF_CREATE_MASK
60 #define DEF_CREATE_MASK (0755)
61 #endif
63 /* string manipulation flags - see clistr.c and srvstr.c */
64 #define STR_TERMINATE 1
65 #define STR_UPPER 2
66 #define STR_ASCII 4
67 #define STR_UNICODE 8
68 #define STR_NOALIGN 16
69 #define STR_TERMINATE_ASCII 128
71 /* how long to wait for secondary SMB packets (milli-seconds) */
72 #define SMB_SECONDARY_WAIT (60*1000)
74 #define DIR_STRUCT_SIZE 43
76 /* deny modes */
77 #define DENY_DOS 0
78 #define DENY_ALL 1
79 #define DENY_WRITE 2
80 #define DENY_READ 3
81 #define DENY_NONE 4
82 #define DENY_FCB 7
84 /* open modes */
85 #define DOS_OPEN_RDONLY 0
86 #define DOS_OPEN_WRONLY 1
87 #define DOS_OPEN_RDWR 2
88 #define DOS_OPEN_EXEC 3
89 #define DOS_OPEN_FCB 0xF
91 /* define shifts and masks for share and open modes. */
92 #define OPENX_MODE_MASK 0xF
93 #define DENY_MODE_SHIFT 4
94 #define DENY_MODE_MASK 0x7
95 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
96 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
97 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
98 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
100 /* Sync on open file (not sure if used anymore... ?) */
101 #define FILE_SYNC_OPENMODE (1<<14)
102 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
104 /* open disposition values */
105 #define OPENX_FILE_EXISTS_FAIL 0
106 #define OPENX_FILE_EXISTS_OPEN 1
107 #define OPENX_FILE_EXISTS_TRUNCATE 2
109 /* mask for open disposition. */
110 #define OPENX_FILE_OPEN_MASK 0x3
112 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
113 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
115 /* The above can be OR'ed with... */
116 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
117 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
119 typedef union unid_t {
120 uid_t uid;
121 gid_t gid;
122 } unid_t;
124 /* pipe string names */
126 #ifndef MAXSUBAUTHS
127 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
128 #endif
130 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
132 #include "librpc/gen_ndr/security.h"
135 * The complete list of SIDS belonging to this user.
136 * Created when a vuid is registered.
137 * The definition of the user_sids array is as follows :
139 * token->user_sids[0] = primary user SID.
140 * token->user_sids[1] = primary group SID.
141 * token->user_sids[2..num_sids] = supplementary group SIDS.
144 #define PRIMARY_USER_SID_INDEX 0
145 #define PRIMARY_GROUP_SID_INDEX 1
147 typedef struct write_cache {
148 SMB_OFF_T file_size;
149 SMB_OFF_T offset;
150 size_t alloc_size;
151 size_t data_size;
152 char *data;
153 } write_cache;
155 struct fd_handle {
156 size_t ref_count;
157 int fd;
158 uint64_t position_information;
159 SMB_OFF_T pos;
160 uint32 private_options; /* NT Create options, but we only look at
161 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
162 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
163 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
164 * for print files *only*, where
165 * DELETE_ON_CLOSE is not stored in the share
166 * mode database.
168 unsigned long gen_id;
171 struct idle_event;
172 struct share_mode_entry;
173 struct uuid;
174 struct named_mutex;
175 struct wb_context;
176 struct rpc_cli_smbd_conn;
177 struct fncall_context;
179 struct vfs_fsp_data {
180 struct vfs_fsp_data *next;
181 struct vfs_handle_struct *owner;
182 void (*destroy)(void *p_data);
183 void *_dummy_;
184 /* NOTE: This structure contains four pointers so that we can guarantee
185 * that the end of the structure is always both 4-byte and 8-byte aligned.
189 /* the basic packet size, assuming no words or bytes */
190 #define smb_size 39
192 struct notify_change {
193 uint32_t action;
194 const char *name;
197 struct notify_mid_map;
198 struct notify_entry;
199 struct notify_event;
200 struct notify_change_request;
201 struct sys_notify_backend;
202 struct sys_notify_context {
203 struct event_context *ev;
204 struct connection_struct *conn;
205 void *private_data; /* For use by the system backend */
208 struct notify_change_buf {
210 * If no requests are pending, changes are queued here. Simple array,
211 * we only append.
215 * num_changes == -1 means that we have got a catch-all change, when
216 * asked we just return NT_STATUS_OK without specific changes.
218 int num_changes;
219 struct notify_change *changes;
222 * If no changes are around requests are queued here. Using a linked
223 * list, because we have to append at the end and delete from the top.
225 struct notify_change_request *requests;
228 struct print_file_data {
229 char *svcname;
230 char *docname;
231 char *filename;
232 struct policy_handle handle;
233 uint32_t jobid;
234 uint16 rap_jobid;
237 typedef struct files_struct {
238 struct files_struct *next, *prev;
239 int fnum;
240 struct connection_struct *conn;
241 struct fd_handle *fh;
242 unsigned int num_smb_operations;
243 struct file_id file_id;
244 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
245 mode_t mode;
246 uint16 file_pid;
247 uint16 vuid;
248 write_cache *wcp;
249 struct timeval open_time;
250 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
251 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
253 bool update_write_time_triggered;
254 struct timed_event *update_write_time_event;
255 bool update_write_time_on_close;
256 struct timespec close_write_time;
257 bool write_time_forced;
259 int oplock_type;
260 int sent_oplock_break;
261 struct timed_event *oplock_timeout;
262 struct lock_struct last_lock_failure;
263 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
265 struct share_mode_entry *pending_break_messages;
266 int num_pending_break_messages;
268 bool can_lock;
269 bool can_read;
270 bool can_write;
271 bool modified;
272 bool is_directory;
273 bool aio_write_behind;
274 bool lockdb_clean;
275 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
276 bool delete_on_close;
277 bool posix_open;
278 bool is_sparse;
279 struct smb_filename *fsp_name;
280 uint32_t name_hash; /* Jenkins hash of full pathname. */
282 struct vfs_fsp_data *vfs_extension;
283 struct fake_file_handle *fake_file_handle;
285 struct notify_change_buf *notify;
287 struct files_struct *base_fsp; /* placeholder for delete on close */
290 * Read-only cached brlock record, thrown away when the
291 * brlock.tdb seqnum changes. This avoids fetching data from
292 * the brlock.tdb on every read/write call.
294 int brlock_seqnum;
295 struct byte_range_lock *brlock_rec;
297 struct dptr_struct *dptr;
299 /* if not NULL, means this is a print file */
300 struct print_file_data *print_file;
302 } files_struct;
304 #include "ntquotas.h"
305 #include "sysquotas.h"
307 struct vuid_cache_entry {
308 struct auth_session_info *session_info;
309 uint16_t vuid;
310 bool read_only;
313 struct vuid_cache {
314 unsigned int next_entry;
315 struct vuid_cache_entry array[VUID_CACHE_SIZE];
318 typedef struct {
319 char *name;
320 bool is_wild;
321 } name_compare_entry;
323 struct trans_state {
324 struct trans_state *next, *prev;
325 uint16 vuid;
326 uint64_t mid;
328 uint32 max_param_return;
329 uint32 max_data_return;
330 uint32 max_setup_return;
332 uint8 cmd; /* SMBtrans or SMBtrans2 */
334 char *name; /* for trans requests */
335 uint16 call; /* for trans2 and nttrans requests */
337 bool close_on_completion;
338 bool one_way;
340 unsigned int setup_count;
341 uint16 *setup;
343 size_t received_data;
344 size_t received_param;
346 size_t total_param;
347 char *param;
349 size_t total_data;
350 char *data;
354 * Info about an alternate data stream
357 struct stream_struct {
358 SMB_OFF_T size;
359 SMB_OFF_T alloc_size;
360 char *name;
363 /* Include VFS stuff */
365 #include "smb_acls.h"
366 #include "vfs.h"
368 struct dfree_cached_info {
369 time_t last_dfree_time;
370 uint64_t dfree_ret;
371 uint64_t bsize;
372 uint64_t dfree;
373 uint64_t dsize;
376 struct dptr_struct;
378 struct share_params {
379 int service;
382 typedef struct connection_struct {
383 struct connection_struct *next, *prev;
384 struct smbd_server_connection *sconn; /* can be NULL */
385 unsigned cnum; /* an index passed over the wire */
386 struct share_params *params;
387 bool force_user;
388 struct vuid_cache vuid_cache;
389 bool printer;
390 bool ipc;
391 bool read_only; /* Attributes for the current user of the share. */
392 uint32_t share_access;
393 /* Does this filesystem honor
394 sub second timestamps on files
395 and directories when setting time ? */
396 enum timestamp_set_resolution ts_res;
397 char *connectpath;
398 char *origpath;
400 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
403 * This represents the user information on this connection. Depending
404 * on the vuid using this tid, this might change per SMB request.
406 struct auth_session_info *session_info;
409 * If the "force group" parameter is set, this is the primary gid that
410 * may be used in the users token, depending on the vuid using this tid.
412 gid_t force_group_gid;
414 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
416 time_t lastused;
417 time_t lastused_count;
418 bool used;
419 int num_files_open;
420 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
421 int encrypt_level;
422 bool encrypted_tid;
424 /* Semantics requested by the client or forced by the server config. */
425 bool case_sensitive;
426 bool case_preserve;
427 bool short_case_preserve;
429 /* Semantics provided by the underlying filesystem. */
430 int fs_capabilities;
431 /* Device number of the directory of the share mount.
432 Used to ensure unique FileIndex returns. */
433 SMB_DEV_T base_share_dev;
435 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
436 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
437 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
438 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
439 struct dfree_cached_info *dfree_info;
440 struct trans_state *pending_trans;
441 struct notify_context *notify_ctx;
443 struct rpc_pipe_client *spoolss_pipe;
445 } connection_struct;
447 struct current_user {
448 connection_struct *conn;
449 uint16 vuid;
450 struct security_unix_token ut;
451 struct security_token *nt_user_token;
454 struct smbd_smb2_request;
456 struct smb_request {
457 uint8_t cmd;
458 uint16 flags2;
459 uint16 smbpid;
460 uint64_t mid; /* For compatibility with SMB2. */
461 uint32_t seqnum;
462 uint16 vuid;
463 uint16 tid;
464 uint8 wct;
465 uint16_t *vwv;
466 uint16_t buflen;
467 const uint8_t *buf;
468 const uint8 *inbuf;
471 * Async handling in the main smb processing loop is directed by
472 * outbuf: reply_xxx routines indicate sync behaviour by putting their
473 * reply into "outbuf". If they leave it as NULL, they take of it
474 * themselves, possibly later.
476 * If async handling is wanted, the reply_xxx routine must make sure
477 * that it talloc_move()s the smb_req somewhere else.
479 uint8 *outbuf;
481 size_t unread_bytes;
482 bool encrypted;
483 connection_struct *conn;
484 struct smbd_server_connection *sconn;
485 struct smb_perfcount_data pcd;
488 * Chained request handling
490 struct files_struct *chain_fsp;
493 * Here we collect the outbufs from the chain handlers
495 uint8_t *chain_outbuf;
498 * state information for async smb handling
500 void *async_priv;
502 bool done;
505 * Back pointer to smb2 request.
507 struct smbd_smb2_request *smb2req;
510 /* Defines for the sent_oplock_break field above. */
511 #define NO_BREAK_SENT 0
512 #define BREAK_TO_NONE_SENT 1
513 #define LEVEL_II_BREAK_SENT 2
515 typedef struct {
516 fstring smb_name; /* user name from the client */
517 fstring unix_name; /* unix user name of a validated user */
518 fstring domain; /* domain that the client specified */
519 } userdom_struct;
521 /* used for server information: client, nameserv and ipc */
522 struct server_info_struct {
523 fstring name;
524 uint32 type;
525 fstring comment;
526 fstring domain; /* used ONLY in ipc.c NOT namework.c */
527 bool server_added; /* used ONLY in ipc.c NOT namework.c */
530 /* used for network interfaces */
531 struct interface {
532 struct interface *next, *prev;
533 char *name;
534 int flags;
535 struct sockaddr_storage ip;
536 struct sockaddr_storage netmask;
537 struct sockaddr_storage bcast;
540 /* Internal message queue for deferred opens. */
541 struct pending_message_list {
542 struct pending_message_list *next, *prev;
543 struct timeval request_time; /* When was this first issued? */
544 struct timed_event *te;
545 struct smb_perfcount_data pcd;
546 uint32_t seqnum;
547 bool encrypted;
548 bool processed;
549 DATA_BLOB buf;
550 DATA_BLOB private_data;
553 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
555 #include "librpc/gen_ndr/server_id.h"
557 /* struct returned by get_share_modes */
558 struct share_mode_entry {
559 struct server_id pid;
560 uint64_t op_mid; /* For compatibility with SMB2 opens. */
561 uint16 op_type;
562 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
563 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
564 uint32 private_options; /* NT Create options, but we only look at
565 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
566 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
567 * smbstatus and swat */
568 struct timeval time;
569 struct file_id id;
570 unsigned long share_file_id;
571 uint32 uid; /* uid of file opener. */
572 uint16 flags; /* See SHARE_MODE_XX above. */
573 uint32_t name_hash; /* Jenkins hash of full pathname. */
576 /* oplock break message definition - linearization of share_mode_entry.
578 Offset Data length.
579 0 struct server_id pid 4
580 4 uint16 op_mid 8
581 12 uint16 op_type 2
582 14 uint32 access_mask 4
583 18 uint32 share_access 4
584 22 uint32 private_options 4
585 26 uint32 time sec 4
586 30 uint32 time usec 4
587 34 uint64 dev 8 bytes
588 42 uint64 inode 8 bytes
589 50 uint64 extid 8 bytes
590 58 unsigned long file_id 4 bytes
591 62 uint32 uid 4 bytes
592 66 uint16 flags 2 bytes
593 68 uint32 name_hash 4 bytes
598 #define OP_BREAK_MSG_PID_OFFSET 0
599 #define OP_BREAK_MSG_MID_OFFSET 4
600 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
601 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
602 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
603 #define OP_BREAK_MSG_PRIV_OFFSET 22
604 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
605 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
606 #define OP_BREAK_MSG_DEV_OFFSET 34
607 #define OP_BREAK_MSG_INO_OFFSET 42
608 #define OP_BREAK_MSG_EXTID_OFFSET 50
609 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
610 #define OP_BREAK_MSG_UID_OFFSET 62
611 #define OP_BREAK_MSG_FLAGS_OFFSET 66
612 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
614 #define OP_BREAK_MSG_VNN_OFFSET 72
615 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
617 struct delete_token_list {
618 struct delete_token_list *next, *prev;
619 uint32_t name_hash;
620 struct security_unix_token *delete_token;
623 struct share_mode_lock {
624 const char *servicepath; /* canonicalized. */
625 const char *base_name;
626 const char *stream_name;
627 struct file_id id;
628 int num_share_modes;
629 struct share_mode_entry *share_modes;
630 struct delete_token_list *delete_tokens;
631 struct timespec old_write_time;
632 struct timespec changed_write_time;
633 bool fresh;
634 bool modified;
635 struct db_record *record;
639 * Internal structure of locking.tdb share mode db.
640 * Used by locking.c and libsmbsharemodes.c
643 struct locking_data {
644 union {
645 struct {
646 int num_share_mode_entries;
647 struct timespec old_write_time;
648 struct timespec changed_write_time;
649 uint32 num_delete_token_entries;
650 } s;
651 struct share_mode_entry dummy; /* Needed for alignment. */
652 } u;
653 /* The following four entries are implicit
655 (1) struct share_mode_entry modes[num_share_mode_entries];
657 (2) A num_delete_token_entries of structs {
658 uint32_t len_delete_token;
659 char unix_token[len_delete_token] (divisible by 4).
662 (3) char share_name[];
663 (4) char file_name[];
667 #define NT_HASH_LEN 16
668 #define LM_HASH_LEN 16
670 /* key and data in the connections database - used in smbstatus and smbd */
671 struct connections_key {
672 struct server_id pid;
673 int cnum;
674 fstring name;
677 struct connections_data {
678 int magic;
679 struct server_id pid;
680 int cnum;
681 uid_t uid;
682 gid_t gid;
683 char servicename[FSTRING_LEN];
684 char addr[24];
685 char machine[FSTRING_LEN];
686 time_t start;
689 * This field used to hold the msg_flags. For compatibility reasons,
690 * keep the data structure in the tdb file the same.
692 uint32 unused_compatitibility_field;
695 /* offsets into message for common items */
696 #define smb_com (NBT_HDR_SIZE+HDR_COM)
697 #define smb_rcls (NBT_HDR_SIZE+HDR_RCLS)
698 #define smb_reh (NBT_HDR_SIZE+HDR_REH)
699 #define smb_err (NBT_HDR_SIZE+HDR_ERR)
700 #define smb_flg (NBT_HDR_SIZE+HDR_FLG)
701 #define smb_flg2 (NBT_HDR_SIZE+HDR_FLG2)
702 #define smb_pidhigh (NBT_HDR_SIZE+HDR_PIDHIGH)
703 #define smb_ss_field (NBT_HDR_SIZE+HDR_SS_FIELD)
704 #define smb_tid (NBT_HDR_SIZE+HDR_TID)
705 #define smb_pid (NBT_HDR_SIZE+HDR_PID)
706 #define smb_uid (NBT_HDR_SIZE+HDR_UID)
707 #define smb_mid (NBT_HDR_SIZE+HDR_MID)
708 #define smb_wct (NBT_HDR_SIZE+HDR_WCT)
709 #define smb_vwv (NBT_HDR_SIZE+HDR_VWV)
710 #define smb_vwv0 (smb_vwv+( 0*2))
711 #define smb_vwv1 (smb_vwv+( 1*2))
712 #define smb_vwv2 (smb_vwv+( 2*2))
713 #define smb_vwv3 (smb_vwv+( 3*2))
714 #define smb_vwv4 (smb_vwv+( 4*2))
715 #define smb_vwv5 (smb_vwv+( 5*2))
716 #define smb_vwv6 (smb_vwv+( 6*2))
717 #define smb_vwv7 (smb_vwv+( 7*2))
718 #define smb_vwv8 (smb_vwv+( 8*2))
719 #define smb_vwv9 (smb_vwv+( 9*2))
720 #define smb_vwv10 (smb_vwv+(10*2))
721 #define smb_vwv11 (smb_vwv+(11*2))
722 #define smb_vwv12 (smb_vwv+(12*2))
723 #define smb_vwv13 (smb_vwv+(13*2))
724 #define smb_vwv14 (smb_vwv+(14*2))
725 #define smb_vwv15 (smb_vwv+(15*2))
726 #define smb_vwv16 (smb_vwv+(16*2))
727 #define smb_vwv17 (smb_vwv+(17*2))
729 /* These are the trans subcommands */
730 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
731 #define TRANSACT_DCERPCCMD 0x26
732 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
734 /* These are the TRANS2 sub commands */
735 #define TRANSACT2_OPEN 0x00
736 #define TRANSACT2_FINDFIRST 0x01
737 #define TRANSACT2_FINDNEXT 0x02
738 #define TRANSACT2_QFSINFO 0x03
739 #define TRANSACT2_SETFSINFO 0x04
740 #define TRANSACT2_QPATHINFO 0x05
741 #define TRANSACT2_SETPATHINFO 0x06
742 #define TRANSACT2_QFILEINFO 0x07
743 #define TRANSACT2_SETFILEINFO 0x08
744 #define TRANSACT2_FSCTL 0x09
745 #define TRANSACT2_IOCTL 0x0A
746 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
747 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
748 #define TRANSACT2_MKDIR 0x0D
749 #define TRANSACT2_SESSION_SETUP 0x0E
750 #define TRANSACT2_GET_DFS_REFERRAL 0x10
751 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
753 /* These are the NT transact sub commands. */
754 #define NT_TRANSACT_CREATE 1
755 #define NT_TRANSACT_IOCTL 2
756 #define NT_TRANSACT_SET_SECURITY_DESC 3
757 #define NT_TRANSACT_NOTIFY_CHANGE 4
758 #define NT_TRANSACT_RENAME 5
759 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
760 #define NT_TRANSACT_GET_USER_QUOTA 7
761 #define NT_TRANSACT_SET_USER_QUOTA 8
763 /* These are the NT transact_get_user_quota sub commands */
764 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
765 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
766 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
768 /* Relevant IOCTL codes */
769 #define IOCTL_QUERY_JOB_INFO 0x530060
771 /* these are the trans2 sub fields for primary requests */
772 #define smb_tpscnt smb_vwv0
773 #define smb_tdscnt smb_vwv1
774 #define smb_mprcnt smb_vwv2
775 #define smb_mdrcnt smb_vwv3
776 #define smb_msrcnt smb_vwv4
777 #define smb_flags smb_vwv5
778 #define smb_timeout smb_vwv6
779 #define smb_pscnt smb_vwv9
780 #define smb_psoff smb_vwv10
781 #define smb_dscnt smb_vwv11
782 #define smb_dsoff smb_vwv12
783 #define smb_suwcnt smb_vwv13
784 #define smb_setup smb_vwv14
785 #define smb_setup0 smb_setup
786 #define smb_setup1 (smb_setup+2)
787 #define smb_setup2 (smb_setup+4)
789 /* these are for the secondary requests */
790 #define smb_spscnt smb_vwv2
791 #define smb_spsoff smb_vwv3
792 #define smb_spsdisp smb_vwv4
793 #define smb_sdscnt smb_vwv5
794 #define smb_sdsoff smb_vwv6
795 #define smb_sdsdisp smb_vwv7
796 #define smb_sfid smb_vwv8
798 /* and these for responses */
799 #define smb_tprcnt smb_vwv0
800 #define smb_tdrcnt smb_vwv1
801 #define smb_prcnt smb_vwv3
802 #define smb_proff smb_vwv4
803 #define smb_prdisp smb_vwv5
804 #define smb_drcnt smb_vwv6
805 #define smb_droff smb_vwv7
806 #define smb_drdisp smb_vwv8
808 /* these are for the NT trans primary request. */
809 #define smb_nt_MaxSetupCount smb_vwv0
810 #define smb_nt_Flags (smb_vwv0 + 1)
811 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
812 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
813 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
814 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
815 #define smb_nt_ParameterCount (smb_vwv0 + 19)
816 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
817 #define smb_nt_DataCount (smb_vwv0 + 27)
818 #define smb_nt_DataOffset (smb_vwv0 + 31)
819 #define smb_nt_SetupCount (smb_vwv0 + 35)
820 #define smb_nt_Function (smb_vwv0 + 36)
821 #define smb_nt_SetupStart (smb_vwv0 + 38)
823 /* these are for the NT trans secondary request. */
824 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
825 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
826 #define smb_nts_ParameterCount (smb_vwv0 + 11)
827 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
828 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
829 #define smb_nts_DataCount (smb_vwv0 + 23)
830 #define smb_nts_DataOffset (smb_vwv0 + 27)
831 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
833 /* these are for the NT trans reply. */
834 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
835 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
836 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
837 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
838 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
839 #define smb_ntr_DataCount (smb_vwv0 + 23)
840 #define smb_ntr_DataOffset (smb_vwv0 + 27)
841 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
843 /* these are for the NT create_and_X */
844 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
845 #define smb_ntcreate_Flags (smb_vwv0 + 7)
846 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
847 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
848 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
849 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
850 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
851 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
852 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
853 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
854 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
856 /* this is used on a TConX. I'm not sure the name is very helpful though */
857 #define SMB_SUPPORT_SEARCH_BITS 0x0001
858 #define SMB_SHARE_IN_DFS 0x0002
860 /* Named pipe write mode flags. Used in writeX calls. */
861 #define PIPE_RAW_MODE 0x4
862 #define PIPE_START_MESSAGE 0x8
864 /* the desired access to use when opening a pipe */
865 #define DESIRED_ACCESS_PIPE 0x2019f
867 /* Mapping of access rights to UNIX perms. */
868 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
869 #define UNIX_ACCESS_R FILE_GENERIC_READ
870 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
871 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
873 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
874 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
875 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
876 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
877 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
879 #if 0
881 * This is the old mapping we used to use. To get W2KSP2 profiles
882 * working we need to map to the canonical file perms.
884 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
885 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
886 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
887 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
888 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
889 FILE_APPEND_DATA|FILE_WRITE_DATA)
890 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
891 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
892 #endif
894 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
896 /* Flags field. */
897 #define REQUEST_OPLOCK 2
898 #define REQUEST_BATCH_OPLOCK 4
899 #define OPEN_DIRECTORY 8
900 #define EXTENDED_RESPONSE_REQUIRED 0x10
902 /* ShareAccess field. */
903 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
904 #define FILE_SHARE_READ 1
905 #define FILE_SHARE_WRITE 2
906 #define FILE_SHARE_DELETE 4
908 /* Flags - combined with attributes. */
909 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
910 #define FILE_FLAG_NO_BUFFERING 0x20000000L
911 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
912 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
913 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
914 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
915 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
917 /* CreateDisposition field. */
918 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
919 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
920 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
921 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
922 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
923 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
925 /* CreateOptions field. */
926 #define FILE_DIRECTORY_FILE 0x0001
927 #define FILE_WRITE_THROUGH 0x0002
928 #define FILE_SEQUENTIAL_ONLY 0x0004
929 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
930 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
931 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
932 #define FILE_NON_DIRECTORY_FILE 0x0040
933 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
934 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
935 #define FILE_NO_EA_KNOWLEDGE 0x0200
936 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
937 #define FILE_RANDOM_ACCESS 0x0800
938 #define FILE_DELETE_ON_CLOSE 0x1000
939 #define FILE_OPEN_BY_FILE_ID 0x2000
940 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
941 #define FILE_NO_COMPRESSION 0x8000
942 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
943 #define FILE_OPEN_REPARSE_POINT 0x00200000
944 #define FILE_OPEN_NO_RECALL 0x00400000
945 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
947 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
949 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
952 * Private create options used by the ntcreatex processing code. From Samba4.
953 * We reuse some ignored flags for private use. Passed in the private_flags
954 * argument.
956 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
957 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
959 /* Private options for streams support */
960 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
962 /* Private options for printer support */
963 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
965 /* Responses when opening a file. */
966 #define FILE_WAS_SUPERSEDED 0
967 #define FILE_WAS_OPENED 1
968 #define FILE_WAS_CREATED 2
969 #define FILE_WAS_OVERWRITTEN 3
971 /* Flag for NT transact rename call. */
972 #define RENAME_REPLACE_IF_EXISTS 1
974 /* flags for SMBntrename call (from Samba4) */
975 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
976 #define RENAME_FLAG_HARD_LINK 0x103
977 #define RENAME_FLAG_RENAME 0x104
978 #define RENAME_FLAG_COPY 0x105
980 /* Filesystem Attributes. */
981 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
982 #define FILE_CASE_PRESERVED_NAMES 0x00000002
983 #define FILE_UNICODE_ON_DISK 0x00000004
984 /* According to cifs9f, this is 4, not 8 */
985 /* Acconding to testing, this actually sets the security attribute! */
986 #define FILE_PERSISTENT_ACLS 0x00000008
987 #define FILE_FILE_COMPRESSION 0x00000010
988 #define FILE_VOLUME_QUOTAS 0x00000020
989 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
990 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
991 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
992 #define FS_LFN_APIS 0x00004000
993 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
994 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
995 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
996 #define FILE_NAMED_STREAMS 0x00040000
997 #define FILE_READ_ONLY_VOLUME 0x00080000
999 /* ChangeNotify flags. */
1000 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1001 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1002 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1003 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1004 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1005 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1006 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1007 #define FILE_NOTIFY_CHANGE_EA 0x080
1008 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1009 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1010 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1011 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1013 #define FILE_NOTIFY_CHANGE_NAME \
1014 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1016 /* change notify action results */
1017 #define NOTIFY_ACTION_ADDED 1
1018 #define NOTIFY_ACTION_REMOVED 2
1019 #define NOTIFY_ACTION_MODIFIED 3
1020 #define NOTIFY_ACTION_OLD_NAME 4
1021 #define NOTIFY_ACTION_NEW_NAME 5
1022 #define NOTIFY_ACTION_ADDED_STREAM 6
1023 #define NOTIFY_ACTION_REMOVED_STREAM 7
1024 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1027 /* where to find the base of the SMB packet proper */
1028 #define smb_base(buf) (((const char *)(buf))+4)
1030 /* we don't allow server strings to be longer than 48 characters as
1031 otherwise NT will not honour the announce packets */
1032 #define MAX_SERVER_STRING_LENGTH 48
1035 #define SMB_SUCCESS 0 /* The request was successful. */
1037 #ifdef WITH_DFS
1038 void dfs_unlogin(void);
1039 extern int dcelogin_atmost_once;
1040 #endif
1042 #ifdef NOSTRDUP
1043 char *strdup(char *s);
1044 #endif
1046 #ifndef SELECT_CAST
1047 #define SELECT_CAST
1048 #endif
1050 /* This was set by JHT in liaison with Jeremy Allison early 1997
1051 * History:
1052 * Version 4.0 - never made public
1053 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1054 * - Reappeared in 1.9.16p11 with fixed smbd services
1055 * Version 4.20 - To indicate that nmbd and browsing now works better
1056 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1058 * Note: In the presence of NT4.X do not set above 4.9
1059 * Setting this above 4.9 can have undesired side-effects.
1060 * This may change again in Samba-3.0 after further testing. JHT
1063 #define SAMBA_MAJOR_NBT_ANNOUNCE_VERSION 0x04
1064 #define SAMBA_MINOR_NBT_ANNOUNCE_VERSION 0x09
1066 /* Browser Election Values */
1067 #define BROWSER_ELECTION_VERSION 0x010f
1068 #define BROWSER_CONSTANT 0xaa55
1070 /* TCONX Flag (smb_vwv2). */
1071 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1073 /* File Status Flags. See:
1075 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1078 #define NO_EAS 0x1
1079 #define NO_SUBSTREAMS 0x2
1080 #define NO_REPARSETAG 0x4
1082 /* printing types */
1083 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1084 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1085 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1086 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1087 ,PRINT_TEST,PRINT_VLP
1088 #endif /* DEVELOPER */
1091 /* LDAP SSL options */
1092 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1094 /* LDAP PASSWD SYNC methods */
1095 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1098 * This should be under the HAVE_KRB5 flag but since they're used
1099 * in lp_kerberos_method(), they ned to be always available
1100 * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
1101 * so they remain accurate.
1104 #define KERBEROS_VERIFY_SECRETS 0
1105 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1106 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1107 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1109 /* Remote architectures we know about. */
1110 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1111 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1112 RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
1114 /* case handling */
1115 enum case_handling {CASE_LOWER,CASE_UPPER};
1117 /* ACL compatibility */
1118 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1120 * Global value meaing that the smb_uid field should be
1121 * ingored (in share level security and protocol level == CORE)
1124 #define UID_FIELD_INVALID 0
1125 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1128 * Size of buffer to use when moving files across filesystems.
1130 #define COPYBUF_SIZE (8*1024)
1133 * Map the Core and Extended Oplock requesst bits down
1134 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1138 * Core protocol.
1140 #define CORE_OPLOCK_REQUEST(inbuf) \
1141 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1144 * Extended protocol.
1146 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1149 * Bits we test with.
1150 * Note these must fit into 16-bits.
1153 #define NO_OPLOCK OPLOCK_NONE
1154 #define EXCLUSIVE_OPLOCK OPLOCK_EXCLUSIVE
1155 #define BATCH_OPLOCK OPLOCK_BATCH
1156 #define LEVEL_II_OPLOCK OPLOCK_LEVEL_II
1158 /* The following are Samba-private. */
1159 #define INTERNAL_OPEN_ONLY 0x8
1160 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1161 * inform potential level2 holders on
1162 * write. */
1163 #define DEFERRED_OPEN_ENTRY 0x20
1164 #define UNUSED_SHARE_MODE_ENTRY 0x40
1165 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1167 /* None of the following should ever appear in fsp->oplock_request. */
1168 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1170 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1171 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1172 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1174 /* kernel_oplock_message definition.
1176 struct kernel_oplock_message {
1177 uint64_t dev;
1178 uint64_t inode;
1179 unit64_t extid;
1180 unsigned long file_id;
1183 Offset Data length.
1184 0 uint64_t dev 8 bytes
1185 8 uint64_t inode 8 bytes
1186 16 uint64_t extid 8 bytes
1187 24 unsigned long file_id 4 bytes
1191 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1193 /* file_renamed_message definition.
1195 struct file_renamed_message {
1196 uint64_t dev;
1197 uint64_t inode;
1198 char names[1]; A variable area containing sharepath and filename.
1201 Offset Data length.
1202 0 uint64_t dev 8 bytes
1203 8 uint64_t inode 8 bytes
1204 16 unit64_t extid 8 bytes
1205 24 char [] name zero terminated namelen bytes
1206 minimum length == 24.
1210 #define MSG_FILE_RENAMED_MIN_SIZE 24
1213 * On the wire return values for oplock types.
1216 #define CORE_OPLOCK_GRANTED (1<<5)
1217 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1219 #define NO_OPLOCK_RETURN 0
1220 #define EXCLUSIVE_OPLOCK_RETURN 1
1221 #define BATCH_OPLOCK_RETURN 2
1222 #define LEVEL_II_OPLOCK_RETURN 3
1224 /* Oplock levels */
1225 #define OPLOCKLEVEL_NONE 0
1226 #define OPLOCKLEVEL_II 1
1229 * Capabilities abstracted for different systems.
1232 enum smbd_capability {
1233 KERNEL_OPLOCK_CAPABILITY,
1234 DMAPI_ACCESS_CAPABILITY,
1235 LEASE_CAPABILITY
1239 * Kernel oplocks capability flags.
1242 /* Level 2 oplocks are supported natively by kernel oplocks. */
1243 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1245 /* The kernel notifies deferred openers when they can retry the open. */
1246 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1248 /* The kernel notifies smbds when an oplock break times out. */
1249 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1251 /* The kernel notifies smbds when an oplock is broken. */
1252 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1254 struct kernel_oplocks_ops;
1255 struct kernel_oplocks {
1256 const struct kernel_oplocks_ops *ops;
1257 uint32_t flags;
1258 void *private_data;
1261 enum level2_contention_type {
1262 LEVEL2_CONTEND_ALLOC_SHRINK,
1263 LEVEL2_CONTEND_ALLOC_GROW,
1264 LEVEL2_CONTEND_SET_FILE_LEN,
1265 LEVEL2_CONTEND_FILL_SPARSE,
1266 LEVEL2_CONTEND_WRITE,
1267 LEVEL2_CONTEND_WINDOWS_BRL,
1268 LEVEL2_CONTEND_POSIX_BRL
1271 /* if a kernel does support oplocks then a structure of the following
1272 typee is used to describe how to interact with the kernel */
1273 struct kernel_oplocks_ops {
1274 bool (*set_oplock)(struct kernel_oplocks *ctx,
1275 files_struct *fsp, int oplock_type);
1276 void (*release_oplock)(struct kernel_oplocks *ctx,
1277 files_struct *fsp, int oplock_type);
1278 void (*contend_level2_oplocks_begin)(files_struct *fsp,
1279 enum level2_contention_type type);
1280 void (*contend_level2_oplocks_end)(files_struct *fsp,
1281 enum level2_contention_type type);
1284 #include "smb_macros.h"
1286 #define MAX_NETBIOSNAME_LEN 16
1287 /* DOS character, NetBIOS namestring. Type used on the wire. */
1288 typedef char nstring[MAX_NETBIOSNAME_LEN];
1289 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1290 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1292 /* A netbios name structure. */
1293 struct nmb_name {
1294 nstring name;
1295 char scope[64];
1296 unsigned int name_type;
1299 /* A netbios node status array element. */
1300 struct node_status {
1301 nstring name;
1302 unsigned char type;
1303 unsigned char flags;
1306 /* The extra info from a NetBIOS node status query */
1307 struct node_status_extra {
1308 unsigned char mac_addr[6];
1309 /* There really is more here ... */
1312 typedef struct user_struct {
1313 struct user_struct *next, *prev;
1314 uint16 vuid; /* Tag for this entry. */
1316 char *session_keystr; /* used by utmp and pam session code.
1317 TDB key string */
1318 int homes_snum;
1320 struct auth_session_info *session_info;
1322 struct auth_ntlmssp_state *auth_ntlmssp_state;
1323 } user_struct;
1326 Do you want session setups at user level security with a invalid
1327 password to be rejected or allowed in as guest? WinNT rejects them
1328 but it can be a pain as it means "net view" needs to use a password
1330 You have 3 choices in the setting of map_to_guest:
1332 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1333 are rejected. This is the default.
1335 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1336 are rejected, unless the username does not exist, in which case it
1337 is treated as a guest login
1339 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1340 are treated as a guest login
1342 Note that map_to_guest only has an effect in user or server
1343 level security.
1346 #define NEVER_MAP_TO_GUEST 0
1347 #define MAP_TO_GUEST_ON_BAD_USER 1
1348 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1349 #define MAP_TO_GUEST_ON_BAD_UID 3
1351 #define SAFE_NETBIOS_CHARS ". -_"
1353 /* The maximum length of a trust account password.
1354 Used when we randomly create it, 15 char passwords
1355 exceed NT4's max password length */
1357 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1359 #define PORT_NONE 0
1360 #ifndef LDAP_PORT
1361 #define LDAP_PORT 389
1362 #endif
1363 #define LDAP_GC_PORT 3268
1365 /* used by the IP comparison function */
1366 struct ip_service {
1367 struct sockaddr_storage ss;
1368 unsigned port;
1371 struct ea_struct {
1372 uint8 flags;
1373 char *name;
1374 DATA_BLOB value;
1377 struct ea_list {
1378 struct ea_list *next, *prev;
1379 struct ea_struct ea;
1382 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1383 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1384 /* EA to use for DOS attributes */
1385 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1386 /* Prefix for DosStreams in the vfs_streams_xattr module */
1387 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1388 /* Prefix for xattrs storing streams. */
1389 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1391 /* map readonly options */
1392 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1394 /* usershare error codes. */
1395 enum usershare_err {
1396 USERSHARE_OK=0,
1397 USERSHARE_MALFORMED_FILE,
1398 USERSHARE_BAD_VERSION,
1399 USERSHARE_MALFORMED_PATH,
1400 USERSHARE_MALFORMED_COMMENT_DEF,
1401 USERSHARE_MALFORMED_ACL_DEF,
1402 USERSHARE_ACL_ERR,
1403 USERSHARE_PATH_NOT_ABSOLUTE,
1404 USERSHARE_PATH_IS_DENIED,
1405 USERSHARE_PATH_NOT_ALLOWED,
1406 USERSHARE_PATH_NOT_DIRECTORY,
1407 USERSHARE_POSIX_ERR,
1408 USERSHARE_MALFORMED_SHARENAME_DEF,
1409 USERSHARE_BAD_SHARENAME
1412 /* Different reasons for closing a file. */
1413 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1415 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1416 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1417 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1418 struct smb_extended_info {
1419 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1420 uint32 samba_version; /* Major/Minor/Release/Revision */
1421 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1422 NTTIME samba_gitcommitdate;
1423 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1426 /* time info */
1427 struct smb_file_time {
1428 struct timespec mtime;
1429 struct timespec atime;
1430 struct timespec ctime;
1431 struct timespec create_time;
1435 * unix_convert_flags
1437 #define UCF_SAVE_LCOMP 0x00000001
1438 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1439 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1440 #define UCF_POSIX_PATHNAMES 0x00000008
1441 #define UCF_UNIX_NAME_LOOKUP 0x00000010
1444 * smb_filename
1446 struct smb_filename {
1447 char *base_name;
1448 char *stream_name;
1449 char *original_lcomp;
1450 SMB_STRUCT_STAT st;
1453 /* struct for maintaining the child processes that get spawned from smbd */
1454 struct child_pid {
1455 struct child_pid *prev, *next;
1456 pid_t pid;
1459 /* Used to keep track of deferred opens. */
1460 struct deferred_open_record;
1462 /* Used inside aio code. */
1463 struct aio_extra;
1466 * Reasons for cache flush.
1469 enum flush_reason_enum {
1470 SEEK_FLUSH,
1471 READ_FLUSH,
1472 WRITE_FLUSH,
1473 READRAW_FLUSH,
1474 OPLOCK_RELEASE_FLUSH,
1475 CLOSE_FLUSH,
1476 SYNC_FLUSH,
1477 SIZECHANGE_FLUSH,
1478 /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */
1479 NUM_FLUSH_REASONS};
1481 #endif /* _SMB_H */