2 Unix SMB/Netbios implementation.
4 SMB parameters and setup
5 Copyright (C) Andrew Tridgell 1992-1998
6 Copyright (C) John H Terpstra 1996-1998
7 Copyright (C) Luke Kenneth Casson Leighton 1996-1998
8 Copyright (C) Paul Ashton 1998
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #define BUFFER_SIZE (0xFFFF)
28 #define SAFETY_MARGIN 1024
31 #define DGRAM_PORT 138
36 #define BOOLSTR(b) ((b) ? "Yes" : "No")
37 #define BITSETB(ptr,bit) ((((char *)ptr)[0] & (1<<(bit)))!=0)
38 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
40 #define IS_BITS_SET_ALL(var,bit) (((var)&(bit))==(bit))
41 #define IS_BITS_SET_SOME(var,bit) (((var)&(bit))!=0)
42 #define IS_BITS_CLR_ALL(var,bit) (((var)&(bit))==0)
44 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
48 /* limiting size of ipc replies */
49 #define REALLOC(ptr,size) Realloc(ptr,MAX((size),4*1024))
53 #ifndef DEF_CREATE_MASK
54 #define DEF_CREATE_MASK (0755)
57 /* how long to wait for secondary SMB packets (milli-seconds) */
58 #define SMB_SECONDARY_WAIT (60*1000)
60 /* -------------------------------------------------------------------------- **
61 * Debugging code. See also debug.c
64 /* mkproto.awk has trouble with ifdef'd function definitions (it ignores
65 * the #ifdef directive and will read both definitions, thus creating two
66 * diffferent prototype declarations), so we must do these by hand.
68 /* I know the __attribute__ stuff is ugly, but it does ensure we get the
69 arguemnts to DEBUG() right. We have got them wrong too often in the
72 int Debug1( char *, ... )
74 __attribute__ ((format (printf, 1, 2)))
77 BOOL dbgtext( char *, ... )
79 __attribute__ ((format (printf, 1, 2)))
87 /* If we have these macros, we can add additional info to the header. */
88 #ifdef HAVE_FILE_MACRO
89 #define FILE_MACRO (__FILE__)
91 #define FILE_MACRO ("")
94 #ifdef HAVE_FUNCTION_MACRO
95 #define FUNCTION_MACRO (__FUNCTION__)
97 #define FUNCTION_MACRO ("")
101 * DEBUGLVL() - If level is <= the system-wide DEBUGLEVEL then generate a
102 * header using the default macros for file, line, and
104 * Returns True if the debug level was <= DEBUGLEVEL.
106 * if( DEBUGLVL( 2 ) )
107 * dbgtext( "Some text.\n" );
108 * DEGUG() - Good old DEBUG(). Each call to DEBUG() will generate a new
109 * header *unless* the previous debug output was unterminated
110 * (i.e., no '\n'). See debug.c:dbghdr() for more info.
112 * DEBUG( 2, ("Some text.\n") );
113 * DEBUGADD() - If level <= DEBUGLEVEL, then the text is appended to the
114 * current message (i.e., no header).
116 * DEBUGADD( 2, ("Some additional text.\n") );
118 #define DEBUGLVL( level ) \
119 ( (DEBUGLEVEL >= (level)) \
120 && dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) ) )
124 #define DEBUG( level, body ) \
125 ( ( DEBUGLEVEL >= (level) \
126 && dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) ) ) \
127 ? (void)(dbgtext body) : (void)0 )
129 #define DEBUGADD( level, body ) \
130 ( (DEBUGLEVEL >= (level)) ? (void)(dbgtext body) : (void)0 )
134 #define DEBUG( level, body ) \
135 (void)( (DEBUGLEVEL >= (level)) \
136 && (dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) )) \
139 #define DEBUGADD( level, body ) \
140 (void)( (DEBUGLEVEL >= (level)) && (dbgtext body) )
144 /* End Debugging code section.
145 * -------------------------------------------------------------------------- **
148 /* this defines the error codes that receive_smb can put in smb_read_error */
149 #define READ_TIMEOUT 1
154 #define DIR_STRUCT_SIZE 43
156 /* these define all the command types recognised by the server - there
157 are lots of gaps so probably there are some rare commands that are not
160 #define pSETDIR '\377'
162 /* these define the attribute byte as seen by DOS */
163 #define aRONLY (1L<<0)
164 #define aHIDDEN (1L<<1)
165 #define aSYSTEM (1L<<2)
166 #define aVOLID (1L<<3)
168 #define aARCH (1L<<5)
170 /* for readability... */
171 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
172 #define IS_DOS_DIR(test_mode) (((test_mode) & aDIR) != 0)
173 #define IS_DOS_ARCHIVE(test_mode) (((test_mode) & aARCH) != 0)
174 #define IS_DOS_SYSTEM(test_mode) (((test_mode) & aSYSTEM) != 0)
175 #define IS_DOS_HIDDEN(test_mode) (((test_mode) & aHIDDEN) != 0)
186 #define DOS_OPEN_RDONLY 0
187 #define DOS_OPEN_WRONLY 1
188 #define DOS_OPEN_RDWR 2
189 #define DOS_OPEN_FCB 0xF
191 /* define shifts and masks for share and open modes. */
192 #define OPEN_MODE_MASK 0xF
193 #define SHARE_MODE_SHIFT 4
194 #define SHARE_MODE_MASK 0x7
195 #define GET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
196 #define SET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
197 #define GET_DENY_MODE(x) (((x)>>SHARE_MODE_SHIFT) & SHARE_MODE_MASK)
198 #define SET_DENY_MODE(x) ((x)<<SHARE_MODE_SHIFT)
200 /* Sync on open file (not sure if used anymore... ?) */
201 #define FILE_SYNC_OPENMODE (1<<14)
202 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
204 /* allow delete on open file mode (used by NT SMB's). */
205 #define ALLOW_SHARE_DELETE (1<<15)
206 #define GET_ALLOW_SHARE_DELETE(x) (((x) & ALLOW_SHARE_DELETE) ? True : False)
207 #define SET_ALLOW_SHARE_DELETE(x) ((x) ? ALLOW_SHARE_DELETE : 0)
209 /* delete on close flag (used by NT SMB's). */
210 #define DELETE_ON_CLOSE_FLAG (1<<16)
211 #define GET_DELETE_ON_CLOSE_FLAG(x) (((x) & DELETE_ON_CLOSE_FLAG) ? True : False)
212 #define SET_DELETE_ON_CLOSE_FLAG(x) ((x) ? DELETE_ON_CLOSE_FLAG : 0)
214 /* open disposition values */
215 #define FILE_EXISTS_FAIL 0
216 #define FILE_EXISTS_OPEN 1
217 #define FILE_EXISTS_TRUNCATE 2
219 /* mask for open disposition. */
220 #define FILE_OPEN_MASK 0x3
222 #define GET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
223 #define SET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
225 /* The above can be OR'ed with... */
226 #define FILE_CREATE_IF_NOT_EXIST 0x10
227 #define FILE_FAIL_IF_NOT_EXIST 0
229 #define GET_FILE_CREATE_DISPOSITION(x) ((x) & (FILE_CREATE_IF_NOT_EXIST|FILE_FAIL_IF_NOT_EXIST))
232 #define STYPE_DISKTREE 0 /* Disk drive */
233 #define STYPE_PRINTQ 1 /* Spooler queue */
234 #define STYPE_DEVICE 2 /* Serial device */
235 #define STYPE_IPC 3 /* Interprocess communication (IPC) */
236 #define STYPE_HIDDEN 0x80000000 /* share is a hidden one (ends with $) */
238 /* SMB X/Open error codes for the ERRDOS error class */
239 #define ERRbadfunc 1 /* Invalid function (or system call) */
240 #define ERRbadfile 2 /* File not found (pathname error) */
241 #define ERRbadpath 3 /* Directory not found */
242 #define ERRnofids 4 /* Too many open files */
243 #define ERRnoaccess 5 /* Access denied */
244 #define ERRbadfid 6 /* Invalid fid */
245 #define ERRnomem 8 /* Out of memory */
246 #define ERRbadmem 9 /* Invalid memory block address */
247 #define ERRbadenv 10 /* Invalid environment */
248 #define ERRbadaccess 12 /* Invalid open mode */
249 #define ERRbaddata 13 /* Invalid data (only from ioctl call) */
250 #define ERRres 14 /* reserved */
251 #define ERRbaddrive 15 /* Invalid drive */
252 #define ERRremcd 16 /* Attempt to delete current directory */
253 #define ERRdiffdevice 17 /* rename/move across different filesystems */
254 #define ERRnofiles 18 /* no more files found in file search */
255 #define ERRbadshare 32 /* Share mode on file conflict with open mode */
256 #define ERRlock 33 /* Lock request conflicts with existing lock */
257 #define ERRunsup 50 /* Request unsupported, returned by Win 95, RJS 20Jun98 */
258 #define ERRfilexists 80 /* File in operation already exists */
259 #define ERRcannotopen 110 /* Cannot open the file specified */
260 #define ERRunknownlevel 124
261 #define ERRrename 183
262 #define ERRbadpipe 230 /* Named pipe invalid */
263 #define ERRpipebusy 231 /* All instances of pipe are busy */
264 #define ERRpipeclosing 232 /* named pipe close in progress */
265 #define ERRnotconnected 233 /* No process on other end of named pipe */
266 #define ERRmoredata 234 /* More data to be returned */
267 #define ERRbaddirectory 267 /* Invalid directory name in a path. */
268 #define ERROR_EAS_DIDNT_FIT 275 /* Extended attributes didn't fit */
269 #define ERROR_EAS_NOT_SUPPORTED 282 /* Extended attributes not supported */
270 #define ERROR_NOTIFY_ENUM_DIR 1022 /* Buffer too small to return change notify. */
271 #define ERRunknownipc 2142
274 /* here's a special one from observing NT */
275 #define ERRnoipc 66 /* don't support ipc */
277 /* Error codes for the ERRSRV class */
279 #define ERRerror 1 /* Non specific error code */
280 #define ERRbadpw 2 /* Bad password */
281 #define ERRbadtype 3 /* reserved */
282 #define ERRaccess 4 /* No permissions to do the requested operation */
283 #define ERRinvnid 5 /* tid invalid */
284 #define ERRinvnetname 6 /* Invalid servername */
285 #define ERRinvdevice 7 /* Invalid device */
286 #define ERRqfull 49 /* Print queue full */
287 #define ERRqtoobig 50 /* Queued item too big */
288 #define ERRinvpfid 52 /* Invalid print file in smb_fid */
289 #define ERRsmbcmd 64 /* Unrecognised command */
290 #define ERRsrverror 65 /* smb server internal error */
291 #define ERRfilespecs 67 /* fid and pathname invalid combination */
292 #define ERRbadlink 68 /* reserved */
293 #define ERRbadpermits 69 /* Access specified for a file is not valid */
294 #define ERRbadpid 70 /* reserved */
295 #define ERRsetattrmode 71 /* attribute mode invalid */
296 #define ERRpaused 81 /* Message server paused */
297 #define ERRmsgoff 82 /* Not receiving messages */
298 #define ERRnoroom 83 /* No room for message */
299 #define ERRrmuns 87 /* too many remote usernames */
300 #define ERRtimeout 88 /* operation timed out */
301 #define ERRnoresource 89 /* No resources currently available for request. */
302 #define ERRtoomanyuids 90 /* too many userids */
303 #define ERRbaduid 91 /* bad userid */
304 #define ERRuseMPX 250 /* temporarily unable to use raw mode, use MPX mode */
305 #define ERRuseSTD 251 /* temporarily unable to use raw mode, use standard mode */
306 #define ERRcontMPX 252 /* resume MPX mode */
307 #define ERRbadPW /* reserved */
308 #define ERRnosupport 0xFFFF
309 #define ERRunknownsmb 22 /* from NT 3.5 response */
312 /* Error codes for the ERRHRD class */
314 #define ERRnowrite 19 /* read only media */
315 #define ERRbadunit 20 /* Unknown device */
316 #define ERRnotready 21 /* Drive not ready */
317 #define ERRbadcmd 22 /* Unknown command */
318 #define ERRdata 23 /* Data (CRC) error */
319 #define ERRbadreq 24 /* Bad request structure length */
321 #define ERRbadmedia 26
322 #define ERRbadsector 27
323 #define ERRnopaper 28
324 #define ERRwrite 29 /* write fault */
325 #define ERRread 30 /* read fault */
326 #define ERRgeneral 31 /* General hardware failure */
327 #define ERRwrongdisk 34
328 #define ERRFCBunavail 35
329 #define ERRsharebufexc 36 /* share buffer exceeded */
330 #define ERRdiskfull 39
333 typedef char pstring[1024];
334 typedef char fstring[128];
336 /* pipe string names */
337 #define PIPE_LANMAN "\\PIPE\\LANMAN"
338 #define PIPE_SRVSVC "\\PIPE\\srvsvc"
339 #define PIPE_SAMR "\\PIPE\\samr"
340 #define PIPE_WINREG "\\PIPE\\winreg"
341 #define PIPE_WKSSVC "\\PIPE\\wkssvc"
342 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
343 #define PIPE_NTLSA "\\PIPE\\ntlsa"
344 #define PIPE_NTSVCS "\\PIPE\\ntsvcs"
345 #define PIPE_LSASS "\\PIPE\\lsass"
346 #define PIPE_LSARPC "\\PIPE\\lsarpc"
349 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
350 typedef struct nttime_info
357 /* Allowable account control bits */
358 #define ACB_DISABLED 0x0001 /* 1 = User account disabled */
359 #define ACB_HOMDIRREQ 0x0002 /* 1 = Home directory required */
360 #define ACB_PWNOTREQ 0x0004 /* 1 = User password not required */
361 #define ACB_TEMPDUP 0x0008 /* 1 = Temporary duplicate account */
362 #define ACB_NORMAL 0x0010 /* 1 = Normal user account */
363 #define ACB_MNS 0x0020 /* 1 = MNS logon user account */
364 #define ACB_DOMTRUST 0x0040 /* 1 = Interdomain trust account */
365 #define ACB_WSTRUST 0x0080 /* 1 = Workstation trust account */
366 #define ACB_SVRTRUST 0x0100 /* 1 = Server trust account */
367 #define ACB_PWNOEXP 0x0200 /* 1 = User password does not expire */
368 #define ACB_AUTOLOCK 0x0400 /* 1 = Account auto locked */
370 #define MAX_HOURS_LEN 32
374 time_t logon_time; /* logon time */
375 time_t logoff_time; /* logoff time */
376 time_t kickoff_time; /* kickoff time */
377 time_t pass_last_set_time; /* password last set time */
378 time_t pass_can_change_time; /* password can change time */
379 time_t pass_must_change_time; /* password must change time */
381 char *smb_name; /* username string */
382 char *full_name; /* user's full name string */
383 char *home_dir; /* home directory string */
384 char *dir_drive; /* home directory drive string */
385 char *logon_script; /* logon script string */
386 char *profile_path; /* profile path string */
387 char *acct_desc ; /* user description string */
388 char *workstations; /* login from workstations string */
389 char *unknown_str ; /* don't know what this is, yet. */
390 char *munged_dial ; /* munged path name and dial-back tel number */
392 uid_t smb_userid; /* this is actually the unix uid_t */
393 gid_t smb_grpid; /* this is actually the unix gid_t */
394 uint32 user_rid; /* Primary User ID */
395 uint32 group_rid; /* Primary Group ID */
397 unsigned char *smb_passwd; /* Null if no password */
398 unsigned char *smb_nt_passwd; /* Null if no password */
400 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
401 uint32 unknown_3; /* 0x00ff ffff */
403 uint16 logon_divs; /* 168 - number of hours in a week */
404 uint32 hours_len; /* normally 21 bytes */
405 uint8 hours[MAX_HOURS_LEN];
407 uint32 unknown_5; /* 0x0002 0000 */
408 uint32 unknown_6; /* 0x0000 04ec */
413 uid_t smb_userid; /* this is actually the unix uid_t */
414 char *smb_name; /* username string */
416 unsigned char *smb_passwd; /* Null if no password */
417 unsigned char *smb_nt_passwd; /* Null if no password */
419 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
420 time_t pass_last_set_time; /* password last set time */
426 uint32 user_rid; /* Primary User ID */
427 char *smb_name; /* username string */
428 char *full_name; /* user's full name string */
431 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
433 /* DOM_SID - security id */
434 typedef struct sid_info
436 uint8 sid_rev_num; /* SID revision number */
437 uint8 num_auths; /* number of sub-authorities */
438 uint8 id_auth[6]; /* Identifier Authority */
440 * Note that the values in these uint32's are in *native* byteorder,
441 * not neccessarily little-endian...... JRA.
443 uint32 sub_auths[MAXSUBAUTHS]; /* pointer to sub-authorities. */
448 /*** query a local group, get a list of these: shows who is in that group ***/
450 /* local group member info */
451 typedef struct local_grp_member_info
453 DOM_SID sid ; /* matches with name */
454 uint8 sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
455 fstring name ; /* matches with sid: must be of the form "DOMAIN\account" */
459 /* enumerate these to get list of local groups */
461 /* local group info */
462 typedef struct local_grp_info
469 /*** enumerate these to get list of domain groups ***/
471 /* domain group member info */
472 typedef struct domain_grp_info
476 uint32 rid; /* group rid */
477 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
481 /*** query a domain group, get a list of these: shows who is in that group ***/
483 /* domain group info */
484 typedef struct domain_grp_member_info
487 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
491 /* DOM_CHAL - challenge info */
492 typedef struct chal_info
494 uchar data[8]; /* credentials */
497 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
498 typedef struct time_info
503 /* DOM_CREDs - timestamped client or server credentials */
504 typedef struct cred_info
506 DOM_CHAL challenge; /* credentials */
507 UTIME timestamp; /* credential time-stamp */
510 /* Structure used when SMBwritebmpx is active */
513 size_t wr_total_written; /* So we know when to discard this */
516 int32 wr_error; /* Cached errors */
517 BOOL wr_mode; /* write through mode) */
518 BOOL wr_discard; /* discard all further data */
522 * Structure used to indirect fd's from the files_struct.
523 * Needed as POSIX locking is based on file and process, not
524 * file descriptor and process.
527 typedef struct file_fd_struct
529 struct file_fd_struct *next, *prev;
531 uint16 uid_cache_count;
532 uid_t uid_users_cache[10];
539 BOOL delete_on_close;
543 * Structure used to keep directory state information around.
544 * Used in NT change-notify code.
555 uid_t list[UID_CACHE_SIZE];
562 } name_compare_entry;
564 typedef struct connection_struct
566 struct connection_struct *next, *prev;
567 unsigned cnum; /* an index passed over the wire */
570 struct uid_cache uid_cache;
579 char *user; /* name of user who *opened* this connection */
580 uid_t uid; /* uid of user who *opened* this connection */
581 gid_t gid; /* gid of user who *opened* this connection */
582 char client_address[18]; /* String version of client IP address. */
584 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
586 /* following groups stuff added by ih */
588 /* This groups info is valid for the user that *opened* the connection */
595 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
596 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
597 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
603 connection_struct *conn;
611 typedef struct write_cache
621 * Reasons for cache flush.
624 #define NUM_FLUSH_REASONS 8 /* Keep this in sync with the enum below. */
625 enum flush_reason_enum { SEEK_FLUSH, READ_FLUSH, WRITE_FLUSH, READRAW_FLUSH,
626 OPLOCK_RELEASE_FLUSH, CLOSE_FLUSH, SYNC_FLUSH, SIZECHANGE_FLUSH };
628 typedef struct files_struct
630 struct files_struct *next, *prev;
632 connection_struct *conn;
633 file_fd_struct *fd_ptr;
638 write_bmpx_struct *wbmpx_ptr;
640 struct timeval open_time;
642 time_t pending_modtime;
644 int sent_oplock_break;
652 BOOL directory_delete_on_close;
657 /* Defines for the sent_oplock_break field above. */
658 #define NO_BREAK_SENT 0
659 #define EXCLUSIVE_BREAK_SENT 1
660 #define LEVEL_II_BREAK_SENT 2
662 /* Domain controller authentication protocol info */
665 DOM_CHAL clnt_chal; /* Initial challenge received from client */
666 DOM_CHAL srv_chal; /* Initial server challenge */
667 DOM_CRED clnt_cred; /* Last client credential */
668 DOM_CRED srv_cred; /* Last server credential */
670 uchar sess_key[8]; /* Session key */
671 uchar md4pw[16]; /* md4(machine password) */
676 uid_t uid; /* uid of a validated user */
677 gid_t gid; /* gid of a validated user */
679 fstring requested_name; /* user name from the client */
680 fstring name; /* unix user name of a validated user */
681 fstring real_name; /* to store real name from password file - simeon */
684 /* following groups stuff added by ih */
685 /* This groups info is needed for when we become_user() for this uid */
692 /* per-user authentication information on NT RPCs */
698 enum {LPQ_QUEUED,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING};
709 } print_queue_struct;
711 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
717 } print_status_struct;
719 /* used for server information: client, nameserv and ipc */
720 struct server_info_struct
725 fstring domain; /* used ONLY in ipc.c NOT namework.c */
726 BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
730 /* used for network interfaces */
733 struct interface *next, *prev;
735 struct in_addr bcast;
736 struct in_addr nmask;
739 /* struct returned by get_share_modes */
750 /* each implementation of the share mode code needs
751 to support the following operations */
753 BOOL (*stop_mgmt)(void);
754 BOOL (*lock_entry)(connection_struct *, SMB_DEV_T , SMB_INO_T , int *);
755 BOOL (*unlock_entry)(connection_struct *, SMB_DEV_T , SMB_INO_T , int );
756 int (*get_entries)(connection_struct *, int , SMB_DEV_T , SMB_INO_T , share_mode_entry **);
757 void (*del_entry)(int , files_struct *);
758 BOOL (*set_entry)(int, files_struct *, uint16 , uint16 );
759 BOOL (*mod_entry)(int, files_struct *, void (*)(share_mode_entry *, SMB_DEV_T, SMB_INO_T, void *), void *);
760 int (*forall)(void (*)(share_mode_entry *, char *));
761 void (*status)(FILE *);
764 /* each implementation of the shared memory code needs
765 to support the following operations */
767 BOOL (*shm_close)( void );
768 int (*shm_alloc)(int );
769 BOOL (*shm_free)(int );
770 int (*get_userdef_off)(void);
771 void *(*offset2addr)(int );
772 int (*addr2offset)(void *addr);
773 BOOL (*lock_hash_entry)(unsigned int);
774 BOOL (*unlock_hash_entry)( unsigned int );
775 BOOL (*get_usage)(int *,int *,int *);
776 unsigned (*hash_size)(void);
780 * Each implementation of the password database code needs
781 * to support the following operations.
786 * Password database ops.
788 void *(*startsmbpwent)(BOOL);
789 void (*endsmbpwent)(void *);
790 SMB_BIG_UINT (*getsmbpwpos)(void *);
791 BOOL (*setsmbpwpos)(void *, SMB_BIG_UINT);
794 * smb password database query functions.
796 struct smb_passwd *(*getsmbpwnam)(char *);
797 struct smb_passwd *(*getsmbpwuid)(uid_t);
798 struct smb_passwd *(*getsmbpwrid)(uint32);
799 struct smb_passwd *(*getsmbpwent)(void *);
802 * smb password database modification functions.
804 BOOL (*add_smbpwd_entry)(struct smb_passwd *);
805 BOOL (*mod_smbpwd_entry)(struct smb_passwd *, BOOL);
808 * Functions that manupulate a struct sam_passwd.
810 struct sam_passwd *(*getsam21pwent)(void *);
813 * sam password database query functions.
815 struct sam_passwd *(*getsam21pwnam)(char *);
816 struct sam_passwd *(*getsam21pwuid)(uid_t);
817 struct sam_passwd *(*getsam21pwrid)(uint32);
820 * sam password database modification functions.
822 BOOL (*add_sam21pwd_entry)(struct sam_passwd *);
823 BOOL (*mod_sam21pwd_entry)(struct sam_passwd *, BOOL);
826 * sam query display info functions.
828 struct sam_disp_info *(*getsamdispnam)(char *);
829 struct sam_disp_info *(*getsamdisprid)(uint32);
830 struct sam_disp_info *(*getsamdispent)(void *);
834 * password checking functions
836 struct smb_passwd *(*smb_password_chal )(char *username, char lm_pass[24], char nt_pass[24], char chal[8]);
837 struct smb_passwd *(*smb_password_check )(char *username, char lm_hash[16], char nt_hash[16]);
838 struct passwd *(*unix_password_check)(char *username, char *pass, int pass_len);
842 /* this is used for smbstatus */
844 struct connect_record
857 /* the following are used by loadparm for option lists */
860 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
861 P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
866 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
880 BOOL (*special)(char *, char **);
881 struct enum_list *enum_list;
896 #define FLAG_BASIC 0x01 /* fundamental options */
897 #define FLAG_SHARE 0x02 /* file sharing options */
898 #define FLAG_PRINT 0x04 /* printing options */
899 #define FLAG_GLOBAL 0x08 /* local options that should be globally settable in SWAT */
900 #define FLAG_DEPRECATED 0x10 /* options that should no longer be used */
901 #define FLAG_HIDE 0x20 /* options that should be hidden in SWAT */
902 #define FLAG_DOS_STRING 0x40 /* convert from UNIX to DOS codepage when reading this string. */
904 #ifndef LOCKING_VERSION
905 #define LOCKING_VERSION 4
906 #endif /* LOCKING_VERSION */
908 /* these are useful macros for checking validity of handles */
909 #define OPEN_FSP(fsp) ((fsp) && (fsp)->open && !(fsp)->is_directory)
910 #define OPEN_CONN(conn) ((conn) && (conn)->open)
911 #define IS_IPC(conn) ((conn) && (conn)->ipc)
912 #define IS_PRINT(conn) ((conn) && (conn)->printer)
913 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn)
915 #define CHECK_FSP(fsp,conn) if (!FNUM_OK(fsp,conn)) \
916 return(ERROR(ERRDOS,ERRbadfid)); \
917 else if((fsp)->fd_ptr == NULL) \
918 return(ERROR(ERRDOS,ERRbadaccess))
920 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
921 return(ERROR(ERRDOS,ERRbadaccess))
922 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
923 return(ERROR(ERRDOS,ERRbadaccess))
924 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
925 return(CACHED_ERROR(fsp))
927 /* translates a connection number into a service number */
928 #define SNUM(conn) ((conn)?(conn)->service:-1)
930 /* access various service details */
931 #define SERVICE(snum) (lp_servicename(snum))
932 #define PRINTCAP (lp_printcapname())
933 #define PRINTCOMMAND(snum) (lp_printcommand(snum))
934 #define PRINTERNAME(snum) (lp_printername(snum))
935 #define CAN_WRITE(conn) (!conn->read_only)
936 #define VALID_SNUM(snum) (lp_snum_ok(snum))
937 #define GUEST_OK(snum) (VALID_SNUM(snum) && lp_guest_ok(snum))
938 #define GUEST_ONLY(snum) (VALID_SNUM(snum) && lp_guest_only(snum))
939 #define CAN_SETDIR(snum) (!lp_no_set_dir(snum))
940 #define CAN_PRINT(conn) ((conn) && lp_print_ok((conn)->service))
941 #define MAP_HIDDEN(conn) ((conn) && lp_map_hidden((conn)->service))
942 #define MAP_SYSTEM(conn) ((conn) && lp_map_system((conn)->service))
943 #define MAP_ARCHIVE(conn) ((conn) && lp_map_archive((conn)->service))
944 #define IS_HIDDEN_PATH(conn,path) ((conn) && is_in_path((path),(conn)->hide_list))
945 #define IS_VETO_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_list))
946 #define IS_VETO_OPLOCK_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_oplock_list))
949 * Used by the stat cache code to check if a returned
950 * stat structure is valid.
953 #define VALID_STAT(st) (st.st_nlink != 0)
954 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR(st.st_mode))
956 #define SMBENCRYPT() (lp_encrypted_passwords())
958 /* the basic packet size, assuming no words or bytes */
961 /* offsets into message for common items */
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
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 SMBchkpth 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 SMBinvalid 0xFE /* invalid command */
1078 /* Extended 2.0 protocol */
1079 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1080 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1081 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1082 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1083 #define SMBulogoffX 0x74 /* user logoff */
1085 /* NT SMB extensions. */
1086 #define SMBnttrans 0xA0 /* NT transact */
1087 #define SMBnttranss 0xA1 /* NT transact secondary */
1088 #define SMBntcreateX 0xA2 /* NT create and X */
1089 #define SMBntcancel 0xA4 /* NT cancel */
1091 /* These are the TRANS2 sub commands */
1092 #define TRANSACT2_OPEN 0
1093 #define TRANSACT2_FINDFIRST 1
1094 #define TRANSACT2_FINDNEXT 2
1095 #define TRANSACT2_QFSINFO 3
1096 #define TRANSACT2_SETFSINFO 4
1097 #define TRANSACT2_QPATHINFO 5
1098 #define TRANSACT2_SETPATHINFO 6
1099 #define TRANSACT2_QFILEINFO 7
1100 #define TRANSACT2_SETFILEINFO 8
1101 #define TRANSACT2_FSCTL 9
1102 #define TRANSACT2_IOCTL 0xA
1103 #define TRANSACT2_FINDNOTIFYFIRST 0xB
1104 #define TRANSACT2_FINDNOTIFYNEXT 0xC
1105 #define TRANSACT2_MKDIR 0xD
1106 #define TRANSACT2_SESSION_SETUP 0xE
1107 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1108 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1110 /* These are the NT transact sub commands. */
1111 #define NT_TRANSACT_CREATE 1
1112 #define NT_TRANSACT_IOCTL 2
1113 #define NT_TRANSACT_SET_SECURITY_DESC 3
1114 #define NT_TRANSACT_NOTIFY_CHANGE 4
1115 #define NT_TRANSACT_RENAME 5
1116 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1118 /* Relevant IOCTL codes */
1119 #define IOCTL_QUERY_JOB_INFO 0x530060
1121 /* these are the trans2 sub fields for primary requests */
1122 #define smb_tpscnt smb_vwv0
1123 #define smb_tdscnt smb_vwv1
1124 #define smb_mprcnt smb_vwv2
1125 #define smb_mdrcnt smb_vwv3
1126 #define smb_msrcnt smb_vwv4
1127 #define smb_flags smb_vwv5
1128 #define smb_timeout smb_vwv6
1129 #define smb_pscnt smb_vwv9
1130 #define smb_psoff smb_vwv10
1131 #define smb_dscnt smb_vwv11
1132 #define smb_dsoff smb_vwv12
1133 #define smb_suwcnt smb_vwv13
1134 #define smb_setup smb_vwv14
1135 #define smb_setup0 smb_setup
1136 #define smb_setup1 (smb_setup+2)
1137 #define smb_setup2 (smb_setup+4)
1139 /* these are for the secondary requests */
1140 #define smb_spscnt smb_vwv2
1141 #define smb_spsoff smb_vwv3
1142 #define smb_spsdisp smb_vwv4
1143 #define smb_sdscnt smb_vwv5
1144 #define smb_sdsoff smb_vwv6
1145 #define smb_sdsdisp smb_vwv7
1146 #define smb_sfid smb_vwv8
1148 /* and these for responses */
1149 #define smb_tprcnt smb_vwv0
1150 #define smb_tdrcnt smb_vwv1
1151 #define smb_prcnt smb_vwv3
1152 #define smb_proff smb_vwv4
1153 #define smb_prdisp smb_vwv5
1154 #define smb_drcnt smb_vwv6
1155 #define smb_droff smb_vwv7
1156 #define smb_drdisp smb_vwv8
1158 /* these are for the NT trans primary request. */
1159 #define smb_nt_MaxSetupCount smb_vwv0
1160 #define smb_nt_Flags (smb_vwv0 + 1)
1161 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1162 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1163 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1164 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1165 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1166 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1167 #define smb_nt_DataCount (smb_vwv0 + 27)
1168 #define smb_nt_DataOffset (smb_vwv0 + 31)
1169 #define smb_nt_SetupCount (smb_vwv0 + 35)
1170 #define smb_nt_Function (smb_vwv0 + 36)
1171 #define smb_nt_SetupStart (smb_vwv0 + 38)
1173 /* these are for the NT trans secondary request. */
1174 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1175 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1176 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1177 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1178 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1179 #define smb_nts_DataCount (smb_vwv0 + 23)
1180 #define smb_nts_DataOffset (smb_vwv0 + 27)
1181 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1183 /* these are for the NT trans reply. */
1184 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1185 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1186 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1187 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1188 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1189 #define smb_ntr_DataCount (smb_vwv0 + 23)
1190 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1191 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1193 /* these are for the NT create_and_X */
1194 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1195 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1196 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1197 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1198 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1199 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1200 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1201 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1202 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1203 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1204 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1206 /* this is used on a TConX. I'm not sure the name is very helpful though */
1207 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1209 /* these are the constants used in the above call. */
1211 /* File Specific access rights. */
1212 #define FILE_READ_DATA 0x001
1213 #define FILE_WRITE_DATA 0x002
1214 #define FILE_APPEND_DATA 0x004
1215 #define FILE_READ_EA 0x008
1216 #define FILE_WRITE_EA 0x010
1217 #define FILE_EXECUTE 0x020
1218 #define FILE_DELETE_CHILD 0x040
1219 #define FILE_READ_ATTRIBUTES 0x080
1220 #define FILE_WRITE_ATTRIBUTES 0x100
1222 #define FILE_ALL_ATTRIBUTES 0x1FF
1224 /* Generic access masks & rights. */
1225 #define SPECIFIC_RIGHTS_MASK 0x00FFFFL
1226 #define STANDARD_RIGHTS_MASK 0xFF0000L
1227 #define DELETE_ACCESS (1L<<16)
1228 #define READ_CONTROL_ACCESS (1L<<17)
1229 #define WRITE_DAC_ACCESS (1L<<18)
1230 #define WRITE_OWNER_ACCESS (1L<<19)
1231 #define SYNCHRONIZE_ACCESS (1L<<20)
1233 #define SYSTEM_SECURITY_ACCESS (1L<<24)
1234 #define GENERIC_ALL_ACCESS (1<<28)
1235 #define GENERIC_EXECUTE_ACCESS (1<<29)
1236 #define GENERIC_WRITE_ACCESS (1<<30)
1237 #define GENERIC_READ_ACCESS (((unsigned)1)<<31)
1239 #define FILE_ALL_STANDARD_ACCESS 0x1F0000
1241 /* Mapping of access rights to UNIX perms. */
1242 #if 0 /* Don't use all here... JRA. */
1243 #define UNIX_ACCESS_RWX (FILE_ALL_ATTRIBUTES|FILE_ALL_STANDARD_ACCESS)
1245 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1248 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1249 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1250 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1251 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1252 FILE_APPEND_DATA|FILE_WRITE_DATA)
1253 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1254 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1256 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1259 #define REQUEST_OPLOCK 2
1260 #define REQUEST_BATCH_OPLOCK 4
1261 #define OPEN_DIRECTORY 8
1263 /* ShareAccess field. */
1264 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1265 #define FILE_SHARE_READ 1
1266 #define FILE_SHARE_WRITE 2
1267 #define FILE_SHARE_DELETE 4
1269 /* FileAttributesField */
1270 #define FILE_ATTRIBUTE_READONLY aRONLY
1271 #define FILE_ATTRIBUTE_HIDDEN aHIDDEN
1272 #define FILE_ATTRIBUTE_SYSTEM aSYSTEM
1273 #define FILE_ATTRIBUTE_DIRECTORY aDIR
1274 #define FILE_ATTRIBUTE_ARCHIVE aARCH
1275 #define FILE_ATTRIBUTE_NORMAL 0x80L
1276 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1277 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1278 #define SAMBA_ATTRIBUTES_MASK 0x7F
1280 /* Flags - combined with attributes. */
1281 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1282 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1283 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1284 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1285 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1286 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1287 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1289 /* CreateDisposition field. */
1290 #define FILE_SUPERSEDE 0
1292 #define FILE_CREATE 2
1293 #define FILE_OPEN_IF 3
1294 #define FILE_OVERWRITE 4
1295 #define FILE_OVERWRITE_IF 5
1297 /* CreateOptions field. */
1298 #define FILE_DIRECTORY_FILE 0x0001
1299 #define FILE_WRITE_THROUGH 0x0002
1300 #define FILE_SEQUENTIAL_ONLY 0x0004
1301 #define FILE_NON_DIRECTORY_FILE 0x0040
1302 #define FILE_NO_EA_KNOWLEDGE 0x0200
1303 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1304 #define FILE_RANDOM_ACCESS 0x0800
1305 #define FILE_DELETE_ON_CLOSE 0x1000
1307 /* Responses when opening a file. */
1308 #define FILE_WAS_OPENED 1
1309 #define FILE_WAS_CREATED 2
1310 #define FILE_WAS_OVERWRITTEN 3
1312 /* File type flags */
1313 #define FILE_TYPE_DISK 0
1314 #define FILE_TYPE_BYTE_MODE_PIPE 1
1315 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1316 #define FILE_TYPE_PRINTER 3
1317 #define FILE_TYPE_COMM_DEVICE 4
1318 #define FILE_TYPE_UNKNOWN 0xFFFF
1320 /* Flag for NT transact rename call. */
1321 #define RENAME_REPLACE_IF_EXISTS 1
1323 /* Filesystem Attributes. */
1324 #define FILE_CASE_SENSITIVE_SEARCH 0x1
1325 #define FILE_CASE_PRESERVED_NAMES 0x2
1326 #define FILE_UNICODE_ON_DISK 0x4
1327 #define FILE_PERSISTENT_ACLS 0x8
1329 /* ChangeNotify flags. */
1330 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1331 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1332 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1333 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1334 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1335 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1336 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1337 #define FILE_NOTIFY_CHANGE_EA 0x080
1338 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1340 /* where to find the base of the SMB packet proper */
1341 #define smb_base(buf) (((char *)(buf))+4)
1344 /* we don't allow server strings to be longer than 48 characters as
1345 otherwise NT will not honour the announce packets */
1346 #define MAX_SERVER_STRING_LENGTH 48
1349 #define SMB_SUCCESS 0 /* The request was successful. */
1350 #define ERRDOS 0x01 /* Error is from the core DOS operating system set. */
1351 #define ERRSRV 0x02 /* Error is generated by the server network file manager.*/
1352 #define ERRHRD 0x03 /* Error is an hardware error. */
1353 #define ERRCMD 0xFF /* Command was not in the "SMB" format. */
1355 #ifdef HAVE_STDARG_H
1356 int slprintf(char *str, int n, char *format, ...)
1358 __attribute__ ((format (printf, 3, 4)))
1366 void dfs_unlogin(void);
1367 extern int dcelogin_atmost_once;
1371 char *strdup(char *s);
1375 #define MIN(a,b) ((a)<(b)?(a):(b))
1378 #define MAX(a,b) ((a)>(b)?(a):(b))
1382 #define ABS(a) ((a)>0?(a):(-(a)))
1386 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1394 /* Some POSIX definitions for those without */
1397 #define S_IFDIR 0x4000
1400 #define S_ISDIR(mode) ((mode & 0xF000) == S_IFDIR)
1403 #define S_IRWXU 00700 /* read, write, execute: owner */
1406 #define S_IRUSR 00400 /* read permission: owner */
1409 #define S_IWUSR 00200 /* write permission: owner */
1412 #define S_IXUSR 00100 /* execute permission: owner */
1415 #define S_IRWXG 00070 /* read, write, execute: group */
1418 #define S_IRGRP 00040 /* read permission: group */
1421 #define S_IWGRP 00020 /* write permission: group */
1424 #define S_IXGRP 00010 /* execute permission: group */
1427 #define S_IRWXO 00007 /* read, write, execute: other */
1430 #define S_IROTH 00004 /* read permission: other */
1433 #define S_IWOTH 00002 /* write permission: other */
1436 #define S_IXOTH 00001 /* execute permission: other */
1440 /* these are used in NetServerEnum to choose what to receive */
1441 #define SV_TYPE_WORKSTATION 0x00000001
1442 #define SV_TYPE_SERVER 0x00000002
1443 #define SV_TYPE_SQLSERVER 0x00000004
1444 #define SV_TYPE_DOMAIN_CTRL 0x00000008
1445 #define SV_TYPE_DOMAIN_BAKCTRL 0x00000010
1446 #define SV_TYPE_TIME_SOURCE 0x00000020
1447 #define SV_TYPE_AFP 0x00000040
1448 #define SV_TYPE_NOVELL 0x00000080
1449 #define SV_TYPE_DOMAIN_MEMBER 0x00000100
1450 #define SV_TYPE_PRINTQ_SERVER 0x00000200
1451 #define SV_TYPE_DIALIN_SERVER 0x00000400
1452 #define SV_TYPE_SERVER_UNIX 0x00000800
1453 #define SV_TYPE_NT 0x00001000
1454 #define SV_TYPE_WFW 0x00002000
1455 #define SV_TYPE_SERVER_MFPN 0x00004000
1456 #define SV_TYPE_SERVER_NT 0x00008000
1457 #define SV_TYPE_POTENTIAL_BROWSER 0x00010000
1458 #define SV_TYPE_BACKUP_BROWSER 0x00020000
1459 #define SV_TYPE_MASTER_BROWSER 0x00040000
1460 #define SV_TYPE_DOMAIN_MASTER 0x00080000
1461 #define SV_TYPE_SERVER_OSF 0x00100000
1462 #define SV_TYPE_SERVER_VMS 0x00200000
1463 #define SV_TYPE_WIN95_PLUS 0x00400000
1464 #define SV_TYPE_ALTERNATE_XPORT 0x20000000
1465 #define SV_TYPE_LOCAL_LIST_ONLY 0x40000000
1466 #define SV_TYPE_DOMAIN_ENUM 0x80000000
1467 #define SV_TYPE_ALL 0xFFFFFFFF
1469 /* what server type are we currently - JHT Says we ARE 4.20 */
1470 /* this was set by JHT in liaison with Jeremy Allison early 1997 */
1471 /* setting to 4.20 at same time as announcing ourselves as NT Server */
1473 /* Version 4.0 - never made public */
1474 /* Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9 */
1475 /* - Reappeared in 1.9.16p11 with fixed smbd services */
1476 /* Version 4.20 - To indicate that nmbd and browsing now works better */
1478 #define DEFAULT_MAJOR_VERSION 0x04
1479 #define DEFAULT_MINOR_VERSION 0x02
1481 /* Browser Election Values */
1482 #define BROWSER_ELECTION_VERSION 0x010f
1483 #define BROWSER_CONSTANT 0xaa55
1485 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1487 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1488 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1489 #define FLAGS2_DFS_PATHNAMES 0x1000
1490 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1491 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1492 #define FLAGS2_UNICODE_STRINGS 0x8000
1494 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1496 #define CAP_RAW_MODE 0x0001
1497 #define CAP_MPX_MODE 0x0002
1498 #define CAP_UNICODE 0x0004
1499 #define CAP_LARGE_FILES 0x0008
1500 #define CAP_NT_SMBS 0x0010
1501 #define CAP_RPC_REMOTE_APIS 0x0020
1502 #define CAP_STATUS32 0x0040
1503 #define CAP_LEVEL_II_OPLOCKS 0x0080
1504 #define CAP_LOCK_AND_READ 0x0100
1505 #define CAP_NT_FIND 0x0200
1506 #define CAP_DFS 0x1000
1507 #define CAP_LARGE_READX 0x4000
1509 /* protocol types. It assumes that higher protocols include lower protocols
1511 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1513 /* security levels */
1514 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN};
1516 /* printing types */
1517 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1518 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,PRINT_CUPS};
1520 /* Remote architectures we know about. */
1521 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_WIN2K, RA_SAMBA};
1524 enum case_handling {CASE_LOWER,CASE_UPPER};
1527 /* SSL version options */
1528 enum ssl_version_enum {SMB_SSL_V2,SMB_SSL_V3,SMB_SSL_V23,SMB_SSL_TLS1};
1529 #endif /* WITH_SSL */
1531 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
1532 structures. We cannot define these as actual structures
1533 due to possible differences in structure packing
1534 on different machines/compilers. */
1536 #define SMB_LPID_OFFSET(indx) (10 * (indx))
1537 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
1538 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
1539 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
1540 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
1541 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
1542 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
1544 /* Macro to cache an error in a write_bmpx_struct */
1545 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
1546 w->wr_discard = True, -1)
1547 /* Macro to test if an error has been cached for this fnum */
1548 #define HAS_CACHED_ERROR(fsp) ((fsp)->open && (fsp)->wbmpx_ptr && \
1549 (fsp)->wbmpx_ptr->wr_discard)
1550 /* Macro to turn the cached error into an error packet */
1551 #define CACHED_ERROR(fsp) cached_error_packet(inbuf,outbuf,fsp,__LINE__)
1553 /* these are the datagram types */
1554 #define DGRAM_DIRECT_UNIQUE 0x10
1556 #define ERROR(class,x) error_packet(inbuf,outbuf,class,x,__LINE__)
1558 /* this is how errors are generated */
1559 #define UNIXERROR(defclass,deferror) unix_error_packet(inbuf,outbuf,defclass,deferror,__LINE__)
1561 #define SMB_ROUNDUP(x,g) (((x)+((g)-1))&~((g)-1))
1564 * Global value meaing that the smb_uid field should be
1565 * ingored (in share level security and protocol level == CORE)
1568 #define UID_FIELD_INVALID 0
1569 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1571 /* Defines needed for multi-codepage support. */
1572 #define MSDOS_LATIN_1_CODEPAGE 850
1573 #define KANJI_CODEPAGE 932
1574 #define HANGUL_CODEPAGE 949
1575 #define BIG5_CODEPAGE 950
1576 #define SIMPLIFIED_CHINESE_CODEPAGE 936
1580 * Default client code page - Japanese
1582 #define DEFAULT_CLIENT_CODE_PAGE KANJI_CODEPAGE
1585 * Default client code page - 850 - Western European
1587 #define DEFAULT_CLIENT_CODE_PAGE MSDOS_LATIN_1_CODEPAGE
1591 * Size of buffer to use when moving files across filesystems.
1593 #define COPYBUF_SIZE (8*1024)
1596 * Integers used to override error codes.
1598 extern int unix_ERR_class;
1599 extern int unix_ERR_code;
1602 * Map the Core and Extended Oplock requesst bits down
1603 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1609 #define CORE_OPLOCK_REQUEST(inbuf) \
1610 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1613 * Extended protocol.
1615 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1618 #define LOCKING_ANDX_SHARED_LOCK 0x1
1619 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1620 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1621 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1622 #define LOCKING_ANDX_LARGE_FILES 0x10
1625 #define OPLOCKLEVEL_NONE 0
1626 #define OPLOCKLEVEL_II 1
1629 * Bits we test with.
1633 #define EXCLUSIVE_OPLOCK 1
1634 #define BATCH_OPLOCK 2
1635 #define LEVEL_II_OPLOCK 4
1637 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1638 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1639 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1641 #define CORE_OPLOCK_GRANTED (1<<5)
1642 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1645 * Return values for oplock types.
1648 #define NO_OPLOCK_RETURN 0
1649 #define EXCLUSIVE_OPLOCK_RETURN 1
1650 #define BATCH_OPLOCK_RETURN 2
1651 #define LEVEL_II_OPLOCK_RETURN 3
1654 * Loopback command offsets.
1657 #define OPBRK_CMD_LEN_OFFSET 0
1658 #define OPBRK_CMD_PORT_OFFSET 4
1659 #define OPBRK_CMD_HEADER_LEN 6
1661 #define OPBRK_MESSAGE_CMD_OFFSET 0
1664 * Oplock break command code to send over the udp socket.
1665 * The same message is sent for both exlusive and level II breaks.
1667 * The form of this is :
1669 * 0 2 6 10 14 14+devsize 14+devsize+inodesize
1670 * +----+--------+--------+--------+-------+--------+
1671 * | cmd| pid | sec | usec | dev | inode |
1672 * +----+--------+--------+--------+-------+--------+
1675 #define OPLOCK_BREAK_CMD 0x1
1676 #define OPLOCK_BREAK_PID_OFFSET 2
1677 #define OPLOCK_BREAK_SEC_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1678 #define OPLOCK_BREAK_USEC_OFFSET (OPLOCK_BREAK_SEC_OFFSET + sizeof(time_t))
1679 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_USEC_OFFSET + sizeof(long))
1680 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1681 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1683 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1686 * Capabilities abstracted for different systems.
1689 #define KERNEL_OPLOCK_CAPABILITY 0x1
1691 #if defined(HAVE_KERNEL_OPLOCKS)
1693 * Oplock break command code sent via the kernel interface.
1697 * 0 2 2+devsize 2+devsize+inodesize
1698 * +----+--------+--------+
1699 * | cmd| dev | inode |
1700 * +----+--------+--------+
1703 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1704 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1705 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1706 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1708 #endif /* HAVE_KERNEL_OPLOCKS */
1710 #define CMD_REPLY 0x8000
1714 /* zero a structure */
1715 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
1717 /* zero a structure given a pointer to the structure - no zero check */
1718 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
1720 /* zero a structure given a pointer to the structure */
1721 #define ZERO_STRUCTP(x) { if ((x) != NULL) ZERO_STRUCTPN(x); }
1723 /* zero an array - note that sizeof(array) must work - ie. it must not be a
1725 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
1727 #define SMB_ASSERT(b) ((b)?(void)0: \
1728 (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
1729 __FILE__, __LINE__)), smb_panic("assert failed")))
1730 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
1732 #include "ntdomain.h"
1734 /* A netbios name structure. */
1738 unsigned int name_type;
1742 #include "rpcclient.h"
1745 * Size of new password account encoding string. DO NOT CHANGE.
1748 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1751 Do you want session setups at user level security with a invalid
1752 password to be rejected or allowed in as guest? WinNT rejects them
1753 but it can be a pain as it means "net view" needs to use a password
1755 You have 3 choices in the setting of map_to_guest:
1757 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1758 are rejected. This is the default.
1760 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1761 are rejected, unless the username does not exist, in which case it
1762 is treated as a guest login
1764 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1765 are treated as a guest login
1767 Note that map_to_guest only has an effect in user or server
1771 #define NEVER_MAP_TO_GUEST 0
1772 #define MAP_TO_GUEST_ON_BAD_USER 1
1773 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1776 * SMB UCS2 (16-bit unicode) internal type.
1779 typedef uint16 smb_ucs2_t;