Move samba_extended_info_version to smbd/trans2.c
[Samba/gbeck.git] / source3 / include / smb.h
blobf3cf1db6f8b09fe7d37956babc576d80343a039e
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_LSARPC_DS 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 #define dom_sid2 dom_sid
263 #define dom_sid28 dom_sid
265 enum id_mapping {
266 ID_UNKNOWN = 0,
267 ID_MAPPED,
268 ID_UNMAPPED,
269 ID_EXPIRED
272 enum id_type {
273 ID_TYPE_NOT_SPECIFIED = 0,
274 ID_TYPE_UID,
275 ID_TYPE_GID
278 struct unixid {
279 uint32_t id;
280 enum id_type type;
283 struct id_map {
284 DOM_SID *sid;
285 struct unixid xid;
286 enum id_mapping status;
289 /* used to hold an arbitrary blob of data */
290 typedef struct data_blob {
291 uint8 *data;
292 size_t length;
293 void (*free)(struct data_blob *data_blob);
294 } DATA_BLOB;
296 extern const DATA_BLOB data_blob_null;
298 #include "librpc/gen_ndr/misc.h"
299 #include "librpc/ndr/security.h"
300 #include "librpc/ndr/libndr.h"
301 #include "librpc/gen_ndr/lsa.h"
302 #include "librpc/gen_ndr/dfs.h"
303 #include "librpc/gen_ndr/winreg.h"
304 #include "librpc/gen_ndr/initshutdown.h"
305 #include "librpc/gen_ndr/eventlog.h"
306 #include "librpc/gen_ndr/srvsvc.h"
307 #include "librpc/gen_ndr/wkssvc.h"
308 #include "librpc/gen_ndr/echo.h"
309 #include "librpc/gen_ndr/svcctl.h"
310 #include "librpc/gen_ndr/netlogon.h"
311 #include "librpc/gen_ndr/samr.h"
312 #include "librpc/gen_ndr/libnet_join.h"
314 struct lsa_dom_info {
315 bool valid;
316 DOM_SID sid;
317 const char *name;
318 int num_idxs;
319 int *idxs;
322 struct lsa_name_info {
323 uint32 rid;
324 enum lsa_SidType type;
325 const char *name;
326 int dom_idx;
329 /* Some well-known SIDs */
330 extern const DOM_SID global_sid_World_Domain;
331 extern const DOM_SID global_sid_World;
332 extern const DOM_SID global_sid_Creator_Owner_Domain;
333 extern const DOM_SID global_sid_NT_Authority;
334 extern const DOM_SID global_sid_System;
335 extern const DOM_SID global_sid_NULL;
336 extern const DOM_SID global_sid_Authenticated_Users;
337 extern const DOM_SID global_sid_Network;
338 extern const DOM_SID global_sid_Creator_Owner;
339 extern const DOM_SID global_sid_Creator_Group;
340 extern const DOM_SID global_sid_Anonymous;
341 extern const DOM_SID global_sid_Builtin;
342 extern const DOM_SID global_sid_Builtin_Administrators;
343 extern const DOM_SID global_sid_Builtin_Users;
344 extern const DOM_SID global_sid_Builtin_Guests;
345 extern const DOM_SID global_sid_Builtin_Power_Users;
346 extern const DOM_SID global_sid_Builtin_Account_Operators;
347 extern const DOM_SID global_sid_Builtin_Server_Operators;
348 extern const DOM_SID global_sid_Builtin_Print_Operators;
349 extern const DOM_SID global_sid_Builtin_Backup_Operators;
350 extern const DOM_SID global_sid_Builtin_Replicator;
351 extern const DOM_SID global_sid_Builtin_PreWin2kAccess;
352 extern const DOM_SID global_sid_Unix_Users;
353 extern const DOM_SID global_sid_Unix_Groups;
356 * The complete list of SIDS belonging to this user.
357 * Created when a vuid is registered.
358 * The definition of the user_sids array is as follows :
360 * token->user_sids[0] = primary user SID.
361 * token->user_sids[1] = primary group SID.
362 * token->user_sids[2..num_sids] = supplementary group SIDS.
365 #define PRIMARY_USER_SID_INDEX 0
366 #define PRIMARY_GROUP_SID_INDEX 1
368 typedef struct nt_user_token {
369 size_t num_sids;
370 DOM_SID *user_sids;
371 SE_PRIV privileges;
372 } NT_USER_TOKEN;
374 typedef struct _unix_token {
375 uid_t uid;
376 gid_t gid;
377 int ngroups;
378 gid_t *groups;
379 } UNIX_USER_TOKEN;
381 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
382 typedef struct time_info {
383 uint32 time;
384 } UTIME;
386 typedef struct write_cache {
387 SMB_OFF_T file_size;
388 SMB_OFF_T offset;
389 size_t alloc_size;
390 size_t data_size;
391 char *data;
392 } write_cache;
394 typedef struct {
395 smb_ucs2_t *origname;
396 smb_ucs2_t *filename;
397 SMB_STRUCT_STAT *statinfo;
398 } smb_filename;
400 #include "fake_file.h"
402 struct fd_handle {
403 size_t ref_count;
404 int fd;
405 SMB_BIG_UINT position_information;
406 SMB_OFF_T pos;
407 uint32 private_options; /* NT Create options, but we only look at
408 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
409 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB (Except
410 * for print files *only*, where
411 * DELETE_ON_CLOSE is not stored in the share
412 * mode database.
414 unsigned long gen_id;
417 struct event_context;
418 struct fd_event;
419 struct timed_event;
420 struct idle_event;
421 struct share_mode_entry;
422 struct uuid;
424 struct vfs_fsp_data {
425 struct vfs_fsp_data *next;
426 struct vfs_handle_struct *owner;
427 /* NOTE: This structure contains two pointers so that we can guarantee
428 * that the end of the structure is always both 4-byte and 8-byte aligned.
432 /* the basic packet size, assuming no words or bytes */
433 #define smb_size 39
435 struct notify_change {
436 uint32_t action;
437 const char *name;
440 struct notify_mid_map;
441 struct notify_entry;
442 struct notify_event;
443 struct notify_change_request;
444 struct sys_notify_backend;
445 struct sys_notify_context {
446 struct event_context *ev;
447 struct connection_struct *conn;
448 void *private_data; /* For use by the system backend */
451 struct notify_change_buf {
453 * If no requests are pending, changes are queued here. Simple array,
454 * we only append.
458 * num_changes == -1 means that we have got a catch-all change, when
459 * asked we just return NT_STATUS_OK without specific changes.
461 int num_changes;
462 struct notify_change *changes;
465 * If no changes are around requests are queued here. Using a linked
466 * list, because we have to append at the end and delete from the top.
468 struct notify_change_request *requests;
471 typedef struct files_struct {
472 struct files_struct *next, *prev;
473 int fnum;
474 struct connection_struct *conn;
475 struct fd_handle *fh;
476 unsigned int num_smb_operations;
477 uint16 rap_print_jobid;
478 struct file_id file_id;
479 SMB_BIG_UINT initial_allocation_size; /* Faked up initial allocation on disk. */
480 mode_t mode;
481 uint16 file_pid;
482 uint16 vuid;
483 write_cache *wcp;
484 struct timeval open_time;
485 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
486 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
487 bool pending_modtime_owner;
488 struct timespec pending_modtime;
489 struct timespec last_write_time;
490 int oplock_type;
491 int sent_oplock_break;
492 struct timed_event *oplock_timeout;
493 struct lock_struct last_lock_failure;
494 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
496 struct share_mode_entry *pending_break_messages;
497 int num_pending_break_messages;
499 bool can_lock;
500 bool can_read;
501 bool can_write;
502 bool print_file;
503 bool modified;
504 bool is_directory;
505 bool is_stat;
506 bool aio_write_behind;
507 bool lockdb_clean;
508 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
509 bool posix_open;
510 char *fsp_name;
512 struct vfs_fsp_data *vfs_extension;
513 FAKE_FILE_HANDLE *fake_file_handle;
515 struct notify_change_buf *notify;
517 struct files_struct *base_fsp; /* placeholder for delete on close */
518 } files_struct;
520 #include "ntquotas.h"
521 #include "sysquotas.h"
524 * Structure used to keep directory state information around.
525 * Used in NT change-notify code.
528 typedef struct {
529 time_t modify_time;
530 time_t status_time;
531 } dir_status_struct;
533 struct vuid_cache_entry {
534 uint16 vuid;
535 bool read_only;
536 bool admin_user;
539 struct vuid_cache {
540 unsigned int entries;
541 struct vuid_cache_entry array[VUID_CACHE_SIZE];
544 typedef struct {
545 char *name;
546 bool is_wild;
547 } name_compare_entry;
549 struct trans_state {
550 struct trans_state *next, *prev;
551 uint16 vuid;
552 uint16 mid;
554 uint32 max_param_return;
555 uint32 max_data_return;
556 uint32 max_setup_return;
558 uint8 cmd; /* SMBtrans or SMBtrans2 */
560 char *name; /* for trans requests */
561 uint16 call; /* for trans2 and nttrans requests */
563 bool close_on_completion;
564 bool one_way;
566 unsigned int setup_count;
567 uint16 *setup;
569 size_t received_data;
570 size_t received_param;
572 size_t total_param;
573 char *param;
575 size_t total_data;
576 char *data;
580 * Info about an alternate data stream
583 struct stream_struct {
584 SMB_OFF_T size;
585 SMB_OFF_T alloc_size;
586 char *name;
589 /* Include VFS stuff */
591 #include "smb_acls.h"
592 #include "vfs.h"
594 struct dfree_cached_info {
595 time_t last_dfree_time;
596 SMB_BIG_UINT dfree_ret;
597 SMB_BIG_UINT bsize;
598 SMB_BIG_UINT dfree;
599 SMB_BIG_UINT dsize;
602 struct dptr_struct;
604 struct share_params {
605 int service;
608 struct share_iterator {
609 int next_id;
612 typedef struct connection_struct {
613 struct connection_struct *next, *prev;
614 TALLOC_CTX *mem_ctx; /* long-lived memory context for things hanging off this struct. */
615 unsigned cnum; /* an index passed over the wire */
616 struct share_params *params;
617 bool force_user;
618 bool force_group;
619 struct vuid_cache vuid_cache;
620 struct dptr_struct *dirptr;
621 bool printer;
622 bool ipc;
623 bool read_only; /* Attributes for the current user of the share. */
624 bool admin_user; /* Attributes for the current user of the share. */
625 char *dirpath;
626 char *connectpath;
627 char *origpath;
629 struct vfs_ops vfs; /* Filesystem operations */
630 struct vfs_ops vfs_opaque; /* OPAQUE Filesystem operations */
631 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
633 char *user; /* name of user who *opened* this connection */
634 uid_t uid; /* uid of user who *opened* this connection */
635 gid_t gid; /* gid of user who *opened* this connection */
636 char client_address[INET6_ADDRSTRLEN]; /* String version of client IP address. */
638 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
640 /* following groups stuff added by ih */
642 /* This groups info is valid for the user that *opened* the connection */
643 size_t ngroups;
644 gid_t *groups;
645 NT_USER_TOKEN *nt_user_token;
647 time_t lastused;
648 time_t lastused_count;
649 bool used;
650 int num_files_open;
651 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
652 int encrypt_level;
653 bool encrypted_tid;
655 /* Semantics requested by the client or forced by the server config. */
656 bool case_sensitive;
657 bool case_preserve;
658 bool short_case_preserve;
660 /* Semantics provided by the underlying filesystem. */
661 int fs_capabilities;
663 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
664 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
665 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
666 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
667 struct dfree_cached_info *dfree_info;
668 struct trans_state *pending_trans;
669 struct notify_context *notify_ctx;
670 } connection_struct;
672 struct current_user {
673 connection_struct *conn;
674 uint16 vuid;
675 UNIX_USER_TOKEN ut;
676 NT_USER_TOKEN *nt_user_token;
679 struct smb_request {
680 uint16 flags2;
681 uint16 smbpid;
682 uint16 mid;
683 uint16 vuid;
684 uint16 tid;
685 uint8 wct;
686 const uint8 *inbuf;
687 uint8 *outbuf;
688 size_t unread_bytes;
689 bool encrypted;
690 connection_struct *conn;
693 /* Defines for the sent_oplock_break field above. */
694 #define NO_BREAK_SENT 0
695 #define BREAK_TO_NONE_SENT 1
696 #define LEVEL_II_BREAK_SENT 2
698 typedef struct {
699 fstring smb_name; /* user name from the client */
700 fstring unix_name; /* unix user name of a validated user */
701 fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
702 fstring domain; /* domain that the client specified */
703 } userdom_struct;
705 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
707 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
708 LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
710 typedef struct _print_queue_struct {
711 int job; /* normally the UNIX jobid -- see note in
712 printing.c:traverse_fn_delete() */
713 int size;
714 int page_count;
715 int status;
716 int priority;
717 time_t time;
718 fstring fs_user;
719 fstring fs_file;
720 } print_queue_struct;
722 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
724 typedef struct {
725 fstring message;
726 int qcount;
727 int status;
728 } print_status_struct;
730 /* used for server information: client, nameserv and ipc */
731 struct server_info_struct {
732 fstring name;
733 uint32 type;
734 fstring comment;
735 fstring domain; /* used ONLY in ipc.c NOT namework.c */
736 bool server_added; /* used ONLY in ipc.c NOT namework.c */
739 /* used for network interfaces */
740 struct interface {
741 struct interface *next, *prev;
742 char *name;
743 int flags;
744 struct sockaddr_storage ip;
745 struct sockaddr_storage netmask;
746 struct sockaddr_storage bcast;
749 /* Internal message queue for deferred opens. */
750 struct pending_message_list {
751 struct pending_message_list *next, *prev;
752 struct timeval request_time; /* When was this first issued? */
753 struct timeval end_time; /* When does this time out? */
754 bool encrypted;
755 DATA_BLOB buf;
756 DATA_BLOB private_data;
759 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
760 #define SHARE_MODE_ALLOW_INITIAL_DELETE_ON_CLOSE 0x2
762 /* struct returned by get_share_modes */
763 struct share_mode_entry {
764 struct server_id pid;
765 uint16 op_mid;
766 uint16 op_type;
767 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
768 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
769 uint32 private_options; /* NT Create options, but we only look at
770 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
771 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
772 * smbstatus and swat */
773 struct timeval time;
774 struct file_id id;
775 unsigned long share_file_id;
776 uint32 uid; /* uid of file opener. */
777 uint16 flags; /* See SHARE_MODE_XX above. */
780 /* oplock break message definition - linearization of share_mode_entry.
782 Offset Data length.
783 0 struct server_id pid 4
784 4 uint16 op_mid 2
785 6 uint16 op_type 2
786 8 uint32 access_mask 4
787 12 uint32 share_access 4
788 16 uint32 private_options 4
789 20 uint32 time sec 4
790 24 uint32 time usec 4
791 28 SMB_DEV_T dev 8 bytes.
792 36 SMB_INO_T inode 8 bytes
793 44 unsigned long file_id 4 bytes
794 48 uint32 uid 4 bytes
795 52 uint16 flags 2 bytes
799 #ifdef CLUSTER_SUPPORT
800 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 58
801 #else
802 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 54
803 #endif
805 struct share_mode_lock {
806 const char *servicepath; /* canonicalized. */
807 const char *filename;
808 struct file_id id;
809 int num_share_modes;
810 struct share_mode_entry *share_modes;
811 UNIX_USER_TOKEN *delete_token;
812 bool delete_on_close;
813 bool fresh;
814 bool modified;
815 struct db_record *record;
819 * Internal structure of locking.tdb share mode db.
820 * Used by locking.c and libsmbsharemodes.c
823 struct locking_data {
824 union {
825 struct {
826 int num_share_mode_entries;
827 bool delete_on_close;
828 uint32 delete_token_size; /* Only valid if either of
829 the two previous fields
830 are True. */
831 } s;
832 struct share_mode_entry dummy; /* Needed for alignment. */
833 } u;
834 /* The following four entries are implicit
835 struct share_mode_entry modes[num_share_mode_entries];
836 char unix_token[delete_token_size] (divisible by 4).
837 char share_name[];
838 char file_name[];
842 /* Used to store pipe open records for NetFileEnum() */
844 struct pipe_open_rec {
845 struct server_id pid;
846 uid_t uid;
847 int pnum;
848 fstring name;
852 #define NT_HASH_LEN 16
853 #define LM_HASH_LEN 16
855 /* Password history contants. */
856 #define PW_HISTORY_SALT_LEN 16
857 #define SALTED_MD5_HASH_LEN 16
858 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
859 #define MAX_PW_HISTORY_LEN 24
862 * Flags for account policy.
864 #define AP_MIN_PASSWORD_LEN 1
865 #define AP_PASSWORD_HISTORY 2
866 #define AP_USER_MUST_LOGON_TO_CHG_PASS 3
867 #define AP_MAX_PASSWORD_AGE 4
868 #define AP_MIN_PASSWORD_AGE 5
869 #define AP_LOCK_ACCOUNT_DURATION 6
870 #define AP_RESET_COUNT_TIME 7
871 #define AP_BAD_ATTEMPT_LOCKOUT 8
872 #define AP_TIME_TO_LOGOUT 9
873 #define AP_REFUSE_MACHINE_PW_CHANGE 10
876 * Flags for local user manipulation.
879 #define LOCAL_ADD_USER 0x1
880 #define LOCAL_DELETE_USER 0x2
881 #define LOCAL_DISABLE_USER 0x4
882 #define LOCAL_ENABLE_USER 0x8
883 #define LOCAL_TRUST_ACCOUNT 0x10
884 #define LOCAL_SET_NO_PASSWORD 0x20
885 #define LOCAL_SET_PASSWORD 0x40
886 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
887 #define LOCAL_INTERDOM_ACCOUNT 0x100
888 #define LOCAL_AM_ROOT 0x200 /* Act as root */
890 /* key and data in the connections database - used in smbstatus and smbd */
891 struct connections_key {
892 struct server_id pid;
893 int cnum;
894 fstring name;
897 struct connections_data {
898 int magic;
899 struct server_id pid;
900 int cnum;
901 uid_t uid;
902 gid_t gid;
903 char servicename[FSTRING_LEN];
904 char addr[24];
905 char machine[FSTRING_LEN];
906 time_t start;
907 uint32 bcast_msg_flags;
911 /* the following are used by loadparm for option lists */
912 typedef enum {
913 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
914 P_STRING,P_USTRING,P_ENUM,P_SEP
915 } parm_type;
917 typedef enum {
918 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
919 } parm_class;
921 struct enum_list {
922 int value;
923 const char *name;
926 struct parm_struct {
927 const char *label;
928 parm_type type;
929 parm_class p_class;
930 void *ptr;
931 bool (*special)(int snum, const char *, char **);
932 const struct enum_list *enum_list;
933 unsigned flags;
934 union {
935 bool bvalue;
936 int ivalue;
937 char *svalue;
938 char cvalue;
939 char **lvalue;
940 } def;
943 /* The following flags are used in SWAT */
944 #define FLAG_BASIC 0x0001 /* Display only in BASIC view */
945 #define FLAG_SHARE 0x0002 /* file sharing options */
946 #define FLAG_PRINT 0x0004 /* printing options */
947 #define FLAG_GLOBAL 0x0008 /* local options that should be globally settable in SWAT */
948 #define FLAG_WIZARD 0x0010 /* Parameters that the wizard will operate on */
949 #define FLAG_ADVANCED 0x0020 /* Parameters that will be visible in advanced view */
950 #define FLAG_DEVELOPER 0x0040 /* No longer used */
951 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
952 #define FLAG_HIDE 0x2000 /* options that should be hidden in SWAT */
953 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
955 struct bitmap {
956 uint32 *b;
957 unsigned int n;
960 /* offsets into message for common items */
961 #define smb_com 8
962 #define smb_rcls 9
963 #define smb_reh 10
964 #define smb_err 11
965 #define smb_flg 13
966 #define smb_flg2 14
967 #define smb_pidhigh 16
968 #define smb_ss_field 18
969 #define smb_tid 28
970 #define smb_pid 30
971 #define smb_uid 32
972 #define smb_mid 34
973 #define smb_wct 36
974 #define smb_vwv 37
975 #define smb_vwv0 37
976 #define smb_vwv1 39
977 #define smb_vwv2 41
978 #define smb_vwv3 43
979 #define smb_vwv4 45
980 #define smb_vwv5 47
981 #define smb_vwv6 49
982 #define smb_vwv7 51
983 #define smb_vwv8 53
984 #define smb_vwv9 55
985 #define smb_vwv10 57
986 #define smb_vwv11 59
987 #define smb_vwv12 61
988 #define smb_vwv13 63
989 #define smb_vwv14 65
990 #define smb_vwv15 67
991 #define smb_vwv16 69
992 #define smb_vwv17 71
994 /* flag defines. CIFS spec 3.1.1 */
995 #define FLAG_SUPPORT_LOCKREAD 0x01
996 #define FLAG_CLIENT_BUF_AVAIL 0x02
997 #define FLAG_RESERVED 0x04
998 #define FLAG_CASELESS_PATHNAMES 0x08
999 #define FLAG_CANONICAL_PATHNAMES 0x10
1000 #define FLAG_REQUEST_OPLOCK 0x20
1001 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
1002 #define FLAG_REPLY 0x80
1004 /* the complete */
1005 #define SMBmkdir 0x00 /* create directory */
1006 #define SMBrmdir 0x01 /* delete directory */
1007 #define SMBopen 0x02 /* open file */
1008 #define SMBcreate 0x03 /* create file */
1009 #define SMBclose 0x04 /* close file */
1010 #define SMBflush 0x05 /* flush file */
1011 #define SMBunlink 0x06 /* delete file */
1012 #define SMBmv 0x07 /* rename file */
1013 #define SMBgetatr 0x08 /* get file attributes */
1014 #define SMBsetatr 0x09 /* set file attributes */
1015 #define SMBread 0x0A /* read from file */
1016 #define SMBwrite 0x0B /* write to file */
1017 #define SMBlock 0x0C /* lock byte range */
1018 #define SMBunlock 0x0D /* unlock byte range */
1019 #define SMBctemp 0x0E /* create temporary file */
1020 #define SMBmknew 0x0F /* make new file */
1021 #define SMBcheckpath 0x10 /* check directory path */
1022 #define SMBexit 0x11 /* process exit */
1023 #define SMBlseek 0x12 /* seek */
1024 #define SMBtcon 0x70 /* tree connect */
1025 #define SMBtconX 0x75 /* tree connect and X*/
1026 #define SMBtdis 0x71 /* tree disconnect */
1027 #define SMBnegprot 0x72 /* negotiate protocol */
1028 #define SMBdskattr 0x80 /* get disk attributes */
1029 #define SMBsearch 0x81 /* search directory */
1030 #define SMBsplopen 0xC0 /* open print spool file */
1031 #define SMBsplwr 0xC1 /* write to print spool file */
1032 #define SMBsplclose 0xC2 /* close print spool file */
1033 #define SMBsplretq 0xC3 /* return print queue */
1034 #define SMBsends 0xD0 /* send single block message */
1035 #define SMBsendb 0xD1 /* send broadcast message */
1036 #define SMBfwdname 0xD2 /* forward user name */
1037 #define SMBcancelf 0xD3 /* cancel forward */
1038 #define SMBgetmac 0xD4 /* get machine name */
1039 #define SMBsendstrt 0xD5 /* send start of multi-block message */
1040 #define SMBsendend 0xD6 /* send end of multi-block message */
1041 #define SMBsendtxt 0xD7 /* send text of multi-block message */
1043 /* Core+ protocol */
1044 #define SMBlockread 0x13 /* Lock a range and read */
1045 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1046 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
1047 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
1048 #define SMBwritec 0x20 /* secondary write request */
1049 #define SMBwriteclose 0x2c /* write a file then close it */
1051 /* dos extended protocol */
1052 #define SMBreadBraw 0x1A /* read block raw */
1053 #define SMBreadBmpx 0x1B /* read block multiplexed */
1054 #define SMBreadBs 0x1C /* read block (secondary response) */
1055 #define SMBwriteBraw 0x1D /* write block raw */
1056 #define SMBwriteBmpx 0x1E /* write block multiplexed */
1057 #define SMBwriteBs 0x1F /* write block (secondary request) */
1058 #define SMBwriteC 0x20 /* write complete response */
1059 #define SMBsetattrE 0x22 /* set file attributes expanded */
1060 #define SMBgetattrE 0x23 /* get file attributes expanded */
1061 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
1062 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
1063 #define SMBtranss 0x26 /* transaction (secondary request/response) */
1064 #define SMBioctl 0x27 /* IOCTL */
1065 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
1066 #define SMBcopy 0x29 /* copy */
1067 #define SMBmove 0x2A /* move */
1068 #define SMBecho 0x2B /* echo */
1069 #define SMBopenX 0x2D /* open and X */
1070 #define SMBreadX 0x2E /* read and X */
1071 #define SMBwriteX 0x2F /* write and X */
1072 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
1073 #define SMBffirst 0x82 /* find first */
1074 #define SMBfunique 0x83 /* find unique */
1075 #define SMBfclose 0x84 /* find close */
1076 #define SMBkeepalive 0x85 /* keepalive */
1077 #define SMBinvalid 0xFE /* invalid command */
1079 /* Extended 2.0 protocol */
1080 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1081 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1082 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1083 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1084 #define SMBulogoffX 0x74 /* user logoff */
1086 /* NT SMB extensions. */
1087 #define SMBnttrans 0xA0 /* NT transact */
1088 #define SMBnttranss 0xA1 /* NT transact secondary */
1089 #define SMBntcreateX 0xA2 /* NT create and X */
1090 #define SMBntcancel 0xA4 /* NT cancel */
1091 #define SMBntrename 0xA5 /* NT rename */
1093 /* These are the trans subcommands */
1094 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
1095 #define TRANSACT_DCERPCCMD 0x26
1096 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1098 /* These are the TRANS2 sub commands */
1099 #define TRANSACT2_OPEN 0x00
1100 #define TRANSACT2_FINDFIRST 0x01
1101 #define TRANSACT2_FINDNEXT 0x02
1102 #define TRANSACT2_QFSINFO 0x03
1103 #define TRANSACT2_SETFSINFO 0x04
1104 #define TRANSACT2_QPATHINFO 0x05
1105 #define TRANSACT2_SETPATHINFO 0x06
1106 #define TRANSACT2_QFILEINFO 0x07
1107 #define TRANSACT2_SETFILEINFO 0x08
1108 #define TRANSACT2_FSCTL 0x09
1109 #define TRANSACT2_IOCTL 0x0A
1110 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
1111 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
1112 #define TRANSACT2_MKDIR 0x0D
1113 #define TRANSACT2_SESSION_SETUP 0x0E
1114 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1115 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1117 /* These are the NT transact sub commands. */
1118 #define NT_TRANSACT_CREATE 1
1119 #define NT_TRANSACT_IOCTL 2
1120 #define NT_TRANSACT_SET_SECURITY_DESC 3
1121 #define NT_TRANSACT_NOTIFY_CHANGE 4
1122 #define NT_TRANSACT_RENAME 5
1123 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1124 #define NT_TRANSACT_GET_USER_QUOTA 7
1125 #define NT_TRANSACT_SET_USER_QUOTA 8
1127 /* These are the NT transact_get_user_quota sub commands */
1128 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
1129 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
1130 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
1132 /* Relevant IOCTL codes */
1133 #define IOCTL_QUERY_JOB_INFO 0x530060
1135 /* these are the trans2 sub fields for primary requests */
1136 #define smb_tpscnt smb_vwv0
1137 #define smb_tdscnt smb_vwv1
1138 #define smb_mprcnt smb_vwv2
1139 #define smb_mdrcnt smb_vwv3
1140 #define smb_msrcnt smb_vwv4
1141 #define smb_flags smb_vwv5
1142 #define smb_timeout smb_vwv6
1143 #define smb_pscnt smb_vwv9
1144 #define smb_psoff smb_vwv10
1145 #define smb_dscnt smb_vwv11
1146 #define smb_dsoff smb_vwv12
1147 #define smb_suwcnt smb_vwv13
1148 #define smb_setup smb_vwv14
1149 #define smb_setup0 smb_setup
1150 #define smb_setup1 (smb_setup+2)
1151 #define smb_setup2 (smb_setup+4)
1153 /* these are for the secondary requests */
1154 #define smb_spscnt smb_vwv2
1155 #define smb_spsoff smb_vwv3
1156 #define smb_spsdisp smb_vwv4
1157 #define smb_sdscnt smb_vwv5
1158 #define smb_sdsoff smb_vwv6
1159 #define smb_sdsdisp smb_vwv7
1160 #define smb_sfid smb_vwv8
1162 /* and these for responses */
1163 #define smb_tprcnt smb_vwv0
1164 #define smb_tdrcnt smb_vwv1
1165 #define smb_prcnt smb_vwv3
1166 #define smb_proff smb_vwv4
1167 #define smb_prdisp smb_vwv5
1168 #define smb_drcnt smb_vwv6
1169 #define smb_droff smb_vwv7
1170 #define smb_drdisp smb_vwv8
1172 /* these are for the NT trans primary request. */
1173 #define smb_nt_MaxSetupCount smb_vwv0
1174 #define smb_nt_Flags (smb_vwv0 + 1)
1175 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1176 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1177 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1178 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1179 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1180 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1181 #define smb_nt_DataCount (smb_vwv0 + 27)
1182 #define smb_nt_DataOffset (smb_vwv0 + 31)
1183 #define smb_nt_SetupCount (smb_vwv0 + 35)
1184 #define smb_nt_Function (smb_vwv0 + 36)
1185 #define smb_nt_SetupStart (smb_vwv0 + 38)
1187 /* these are for the NT trans secondary request. */
1188 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1189 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1190 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1191 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1192 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1193 #define smb_nts_DataCount (smb_vwv0 + 23)
1194 #define smb_nts_DataOffset (smb_vwv0 + 27)
1195 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1197 /* these are for the NT trans reply. */
1198 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1199 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1200 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1201 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1202 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1203 #define smb_ntr_DataCount (smb_vwv0 + 23)
1204 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1205 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1207 /* these are for the NT create_and_X */
1208 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1209 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1210 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1211 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1212 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1213 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1214 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1215 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1216 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1217 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1218 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1220 /* this is used on a TConX. I'm not sure the name is very helpful though */
1221 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1222 #define SMB_SHARE_IN_DFS 0x0002
1224 /* Named pipe write mode flags. Used in writeX calls. */
1225 #define PIPE_RAW_MODE 0x4
1226 #define PIPE_START_MESSAGE 0x8
1228 /* File Specific access rights */
1229 #define FILE_READ_DATA 0x00000001
1230 #define FILE_WRITE_DATA 0x00000002
1231 #define FILE_APPEND_DATA 0x00000004
1232 #define FILE_READ_EA 0x00000008 /* File and directory */
1233 #define FILE_WRITE_EA 0x00000010 /* File and directory */
1234 #define FILE_EXECUTE 0x00000020
1235 #define FILE_DELETE_CHILD 0x00000040
1236 #define FILE_READ_ATTRIBUTES 0x00000080
1237 #define FILE_WRITE_ATTRIBUTES 0x00000100
1239 #define FILE_ALL_ACCESS 0x000001FF
1241 /* Directory specific access rights */
1242 #define FILE_LIST_DIRECTORY 0x00000001
1243 #define FILE_ADD_FILE 0x00000002
1244 #define FILE_ADD_SUBDIRECTORY 0x00000004
1245 #define FILE_TRAVERSE 0x00000020
1246 #define FILE_DELETE_CHILD 0x00000040
1248 /* the desired access to use when opening a pipe */
1249 #define DESIRED_ACCESS_PIPE 0x2019f
1251 /* Generic access masks & rights. */
1252 #define DELETE_ACCESS 0x00010000 /* (1L<<16) */
1253 #define READ_CONTROL_ACCESS 0x00020000 /* (1L<<17) */
1254 #define WRITE_DAC_ACCESS 0x00040000 /* (1L<<18) */
1255 #define WRITE_OWNER_ACCESS 0x00080000 /* (1L<<19) */
1256 #define SYNCHRONIZE_ACCESS 0x00100000 /* (1L<<20) */
1258 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1259 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1260 #define GENERIC_ALL_ACCESS 0x10000000 /* (1<<28) */
1261 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1262 #define GENERIC_WRITE_ACCESS 0x40000000 /* (1<<30) */
1263 #define GENERIC_READ_ACCESS ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1265 /* Mapping of generic access rights for files to specific rights. */
1267 /* This maps to 0x1F01FF */
1268 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1270 /* This maps to 0x120089 */
1271 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1272 FILE_READ_EA|SYNCHRONIZE_ACCESS)
1274 /* This maps to 0x120116 */
1275 #define FILE_GENERIC_WRITE (STD_RIGHT_READ_CONTROL_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1276 FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1278 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|\
1279 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1281 /* Share specific rights. */
1282 #define SHARE_ALL_ACCESS FILE_GENERIC_ALL
1283 #define SHARE_READ_ONLY (FILE_GENERIC_READ|FILE_EXECUTE)
1285 /* Mapping of access rights to UNIX perms. */
1286 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
1287 #define UNIX_ACCESS_R FILE_GENERIC_READ
1288 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
1289 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
1291 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1292 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
1293 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
1294 #define UNIX_DIRECTORY_ACCESS_W FILE_GENERIC_WRITE
1295 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
1297 #if 0
1299 * This is the old mapping we used to use. To get W2KSP2 profiles
1300 * working we need to map to the canonical file perms.
1302 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1303 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1304 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1305 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1306 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1307 FILE_APPEND_DATA|FILE_WRITE_DATA)
1308 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1309 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1310 #endif
1312 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1314 /* Flags field. */
1315 #define REQUEST_OPLOCK 2
1316 #define REQUEST_BATCH_OPLOCK 4
1317 #define OPEN_DIRECTORY 8
1318 #define EXTENDED_RESPONSE_REQUIRED 0x10
1320 /* ShareAccess field. */
1321 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1322 #define FILE_SHARE_READ 1
1323 #define FILE_SHARE_WRITE 2
1324 #define FILE_SHARE_DELETE 4
1326 /* FileAttributesField */
1327 #define FILE_ATTRIBUTE_READONLY 0x001L
1328 #define FILE_ATTRIBUTE_HIDDEN 0x002L
1329 #define FILE_ATTRIBUTE_SYSTEM 0x004L
1330 #define FILE_ATTRIBUTE_DIRECTORY 0x010L
1331 #define FILE_ATTRIBUTE_ARCHIVE 0x020L
1332 #define FILE_ATTRIBUTE_NORMAL 0x080L
1333 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1334 #define FILE_ATTRIBUTE_SPARSE 0x200L
1335 #define FILE_ATTRIBUTE_REPARSE_POINT 0x400L
1336 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1337 #define FILE_ATTRIBUTE_OFFLINE 0x1000L
1338 #define FILE_ATTRIBUTE_NONINDEXED 0x2000L
1339 #define FILE_ATTRIBUTE_ENCRYPTED 0x4000L
1340 #define SAMBA_ATTRIBUTES_MASK 0x7F
1342 /* Flags - combined with attributes. */
1343 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1344 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1345 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1346 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1347 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1348 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1349 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1351 /* CreateDisposition field. */
1352 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
1353 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
1354 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
1355 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
1356 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
1357 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
1359 /* CreateOptions field. */
1360 #define FILE_DIRECTORY_FILE 0x0001
1361 #define FILE_WRITE_THROUGH 0x0002
1362 #define FILE_SEQUENTIAL_ONLY 0x0004
1363 #define FILE_NON_DIRECTORY_FILE 0x0040
1364 #define FILE_NO_EA_KNOWLEDGE 0x0200
1365 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1366 #define FILE_RANDOM_ACCESS 0x0800
1367 #define FILE_DELETE_ON_CLOSE 0x1000
1368 #define FILE_OPEN_BY_FILE_ID 0x2000
1370 /* Private create options used by the ntcreatex processing code. From Samba4. */
1371 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x01000000
1372 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x02000000
1374 /* Private options for streams support */
1375 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x04000000
1377 /* Responses when opening a file. */
1378 #define FILE_WAS_SUPERSEDED 0
1379 #define FILE_WAS_OPENED 1
1380 #define FILE_WAS_CREATED 2
1381 #define FILE_WAS_OVERWRITTEN 3
1383 /* File type flags */
1384 #define FILE_TYPE_DISK 0
1385 #define FILE_TYPE_BYTE_MODE_PIPE 1
1386 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1387 #define FILE_TYPE_PRINTER 3
1388 #define FILE_TYPE_COMM_DEVICE 4
1389 #define FILE_TYPE_UNKNOWN 0xFFFF
1391 /* Flag for NT transact rename call. */
1392 #define RENAME_REPLACE_IF_EXISTS 1
1394 /* flags for SMBntrename call (from Samba4) */
1395 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1396 #define RENAME_FLAG_HARD_LINK 0x103
1397 #define RENAME_FLAG_RENAME 0x104
1398 #define RENAME_FLAG_COPY 0x105
1400 /* Filesystem Attributes. */
1401 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
1402 #define FILE_CASE_PRESERVED_NAMES 0x00000002
1403 #define FILE_UNICODE_ON_DISK 0x00000004
1404 /* According to cifs9f, this is 4, not 8 */
1405 /* Acconding to testing, this actually sets the security attribute! */
1406 #define FILE_PERSISTENT_ACLS 0x00000008
1407 #define FILE_FILE_COMPRESSION 0x00000010
1408 #define FILE_VOLUME_QUOTAS 0x00000020
1409 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
1410 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
1411 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
1412 #define FS_LFN_APIS 0x00004000
1413 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
1414 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
1415 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
1416 #define FILE_NAMED_STREAMS 0x00040000
1417 #define FILE_READ_ONLY_VOLUME 0x00080000
1419 /* ChangeNotify flags. */
1420 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1421 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1422 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1423 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1424 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1425 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1426 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1427 #define FILE_NOTIFY_CHANGE_EA 0x080
1428 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1429 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1430 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1431 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1433 #define FILE_NOTIFY_CHANGE_NAME \
1434 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1436 /* change notify action results */
1437 #define NOTIFY_ACTION_ADDED 1
1438 #define NOTIFY_ACTION_REMOVED 2
1439 #define NOTIFY_ACTION_MODIFIED 3
1440 #define NOTIFY_ACTION_OLD_NAME 4
1441 #define NOTIFY_ACTION_NEW_NAME 5
1442 #define NOTIFY_ACTION_ADDED_STREAM 6
1443 #define NOTIFY_ACTION_REMOVED_STREAM 7
1444 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1447 /* where to find the base of the SMB packet proper */
1448 #define smb_base(buf) (((char *)(buf))+4)
1450 /* we don't allow server strings to be longer than 48 characters as
1451 otherwise NT will not honour the announce packets */
1452 #define MAX_SERVER_STRING_LENGTH 48
1455 #define SMB_SUCCESS 0 /* The request was successful. */
1457 #ifdef WITH_DFS
1458 void dfs_unlogin(void);
1459 extern int dcelogin_atmost_once;
1460 #endif
1462 #ifdef NOSTRDUP
1463 char *strdup(char *s);
1464 #endif
1466 #ifndef SIGNAL_CAST
1467 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1468 #endif
1470 #ifndef SELECT_CAST
1471 #define SELECT_CAST
1472 #endif
1474 /* This was set by JHT in liaison with Jeremy Allison early 1997
1475 * History:
1476 * Version 4.0 - never made public
1477 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1478 * - Reappeared in 1.9.16p11 with fixed smbd services
1479 * Version 4.20 - To indicate that nmbd and browsing now works better
1480 * Version 4.50 - Set at release of samba-2.2.0 by JHT
1482 * Note: In the presence of NT4.X do not set above 4.9
1483 * Setting this above 4.9 can have undesired side-effects.
1484 * This may change again in Samba-3.0 after further testing. JHT
1487 #define DEFAULT_MAJOR_VERSION 0x04
1488 #define DEFAULT_MINOR_VERSION 0x09
1490 /* Browser Election Values */
1491 #define BROWSER_ELECTION_VERSION 0x010f
1492 #define BROWSER_CONSTANT 0xaa55
1494 /* Sercurity mode bits. */
1495 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
1496 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
1497 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
1498 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
1500 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1502 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1503 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1504 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1505 #define FLAGS2_UNKNOWN_BIT4 0x0010
1506 #define FLAGS2_IS_LONG_NAME 0x0040
1507 #define FLAGS2_EXTENDED_SECURITY 0x0800
1508 #define FLAGS2_DFS_PATHNAMES 0x1000
1509 #define FLAGS2_READ_PERMIT_EXECUTE 0x2000
1510 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1511 #define FLAGS2_UNICODE_STRINGS 0x8000
1513 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1515 /* TCONX Flag (smb_vwv2). */
1516 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
1518 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1520 #define CAP_RAW_MODE 0x0001
1521 #define CAP_MPX_MODE 0x0002
1522 #define CAP_UNICODE 0x0004
1523 #define CAP_LARGE_FILES 0x0008
1524 #define CAP_NT_SMBS 0x0010
1525 #define CAP_RPC_REMOTE_APIS 0x0020
1526 #define CAP_STATUS32 0x0040
1527 #define CAP_LEVEL_II_OPLOCKS 0x0080
1528 #define CAP_LOCK_AND_READ 0x0100
1529 #define CAP_NT_FIND 0x0200
1530 #define CAP_DFS 0x1000
1531 #define CAP_W2K_SMBS 0x2000
1532 #define CAP_LARGE_READX 0x4000
1533 #define CAP_LARGE_WRITEX 0x8000
1534 #define CAP_UNIX 0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1535 #define CAP_EXTENDED_SECURITY 0x80000000
1537 /* protocol types. It assumes that higher protocols include lower protocols
1538 as subsets */
1539 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1541 /* security levels */
1542 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1544 /* server roles */
1545 enum server_types {
1546 ROLE_STANDALONE,
1547 ROLE_DOMAIN_MEMBER,
1548 ROLE_DOMAIN_BDC,
1549 ROLE_DOMAIN_PDC
1552 /* printing types */
1553 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1554 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1555 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1556 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1557 ,PRINT_TEST,PRINT_VLP
1558 #endif /* DEVELOPER */
1561 /* LDAP schema types */
1562 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1564 /* LDAP SSL options */
1565 enum ldap_ssl_types {LDAP_SSL_ON, LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1567 /* LDAP PASSWD SYNC methods */
1568 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1570 /* Remote architectures we know about. */
1571 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1572 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1573 RA_SAMBA, RA_CIFSFS};
1575 /* case handling */
1576 enum case_handling {CASE_LOWER,CASE_UPPER};
1578 /* ACL compatibility */
1579 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1581 * Global value meaing that the smb_uid field should be
1582 * ingored (in share level security and protocol level == CORE)
1585 #define UID_FIELD_INVALID 0
1586 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1589 * Size of buffer to use when moving files across filesystems.
1591 #define COPYBUF_SIZE (8*1024)
1594 * Used in chaining code.
1596 extern int chain_size;
1599 * Map the Core and Extended Oplock requesst bits down
1600 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1604 * Core protocol.
1606 #define CORE_OPLOCK_REQUEST(inbuf) \
1607 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1610 * Extended protocol.
1612 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1614 /* Lock types. */
1615 #define LOCKING_ANDX_SHARED_LOCK 0x1
1616 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1617 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1618 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1619 #define LOCKING_ANDX_LARGE_FILES 0x10
1622 * Bits we test with.
1623 * Note these must fit into 16-bits.
1626 #define NO_OPLOCK 0x0
1627 #define EXCLUSIVE_OPLOCK 0x1
1628 #define BATCH_OPLOCK 0x2
1629 #define LEVEL_II_OPLOCK 0x4
1631 /* The following are Samba-private. */
1632 #define INTERNAL_OPEN_ONLY 0x8
1633 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
1634 * inform potential level2 holders on
1635 * write. */
1636 #define DEFERRED_OPEN_ENTRY 0x20
1637 #define UNUSED_SHARE_MODE_ENTRY 0x40
1638 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
1640 /* None of the following should ever appear in fsp->oplock_request. */
1641 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1643 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1644 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1645 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1647 struct inform_level2_message {
1648 SMB_DEV_T dev;
1649 SMB_INO_T inode;
1650 uint16 mid;
1651 unsigned long target_file_id;
1652 unsigned long source_file_id;
1655 /* kernel_oplock_message definition.
1657 struct kernel_oplock_message {
1658 SMB_DEV_T dev;
1659 SMB_INO_T inode;
1660 unsigned long file_id;
1663 Offset Data length.
1664 0 SMB_DEV_T dev 8 bytes.
1665 8 SMB_INO_T inode 8 bytes
1666 16 unsigned long file_id 4 bytes
1670 #define MSG_SMB_KERNEL_BREAK_SIZE 20
1672 /* file_renamed_message definition.
1674 struct file_renamed_message {
1675 SMB_DEV_T dev;
1676 SMB_INO_T inode;
1677 char names[1]; A variable area containing sharepath and filename.
1680 Offset Data length.
1681 0 SMB_DEV_T dev 8 bytes.
1682 8 SMB_INO_T inode 8 bytes
1683 16 char [] name zero terminated namelen bytes
1684 minimum length == 18.
1688 #define MSG_FILE_RENAMED_MIN_SIZE 16
1691 * On the wire return values for oplock types.
1694 #define CORE_OPLOCK_GRANTED (1<<5)
1695 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1697 #define NO_OPLOCK_RETURN 0
1698 #define EXCLUSIVE_OPLOCK_RETURN 1
1699 #define BATCH_OPLOCK_RETURN 2
1700 #define LEVEL_II_OPLOCK_RETURN 3
1702 /* Oplock levels */
1703 #define OPLOCKLEVEL_NONE 0
1704 #define OPLOCKLEVEL_II 1
1707 * Capabilities abstracted for different systems.
1710 enum smbd_capability {
1711 KERNEL_OPLOCK_CAPABILITY,
1712 DMAPI_ACCESS_CAPABILITY
1715 /* if a kernel does support oplocks then a structure of the following
1716 typee is used to describe how to interact with the kernel */
1717 struct kernel_oplocks {
1718 files_struct * (*receive_message)(fd_set *fds);
1719 bool (*set_oplock)(files_struct *fsp, int oplock_type);
1720 void (*release_oplock)(files_struct *fsp);
1721 bool (*msg_waiting)(fd_set *fds);
1722 int notification_fd;
1725 #include "smb_macros.h"
1727 #define MAX_NETBIOSNAME_LEN 16
1728 /* DOS character, NetBIOS namestring. Type used on the wire. */
1729 typedef char nstring[MAX_NETBIOSNAME_LEN];
1730 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1731 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1733 /* A netbios name structure. */
1734 struct nmb_name {
1735 nstring name;
1736 char scope[64];
1737 unsigned int name_type;
1740 /* A netbios node status array element. */
1741 typedef struct node_status_ {
1742 nstring name;
1743 unsigned char type;
1744 unsigned char flags;
1745 } NODE_STATUS_STRUCT;
1747 /* The extra info from a NetBIOS node status query */
1748 struct node_status_extra {
1749 unsigned char mac_addr[6];
1750 /* There really is more here ... */
1753 struct pwd_info {
1754 bool null_pwd;
1755 bool cleartext;
1757 fstring password;
1760 /* For split krb5 SPNEGO blobs. */
1761 struct pending_auth_data {
1762 struct pending_auth_data *prev, *next;
1763 uint16 vuid; /* Tag for this entry. */
1764 uint16 smbpid; /* Alternate tag for this entry. */
1765 size_t needed_len;
1766 DATA_BLOB partial_data;
1769 typedef struct user_struct {
1770 struct user_struct *next, *prev;
1771 uint16 vuid; /* Tag for this entry. */
1772 uid_t uid; /* uid of a validated user */
1773 gid_t gid; /* gid of a validated user */
1775 userdom_struct user;
1776 const char *homedir;
1777 const char *unix_homedir;
1778 const char *logon_script;
1780 bool guest;
1782 /* following groups stuff added by ih */
1783 /* This groups info is needed for when we become_user() for this uid */
1784 int n_groups;
1785 gid_t *groups;
1787 NT_USER_TOKEN *nt_user_token;
1789 DATA_BLOB session_key;
1791 char *session_keystr; /* used by utmp and pam session code.
1792 TDB key string */
1793 int homes_snum;
1795 struct auth_serversupplied_info *server_info;
1797 struct auth_ntlmssp_state *auth_ntlmssp_state;
1798 } user_struct;
1800 struct unix_error_map {
1801 int unix_error;
1802 int dos_class;
1803 int dos_code;
1804 NTSTATUS nt_error;
1808 * Size of new password account encoding string. This is enough space to
1809 * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1810 * Do not change unless you are adding new ACB bits!
1813 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1816 Do you want session setups at user level security with a invalid
1817 password to be rejected or allowed in as guest? WinNT rejects them
1818 but it can be a pain as it means "net view" needs to use a password
1820 You have 3 choices in the setting of map_to_guest:
1822 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1823 are rejected. This is the default.
1825 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1826 are rejected, unless the username does not exist, in which case it
1827 is treated as a guest login
1829 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1830 are treated as a guest login
1832 Note that map_to_guest only has an effect in user or server
1833 level security.
1836 #define NEVER_MAP_TO_GUEST 0
1837 #define MAP_TO_GUEST_ON_BAD_USER 1
1838 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1839 #define MAP_TO_GUEST_ON_BAD_UID 3
1841 #define SAFE_NETBIOS_CHARS ". -_"
1843 /* generic iconv conversion structure */
1844 typedef struct _smb_iconv_t {
1845 size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
1846 char **outbuf, size_t *outbytesleft);
1847 size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
1848 char **outbuf, size_t *outbytesleft);
1849 size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
1850 char **outbuf, size_t *outbytesleft);
1851 void *cd_direct, *cd_pull, *cd_push;
1852 char *from_name, *to_name;
1853 } *smb_iconv_t;
1855 /* The maximum length of a trust account password.
1856 Used when we randomly create it, 15 char passwords
1857 exceed NT4's max password length */
1859 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1861 #include "popt_common.h"
1863 #define PORT_NONE 0
1864 #ifndef LDAP_PORT
1865 #define LDAP_PORT 389
1866 #endif
1868 /* used by the IP comparison function */
1869 struct ip_service {
1870 struct sockaddr_storage ss;
1871 unsigned port;
1874 /* Special name type used to cause a _kerberos DNS lookup. */
1875 #define KDC_NAME_TYPE 0xDCDC
1877 /* Used by the SMB signing functions. */
1879 typedef struct smb_sign_info {
1880 void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1881 bool (*check_incoming_message)(const char *inbuf, struct smb_sign_info *si, bool must_be_ok);
1882 void (*free_signing_context)(struct smb_sign_info *si);
1883 void *signing_context;
1885 bool negotiated_smb_signing;
1886 bool allow_smb_signing;
1887 bool doing_signing;
1888 bool mandatory_signing;
1889 bool seen_valid; /* Have I ever seen a validly signed packet? */
1890 } smb_sign_info;
1892 struct ea_struct {
1893 uint8 flags;
1894 char *name;
1895 DATA_BLOB value;
1898 struct ea_list {
1899 struct ea_list *next, *prev;
1900 struct ea_struct ea;
1903 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1904 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1905 /* EA to use for DOS attributes */
1906 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1907 /* Prefix for DosStreams in the vfs_streams_xattr module */
1908 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1910 #define UUID_SIZE 16
1912 #define UUID_FLAT_SIZE 16
1913 typedef struct uuid_flat {
1914 uint8 info[UUID_FLAT_SIZE];
1915 } UUID_FLAT;
1917 /* map readonly options */
1918 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1920 /* usershare error codes. */
1921 enum usershare_err {
1922 USERSHARE_OK=0,
1923 USERSHARE_MALFORMED_FILE,
1924 USERSHARE_BAD_VERSION,
1925 USERSHARE_MALFORMED_PATH,
1926 USERSHARE_MALFORMED_COMMENT_DEF,
1927 USERSHARE_MALFORMED_ACL_DEF,
1928 USERSHARE_ACL_ERR,
1929 USERSHARE_PATH_NOT_ABSOLUTE,
1930 USERSHARE_PATH_IS_DENIED,
1931 USERSHARE_PATH_NOT_ALLOWED,
1932 USERSHARE_PATH_NOT_DIRECTORY,
1933 USERSHARE_POSIX_ERR
1936 /* Different reasons for closing a file. */
1937 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1939 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1940 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1941 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1942 struct smb_extended_info {
1943 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1944 uint32 samba_version; /* Major/Minor/Release/Revision */
1945 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1946 NTTIME samba_gitcommitdate;
1947 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1950 #endif /* _SMB_H */