s3:auth fix info3 duplication function
[Samba/ekacnet.git] / source3 / include / smb.h
bloba93caa7bf1b5120de04e67f77b41e2020d6f1b39
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-2010"
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 /* Debugging stuff */
72 #include "debug.h"
74 /* this defines the error codes that receive_smb can put in smb_read_error */
75 enum smb_read_errors {
76 SMB_READ_OK = 0,
77 SMB_READ_TIMEOUT,
78 SMB_READ_EOF,
79 SMB_READ_ERROR,
80 SMB_WRITE_ERROR, /* This error code can go into the client smb_rw_error. */
81 SMB_READ_BAD_SIG,
82 SMB_NO_MEMORY,
83 SMB_DO_NOT_DO_TDIS, /* cli_close_connection() check for this when smbfs wants to keep tree connected */
84 SMB_READ_BAD_DECRYPT
87 #define DIR_STRUCT_SIZE 43
89 /* these define the attribute byte as seen by DOS */
90 #define aRONLY (1L<<0) /* 0x01 */
91 #define aHIDDEN (1L<<1) /* 0x02 */
92 #define aSYSTEM (1L<<2) /* 0x04 */
93 #define aVOLID (1L<<3) /* 0x08 */
94 #define aDIR (1L<<4) /* 0x10 */
95 #define aARCH (1L<<5) /* 0x20 */
97 /* deny modes */
98 #define DENY_DOS 0
99 #define DENY_ALL 1
100 #define DENY_WRITE 2
101 #define DENY_READ 3
102 #define DENY_NONE 4
103 #define DENY_FCB 7
105 /* open modes */
106 #define DOS_OPEN_RDONLY 0
107 #define DOS_OPEN_WRONLY 1
108 #define DOS_OPEN_RDWR 2
109 #define DOS_OPEN_EXEC 3
110 #define DOS_OPEN_FCB 0xF
112 /* define shifts and masks for share and open modes. */
113 #define OPENX_MODE_MASK 0xF
114 #define DENY_MODE_SHIFT 4
115 #define DENY_MODE_MASK 0x7
116 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
117 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
118 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
119 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
121 /* Sync on open file (not sure if used anymore... ?) */
122 #define FILE_SYNC_OPENMODE (1<<14)
123 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
125 /* open disposition values */
126 #define OPENX_FILE_EXISTS_FAIL 0
127 #define OPENX_FILE_EXISTS_OPEN 1
128 #define OPENX_FILE_EXISTS_TRUNCATE 2
130 /* mask for open disposition. */
131 #define OPENX_FILE_OPEN_MASK 0x3
133 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
134 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
136 /* The above can be OR'ed with... */
137 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
138 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
140 #include "../libcli/util/doserr.h"
142 typedef union unid_t {
143 uid_t uid;
144 gid_t gid;
145 } unid_t;
148 * SMB UCS2 (16-bit unicode) internal type.
149 * smb_ucs2_t is *always* in little endian format.
152 #ifdef WORDS_BIGENDIAN
153 #define UCS2_SHIFT 8
154 #else
155 #define UCS2_SHIFT 0
156 #endif
158 /* turn a 7 bit character into a ucs2 character */
159 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
161 /* return an ascii version of a ucs2 character */
162 #define UCS2_TO_CHAR(c) (((c) >> UCS2_SHIFT) & 0xff)
164 /* Copy into a smb_ucs2_t from a possibly unaligned buffer. Return the copied smb_ucs2_t */
165 #define COPY_UCS2_CHAR(dest,src) (((unsigned char *)(dest))[0] = ((unsigned char *)(src))[0],\
166 ((unsigned char *)(dest))[1] = ((unsigned char *)(src))[1], (dest))
168 /* pipe string names */
169 #define PIPE_LANMAN "\\PIPE\\LANMAN"
171 #define MAX_HOURS_LEN 32
173 #ifndef MAXSUBAUTHS
174 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
175 #endif
177 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
179 #define LOOKUP_NAME_NONE 0x00000000
180 #define LOOKUP_NAME_ISOLATED 0x00000001 /* Look up unqualified names */
181 #define LOOKUP_NAME_REMOTE 0x00000002 /* Ask others */
182 #define LOOKUP_NAME_GROUP 0x00000004 /* (unused) This is a NASTY hack for
183 valid users = @foo where foo also
184 exists in as user. */
185 #define LOOKUP_NAME_NO_NSS 0x00000008 /* no NSS calls to avoid
186 winbind recursions */
187 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
188 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
189 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
190 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
191 |LOOKUP_NAME_BUILTIN\
192 |LOOKUP_NAME_WKN\
193 |LOOKUP_NAME_DOMAIN)
194 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
195 |LOOKUP_NAME_REMOTE\
196 |LOOKUP_NAME_BUILTIN\
197 |LOOKUP_NAME_WKN\
198 |LOOKUP_NAME_DOMAIN)
200 enum id_mapping {
201 ID_UNKNOWN = 0,
202 ID_MAPPED,
203 ID_UNMAPPED,
204 ID_EXPIRED
207 enum id_type {
208 ID_TYPE_NOT_SPECIFIED = 0,
209 ID_TYPE_UID,
210 ID_TYPE_GID
213 struct unixid {
214 uint32_t id;
215 enum id_type type;
218 struct id_map {
219 struct dom_sid *sid;
220 struct unixid xid;
221 enum id_mapping status;
224 #include "librpc/gen_ndr/epmapper.h"
225 #include "librpc/gen_ndr/krb5pac.h"
226 #include "librpc/gen_ndr/dcerpc.h"
228 struct lsa_dom_info {
229 bool valid;
230 struct dom_sid sid;
231 const char *name;
232 int num_idxs;
233 int *idxs;
236 struct lsa_name_info {
237 uint32 rid;
238 enum lsa_SidType type;
239 const char *name;
240 int dom_idx;
243 /* Some well-known SIDs */
244 extern const struct dom_sid global_sid_World_Domain;
245 extern const struct dom_sid global_sid_World;
246 extern const struct dom_sid global_sid_Creator_Owner_Domain;
247 extern const struct dom_sid global_sid_NT_Authority;
248 extern const struct dom_sid global_sid_System;
249 extern const struct dom_sid global_sid_NULL;
250 extern const struct dom_sid global_sid_Authenticated_Users;
251 extern const struct dom_sid global_sid_Network;
252 extern const struct dom_sid global_sid_Creator_Owner;
253 extern const struct dom_sid global_sid_Creator_Group;
254 extern const struct dom_sid global_sid_Anonymous;
255 extern const struct dom_sid global_sid_Builtin;
256 extern const struct dom_sid global_sid_Builtin_Administrators;
257 extern const struct dom_sid global_sid_Builtin_Users;
258 extern const struct dom_sid global_sid_Builtin_Guests;
259 extern const struct dom_sid global_sid_Builtin_Power_Users;
260 extern const struct dom_sid global_sid_Builtin_Account_Operators;
261 extern const struct dom_sid global_sid_Builtin_Server_Operators;
262 extern const struct dom_sid global_sid_Builtin_Print_Operators;
263 extern const struct dom_sid global_sid_Builtin_Backup_Operators;
264 extern const struct dom_sid global_sid_Builtin_Replicator;
265 extern const struct dom_sid global_sid_Builtin_PreWin2kAccess;
266 extern const struct dom_sid global_sid_Unix_Users;
267 extern const struct dom_sid global_sid_Unix_Groups;
270 * The complete list of SIDS belonging to this user.
271 * Created when a vuid is registered.
272 * The definition of the user_sids array is as follows :
274 * token->user_sids[0] = primary user SID.
275 * token->user_sids[1] = primary group SID.
276 * token->user_sids[2..num_sids] = supplementary group SIDS.
279 #define PRIMARY_USER_SID_INDEX 0
280 #define PRIMARY_GROUP_SID_INDEX 1
282 typedef struct nt_user_token {
283 size_t num_sids;
284 struct dom_sid *user_sids;
285 SE_PRIV privileges;
286 } NT_USER_TOKEN;
288 typedef struct unix_user_token {
289 uid_t uid;
290 gid_t gid;
291 size_t ngroups;
292 gid_t *groups;
293 } UNIX_USER_TOKEN;
295 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
296 typedef struct time_info {
297 uint32 time;
298 } UTIME;
300 typedef struct write_cache {
301 SMB_OFF_T file_size;
302 SMB_OFF_T offset;
303 size_t alloc_size;
304 size_t data_size;
305 char *data;
306 } write_cache;
308 #include "fake_file.h"
310 struct fd_handle {
311 size_t ref_count;
312 int fd;
313 uint64_t position_information;
314 SMB_OFF_T pos;
315 uint32 private_options; /* NT Create options, but we only look at
316 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
317 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
318 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
319 * for print files *only*, where
320 * DELETE_ON_CLOSE is not stored in the share
321 * mode database.
323 unsigned long gen_id;
326 struct idle_event;
327 struct share_mode_entry;
328 struct uuid;
329 struct named_mutex;
330 struct wb_context;
331 struct rpc_cli_smbd_conn;
332 struct fncall_context;
334 struct vfs_fsp_data {
335 struct vfs_fsp_data *next;
336 struct vfs_handle_struct *owner;
337 void (*destroy)(void *p_data);
338 void *_dummy_;
339 /* NOTE: This structure contains four pointers so that we can guarantee
340 * that the end of the structure is always both 4-byte and 8-byte aligned.
344 /* the basic packet size, assuming no words or bytes */
345 #define smb_size 39
347 struct notify_change {
348 uint32_t action;
349 const char *name;
352 struct notify_mid_map;
353 struct notify_entry;
354 struct notify_event;
355 struct notify_change_request;
356 struct sys_notify_backend;
357 struct sys_notify_context {
358 struct event_context *ev;
359 struct connection_struct *conn;
360 void *private_data; /* For use by the system backend */
363 struct notify_change_buf {
365 * If no requests are pending, changes are queued here. Simple array,
366 * we only append.
370 * num_changes == -1 means that we have got a catch-all change, when
371 * asked we just return NT_STATUS_OK without specific changes.
373 int num_changes;
374 struct notify_change *changes;
377 * If no changes are around requests are queued here. Using a linked
378 * list, because we have to append at the end and delete from the top.
380 struct notify_change_request *requests;
383 struct print_file_data {
384 uint16 rap_jobid;
387 typedef struct files_struct {
388 struct files_struct *next, *prev;
389 int fnum;
390 struct connection_struct *conn;
391 struct fd_handle *fh;
392 unsigned int num_smb_operations;
393 struct file_id file_id;
394 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
395 mode_t mode;
396 uint16 file_pid;
397 uint16 vuid;
398 write_cache *wcp;
399 struct timeval open_time;
400 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
401 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
403 bool update_write_time_triggered;
404 struct timed_event *update_write_time_event;
405 bool update_write_time_on_close;
406 struct timespec close_write_time;
407 bool write_time_forced;
409 int oplock_type;
410 int sent_oplock_break;
411 struct timed_event *oplock_timeout;
412 struct lock_struct last_lock_failure;
413 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
415 struct share_mode_entry *pending_break_messages;
416 int num_pending_break_messages;
418 bool can_lock;
419 bool can_read;
420 bool can_write;
421 bool modified;
422 bool is_directory;
423 bool aio_write_behind;
424 bool lockdb_clean;
425 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
426 bool delete_on_close;
427 bool posix_open;
428 struct smb_filename *fsp_name;
430 struct vfs_fsp_data *vfs_extension;
431 struct fake_file_handle *fake_file_handle;
433 struct notify_change_buf *notify;
435 struct files_struct *base_fsp; /* placeholder for delete on close */
438 * Read-only cached brlock record, thrown away when the
439 * brlock.tdb seqnum changes. This avoids fetching data from
440 * the brlock.tdb on every read/write call.
442 int brlock_seqnum;
443 struct byte_range_lock *brlock_rec;
445 struct dptr_struct *dptr;
447 /* if not NULL, means this is a print file */
448 struct print_file_data *print_file;
450 } files_struct;
452 #include "ntquotas.h"
453 #include "sysquotas.h"
455 struct vuid_cache_entry {
456 struct auth_serversupplied_info *server_info;
457 uint16_t vuid;
458 bool read_only;
461 struct vuid_cache {
462 unsigned int next_entry;
463 struct vuid_cache_entry array[VUID_CACHE_SIZE];
466 typedef struct {
467 char *name;
468 bool is_wild;
469 } name_compare_entry;
471 struct trans_state {
472 struct trans_state *next, *prev;
473 uint16 vuid;
474 uint64_t mid;
476 uint32 max_param_return;
477 uint32 max_data_return;
478 uint32 max_setup_return;
480 uint8 cmd; /* SMBtrans or SMBtrans2 */
482 char *name; /* for trans requests */
483 uint16 call; /* for trans2 and nttrans requests */
485 bool close_on_completion;
486 bool one_way;
488 unsigned int setup_count;
489 uint16 *setup;
491 size_t received_data;
492 size_t received_param;
494 size_t total_param;
495 char *param;
497 size_t total_data;
498 char *data;
502 * Info about an alternate data stream
505 struct stream_struct {
506 SMB_OFF_T size;
507 SMB_OFF_T alloc_size;
508 char *name;
511 /* Include VFS stuff */
513 #include "smb_acls.h"
514 #include "vfs.h"
516 struct dfree_cached_info {
517 time_t last_dfree_time;
518 uint64_t dfree_ret;
519 uint64_t bsize;
520 uint64_t dfree;
521 uint64_t dsize;
524 struct dptr_struct;
526 struct share_params {
527 int service;
530 struct share_iterator {
531 int next_id;
534 typedef struct connection_struct {
535 struct connection_struct *next, *prev;
536 struct smbd_server_connection *sconn; /* can be NULL */
537 unsigned cnum; /* an index passed over the wire */
538 struct share_params *params;
539 bool force_user;
540 struct vuid_cache vuid_cache;
541 bool printer;
542 bool ipc;
543 bool read_only; /* Attributes for the current user of the share. */
544 /* Does this filesystem honor
545 sub second timestamps on files
546 and directories when setting time ? */
547 enum timestamp_set_resolution ts_res;
548 char *connectpath;
549 char *origpath;
551 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
554 * This represents the user information on this connection. Depending
555 * on the vuid using this tid, this might change per SMB request.
557 struct auth_serversupplied_info *server_info;
560 * If the "force group" parameter is set, this is the primary gid that
561 * may be used in the users token, depending on the vuid using this tid.
563 gid_t force_group_gid;
565 char client_address[INET6_ADDRSTRLEN]; /* String version of client IP address. */
567 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
569 time_t lastused;
570 time_t lastused_count;
571 bool used;
572 int num_files_open;
573 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
574 int encrypt_level;
575 bool encrypted_tid;
577 /* Semantics requested by the client or forced by the server config. */
578 bool case_sensitive;
579 bool case_preserve;
580 bool short_case_preserve;
582 /* Semantics provided by the underlying filesystem. */
583 int fs_capabilities;
584 /* Device number of the directory of the share mount.
585 Used to ensure unique FileIndex returns. */
586 SMB_DEV_T base_share_dev;
588 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
589 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
590 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
591 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
592 struct dfree_cached_info *dfree_info;
593 struct trans_state *pending_trans;
594 struct notify_context *notify_ctx;
596 struct rpc_pipe_client *spoolss_pipe;
598 } connection_struct;
600 struct current_user {
601 connection_struct *conn;
602 uint16 vuid;
603 UNIX_USER_TOKEN ut;
604 NT_USER_TOKEN *nt_user_token;
607 struct smbd_smb2_request;
609 struct smb_request {
610 uint8_t cmd;
611 uint16 flags2;
612 uint16 smbpid;
613 uint64_t mid; /* For compatibility with SMB2. */
614 uint32_t seqnum;
615 uint16 vuid;
616 uint16 tid;
617 uint8 wct;
618 uint16_t *vwv;
619 uint16_t buflen;
620 const uint8_t *buf;
621 const uint8 *inbuf;
624 * Async handling in the main smb processing loop is directed by
625 * outbuf: reply_xxx routines indicate sync behaviour by putting their
626 * reply into "outbuf". If they leave it as NULL, they take of it
627 * themselves, possibly later.
629 * If async handling is wanted, the reply_xxx routine must make sure
630 * that it talloc_move()s the smb_req somewhere else.
632 uint8 *outbuf;
634 size_t unread_bytes;
635 bool encrypted;
636 connection_struct *conn;
637 struct smb_perfcount_data pcd;
640 * Chained request handling
642 struct files_struct *chain_fsp;
645 * Here we collect the outbufs from the chain handlers
647 uint8_t *chain_outbuf;
650 * state information for async smb handling
652 void *async_priv;
654 bool done;
657 * Back pointer to smb2 request.
659 struct smbd_smb2_request *smb2req;
662 /* Defines for the sent_oplock_break field above. */
663 #define NO_BREAK_SENT 0
664 #define BREAK_TO_NONE_SENT 1
665 #define LEVEL_II_BREAK_SENT 2
667 typedef struct {
668 fstring smb_name; /* user name from the client */
669 fstring unix_name; /* unix user name of a validated user */
670 fstring domain; /* domain that the client specified */
671 } userdom_struct;
673 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
675 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
676 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
678 typedef struct _print_queue_struct {
679 int job; /* normally the UNIX jobid -- see note in
680 printing.c:traverse_fn_delete() */
681 int size;
682 int page_count;
683 int status;
684 int priority;
685 time_t time;
686 fstring fs_user;
687 fstring fs_file;
688 } print_queue_struct;
690 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
692 typedef struct {
693 fstring message;
694 int qcount;
695 int status;
696 } print_status_struct;
698 /* used for server information: client, nameserv and ipc */
699 struct server_info_struct {
700 fstring name;
701 uint32 type;
702 fstring comment;
703 fstring domain; /* used ONLY in ipc.c NOT namework.c */
704 bool server_added; /* used ONLY in ipc.c NOT namework.c */
707 /* used for network interfaces */
708 struct interface {
709 struct interface *next, *prev;
710 char *name;
711 int flags;
712 struct sockaddr_storage ip;
713 struct sockaddr_storage netmask;
714 struct sockaddr_storage bcast;
717 /* Internal message queue for deferred opens. */
718 struct pending_message_list {
719 struct pending_message_list *next, *prev;
720 struct timeval request_time; /* When was this first issued? */
721 struct timed_event *te;
722 struct smb_perfcount_data pcd;
723 uint32_t seqnum;
724 bool encrypted;
725 bool processed;
726 DATA_BLOB buf;
727 DATA_BLOB private_data;
730 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
732 /* struct returned by get_share_modes */
733 struct share_mode_entry {
734 struct server_id pid;
735 uint64_t op_mid; /* For compatibility with SMB2 opens. */
736 uint16 op_type;
737 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
738 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
739 uint32 private_options; /* NT Create options, but we only look at
740 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
741 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
742 * smbstatus and swat */
743 struct timeval time;
744 struct file_id id;
745 unsigned long share_file_id;
746 uint32 uid; /* uid of file opener. */
747 uint16 flags; /* See SHARE_MODE_XX above. */
750 /* oplock break message definition - linearization of share_mode_entry.
752 Offset Data length.
753 0 struct server_id pid 4
754 4 uint16 op_mid 8
755 12 uint16 op_type 2
756 14 uint32 access_mask 4
757 18 uint32 share_access 4
758 22 uint32 private_options 4
759 26 uint32 time sec 4
760 30 uint32 time usec 4
761 34 uint64 dev 8 bytes
762 42 uint64 inode 8 bytes
763 50 uint64 extid 8 bytes
764 58 unsigned long file_id 4 bytes
765 62 uint32 uid 4 bytes
766 66 uint16 flags 2 bytes
771 #define OP_BREAK_MSG_PID_OFFSET 0
772 #define OP_BREAK_MSG_MID_OFFSET 4
773 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
774 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
775 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
776 #define OP_BREAK_MSG_PRIV_OFFSET 22
777 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
778 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
779 #define OP_BREAK_MSG_DEV_OFFSET 34
780 #define OP_BREAK_MSG_INO_OFFSET 42
781 #define OP_BREAK_MSG_EXTID_OFFSET 50
782 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
783 #define OP_BREAK_MSG_UID_OFFSET 62
784 #define OP_BREAK_MSG_FLAGS_OFFSET 66
786 #ifdef CLUSTER_SUPPORT
787 #define OP_BREAK_MSG_VNN_OFFSET 68
788 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 72
789 #else
790 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 68
791 #endif
793 struct share_mode_lock {
794 const char *servicepath; /* canonicalized. */
795 const char *base_name;
796 const char *stream_name;
797 struct file_id id;
798 int num_share_modes;
799 struct share_mode_entry *share_modes;
800 UNIX_USER_TOKEN *delete_token;
801 bool delete_on_close;
802 struct timespec old_write_time;
803 struct timespec changed_write_time;
804 bool fresh;
805 bool modified;
806 struct db_record *record;
810 * Internal structure of locking.tdb share mode db.
811 * Used by locking.c and libsmbsharemodes.c
814 struct locking_data {
815 union {
816 struct {
817 int num_share_mode_entries;
818 bool delete_on_close;
819 struct timespec old_write_time;
820 struct timespec changed_write_time;
821 uint32 delete_token_size; /* Only valid if either of
822 the two previous fields
823 are True. */
824 } s;
825 struct share_mode_entry dummy; /* Needed for alignment. */
826 } u;
827 /* The following four entries are implicit
828 struct share_mode_entry modes[num_share_mode_entries];
829 char unix_token[delete_token_size] (divisible by 4).
830 char share_name[];
831 char file_name[];
835 /* Used to store pipe open records for NetFileEnum() */
837 struct pipe_open_rec {
838 struct server_id pid;
839 uid_t uid;
840 int pnum;
841 fstring name;
845 #define NT_HASH_LEN 16
846 #define LM_HASH_LEN 16
848 /* Password history contants. */
849 #define PW_HISTORY_SALT_LEN 16
850 #define SALTED_MD5_HASH_LEN 16
851 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
852 #define MAX_PW_HISTORY_LEN 24
855 * Flags for local user manipulation.
858 #define LOCAL_ADD_USER 0x1
859 #define LOCAL_DELETE_USER 0x2
860 #define LOCAL_DISABLE_USER 0x4
861 #define LOCAL_ENABLE_USER 0x8
862 #define LOCAL_TRUST_ACCOUNT 0x10
863 #define LOCAL_SET_NO_PASSWORD 0x20
864 #define LOCAL_SET_PASSWORD 0x40
865 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
866 #define LOCAL_INTERDOM_ACCOUNT 0x100
867 #define LOCAL_AM_ROOT 0x200 /* Act as root */
869 /* key and data in the connections database - used in smbstatus and smbd */
870 struct connections_key {
871 struct server_id pid;
872 int cnum;
873 fstring name;
876 struct connections_data {
877 int magic;
878 struct server_id pid;
879 int cnum;
880 uid_t uid;
881 gid_t gid;
882 char servicename[FSTRING_LEN];
883 char addr[24];
884 char machine[FSTRING_LEN];
885 time_t start;
886 uint32 bcast_msg_flags;
890 /* the following are used by loadparm for option lists */
891 typedef enum {
892 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
893 P_STRING,P_USTRING,P_ENUM,P_SEP
894 } parm_type;
896 typedef enum {
897 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
898 } parm_class;
900 struct enum_list {
901 int value;
902 const char *name;
905 struct parm_struct {
906 const char *label;
907 parm_type type;
908 parm_class p_class;
909 void *ptr;
910 bool (*special)(int snum, const char *, char **);
911 const struct enum_list *enum_list;
912 unsigned flags;
913 union {
914 bool bvalue;
915 int ivalue;
916 char *svalue;
917 char cvalue;
918 char **lvalue;
919 } def;
922 /* The following flags are used in SWAT */
923 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
924 #define FLAG_SHARE 0x0002 /* file sharing options */
925 #define FLAG_PRINT 0x0004 /* printing options */
926 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
927 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
928 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
929 #define FLAG_DEVELOPER 0x0040 /* No longer used */
930 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
931 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
932 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
933 #define FLAG_META 0x8000 /* A meta directive - not a real parameter */
935 struct bitmap {
936 uint32 *b;
937 unsigned int n;
940 /* offsets into message for common items */
941 #define smb_com 8
942 #define smb_rcls 9
943 #define smb_reh 10
944 #define smb_err 11
945 #define smb_flg 13
946 #define smb_flg2 14
947 #define smb_pidhigh 16
948 #define smb_ss_field 18
949 #define smb_tid 28
950 #define smb_pid 30
951 #define smb_uid 32
952 #define smb_mid 34
953 #define smb_wct 36
954 #define smb_vwv 37
955 #define smb_vwv0 37
956 #define smb_vwv1 39
957 #define smb_vwv2 41
958 #define smb_vwv3 43
959 #define smb_vwv4 45
960 #define smb_vwv5 47
961 #define smb_vwv6 49
962 #define smb_vwv7 51
963 #define smb_vwv8 53
964 #define smb_vwv9 55
965 #define smb_vwv10 57
966 #define smb_vwv11 59
967 #define smb_vwv12 61
968 #define smb_vwv13 63
969 #define smb_vwv14 65
970 #define smb_vwv15 67
971 #define smb_vwv16 69
972 #define smb_vwv17 71
974 /* flag defines. CIFS spec 3.1.1 */
975 #define FLAG_SUPPORT_LOCKREAD 0x01
976 #define FLAG_CLIENT_BUF_AVAIL 0x02
977 #define FLAG_RESERVED 0x04
978 #define FLAG_CASELESS_PATHNAMES 0x08
979 #define FLAG_CANONICAL_PATHNAMES 0x10
980 #define FLAG_REQUEST_OPLOCK 0x20
981 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
982 #define FLAG_REPLY 0x80
984 /* the complete */
985 #define SMBmkdir 0x00 /* create directory */
986 #define SMBrmdir 0x01 /* delete directory */
987 #define SMBopen 0x02 /* open file */
988 #define SMBcreate 0x03 /* create file */
989 #define SMBclose 0x04 /* close file */
990 #define SMBflush 0x05 /* flush file */
991 #define SMBunlink 0x06 /* delete file */
992 #define SMBmv 0x07 /* rename file */
993 #define SMBgetatr 0x08 /* get file attributes */
994 #define SMBsetatr 0x09 /* set file attributes */
995 #define SMBread 0x0A /* read from file */
996 #define SMBwrite 0x0B /* write to file */
997 #define SMBlock 0x0C /* lock byte range */
998 #define SMBunlock 0x0D /* unlock byte range */
999 #define SMBctemp 0x0E /* create temporary file */
1000 #define SMBmknew 0x0F /* make new file */
1001 #define SMBcheckpath 0x10 /* check directory path */
1002 #define SMBexit 0x11 /* process exit */
1003 #define SMBlseek 0x12 /* seek */
1004 #define SMBtcon 0x70 /* tree connect */
1005 #define SMBtconX 0x75 /* tree connect and X*/
1006 #define SMBtdis 0x71 /* tree disconnect */
1007 #define SMBnegprot 0x72 /* negotiate protocol */
1008 #define SMBdskattr 0x80 /* get disk attributes */
1009 #define SMBsearch 0x81 /* search directory */
1010 #define SMBsplopen 0xC0 /* open print spool file */
1011 #define SMBsplwr 0xC1 /* write to print spool file */
1012 #define SMBsplclose 0xC2 /* close print spool file */
1013 #define SMBsplretq 0xC3 /* return print queue */
1014 #define SMBsends 0xD0 /* send single block message */
1015 #define SMBsendb 0xD1 /* send broadcast message */
1016 #define SMBfwdname 0xD2 /* forward user name */
1017 #define SMBcancelf 0xD3 /* cancel forward */
1018 #define SMBgetmac 0xD4 /* get machine name */
1019 #define SMBsendstrt 0xD5 /* send start of multi-block message */
1020 #define SMBsendend 0xD6 /* send end of multi-block message */
1021 #define SMBsendtxt 0xD7 /* send text of multi-block message */
1023 /* Core+ protocol */
1024 #define SMBlockread 0x13 /* Lock a range and read */
1025 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1026 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
1027 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
1028 #define SMBwritec 0x20 /* secondary write request */
1029 #define SMBwriteclose 0x2c /* write a file then close it */
1031 /* dos extended protocol */
1032 #define SMBreadBraw 0x1A /* read block raw */
1033 #define SMBreadBmpx 0x1B /* read block multiplexed */
1034 #define SMBreadBs 0x1C /* read block (secondary response) */
1035 #define SMBwriteBraw 0x1D /* write block raw */
1036 #define SMBwriteBmpx 0x1E /* write block multiplexed */
1037 #define SMBwriteBs 0x1F /* write block (secondary request) */
1038 #define SMBwriteC 0x20 /* write complete response */
1039 #define SMBsetattrE 0x22 /* set file attributes expanded */
1040 #define SMBgetattrE 0x23 /* get file attributes expanded */
1041 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
1042 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
1043 #define SMBtranss 0x26 /* transaction (secondary request/response) */
1044 #define SMBioctl 0x27 /* IOCTL */
1045 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
1046 #define SMBcopy 0x29 /* copy */
1047 #define SMBmove 0x2A /* move */
1048 #define SMBecho 0x2B /* echo */
1049 #define SMBopenX 0x2D /* open and X */
1050 #define SMBreadX 0x2E /* read and X */
1051 #define SMBwriteX 0x2F /* write and X */
1052 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
1053 #define SMBffirst 0x82 /* find first */
1054 #define SMBfunique 0x83 /* find unique */
1055 #define SMBfclose 0x84 /* find close */
1056 #define SMBkeepalive 0x85 /* keepalive */
1057 #define SMBinvalid 0xFE /* invalid command */
1059 /* Extended 2.0 protocol */
1060 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1061 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1062 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1063 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1064 #define SMBulogoffX 0x74 /* user logoff */
1066 /* NT SMB extensions. */
1067 #define SMBnttrans 0xA0 /* NT transact */
1068 #define SMBnttranss 0xA1 /* NT transact secondary */
1069 #define SMBntcreateX 0xA2 /* NT create and X */
1070 #define SMBntcancel 0xA4 /* NT cancel */
1071 #define SMBntrename 0xA5 /* NT rename */
1073 /* These are the trans subcommands */
1074 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
1075 #define TRANSACT_DCERPCCMD 0x26
1076 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1078 /* These are the TRANS2 sub commands */
1079 #define TRANSACT2_OPEN 0x00
1080 #define TRANSACT2_FINDFIRST 0x01
1081 #define TRANSACT2_FINDNEXT 0x02
1082 #define TRANSACT2_QFSINFO 0x03
1083 #define TRANSACT2_SETFSINFO 0x04
1084 #define TRANSACT2_QPATHINFO 0x05
1085 #define TRANSACT2_SETPATHINFO 0x06
1086 #define TRANSACT2_QFILEINFO 0x07
1087 #define TRANSACT2_SETFILEINFO 0x08
1088 #define TRANSACT2_FSCTL 0x09
1089 #define TRANSACT2_IOCTL 0x0A
1090 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1091 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1092 #define TRANSACT2_MKDIR 0x0D
1093 #define TRANSACT2_SESSION_SETUP 0x0E
1094 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1095 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1097 /* These are the NT transact sub commands. */
1098 #define NT_TRANSACT_CREATE 1
1099 #define NT_TRANSACT_IOCTL 2
1100 #define NT_TRANSACT_SET_SECURITY_DESC 3
1101 #define NT_TRANSACT_NOTIFY_CHANGE 4
1102 #define NT_TRANSACT_RENAME 5
1103 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1104 #define NT_TRANSACT_GET_USER_QUOTA 7
1105 #define NT_TRANSACT_SET_USER_QUOTA 8
1107 /* These are the NT transact_get_user_quota sub commands */
1108 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1109 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1110 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1112 /* Relevant IOCTL codes */
1113 #define IOCTL_QUERY_JOB_INFO 0x530060
1115 /* these are the trans2 sub fields for primary requests */
1116 #define smb_tpscnt smb_vwv0
1117 #define smb_tdscnt smb_vwv1
1118 #define smb_mprcnt smb_vwv2
1119 #define smb_mdrcnt smb_vwv3
1120 #define smb_msrcnt smb_vwv4
1121 #define smb_flags smb_vwv5
1122 #define smb_timeout smb_vwv6
1123 #define smb_pscnt smb_vwv9
1124 #define smb_psoff smb_vwv10
1125 #define smb_dscnt smb_vwv11
1126 #define smb_dsoff smb_vwv12
1127 #define smb_suwcnt smb_vwv13
1128 #define smb_setup smb_vwv14
1129 #define smb_setup0 smb_setup
1130 #define smb_setup1 (smb_setup+2)
1131 #define smb_setup2 (smb_setup+4)
1133 /* these are for the secondary requests */
1134 #define smb_spscnt smb_vwv2
1135 #define smb_spsoff smb_vwv3
1136 #define smb_spsdisp smb_vwv4
1137 #define smb_sdscnt smb_vwv5
1138 #define smb_sdsoff smb_vwv6
1139 #define smb_sdsdisp smb_vwv7
1140 #define smb_sfid smb_vwv8
1142 /* and these for responses */
1143 #define smb_tprcnt smb_vwv0
1144 #define smb_tdrcnt smb_vwv1
1145 #define smb_prcnt smb_vwv3
1146 #define smb_proff smb_vwv4
1147 #define smb_prdisp smb_vwv5
1148 #define smb_drcnt smb_vwv6
1149 #define smb_droff smb_vwv7
1150 #define smb_drdisp smb_vwv8
1152 /* these are for the NT trans primary request. */
1153 #define smb_nt_MaxSetupCount smb_vwv0
1154 #define smb_nt_Flags (smb_vwv0 + 1)
1155 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1156 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1157 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1158 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1159 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1160 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1161 #define smb_nt_DataCount (smb_vwv0 + 27)
1162 #define smb_nt_DataOffset (smb_vwv0 + 31)
1163 #define smb_nt_SetupCount (smb_vwv0 + 35)
1164 #define smb_nt_Function (smb_vwv0 + 36)
1165 #define smb_nt_SetupStart (smb_vwv0 + 38)
1167 /* these are for the NT trans secondary request. */
1168 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1169 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1170 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1171 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1172 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1173 #define smb_nts_DataCount (smb_vwv0 + 23)
1174 #define smb_nts_DataOffset (smb_vwv0 + 27)
1175 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1177 /* these are for the NT trans reply. */
1178 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1179 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1180 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1181 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1182 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1183 #define smb_ntr_DataCount (smb_vwv0 + 23)
1184 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1185 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1187 /* these are for the NT create_and_X */
1188 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1189 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1190 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1191 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1192 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1193 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1194 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1195 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1196 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1197 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1198 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1200 /* this is used on a TConX. I'm not sure the name is very helpful though */
1201 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1202 #define SMB_SHARE_IN_DFS 0x0002
1204 /* Named pipe write mode flags. Used in writeX calls. */
1205 #define PIPE_RAW_MODE 0x4
1206 #define PIPE_START_MESSAGE 0x8
1208 /* File Specific access rights */
1209 #define FILE_READ_DATA 0x00000001
1210 #define FILE_WRITE_DATA 0x00000002
1211 #define FILE_APPEND_DATA 0x00000004
1212 #define FILE_READ_EA 0x00000008 /* File and directory */
1213 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1214 #define FILE_EXECUTE 0x00000020
1215 #define FILE_DELETE_CHILD 0x00000040
1216 #define FILE_READ_ATTRIBUTES 0x00000080
1217 #define FILE_WRITE_ATTRIBUTES 0x00000100
1219 #define FILE_ALL_ACCESS 0x000001FF
1221 /* Directory specific access rights */
1222 #define FILE_LIST_DIRECTORY 0x00000001
1223 #define FILE_ADD_FILE 0x00000002
1224 #define FILE_ADD_SUBDIRECTORY 0x00000004
1225 #define FILE_TRAVERSE 0x00000020
1226 #define FILE_DELETE_CHILD 0x00000040
1228 /* the desired access to use when opening a pipe */
1229 #define DESIRED_ACCESS_PIPE 0x2019f
1231 /* Generic access masks & rights. */
1232 #define DELETE_ACCESS 0x00010000 /* (1L<<16) */
1233 #define READ_CONTROL_ACCESS 0x00020000 /* (1L<<17) */
1234 #define WRITE_DAC_ACCESS 0x00040000 /* (1L<<18) */
1235 #define WRITE_OWNER_ACCESS 0x00080000 /* (1L<<19) */
1236 #define SYNCHRONIZE_ACCESS 0x00100000 /* (1L<<20) */
1238 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1239 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1240 #define GENERIC_ALL_ACCESS 0x10000000 /* (1<<28) */
1241 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1242 #define GENERIC_WRITE_ACCESS 0x40000000 /* (1<<30) */
1243 #define GENERIC_READ_ACCESS ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1245 /* Mapping of generic access rights for files to specific rights. */
1247 /* This maps to 0x1F01FF */
1248 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS|\
1249 SYNCHRONIZE_ACCESS|\
1250 FILE_ALL_ACCESS)
1252 /* This maps to 0x120089 */
1253 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|\
1254 FILE_READ_DATA|\
1255 FILE_READ_ATTRIBUTES|\
1256 FILE_READ_EA|\
1257 SYNCHRONIZE_ACCESS)
1259 /* This maps to 0x120116 */
1260 #define FILE_GENERIC_WRITE (STD_RIGHT_READ_CONTROL_ACCESS|\
1261 FILE_WRITE_DATA|\
1262 FILE_WRITE_ATTRIBUTES|\
1263 FILE_WRITE_EA|\
1264 FILE_APPEND_DATA|\
1265 SYNCHRONIZE_ACCESS)
1267 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|\
1268 FILE_READ_ATTRIBUTES|\
1269 FILE_EXECUTE|\
1270 SYNCHRONIZE_ACCESS)
1272 /* Share specific rights. */
1273 #define SHARE_ALL_ACCESS FILE_GENERIC_ALL
1274 #define SHARE_READ_ONLY (FILE_GENERIC_READ|FILE_EXECUTE)
1276 /* Mapping of access rights to UNIX perms. */
1277 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1278 #define UNIX_ACCESS_R FILE_GENERIC_READ
1279 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1280 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1282 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1283 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1284 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1285 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1286 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1288 #if 0
1290 * This is the old mapping we used to use. To get W2KSP2 profiles
1291 * working we need to map to the canonical file perms.
1293 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1294 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1295 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1296 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1297 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1298 FILE_APPEND_DATA|FILE_WRITE_DATA)
1299 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1300 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1301 #endif
1303 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1305 /* Flags field. */
1306 #define REQUEST_OPLOCK 2
1307 #define REQUEST_BATCH_OPLOCK 4
1308 #define OPEN_DIRECTORY 8
1309 #define EXTENDED_RESPONSE_REQUIRED 0x10
1311 /* ShareAccess field. */
1312 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1313 #define FILE_SHARE_READ 1
1314 #define FILE_SHARE_WRITE 2
1315 #define FILE_SHARE_DELETE 4
1317 /* FileAttributesField */
1318 #define FILE_ATTRIBUTE_READONLY 0x001L
1319 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1320 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1321 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1322 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1323 #define FILE_ATTRIBUTE_NORMAL 0x080L
1324 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1325 #define FILE_ATTRIBUTE_SPARSE 0x200L
1326 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1327 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1328 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1329 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1330 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1331 #define SAMBA_ATTRIBUTES_MASK 0x7F
1333 /* Flags - combined with attributes. */
1334 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1335 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1336 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1337 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1338 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1339 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1340 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1342 /* CreateDisposition field. */
1343 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1344 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1345 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1346 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1347 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1348 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1350 /* CreateOptions field. */
1351 #define FILE_DIRECTORY_FILE 0x0001
1352 #define FILE_WRITE_THROUGH 0x0002
1353 #define FILE_SEQUENTIAL_ONLY 0x0004
1354 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1355 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
1356 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
1357 #define FILE_NON_DIRECTORY_FILE 0x0040
1358 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
1359 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
1360 #define FILE_NO_EA_KNOWLEDGE 0x0200
1361 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1362 #define FILE_RANDOM_ACCESS 0x0800
1363 #define FILE_DELETE_ON_CLOSE 0x1000
1364 #define FILE_OPEN_BY_FILE_ID 0x2000
1365 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
1366 #define FILE_NO_COMPRESSION 0x8000
1367 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
1368 #define FILE_OPEN_REPARSE_POINT 0x00200000
1369 #define FILE_OPEN_NO_RECALL 0x00400000
1370 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1372 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
1374 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
1377 * Private create options used by the ntcreatex processing code. From Samba4.
1378 * We reuse some ignored flags for private use. Passed in the private_flags
1379 * argument.
1381 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
1382 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
1384 /* Private options for streams support */
1385 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1387 /* Private options for printer support */
1388 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1390 /* Responses when opening a file. */
1391 #define FILE_WAS_SUPERSEDED 0
1392 #define FILE_WAS_OPENED 1
1393 #define FILE_WAS_CREATED 2
1394 #define FILE_WAS_OVERWRITTEN 3
1396 /* File type flags */
1397 #define FILE_TYPE_DISK 0
1398 #define FILE_TYPE_BYTE_MODE_PIPE 1
1399 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1400 #define FILE_TYPE_PRINTER 3
1401 #define FILE_TYPE_COMM_DEVICE 4
1402 #define FILE_TYPE_UNKNOWN 0xFFFF
1404 /* Flag for NT transact rename call. */
1405 #define RENAME_REPLACE_IF_EXISTS 1
1407 /* flags for SMBntrename call (from Samba4) */
1408 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1409 #define RENAME_FLAG_HARD_LINK 0x103
1410 #define RENAME_FLAG_RENAME 0x104
1411 #define RENAME_FLAG_COPY 0x105
1413 /* Filesystem Attributes. */
1414 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1415 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1416 #define FILE_UNICODE_ON_DISK 0x00000004
1417 /* According to cifs9f, this is 4, not 8 */
1418 /* Acconding to testing, this actually sets the security attribute! */
1419 #define FILE_PERSISTENT_ACLS 0x00000008
1420 #define FILE_FILE_COMPRESSION 0x00000010
1421 #define FILE_VOLUME_QUOTAS 0x00000020
1422 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1423 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1424 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1425 #define FS_LFN_APIS 0x00004000
1426 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1427 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1428 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1429 #define FILE_NAMED_STREAMS 0x00040000
1430 #define FILE_READ_ONLY_VOLUME 0x00080000
1432 /* ChangeNotify flags. */
1433 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1434 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1435 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1436 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1437 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1438 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1439 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1440 #define FILE_NOTIFY_CHANGE_EA 0x080
1441 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1442 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1443 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1444 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1446 #define FILE_NOTIFY_CHANGE_NAME \
1447 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1449 /* change notify action results */
1450 #define NOTIFY_ACTION_ADDED 1
1451 #define NOTIFY_ACTION_REMOVED 2
1452 #define NOTIFY_ACTION_MODIFIED 3
1453 #define NOTIFY_ACTION_OLD_NAME 4
1454 #define NOTIFY_ACTION_NEW_NAME 5
1455 #define NOTIFY_ACTION_ADDED_STREAM 6
1456 #define NOTIFY_ACTION_REMOVED_STREAM 7
1457 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1460 /* where to find the base of the SMB packet proper */
1461 #define smb_base(buf) (((char *)(buf))+4)
1463 /* we don't allow server strings to be longer than 48 characters as
1464 otherwise NT will not honour the announce packets */
1465 #define MAX_SERVER_STRING_LENGTH 48
1468 #define SMB_SUCCESS 0 /* The request was successful. */
1470 #ifdef WITH_DFS
1471 void dfs_unlogin(void);
1472 extern int dcelogin_atmost_once;
1473 #endif
1475 #ifdef NOSTRDUP
1476 char *strdup(char *s);
1477 #endif
1479 #ifndef SELECT_CAST
1480 #define SELECT_CAST
1481 #endif
1483 /* This was set by JHT in liaison with Jeremy Allison early 1997
1484 * History:
1485 * Version 4.0 - never made public
1486 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1487 * - Reappeared in 1.9.16p11 with fixed smbd services
1488 * Version 4.20 - To indicate that nmbd and browsing now works better
1489 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1491 * Note: In the presence of NT4.X do not set above 4.9
1492 * Setting this above 4.9 can have undesired side-effects.
1493 * This may change again in Samba-3.0 after further testing. JHT
1496 #define DEFAULT_MAJOR_VERSION 0x04
1497 #define DEFAULT_MINOR_VERSION 0x09
1499 /* Browser Election Values */
1500 #define BROWSER_ELECTION_VERSION 0x010f
1501 #define BROWSER_CONSTANT 0xaa55
1503 /* Sercurity mode bits. */
1504 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1505 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1506 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1507 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1509 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1511 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1512 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1513 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1514 #define FLAGS2_UNKNOWN_BIT4 0x0010
1515 #define FLAGS2_IS_LONG_NAME 0x0040
1516 #define FLAGS2_EXTENDED_SECURITY 0x0800
1517 #define FLAGS2_DFS_PATHNAMES 0x1000
1518 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1519 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1520 #define FLAGS2_UNICODE_STRINGS 0x8000
1522 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1524 /* TCONX Flag (smb_vwv2). */
1525 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1527 /* File Status Flags. See:
1529 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1532 #define NO_EAS 0x1
1533 #define NO_SUBSTREAMS 0x2
1534 #define NO_REPARSETAG 0x4
1536 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1538 #define CAP_RAW_MODE 0x0001
1539 #define CAP_MPX_MODE 0x0002
1540 #define CAP_UNICODE 0x0004
1541 #define CAP_LARGE_FILES 0x0008
1542 #define CAP_NT_SMBS 0x0010
1543 #define CAP_RPC_REMOTE_APIS 0x0020
1544 #define CAP_STATUS32 0x0040
1545 #define CAP_LEVEL_II_OPLOCKS 0x0080
1546 #define CAP_LOCK_AND_READ 0x0100
1547 #define CAP_NT_FIND 0x0200
1548 #define CAP_DFS 0x1000
1549 #define CAP_W2K_SMBS 0x2000
1550 #define CAP_LARGE_READX 0x4000
1551 #define CAP_LARGE_WRITEX 0x8000
1552 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1553 #define CAP_EXTENDED_SECURITY 0x80000000
1555 /* protocol types. It assumes that higher protocols include lower protocols
1556 as subsets */
1557 enum protocol_types {
1558 PROTOCOL_NONE,
1559 PROTOCOL_CORE,
1560 PROTOCOL_COREPLUS,
1561 PROTOCOL_LANMAN1,
1562 PROTOCOL_LANMAN2,
1563 PROTOCOL_NT1,
1564 PROTOCOL_SMB2
1567 /* security levels */
1568 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1570 /* server roles */
1571 enum server_types {
1572 ROLE_STANDALONE,
1573 ROLE_DOMAIN_MEMBER,
1574 ROLE_DOMAIN_BDC,
1575 ROLE_DOMAIN_PDC
1578 /* printing types */
1579 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1580 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1581 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1582 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1583 ,PRINT_TEST,PRINT_VLP
1584 #endif /* DEVELOPER */
1587 /* LDAP schema types */
1588 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1590 /* LDAP SSL options */
1591 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1593 /* LDAP PASSWD SYNC methods */
1594 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1596 /* Remote architectures we know about. */
1597 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1598 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1599 RA_SAMBA, RA_CIFSFS, RA_WINXP64};
1601 /* case handling */
1602 enum case_handling {CASE_LOWER,CASE_UPPER};
1604 /* ACL compatibility */
1605 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1607 * Global value meaing that the smb_uid field should be
1608 * ingored (in share level security and protocol level == CORE)
1611 #define UID_FIELD_INVALID 0
1612 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1615 * Size of buffer to use when moving files across filesystems.
1617 #define COPYBUF_SIZE (8*1024)
1620 * Map the Core and Extended Oplock requesst bits down
1621 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1625 * Core protocol.
1627 #define CORE_OPLOCK_REQUEST(inbuf) \
1628 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1631 * Extended protocol.
1633 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1635 /* Lock types. */
1636 #define LOCKING_ANDX_SHARED_LOCK 0x1
1637 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1638 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1639 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1640 #define LOCKING_ANDX_LARGE_FILES 0x10
1643 * Bits we test with.
1644 * Note these must fit into 16-bits.
1647 #define NO_OPLOCK 0x0
1648 #define EXCLUSIVE_OPLOCK 0x1
1649 #define BATCH_OPLOCK 0x2
1650 #define LEVEL_II_OPLOCK 0x4
1652 /* The following are Samba-private. */
1653 #define INTERNAL_OPEN_ONLY 0x8
1654 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1655 * inform potential level2 holders on
1656 * write. */
1657 #define DEFERRED_OPEN_ENTRY 0x20
1658 #define UNUSED_SHARE_MODE_ENTRY 0x40
1659 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1661 /* None of the following should ever appear in fsp->oplock_request. */
1662 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1664 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1665 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1666 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1668 /* kernel_oplock_message definition.
1670 struct kernel_oplock_message {
1671 uint64_t dev;
1672 uint64_t inode;
1673 unit64_t extid;
1674 unsigned long file_id;
1677 Offset Data length.
1678 0 uint64_t dev 8 bytes
1679 8 uint64_t inode 8 bytes
1680 16 uint64_t extid 8 bytes
1681 24 unsigned long file_id 4 bytes
1685 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1687 /* file_renamed_message definition.
1689 struct file_renamed_message {
1690 uint64_t dev;
1691 uint64_t inode;
1692 char names[1]; A variable area containing sharepath and filename.
1695 Offset Data length.
1696 0 uint64_t dev 8 bytes
1697 8 uint64_t inode 8 bytes
1698 16 unit64_t extid 8 bytes
1699 24 char [] name zero terminated namelen bytes
1700 minimum length == 24.
1704 #define MSG_FILE_RENAMED_MIN_SIZE 24
1707 * On the wire return values for oplock types.
1710 #define CORE_OPLOCK_GRANTED (1<<5)
1711 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1713 #define NO_OPLOCK_RETURN 0
1714 #define EXCLUSIVE_OPLOCK_RETURN 1
1715 #define BATCH_OPLOCK_RETURN 2
1716 #define LEVEL_II_OPLOCK_RETURN 3
1718 /* Oplock levels */
1719 #define OPLOCKLEVEL_NONE 0
1720 #define OPLOCKLEVEL_II 1
1723 * Capabilities abstracted for different systems.
1726 enum smbd_capability {
1727 KERNEL_OPLOCK_CAPABILITY,
1728 DMAPI_ACCESS_CAPABILITY,
1729 LEASE_CAPABILITY
1733 * Kernel oplocks capability flags.
1736 /* Level 2 oplocks are supported natively by kernel oplocks. */
1737 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
1739 /* The kernel notifies deferred openers when they can retry the open. */
1740 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
1742 /* The kernel notifies smbds when an oplock break times out. */
1743 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
1745 /* The kernel notifies smbds when an oplock is broken. */
1746 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
1748 struct kernel_oplocks_ops;
1749 struct kernel_oplocks {
1750 const struct kernel_oplocks_ops *ops;
1751 uint32_t flags;
1752 void *private_data;
1755 enum level2_contention_type {
1756 LEVEL2_CONTEND_ALLOC_SHRINK,
1757 LEVEL2_CONTEND_ALLOC_GROW,
1758 LEVEL2_CONTEND_SET_FILE_LEN,
1759 LEVEL2_CONTEND_FILL_SPARSE,
1760 LEVEL2_CONTEND_WRITE,
1761 LEVEL2_CONTEND_WINDOWS_BRL,
1762 LEVEL2_CONTEND_POSIX_BRL
1765 /* if a kernel does support oplocks then a structure of the following
1766 typee is used to describe how to interact with the kernel */
1767 struct kernel_oplocks_ops {
1768 bool (*set_oplock)(struct kernel_oplocks *ctx,
1769 files_struct *fsp, int oplock_type);
1770 void (*release_oplock)(struct kernel_oplocks *ctx,
1771 files_struct *fsp, int oplock_type);
1772 void (*contend_level2_oplocks_begin)(files_struct *fsp,
1773 enum level2_contention_type type);
1774 void (*contend_level2_oplocks_end)(files_struct *fsp,
1775 enum level2_contention_type type);
1778 #include "smb_macros.h"
1780 #define MAX_NETBIOSNAME_LEN 16
1781 /* DOS character, NetBIOS namestring. Type used on the wire. */
1782 typedef char nstring[MAX_NETBIOSNAME_LEN];
1783 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1784 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1786 /* A netbios name structure. */
1787 struct nmb_name {
1788 nstring name;
1789 char scope[64];
1790 unsigned int name_type;
1793 /* A netbios node status array element. */
1794 typedef struct node_status_ {
1795 nstring name;
1796 unsigned char type;
1797 unsigned char flags;
1798 } NODE_STATUS_STRUCT;
1800 /* The extra info from a NetBIOS node status query */
1801 struct node_status_extra {
1802 unsigned char mac_addr[6];
1803 /* There really is more here ... */
1806 typedef struct user_struct {
1807 struct user_struct *next, *prev;
1808 uint16 vuid; /* Tag for this entry. */
1810 char *session_keystr; /* used by utmp and pam session code.
1811 TDB key string */
1812 int homes_snum;
1814 struct auth_serversupplied_info *server_info;
1816 struct auth_ntlmssp_state *auth_ntlmssp_state;
1817 } user_struct;
1819 struct unix_error_map {
1820 int unix_error;
1821 int dos_class;
1822 int dos_code;
1823 NTSTATUS nt_error;
1827 * Size of new password account encoding string. This is enough space to
1828 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1829 * Do not change unless you are adding new ACB bits!
1832 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1835 Do you want session setups at user level security with a invalid
1836 password to be rejected or allowed in as guest? WinNT rejects them
1837 but it can be a pain as it means "net view" needs to use a password
1839 You have 3 choices in the setting of map_to_guest:
1841 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1842 are rejected. This is the default.
1844 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1845 are rejected, unless the username does not exist, in which case it
1846 is treated as a guest login
1848 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1849 are treated as a guest login
1851 Note that map_to_guest only has an effect in user or server
1852 level security.
1855 #define NEVER_MAP_TO_GUEST 0
1856 #define MAP_TO_GUEST_ON_BAD_USER 1
1857 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1858 #define MAP_TO_GUEST_ON_BAD_UID 3
1860 #define SAFE_NETBIOS_CHARS ". -_"
1862 /* The maximum length of a trust account password.
1863 Used when we randomly create it, 15 char passwords
1864 exceed NT4's max password length */
1866 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1868 #include "popt_common.h"
1870 #define PORT_NONE 0
1871 #ifndef LDAP_PORT
1872 #define LDAP_PORT 389
1873 #endif
1874 #define LDAP_GC_PORT 3268
1876 /* used by the IP comparison function */
1877 struct ip_service {
1878 struct sockaddr_storage ss;
1879 unsigned port;
1882 /* Special name type used to cause a _kerberos DNS lookup. */
1883 #define KDC_NAME_TYPE 0xDCDC
1885 struct ea_struct {
1886 uint8 flags;
1887 char *name;
1888 DATA_BLOB value;
1891 struct ea_list {
1892 struct ea_list *next, *prev;
1893 struct ea_struct ea;
1896 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1897 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1898 /* EA to use for DOS attributes */
1899 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1900 /* Prefix for DosStreams in the vfs_streams_xattr module */
1901 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1902 /* Prefix for xattrs storing streams. */
1903 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1905 #define UUID_SIZE 16
1907 #define UUID_FLAT_SIZE 16
1908 typedef struct uuid_flat {
1909 uint8 info[UUID_FLAT_SIZE];
1910 } UUID_FLAT;
1912 /* map readonly options */
1913 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1915 /* usershare error codes. */
1916 enum usershare_err {
1917 USERSHARE_OK=0,
1918 USERSHARE_MALFORMED_FILE,
1919 USERSHARE_BAD_VERSION,
1920 USERSHARE_MALFORMED_PATH,
1921 USERSHARE_MALFORMED_COMMENT_DEF,
1922 USERSHARE_MALFORMED_ACL_DEF,
1923 USERSHARE_ACL_ERR,
1924 USERSHARE_PATH_NOT_ABSOLUTE,
1925 USERSHARE_PATH_IS_DENIED,
1926 USERSHARE_PATH_NOT_ALLOWED,
1927 USERSHARE_PATH_NOT_DIRECTORY,
1928 USERSHARE_POSIX_ERR,
1929 USERSHARE_MALFORMED_SHARENAME_DEF,
1930 USERSHARE_BAD_SHARENAME
1933 /* Different reasons for closing a file. */
1934 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1936 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1937 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1938 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1939 struct smb_extended_info {
1940 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1941 uint32 samba_version; /* Major/Minor/Release/Revision */
1942 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1943 NTTIME samba_gitcommitdate;
1944 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1947 /* time info */
1948 struct smb_file_time {
1949 struct timespec mtime;
1950 struct timespec atime;
1951 struct timespec ctime;
1952 struct timespec create_time;
1956 * unix_convert_flags
1958 #define UCF_SAVE_LCOMP 0x00000001
1959 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP 0x00000002
1960 #define UCF_COND_ALLOW_WCARD_LCOMP 0x00000004
1961 #define UCF_POSIX_PATHNAMES 0x00000008
1964 * smb_filename
1966 struct smb_filename {
1967 char *base_name;
1968 char *stream_name;
1969 char *original_lcomp;
1970 SMB_STRUCT_STAT st;
1973 /* struct for maintaining the child processes that get spawned from smbd */
1974 struct child_pid {
1975 struct child_pid *prev, *next;
1976 pid_t pid;
1979 /* Used to keep track of deferred opens. */
1980 struct deferred_open_record;
1982 /* Client-side offline caching policy types */
1983 #define CSC_POLICY_MANUAL 0
1984 #define CSC_POLICY_DOCUMENTS 1
1985 #define CSC_POLICY_PROGRAMS 2
1986 #define CSC_POLICY_DISABLE 3
1988 #endif /* _SMB_H */