Remove "userdom_struct user" from "struct user_struct"
[Samba/gebeck_regimport.git] / source3 / include / smb.h
blob47a11f51a0845bbf82f2654522fdf862824dccdf
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-2008"
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 "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 typedef uint16 smb_ucs2_t;
154 #ifdef WORDS_BIGENDIAN
155 #define UCS2_SHIFT 8
156 #else
157 #define UCS2_SHIFT 0
158 #endif
160 /* turn a 7 bit character into a ucs2 character */
161 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
163 /* return an ascii version of a ucs2 character */
164 #define UCS2_TO_CHAR(c) (((c) >> UCS2_SHIFT) & 0xff)
166 /* Copy into a smb_ucs2_t from a possibly unaligned buffer. Return the copied smb_ucs2_t */
167 #define COPY_UCS2_CHAR(dest,src) (((unsigned char *)(dest))[0] = ((unsigned char *)(src))[0],\
168 ((unsigned char *)(dest))[1] = ((unsigned char *)(src))[1], (dest))
170 /* Large data type for manipulating uint32 unicode codepoints */
171 typedef uint32 codepoint_t;
172 #define INVALID_CODEPOINT ((codepoint_t)-1)
174 /* pipe string names */
175 #define PIPE_LANMAN "\\PIPE\\LANMAN"
176 #define PIPE_SRVSVC "\\PIPE\\srvsvc"
177 #define PIPE_SAMR "\\PIPE\\samr"
178 #define PIPE_WINREG "\\PIPE\\winreg"
179 #define PIPE_WKSSVC "\\PIPE\\wkssvc"
180 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
181 #define PIPE_NTLSA "\\PIPE\\ntlsa"
182 #define PIPE_NTSVCS "\\PIPE\\ntsvcs"
183 #define PIPE_LSASS "\\PIPE\\lsass"
184 #define PIPE_LSARPC "\\PIPE\\lsarpc"
185 #define PIPE_SPOOLSS "\\PIPE\\spoolss"
186 #define PIPE_NETDFS "\\PIPE\\netdfs"
187 #define PIPE_ECHO "\\PIPE\\rpcecho"
188 #define PIPE_SHUTDOWN "\\PIPE\\initshutdown"
189 #define PIPE_EPM "\\PIPE\\epmapper"
190 #define PIPE_SVCCTL "\\PIPE\\svcctl"
191 #define PIPE_EVENTLOG "\\PIPE\\eventlog"
193 #define PIPE_NETLOGON_PLAIN "\\NETLOGON"
195 #define PI_LSARPC 0
196 #define PI_DSSETUP 1
197 #define PI_SAMR 2
198 #define PI_NETLOGON 3
199 #define PI_SRVSVC 4
200 #define PI_WKSSVC 5
201 #define PI_WINREG 6
202 #define PI_SPOOLSS 7
203 #define PI_NETDFS 8
204 #define PI_RPCECHO 9
205 #define PI_INITSHUTDOWN 10
206 #define PI_SVCCTL 11
207 #define PI_EVENTLOG 12
208 #define PI_NTSVCS 13
209 #define PI_MAX_PIPES 14
211 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
212 typedef uint64_t NTTIME;
214 #define MAX_HOURS_LEN 32
216 #ifndef MAXSUBAUTHS
217 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
218 #endif
220 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
222 #define LOOKUP_NAME_NONE 0x00000000
223 #define LOOKUP_NAME_ISOLATED 0x00000001 /* Look up unqualified names */
224 #define LOOKUP_NAME_REMOTE 0x00000002 /* Ask others */
225 #define LOOKUP_NAME_GROUP 0x00000004 /* (unused) This is a NASTY hack for
226 valid users = @foo where foo also
227 exists in as user. */
228 #define LOOKUP_NAME_EXPLICIT 0x00000008 /* Only include
229 explicitly mapped names and not
230 the Unix {User,Group} domain */
231 #define LOOKUP_NAME_BUILTIN 0x00000010 /* builtin names */
232 #define LOOKUP_NAME_WKN 0x00000020 /* well known names */
233 #define LOOKUP_NAME_DOMAIN 0x00000040 /* only lookup own domain */
234 #define LOOKUP_NAME_LOCAL (LOOKUP_NAME_ISOLATED\
235 |LOOKUP_NAME_BUILTIN\
236 |LOOKUP_NAME_WKN\
237 |LOOKUP_NAME_DOMAIN)
238 #define LOOKUP_NAME_ALL (LOOKUP_NAME_ISOLATED\
239 |LOOKUP_NAME_REMOTE\
240 |LOOKUP_NAME_BUILTIN\
241 |LOOKUP_NAME_WKN\
242 |LOOKUP_NAME_DOMAIN)
245 * @brief Security Identifier
247 * @sa http://msdn.microsoft.com/library/default.asp?url=/library/en-us/security/accctrl_38yn.asp
249 typedef struct dom_sid {
250 uint8 sid_rev_num; /**< SID revision number */
251 uint8 num_auths; /**< Number of sub-authorities */
252 uint8 id_auth[6]; /**< Identifier Authority */
254 * Pointer to sub-authorities.
256 * @note The values in these uint32's are in *native* byteorder, not
257 * neccessarily little-endian...... JRA.
259 uint32 sub_auths[MAXSUBAUTHS];
260 } DOM_SID;
262 enum id_mapping {
263 ID_UNKNOWN = 0,
264 ID_MAPPED,
265 ID_UNMAPPED,
266 ID_EXPIRED
269 enum id_type {
270 ID_TYPE_NOT_SPECIFIED = 0,
271 ID_TYPE_UID,
272 ID_TYPE_GID
275 struct unixid {
276 uint32_t id;
277 enum id_type type;
280 struct id_map {
281 DOM_SID *sid;
282 struct unixid xid;
283 enum id_mapping status;
286 /* used to hold an arbitrary blob of data */
287 typedef struct data_blob {
288 uint8 *data;
289 size_t length;
290 void (*free)(struct data_blob *data_blob);
291 } DATA_BLOB;
293 extern const DATA_BLOB data_blob_null;
295 #include "librpc/gen_ndr/misc.h"
296 #include "librpc/gen_ndr/security.h"
297 #include "librpc/ndr/libndr.h"
298 #include "librpc/gen_ndr/lsa.h"
299 #include "librpc/gen_ndr/dfs.h"
300 #include "librpc/gen_ndr/winreg.h"
301 #include "librpc/gen_ndr/initshutdown.h"
302 #include "librpc/gen_ndr/eventlog.h"
303 #include "librpc/gen_ndr/srvsvc.h"
304 #include "librpc/gen_ndr/wkssvc.h"
305 #include "librpc/gen_ndr/echo.h"
306 #include "librpc/gen_ndr/svcctl.h"
307 #include "librpc/gen_ndr/netlogon.h"
308 #include "librpc/gen_ndr/samr.h"
309 #include "librpc/gen_ndr/dssetup.h"
310 #include "librpc/gen_ndr/libnet_join.h"
311 #include "librpc/gen_ndr/krb5pac.h"
312 #include "librpc/gen_ndr/ntsvcs.h"
313 #include "librpc/gen_ndr/nbt.h"
315 struct lsa_dom_info {
316 bool valid;
317 DOM_SID sid;
318 const char *name;
319 int num_idxs;
320 int *idxs;
323 struct lsa_name_info {
324 uint32 rid;
325 enum lsa_SidType type;
326 const char *name;
327 int dom_idx;
330 /* Some well-known SIDs */
331 extern const DOM_SID global_sid_World_Domain;
332 extern const DOM_SID global_sid_World;
333 extern const DOM_SID global_sid_Creator_Owner_Domain;
334 extern const DOM_SID global_sid_NT_Authority;
335 extern const DOM_SID global_sid_System;
336 extern const DOM_SID global_sid_NULL;
337 extern const DOM_SID global_sid_Authenticated_Users;
338 extern const DOM_SID global_sid_Network;
339 extern const DOM_SID global_sid_Creator_Owner;
340 extern const DOM_SID global_sid_Creator_Group;
341 extern const DOM_SID global_sid_Anonymous;
342 extern const DOM_SID global_sid_Builtin;
343 extern const DOM_SID global_sid_Builtin_Administrators;
344 extern const DOM_SID global_sid_Builtin_Users;
345 extern const DOM_SID global_sid_Builtin_Guests;
346 extern const DOM_SID global_sid_Builtin_Power_Users;
347 extern const DOM_SID global_sid_Builtin_Account_Operators;
348 extern const DOM_SID global_sid_Builtin_Server_Operators;
349 extern const DOM_SID global_sid_Builtin_Print_Operators;
350 extern const DOM_SID global_sid_Builtin_Backup_Operators;
351 extern const DOM_SID global_sid_Builtin_Replicator;
352 extern const DOM_SID global_sid_Builtin_PreWin2kAccess;
353 extern const DOM_SID global_sid_Unix_Users;
354 extern const DOM_SID global_sid_Unix_Groups;
357 * The complete list of SIDS belonging to this user.
358 * Created when a vuid is registered.
359 * The definition of the user_sids array is as follows :
361 * token->user_sids[0] = primary user SID.
362 * token->user_sids[1] = primary group SID.
363 * token->user_sids[2..num_sids] = supplementary group SIDS.
366 #define PRIMARY_USER_SID_INDEX 0
367 #define PRIMARY_GROUP_SID_INDEX 1
369 typedef struct nt_user_token {
370 size_t num_sids;
371 DOM_SID *user_sids;
372 SE_PRIV privileges;
373 } NT_USER_TOKEN;
375 typedef struct _unix_token {
376 uid_t uid;
377 gid_t gid;
378 int ngroups;
379 gid_t *groups;
380 } UNIX_USER_TOKEN;
382 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
383 typedef struct time_info {
384 uint32 time;
385 } UTIME;
387 typedef struct write_cache {
388 SMB_OFF_T file_size;
389 SMB_OFF_T offset;
390 size_t alloc_size;
391 size_t data_size;
392 char *data;
393 } write_cache;
395 typedef struct {
396 smb_ucs2_t *origname;
397 smb_ucs2_t *filename;
398 SMB_STRUCT_STAT *statinfo;
399 } smb_filename;
401 #include "fake_file.h"
403 struct fd_handle {
404 size_t ref_count;
405 int fd;
406 SMB_BIG_UINT position_information;
407 SMB_OFF_T pos;
408 uint32 private_options; /* NT Create options, but we only look at
409 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
410 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB (Except
411 * for print files *only*, where
412 * DELETE_ON_CLOSE is not stored in the share
413 * mode database.
415 unsigned long gen_id;
418 struct event_context;
419 struct fd_event;
420 struct timed_event;
421 struct idle_event;
422 struct share_mode_entry;
423 struct uuid;
424 struct named_mutex;
426 struct vfs_fsp_data {
427 struct vfs_fsp_data *next;
428 struct vfs_handle_struct *owner;
429 /* NOTE: This structure contains two pointers so that we can guarantee
430 * that the end of the structure is always both 4-byte and 8-byte aligned.
434 /* the basic packet size, assuming no words or bytes */
435 #define smb_size 39
437 struct notify_change {
438 uint32_t action;
439 const char *name;
442 struct notify_mid_map;
443 struct notify_entry;
444 struct notify_event;
445 struct notify_change_request;
446 struct sys_notify_backend;
447 struct sys_notify_context {
448 struct event_context *ev;
449 struct connection_struct *conn;
450 void *private_data; /* For use by the system backend */
453 struct notify_change_buf {
455 * If no requests are pending, changes are queued here. Simple array,
456 * we only append.
460 * num_changes == -1 means that we have got a catch-all change, when
461 * asked we just return NT_STATUS_OK without specific changes.
463 int num_changes;
464 struct notify_change *changes;
467 * If no changes are around requests are queued here. Using a linked
468 * list, because we have to append at the end and delete from the top.
470 struct notify_change_request *requests;
473 typedef struct files_struct {
474 struct files_struct *next, *prev;
475 int fnum;
476 struct connection_struct *conn;
477 struct fd_handle *fh;
478 unsigned int num_smb_operations;
479 uint16 rap_print_jobid;
480 struct file_id file_id;
481 SMB_BIG_UINT initial_allocation_size; /* Faked up initial allocation on disk. */
482 mode_t mode;
483 uint16 file_pid;
484 uint16 vuid;
485 write_cache *wcp;
486 struct timeval open_time;
487 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
488 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
490 bool update_write_time_triggered;
491 struct timed_event *update_write_time_event;
492 bool update_write_time_on_close;
493 struct timespec close_write_time;
494 bool write_time_forced;
496 int oplock_type;
497 int sent_oplock_break;
498 struct timed_event *oplock_timeout;
499 struct lock_struct last_lock_failure;
500 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
502 struct share_mode_entry *pending_break_messages;
503 int num_pending_break_messages;
505 bool can_lock;
506 bool can_read;
507 bool can_write;
508 bool print_file;
509 bool modified;
510 bool is_directory;
511 bool aio_write_behind;
512 bool lockdb_clean;
513 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
514 bool posix_open;
515 char *fsp_name;
517 struct vfs_fsp_data *vfs_extension;
518 FAKE_FILE_HANDLE *fake_file_handle;
520 struct notify_change_buf *notify;
522 struct files_struct *base_fsp; /* placeholder for delete on close */
523 } files_struct;
525 #include "ntquotas.h"
526 #include "sysquotas.h"
529 * Structure used to keep directory state information around.
530 * Used in NT change-notify code.
533 typedef struct {
534 time_t modify_time;
535 time_t status_time;
536 } dir_status_struct;
538 struct vuid_cache_entry {
539 uint16 vuid;
540 bool read_only;
541 bool admin_user;
544 struct vuid_cache {
545 unsigned int entries;
546 struct vuid_cache_entry array[VUID_CACHE_SIZE];
549 typedef struct {
550 char *name;
551 bool is_wild;
552 } name_compare_entry;
554 struct trans_state {
555 struct trans_state *next, *prev;
556 uint16 vuid;
557 uint16 mid;
559 uint32 max_param_return;
560 uint32 max_data_return;
561 uint32 max_setup_return;
563 uint8 cmd; /* SMBtrans or SMBtrans2 */
565 char *name; /* for trans requests */
566 uint16 call; /* for trans2 and nttrans requests */
568 bool close_on_completion;
569 bool one_way;
571 unsigned int setup_count;
572 uint16 *setup;
574 size_t received_data;
575 size_t received_param;
577 size_t total_param;
578 char *param;
580 size_t total_data;
581 char *data;
585 * Info about an alternate data stream
588 struct stream_struct {
589 SMB_OFF_T size;
590 SMB_OFF_T alloc_size;
591 char *name;
594 /* Include VFS stuff */
596 #include "smb_acls.h"
597 #include "vfs.h"
599 struct dfree_cached_info {
600 time_t last_dfree_time;
601 SMB_BIG_UINT dfree_ret;
602 SMB_BIG_UINT bsize;
603 SMB_BIG_UINT dfree;
604 SMB_BIG_UINT dsize;
607 struct dptr_struct;
609 struct share_params {
610 int service;
613 struct share_iterator {
614 int next_id;
617 typedef struct connection_struct {
618 struct connection_struct *next, *prev;
619 unsigned cnum; /* an index passed over the wire */
620 struct share_params *params;
621 bool force_user;
622 bool force_group;
623 struct vuid_cache vuid_cache;
624 struct dptr_struct *dirptr;
625 bool printer;
626 bool ipc;
627 bool read_only; /* Attributes for the current user of the share. */
628 bool admin_user; /* Attributes for the current user of the share. */
629 char *dirpath;
630 char *connectpath;
631 char *origpath;
633 struct vfs_ops vfs; /* Filesystem operations */
634 struct vfs_ops vfs_opaque; /* OPAQUE Filesystem operations */
635 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
637 char *user; /* name of user who *opened* this connection */
638 uid_t uid; /* uid of user who *opened* this connection */
639 gid_t gid; /* gid of user who *opened* this connection */
640 char client_address[INET6_ADDRSTRLEN]; /* String version of client IP address. */
642 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
644 /* following groups stuff added by ih */
646 /* This groups info is valid for the user that *opened* the connection */
647 size_t ngroups;
648 gid_t *groups;
649 NT_USER_TOKEN *nt_user_token;
651 time_t lastused;
652 time_t lastused_count;
653 bool used;
654 int num_files_open;
655 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
656 int encrypt_level;
657 bool encrypted_tid;
659 /* Semantics requested by the client or forced by the server config. */
660 bool case_sensitive;
661 bool case_preserve;
662 bool short_case_preserve;
664 /* Semantics provided by the underlying filesystem. */
665 int fs_capabilities;
667 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
668 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
669 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
670 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
671 struct dfree_cached_info *dfree_info;
672 struct trans_state *pending_trans;
673 struct notify_context *notify_ctx;
674 } connection_struct;
676 struct current_user {
677 connection_struct *conn;
678 uint16 vuid;
679 UNIX_USER_TOKEN ut;
680 NT_USER_TOKEN *nt_user_token;
683 struct smb_request {
684 uint16 flags2;
685 uint16 smbpid;
686 uint16 mid;
687 uint16 vuid;
688 uint16 tid;
689 uint8 wct;
690 const uint8 *inbuf;
691 uint8 *outbuf;
692 size_t unread_bytes;
693 bool encrypted;
694 connection_struct *conn;
697 /* Defines for the sent_oplock_break field above. */
698 #define NO_BREAK_SENT 0
699 #define BREAK_TO_NONE_SENT 1
700 #define LEVEL_II_BREAK_SENT 2
702 typedef struct {
703 fstring smb_name; /* user name from the client */
704 fstring unix_name; /* unix user name of a validated user */
705 fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
706 fstring domain; /* domain that the client specified */
707 } userdom_struct;
709 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
711 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
712 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
714 typedef struct _print_queue_struct {
715 int job; /* normally the UNIX jobid -- see note in
716 printing.c:traverse_fn_delete() */
717 int size;
718 int page_count;
719 int status;
720 int priority;
721 time_t time;
722 fstring fs_user;
723 fstring fs_file;
724 } print_queue_struct;
726 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
728 typedef struct {
729 fstring message;
730 int qcount;
731 int status;
732 } print_status_struct;
734 /* used for server information: client, nameserv and ipc */
735 struct server_info_struct {
736 fstring name;
737 uint32 type;
738 fstring comment;
739 fstring domain; /* used ONLY in ipc.c NOT namework.c */
740 bool server_added; /* used ONLY in ipc.c NOT namework.c */
743 /* used for network interfaces */
744 struct interface {
745 struct interface *next, *prev;
746 char *name;
747 int flags;
748 struct sockaddr_storage ip;
749 struct sockaddr_storage netmask;
750 struct sockaddr_storage bcast;
753 /* Internal message queue for deferred opens. */
754 struct pending_message_list {
755 struct pending_message_list *next, *prev;
756 struct timeval request_time; /* When was this first issued? */
757 struct timeval end_time; /* When does this time out? */
758 bool encrypted;
759 DATA_BLOB buf;
760 DATA_BLOB private_data;
763 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
764 #define SHARE_MODE_ALLOW_INITIAL_DELETE_ON_CLOSE 0x2
766 /* struct returned by get_share_modes */
767 struct share_mode_entry {
768 struct server_id pid;
769 uint16 op_mid;
770 uint16 op_type;
771 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
772 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
773 uint32 private_options; /* NT Create options, but we only look at
774 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
775 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
776 * smbstatus and swat */
777 struct timeval time;
778 struct file_id id;
779 unsigned long share_file_id;
780 uint32 uid; /* uid of file opener. */
781 uint16 flags; /* See SHARE_MODE_XX above. */
784 /* oplock break message definition - linearization of share_mode_entry.
786 Offset Data length.
787 0 struct server_id pid 4
788 4 uint16 op_mid 2
789 6 uint16 op_type 2
790 8 uint32 access_mask 4
791 12 uint32 share_access 4
792 16 uint32 private_options 4
793 20 uint32 time sec 4
794 24 uint32 time usec 4
795 28 SMB_DEV_T dev 8 bytes.
796 36 SMB_INO_T inode 8 bytes
797 44 unsigned long file_id 4 bytes
798 48 uint32 uid 4 bytes
799 52 uint16 flags 2 bytes
803 #ifdef CLUSTER_SUPPORT
804 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 58
805 #else
806 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 54
807 #endif
809 struct share_mode_lock {
810 const char *servicepath; /* canonicalized. */
811 const char *filename;
812 struct file_id id;
813 int num_share_modes;
814 struct share_mode_entry *share_modes;
815 UNIX_USER_TOKEN *delete_token;
816 bool delete_on_close;
817 struct timespec old_write_time;
818 struct timespec changed_write_time;
819 bool fresh;
820 bool modified;
821 struct db_record *record;
825 * Internal structure of locking.tdb share mode db.
826 * Used by locking.c and libsmbsharemodes.c
829 struct locking_data {
830 union {
831 struct {
832 int num_share_mode_entries;
833 bool delete_on_close;
834 struct timespec old_write_time;
835 struct timespec changed_write_time;
836 uint32 delete_token_size; /* Only valid if either of
837 the two previous fields
838 are True. */
839 } s;
840 struct share_mode_entry dummy; /* Needed for alignment. */
841 } u;
842 /* The following four entries are implicit
843 struct share_mode_entry modes[num_share_mode_entries];
844 char unix_token[delete_token_size] (divisible by 4).
845 char share_name[];
846 char file_name[];
850 /* Used to store pipe open records for NetFileEnum() */
852 struct pipe_open_rec {
853 struct server_id pid;
854 uid_t uid;
855 int pnum;
856 fstring name;
860 #define NT_HASH_LEN 16
861 #define LM_HASH_LEN 16
863 /* Password history contants. */
864 #define PW_HISTORY_SALT_LEN 16
865 #define SALTED_MD5_HASH_LEN 16
866 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
867 #define MAX_PW_HISTORY_LEN 24
870 * Flags for account policy.
872 #define AP_MIN_PASSWORD_LEN 1
873 #define AP_PASSWORD_HISTORY 2
874 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
875 #define AP_MAX_PASSWORD_AGE 4
876 #define AP_MIN_PASSWORD_AGE 5
877 #define AP_LOCK_ACCOUNT_DURATION 6
878 #define AP_RESET_COUNT_TIME 7
879 #define AP_BAD_ATTEMPT_LOCKOUT 8
880 #define AP_TIME_TO_LOGOUT 9
881 #define AP_REFUSE_MACHINE_PW_CHANGE 10
884 * Flags for local user manipulation.
887 #define LOCAL_ADD_USER 0x1
888 #define LOCAL_DELETE_USER 0x2
889 #define LOCAL_DISABLE_USER 0x4
890 #define LOCAL_ENABLE_USER 0x8
891 #define LOCAL_TRUST_ACCOUNT 0x10
892 #define LOCAL_SET_NO_PASSWORD 0x20
893 #define LOCAL_SET_PASSWORD 0x40
894 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
895 #define LOCAL_INTERDOM_ACCOUNT 0x100
896 #define LOCAL_AM_ROOT 0x200 /* Act as root */
898 /* key and data in the connections database - used in smbstatus and smbd */
899 struct connections_key {
900 struct server_id pid;
901 int cnum;
902 fstring name;
905 struct connections_data {
906 int magic;
907 struct server_id pid;
908 int cnum;
909 uid_t uid;
910 gid_t gid;
911 char servicename[FSTRING_LEN];
912 char addr[24];
913 char machine[FSTRING_LEN];
914 time_t start;
915 uint32 bcast_msg_flags;
919 /* the following are used by loadparm for option lists */
920 typedef enum {
921 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
922 P_STRING,P_USTRING,P_ENUM,P_SEP
923 } parm_type;
925 typedef enum {
926 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
927 } parm_class;
929 struct enum_list {
930 int value;
931 const char *name;
934 struct parm_struct {
935 const char *label;
936 parm_type type;
937 parm_class p_class;
938 void *ptr;
939 bool (*special)(int snum, const char *, char **);
940 const struct enum_list *enum_list;
941 unsigned flags;
942 union {
943 bool bvalue;
944 int ivalue;
945 char *svalue;
946 char cvalue;
947 char **lvalue;
948 } def;
951 /* The following flags are used in SWAT */
952 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
953 #define FLAG_SHARE 0x0002 /* file sharing options */
954 #define FLAG_PRINT 0x0004 /* printing options */
955 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
956 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
957 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
958 #define FLAG_DEVELOPER 0x0040 /* No longer used */
959 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
960 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
961 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
963 struct bitmap {
964 uint32 *b;
965 unsigned int n;
968 /* offsets into message for common items */
969 #define smb_com 8
970 #define smb_rcls 9
971 #define smb_reh 10
972 #define smb_err 11
973 #define smb_flg 13
974 #define smb_flg2 14
975 #define smb_pidhigh 16
976 #define smb_ss_field 18
977 #define smb_tid 28
978 #define smb_pid 30
979 #define smb_uid 32
980 #define smb_mid 34
981 #define smb_wct 36
982 #define smb_vwv 37
983 #define smb_vwv0 37
984 #define smb_vwv1 39
985 #define smb_vwv2 41
986 #define smb_vwv3 43
987 #define smb_vwv4 45
988 #define smb_vwv5 47
989 #define smb_vwv6 49
990 #define smb_vwv7 51
991 #define smb_vwv8 53
992 #define smb_vwv9 55
993 #define smb_vwv10 57
994 #define smb_vwv11 59
995 #define smb_vwv12 61
996 #define smb_vwv13 63
997 #define smb_vwv14 65
998 #define smb_vwv15 67
999 #define smb_vwv16 69
1000 #define smb_vwv17 71
1002 /* flag defines. CIFS spec 3.1.1 */
1003 #define FLAG_SUPPORT_LOCKREAD 0x01
1004 #define FLAG_CLIENT_BUF_AVAIL 0x02
1005 #define FLAG_RESERVED 0x04
1006 #define FLAG_CASELESS_PATHNAMES 0x08
1007 #define FLAG_CANONICAL_PATHNAMES 0x10
1008 #define FLAG_REQUEST_OPLOCK 0x20
1009 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
1010 #define FLAG_REPLY 0x80
1012 /* the complete */
1013 #define SMBmkdir 0x00 /* create directory */
1014 #define SMBrmdir 0x01 /* delete directory */
1015 #define SMBopen 0x02 /* open file */
1016 #define SMBcreate 0x03 /* create file */
1017 #define SMBclose 0x04 /* close file */
1018 #define SMBflush 0x05 /* flush file */
1019 #define SMBunlink 0x06 /* delete file */
1020 #define SMBmv 0x07 /* rename file */
1021 #define SMBgetatr 0x08 /* get file attributes */
1022 #define SMBsetatr 0x09 /* set file attributes */
1023 #define SMBread 0x0A /* read from file */
1024 #define SMBwrite 0x0B /* write to file */
1025 #define SMBlock 0x0C /* lock byte range */
1026 #define SMBunlock 0x0D /* unlock byte range */
1027 #define SMBctemp 0x0E /* create temporary file */
1028 #define SMBmknew 0x0F /* make new file */
1029 #define SMBcheckpath 0x10 /* check directory path */
1030 #define SMBexit 0x11 /* process exit */
1031 #define SMBlseek 0x12 /* seek */
1032 #define SMBtcon 0x70 /* tree connect */
1033 #define SMBtconX 0x75 /* tree connect and X*/
1034 #define SMBtdis 0x71 /* tree disconnect */
1035 #define SMBnegprot 0x72 /* negotiate protocol */
1036 #define SMBdskattr 0x80 /* get disk attributes */
1037 #define SMBsearch 0x81 /* search directory */
1038 #define SMBsplopen 0xC0 /* open print spool file */
1039 #define SMBsplwr 0xC1 /* write to print spool file */
1040 #define SMBsplclose 0xC2 /* close print spool file */
1041 #define SMBsplretq 0xC3 /* return print queue */
1042 #define SMBsends 0xD0 /* send single block message */
1043 #define SMBsendb 0xD1 /* send broadcast message */
1044 #define SMBfwdname 0xD2 /* forward user name */
1045 #define SMBcancelf 0xD3 /* cancel forward */
1046 #define SMBgetmac 0xD4 /* get machine name */
1047 #define SMBsendstrt 0xD5 /* send start of multi-block message */
1048 #define SMBsendend 0xD6 /* send end of multi-block message */
1049 #define SMBsendtxt 0xD7 /* send text of multi-block message */
1051 /* Core+ protocol */
1052 #define SMBlockread 0x13 /* Lock a range and read */
1053 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1054 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
1055 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
1056 #define SMBwritec 0x20 /* secondary write request */
1057 #define SMBwriteclose 0x2c /* write a file then close it */
1059 /* dos extended protocol */
1060 #define SMBreadBraw 0x1A /* read block raw */
1061 #define SMBreadBmpx 0x1B /* read block multiplexed */
1062 #define SMBreadBs 0x1C /* read block (secondary response) */
1063 #define SMBwriteBraw 0x1D /* write block raw */
1064 #define SMBwriteBmpx 0x1E /* write block multiplexed */
1065 #define SMBwriteBs 0x1F /* write block (secondary request) */
1066 #define SMBwriteC 0x20 /* write complete response */
1067 #define SMBsetattrE 0x22 /* set file attributes expanded */
1068 #define SMBgetattrE 0x23 /* get file attributes expanded */
1069 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
1070 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
1071 #define SMBtranss 0x26 /* transaction (secondary request/response) */
1072 #define SMBioctl 0x27 /* IOCTL */
1073 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
1074 #define SMBcopy 0x29 /* copy */
1075 #define SMBmove 0x2A /* move */
1076 #define SMBecho 0x2B /* echo */
1077 #define SMBopenX 0x2D /* open and X */
1078 #define SMBreadX 0x2E /* read and X */
1079 #define SMBwriteX 0x2F /* write and X */
1080 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
1081 #define SMBffirst 0x82 /* find first */
1082 #define SMBfunique 0x83 /* find unique */
1083 #define SMBfclose 0x84 /* find close */
1084 #define SMBkeepalive 0x85 /* keepalive */
1085 #define SMBinvalid 0xFE /* invalid command */
1087 /* Extended 2.0 protocol */
1088 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1089 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1090 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1091 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1092 #define SMBulogoffX 0x74 /* user logoff */
1094 /* NT SMB extensions. */
1095 #define SMBnttrans 0xA0 /* NT transact */
1096 #define SMBnttranss 0xA1 /* NT transact secondary */
1097 #define SMBntcreateX 0xA2 /* NT create and X */
1098 #define SMBntcancel 0xA4 /* NT cancel */
1099 #define SMBntrename 0xA5 /* NT rename */
1101 /* These are the trans subcommands */
1102 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
1103 #define TRANSACT_DCERPCCMD 0x26
1104 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1106 /* These are the TRANS2 sub commands */
1107 #define TRANSACT2_OPEN 0x00
1108 #define TRANSACT2_FINDFIRST 0x01
1109 #define TRANSACT2_FINDNEXT 0x02
1110 #define TRANSACT2_QFSINFO 0x03
1111 #define TRANSACT2_SETFSINFO 0x04
1112 #define TRANSACT2_QPATHINFO 0x05
1113 #define TRANSACT2_SETPATHINFO 0x06
1114 #define TRANSACT2_QFILEINFO 0x07
1115 #define TRANSACT2_SETFILEINFO 0x08
1116 #define TRANSACT2_FSCTL 0x09
1117 #define TRANSACT2_IOCTL 0x0A
1118 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1119 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1120 #define TRANSACT2_MKDIR 0x0D
1121 #define TRANSACT2_SESSION_SETUP 0x0E
1122 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1123 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1125 /* These are the NT transact sub commands. */
1126 #define NT_TRANSACT_CREATE 1
1127 #define NT_TRANSACT_IOCTL 2
1128 #define NT_TRANSACT_SET_SECURITY_DESC 3
1129 #define NT_TRANSACT_NOTIFY_CHANGE 4
1130 #define NT_TRANSACT_RENAME 5
1131 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1132 #define NT_TRANSACT_GET_USER_QUOTA 7
1133 #define NT_TRANSACT_SET_USER_QUOTA 8
1135 /* These are the NT transact_get_user_quota sub commands */
1136 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1137 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1138 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1140 /* Relevant IOCTL codes */
1141 #define IOCTL_QUERY_JOB_INFO 0x530060
1143 /* these are the trans2 sub fields for primary requests */
1144 #define smb_tpscnt smb_vwv0
1145 #define smb_tdscnt smb_vwv1
1146 #define smb_mprcnt smb_vwv2
1147 #define smb_mdrcnt smb_vwv3
1148 #define smb_msrcnt smb_vwv4
1149 #define smb_flags smb_vwv5
1150 #define smb_timeout smb_vwv6
1151 #define smb_pscnt smb_vwv9
1152 #define smb_psoff smb_vwv10
1153 #define smb_dscnt smb_vwv11
1154 #define smb_dsoff smb_vwv12
1155 #define smb_suwcnt smb_vwv13
1156 #define smb_setup smb_vwv14
1157 #define smb_setup0 smb_setup
1158 #define smb_setup1 (smb_setup+2)
1159 #define smb_setup2 (smb_setup+4)
1161 /* these are for the secondary requests */
1162 #define smb_spscnt smb_vwv2
1163 #define smb_spsoff smb_vwv3
1164 #define smb_spsdisp smb_vwv4
1165 #define smb_sdscnt smb_vwv5
1166 #define smb_sdsoff smb_vwv6
1167 #define smb_sdsdisp smb_vwv7
1168 #define smb_sfid smb_vwv8
1170 /* and these for responses */
1171 #define smb_tprcnt smb_vwv0
1172 #define smb_tdrcnt smb_vwv1
1173 #define smb_prcnt smb_vwv3
1174 #define smb_proff smb_vwv4
1175 #define smb_prdisp smb_vwv5
1176 #define smb_drcnt smb_vwv6
1177 #define smb_droff smb_vwv7
1178 #define smb_drdisp smb_vwv8
1180 /* these are for the NT trans primary request. */
1181 #define smb_nt_MaxSetupCount smb_vwv0
1182 #define smb_nt_Flags (smb_vwv0 + 1)
1183 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1184 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1185 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1186 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1187 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1188 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1189 #define smb_nt_DataCount (smb_vwv0 + 27)
1190 #define smb_nt_DataOffset (smb_vwv0 + 31)
1191 #define smb_nt_SetupCount (smb_vwv0 + 35)
1192 #define smb_nt_Function (smb_vwv0 + 36)
1193 #define smb_nt_SetupStart (smb_vwv0 + 38)
1195 /* these are for the NT trans secondary request. */
1196 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1197 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1198 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1199 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1200 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1201 #define smb_nts_DataCount (smb_vwv0 + 23)
1202 #define smb_nts_DataOffset (smb_vwv0 + 27)
1203 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1205 /* these are for the NT trans reply. */
1206 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1207 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1208 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1209 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1210 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1211 #define smb_ntr_DataCount (smb_vwv0 + 23)
1212 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1213 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1215 /* these are for the NT create_and_X */
1216 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1217 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1218 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1219 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1220 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1221 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1222 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1223 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1224 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1225 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1226 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1228 /* this is used on a TConX. I'm not sure the name is very helpful though */
1229 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1230 #define SMB_SHARE_IN_DFS 0x0002
1232 /* Named pipe write mode flags. Used in writeX calls. */
1233 #define PIPE_RAW_MODE 0x4
1234 #define PIPE_START_MESSAGE 0x8
1236 /* File Specific access rights */
1237 #define FILE_READ_DATA 0x00000001
1238 #define FILE_WRITE_DATA 0x00000002
1239 #define FILE_APPEND_DATA 0x00000004
1240 #define FILE_READ_EA 0x00000008 /* File and directory */
1241 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1242 #define FILE_EXECUTE 0x00000020
1243 #define FILE_DELETE_CHILD 0x00000040
1244 #define FILE_READ_ATTRIBUTES 0x00000080
1245 #define FILE_WRITE_ATTRIBUTES 0x00000100
1247 #define FILE_ALL_ACCESS 0x000001FF
1249 /* Directory specific access rights */
1250 #define FILE_LIST_DIRECTORY 0x00000001
1251 #define FILE_ADD_FILE 0x00000002
1252 #define FILE_ADD_SUBDIRECTORY 0x00000004
1253 #define FILE_TRAVERSE 0x00000020
1254 #define FILE_DELETE_CHILD 0x00000040
1256 /* the desired access to use when opening a pipe */
1257 #define DESIRED_ACCESS_PIPE 0x2019f
1259 /* Generic access masks & rights. */
1260 #define DELETE_ACCESS 0x00010000 /* (1L<<16) */
1261 #define READ_CONTROL_ACCESS 0x00020000 /* (1L<<17) */
1262 #define WRITE_DAC_ACCESS 0x00040000 /* (1L<<18) */
1263 #define WRITE_OWNER_ACCESS 0x00080000 /* (1L<<19) */
1264 #define SYNCHRONIZE_ACCESS 0x00100000 /* (1L<<20) */
1266 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1267 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1268 #define GENERIC_ALL_ACCESS 0x10000000 /* (1<<28) */
1269 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1270 #define GENERIC_WRITE_ACCESS 0x40000000 /* (1<<30) */
1271 #define GENERIC_READ_ACCESS ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1273 /* Mapping of generic access rights for files to specific rights. */
1275 /* This maps to 0x1F01FF */
1276 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1278 /* This maps to 0x120089 */
1279 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1280 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1282 /* This maps to 0x120116 */
1283 #define FILE_GENERIC_WRITE (STD_RIGHT_READ_CONTROL_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1284 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1286 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|\
1287 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1289 /* Share specific rights. */
1290 #define SHARE_ALL_ACCESS FILE_GENERIC_ALL
1291 #define SHARE_READ_ONLY (FILE_GENERIC_READ|FILE_EXECUTE)
1293 /* Mapping of access rights to UNIX perms. */
1294 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1295 #define UNIX_ACCESS_R FILE_GENERIC_READ
1296 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1297 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1299 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1300 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1301 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1302 #define UNIX_DIRECTORY_ACCESS_W FILE_GENERIC_WRITE
1303 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1305 #if 0
1307 * This is the old mapping we used to use. To get W2KSP2 profiles
1308 * working we need to map to the canonical file perms.
1310 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1311 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1312 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1313 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1314 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1315 FILE_APPEND_DATA|FILE_WRITE_DATA)
1316 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1317 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1318 #endif
1320 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1322 /* Flags field. */
1323 #define REQUEST_OPLOCK 2
1324 #define REQUEST_BATCH_OPLOCK 4
1325 #define OPEN_DIRECTORY 8
1326 #define EXTENDED_RESPONSE_REQUIRED 0x10
1328 /* ShareAccess field. */
1329 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1330 #define FILE_SHARE_READ 1
1331 #define FILE_SHARE_WRITE 2
1332 #define FILE_SHARE_DELETE 4
1334 /* FileAttributesField */
1335 #define FILE_ATTRIBUTE_READONLY 0x001L
1336 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1337 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1338 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1339 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1340 #define FILE_ATTRIBUTE_NORMAL 0x080L
1341 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1342 #define FILE_ATTRIBUTE_SPARSE 0x200L
1343 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1344 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1345 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1346 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1347 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1348 #define SAMBA_ATTRIBUTES_MASK 0x7F
1350 /* Flags - combined with attributes. */
1351 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1352 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1353 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1354 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1355 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1356 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1357 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1359 /* CreateDisposition field. */
1360 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1361 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1362 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1363 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1364 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1365 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1367 /* CreateOptions field. */
1368 #define FILE_DIRECTORY_FILE 0x0001
1369 #define FILE_WRITE_THROUGH 0x0002
1370 #define FILE_SEQUENTIAL_ONLY 0x0004
1371 #define FILE_NON_DIRECTORY_FILE 0x0040
1372 #define FILE_NO_EA_KNOWLEDGE 0x0200
1373 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1374 #define FILE_RANDOM_ACCESS 0x0800
1375 #define FILE_DELETE_ON_CLOSE 0x1000
1376 #define FILE_OPEN_BY_FILE_ID 0x2000
1378 /* Private create options used by the ntcreatex processing code. From Samba4. */
1379 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x01000000
1380 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x02000000
1382 /* Private options for streams support */
1383 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x04000000
1385 /* Responses when opening a file. */
1386 #define FILE_WAS_SUPERSEDED 0
1387 #define FILE_WAS_OPENED 1
1388 #define FILE_WAS_CREATED 2
1389 #define FILE_WAS_OVERWRITTEN 3
1391 /* File type flags */
1392 #define FILE_TYPE_DISK 0
1393 #define FILE_TYPE_BYTE_MODE_PIPE 1
1394 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1395 #define FILE_TYPE_PRINTER 3
1396 #define FILE_TYPE_COMM_DEVICE 4
1397 #define FILE_TYPE_UNKNOWN 0xFFFF
1399 /* Flag for NT transact rename call. */
1400 #define RENAME_REPLACE_IF_EXISTS 1
1402 /* flags for SMBntrename call (from Samba4) */
1403 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1404 #define RENAME_FLAG_HARD_LINK 0x103
1405 #define RENAME_FLAG_RENAME 0x104
1406 #define RENAME_FLAG_COPY 0x105
1408 /* Filesystem Attributes. */
1409 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1410 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1411 #define FILE_UNICODE_ON_DISK 0x00000004
1412 /* According to cifs9f, this is 4, not 8 */
1413 /* Acconding to testing, this actually sets the security attribute! */
1414 #define FILE_PERSISTENT_ACLS 0x00000008
1415 #define FILE_FILE_COMPRESSION 0x00000010
1416 #define FILE_VOLUME_QUOTAS 0x00000020
1417 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1418 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1419 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1420 #define FS_LFN_APIS 0x00004000
1421 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1422 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1423 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1424 #define FILE_NAMED_STREAMS 0x00040000
1425 #define FILE_READ_ONLY_VOLUME 0x00080000
1427 /* ChangeNotify flags. */
1428 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1429 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1430 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1431 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1432 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1433 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1434 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1435 #define FILE_NOTIFY_CHANGE_EA 0x080
1436 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1437 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1438 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1439 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1441 #define FILE_NOTIFY_CHANGE_NAME \
1442 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1444 /* change notify action results */
1445 #define NOTIFY_ACTION_ADDED 1
1446 #define NOTIFY_ACTION_REMOVED 2
1447 #define NOTIFY_ACTION_MODIFIED 3
1448 #define NOTIFY_ACTION_OLD_NAME 4
1449 #define NOTIFY_ACTION_NEW_NAME 5
1450 #define NOTIFY_ACTION_ADDED_STREAM 6
1451 #define NOTIFY_ACTION_REMOVED_STREAM 7
1452 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1455 /* where to find the base of the SMB packet proper */
1456 #define smb_base(buf) (((char *)(buf))+4)
1458 /* we don't allow server strings to be longer than 48 characters as
1459 otherwise NT will not honour the announce packets */
1460 #define MAX_SERVER_STRING_LENGTH 48
1463 #define SMB_SUCCESS 0 /* The request was successful. */
1465 #ifdef WITH_DFS
1466 void dfs_unlogin(void);
1467 extern int dcelogin_atmost_once;
1468 #endif
1470 #ifdef NOSTRDUP
1471 char *strdup(char *s);
1472 #endif
1474 #ifndef SIGNAL_CAST
1475 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1476 #endif
1478 #ifndef SELECT_CAST
1479 #define SELECT_CAST
1480 #endif
1482 /* This was set by JHT in liaison with Jeremy Allison early 1997
1483 * History:
1484 * Version 4.0 - never made public
1485 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1486 * - Reappeared in 1.9.16p11 with fixed smbd services
1487 * Version 4.20 - To indicate that nmbd and browsing now works better
1488 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1490 * Note: In the presence of NT4.X do not set above 4.9
1491 * Setting this above 4.9 can have undesired side-effects.
1492 * This may change again in Samba-3.0 after further testing. JHT
1495 #define DEFAULT_MAJOR_VERSION 0x04
1496 #define DEFAULT_MINOR_VERSION 0x09
1498 /* Browser Election Values */
1499 #define BROWSER_ELECTION_VERSION 0x010f
1500 #define BROWSER_CONSTANT 0xaa55
1502 /* Sercurity mode bits. */
1503 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1504 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1505 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1506 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1508 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1510 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1511 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1512 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1513 #define FLAGS2_UNKNOWN_BIT4 0x0010
1514 #define FLAGS2_IS_LONG_NAME 0x0040
1515 #define FLAGS2_EXTENDED_SECURITY 0x0800
1516 #define FLAGS2_DFS_PATHNAMES 0x1000
1517 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1518 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1519 #define FLAGS2_UNICODE_STRINGS 0x8000
1521 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1523 /* TCONX Flag (smb_vwv2). */
1524 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1526 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1528 #define CAP_RAW_MODE 0x0001
1529 #define CAP_MPX_MODE 0x0002
1530 #define CAP_UNICODE 0x0004
1531 #define CAP_LARGE_FILES 0x0008
1532 #define CAP_NT_SMBS 0x0010
1533 #define CAP_RPC_REMOTE_APIS 0x0020
1534 #define CAP_STATUS32 0x0040
1535 #define CAP_LEVEL_II_OPLOCKS 0x0080
1536 #define CAP_LOCK_AND_READ 0x0100
1537 #define CAP_NT_FIND 0x0200
1538 #define CAP_DFS 0x1000
1539 #define CAP_W2K_SMBS 0x2000
1540 #define CAP_LARGE_READX 0x4000
1541 #define CAP_LARGE_WRITEX 0x8000
1542 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1543 #define CAP_EXTENDED_SECURITY 0x80000000
1545 /* protocol types. It assumes that higher protocols include lower protocols
1546 as subsets */
1547 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1549 /* security levels */
1550 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1552 /* server roles */
1553 enum server_types {
1554 ROLE_STANDALONE,
1555 ROLE_DOMAIN_MEMBER,
1556 ROLE_DOMAIN_BDC,
1557 ROLE_DOMAIN_PDC
1560 /* printing types */
1561 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1562 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1563 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1564 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1565 ,PRINT_TEST,PRINT_VLP
1566 #endif /* DEVELOPER */
1569 /* LDAP schema types */
1570 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1572 /* LDAP SSL options */
1573 enum ldap_ssl_types {LDAP_SSL_ON, LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1575 /* LDAP PASSWD SYNC methods */
1576 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1578 /* Remote architectures we know about. */
1579 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1580 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1581 RA_SAMBA, RA_CIFSFS, RA_WINXP64};
1583 /* case handling */
1584 enum case_handling {CASE_LOWER,CASE_UPPER};
1586 /* ACL compatibility */
1587 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1589 * Global value meaing that the smb_uid field should be
1590 * ingored (in share level security and protocol level == CORE)
1593 #define UID_FIELD_INVALID 0
1594 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1597 * Size of buffer to use when moving files across filesystems.
1599 #define COPYBUF_SIZE (8*1024)
1602 * Used in chaining code.
1604 extern int chain_size;
1607 * Map the Core and Extended Oplock requesst bits down
1608 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1612 * Core protocol.
1614 #define CORE_OPLOCK_REQUEST(inbuf) \
1615 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1618 * Extended protocol.
1620 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1622 /* Lock types. */
1623 #define LOCKING_ANDX_SHARED_LOCK 0x1
1624 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1625 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1626 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1627 #define LOCKING_ANDX_LARGE_FILES 0x10
1630 * Bits we test with.
1631 * Note these must fit into 16-bits.
1634 #define NO_OPLOCK 0x0
1635 #define EXCLUSIVE_OPLOCK 0x1
1636 #define BATCH_OPLOCK 0x2
1637 #define LEVEL_II_OPLOCK 0x4
1639 /* The following are Samba-private. */
1640 #define INTERNAL_OPEN_ONLY 0x8
1641 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1642 * inform potential level2 holders on
1643 * write. */
1644 #define DEFERRED_OPEN_ENTRY 0x20
1645 #define UNUSED_SHARE_MODE_ENTRY 0x40
1646 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1648 /* None of the following should ever appear in fsp->oplock_request. */
1649 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1651 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1652 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1653 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1655 struct inform_level2_message {
1656 SMB_DEV_T dev;
1657 SMB_INO_T inode;
1658 uint16 mid;
1659 unsigned long target_file_id;
1660 unsigned long source_file_id;
1663 /* kernel_oplock_message definition.
1665 struct kernel_oplock_message {
1666 SMB_DEV_T dev;
1667 SMB_INO_T inode;
1668 unsigned long file_id;
1671 Offset Data length.
1672 0 SMB_DEV_T dev 8 bytes.
1673 8 SMB_INO_T inode 8 bytes
1674 16 unsigned long file_id 4 bytes
1678 #define MSG_SMB_KERNEL_BREAK_SIZE 20
1680 /* file_renamed_message definition.
1682 struct file_renamed_message {
1683 SMB_DEV_T dev;
1684 SMB_INO_T inode;
1685 char names[1]; A variable area containing sharepath and filename.
1688 Offset Data length.
1689 0 SMB_DEV_T dev 8 bytes.
1690 8 SMB_INO_T inode 8 bytes
1691 16 char [] name zero terminated namelen bytes
1692 minimum length == 18.
1696 #define MSG_FILE_RENAMED_MIN_SIZE 16
1699 * On the wire return values for oplock types.
1702 #define CORE_OPLOCK_GRANTED (1<<5)
1703 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1705 #define NO_OPLOCK_RETURN 0
1706 #define EXCLUSIVE_OPLOCK_RETURN 1
1707 #define BATCH_OPLOCK_RETURN 2
1708 #define LEVEL_II_OPLOCK_RETURN 3
1710 /* Oplock levels */
1711 #define OPLOCKLEVEL_NONE 0
1712 #define OPLOCKLEVEL_II 1
1715 * Capabilities abstracted for different systems.
1718 enum smbd_capability {
1719 KERNEL_OPLOCK_CAPABILITY,
1720 DMAPI_ACCESS_CAPABILITY
1723 /* if a kernel does support oplocks then a structure of the following
1724 typee is used to describe how to interact with the kernel */
1725 struct kernel_oplocks {
1726 files_struct * (*receive_message)(fd_set *fds);
1727 bool (*set_oplock)(files_struct *fsp, int oplock_type);
1728 void (*release_oplock)(files_struct *fsp);
1729 bool (*msg_waiting)(fd_set *fds);
1730 int notification_fd;
1733 #include "smb_macros.h"
1735 #define MAX_NETBIOSNAME_LEN 16
1736 /* DOS character, NetBIOS namestring. Type used on the wire. */
1737 typedef char nstring[MAX_NETBIOSNAME_LEN];
1738 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1739 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1741 /* A netbios name structure. */
1742 struct nmb_name {
1743 nstring name;
1744 char scope[64];
1745 unsigned int name_type;
1748 /* A netbios node status array element. */
1749 typedef struct node_status_ {
1750 nstring name;
1751 unsigned char type;
1752 unsigned char flags;
1753 } NODE_STATUS_STRUCT;
1755 /* The extra info from a NetBIOS node status query */
1756 struct node_status_extra {
1757 unsigned char mac_addr[6];
1758 /* There really is more here ... */
1761 struct pwd_info {
1762 bool null_pwd;
1763 bool cleartext;
1765 fstring password;
1768 /* For split krb5 SPNEGO blobs. */
1769 struct pending_auth_data {
1770 struct pending_auth_data *prev, *next;
1771 uint16 vuid; /* Tag for this entry. */
1772 uint16 smbpid; /* Alternate tag for this entry. */
1773 size_t needed_len;
1774 DATA_BLOB partial_data;
1777 typedef struct user_struct {
1778 struct user_struct *next, *prev;
1779 uint16 vuid; /* Tag for this entry. */
1781 char *session_keystr; /* used by utmp and pam session code.
1782 TDB key string */
1783 int homes_snum;
1785 struct auth_serversupplied_info *server_info;
1787 struct auth_ntlmssp_state *auth_ntlmssp_state;
1788 } user_struct;
1790 struct unix_error_map {
1791 int unix_error;
1792 int dos_class;
1793 int dos_code;
1794 NTSTATUS nt_error;
1798 * Size of new password account encoding string. This is enough space to
1799 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1800 * Do not change unless you are adding new ACB bits!
1803 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1806 Do you want session setups at user level security with a invalid
1807 password to be rejected or allowed in as guest? WinNT rejects them
1808 but it can be a pain as it means "net view" needs to use a password
1810 You have 3 choices in the setting of map_to_guest:
1812 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1813 are rejected. This is the default.
1815 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1816 are rejected, unless the username does not exist, in which case it
1817 is treated as a guest login
1819 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1820 are treated as a guest login
1822 Note that map_to_guest only has an effect in user or server
1823 level security.
1826 #define NEVER_MAP_TO_GUEST 0
1827 #define MAP_TO_GUEST_ON_BAD_USER 1
1828 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1829 #define MAP_TO_GUEST_ON_BAD_UID 3
1831 #define SAFE_NETBIOS_CHARS ". -_"
1833 /* generic iconv conversion structure */
1834 typedef struct _smb_iconv_t {
1835 size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
1836 char **outbuf, size_t *outbytesleft);
1837 size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
1838 char **outbuf, size_t *outbytesleft);
1839 size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
1840 char **outbuf, size_t *outbytesleft);
1841 void *cd_direct, *cd_pull, *cd_push;
1842 char *from_name, *to_name;
1843 } *smb_iconv_t;
1845 /* The maximum length of a trust account password.
1846 Used when we randomly create it, 15 char passwords
1847 exceed NT4's max password length */
1849 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1851 #include "popt_common.h"
1853 #define PORT_NONE 0
1854 #ifndef LDAP_PORT
1855 #define LDAP_PORT 389
1856 #endif
1858 /* used by the IP comparison function */
1859 struct ip_service {
1860 struct sockaddr_storage ss;
1861 unsigned port;
1864 /* Special name type used to cause a _kerberos DNS lookup. */
1865 #define KDC_NAME_TYPE 0xDCDC
1867 /* Used by the SMB signing functions. */
1869 typedef struct smb_sign_info {
1870 void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1871 bool (*check_incoming_message)(const char *inbuf, struct smb_sign_info *si, bool must_be_ok);
1872 void (*free_signing_context)(struct smb_sign_info *si);
1873 void *signing_context;
1875 bool negotiated_smb_signing;
1876 bool allow_smb_signing;
1877 bool doing_signing;
1878 bool mandatory_signing;
1879 bool seen_valid; /* Have I ever seen a validly signed packet? */
1880 } smb_sign_info;
1882 struct ea_struct {
1883 uint8 flags;
1884 char *name;
1885 DATA_BLOB value;
1888 struct ea_list {
1889 struct ea_list *next, *prev;
1890 struct ea_struct ea;
1893 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1894 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1895 /* EA to use for DOS attributes */
1896 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1897 /* Prefix for DosStreams in the vfs_streams_xattr module */
1898 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1900 #define UUID_SIZE 16
1902 #define UUID_FLAT_SIZE 16
1903 typedef struct uuid_flat {
1904 uint8 info[UUID_FLAT_SIZE];
1905 } UUID_FLAT;
1907 /* map readonly options */
1908 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1910 /* usershare error codes. */
1911 enum usershare_err {
1912 USERSHARE_OK=0,
1913 USERSHARE_MALFORMED_FILE,
1914 USERSHARE_BAD_VERSION,
1915 USERSHARE_MALFORMED_PATH,
1916 USERSHARE_MALFORMED_COMMENT_DEF,
1917 USERSHARE_MALFORMED_ACL_DEF,
1918 USERSHARE_ACL_ERR,
1919 USERSHARE_PATH_NOT_ABSOLUTE,
1920 USERSHARE_PATH_IS_DENIED,
1921 USERSHARE_PATH_NOT_ALLOWED,
1922 USERSHARE_PATH_NOT_DIRECTORY,
1923 USERSHARE_POSIX_ERR
1926 /* Different reasons for closing a file. */
1927 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1929 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1930 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1931 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1932 struct smb_extended_info {
1933 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1934 uint32 samba_version; /* Major/Minor/Release/Revision */
1935 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1936 NTTIME samba_gitcommitdate;
1937 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1940 #endif /* _SMB_H */