Code indentation.
[midnight-commander.git] / src / vfs / smbfs / helpers / include / smb.h
blobea98e19da7eabe91d9666af4b2bce798d9237c74
1 /*
2 Unix SMB/Netbios implementation.
3 Version 1.9.
4 SMB parameters and setup
5 */
6 #ifndef _SMB_H
7 #define _SMB_H
9 #define BUFFER_SIZE (0xFFFF)
10 #define SAFETY_MARGIN 1024
12 #define NMB_PORT 137
13 #define DGRAM_PORT 138
14 #define SMB_PORT 139
16 #define False (0)
17 #define True (1)
18 #define BOOLSTR(b) ((b) ? "Yes" : "No")
19 #define BITSETB(ptr,bit) ((((char *)ptr)[0] & (1<<(bit)))!=0)
20 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
22 #define IS_BITS_SET_ALL(var,bit) (((var)&(bit))==(bit))
23 #define IS_BITS_SET_SOME(var,bit) (((var)&(bit))!=0)
24 #define IS_BITS_CLR_ALL(var,bit) (((var)&(bit))==0)
26 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
28 typedef int BOOL;
30 /* limiting size of ipc replies */
31 #define REALLOC(ptr,size) Realloc(ptr,MAX((size),4*1024))
33 #define SIZEOFWORD 2
35 #ifndef DEF_CREATE_MASK
36 #define DEF_CREATE_MASK (0755)
37 #endif
39 /* how long to wait for secondary SMB packets (milli-seconds) */
40 #define SMB_SECONDARY_WAIT (60*1000)
42 /* -------------------------------------------------------------------------- **
43 * Debugging code. See also debug.c
46 /* mkproto.awk has trouble with ifdef'd function definitions (it ignores
47 * the #ifdef directive and will read both definitions, thus creating two
48 * diffferent prototype declarations), so we must do these by hand.
50 /* I know the __attribute__ stuff is ugly, but it does ensure we get the
51 arguemnts to DEBUG() right. We have got them wrong too often in the
52 past */
53 #ifdef HAVE_STDARG_H
54 int
55 Debug1 (const char *, ...)
56 #ifdef __GNUC__
57 __attribute__ ((format (printf, 1, 2)))
58 #endif
60 BOOL dbgtext (const char *, ...)
61 #ifdef __GNUC__
62 __attribute__ ((format (printf, 1, 2)))
63 #endif
65 #else
66 int Debug1 ();
67 BOOL dbgtext ();
68 #endif
70 /* If we have these macros, we can add additional info to the header. */
71 #ifdef HAVE_FILE_MACRO
72 #define FILE_MACRO (__FILE__)
73 #else
74 #define FILE_MACRO ("")
75 #endif
77 #ifdef HAVE_FUNCTION_MACRO
78 #define FUNCTION_MACRO (__FUNCTION__)
79 #else
80 #define FUNCTION_MACRO ("")
81 #endif
83 /* Debugging macros.
84 * DEBUGLVL() - If level is <= the system-wide DEBUGLEVEL then generate a
85 * header using the default macros for file, line, and
86 * function name.
87 * Returns True if the debug level was <= DEBUGLEVEL.
88 * Example usage:
89 * if( DEBUGLVL( 2 ) )
90 * dbgtext( "Some text.\n" );
91 * DEGUG() - Good old DEBUG(). Each call to DEBUG() will generate a new
92 * header *unless* the previous debug output was unterminated
93 * (i.e., no '\n'). See debug.c:dbghdr() for more info.
94 * Example usage:
95 * DEBUG( 2, ("Some text.\n") );
96 * DEBUGADD() - If level <= DEBUGLEVEL, then the text is appended to the
97 * current message (i.e., no header).
98 * Usage:
99 * DEBUGADD( 2, ("Some additional text.\n") );
101 #define DEBUGLVL( level ) \
102 ( (DEBUGLEVEL >= (level)) \
103 && dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) ) )
105 #if 0
107 #define DEBUG( level, body ) \
108 ( ( DEBUGLEVEL >= (level) \
109 && dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) ) ) \
110 ? (void)(dbgtext body) : (void)0 )
112 #define DEBUGADD( level, body ) \
113 ( (DEBUGLEVEL >= (level)) ? (void)(dbgtext body) : (void)0 )
115 #else
117 #define DEBUG( level, body ) \
118 (void)( (DEBUGLEVEL >= (level)) \
119 && (dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) )) \
120 && (dbgtext body) )
122 #define DEBUGADD( level, body ) \
123 (void)( (DEBUGLEVEL >= (level)) && (dbgtext body) )
125 #endif
127 /* End Debugging code section.
128 * -------------------------------------------------------------------------- **
131 /* this defines the error codes that receive_smb can put in smb_read_error */
132 #define READ_TIMEOUT 1
133 #define READ_EOF 2
134 #define READ_ERROR 3
137 #define DIR_STRUCT_SIZE 43
139 /* these define all the command types recognised by the server - there
140 are lots of gaps so probably there are some rare commands that are not
141 implemented */
143 #define pSETDIR '\377'
145 /* these define the attribute byte as seen by DOS */
146 #define aRONLY (1L<<0)
147 #define aHIDDEN (1L<<1)
148 #define aSYSTEM (1L<<2)
149 #define aVOLID (1L<<3)
150 #define aDIR (1L<<4)
151 #define aARCH (1L<<5)
153 /* for readability... */
154 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
155 #define IS_DOS_DIR(test_mode) (((test_mode) & aDIR) != 0)
156 #define IS_DOS_ARCHIVE(test_mode) (((test_mode) & aARCH) != 0)
157 #define IS_DOS_SYSTEM(test_mode) (((test_mode) & aSYSTEM) != 0)
158 #define IS_DOS_HIDDEN(test_mode) (((test_mode) & aHIDDEN) != 0)
160 /* deny modes */
161 #define DENY_DOS 0
162 #define DENY_ALL 1
163 #define DENY_WRITE 2
164 #define DENY_READ 3
165 #define DENY_NONE 4
166 #define DENY_FCB 7
168 /* open modes */
169 #define DOS_OPEN_RDONLY 0
170 #define DOS_OPEN_WRONLY 1
171 #define DOS_OPEN_RDWR 2
172 #define DOS_OPEN_FCB 0xF
174 /* define shifts and masks for share and open modes. */
175 #define OPEN_MODE_MASK 0xF
176 #define SHARE_MODE_SHIFT 4
177 #define SHARE_MODE_MASK 0x7
178 #define GET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
179 #define SET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
180 #define GET_DENY_MODE(x) (((x)>>SHARE_MODE_SHIFT) & SHARE_MODE_MASK)
181 #define SET_DENY_MODE(x) ((x)<<SHARE_MODE_SHIFT)
183 /* Sync on open file (not sure if used anymore... ?) */
184 #define FILE_SYNC_OPENMODE (1<<14)
185 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
187 /* allow delete on open file mode (used by NT SMB's). */
188 #define ALLOW_SHARE_DELETE (1<<15)
189 #define GET_ALLOW_SHARE_DELETE(x) (((x) & ALLOW_SHARE_DELETE) ? True : False)
190 #define SET_ALLOW_SHARE_DELETE(x) ((x) ? ALLOW_SHARE_DELETE : 0)
192 /* delete on close flag (used by NT SMB's). */
193 #define DELETE_ON_CLOSE_FLAG (1<<16)
194 #define GET_DELETE_ON_CLOSE_FLAG(x) (((x) & DELETE_ON_CLOSE_FLAG) ? True : False)
195 #define SET_DELETE_ON_CLOSE_FLAG(x) ((x) ? DELETE_ON_CLOSE_FLAG : 0)
197 /* open disposition values */
198 #define FILE_EXISTS_FAIL 0
199 #define FILE_EXISTS_OPEN 1
200 #define FILE_EXISTS_TRUNCATE 2
202 /* mask for open disposition. */
203 #define FILE_OPEN_MASK 0x3
205 #define GET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
206 #define SET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
208 /* The above can be OR'ed with... */
209 #define FILE_CREATE_IF_NOT_EXIST 0x10
210 #define FILE_FAIL_IF_NOT_EXIST 0
212 #define GET_FILE_CREATE_DISPOSITION(x) ((x) & (FILE_CREATE_IF_NOT_EXIST|FILE_FAIL_IF_NOT_EXIST))
214 /* share types */
215 #define STYPE_DISKTREE 0 /* Disk drive */
216 #define STYPE_PRINTQ 1 /* Spooler queue */
217 #define STYPE_DEVICE 2 /* Serial device */
218 #define STYPE_IPC 3 /* Interprocess communication (IPC) */
219 #define STYPE_HIDDEN 0x80000000 /* share is a hidden one (ends with $) */
221 /* SMB X/Open error codes for the ERRDOS error class */
222 #define ERRbadfunc 1 /* Invalid function (or system call) */
223 #define ERRbadfile 2 /* File not found (pathname error) */
224 #define ERRbadpath 3 /* Directory not found */
225 #define ERRnofids 4 /* Too many open files */
226 #define ERRnoaccess 5 /* Access denied */
227 #define ERRbadfid 6 /* Invalid fid */
228 #define ERRnomem 8 /* Out of memory */
229 #define ERRbadmem 9 /* Invalid memory block address */
230 #define ERRbadenv 10 /* Invalid environment */
231 #define ERRbadaccess 12 /* Invalid open mode */
232 #define ERRbaddata 13 /* Invalid data (only from ioctl call) */
233 #define ERRres 14 /* reserved */
234 #define ERRbaddrive 15 /* Invalid drive */
235 #define ERRremcd 16 /* Attempt to delete current directory */
236 #define ERRdiffdevice 17 /* rename/move across different filesystems */
237 #define ERRnofiles 18 /* no more files found in file search */
238 #define ERRbadshare 32 /* Share mode on file conflict with open mode */
239 #define ERRlock 33 /* Lock request conflicts with existing lock */
240 #define ERRunsup 50 /* Request unsupported, returned by Win 95, RJS 20Jun98 */
241 #define ERRfilexists 80 /* File in operation already exists */
242 #define ERRcannotopen 110 /* Cannot open the file specified */
243 #define ERRunknownlevel 124
244 #define ERRrename 183
245 #define ERRbadpipe 230 /* Named pipe invalid */
246 #define ERRpipebusy 231 /* All instances of pipe are busy */
247 #define ERRpipeclosing 232 /* named pipe close in progress */
248 #define ERRnotconnected 233 /* No process on other end of named pipe */
249 #define ERRmoredata 234 /* More data to be returned */
250 #define ERRbaddirectory 267 /* Invalid directory name in a path. */
251 #define ERROR_EAS_DIDNT_FIT 275 /* Extended attributes didn't fit */
252 #define ERROR_EAS_NOT_SUPPORTED 282 /* Extended attributes not supported */
253 #define ERROR_NOTIFY_ENUM_DIR 1022 /* Buffer too small to return change notify. */
254 #define ERRunknownipc 2142
257 /* here's a special one from observing NT */
258 #define ERRnoipc 66 /* don't support ipc */
260 /* Error codes for the ERRSRV class */
262 #define ERRerror 1 /* Non specific error code */
263 #define ERRbadpw 2 /* Bad password */
264 #define ERRbadtype 3 /* reserved */
265 #define ERRaccess 4 /* No permissions to do the requested operation */
266 #define ERRinvnid 5 /* tid invalid */
267 #define ERRinvnetname 6 /* Invalid servername */
268 #define ERRinvdevice 7 /* Invalid device */
269 #define ERRqfull 49 /* Print queue full */
270 #define ERRqtoobig 50 /* Queued item too big */
271 #define ERRinvpfid 52 /* Invalid print file in smb_fid */
272 #define ERRsmbcmd 64 /* Unrecognised command */
273 #define ERRsrverror 65 /* smb server internal error */
274 #define ERRfilespecs 67 /* fid and pathname invalid combination */
275 #define ERRbadlink 68 /* reserved */
276 #define ERRbadpermits 69 /* Access specified for a file is not valid */
277 #define ERRbadpid 70 /* reserved */
278 #define ERRsetattrmode 71 /* attribute mode invalid */
279 #define ERRpaused 81 /* Message server paused */
280 #define ERRmsgoff 82 /* Not receiving messages */
281 #define ERRnoroom 83 /* No room for message */
282 #define ERRrmuns 87 /* too many remote usernames */
283 #define ERRtimeout 88 /* operation timed out */
284 #define ERRnoresource 89 /* No resources currently available for request. */
285 #define ERRtoomanyuids 90 /* too many userids */
286 #define ERRbaduid 91 /* bad userid */
287 #define ERRuseMPX 250 /* temporarily unable to use raw mode, use MPX mode */
288 #define ERRuseSTD 251 /* temporarily unable to use raw mode, use standard mode */
289 #define ERRcontMPX 252 /* resume MPX mode */
290 #define ERRbadPW /* reserved */
291 #define ERRnosupport 0xFFFF
292 #define ERRunknownsmb 22 /* from NT 3.5 response */
295 /* Error codes for the ERRHRD class */
297 #define ERRnowrite 19 /* read only media */
298 #define ERRbadunit 20 /* Unknown device */
299 #define ERRnotready 21 /* Drive not ready */
300 #define ERRbadcmd 22 /* Unknown command */
301 #define ERRdata 23 /* Data (CRC) error */
302 #define ERRbadreq 24 /* Bad request structure length */
303 #define ERRseek 25
304 #define ERRbadmedia 26
305 #define ERRbadsector 27
306 #define ERRnopaper 28
307 #define ERRwrite 29 /* write fault */
308 #define ERRread 30 /* read fault */
309 #define ERRgeneral 31 /* General hardware failure */
310 #define ERRwrongdisk 34
311 #define ERRFCBunavail 35
312 #define ERRsharebufexc 36 /* share buffer exceeded */
313 #define ERRdiskfull 39
316 typedef char pstring[1024];
317 typedef char fstring[128];
319 /* pipe string names */
320 #define PIPE_LANMAN "\\PIPE\\LANMAN"
321 #define PIPE_SRVSVC "\\PIPE\\srvsvc"
322 #define PIPE_SAMR "\\PIPE\\samr"
323 #define PIPE_WINREG "\\PIPE\\winreg"
324 #define PIPE_WKSSVC "\\PIPE\\wkssvc"
325 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
326 #define PIPE_NTLSA "\\PIPE\\ntlsa"
327 #define PIPE_NTSVCS "\\PIPE\\ntsvcs"
328 #define PIPE_LSASS "\\PIPE\\lsass"
329 #define PIPE_LSARPC "\\PIPE\\lsarpc"
332 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
333 typedef struct nttime_info
335 uint32 low;
336 uint32 high;
338 } NTTIME;
340 /* Allowable account control bits */
341 #define ACB_DISABLED 0x0001 /* 1 = User account disabled */
342 #define ACB_HOMDIRREQ 0x0002 /* 1 = Home directory required */
343 #define ACB_PWNOTREQ 0x0004 /* 1 = User password not required */
344 #define ACB_TEMPDUP 0x0008 /* 1 = Temporary duplicate account */
345 #define ACB_NORMAL 0x0010 /* 1 = Normal user account */
346 #define ACB_MNS 0x0020 /* 1 = MNS logon user account */
347 #define ACB_DOMTRUST 0x0040 /* 1 = Interdomain trust account */
348 #define ACB_WSTRUST 0x0080 /* 1 = Workstation trust account */
349 #define ACB_SVRTRUST 0x0100 /* 1 = Server trust account */
350 #define ACB_PWNOEXP 0x0200 /* 1 = User password does not expire */
351 #define ACB_AUTOLOCK 0x0400 /* 1 = Account auto locked */
353 #define MAX_HOURS_LEN 32
355 struct sam_passwd
357 time_t logon_time; /* logon time */
358 time_t logoff_time; /* logoff time */
359 time_t kickoff_time; /* kickoff time */
360 time_t pass_last_set_time; /* password last set time */
361 time_t pass_can_change_time; /* password can change time */
362 time_t pass_must_change_time; /* password must change time */
364 char *smb_name; /* username string */
365 char *full_name; /* user's full name string */
366 char *home_dir; /* home directory string */
367 char *dir_drive; /* home directory drive string */
368 char *logon_script; /* logon script string */
369 char *profile_path; /* profile path string */
370 char *acct_desc; /* user description string */
371 char *workstations; /* login from workstations string */
372 char *unknown_str; /* don't know what this is, yet. */
373 char *munged_dial; /* munged path name and dial-back tel number */
375 uid_t smb_userid; /* this is actually the unix uid_t */
376 gid_t smb_grpid; /* this is actually the unix gid_t */
377 uint32 user_rid; /* Primary User ID */
378 uint32 group_rid; /* Primary Group ID */
380 unsigned char *smb_passwd; /* Null if no password */
381 unsigned char *smb_nt_passwd; /* Null if no password */
383 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
384 uint32 unknown_3; /* 0x00ff ffff */
386 uint16 logon_divs; /* 168 - number of hours in a week */
387 uint32 hours_len; /* normally 21 bytes */
388 uint8 hours[MAX_HOURS_LEN];
390 uint32 unknown_5; /* 0x0002 0000 */
391 uint32 unknown_6; /* 0x0000 04ec */
394 struct smb_passwd
396 uid_t smb_userid; /* this is actually the unix uid_t */
397 char *smb_name; /* username string */
399 unsigned char *smb_passwd; /* Null if no password */
400 unsigned char *smb_nt_passwd; /* Null if no password */
402 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
403 time_t pass_last_set_time; /* password last set time */
407 struct sam_disp_info
409 uint32 user_rid; /* Primary User ID */
410 char *smb_name; /* username string */
411 char *full_name; /* user's full name string */
414 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
416 /* DOM_SID - security id */
417 typedef struct sid_info
419 uint8 sid_rev_num; /* SID revision number */
420 uint8 num_auths; /* number of sub-authorities */
421 uint8 id_auth[6]; /* Identifier Authority */
423 * Note that the values in these uint32's are in *native* byteorder,
424 * not neccessarily little-endian...... JRA.
426 uint32 sub_auths[MAXSUBAUTHS]; /* pointer to sub-authorities. */
428 } DOM_SID;
431 /*** query a local group, get a list of these: shows who is in that group ***/
433 /* local group member info */
434 typedef struct local_grp_member_info
436 DOM_SID sid; /* matches with name */
437 uint8 sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
438 fstring name; /* matches with sid: must be of the form "DOMAIN\account" */
440 } LOCAL_GRP_MEMBER;
442 /* enumerate these to get list of local groups */
444 /* local group info */
445 typedef struct local_grp_info
447 fstring name;
448 fstring comment;
450 } LOCAL_GRP;
452 /*** enumerate these to get list of domain groups ***/
454 /* domain group member info */
455 typedef struct domain_grp_info
457 fstring name;
458 fstring comment;
459 uint32 rid; /* group rid */
460 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
462 } DOMAIN_GRP;
464 /*** query a domain group, get a list of these: shows who is in that group ***/
466 /* domain group info */
467 typedef struct domain_grp_member_info
469 fstring name;
470 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
472 } DOMAIN_GRP_MEMBER;
474 /* DOM_CHAL - challenge info */
475 typedef struct chal_info
477 uchar data[8]; /* credentials */
478 } DOM_CHAL;
480 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
481 typedef struct time_info
483 uint32 time;
484 } UTIME;
486 /* DOM_CREDs - timestamped client or server credentials */
487 typedef struct cred_info
489 DOM_CHAL challenge; /* credentials */
490 UTIME timestamp; /* credential time-stamp */
491 } DOM_CRED;
493 /* Structure used when SMBwritebmpx is active */
494 typedef struct
496 size_t wr_total_written; /* So we know when to discard this */
497 int32 wr_timeout;
498 int32 wr_errclass;
499 int32 wr_error; /* Cached errors */
500 BOOL wr_mode; /* write through mode) */
501 BOOL wr_discard; /* discard all further data */
502 } write_bmpx_struct;
505 * Structure used to indirect fd's from the files_struct.
506 * Needed as POSIX locking is based on file and process, not
507 * file descriptor and process.
510 typedef struct file_fd_struct
512 struct file_fd_struct *next, *prev;
513 uint16 ref_count;
514 uint16 uid_cache_count;
515 uid_t uid_users_cache[10];
516 SMB_DEV_T dev;
517 SMB_INO_T inode;
518 int fd;
519 int fd_readonly;
520 int fd_writeonly;
521 int real_open_flags;
522 BOOL delete_on_close;
523 } file_fd_struct;
526 * Structure used to keep directory state information around.
527 * Used in NT change-notify code.
530 typedef struct
532 time_t modify_time;
533 time_t status_time;
534 } dir_status_struct;
536 struct uid_cache
538 int entries;
539 uid_t list[UID_CACHE_SIZE];
542 typedef struct
544 char *name;
545 BOOL is_wild;
546 } name_compare_entry;
548 typedef struct connection_struct
550 struct connection_struct *next, *prev;
551 unsigned cnum; /* an index passed over the wire */
552 int service;
553 BOOL force_user;
554 struct uid_cache uid_cache;
555 void *dirptr;
556 BOOL printer;
557 BOOL ipc;
558 BOOL read_only;
559 BOOL admin_user;
560 char *dirpath;
561 char *connectpath;
562 char *origpath;
563 char *user; /* name of user who *opened* this connection */
564 uid_t uid; /* uid of user who *opened* this connection */
565 gid_t gid; /* gid of user who *opened* this connection */
567 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
569 /* following groups stuff added by ih */
571 /* This groups info is valid for the user that *opened* the connection */
572 int ngroups;
573 gid_t *groups;
575 time_t lastused;
576 BOOL used;
577 int num_files_open;
578 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
579 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
580 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
582 } connection_struct;
584 struct current_user
586 connection_struct *conn;
587 uint16 vuid;
588 uid_t uid;
589 gid_t gid;
590 int ngroups;
591 gid_t *groups;
594 typedef struct files_struct
596 struct files_struct *next, *prev;
597 int fnum;
598 connection_struct *conn;
599 file_fd_struct *fd_ptr;
600 SMB_OFF_T pos;
601 SMB_OFF_T size;
602 mode_t mode;
603 uint16 vuid;
604 char *mmap_ptr;
605 SMB_OFF_T mmap_size;
606 write_bmpx_struct *wbmpx_ptr;
607 struct timeval open_time;
608 int share_mode;
609 time_t pending_modtime;
610 BOOL open;
611 BOOL can_lock;
612 BOOL can_read;
613 BOOL can_write;
614 BOOL print_file;
615 BOOL modified;
616 BOOL granted_oplock;
617 BOOL sent_oplock_break;
618 BOOL is_directory;
619 BOOL directory_delete_on_close;
620 BOOL stat_open;
621 char *fsp_name;
622 } files_struct;
624 /* Domain controller authentication protocol info */
625 struct dcinfo
627 DOM_CHAL clnt_chal; /* Initial challenge received from client */
628 DOM_CHAL srv_chal; /* Initial server challenge */
629 DOM_CRED clnt_cred; /* Last client credential */
630 DOM_CRED srv_cred; /* Last server credential */
632 uchar sess_key[8]; /* Session key */
633 uchar md4pw[16]; /* md4(machine password) */
636 typedef struct
638 uid_t uid; /* uid of a validated user */
639 gid_t gid; /* gid of a validated user */
641 fstring requested_name; /* user name from the client */
642 fstring name; /* unix user name of a validated user */
643 fstring real_name; /* to store real name from password file - simeon */
644 BOOL guest;
646 /* following groups stuff added by ih */
647 /* This groups info is needed for when we become_user() for this uid */
648 int n_groups;
649 gid_t *groups;
651 int n_sids;
652 int *sids;
654 /* per-user authentication information on NT RPCs */
655 struct dcinfo dc;
657 } user_struct;
660 enum
661 { LPQ_QUEUED, LPQ_PAUSED, LPQ_SPOOLING, LPQ_PRINTING };
663 typedef struct
665 int job;
666 int size;
667 int status;
668 int priority;
669 time_t time;
670 char user[30];
671 char file[100];
672 } print_queue_struct;
674 enum
675 { LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR };
677 typedef struct
679 fstring message;
680 int status;
681 } print_status_struct;
683 /* used for server information: client, nameserv and ipc */
684 struct server_info_struct
686 fstring name;
687 uint32 type;
688 fstring comment;
689 fstring domain; /* used ONLY in ipc.c NOT namework.c */
690 BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
694 /* used for network interfaces */
695 struct interface
697 struct interface *next;
698 struct in_addr ip;
699 struct in_addr bcast;
700 struct in_addr nmask;
703 /* struct returned by get_share_modes */
704 typedef struct
706 int pid;
707 uint16 op_port;
708 uint16 op_type;
709 int share_mode;
710 struct timeval time;
711 } share_mode_entry;
714 /* each implementation of the share mode code needs
715 to support the following operations */
716 struct share_ops
718 BOOL (*stop_mgmt) (void);
719 BOOL (*lock_entry) (connection_struct *, SMB_DEV_T, SMB_INO_T, int *);
720 BOOL (*unlock_entry) (connection_struct *, SMB_DEV_T, SMB_INO_T, int);
721 int (*get_entries) (connection_struct *, int, SMB_DEV_T, SMB_INO_T, share_mode_entry **);
722 void (*del_entry) (int, files_struct *);
723 BOOL (*set_entry) (int, files_struct *, uint16, uint16);
724 BOOL (*mod_entry) (int, files_struct *,
725 void (*)(share_mode_entry *, SMB_DEV_T, SMB_INO_T, void *), void *);
726 int (*forall) (void (*)(share_mode_entry *, char *));
727 void (*status) (FILE *);
730 /* each implementation of the shared memory code needs
731 to support the following operations */
732 struct shmem_ops
734 BOOL (*shm_close) (void);
735 int (*shm_alloc) (int);
736 BOOL (*shm_free) (int);
737 int (*get_userdef_off) (void);
738 void *(*offset2addr) (int);
739 int (*addr2offset) (void *addr);
740 BOOL (*lock_hash_entry) (unsigned int);
741 BOOL (*unlock_hash_entry) (unsigned int);
742 BOOL (*get_usage) (int *, int *, int *);
743 unsigned (*hash_size) (void);
747 * Each implementation of the password database code needs
748 * to support the following operations.
751 struct passdb_ops
754 * Password database ops.
756 void *(*startsmbpwent) (BOOL);
757 void (*endsmbpwent) (void *);
758 SMB_BIG_UINT (*getsmbpwpos) (void *);
759 BOOL (*setsmbpwpos) (void *, SMB_BIG_UINT);
762 * smb password database query functions.
764 struct smb_passwd *(*getsmbpwnam) (char *);
765 struct smb_passwd *(*getsmbpwuid) (uid_t);
766 struct smb_passwd *(*getsmbpwrid) (uint32);
767 struct smb_passwd *(*getsmbpwent) (void *);
770 * smb password database modification functions.
772 BOOL (*add_smbpwd_entry) (struct smb_passwd *);
773 BOOL (*mod_smbpwd_entry) (struct smb_passwd *, BOOL);
776 * Functions that manipulate a struct sam_passwd.
778 struct sam_passwd *(*getsam21pwent) (void *);
781 * sam password database query functions.
783 struct sam_passwd *(*getsam21pwnam) (char *);
784 struct sam_passwd *(*getsam21pwuid) (uid_t);
785 struct sam_passwd *(*getsam21pwrid) (uint32);
788 * sam password database modification functions.
790 BOOL (*add_sam21pwd_entry) (struct sam_passwd *);
791 BOOL (*mod_sam21pwd_entry) (struct sam_passwd *, BOOL);
794 * sam query display info functions.
796 struct sam_disp_info *(*getsamdispnam) (char *);
797 struct sam_disp_info *(*getsamdisprid) (uint32);
798 struct sam_disp_info *(*getsamdispent) (void *);
800 #if 0
802 * password checking functions
804 struct smb_passwd *(*smb_password_chal) (char *username, char lm_pass[24], char nt_pass[24],
805 char chal[8]);
806 struct smb_passwd *(*smb_password_check) (char *username, char lm_hash[16], char nt_hash[16]);
807 struct passwd *(*unix_password_check) (char *username, char *pass, int pass_len);
808 #endif
811 /* this is used for smbstatus */
813 struct connect_record
815 int magic;
816 int pid;
817 int cnum;
818 uid_t uid;
819 gid_t gid;
820 char name[24];
821 char addr[24];
822 char machine[128];
823 time_t start;
826 /* This is used by smbclient to send it to a smbfs mount point */
827 struct connection_options
829 int protocol;
830 /* Connection-Options */
831 uint32 max_xmit;
832 uint16 server_vuid;
833 uint16 tid;
834 /* The following are LANMAN 1.0 options */
835 uint16 sec_mode;
836 uint16 max_mux;
837 uint16 max_vcs;
838 uint16 rawmode;
839 uint32 sesskey;
840 /* The following are NT LM 0.12 options */
841 uint32 maxraw;
842 uint32 capabilities;
843 uint16 serverzone;
846 /* the following are used by loadparm for option lists */
847 typedef enum
849 P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER, P_OCTAL,
850 P_STRING, P_USTRING, P_GSTRING, P_UGSTRING, P_ENUM, P_SEP
851 } parm_type;
853 typedef enum
855 P_LOCAL, P_GLOBAL, P_SEPARATOR, P_NONE
856 } parm_class;
858 struct enum_list
860 int value;
861 const char *name;
864 struct parm_struct
866 const char *label;
867 parm_type type;
868 parm_class class;
869 void *ptr;
870 BOOL (*special) (const char *, char **);
871 const struct enum_list *enum_list;
872 unsigned flags;
873 union
875 BOOL bvalue;
876 int ivalue;
877 char *svalue;
878 char cvalue;
879 } def;
882 struct bitmap
884 uint32 *b;
885 int n;
888 #define FLAG_BASIC 0x01 /* fundamental options */
889 #define FLAG_SHARE 0x02 /* file sharing options */
890 #define FLAG_PRINT 0x04 /* printing options */
891 #define FLAG_GLOBAL 0x08 /* local options that should be globally settable in SWAT */
892 #define FLAG_DEPRECATED 0x10 /* options that should no longer be used */
893 #define FLAG_HIDE 0x20 /* options that should be hidden in SWAT */
895 #ifndef LOCKING_VERSION
896 #define LOCKING_VERSION 4
897 #endif /* LOCKING_VERSION */
899 /* these are useful macros for checking validity of handles */
900 #define OPEN_FSP(fsp) ((fsp) && (fsp)->open && !(fsp)->is_directory)
901 #define OPEN_CONN(conn) ((conn) && (conn)->open)
902 #define IS_IPC(conn) ((conn) && (conn)->ipc)
903 #define IS_PRINT(conn) ((conn) && (conn)->printer)
904 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn)
906 #define CHECK_FSP(fsp,conn) if (!FNUM_OK(fsp,conn)) \
907 return(ERROR(ERRDOS,ERRbadfid)); \
908 else if((fsp)->fd_ptr == NULL) \
909 return(ERROR(ERRDOS,ERRbadaccess))
911 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
912 return(ERROR(ERRDOS,ERRbadaccess))
913 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
914 return(ERROR(ERRDOS,ERRbadaccess))
915 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
916 return(CACHED_ERROR(fsp))
918 /* translates a connection number into a service number */
919 #define SNUM(conn) ((conn)?(conn)->service:-1)
921 /* access various service details */
922 #define SERVICE(snum) (lp_servicename(snum))
923 #define PRINTCAP (lp_printcapname())
924 #define PRINTCOMMAND(snum) (lp_printcommand(snum))
925 #define PRINTERNAME(snum) (lp_printername(snum))
926 #define CAN_WRITE(conn) (!conn->read_only)
927 #define VALID_SNUM(snum) (lp_snum_ok(snum))
928 #define GUEST_OK(snum) (VALID_SNUM(snum) && lp_guest_ok(snum))
929 #define GUEST_ONLY(snum) (VALID_SNUM(snum) && lp_guest_only(snum))
930 #define CAN_SETDIR(snum) (!lp_no_set_dir(snum))
931 #define CAN_PRINT(conn) ((conn) && lp_print_ok((conn)->service))
932 #define MAP_HIDDEN(conn) ((conn) && lp_map_hidden((conn)->service))
933 #define MAP_SYSTEM(conn) ((conn) && lp_map_system((conn)->service))
934 #define MAP_ARCHIVE(conn) ((conn) && lp_map_archive((conn)->service))
935 #define IS_HIDDEN_PATH(conn,path) ((conn) && is_in_path((path),(conn)->hide_list))
936 #define IS_VETO_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_list))
937 #define IS_VETO_OPLOCK_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_oplock_list))
940 * Used by the stat cache code to check if a returned
941 * stat structure is valid.
944 #define VALID_STAT(st) (st.st_nlink != 0)
945 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR(st.st_mode))
947 #define SMBENCRYPT() (lp_encrypted_passwords())
949 /* the basic packet size, assuming no words or bytes */
950 #define smb_size 39
952 /* offsets into message for common items */
953 #define smb_com 8
954 #define smb_rcls 9
955 #define smb_reh 10
956 #define smb_err 11
957 #define smb_flg 13
958 #define smb_flg2 14
959 #define smb_reb 13
960 #define smb_tid 28
961 #define smb_pid 30
962 #define smb_uid 32
963 #define smb_mid 34
964 #define smb_wct 36
965 #define smb_vwv 37
966 #define smb_vwv0 37
967 #define smb_vwv1 39
968 #define smb_vwv2 41
969 #define smb_vwv3 43
970 #define smb_vwv4 45
971 #define smb_vwv5 47
972 #define smb_vwv6 49
973 #define smb_vwv7 51
974 #define smb_vwv8 53
975 #define smb_vwv9 55
976 #define smb_vwv10 57
977 #define smb_vwv11 59
978 #define smb_vwv12 61
979 #define smb_vwv13 63
980 #define smb_vwv14 65
981 #define smb_vwv15 67
982 #define smb_vwv16 69
983 #define smb_vwv17 71
985 /* flag defines. CIFS spec 3.1.1 */
986 #define FLAG_SUPPORT_LOCKREAD 0x01
987 #define FLAG_CLIENT_BUF_AVAIL 0x02
988 #define FLAG_RESERVED 0x04
989 #define FLAG_CASELESS_PATHNAMES 0x08
990 #define FLAG_CANONICAL_PATHNAMES 0x10
991 #define FLAG_REQUEST_OPLOCK 0x20
992 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
993 #define FLAG_REPLY 0x80
995 /* the complete */
996 #define SMBmkdir 0x00 /* create directory */
997 #define SMBrmdir 0x01 /* delete directory */
998 #define SMBopen 0x02 /* open file */
999 #define SMBcreate 0x03 /* create file */
1000 #define SMBclose 0x04 /* close file */
1001 #define SMBflush 0x05 /* flush file */
1002 #define SMBunlink 0x06 /* delete file */
1003 #define SMBmv 0x07 /* rename file */
1004 #define SMBgetatr 0x08 /* get file attributes */
1005 #define SMBsetatr 0x09 /* set file attributes */
1006 #define SMBread 0x0A /* read from file */
1007 #define SMBwrite 0x0B /* write to file */
1008 #define SMBlock 0x0C /* lock byte range */
1009 #define SMBunlock 0x0D /* unlock byte range */
1010 #define SMBctemp 0x0E /* create temporary file */
1011 #define SMBmknew 0x0F /* make new file */
1012 #define SMBchkpth 0x10 /* check directory path */
1013 #define SMBexit 0x11 /* process exit */
1014 #define SMBlseek 0x12 /* seek */
1015 #define SMBtcon 0x70 /* tree connect */
1016 #define SMBtconX 0x75 /* tree connect and X */
1017 #define SMBtdis 0x71 /* tree disconnect */
1018 #define SMBnegprot 0x72 /* negotiate protocol */
1019 #define SMBdskattr 0x80 /* get disk attributes */
1020 #define SMBsearch 0x81 /* search directory */
1021 #define SMBsplopen 0xC0 /* open print spool file */
1022 #define SMBsplwr 0xC1 /* write to print spool file */
1023 #define SMBsplclose 0xC2 /* close print spool file */
1024 #define SMBsplretq 0xC3 /* return print queue */
1025 #define SMBsends 0xD0 /* send single block message */
1026 #define SMBsendb 0xD1 /* send broadcast message */
1027 #define SMBfwdname 0xD2 /* forward user name */
1028 #define SMBcancelf 0xD3 /* cancel forward */
1029 #define SMBgetmac 0xD4 /* get machine name */
1030 #define SMBsendstrt 0xD5 /* send start of multi-block message */
1031 #define SMBsendend 0xD6 /* send end of multi-block message */
1032 #define SMBsendtxt 0xD7 /* send text of multi-block message */
1034 /* Core+ protocol */
1035 #define SMBlockread 0x13 /* Lock a range and read */
1036 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1037 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
1038 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
1039 #define SMBwritec 0x20 /* secondary write request */
1040 #define SMBwriteclose 0x2c /* write a file then close it */
1042 /* dos extended protocol */
1043 #define SMBreadBraw 0x1A /* read block raw */
1044 #define SMBreadBmpx 0x1B /* read block multiplexed */
1045 #define SMBreadBs 0x1C /* read block (secondary response) */
1046 #define SMBwriteBraw 0x1D /* write block raw */
1047 #define SMBwriteBmpx 0x1E /* write block multiplexed */
1048 #define SMBwriteBs 0x1F /* write block (secondary request) */
1049 #define SMBwriteC 0x20 /* write complete response */
1050 #define SMBsetattrE 0x22 /* set file attributes expanded */
1051 #define SMBgetattrE 0x23 /* get file attributes expanded */
1052 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
1053 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
1054 #define SMBtranss 0x26 /* transaction (secondary request/response) */
1055 #define SMBioctl 0x27 /* IOCTL */
1056 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
1057 #define SMBcopy 0x29 /* copy */
1058 #define SMBmove 0x2A /* move */
1059 #define SMBecho 0x2B /* echo */
1060 #define SMBopenX 0x2D /* open and X */
1061 #define SMBreadX 0x2E /* read and X */
1062 #define SMBwriteX 0x2F /* write and X */
1063 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
1064 #define SMBffirst 0x82 /* find first */
1065 #define SMBfunique 0x83 /* find unique */
1066 #define SMBfclose 0x84 /* find close */
1067 #define SMBinvalid 0xFE /* invalid command */
1069 /* Extended 2.0 protocol */
1070 #define SMBtrans2 0x32 /* TRANS2 protocol set */
1071 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
1072 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
1073 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1074 #define SMBulogoffX 0x74 /* user logoff */
1076 /* NT SMB extensions. */
1077 #define SMBnttrans 0xA0 /* NT transact */
1078 #define SMBnttranss 0xA1 /* NT transact secondary */
1079 #define SMBntcreateX 0xA2 /* NT create and X */
1080 #define SMBntcancel 0xA4 /* NT cancel */
1082 /* These are the TRANS2 sub commands */
1083 #define TRANSACT2_OPEN 0
1084 #define TRANSACT2_FINDFIRST 1
1085 #define TRANSACT2_FINDNEXT 2
1086 #define TRANSACT2_QFSINFO 3
1087 #define TRANSACT2_SETFSINFO 4
1088 #define TRANSACT2_QPATHINFO 5
1089 #define TRANSACT2_SETPATHINFO 6
1090 #define TRANSACT2_QFILEINFO 7
1091 #define TRANSACT2_SETFILEINFO 8
1092 #define TRANSACT2_FSCTL 9
1093 #define TRANSACT2_IOCTL 0xA
1094 #define TRANSACT2_FINDNOTIFYFIRST 0xB
1095 #define TRANSACT2_FINDNOTIFYNEXT 0xC
1096 #define TRANSACT2_MKDIR 0xD
1097 #define TRANSACT2_SESSION_SETUP 0xE
1098 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1099 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1101 /* These are the NT transact sub commands. */
1102 #define NT_TRANSACT_CREATE 1
1103 #define NT_TRANSACT_IOCTL 2
1104 #define NT_TRANSACT_SET_SECURITY_DESC 3
1105 #define NT_TRANSACT_NOTIFY_CHANGE 4
1106 #define NT_TRANSACT_RENAME 5
1107 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1109 /* these are the trans2 sub fields for primary requests */
1110 #define smb_tpscnt smb_vwv0
1111 #define smb_tdscnt smb_vwv1
1112 #define smb_mprcnt smb_vwv2
1113 #define smb_mdrcnt smb_vwv3
1114 #define smb_msrcnt smb_vwv4
1115 #define smb_flags smb_vwv5
1116 #define smb_timeout smb_vwv6
1117 #define smb_pscnt smb_vwv9
1118 #define smb_psoff smb_vwv10
1119 #define smb_dscnt smb_vwv11
1120 #define smb_dsoff smb_vwv12
1121 #define smb_suwcnt smb_vwv13
1122 #define smb_setup smb_vwv14
1123 #define smb_setup0 smb_setup
1124 #define smb_setup1 (smb_setup+2)
1125 #define smb_setup2 (smb_setup+4)
1127 /* these are for the secondary requests */
1128 #define smb_spscnt smb_vwv2
1129 #define smb_spsoff smb_vwv3
1130 #define smb_spsdisp smb_vwv4
1131 #define smb_sdscnt smb_vwv5
1132 #define smb_sdsoff smb_vwv6
1133 #define smb_sdsdisp smb_vwv7
1134 #define smb_sfid smb_vwv8
1136 /* and these for responses */
1137 #define smb_tprcnt smb_vwv0
1138 #define smb_tdrcnt smb_vwv1
1139 #define smb_prcnt smb_vwv3
1140 #define smb_proff smb_vwv4
1141 #define smb_prdisp smb_vwv5
1142 #define smb_drcnt smb_vwv6
1143 #define smb_droff smb_vwv7
1144 #define smb_drdisp smb_vwv8
1146 /* these are for the NT trans primary request. */
1147 #define smb_nt_MaxSetupCount smb_vwv0
1148 #define smb_nt_Flags (smb_vwv0 + 1)
1149 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1150 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1151 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1152 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1153 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1154 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1155 #define smb_nt_DataCount (smb_vwv0 + 27)
1156 #define smb_nt_DataOffset (smb_vwv0 + 31)
1157 #define smb_nt_SetupCount (smb_vwv0 + 35)
1158 #define smb_nt_Function (smb_vwv0 + 36)
1159 #define smb_nt_SetupStart (smb_vwv0 + 38)
1161 /* these are for the NT trans secondary request. */
1162 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1163 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1164 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1165 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1166 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1167 #define smb_nts_DataCount (smb_vwv0 + 23)
1168 #define smb_nts_DataOffset (smb_vwv0 + 27)
1169 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1171 /* these are for the NT trans reply. */
1172 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1173 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1174 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1175 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1176 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1177 #define smb_ntr_DataCount (smb_vwv0 + 23)
1178 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1179 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1181 /* these are for the NT create_and_X */
1182 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1183 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1184 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1185 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1186 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1187 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1188 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1189 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1190 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1191 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1192 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1194 /* this is used on a TConX. I'm not sure the name is very helpful though */
1195 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1197 /* these are the constants used in the above call. */
1198 /* DesiredAccess */
1199 /* File Specific access rights. */
1200 #define FILE_READ_DATA 0x001
1201 #define FILE_WRITE_DATA 0x002
1202 #define FILE_APPEND_DATA 0x004
1203 #define FILE_READ_EA 0x008
1204 #define FILE_WRITE_EA 0x010
1205 #define FILE_EXECUTE 0x020
1206 #define FILE_DELETE_CHILD 0x040
1207 #define FILE_READ_ATTRIBUTES 0x080
1208 #define FILE_WRITE_ATTRIBUTES 0x100
1210 #define FILE_ALL_ATTRIBUTES 0x1FF
1212 /* Generic access masks & rights. */
1213 #define SPECIFIC_RIGHTS_MASK 0x00FFFFL
1214 #define STANDARD_RIGHTS_MASK 0xFF0000L
1215 #define DELETE_ACCESS (1L<<16)
1216 #define READ_CONTROL_ACCESS (1L<<17)
1217 #define WRITE_DAC_ACCESS (1L<<18)
1218 #define WRITE_OWNER_ACCESS (1L<<19)
1219 #define SYNCHRONIZE_ACCESS (1L<<20)
1221 #define SYSTEM_SECURITY_ACCESS (1L<<24)
1222 #define GENERIC_ALL_ACCESS (1<<28)
1223 #define GENERIC_EXECUTE_ACCESS (1<<29)
1224 #define GENERIC_WRITE_ACCESS (1<<30)
1225 #define GENERIC_READ_ACCESS (1<<31)
1227 #define FILE_ALL_STANDARD_ACCESS 0x1F0000
1229 /* Mapping of access rights to UNIX perms. */
1230 #if 0 /* Don't use all here... JRA. */
1231 #define UNIX_ACCESS_RWX (FILE_ALL_ATTRIBUTES|FILE_ALL_STANDARD_ACCESS)
1232 #else
1233 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1234 #endif
1236 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1237 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1238 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1239 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1240 FILE_APPEND_DATA|FILE_WRITE_DATA)
1241 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1242 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1244 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1246 /* Flags field. */
1247 #define REQUEST_OPLOCK 2
1248 #define REQUEST_BATCH_OPLOCK 4
1249 #define OPEN_DIRECTORY 8
1251 /* ShareAccess field. */
1252 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1253 #define FILE_SHARE_READ 1
1254 #define FILE_SHARE_WRITE 2
1255 #define FILE_SHARE_DELETE 4
1257 /* FileAttributesField */
1258 #define FILE_ATTRIBUTE_READONLY aRONLY
1259 #define FILE_ATTRIBUTE_HIDDEN aHIDDEN
1260 #define FILE_ATTRIBUTE_SYSTEM aSYSTEM
1261 #define FILE_ATTRIBUTE_DIRECTORY aDIR
1262 #define FILE_ATTRIBUTE_ARCHIVE aARCH
1263 #define FILE_ATTRIBUTE_NORMAL 0x80L
1264 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1265 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1266 #define SAMBA_ATTRIBUTES_MASK 0x7F
1268 /* Flags - combined with attributes. */
1269 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1270 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1271 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1272 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1273 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1274 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1275 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1277 /* CreateDisposition field. */
1278 #define FILE_SUPERSEDE 0
1279 #define FILE_OPEN 1
1280 #define FILE_CREATE 2
1281 #define FILE_OPEN_IF 3
1282 #define FILE_OVERWRITE 4
1283 #define FILE_OVERWRITE_IF 5
1285 /* CreateOptions field. */
1286 #define FILE_DIRECTORY_FILE 0x0001
1287 #define FILE_WRITE_THROUGH 0x0002
1288 #define FILE_SEQUENTIAL_ONLY 0x0004
1289 #define FILE_NON_DIRECTORY_FILE 0x0040
1290 #define FILE_NO_EA_KNOWLEDGE 0x0200
1291 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1292 #define FILE_RANDOM_ACCESS 0x0800
1293 #define FILE_DELETE_ON_CLOSE 0x1000
1295 /* Responses when opening a file. */
1296 #define FILE_WAS_OPENED 1
1297 #define FILE_WAS_CREATED 2
1298 #define FILE_WAS_OVERWRITTEN 3
1300 /* File type flags */
1301 #define FILE_TYPE_DISK 0
1302 #define FILE_TYPE_BYTE_MODE_PIPE 1
1303 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1304 #define FILE_TYPE_PRINTER 3
1305 #define FILE_TYPE_COMM_DEVICE 4
1306 #define FILE_TYPE_UNKNOWN 0xFFFF
1308 /* Flag for NT transact rename call. */
1309 #define RENAME_REPLACE_IF_EXISTS 1
1311 /* Filesystem Attributes. */
1312 #define FILE_CASE_SENSITIVE_SEARCH 0x1
1313 #define FILE_CASE_PRESERVED_NAMES 0x2
1314 #define FILE_UNICODE_ON_DISK 0x4
1315 #define FILE_PERSISTENT_ACLS 0x8
1317 /* ChangeNotify flags. */
1318 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
1319 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1320 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1321 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1322 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1323 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1324 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1325 #define FILE_NOTIFY_CHANGE_EA 0x080
1326 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1328 /* where to find the base of the SMB packet proper */
1329 #define smb_base(buf) (((char *)(buf))+4)
1332 #define SMB_SUCCESS 0 /* The request was successful. */
1333 #define ERRDOS 0x01 /* Error is from the core DOS operating system set. */
1334 #define ERRSRV 0x02 /* Error is generated by the server network file manager. */
1335 #define ERRHRD 0x03 /* Error is an hardware error. */
1336 #define ERRCMD 0xFF /* Command was not in the "SMB" format. */
1338 #ifdef HAVE_STDARG_H
1340 slprintf (char *str, int n, const char *format, ...)
1341 #ifdef __GNUC__
1342 __attribute__ ((format (printf, 3, 4)))
1343 #endif
1345 #else
1346 int slprintf ();
1347 #endif
1349 #ifdef WITH_DFS
1350 void dfs_unlogin (void);
1351 extern int dcelogin_atmost_once;
1352 #endif
1354 #ifndef MIN
1355 #define MIN(a,b) ((a)<(b)?(a):(b))
1356 #endif
1357 #ifndef MAX
1358 #define MAX(a,b) ((a)>(b)?(a):(b))
1359 #endif
1361 #ifndef ABS
1362 #define ABS(a) ((a)>0?(a):(-(a)))
1363 #endif
1365 #ifndef SIGNAL_CAST
1366 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1367 #endif
1369 #ifndef SELECT_CAST
1370 #define SELECT_CAST
1371 #endif
1374 /* Some POSIX definitions for those without */
1376 #ifndef S_IFDIR
1377 #define S_IFDIR 0x4000
1378 #endif
1379 #ifndef S_ISDIR
1380 #define S_ISDIR(mode) ((mode & 0xF000) == S_IFDIR)
1381 #endif
1382 #ifndef S_IRWXU
1383 #define S_IRWXU 00700 /* read, write, execute: owner */
1384 #endif
1385 #ifndef S_IRUSR
1386 #define S_IRUSR 00400 /* read permission: owner */
1387 #endif
1388 #ifndef S_IWUSR
1389 #define S_IWUSR 00200 /* write permission: owner */
1390 #endif
1391 #ifndef S_IXUSR
1392 #define S_IXUSR 00100 /* execute permission: owner */
1393 #endif
1394 #ifndef S_IRWXG
1395 #define S_IRWXG 00070 /* read, write, execute: group */
1396 #endif
1397 #ifndef S_IRGRP
1398 #define S_IRGRP 00040 /* read permission: group */
1399 #endif
1400 #ifndef S_IWGRP
1401 #define S_IWGRP 00020 /* write permission: group */
1402 #endif
1403 #ifndef S_IXGRP
1404 #define S_IXGRP 00010 /* execute permission: group */
1405 #endif
1406 #ifndef S_IRWXO
1407 #define S_IRWXO 00007 /* read, write, execute: other */
1408 #endif
1409 #ifndef S_IROTH
1410 #define S_IROTH 00004 /* read permission: other */
1411 #endif
1412 #ifndef S_IWOTH
1413 #define S_IWOTH 00002 /* write permission: other */
1414 #endif
1415 #ifndef S_IXOTH
1416 #define S_IXOTH 00001 /* execute permission: other */
1417 #endif
1420 /* these are used in NetServerEnum to choose what to receive */
1421 #define SV_TYPE_WORKSTATION 0x00000001
1422 #define SV_TYPE_SERVER 0x00000002
1423 #define SV_TYPE_SQLSERVER 0x00000004
1424 #define SV_TYPE_DOMAIN_CTRL 0x00000008
1425 #define SV_TYPE_DOMAIN_BAKCTRL 0x00000010
1426 #define SV_TYPE_TIME_SOURCE 0x00000020
1427 #define SV_TYPE_AFP 0x00000040
1428 #define SV_TYPE_NOVELL 0x00000080
1429 #define SV_TYPE_DOMAIN_MEMBER 0x00000100
1430 #define SV_TYPE_PRINTQ_SERVER 0x00000200
1431 #define SV_TYPE_DIALIN_SERVER 0x00000400
1432 #define SV_TYPE_SERVER_UNIX 0x00000800
1433 #define SV_TYPE_NT 0x00001000
1434 #define SV_TYPE_WFW 0x00002000
1435 #define SV_TYPE_SERVER_MFPN 0x00004000
1436 #define SV_TYPE_SERVER_NT 0x00008000
1437 #define SV_TYPE_POTENTIAL_BROWSER 0x00010000
1438 #define SV_TYPE_BACKUP_BROWSER 0x00020000
1439 #define SV_TYPE_MASTER_BROWSER 0x00040000
1440 #define SV_TYPE_DOMAIN_MASTER 0x00080000
1441 #define SV_TYPE_SERVER_OSF 0x00100000
1442 #define SV_TYPE_SERVER_VMS 0x00200000
1443 #define SV_TYPE_WIN95_PLUS 0x00400000
1444 #define SV_TYPE_ALTERNATE_XPORT 0x20000000
1445 #define SV_TYPE_LOCAL_LIST_ONLY 0x40000000
1446 #define SV_TYPE_DOMAIN_ENUM 0x80000000
1447 #define SV_TYPE_ALL 0xFFFFFFFF
1449 /* what server type are we currently - JHT Says we ARE 4.20 */
1450 /* this was set by JHT in liaison with Jeremy Allison early 1997 */
1451 /* setting to 4.20 at same time as announcing ourselves as NT Server */
1452 /* History: */
1453 /* Version 4.0 - never made public */
1454 /* Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9 */
1455 /* - Reappeared in 1.9.16p11 with fixed smbd services */
1456 /* Version 4.20 - To indicate that nmbd and browsing now works better */
1458 #define DEFAULT_MAJOR_VERSION 0x04
1459 #define DEFAULT_MINOR_VERSION 0x02
1461 /* Browser Election Values */
1462 #define BROWSER_ELECTION_VERSION 0x010f
1463 #define BROWSER_CONSTANT 0xaa55
1465 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1467 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1468 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1469 #define FLAGS2_DFS_PATHNAMES 0x1000
1470 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1471 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1472 #define FLAGS2_UNICODE_STRINGS 0x8000
1474 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1476 #define CAP_RAW_MODE 0x0001
1477 #define CAP_MPX_MODE 0x0002
1478 #define CAP_UNICODE 0x0004
1479 #define CAP_LARGE_FILES 0x0008
1480 #define CAP_NT_SMBS 0x0010
1481 #define CAP_RPC_REMOTE_APIS 0x0020
1482 #define CAP_STATUS32 0x0040
1483 #define CAP_LEVEL_II_OPLOCKS 0x0080
1484 #define CAP_LOCK_AND_READ 0x0100
1485 #define CAP_NT_FIND 0x0200
1486 #define CAP_DFS 0x1000
1487 #define CAP_LARGE_READX 0x4000
1489 /* protocol types. It assumes that higher protocols include lower protocols
1490 as subsets */
1491 enum protocol_types
1492 { PROTOCOL_NONE, PROTOCOL_CORE, PROTOCOL_COREPLUS, PROTOCOL_LANMAN1, PROTOCOL_LANMAN2,
1493 PROTOCOL_NT1
1496 /* security levels */
1497 enum security_types
1498 { SEC_SHARE, SEC_USER, SEC_SERVER, SEC_DOMAIN };
1500 /* printing types */
1501 enum printing_types
1502 { PRINT_BSD, PRINT_SYSV, PRINT_AIX, PRINT_HPUX,
1503 PRINT_QNX, PRINT_PLP, PRINT_LPRNG, PRINT_SOFTQ
1506 /* Remote architectures we know about. */
1507 enum remote_arch_types
1508 { RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_SAMBA };
1510 /* case handling */
1511 enum case_handling
1512 { CASE_LOWER, CASE_UPPER };
1514 #ifdef WITH_SSL
1515 /* SSL version options */
1516 enum ssl_version_enum
1517 { SMB_SSL_V2, SMB_SSL_V3, SMB_SSL_V23, SMB_SSL_TLS1 };
1518 #endif /* WITH_SSL */
1520 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
1521 structures. We cannot define these as actual structures
1522 due to possible differences in structure packing
1523 on different machines/compilers. */
1525 #define SMB_LPID_OFFSET(indx) (10 * (indx))
1526 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
1527 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
1528 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
1529 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
1530 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
1531 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
1533 /* Macro to cache an error in a write_bmpx_struct */
1534 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
1535 w->wr_discard = True, -1)
1536 /* Macro to test if an error has been cached for this fnum */
1537 #define HAS_CACHED_ERROR(fsp) ((fsp)->open && (fsp)->wbmpx_ptr && \
1538 (fsp)->wbmpx_ptr->wr_discard)
1539 /* Macro to turn the cached error into an error packet */
1540 #define CACHED_ERROR(fsp) cached_error_packet(inbuf,outbuf,fsp,__LINE__)
1542 /* these are the datagram types */
1543 #define DGRAM_DIRECT_UNIQUE 0x10
1545 #define ERROR(class,x) error_packet(inbuf,outbuf,class,x,__LINE__)
1547 /* this is how errors are generated */
1548 #define UNIXERROR(defclass,deferror) unix_error_packet(inbuf,outbuf,defclass,deferror,__LINE__)
1550 #define SMB_ROUNDUP(x,g) (((x)+((g)-1))&~((g)-1))
1553 * Global value meaing that the smb_uid field should be
1554 * ingored (in share level security and protocol level == CORE)
1557 #define UID_FIELD_INVALID 0
1558 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1560 /* Defines needed for multi-codepage support. */
1561 #define MSDOS_LATIN_1_CODEPAGE 850
1562 #define KANJI_CODEPAGE 932
1563 #define HANGUL_CODEPAGE 949
1564 #define BIG5_CODEPAGE 950
1565 #define SIMPLIFIED_CHINESE_CODEPAGE 936
1567 #ifdef KANJI
1569 * Default client code page - Japanese
1571 #define DEFAULT_CLIENT_CODE_PAGE KANJI_CODEPAGE
1572 #else /* KANJI */
1574 * Default client code page - 850 - Western European
1576 #define DEFAULT_CLIENT_CODE_PAGE MSDOS_LATIN_1_CODEPAGE
1577 #endif /* KANJI */
1580 * Size of buffer to use when moving files across filesystems.
1582 #define COPYBUF_SIZE (8*1024)
1585 * Integers used to override error codes.
1587 extern int unix_ERR_class;
1588 extern int unix_ERR_code;
1591 * Map the Core and Extended Oplock requesst bits down
1592 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1596 * Core protocol.
1598 #define CORE_OPLOCK_REQUEST(inbuf) \
1599 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1602 * Extended protocol.
1604 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1606 /* Lock types. */
1607 #define LOCKING_ANDX_SHARED_LOCK 0x1
1608 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1609 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1610 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1611 #define LOCKING_ANDX_LARGE_FILES 0x10
1613 /* Oplock levels */
1614 #define OPLOCKLEVEL_NONE 0
1615 #define OPLOCKLEVEL_II 1
1618 * Bits we test with.
1620 #define EXCLUSIVE_OPLOCK 1
1621 #define BATCH_OPLOCK 2
1623 #define CORE_OPLOCK_GRANTED (1<<5)
1624 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1627 * Loopback command offsets.
1630 #define OPBRK_CMD_LEN_OFFSET 0
1631 #define OPBRK_CMD_PORT_OFFSET 4
1632 #define OPBRK_CMD_HEADER_LEN 6
1634 #define OPBRK_MESSAGE_CMD_OFFSET 0
1637 * Oplock break command code to send over the udp socket.
1639 * Form of this is :
1641 * 0 2 6 10 14 14+devsize 14+devsize+inodesize
1642 * +----+--------+--------+--------+-------+--------+
1643 * | cmd| pid | sec | usec | dev | inode |
1644 * +----+--------+--------+--------+-------+--------+
1647 #define OPLOCK_BREAK_CMD 0x1
1648 #define OPLOCK_BREAK_PID_OFFSET 2
1649 #define OPLOCK_BREAK_SEC_OFFSET 6
1650 #define OPLOCK_BREAK_USEC_OFFSET 10
1651 #define OPLOCK_BREAK_DEV_OFFSET 14
1652 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1653 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1656 * Capabilities abstracted for different systems.
1659 #define KERNEL_OPLOCK_CAPABILITY 0x1
1661 #if defined(HAVE_KERNEL_OPLOCKS)
1663 * Oplock break command code sent via the kernel interface.
1665 * Form of this is :
1667 * 0 2 2+devsize 2+devsize+inodesize
1668 * +----+--------+--------+
1669 * | cmd| dev | inode |
1670 * +----+--------+--------+
1673 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1674 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1675 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1676 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1678 #endif /* HAVE_KERNEL_OPLOCKS */
1680 #define CMD_REPLY 0x8000
1682 /* useful macros */
1684 /* zero a structure */
1685 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
1687 /* zero a structure given a pointer to the structure - no zero check */
1688 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
1690 /* zero a structure given a pointer to the structure */
1691 #define ZERO_STRUCTP(x) { if ((x) != NULL) ZERO_STRUCTPN(x); }
1693 /* zero an array - note that sizeof(array) must work - ie. it must not be a
1694 pointer */
1695 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
1697 #define SMB_ASSERT(b) ((b)?(void)0: \
1698 (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
1699 __FILE__, __LINE__)), smb_panic("assert failed")))
1700 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
1702 /* A netbios name structure. */
1703 struct nmb_name
1705 char name[17];
1706 char scope[64];
1707 unsigned int name_type;
1710 #include "client.h"
1713 * Size of new password account encoding string. DO NOT CHANGE.
1716 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1719 Do you want session setups at user level security with a invalid
1720 password to be rejected or allowed in as guest? WinNT rejects them
1721 but it can be a pain as it means "net view" needs to use a password
1723 You have 3 choices in the setting of map_to_guest:
1725 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1726 are rejected. This is the default.
1728 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1729 are rejected, unless the username does not exist, in which case it
1730 is treated as a guest login
1732 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1733 are treated as a guest login
1735 Note that map_to_guest only has an effect in user or server
1736 level security.
1739 #define NEVER_MAP_TO_GUEST 0
1740 #define MAP_TO_GUEST_ON_BAD_USER 1
1741 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1743 #endif /* _SMB_H */
1745 /* _SMB_H */