Large commit which restructures the local password storage API.
[Samba.git] / source / include / smb.h
blob57a62b7f1f0ec8e5045bb49e9569078e780d69e5
1 /*
2 Unix SMB/Netbios implementation.
3 Version 1.9.
4 SMB parameters and setup
5 Copyright (C) Andrew Tridgell 1992-2000
6 Copyright (C) John H Terpstra 1996-2000
7 Copyright (C) Luke Kenneth Casson Leighton 1996-2000
8 Copyright (C) Paul Ashton 1998-2000
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.
25 #ifndef _SMB_H
26 #define _SMB_H
28 #define BUFFER_SIZE (0xFFFF)
29 #define SAFETY_MARGIN 1024
31 #define NMB_PORT 137
32 #define DGRAM_PORT 138
33 #define SMB_PORT 139
35 #define False (0)
36 #define True (1)
37 #define Auto (2)
39 typedef unsigned char BYTE;
41 #ifndef _BOOL
42 typedef int BOOL;
43 #define _BOOL /* So we don't typedef BOOL again in vfs.h */
44 #endif
46 /* limiting size of ipc replies */
47 #define REALLOC(ptr,size) Realloc(ptr,MAX((size),4*1024))
49 #define SIZEOFWORD 2
51 #ifndef DEF_CREATE_MASK
52 #define DEF_CREATE_MASK (0755)
53 #endif
55 /* how long to wait for secondary SMB packets (milli-seconds) */
56 #define SMB_SECONDARY_WAIT (60*1000)
58 /* Debugging stuff */
59 #include "debug.h"
61 /* this defines the error codes that receive_smb can put in smb_read_error */
62 #define READ_TIMEOUT 1
63 #define READ_EOF 2
64 #define READ_ERROR 3
67 #define DIR_STRUCT_SIZE 43
69 /* these define all the command types recognised by the server - there
70 are lots of gaps so probably there are some rare commands that are not
71 implemented */
73 #define pSETDIR '\377'
75 /* these define the attribute byte as seen by DOS */
76 #define aRONLY (1L<<0)
77 #define aHIDDEN (1L<<1)
78 #define aSYSTEM (1L<<2)
79 #define aVOLID (1L<<3)
80 #define aDIR (1L<<4)
81 #define aARCH (1L<<5)
83 /* deny modes */
84 #define DENY_DOS 0
85 #define DENY_ALL 1
86 #define DENY_WRITE 2
87 #define DENY_READ 3
88 #define DENY_NONE 4
89 #define DENY_FCB 7
91 /* open modes */
92 #define DOS_OPEN_RDONLY 0
93 #define DOS_OPEN_WRONLY 1
94 #define DOS_OPEN_RDWR 2
95 #define DOS_OPEN_FCB 0xF
97 /* define shifts and masks for share and open modes. */
98 #define OPEN_MODE_MASK 0xF
99 #define SHARE_MODE_SHIFT 4
100 #define SHARE_MODE_MASK 0x7
101 #define GET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
102 #define SET_OPEN_MODE(x) ((x) & OPEN_MODE_MASK)
103 #define GET_DENY_MODE(x) (((x)>>SHARE_MODE_SHIFT) & SHARE_MODE_MASK)
104 #define SET_DENY_MODE(x) ((x)<<SHARE_MODE_SHIFT)
106 /* Sync on open file (not sure if used anymore... ?) */
107 #define FILE_SYNC_OPENMODE (1<<14)
108 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
110 /* allow delete on open file mode (used by NT SMB's). */
111 #define ALLOW_SHARE_DELETE (1<<15)
112 #define GET_ALLOW_SHARE_DELETE(x) (((x) & ALLOW_SHARE_DELETE) ? True : False)
113 #define SET_ALLOW_SHARE_DELETE(x) ((x) ? ALLOW_SHARE_DELETE : 0)
115 /* delete on close flag (used by NT SMB's). */
116 #define DELETE_ON_CLOSE_FLAG (1<<16)
117 #define GET_DELETE_ON_CLOSE_FLAG(x) (((x) & DELETE_ON_CLOSE_FLAG) ? True : False)
118 #define SET_DELETE_ON_CLOSE_FLAG(x) ((x) ? DELETE_ON_CLOSE_FLAG : 0)
120 /* open disposition values */
121 #define FILE_EXISTS_FAIL 0
122 #define FILE_EXISTS_OPEN 1
123 #define FILE_EXISTS_TRUNCATE 2
125 /* mask for open disposition. */
126 #define FILE_OPEN_MASK 0x3
128 #define GET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
129 #define SET_FILE_OPEN_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
131 /* The above can be OR'ed with... */
132 #define FILE_CREATE_IF_NOT_EXIST 0x10
133 #define FILE_FAIL_IF_NOT_EXIST 0
135 #define GET_FILE_CREATE_DISPOSITION(x) ((x) & (FILE_CREATE_IF_NOT_EXIST|FILE_FAIL_IF_NOT_EXIST))
137 /* share types */
138 #define STYPE_DISKTREE 0 /* Disk drive */
139 #define STYPE_PRINTQ 1 /* Spooler queue */
140 #define STYPE_DEVICE 2 /* Serial device */
141 #define STYPE_IPC 3 /* Interprocess communication (IPC) */
142 #define STYPE_HIDDEN 0x80000000 /* share is a hidden one (ends with $) */
144 /* SMB X/Open error codes for the ERRDOS error class */
145 #define ERRbadfunc 1 /* Invalid function (or system call) */
146 #define ERRbadfile 2 /* File not found (pathname error) */
147 #define ERRbadpath 3 /* Directory not found */
148 #define ERRnofids 4 /* Too many open files */
149 #define ERRnoaccess 5 /* Access denied */
150 #define ERRbadfid 6 /* Invalid fid */
151 #define ERRnomem 8 /* Out of memory */
152 #define ERRbadmem 9 /* Invalid memory block address */
153 #define ERRbadenv 10 /* Invalid environment */
154 #define ERRbadaccess 12 /* Invalid open mode */
155 #define ERRbaddata 13 /* Invalid data (only from ioctl call) */
156 #define ERRres 14 /* reserved */
157 #define ERRbaddrive 15 /* Invalid drive */
158 #define ERRremcd 16 /* Attempt to delete current directory */
159 #define ERRdiffdevice 17 /* rename/move across different filesystems */
160 #define ERRnofiles 18 /* no more files found in file search */
161 #define ERRbadshare 32 /* Share mode on file conflict with open mode */
162 #define ERRlock 33 /* Lock request conflicts with existing lock */
163 #define ERRunsup 50 /* Request unsupported, returned by Win 95, RJS 20Jun98 */
164 #define ERRnosuchshare 67 /* You specified an invalid share name */
165 #define ERRfilexists 80 /* File in operation already exists */
166 #define ERRcannotopen 110 /* Cannot open the file specified */
167 #define ERRunknownlevel 124
168 #define ERRrename 183
169 #define ERRbadpipe 230 /* Named pipe invalid */
170 #define ERRpipebusy 231 /* All instances of pipe are busy */
171 #define ERRpipeclosing 232 /* named pipe close in progress */
172 #define ERRnotconnected 233 /* No process on other end of named pipe */
173 #define ERRmoredata 234 /* More data to be returned */
174 #define ERRbaddirectory 267 /* Invalid directory name in a path. */
175 #define ERRunknownipc 2142
177 #define ERROR_INVALID_FUNCTION (1)
178 #define ERROR_ACCESS_DENIED (5)
179 #define ERROR_INVALID_HANDLE (6)
180 #define ERROR_NOT_ENOUGH_MEMORY (8)
181 #define ERROR_INVALID_PARAMETER (87)
182 #define ERROR_INSUFFICIENT_BUFFER (122)
183 #define ERROR_INVALID_NAME (123)
184 #define ERROR_INVALID_LEVEL (124)
185 #define ERROR_MORE_DATA (234)
186 #define ERROR_NO_MORE_ITEMS (259)
187 #define ERROR_EAS_DIDNT_FIT (275) /* Extended attributes didn't fit */
188 #define ERROR_EAS_NOT_SUPPORTED (282) /* Extended attributes not supported */
189 #define ERROR_NOTIFY_ENUM_DIR (1022) /* Buffer too small to return change notify. */
190 #define ERROR_UNKNOWN_PRINTER_DRIVER (1797)
191 #define ERROR_INVALID_PRINTER_NAME (1801)
192 #define ERROR_INVALID_DATATYPE (1804)
193 #define ERROR_INVALID_ENVIRONMENT (1805)
195 /* here's a special one from observing NT */
196 #define ERRnoipc 66 /* don't support ipc */
198 /* Error codes for the ERRSRV class */
200 #define ERRerror 1 /* Non specific error code */
201 #define ERRbadpw 2 /* Bad password */
202 #define ERRbadtype 3 /* reserved */
203 #define ERRaccess 4 /* No permissions to do the requested operation */
204 #define ERRinvnid 5 /* tid invalid */
205 #define ERRinvnetname 6 /* Invalid servername */
206 #define ERRinvdevice 7 /* Invalid device */
207 #define ERRqfull 49 /* Print queue full */
208 #define ERRqtoobig 50 /* Queued item too big */
209 #define ERRinvpfid 52 /* Invalid print file in smb_fid */
210 #define ERRsmbcmd 64 /* Unrecognised command */
211 #define ERRsrverror 65 /* smb server internal error */
212 #define ERRfilespecs 67 /* fid and pathname invalid combination */
213 #define ERRbadlink 68 /* reserved */
214 #define ERRbadpermits 69 /* Access specified for a file is not valid */
215 #define ERRbadpid 70 /* reserved */
216 #define ERRsetattrmode 71 /* attribute mode invalid */
217 #define ERRpaused 81 /* Message server paused */
218 #define ERRmsgoff 82 /* Not receiving messages */
219 #define ERRnoroom 83 /* No room for message */
220 #define ERRrmuns 87 /* too many remote usernames */
221 #define ERRtimeout 88 /* operation timed out */
222 #define ERRnoresource 89 /* No resources currently available for request. */
223 #define ERRtoomanyuids 90 /* too many userids */
224 #define ERRbaduid 91 /* bad userid */
225 #define ERRuseMPX 250 /* temporarily unable to use raw mode, use MPX mode */
226 #define ERRuseSTD 251 /* temporarily unable to use raw mode, use standard mode */
227 #define ERRcontMPX 252 /* resume MPX mode */
228 #define ERRbadPW /* reserved */
229 #define ERRnosupport 0xFFFF
230 #define ERRunknownsmb 22 /* from NT 3.5 response */
233 /* Error codes for the ERRHRD class */
235 #define ERRnowrite 19 /* read only media */
236 #define ERRbadunit 20 /* Unknown device */
237 #define ERRnotready 21 /* Drive not ready */
238 #define ERRbadcmd 22 /* Unknown command */
239 #define ERRdata 23 /* Data (CRC) error */
240 #define ERRbadreq 24 /* Bad request structure length */
241 #define ERRseek 25
242 #define ERRbadmedia 26
243 #define ERRbadsector 27
244 #define ERRnopaper 28
245 #define ERRwrite 29 /* write fault */
246 #define ERRread 30 /* read fault */
247 #define ERRgeneral 31 /* General hardware failure */
248 #define ERRwrongdisk 34
249 #define ERRFCBunavail 35
250 #define ERRsharebufexc 36 /* share buffer exceeded */
251 #define ERRdiskfull 39
253 #ifndef _PSTRING
255 #define PSTRING_LEN 1024
256 #define FSTRING_LEN 128
258 typedef char pstring[PSTRING_LEN];
259 typedef char fstring[FSTRING_LEN];
261 #define _PSTRING
263 #endif
266 * SMB UCS2 (16-bit unicode) internal type.
269 typedef uint16 smb_ucs2_t;
271 /* ucs2 string types. */
272 typedef smb_ucs2_t wpstring[1024];
273 typedef smb_ucs2_t wfstring[128];
275 /* pipe string names */
276 #define PIPE_LANMAN "\\PIPE\\LANMAN"
277 #define PIPE_SRVSVC "\\PIPE\\srvsvc"
278 #define PIPE_SAMR "\\PIPE\\samr"
279 #define PIPE_WINREG "\\PIPE\\winreg"
280 #define PIPE_WKSSVC "\\PIPE\\wkssvc"
281 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
282 #define PIPE_NTLSA "\\PIPE\\ntlsa"
283 #define PIPE_NTSVCS "\\PIPE\\ntsvcs"
284 #define PIPE_LSASS "\\PIPE\\lsass"
285 #define PIPE_LSARPC "\\PIPE\\lsarpc"
286 #define PIPE_SPOOLSS "\\PIPE\\spoolss"
287 #define PIPE_NETDFS "\\PIPE\\netdfs"
289 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
290 typedef struct nttime_info
292 uint32 low;
293 uint32 high;
295 } NTTIME;
297 /* Allowable account control bits */
298 #define ACB_DISABLED 0x0001 /* 1 = User account disabled */
299 #define ACB_HOMDIRREQ 0x0002 /* 1 = Home directory required */
300 #define ACB_PWNOTREQ 0x0004 /* 1 = User password not required */
301 #define ACB_TEMPDUP 0x0008 /* 1 = Temporary duplicate account */
302 #define ACB_NORMAL 0x0010 /* 1 = Normal user account */
303 #define ACB_MNS 0x0020 /* 1 = MNS logon user account */
304 #define ACB_DOMTRUST 0x0040 /* 1 = Interdomain trust account */
305 #define ACB_WSTRUST 0x0080 /* 1 = Workstation trust account */
306 #define ACB_SVRTRUST 0x0100 /* 1 = Server trust account */
307 #define ACB_PWNOEXP 0x0200 /* 1 = User password does not expire */
308 #define ACB_AUTOLOCK 0x0400 /* 1 = Account auto locked */
310 #define MAX_HOURS_LEN 32
312 struct sam_disp_info
314 uint32 user_rid; /* Primary User ID */
315 char *smb_name; /* username string */
316 char *full_name; /* user's full name string */
319 typedef struct
321 uint32 pid;
322 uint16 vuid;
325 vuser_key;
328 struct use_info
330 BOOL connected;
331 char *srv_name;
332 vuser_key key;
333 char *user_name;
334 char *domain;
337 #ifndef MAXSUBAUTHS
338 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
339 #endif
341 #ifndef _DOM_SID
342 /* DOM_SID - security id */
343 typedef struct sid_info
345 uint8 sid_rev_num; /* SID revision number */
346 uint8 num_auths; /* number of sub-authorities */
347 uint8 id_auth[6]; /* Identifier Authority */
349 * Note that the values in these uint32's are in *native* byteorder,
350 * not neccessarily little-endian...... JRA.
352 uint32 sub_auths[MAXSUBAUTHS]; /* pointer to sub-authorities. */
354 } DOM_SID;
355 #define _DOM_SID
356 #endif
359 * The complete list of SIDS belonging to this user.
360 * Created when a vuid is registered.
361 * The definition of the user_sids array is as follows :
363 * token->user_sids[0] = primary user SID.
364 * token->user_sids[1] = primary group SID.
365 * token->user_sids[2-num_sids] = supplementary group SIDS.
368 #ifndef _NT_USER_TOKEN
369 typedef struct _nt_user_token {
370 size_t num_sids;
371 DOM_SID *user_sids;
372 } NT_USER_TOKEN;
373 #define _NT_USER_TOKEN
374 #endif
376 /*** query a local group, get a list of these: shows who is in that group ***/
378 /* local group member info */
379 typedef struct local_grp_member_info
381 DOM_SID sid ; /* matches with name */
382 uint8 sid_use; /* usr=1 grp=2 dom=3 alias=4 wkng=5 del=6 inv=7 unk=8 */
383 fstring name ; /* matches with sid: must be of the form "DOMAIN\account" */
385 } LOCAL_GRP_MEMBER;
387 /* enumerate these to get list of local groups */
389 /* local group info */
390 typedef struct local_grp_info
392 fstring name;
393 fstring comment;
395 } LOCAL_GRP;
397 /*** enumerate these to get list of domain groups ***/
399 /* domain group member info */
400 typedef struct domain_grp_info
402 fstring name;
403 fstring comment;
404 uint32 rid; /* group rid */
405 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
407 } DOMAIN_GRP;
409 /*** query a domain group, get a list of these: shows who is in that group ***/
411 /* domain group info */
412 typedef struct domain_grp_member_info
414 fstring name;
415 uint8 attr; /* attributes forced to be set to 0x7: SE_GROUP_xxx */
417 } DOMAIN_GRP_MEMBER;
419 /* DOM_CHAL - challenge info */
420 typedef struct chal_info
422 uchar data[8]; /* credentials */
423 } DOM_CHAL;
425 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
426 typedef struct time_info
428 uint32 time;
429 } UTIME;
431 /* DOM_CREDs - timestamped client or server credentials */
432 typedef struct cred_info
434 DOM_CHAL challenge; /* credentials */
435 UTIME timestamp; /* credential time-stamp */
436 } DOM_CRED;
438 /* Structure used when SMBwritebmpx is active */
439 typedef struct
441 size_t wr_total_written; /* So we know when to discard this */
442 int32 wr_timeout;
443 int32 wr_errclass;
444 int32 wr_error; /* Cached errors */
445 BOOL wr_mode; /* write through mode) */
446 BOOL wr_discard; /* discard all further data */
447 } write_bmpx_struct;
449 typedef struct write_cache
451 SMB_OFF_T file_size;
452 SMB_OFF_T offset;
453 size_t alloc_size;
454 size_t data_size;
455 char *data;
456 } write_cache;
458 typedef struct files_struct
460 struct files_struct *next, *prev;
461 int fnum;
462 struct connection_struct *conn;
463 int fd;
464 int print_jobid;
465 SMB_DEV_T dev;
466 SMB_INO_T inode;
467 BOOL delete_on_close;
468 SMB_OFF_T pos;
469 SMB_OFF_T size;
470 mode_t mode;
471 uint16 vuid;
472 write_bmpx_struct *wbmpx_ptr;
473 write_cache *wcp;
474 struct timeval open_time;
475 int share_mode;
476 time_t pending_modtime;
477 int oplock_type;
478 int sent_oplock_break;
479 BOOL can_lock;
480 BOOL can_read;
481 BOOL can_write;
482 BOOL print_file;
483 BOOL modified;
484 BOOL is_directory;
485 BOOL directory_delete_on_close;
486 BOOL stat_open;
487 char *fsp_name;
488 } files_struct;
491 * Structure used to keep directory state information around.
492 * Used in NT change-notify code.
495 typedef struct
497 time_t modify_time;
498 time_t status_time;
499 } dir_status_struct;
501 struct uid_cache {
502 int entries;
503 uid_t list[UID_CACHE_SIZE];
506 typedef struct
508 char *name;
509 BOOL is_wild;
510 } name_compare_entry;
512 /* Include VFS stuff */
514 #include "vfs.h"
516 typedef struct connection_struct
518 struct connection_struct *next, *prev;
519 unsigned cnum; /* an index passed over the wire */
520 int service;
521 BOOL force_user;
522 struct uid_cache uid_cache;
523 void *dirptr;
524 BOOL printer;
525 BOOL ipc;
526 BOOL read_only;
527 BOOL admin_user;
528 char *dirpath;
529 char *connectpath;
530 char *origpath;
532 struct vfs_ops vfs_ops; /* Filesystem operations */
533 /* Handle on dlopen() call */
534 void *dl_handle;
536 char *user; /* name of user who *opened* this connection */
537 uid_t uid; /* uid of user who *opened* this connection */
538 gid_t gid; /* gid of user who *opened* this connection */
539 char client_address[18]; /* String version of client IP address. */
541 uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
543 /* following groups stuff added by ih */
545 /* This groups info is valid for the user that *opened* the connection */
546 int ngroups;
547 gid_t *groups;
548 NT_USER_TOKEN *nt_user_token;
550 time_t lastused;
551 BOOL used;
552 int num_files_open;
553 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
554 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
555 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
557 } connection_struct;
559 struct current_user
561 connection_struct *conn;
562 uint16 vuid;
563 uid_t uid;
564 gid_t gid;
565 int ngroups;
566 gid_t *groups;
567 NT_USER_TOKEN *nt_user_token;
570 /* Defines for the sent_oplock_break field above. */
571 #define NO_BREAK_SENT 0
572 #define EXCLUSIVE_BREAK_SENT 1
573 #define LEVEL_II_BREAK_SENT 2
575 /* Domain controller authentication protocol info */
576 struct dcinfo
578 DOM_CHAL clnt_chal; /* Initial challenge received from client */
579 DOM_CHAL srv_chal; /* Initial server challenge */
580 DOM_CRED clnt_cred; /* Last client credential */
581 DOM_CRED srv_cred; /* Last server credential */
583 uchar sess_key[8]; /* Session key */
584 uchar md4pw[16]; /* md4(machine password) */
588 typedef struct {
589 fstring smb_name; /* user name from the client */
590 fstring unix_name; /* unix user name of a validated user */
591 fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
592 fstring domain; /* domain that the client specified */
593 } userdom_struct;
595 enum {LPQ_QUEUED,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING};
597 typedef struct _print_queue_struct
599 int job;
600 int size;
601 int status;
602 int priority;
603 time_t time;
604 fstring user;
605 fstring file;
606 } print_queue_struct;
608 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
610 typedef struct
612 fstring message;
613 int qcount;
614 int status;
615 } print_status_struct;
617 /* used for server information: client, nameserv and ipc */
618 struct server_info_struct
620 fstring name;
621 uint32 type;
622 fstring comment;
623 fstring domain; /* used ONLY in ipc.c NOT namework.c */
624 BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
628 /* used for network interfaces */
629 struct interface
631 struct interface *next, *prev;
632 struct in_addr ip;
633 struct in_addr bcast;
634 struct in_addr nmask;
637 /* struct returned by get_share_modes */
638 typedef struct
640 pid_t pid;
641 uint16 op_port;
642 uint16 op_type;
643 int share_mode;
644 struct timeval time;
645 } share_mode_entry;
648 #define SHAREMODE_FN_CAST() \
649 void (*)(share_mode_entry *, char*)
651 #define SHAREMODE_FN(fn) \
652 void (*fn)(share_mode_entry *, char*)
654 typedef struct sam_passwd
656 time_t logon_time; /* logon time */
657 time_t logoff_time; /* logoff time */
658 time_t kickoff_time; /* kickoff time */
659 time_t pass_last_set_time; /* password last set time */
660 time_t pass_can_change_time; /* password can change time */
661 time_t pass_must_change_time; /* password must change time */
663 char *username; /* UNIX username string */
664 char *domain; /* Windows Domain name */
665 char *nt_username; /* Windows username string */
666 char *full_name; /* user's full name string */
667 char *home_dir; /* home directory string */
668 char *dir_drive; /* home directory drive string */
669 char *logon_script; /* logon script string */
670 char *profile_path; /* profile path string */
671 char *acct_desc ; /* user description string */
672 char *workstations; /* login from workstations string */
673 char *unknown_str ; /* don't know what this is, yet. */
674 char *munged_dial ; /* munged path name and dial-back tel number */
676 uid_t uid; /* this is actually the unix uid_t */
677 gid_t gid; /* this is actually the unix gid_t */
678 uint32 user_rid; /* Primary User ID */
679 uint32 group_rid; /* Primary Group ID */
681 unsigned char *lm_pw; /* Null if no password */
682 unsigned char *nt_pw; /* Null if no password */
684 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
685 uint32 unknown_3; /* 0x00ff ffff */
687 uint16 logon_divs; /* 168 - number of hours in a week */
688 uint32 hours_len; /* normally 21 bytes */
689 uint8 hours[MAX_HOURS_LEN];
691 uint32 unknown_5; /* 0x0002 0000 */
692 uint32 unknown_6; /* 0x0000 04ec */
694 } SAM_ACCOUNT;
696 #if 0 /* GWC */
698 * Each implementation of the password database code needs
699 * to support the following operations.
702 struct passdb_ops {
704 * Password database ops.
706 void *(*startsmbpwent)(BOOL);
707 void (*endsmbpwent)(void *);
708 SMB_BIG_UINT (*getsmbpwpos)(void *);
709 BOOL (*setsmbpwpos)(void *, SMB_BIG_UINT);
712 * smb password database query functions.
714 struct smb_passwd *(*getsmbpwnam)(char *);
715 struct smb_passwd *(*getsmbpwuid)(uid_t);
716 struct smb_passwd *(*getsmbpwrid)(uint32);
717 struct smb_passwd *(*getsmbpwent)(void *);
720 * smb password database modification functions.
722 BOOL (*add_smbpwd_entry)(struct smb_passwd *);
723 BOOL (*mod_smbpwd_entry)(struct smb_passwd *, BOOL);
724 BOOL (*del_smbpwd_entry)(const char *);
727 * Functions that manupulate a struct sam_passwd.
729 struct sam_passwd *(*getsam21pwent)(void *);
732 * sam password database query functions.
734 struct sam_passwd *(*getsam21pwnam)(char *);
735 struct sam_passwd *(*getsam21pwuid)(uid_t);
736 struct sam_passwd *(*getsam21pwrid)(uint32);
739 * sam password database modification functions.
741 BOOL (*add_sam21pwd_entry)(struct sam_passwd *);
742 BOOL (*mod_sam21pwd_entry)(struct sam_passwd *, BOOL);
745 * sam query display info functions.
747 struct sam_disp_info *(*getsamdispnam)(char *);
748 struct sam_disp_info *(*getsamdisprid)(uint32);
749 struct sam_disp_info *(*getsamdispent)(void *);
752 * password checking functions
754 struct smb_passwd *(*smb_password_chal )(char *username, char lm_pass[24], char nt_pass[24], char chal[8]);
755 struct smb_passwd *(*smb_password_check )(char *username, char lm_hash[16], char nt_hash[16]);
756 struct passwd *(*unix_password_check)(char *username, char *pass, int pass_len);
759 #endif /* 0 */
762 * Flags for local user manipulation.
765 #define LOCAL_ADD_USER 0x1
766 #define LOCAL_DELETE_USER 0x2
767 #define LOCAL_DISABLE_USER 0x4
768 #define LOCAL_ENABLE_USER 0x8
769 #define LOCAL_TRUST_ACCOUNT 0x10
770 #define LOCAL_SET_NO_PASSWORD 0x20
772 /* key and data in the connections database - used in smbstatus and smbd */
773 struct connections_key {
774 pid_t pid;
775 int cnum;
776 fstring name;
779 struct connections_data {
780 int magic;
781 pid_t pid;
782 int cnum;
783 uid_t uid;
784 gid_t gid;
785 char name[24];
786 char addr[24];
787 char machine[128];
788 time_t start;
792 /* key and data records in the tdb locking database */
793 struct locking_key {
794 SMB_DEV_T dev;
795 SMB_INO_T inode;
798 struct locking_data {
799 int num_share_mode_entries;
800 /* the following two entries are implicit
801 share_mode_entry modes[num_share_mode_entries];
802 char file_name[];
807 /* the following are used by loadparm for option lists */
808 typedef enum
810 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
811 P_STRING,P_USTRING,P_GSTRING,P_UGSTRING,P_ENUM,P_SEP
812 } parm_type;
814 typedef enum
816 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
817 } parm_class;
819 /* passed to br lock code */
820 enum brl_type {READ_LOCK, WRITE_LOCK};
822 struct enum_list {
823 int value;
824 char *name;
827 #define BRLOCK_FN_CAST() \
828 void (*)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
829 enum brl_type lock_type, \
830 br_off start, br_off size)
831 #define BRLOCK_FN(fn) \
832 void (*fn)(SMB_DEV_T dev, SMB_INO_T ino, int pid, \
833 enum brl_type lock_type, \
834 br_off start, br_off size)
835 struct parm_struct
837 char *label;
838 parm_type type;
839 parm_class class;
840 void *ptr;
841 BOOL (*special)(char *, char **);
842 struct enum_list *enum_list;
843 unsigned flags;
844 union {
845 BOOL bvalue;
846 int ivalue;
847 char *svalue;
848 char cvalue;
849 } def;
852 struct bitmap {
853 uint32 *b;
854 int n;
857 #define FLAG_BASIC 0x01 /* fundamental options */
858 #define FLAG_SHARE 0x02 /* file sharing options */
859 #define FLAG_PRINT 0x04 /* printing options */
860 #define FLAG_GLOBAL 0x08 /* local options that should be globally settable in SWAT */
861 #define FLAG_DEPRECATED 0x10 /* options that should no longer be used */
862 #define FLAG_HIDE 0x20 /* options that should be hidden in SWAT */
863 #define FLAG_DOS_STRING 0x40 /* convert from UNIX to DOS codepage when reading this string. */
865 #ifndef LOCKING_VERSION
866 #define LOCKING_VERSION 4
867 #endif /* LOCKING_VERSION */
870 /* the basic packet size, assuming no words or bytes */
871 #define smb_size 39
873 /* offsets into message for common items */
874 #define smb_com 8
875 #define smb_rcls 9
876 #define smb_reh 10
877 #define smb_err 11
878 #define smb_flg 13
879 #define smb_flg2 14
880 #define smb_reb 13
881 #define smb_tid 28
882 #define smb_pid 30
883 #define smb_uid 32
884 #define smb_mid 34
885 #define smb_wct 36
886 #define smb_vwv 37
887 #define smb_vwv0 37
888 #define smb_vwv1 39
889 #define smb_vwv2 41
890 #define smb_vwv3 43
891 #define smb_vwv4 45
892 #define smb_vwv5 47
893 #define smb_vwv6 49
894 #define smb_vwv7 51
895 #define smb_vwv8 53
896 #define smb_vwv9 55
897 #define smb_vwv10 57
898 #define smb_vwv11 59
899 #define smb_vwv12 61
900 #define smb_vwv13 63
901 #define smb_vwv14 65
902 #define smb_vwv15 67
903 #define smb_vwv16 69
904 #define smb_vwv17 71
906 /* flag defines. CIFS spec 3.1.1 */
907 #define FLAG_SUPPORT_LOCKREAD 0x01
908 #define FLAG_CLIENT_BUF_AVAIL 0x02
909 #define FLAG_RESERVED 0x04
910 #define FLAG_CASELESS_PATHNAMES 0x08
911 #define FLAG_CANONICAL_PATHNAMES 0x10
912 #define FLAG_REQUEST_OPLOCK 0x20
913 #define FLAG_REQUEST_BATCH_OPLOCK 0x40
914 #define FLAG_REPLY 0x80
916 /* the complete */
917 #define SMBmkdir 0x00 /* create directory */
918 #define SMBrmdir 0x01 /* delete directory */
919 #define SMBopen 0x02 /* open file */
920 #define SMBcreate 0x03 /* create file */
921 #define SMBclose 0x04 /* close file */
922 #define SMBflush 0x05 /* flush file */
923 #define SMBunlink 0x06 /* delete file */
924 #define SMBmv 0x07 /* rename file */
925 #define SMBgetatr 0x08 /* get file attributes */
926 #define SMBsetatr 0x09 /* set file attributes */
927 #define SMBread 0x0A /* read from file */
928 #define SMBwrite 0x0B /* write to file */
929 #define SMBlock 0x0C /* lock byte range */
930 #define SMBunlock 0x0D /* unlock byte range */
931 #define SMBctemp 0x0E /* create temporary file */
932 #define SMBmknew 0x0F /* make new file */
933 #define SMBchkpth 0x10 /* check directory path */
934 #define SMBexit 0x11 /* process exit */
935 #define SMBlseek 0x12 /* seek */
936 #define SMBtcon 0x70 /* tree connect */
937 #define SMBtconX 0x75 /* tree connect and X*/
938 #define SMBtdis 0x71 /* tree disconnect */
939 #define SMBnegprot 0x72 /* negotiate protocol */
940 #define SMBdskattr 0x80 /* get disk attributes */
941 #define SMBsearch 0x81 /* search directory */
942 #define SMBsplopen 0xC0 /* open print spool file */
943 #define SMBsplwr 0xC1 /* write to print spool file */
944 #define SMBsplclose 0xC2 /* close print spool file */
945 #define SMBsplretq 0xC3 /* return print queue */
946 #define SMBsends 0xD0 /* send single block message */
947 #define SMBsendb 0xD1 /* send broadcast message */
948 #define SMBfwdname 0xD2 /* forward user name */
949 #define SMBcancelf 0xD3 /* cancel forward */
950 #define SMBgetmac 0xD4 /* get machine name */
951 #define SMBsendstrt 0xD5 /* send start of multi-block message */
952 #define SMBsendend 0xD6 /* send end of multi-block message */
953 #define SMBsendtxt 0xD7 /* send text of multi-block message */
955 /* Core+ protocol */
956 #define SMBlockread 0x13 /* Lock a range and read */
957 #define SMBwriteunlock 0x14 /* Unlock a range then write */
958 #define SMBreadbraw 0x1a /* read a block of data with no smb header */
959 #define SMBwritebraw 0x1d /* write a block of data with no smb header */
960 #define SMBwritec 0x20 /* secondary write request */
961 #define SMBwriteclose 0x2c /* write a file then close it */
963 /* dos extended protocol */
964 #define SMBreadBraw 0x1A /* read block raw */
965 #define SMBreadBmpx 0x1B /* read block multiplexed */
966 #define SMBreadBs 0x1C /* read block (secondary response) */
967 #define SMBwriteBraw 0x1D /* write block raw */
968 #define SMBwriteBmpx 0x1E /* write block multiplexed */
969 #define SMBwriteBs 0x1F /* write block (secondary request) */
970 #define SMBwriteC 0x20 /* write complete response */
971 #define SMBsetattrE 0x22 /* set file attributes expanded */
972 #define SMBgetattrE 0x23 /* get file attributes expanded */
973 #define SMBlockingX 0x24 /* lock/unlock byte ranges and X */
974 #define SMBtrans 0x25 /* transaction - name, bytes in/out */
975 #define SMBtranss 0x26 /* transaction (secondary request/response) */
976 #define SMBioctl 0x27 /* IOCTL */
977 #define SMBioctls 0x28 /* IOCTL (secondary request/response) */
978 #define SMBcopy 0x29 /* copy */
979 #define SMBmove 0x2A /* move */
980 #define SMBecho 0x2B /* echo */
981 #define SMBopenX 0x2D /* open and X */
982 #define SMBreadX 0x2E /* read and X */
983 #define SMBwriteX 0x2F /* write and X */
984 #define SMBsesssetupX 0x73 /* Session Set Up & X (including User Logon) */
985 #define SMBffirst 0x82 /* find first */
986 #define SMBfunique 0x83 /* find unique */
987 #define SMBfclose 0x84 /* find close */
988 #define SMBinvalid 0xFE /* invalid command */
990 /* Extended 2.0 protocol */
991 #define SMBtrans2 0x32 /* TRANS2 protocol set */
992 #define SMBtranss2 0x33 /* TRANS2 protocol set, secondary command */
993 #define SMBfindclose 0x34 /* Terminate a TRANSACT2_FINDFIRST */
994 #define SMBfindnclose 0x35 /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
995 #define SMBulogoffX 0x74 /* user logoff */
997 /* NT SMB extensions. */
998 #define SMBnttrans 0xA0 /* NT transact */
999 #define SMBnttranss 0xA1 /* NT transact secondary */
1000 #define SMBntcreateX 0xA2 /* NT create and X */
1001 #define SMBntcancel 0xA4 /* NT cancel */
1003 /* These are the TRANS2 sub commands */
1004 #define TRANSACT2_OPEN 0
1005 #define TRANSACT2_FINDFIRST 1
1006 #define TRANSACT2_FINDNEXT 2
1007 #define TRANSACT2_QFSINFO 3
1008 #define TRANSACT2_SETFSINFO 4
1009 #define TRANSACT2_QPATHINFO 5
1010 #define TRANSACT2_SETPATHINFO 6
1011 #define TRANSACT2_QFILEINFO 7
1012 #define TRANSACT2_SETFILEINFO 8
1013 #define TRANSACT2_FSCTL 9
1014 #define TRANSACT2_IOCTL 0xA
1015 #define TRANSACT2_FINDNOTIFYFIRST 0xB
1016 #define TRANSACT2_FINDNOTIFYNEXT 0xC
1017 #define TRANSACT2_MKDIR 0xD
1018 #define TRANSACT2_SESSION_SETUP 0xE
1019 #define TRANSACT2_GET_DFS_REFERRAL 0x10
1020 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
1022 /* These are the NT transact sub commands. */
1023 #define NT_TRANSACT_CREATE 1
1024 #define NT_TRANSACT_IOCTL 2
1025 #define NT_TRANSACT_SET_SECURITY_DESC 3
1026 #define NT_TRANSACT_NOTIFY_CHANGE 4
1027 #define NT_TRANSACT_RENAME 5
1028 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
1030 /* Relevant IOCTL codes */
1031 #define IOCTL_QUERY_JOB_INFO 0x530060
1033 /* these are the trans2 sub fields for primary requests */
1034 #define smb_tpscnt smb_vwv0
1035 #define smb_tdscnt smb_vwv1
1036 #define smb_mprcnt smb_vwv2
1037 #define smb_mdrcnt smb_vwv3
1038 #define smb_msrcnt smb_vwv4
1039 #define smb_flags smb_vwv5
1040 #define smb_timeout smb_vwv6
1041 #define smb_pscnt smb_vwv9
1042 #define smb_psoff smb_vwv10
1043 #define smb_dscnt smb_vwv11
1044 #define smb_dsoff smb_vwv12
1045 #define smb_suwcnt smb_vwv13
1046 #define smb_setup smb_vwv14
1047 #define smb_setup0 smb_setup
1048 #define smb_setup1 (smb_setup+2)
1049 #define smb_setup2 (smb_setup+4)
1051 /* these are for the secondary requests */
1052 #define smb_spscnt smb_vwv2
1053 #define smb_spsoff smb_vwv3
1054 #define smb_spsdisp smb_vwv4
1055 #define smb_sdscnt smb_vwv5
1056 #define smb_sdsoff smb_vwv6
1057 #define smb_sdsdisp smb_vwv7
1058 #define smb_sfid smb_vwv8
1060 /* and these for responses */
1061 #define smb_tprcnt smb_vwv0
1062 #define smb_tdrcnt smb_vwv1
1063 #define smb_prcnt smb_vwv3
1064 #define smb_proff smb_vwv4
1065 #define smb_prdisp smb_vwv5
1066 #define smb_drcnt smb_vwv6
1067 #define smb_droff smb_vwv7
1068 #define smb_drdisp smb_vwv8
1070 /* these are for the NT trans primary request. */
1071 #define smb_nt_MaxSetupCount smb_vwv0
1072 #define smb_nt_Flags (smb_vwv0 + 1)
1073 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1074 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1075 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1076 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1077 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1078 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1079 #define smb_nt_DataCount (smb_vwv0 + 27)
1080 #define smb_nt_DataOffset (smb_vwv0 + 31)
1081 #define smb_nt_SetupCount (smb_vwv0 + 35)
1082 #define smb_nt_Function (smb_vwv0 + 36)
1083 #define smb_nt_SetupStart (smb_vwv0 + 38)
1085 /* these are for the NT trans secondary request. */
1086 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1087 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1088 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1089 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1090 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1091 #define smb_nts_DataCount (smb_vwv0 + 23)
1092 #define smb_nts_DataOffset (smb_vwv0 + 27)
1093 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1095 /* these are for the NT trans reply. */
1096 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1097 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1098 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1099 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1100 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1101 #define smb_ntr_DataCount (smb_vwv0 + 23)
1102 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1103 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1105 /* these are for the NT create_and_X */
1106 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1107 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1108 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1109 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1110 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1111 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1112 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1113 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1114 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1115 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1116 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1118 /* this is used on a TConX. I'm not sure the name is very helpful though */
1119 #define SMB_SUPPORT_SEARCH_BITS 0x0001
1120 #define SMB_SHARE_IN_DFS 0x0002
1122 /* Named pipe write mode flags. Used in writeX calls. */
1123 #define PIPE_RAW_MODE 0x4
1124 #define PIPE_START_MESSAGE 0x8
1126 /* these are the constants used in the above call. */
1127 /* DesiredAccess */
1128 /* File Specific access rights. */
1129 #define FILE_READ_DATA 0x001
1130 #define FILE_WRITE_DATA 0x002
1131 #define FILE_APPEND_DATA 0x004
1132 #define FILE_READ_EA 0x008
1133 #define FILE_WRITE_EA 0x010
1134 #define FILE_EXECUTE 0x020
1135 #define FILE_DELETE_CHILD 0x040
1136 #define FILE_READ_ATTRIBUTES 0x080
1137 #define FILE_WRITE_ATTRIBUTES 0x100
1139 #define FILE_ALL_ATTRIBUTES 0x1FF
1141 /* Generic access masks & rights. */
1142 #define SPECIFIC_RIGHTS_MASK 0x00FFFFL
1143 #define STANDARD_RIGHTS_MASK 0xFF0000L
1144 #define DELETE_ACCESS (1L<<16)
1145 #define READ_CONTROL_ACCESS (1L<<17)
1146 #define WRITE_DAC_ACCESS (1L<<18)
1147 #define WRITE_OWNER_ACCESS (1L<<19)
1148 #define SYNCHRONIZE_ACCESS (1L<<20)
1150 /* Combinations of standard masks. */
1151 #define STANDARD_RIGHTS_ALL_ACCESS (DELETE_ACCESS|READ_CONTROL_ACCESS|WRITE_DAC_ACCESS|WRITE_OWNER_ACCESS|SYNCHRONIZE_ACCESS)
1152 #define STANDARD_RIGHTS_EXECUTE_ACCESS (READ_CONTROL_ACCESS)
1153 #define STANDARD_RIGHTS_READ_ACCESS (READ_CONTROL_ACCESS)
1154 #define STANDARD_RIGHTS_REQUIRED_ACCESS (DELETE_ACCESS|READ_CONTROL_ACCESS|WRITE_DAC_ACCESS|WRITE_OWNER_ACCESS)
1155 #define STANDARD_RIGHTS_WRITE_ACCESS (READ_CONTROL_ACCESS)
1157 #define SYSTEM_SECURITY_ACCESS (1L<<24)
1158 #define MAXIMUM_ALLOWED_ACCESS (1L<<25)
1159 #define GENERIC_ALL_ACCESS (1<<28)
1160 #define GENERIC_EXECUTE_ACCESS (1<<29)
1161 #define GENERIC_WRITE_ACCESS (1<<30)
1162 #define GENERIC_READ_ACCESS (((unsigned)1)<<31)
1164 /* Mapping of access rights to UNIX perms. */
1165 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1166 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1167 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1168 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1169 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1170 FILE_APPEND_DATA|FILE_WRITE_DATA)
1171 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1172 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1174 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1176 /* Flags field. */
1177 #define REQUEST_OPLOCK 2
1178 #define REQUEST_BATCH_OPLOCK 4
1179 #define OPEN_DIRECTORY 8
1181 /* ShareAccess field. */
1182 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1183 #define FILE_SHARE_READ 1
1184 #define FILE_SHARE_WRITE 2
1185 #define FILE_SHARE_DELETE 4
1187 /* FileAttributesField */
1188 #define FILE_ATTRIBUTE_READONLY aRONLY
1189 #define FILE_ATTRIBUTE_HIDDEN aHIDDEN
1190 #define FILE_ATTRIBUTE_SYSTEM aSYSTEM
1191 #define FILE_ATTRIBUTE_DIRECTORY aDIR
1192 #define FILE_ATTRIBUTE_ARCHIVE aARCH
1193 #define FILE_ATTRIBUTE_NORMAL 0x80L
1194 #define FILE_ATTRIBUTE_TEMPORARY 0x100L
1195 #define FILE_ATTRIBUTE_COMPRESSED 0x800L
1196 #define SAMBA_ATTRIBUTES_MASK 0x7F
1198 /* Flags - combined with attributes. */
1199 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
1200 #define FILE_FLAG_NO_BUFFERING 0x20000000L
1201 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
1202 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
1203 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
1204 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1205 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
1207 /* CreateDisposition field. */
1208 #define FILE_SUPERSEDE 0
1209 #define FILE_OPEN 1
1210 #define FILE_CREATE 2
1211 #define FILE_OPEN_IF 3
1212 #define FILE_OVERWRITE 4
1213 #define FILE_OVERWRITE_IF 5
1215 /* CreateOptions field. */
1216 #define FILE_DIRECTORY_FILE 0x0001
1217 #define FILE_WRITE_THROUGH 0x0002
1218 #define FILE_SEQUENTIAL_ONLY 0x0004
1219 #define FILE_NON_DIRECTORY_FILE 0x0040
1220 #define FILE_NO_EA_KNOWLEDGE 0x0200
1221 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1222 #define FILE_RANDOM_ACCESS 0x0800
1223 #define FILE_DELETE_ON_CLOSE 0x1000
1225 /* Responses when opening a file. */
1226 #define FILE_WAS_OPENED 1
1227 #define FILE_WAS_CREATED 2
1228 #define FILE_WAS_OVERWRITTEN 3
1230 /* File type flags */
1231 #define FILE_TYPE_DISK 0
1232 #define FILE_TYPE_BYTE_MODE_PIPE 1
1233 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1234 #define FILE_TYPE_PRINTER 3
1235 #define FILE_TYPE_COMM_DEVICE 4
1236 #define FILE_TYPE_UNKNOWN 0xFFFF
1238 /* Flag for NT transact rename call. */
1239 #define RENAME_REPLACE_IF_EXISTS 1
1241 /* Filesystem Attributes. */
1242 #define FILE_CASE_SENSITIVE_SEARCH 0x01
1243 #define FILE_CASE_PRESERVED_NAMES 0x02
1244 #define FILE_UNICODE_ON_DISK 0x04
1245 /* According to cifs9f, this is 4, not 8 */
1246 /* Acconding to testing, this actually sets the security attribute! */
1247 #define FILE_PERSISTENT_ACLS 0x08
1248 /* These entries added from cifs9f --tsb */
1249 #define FILE_FILE_COMPRESSION 0x08
1250 #define FILE_VOLUME_QUOTAS 0x10
1251 #define FILE_DEVICE_IS_MOUNTED 0x20
1252 #define FILE_VOLUME_IS_COMPRESSED 0x8000
1254 /* ChangeNotify flags. */
1255 #define FILE_NOTIFY_CHANGE_FILE 0x001
1256 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
1257 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
1258 #define FILE_NOTIFY_CHANGE_SIZE 0x008
1259 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
1260 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1261 #define FILE_NOTIFY_CHANGE_CREATION 0x040
1262 #define FILE_NOTIFY_CHANGE_EA 0x080
1263 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
1264 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x200
1266 /* where to find the base of the SMB packet proper */
1267 #define smb_base(buf) (((char *)(buf))+4)
1269 /* we don't allow server strings to be longer than 48 characters as
1270 otherwise NT will not honour the announce packets */
1271 #define MAX_SERVER_STRING_LENGTH 48
1274 #define SMB_SUCCESS 0 /* The request was successful. */
1275 #define ERRDOS 0x01 /* Error is from the core DOS operating system set. */
1276 #define ERRSRV 0x02 /* Error is generated by the server network file manager.*/
1277 #define ERRHRD 0x03 /* Error is an hardware error. */
1278 #define ERRCMD 0xFF /* Command was not in the "SMB" format. */
1280 #ifdef HAVE_STDARG_H
1281 int slprintf(char *str, int n, char *format, ...)
1282 #ifdef __GNUC__
1283 __attribute__ ((format (__printf__, 3, 4)))
1284 #endif
1286 #else
1287 int slprintf();
1288 #endif
1290 #ifdef HAVE_STDARG_H
1291 int fdprintf(int fd, char *format, ...)
1292 #ifdef __GNUC__
1293 __attribute__ ((format (__printf__, 2, 3)))
1294 #endif
1296 #else
1297 int fdprintf();
1298 #endif
1300 #ifdef WITH_DFS
1301 void dfs_unlogin(void);
1302 extern int dcelogin_atmost_once;
1303 #endif
1305 #ifdef NOSTRDUP
1306 char *strdup(char *s);
1307 #endif
1309 #ifndef SIGNAL_CAST
1310 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1311 #endif
1313 #ifndef SELECT_CAST
1314 #define SELECT_CAST
1315 #endif
1317 /* these are used in NetServerEnum to choose what to receive */
1318 #define SV_TYPE_WORKSTATION 0x00000001
1319 #define SV_TYPE_SERVER 0x00000002
1320 #define SV_TYPE_SQLSERVER 0x00000004
1321 #define SV_TYPE_DOMAIN_CTRL 0x00000008
1322 #define SV_TYPE_DOMAIN_BAKCTRL 0x00000010
1323 #define SV_TYPE_TIME_SOURCE 0x00000020
1324 #define SV_TYPE_AFP 0x00000040
1325 #define SV_TYPE_NOVELL 0x00000080
1326 #define SV_TYPE_DOMAIN_MEMBER 0x00000100
1327 #define SV_TYPE_PRINTQ_SERVER 0x00000200
1328 #define SV_TYPE_DIALIN_SERVER 0x00000400
1329 #define SV_TYPE_SERVER_UNIX 0x00000800
1330 #define SV_TYPE_NT 0x00001000
1331 #define SV_TYPE_WFW 0x00002000
1332 #define SV_TYPE_SERVER_MFPN 0x00004000
1333 #define SV_TYPE_SERVER_NT 0x00008000
1334 #define SV_TYPE_POTENTIAL_BROWSER 0x00010000
1335 #define SV_TYPE_BACKUP_BROWSER 0x00020000
1336 #define SV_TYPE_MASTER_BROWSER 0x00040000
1337 #define SV_TYPE_DOMAIN_MASTER 0x00080000
1338 #define SV_TYPE_SERVER_OSF 0x00100000
1339 #define SV_TYPE_SERVER_VMS 0x00200000
1340 #define SV_TYPE_WIN95_PLUS 0x00400000
1341 #define SV_TYPE_DFS_SERVER 0x00800000
1342 #define SV_TYPE_ALTERNATE_XPORT 0x20000000
1343 #define SV_TYPE_LOCAL_LIST_ONLY 0x40000000
1344 #define SV_TYPE_DOMAIN_ENUM 0x80000000
1345 #define SV_TYPE_ALL 0xFFFFFFFF
1347 /* what server type are we currently - JHT Says we ARE 4.20 */
1348 /* this was set by JHT in liaison with Jeremy Allison early 1997 */
1349 /* setting to 4.20 at same time as announcing ourselves as NT Server */
1350 /* History: */
1351 /* Version 4.0 - never made public */
1352 /* Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9 */
1353 /* - Reappeared in 1.9.16p11 with fixed smbd services */
1354 /* Version 4.20 - To indicate that nmbd and browsing now works better */
1356 #define DEFAULT_MAJOR_VERSION 0x04
1357 #define DEFAULT_MINOR_VERSION 0x02
1359 /* Browser Election Values */
1360 #define BROWSER_ELECTION_VERSION 0x010f
1361 #define BROWSER_CONSTANT 0xaa55
1363 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1365 #define FLAGS2_LONG_PATH_COMPONENTS 0x0001
1366 #define FLAGS2_EXTENDED_ATTRIBUTES 0x0002
1367 #define FLAGS2_DFS_PATHNAMES 0x1000
1368 #define FLAGS2_READ_PERMIT_NO_EXECUTE 0x2000
1369 #define FLAGS2_32_BIT_ERROR_CODES 0x4000
1370 #define FLAGS2_UNICODE_STRINGS 0x8000
1372 #define FLAGS2_WIN2K_SIGNATURE 0xC852 /* Hack alert ! For now... JRA. */
1374 /* Capabilities. see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1376 #define CAP_RAW_MODE 0x0001
1377 #define CAP_MPX_MODE 0x0002
1378 #define CAP_UNICODE 0x0004
1379 #define CAP_LARGE_FILES 0x0008
1380 #define CAP_NT_SMBS 0x0010
1381 #define CAP_RPC_REMOTE_APIS 0x0020
1382 #define CAP_STATUS32 0x0040
1383 #define CAP_LEVEL_II_OPLOCKS 0x0080
1384 #define CAP_LOCK_AND_READ 0x0100
1385 #define CAP_NT_FIND 0x0200
1386 #define CAP_DFS 0x1000
1387 #define CAP_LARGE_READX 0x4000
1388 #define CAP_EXTENDED_SECURITY 0x80000000
1390 /* protocol types. It assumes that higher protocols include lower protocols
1391 as subsets */
1392 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1394 /* security levels */
1395 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN};
1397 /* server roles */
1398 enum server_types
1400 ROLE_STANDALONE,
1401 ROLE_DOMAIN_MEMBER,
1402 ROLE_DOMAIN_BDC,
1403 ROLE_DOMAIN_PDC
1406 /* printing types */
1407 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1408 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2};
1410 /* Remote architectures we know about. */
1411 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT, RA_WIN2K, RA_SAMBA};
1413 /* case handling */
1414 enum case_handling {CASE_LOWER,CASE_UPPER};
1416 #ifdef WITH_SSL
1417 /* SSL version options */
1418 enum ssl_version_enum {SMB_SSL_V2,SMB_SSL_V3,SMB_SSL_V23,SMB_SSL_TLS1};
1419 #endif /* WITH_SSL */
1422 * Global value meaing that the smb_uid field should be
1423 * ingored (in share level security and protocol level == CORE)
1426 #define UID_FIELD_INVALID 0
1427 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1429 /* Defines needed for multi-codepage support. */
1430 #define MSDOS_LATIN_1_CODEPAGE 850
1431 #define KANJI_CODEPAGE 932
1432 #define HANGUL_CODEPAGE 949
1433 #define BIG5_CODEPAGE 950
1434 #define SIMPLIFIED_CHINESE_CODEPAGE 936
1436 #ifdef KANJI
1438 * Default client code page - Japanese
1440 #define DEFAULT_CLIENT_CODE_PAGE KANJI_CODEPAGE
1441 #else /* KANJI */
1443 * Default client code page - 850 - Western European
1445 #define DEFAULT_CLIENT_CODE_PAGE MSDOS_LATIN_1_CODEPAGE
1446 #endif /* KANJI */
1448 /* Global val set if multibyte codepage. */
1449 extern int global_is_multibyte_codepage;
1451 #define get_character_len(x) (global_is_multibyte_codepage ? skip_multibyte_char((x)) : 0)
1454 * Size of buffer to use when moving files across filesystems.
1456 #define COPYBUF_SIZE (8*1024)
1459 * Integers used to override error codes.
1461 extern int unix_ERR_class;
1462 extern int unix_ERR_code;
1465 * Used in chaining code.
1467 extern int chain_size;
1470 * Map the Core and Extended Oplock requesst bits down
1471 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1475 * Core protocol.
1477 #define CORE_OPLOCK_REQUEST(inbuf) \
1478 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1481 * Extended protocol.
1483 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1485 /* Lock types. */
1486 #define LOCKING_ANDX_SHARED_LOCK 0x1
1487 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1488 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1489 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1490 #define LOCKING_ANDX_LARGE_FILES 0x10
1492 /* Oplock levels */
1493 #define OPLOCKLEVEL_NONE 0
1494 #define OPLOCKLEVEL_II 1
1497 * Bits we test with.
1500 #define NO_OPLOCK 0
1501 #define EXCLUSIVE_OPLOCK 1
1502 #define BATCH_OPLOCK 2
1503 #define LEVEL_II_OPLOCK 4
1505 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK))
1506 #define BATCH_OPLOCK_TYPE(lck) ((lck) & BATCH_OPLOCK)
1507 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & LEVEL_II_OPLOCK)
1509 #define CORE_OPLOCK_GRANTED (1<<5)
1510 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1513 * Return values for oplock types.
1516 #define NO_OPLOCK_RETURN 0
1517 #define EXCLUSIVE_OPLOCK_RETURN 1
1518 #define BATCH_OPLOCK_RETURN 2
1519 #define LEVEL_II_OPLOCK_RETURN 3
1522 * Loopback command offsets.
1525 #define OPBRK_CMD_LEN_OFFSET 0
1526 #define OPBRK_CMD_PORT_OFFSET 4
1527 #define OPBRK_CMD_HEADER_LEN 6
1529 #define OPBRK_MESSAGE_CMD_OFFSET 0
1532 * Oplock break command code to send over the udp socket.
1533 * The same message is sent for both exlusive and level II breaks.
1535 * The form of this is :
1537 * 0 2 6 10 14 14+devsize 14+devsize+inodesize
1538 * +----+--------+--------+--------+-------+--------+
1539 * | cmd| pid | sec | usec | dev | inode |
1540 * +----+--------+--------+--------+-------+--------+
1543 #define OPLOCK_BREAK_CMD 0x1
1544 #define OPLOCK_BREAK_PID_OFFSET 2
1545 #define OPLOCK_BREAK_SEC_OFFSET (OPLOCK_BREAK_PID_OFFSET + sizeof(pid_t))
1546 #define OPLOCK_BREAK_USEC_OFFSET (OPLOCK_BREAK_SEC_OFFSET + sizeof(time_t))
1547 #define OPLOCK_BREAK_DEV_OFFSET (OPLOCK_BREAK_USEC_OFFSET + sizeof(long))
1548 #define OPLOCK_BREAK_INODE_OFFSET (OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1549 #define OPLOCK_BREAK_MSG_LEN (OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1551 #define KERNEL_OPLOCK_BREAK_CMD 0x2
1552 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
1555 * Capabilities abstracted for different systems.
1558 #define KERNEL_OPLOCK_CAPABILITY 0x1
1561 * Oplock break command code sent via the kernel interface (if it exists).
1563 * Form of this is :
1565 * 0 2 2+devsize 2+devsize+inodesize
1566 * +----+--------+--------+
1567 * | cmd| dev | inode |
1568 * +----+--------+--------+
1570 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
1571 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
1572 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
1575 /* if a kernel does support oplocks then a structure of the following
1576 typee is used to describe how to interact with the kernel */
1577 struct kernel_oplocks {
1578 BOOL (*receive_message)(fd_set *fds, char *buffer, int buffer_len);
1579 BOOL (*set_oplock)(files_struct *fsp, int oplock_type);
1580 void (*release_oplock)(files_struct *fsp);
1581 BOOL (*parse_message)(char *msg_start, int msg_len, SMB_INO_T *inode, SMB_DEV_T *dev);
1582 BOOL (*msg_waiting)(fd_set *fds);
1583 int notification_fd;
1587 #define CMD_REPLY 0x8000
1589 /* this structure defines the functions for doing change notify in
1590 various implementations */
1591 struct cnotify_fns {
1592 void * (*register_notify)(connection_struct *conn, char *path, uint32 flags);
1593 BOOL (*check_notify)(connection_struct *conn, uint16 vuid, char *path, uint32 flags, void *data, time_t t);
1594 void (*remove_notify)(void *data);
1595 int select_time;
1600 #include "smb_macros.h"
1602 /* A netbios name structure. */
1603 struct nmb_name {
1604 char name[17];
1605 char scope[64];
1606 unsigned int name_type;
1609 #define AGENT_CMD_CON 0
1610 #define AGENT_CMD_CON_ANON 2
1611 #define AGENT_CMD_CON_REUSE 1
1613 struct pwd_info
1615 BOOL null_pwd;
1616 BOOL cleartext;
1617 BOOL crypted;
1619 fstring password;
1621 uchar smb_lm_pwd[16];
1622 uchar smb_nt_pwd[16];
1624 uchar smb_lm_owf[24];
1625 uchar smb_nt_owf[128];
1626 size_t nt_owf_len;
1628 uchar lm_cli_chal[8];
1629 uchar nt_cli_chal[128];
1630 size_t nt_cli_chal_len;
1632 uchar sess_key[16];
1635 struct ntdom_info
1637 unsigned char sess_key[16]; /* Current session key. */
1638 unsigned char ntlmssp_hash[258]; /* ntlmssp data. */
1639 uint32 ntlmssp_cli_flgs; /* ntlmssp client flags */
1640 uint32 ntlmssp_srv_flgs; /* ntlmssp server flags */
1641 uint32 ntlmssp_seq_num; /* ntlmssp sequence number */
1642 DOM_CRED clnt_cred; /* Client credential. */
1644 int max_recv_frag;
1645 int max_xmit_frag;
1647 vuser_key key;
1651 * Network Computing Architechture Context Name Named Pipe
1652 * See MSDN docs for more information
1654 struct ncacn_np
1656 fstring pipe_name;
1657 struct cli_state *smb;
1658 uint16 fnum;
1659 BOOL initialised;
1662 #include "rpc_creds.h"
1663 #include "rpc_misc.h"
1664 #include "rpc_secdes.h"
1665 #include "nt_printing.h"
1667 typedef struct
1669 uid_t uid; /* uid of a validated user */
1670 gid_t gid; /* gid of a validated user */
1672 userdom_struct user;
1673 BOOL guest;
1675 /* following groups stuff added by ih */
1676 /* This groups info is needed for when we become_user() for this uid */
1677 int n_groups;
1678 gid_t *groups;
1680 NT_USER_TOKEN *nt_user_token;
1682 /* per-user authentication information on NT RPCs */
1683 /* lkclXXXX - THIS SHOULD NOT BE HERE! */
1684 struct dcinfo dc;
1685 } user_struct;
1687 #include "ntdomain.h"
1689 #include "client.h"
1690 #include "rpcclient.h"
1693 * Size of new password account encoding string. DO NOT CHANGE.
1696 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1699 Do you want session setups at user level security with a invalid
1700 password to be rejected or allowed in as guest? WinNT rejects them
1701 but it can be a pain as it means "net view" needs to use a password
1703 You have 3 choices in the setting of map_to_guest:
1705 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1706 are rejected. This is the default.
1708 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1709 are rejected, unless the username does not exist, in which case it
1710 is treated as a guest login
1712 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1713 are treated as a guest login
1715 Note that map_to_guest only has an effect in user or server
1716 level security.
1719 #define NEVER_MAP_TO_GUEST 0
1720 #define MAP_TO_GUEST_ON_BAD_USER 1
1721 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
1723 #include "nsswitch/winbindd_nss.h"
1725 #endif /* _SMB_H */