2 * Copyright 2000, International Business Machines Corporation and others.
5 * This software has been released under the terms of the IBM Public
6 * License. For details, see the LICENSE file in the top-level source
7 * directory or online at http://www.openafs.org/dl/license10.html
11 #define __SMB_H_ENV__ 1
13 /* #define DEBUG_SMB_REFCOUNT 1 */
15 #if _WIN32_WINNT < 0x0501
17 #define _WIN32_WINNT 0x0501
23 /* basic core protocol SMB structure */
31 unsigned char errHigh;
34 unsigned short res[6];
40 unsigned char vdata[1];
45 #define SMB_FLAGS_SUPPORT_LOCKREAD 0x01
46 #define SMB_FLAGS_CLIENT_BUF_AVAIL 0x02
47 #define SMB_FLAGS_CASELESS_PATHNAMES 0x08
48 #define SMB_FLAGS_CANONICAL_PATHNAMES 0x10
49 #define SMB_FLAGS_REQUEST_OPLOCK 0x20
50 #define SMB_FLAGS_REQUEST_BATCH_OPLOCK 0x40
51 #define SMB_FLAGS_SERVER_TO_CLIENT 0x80
55 #define SMB_FLAGS2_KNOWS_LONG_NAMES 0x0001
56 #define SMB_FLAGS2_KNOWS_EAS 0x0002
57 #define SMB_FLAGS2_SECURITY_SIGNATURE 0x0004
58 #define SMB_FLAGS2_RESERVED1 0x0008
59 #define SMB_FLAGS2_IS_LONG_NAME 0x0040
60 #define SMB_FLAGS2_EXT_SEC 0x0800
61 #define SMB_FLAGS2_DFS_PATHNAMES 0x1000
62 #define SMB_FLAGS2_PAGING_IO 0x2000
63 #define SMB_FLAGS2_32BIT_STATUS 0x4000
64 #define SMB_FLAGS2_UNICODE 0x8000
66 #define KNOWS_LONG_NAMES(inp) ((((smb_t *)inp)->flg2 & SMB_FLAGS2_KNOWS_LONG_NAMES)?1:0)
67 #define WANTS_DFS_PATHNAMES(inp) ((((smb_t *)inp)->flg2 & SMB_FLAGS2_DFS_PATHNAMES)?1:0)
68 #define WANTS_UNICODE(inp) ((((smb_t *)inp)->flg2 & SMB_FLAGS2_UNICODE)?1:0)
70 /* Information Levels */
71 #define SMB_INFO_STANDARD 1
72 #define SMB_INFO_QUERY_EA_SIZE 2
73 #define SMB_INFO_QUERY_EAS_FROM_LIST 3
74 #define SMB_INFO_QUERY_ALL_EAS 4
75 #define SMB_INFO_IS_NAME_VALID 6
77 #define SMB_QUERY_FILE_BASIC_INFO 0x101
78 #define SMB_QUERY_FILE_STANDARD_INFO 0x102
79 #define SMB_QUERY_FILE_EA_INFO 0x103
80 #define SMB_QUERY_FILE_NAME_INFO 0x104
81 #define SMB_QUERY_FILE_ALL_INFO 0x107
82 #define SMB_QUERY_FILE_ALT_NAME_INFO 0x108
83 #define SMB_QUERY_FILE_STREAM_INFO 0x109
84 #define SMB_QUERY_FILE_COMPRESSION_INFO 0x10B
85 #define SMB_QUERY_FILE_UNIX_BASIC 0x200
86 #define SMB_QUERY_FILE_UNIX_LINK 0x201
87 #define SMB_INFO_PASSTHROUGH 0x1000
89 #define SMB_SET_FILE_BASIC_INFO 0x101
90 #define SMB_SET_FILE_DISPOSITION_INFO 0x102
91 #define SMB_SET_FILE_ALLOCATION_INFO 0x103
92 #define SMB_SET_FILE_END_OF_FILE_INFO 0x104
93 #define SMB_SET_FILE_UNIX_BASIC 0x200
94 #define SMB_SET_FILE_UNIX_LINK 0x201
95 #define SMB_SET_FILE_UNIX_HLINK 0x203
97 #define SMB_INFO_ALLOCATION 1
98 #define SMB_INFO_VOLUME 2
99 #define SMB_QUERY_FS_LABEL_INFO 0x101
100 #define SMB_QUERY_FS_VOLUME_INFO 0x102
101 #define SMB_QUERY_FS_SIZE_INFO 0x103
102 #define SMB_QUERY_FS_DEVICE_INFO 0x104
103 #define SMB_QUERY_FS_ATTRIBUTE_INFO 0x105
104 #define SMB_QUERY_FS_QUOTA_INFO 0x106
105 #define SMB_QUERY_FS_CONTROL_INFO 0x107
106 #define SMB_INFO_UNIX 0x200
107 #define SMB_INFO_MACOS 0x301
109 #define SMB_FIND_FILE_DIRECTORY_INFO 0x101
110 #define SMB_FIND_FILE_FULL_DIRECTORY_INFO 0x102
111 #define SMB_FIND_FILE_NAMES_INFO 0x103
112 #define SMB_FIND_FILE_BOTH_DIRECTORY_INFO 0x104
114 /* SMB_COM_TRANSACTION Named pipe operations */
115 #define SMB_TRANS_SET_NMPIPE_STATE 0x0001
116 #define SMB_TRANS_RAW_READ_NMPIPE 0x0011
117 #define SMB_TRANS_QUERY_NMPIPE_STATE 0x0021
118 #define SMB_TRANS_QUERY_NMPIPE_INFO 0x0022
119 #define SMB_TRANS_PEEK_NMPIPE 0x0023
120 #define SMB_TRANS_TRANSACT_NMPIPE 0x0026
121 #define SMB_TRANS_RAW_WRITE_NMPIPE 0x0031
122 #define SMB_TRANS_READ_NMPIPE 0x0036
123 #define SMB_TRANS_WRITE_NMPIPE 0x0037
124 #define SMB_TRANS_WAIT_NMPIPE 0x0053
125 #define SMB_TRANS_CALL_NMPIPE 0x0054
128 #define SMB_NOPCODES 256 /* # of opcodes in the dispatch table */
131 #define SMB_THREADSPERVC 4 /* threads per VC */
133 /* flags for functions */
134 #define SMB_FLAG_CREATE 1 /* create the structure if necessary */
135 #define SMB_FLAG_AFSLOGON 2 /* operating on behalf of afslogon.dll */
137 /* max # of bytes we'll receive in an incoming SMB message */
138 /* the maximum is 2^18-1 for NBT and 2^25-1 for Raw transport messages */
139 /* we will use something smaller but large enough to be efficient */
140 #define SMB_PACKETSIZE 32768 /* was 8400 */
141 /* raw mode is considered obsolete and cannot be used with message signing */
142 #define SMB_MAXRAWSIZE 65536
143 /* max STRING characters per packet per request */
144 #define SMB_STRINGBUFSIZE 4096
146 /* Negotiate protocol constants */
148 #define NEGOTIATE_SECURITY_USER_LEVEL 0x01
149 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE 0x02
150 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED 0x04
151 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED 0x08
154 #define NTNEGOTIATE_CAPABILITY_RAWMODE 0x00000001L
155 #define NTNEGOTIATE_CAPABILITY_MPXMODE 0x00000002L
156 #define NTNEGOTIATE_CAPABILITY_UNICODE 0x00000004L
157 #define NTNEGOTIATE_CAPABILITY_LARGEFILES 0x00000008L
158 #define NTNEGOTIATE_CAPABILITY_NTSMB 0x00000010L
159 #define NTNEGOTIATE_CAPABILITY_RPCAPI 0x00000020L
160 #define NTNEGOTIATE_CAPABILITY_NTSTATUS 0x00000040L
161 #define NTNEGOTIATE_CAPABILITY_LEVEL_II_OPLOCKS 0x00000080L
162 #define NTNEGOTIATE_CAPABILITY_LOCK_AND_READ 0x00000100L
163 #define NTNEGOTIATE_CAPABILITY_NTFIND 0x00000200L
164 #define NTNEGOTIATE_CAPABILITY_DFS 0x00001000L
165 #define NTNEGOTIATE_CAPABILITY_NT_INFO_PASSTHRU 0x00002000L
166 #define NTNEGOTIATE_CAPABILITY_LARGE_READX 0x00004000L
167 #define NTNEGOTIATE_CAPABILITY_LARGE_WRITEX 0x00008000L
168 #define NTNEGOTIATE_CAPABILITY_UNIX 0x00800000L
169 #define NTNEGOTIATE_CAPABILITY_BULK_TRANSFER 0x20000000L
170 #define NTNEGOTIATE_CAPABILITY_COMPRESSED 0x40000000L
171 #define NTNEGOTIATE_CAPABILITY_EXTENDED_SECURITY 0x80000000L
173 #define NTSID_LOCAL_SYSTEM L"S-1-5-18"
175 /* a packet structure for receiving SMB messages; locked by smb_globalLock.
176 * Most of the work involved is in handling chained requests and responses.
178 * When handling input, inWctp points to the current request's wct field (and
179 * the other parameters and request data can be found from this field). The
180 * opcode, unfortunately, isn't available there, so is instead copied to the
181 * packet's inCom field. It is initially set to com, but each chained
182 * operation sets it, also.
183 * The function smb_AdvanceInput advances an input packet to the next request
184 * in the chain. The inCom field is set to 0xFF when there are no more
185 * requests. The inCount field is 0 if this is the first request, and
186 * otherwise counts which request it is.
188 * When handling output, we also have to chain all of the responses together.
189 * The function smb_GetResponsePacket will setup outWctp to point to the right
192 #define SMB_PACKETMAGIC 0x7436353 /* magic # for packets */
193 typedef struct smb_packet {
194 char data[SMB_PACKETSIZE];
195 struct smb_packet *nextp; /* in free list, or whatever */
197 cm_space_t *spacep; /* use this for stripping last component */
198 NCB *ncbp; /* use this for sending */
200 unsigned long resumeCode;
201 unsigned short inCount;
202 unsigned short fid; /* for calls bundled with openAndX */
205 unsigned char oddByte;
206 unsigned short ncb_length;
208 cm_space_t *stringsp; /* decoded strings from this packet */
211 /* smb_packet flags */
212 #define SMB_PACKETFLAG_NOSEND 1
213 #define SMB_PACKETFLAG_SUSPENDED 2
215 /* a structure for making Netbios calls; locked by smb_globalLock */
216 #define SMB_NCBMAGIC 0x2334344
217 typedef struct myncb {
218 NCB ncb; /* ncb to use */
219 struct myncb *nextp; /* when on free list */
223 /* structures representing environments from kernel / SMB network.
224 * Most have their own locks, but the tree connection fields and
225 * reference counts are locked by the smb_rctLock. Those fields will
226 * be marked in comments.
229 /* one per virtual circuit */
230 typedef struct smb_vc {
231 struct smb_vc *nextp; /* not used */
232 afs_uint32 magic; /* a magic value to detect bad entries */
233 afs_int32 refCount; /* the reference count */
234 afs_uint32 flags; /* the flags, if any; locked by mx */
235 osi_mutex_t mx; /* the mutex */
236 afs_uint32 vcID; /* VC id */
237 unsigned short lsn; /* the NCB LSN associated with this */
238 unsigned short uidCounter; /* session ID counter */
239 unsigned short tidCounter; /* tree ID counter */
240 unsigned short fidCounter; /* file handle ID counter */
241 struct smb_tid *tidsp; /* the first child in the tid list */
242 struct smb_user *usersp; /* the first child in the user session list */
243 struct smb_fid *fidsp; /* the first child in the open file list */
244 unsigned char errorCount;
245 clientchar_t rname[17];
247 char encKey[MSV1_0_CHALLENGE_LENGTH]; /* MSV1_0_CHALLENGE_LENGTH is 8 */
248 void * secCtx; /* security context when negotiating SMB extended auth
249 * valid when SMB_VCFLAG_AUTH_IN_PROGRESS is set
251 unsigned short session; /* This is the Session Index associated with the NCBs */
254 #define SMB_VC_MAGIC ('S' | 'C'<<8 | 'A'<<16 | 'C'<<24)
255 /* have we negotiated ... */
256 #define SMB_VCFLAG_USEV3 1 /* ... version 3 of the protocol */
257 #define SMB_VCFLAG_USECORE 2 /* ... the core protocol */
258 #define SMB_VCFLAG_USENT 4 /* ... NT LM 0.12 or beyond */
259 #define SMB_VCFLAG_STATUS32 8 /* use 32-bit NT status codes */
260 #define SMB_VCFLAG_REMOTECONN 0x10 /* bad: remote conns not allowed */
261 #define SMB_VCFLAG_ALREADYDEAD 0x20 /* do not get tokens from this vc */
262 #define SMB_VCFLAG_SESSX_RCVD 0x40 /* we received at least one session setups on this vc */
263 #define SMB_VCFLAG_AUTH_IN_PROGRESS 0x80 /* a SMB NT extended authentication is in progress */
264 #define SMB_VCFLAG_CLEAN_IN_PROGRESS 0x100
265 #define SMB_VCFLAG_USEUNICODE 0x200 /* une UNICODE for STRING fields (NTLM 0.12 or later) */
267 /* one per user session */
268 typedef struct smb_user {
269 struct smb_user *nextp; /* next sibling */
270 afs_int32 refCount; /* ref count */
271 afs_uint32 flags; /* flags; locked by mx */
273 unsigned short userID; /* the session identifier */
274 struct smb_vc *vcp; /* back ptr to virtual circuit */
275 struct smb_username *unp; /* user name struct */
276 afs_uint32 deleteOk; /* ok to del: locked by smb_rctLock */
279 #define SMB_USERFLAG_DELETE 1 /* delete struct when ref count zero */
281 typedef struct smb_username {
282 struct smb_username *nextp; /* next sibling */
283 afs_int32 refCount; /* ref count */
284 long flags; /* flags; locked by mx */
286 struct cm_user *userp; /* CM user structure */
287 clientchar_t *name; /* user name */
288 clientchar_t *machine; /* machine name */
289 time_t last_logoff_t; /* most recent logoff time */
292 /* The SMB_USERNAMEFLAG_AFSLOGON is used to preserve the existence of an
293 * smb_username_t even when the refCount is zero. This is used to ensure
294 * that tokens set to a username during the integrated logon process are
295 * preserved until the SMB Session that will require the tokens is created.
296 * The cm_IoctlSetTokens() function when executed from the Network Provider
297 * connects to the AFS Client Service using the credentials of the machine
298 * and not the user for whom the tokens are being configured. */
299 #define SMB_USERNAMEFLAG_AFSLOGON 1
301 /* The SMB_USERNAMEFLAG_LOGOFF is used to indicate that the user most
302 * recently logged off at 'last_logoff_t'. The smb_username_t should not
303 * be deleted even if the refCount is zero before 'last_logoff_t' +
304 * 'smb_LogoffTransferTimeout' if 'smb_LogoffTokenTransfer' is non-zero.
305 * The smb_Daemon() thread is responsible for purging the expired objects */
307 #define SMB_USERNAMEFLAG_LOGOFF 2
309 #define SMB_MAX_USERNAME_LENGTH 256
311 /* one per tree-connect */
312 typedef struct smb_tid {
313 struct smb_tid *nextp; /* next sibling */
315 afs_uint32 flags; /* protected by mx */
316 osi_mutex_t mx; /* for non-tree-related stuff */
317 unsigned short tid; /* the tid */
318 struct smb_vc *vcp; /* back ptr */
319 struct cm_user *userp; /* user logged in at the
320 * tree connect level (base) */
321 clientchar_t *pathname; /* pathname derived from sharename */
322 afs_uint32 deleteOk; /* ok to del: locked by smb_rctLock */
325 #define SMB_TIDFLAG_IPC 1 /* IPC$ */
327 /* one per process ID */
328 typedef struct smb_pid {
329 struct smb_pid *nextp; /* next sibling */
332 osi_mutex_t mx; /* for non-tree-related stuff */
333 unsigned short pid; /* the pid */
334 struct smb_tid *tidp; /* back ptr */
338 /* Defined in smb_ioctl.h */
341 /* Defined in smb_rpc.h */
344 /* one per file ID; these are really file descriptors */
345 typedef struct smb_fid {
348 afs_uint32 flags; /* protected by mx */
349 osi_mutex_t mx; /* for non-tree-related stuff */
350 unsigned short fid; /* the file ID */
351 struct smb_vc *vcp; /* back ptr */
352 struct cm_scache *scp; /* scache of open file */
353 struct cm_user *userp; /* user that opened the file
354 originally (used to close
355 the file if session is
357 osi_hyper_t offset; /* our file pointer */
358 struct smb_ioctl *ioctlp; /* ptr to ioctl structure */
359 /* Under NT, we may need to know the
360 * parent directory and pathname used
361 * to open the file, either to delete
362 * the file on close, or to do a
363 * change notification */
364 struct smb_rpc *rpcp; /* ptr to RPC structure. Used
365 to keep track of endpoint
366 that was opened for the
368 struct cm_scache *NTopen_dscp; /* parent directory (NT) */
369 clientchar_t *NTopen_pathp; /* path used in open (NT) */
370 clientchar_t *NTopen_wholepathp; /* entire path, not just last name */
371 int curr_chunk; /* chunk being read */
372 int prev_chunk; /* previous chunk read */
373 int raw_writers; /* pending async raw writes */
374 EVENT_HANDLE raw_write_event; /* signal this when raw_writers zero */
375 afs_uint32 deleteOk; /* ok to del: locked by smb_rctLock */
378 #define SMB_FID_OPENREAD_LISTDIR 1 /* open for reading / listing directory */
379 #define SMB_FID_OPENWRITE 2 /* open for writing */
380 #define SMB_FID_CREATED 4 /* a new file */
381 #define SMB_FID_IOCTL 8 /* a file descriptor for the
382 * magic ioctl file */
383 #define SMB_FID_OPENDELETE 0x10 /* open for deletion (NT) */
384 #define SMB_FID_DELONCLOSE 0x20 /* marked for deletion */
387 * Now some special flags to work around a bug in NT Client
389 #define SMB_FID_LENGTHSETDONE 0x40 /* have done 0-length write */
390 #define SMB_FID_MTIMESETDONE 0x80 /* have set modtime via Tr2 */
391 #define SMB_FID_LOOKSLIKECOPY (SMB_FID_LENGTHSETDONE | SMB_FID_MTIMESETDONE)
392 #define SMB_FID_NTOPEN 0x100 /* have dscp and pathp */
393 #define SMB_FID_SEQUENTIAL 0x200
394 #define SMB_FID_RANDOM 0x400
395 #define SMB_FID_EXECUTABLE 0x800
397 #define SMB_FID_SHARE_READ 0x1000
398 #define SMB_FID_SHARE_WRITE 0x2000
400 #define SMB_FID_RPC 0x4000 /* open for MS RPC */
401 #define SMB_FID_MESSAGEMODEPIPE 0x8000 /* message mode pipe */
402 #define SMB_FID_BLOCKINGPIPE 0x10000 /* blocking pipe */
403 #define SMB_FID_RPC_INCALL 0x20000 /* in an RPC call */
405 #define SMB_FID_QLOCK_HIGH 0x7f000000
406 #define SMB_FID_QLOCK_LOW 0x00000000
407 #define SMB_FID_QLOCK_LENGTH 1
408 #define SMB_FID_QLOCK_PID 0
411 * SMB file attributes (16-bit)
413 #define SMB_ATTR_READONLY 0x0001
414 #define SMB_ATTR_HIDDEN 0x0002 /* hidden file for the purpose of dir listings */
415 #define SMB_ATTR_SYSTEM 0x0004
416 #define SMB_ATTR_VOLUMEID 0x0008 /* obsolete */
417 #define SMB_ATTR_DIRECTORY 0x0010
418 #define SMB_ATTR_ARCHIVE 0x0020
419 #define SMB_ATTR_DEVICE 0x0040
421 /* the following are Extended File Attributes (32-bit) */
422 #define SMB_ATTR_NORMAL 0x0080 /* normal file. Only valid if used alone */
423 #define SMB_ATTR_TEMPORARY 0x0100
424 #define SMB_ATTR_SPARSE_FILE 0x0200 /* used with dfs links */
425 #define SMB_ATTR_REPARSE_POINT 0x0400
426 #define SMB_ATTR_COMPRESSED 0x0800 /* file or dir is compressed */
427 #define SMB_ATTR_OFFLINE 0x1000
428 #define SMB_ATTR_NOT_CONTENT_INDEXED 0x2000
429 #define SMB_ATTR_ENCRYPTED 0x4000
430 #define SMB_ATTR_POSIX_SEMANTICS 0x01000000
431 #define SMB_ATTR_BACKUP_SEMANTICS 0x02000000
432 #define SMB_ATTR_DELETE_ON_CLOSE 0x04000000
433 #define SMB_ATTR_SEQUENTIAL_SCAN 0x08000000
434 #define SMB_ATTR_RANDOM_ACCESS 0x10000000
435 #define SMB_ATTR_NO_BUFFERING 0x20000000
436 #define SMB_ATTR_WRITE_THROUGH 0x80000000
438 #define LOCKING_ANDX_SHARED_LOCK 0x01 /* Read-only lock */
439 #define LOCKING_ANDX_OPLOCK_RELEASE 0x02 /* Oplock break notification */
440 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x04 /* Change lock type */
441 #define LOCKING_ANDX_CANCEL_LOCK 0x08 /* Cancel outstanding request */
442 #define LOCKING_ANDX_LARGE_FILES 0x10 /* Large file locking format */
444 /* File type constants */
445 #define SMB_FILETYPE_DISK 0x0000
446 #define SMB_FILETYPE_BYTE_MODE_PIPE 0x0001
447 #define SMB_FILETYPE_MESSAGE_MODE_PIPE 0x0002
448 #define SMB_FILETYPE_PRINTER 0x0003
449 #define SMB_FILETYPE_UNKNOWN 0xffff
451 /* Device state constants */
452 #define SMB_DEVICESTATE_READASBYTESTREAM 0x0000
453 #define SMB_DEVICESTATE_READMSGFROMPIPE 0x0100
454 #define SMB_DEVICESTATE_BYTESTREAMPIPE 0x0000
455 #define SMB_DEVICESTATE_MESSAGEMODEPIPE 0x0400
456 #define SMB_DEVICESTATE_PIPECLIENTEND 0x0000
457 #define SMB_DEVICESTATE_PIPESERVEREND 0x4000
458 #define SMB_DEVICESTATE_BLOCKING 0x8000
460 /* for tracking in-progress directory searches */
461 typedef struct smb_dirSearch {
462 osi_queue_t q; /* queue of all outstanding cookies */
463 osi_mutex_t mx; /* just in case the caller screws up */
464 afs_int32 refCount; /* reference count */
465 long cookie; /* value returned to the caller */
466 struct cm_scache *scp; /* vnode of the dir we're searching */
467 time_t lastTime; /* last time we used this (osi_Time) */
468 long flags; /* flags (see below);
469 * locked by smb_globalLock */
470 unsigned short attribute; /* search attribute
471 * (used for extended protocol) */
472 clientchar_t tidPath[256]; /* tid path */
473 clientchar_t relPath[1024]; /* relative path */
474 clientchar_t mask[256]; /* search mask for V3 */
477 #define SMB_DIRSEARCH_DELETE 1 /* delete struct when ref count zero */
478 #define SMB_DIRSEARCH_HITEOF 2 /* perhaps useful for advisory later */
479 #define SMB_DIRSEARCH_SMALLID 4 /* cookie can only be 8 bits, not 16 */
480 #define SMB_DIRSEARCH_BULKST 8 /* get bulk stat info */
482 /* type for patching directory listings */
483 typedef struct smb_dirListPatch {
485 char *dptr; /* ptr to attr, time, data, sizel, sizeh */
486 long flags; /* flags. See below */
488 cm_dirEntry_t *dep; /* temp */
489 } smb_dirListPatch_t;
491 /* dirListPatch Flags */
492 #define SMB_DIRLISTPATCH_DOTFILE 1
493 /* the file referenced is a dot file
494 * Note: will not be set if smb_hideDotFiles is false
497 /* individual lock on a waiting lock request */
498 typedef struct smb_waitingLock {
501 LARGE_INTEGER LOffset;
502 LARGE_INTEGER LLength;
503 cm_file_lock_t * lockp;
507 #define SMB_WAITINGLOCKSTATE_WAITING 0
508 #define SMB_WAITINGLOCKSTATE_DONE 1
509 #define SMB_WAITINGLOCKSTATE_ERROR 2
510 #define SMB_WAITINGLOCKSTATE_CANCELLED 3
512 /* waiting lock request */
513 typedef struct smb_waitingLockRequest {
520 time_t start_t; /* osi_Time */
521 afs_uint32 msTimeout; /* msecs, 0xFFFFFFFF = wait forever */
522 smb_waitingLock_t * locks;
523 } smb_waitingLockRequest_t;
525 extern smb_waitingLockRequest_t *smb_allWaitingLocks;
527 typedef long (smb_proc_t)(smb_vc_t *vcp, smb_packet_t *inp, smb_packet_t *outp);
529 typedef struct smb_dispatch {
530 smb_proc_t *procp; /* proc to call */
531 int flags; /* flags describing function */
534 #define SMB_DISPATCHFLAG_CHAINED 1 /* this is an _AND_X function */
535 #define SMB_DISPATCHFLAG_NORESPONSE 2 /* don't send the response
536 * packet, typically because
537 * the response was already
540 #define SMB_MAX_PATH 260 /* max path length */
544 extern void smb_Init(osi_log_t *logp, int useV3,
549 extern void smb_DosUTimeFromUnixTime(afs_uint32 *dosUTimep, time_t unixTime);
551 extern void smb_UnixTimeFromDosUTime(time_t *unixTimep, afs_uint32 dosUTime);
553 extern void CompensateForSmbClientLastWriteTimeBugs(afs_uint32 *dosTimep);
555 #ifdef DEBUG_SMB_REFCOUNT
556 extern smb_vc_t *smb_FindVCDbg(unsigned short lsn, int flags, int lana, char *, long);
557 #define smb_FindVC(a,b,c) smb_FindVCDbg(a,b,c,__FILE__,__LINE__);
559 extern void smb_HoldVCDbg(smb_vc_t *vcp, char *, long);
560 #define smb_HoldVC(a) smb_HoldVCDbg(a,__FILE__,__LINE__);
562 extern void smb_HoldVCNoLockDbg(smb_vc_t *vcp, char *, long);
563 #define smb_HoldVCNoLock(a) smb_HoldVCNoLockDbg(a,__FILE__,__LINE__);
565 extern void smb_ReleaseVCDbg(smb_vc_t *vcp, char *, long);
566 #define smb_ReleaseVC(a) smb_ReleaseVCDbg(a,__FILE__,__LINE__);
568 extern void smb_ReleaseVCNoLockDbg(smb_vc_t *vcp, char *, long);
569 #define smb_ReleaseVCNoLock(a) smb_ReleaseVCNoLockDbg(a,__FILE__,__LINE__);
571 extern smb_vc_t *smb_FindVC(unsigned short lsn, int flags, int lana);
573 extern void smb_HoldVC(smb_vc_t *vcp);
575 extern void smb_HoldVCNoLock(smb_vc_t *vcp);
577 extern void smb_ReleaseVC(smb_vc_t *vcp);
579 extern void smb_ReleaseVCNoLock(smb_vc_t *vcp);
582 extern void smb_CleanupDeadVC(smb_vc_t *vcp);
584 extern void smb_MarkAllVCsDead(smb_vc_t *exclude_vcp);
586 #ifdef DEBUG_SMB_REFCOUNT
587 extern smb_tid_t *smb_FindTIDDbg(smb_vc_t *vcp, unsigned short tid, int flags, char *, long);
588 #define smb_FindTID(a,b,c) smb_FindTIDDbg(a,b,c,__FILE__,__LINE__);
590 extern void smb_HoldTIDNoLockDbg(smb_tid_t *tidp, char *, long);
591 #define smb_HoldTIDNoLock(a) smb_HoldTIDNoLockDbg(a,__FILE__,__LINE__);
593 extern void smb_ReleaseTIDDbg(smb_tid_t *tidp, afs_uint32 locked, char *, long);
594 #define smb_ReleaseTID(a,b) smb_ReleaseTIDDbg(a,b,__FILE__,__LINE__);
596 extern smb_tid_t *smb_FindTID(smb_vc_t *vcp, unsigned short tid, int flags);
598 extern void smb_HoldTIDNoLock(smb_tid_t *tidp);
600 extern void smb_ReleaseTID(smb_tid_t *tidp, afs_uint32 locked);
603 extern smb_user_t *smb_FindUID(smb_vc_t *vcp, unsigned short uid, int flags);
605 extern afs_int32 smb_userIsLocalSystem(smb_user_t *userp);
607 extern smb_username_t *smb_FindUserByName(clientchar_t *usern, clientchar_t *machine, afs_uint32 flags);
609 extern cm_user_t *smb_FindCMUserByName(clientchar_t *usern, clientchar_t *machine, afs_uint32 flags);
611 extern smb_user_t *smb_FindUserByNameThisSession(smb_vc_t *vcp, clientchar_t *usern);
613 extern void smb_ReleaseUsername(smb_username_t *unp);
615 extern void smb_HoldUIDNoLock(smb_user_t *uidp);
617 extern void smb_ReleaseUID(smb_user_t *uidp);
619 extern cm_user_t *smb_GetUserFromVCP(smb_vc_t *vcp, smb_packet_t *inp);
621 extern cm_user_t *smb_GetUserFromUID(smb_user_t *uidp);
623 extern long smb_LookupTIDPath(smb_vc_t *vcp, unsigned short tid, clientchar_t ** tidPathp);
625 #ifdef DEBUG_SMB_REFCOUNT
626 extern smb_fid_t *smb_FindFIDDbg(smb_vc_t *vcp, unsigned short fid, int flags, char *, long);
627 #define smb_FindFID(a,b,c) smb_FindFIDDbg(a,b,c,__FILE__,__LINE__);
629 extern smb_fid_t *smb_FindFIDByScacheDbg(smb_vc_t *vcp, cm_scache_t * scp, char *, long);
630 #define smb_FindFIDByScache(a,b) smb_FindFIDByScacheDbg(a,b,__FILE__,__LINE__);
632 extern void smb_HoldFIDNoLockDbg(smb_fid_t *fidp, char *, long);
633 #define smb_HoldFIDNoLock(a) smb_HoldFIDNoLockDbg(a,__FILE__,__LINE__);
635 extern void smb_ReleaseFIDDbg(smb_fid_t *fidp, char *, long);
636 #define smb_ReleaseFID(a) smb_ReleaseFIDDbg(a,__FILE__,__LINE__);
638 extern smb_fid_t *smb_FindFID(smb_vc_t *vcp, unsigned short fid, int flags);
640 extern smb_fid_t *smb_FindFIDByScache(smb_vc_t *vcp, cm_scache_t * scp);
642 extern void smb_HoldFIDNoLock(smb_fid_t *fidp);
644 extern void smb_ReleaseFID(smb_fid_t *fidp);
647 extern long smb_CloseFID(smb_vc_t *vcp, smb_fid_t *fidp, cm_user_t *userp,
650 extern int smb_FindShare(smb_vc_t *vcp, smb_user_t *uidp, clientchar_t *shareName, clientchar_t **pathNamep);
652 extern int smb_FindShareCSCPolicy(clientchar_t *shareName);
654 extern smb_dirSearch_t *smb_FindDirSearchNL(long cookie);
656 extern void smb_DeleteDirSearch(smb_dirSearch_t *dsp);
658 extern void smb_ReleaseDirSearch(smb_dirSearch_t *dsp);
660 extern smb_dirSearch_t *smb_FindDirSearch(long cookie);
662 extern smb_dirSearch_t *smb_NewDirSearch(int isV3);
664 extern smb_packet_t *smb_CopyPacket(smb_packet_t *packetp);
666 extern void smb_FreePacket(smb_packet_t *packetp);
668 extern unsigned char *smb_GetSMBData(smb_packet_t *smbp, int *nbytesp);
670 extern void smb_SetSMBDataLength(smb_packet_t *smbp, unsigned int dsize);
672 extern unsigned short smb_GetSMBParm(smb_packet_t *smbp, int parm);
674 extern unsigned char smb_GetSMBParmByte(smb_packet_t *smbp, int parm);
676 extern unsigned int smb_GetSMBParmLong(smb_packet_t *smbp, int parm);
678 extern unsigned int smb_GetSMBOffsetParm(smb_packet_t *smbp, int parm, int offset);
680 extern void smb_SetSMBParm(smb_packet_t *smbp, int slot, unsigned int parmValue);
682 extern void smb_SetSMBParmLong(smb_packet_t *smbp, int slot, unsigned int parmValue);
684 extern void smb_SetSMBParmDouble(smb_packet_t *smbp, int slot, char *parmValuep);
686 extern void smb_SetSMBParmByte(smb_packet_t *smbp, int slot, unsigned int parmValue);
688 extern void smb_StripLastComponent(clientchar_t *outPathp, clientchar_t **lastComponentp,
689 clientchar_t *inPathp);
691 #define SMB_STRF_FORCEASCII (1<<0)
692 #define SMB_STRF_ANSIPATH (1<<1)
693 #define SMB_STRF_IGNORENUL (1<<2)
694 #define SMB_STRF_SRCNULTERM (1<<3)
696 extern clientchar_t *smb_ParseASCIIBlock(smb_packet_t * pktp, unsigned char *inp,
697 char **chainpp, int flags);
699 extern clientchar_t *smb_ParseString(smb_packet_t * pktp, unsigned char * inp,
700 char ** chainpp, int flags);
702 extern clientchar_t *smb_ParseStringBuf(const unsigned char * bufbase,
703 cm_space_t ** stringspp,
704 unsigned char *inp, size_t *pcb_max,
705 char **chainpp, int flags);
707 extern clientchar_t *smb_ParseStringCb(smb_packet_t * pktp, unsigned char * inp,
708 size_t cb, char ** chainpp, int flags);
710 extern clientchar_t *smb_ParseStringCch(smb_packet_t * pktp, unsigned char * inp,
711 size_t cch, char ** chainpp, int flags);
713 extern unsigned char * smb_UnparseString(smb_packet_t * pktp, unsigned char * outp,
715 size_t * plen, int flags);
717 extern unsigned char *smb_ParseVblBlock(unsigned char *inp, char **chainpp,
720 extern smb_packet_t *smb_GetResponsePacket(smb_vc_t *vcp, smb_packet_t *inp);
722 extern void smb_SendPacket(smb_vc_t *vcp, smb_packet_t *inp);
724 extern void smb_MapCoreError(long code, smb_vc_t *vcp, unsigned short *scodep,
725 unsigned char *classp);
727 extern void smb_MapNTError(long code, unsigned long *NTStatusp);
729 extern void smb_MapWin32Error(long code, unsigned long *Win32Ep);
731 /* some globals, too */
732 extern char *smb_localNamep;
734 extern osi_log_t *smb_logp;
736 extern osi_rwlock_t smb_globalLock;
738 extern osi_rwlock_t smb_rctLock;
740 extern int smb_LogoffTokenTransfer;
741 extern time_t smb_LogoffTransferTimeout;
743 extern int smb_maxVCPerServer; /* max # of VCs per server */
744 extern int smb_maxMpxRequests; /* max # of mpx requests */
746 extern int smb_StoreAnsiFilenames;
747 extern int smb_hideDotFiles;
748 extern unsigned int smb_IsDotFile(clientchar_t *lastComp);
749 extern afs_uint32 smb_AsyncStore;
750 extern afs_uint32 smb_AsyncStoreSize;
752 /* the following are used for smb auth */
753 extern int smb_authType; /* Type of SMB authentication to be used. One from below. */
755 #define SMB_AUTH_NONE 0
756 #define SMB_AUTH_NTLM 1
757 #define SMB_AUTH_EXTENDED 2
759 extern HANDLE smb_lsaHandle; /* LSA handle obtained during smb_init if using SMB auth */
760 extern ULONG smb_lsaSecPackage; /* LSA security package id. Set during smb_init */
761 extern clientchar_t smb_ServerDomainName[];
762 extern int smb_ServerDomainNameLength;
763 extern clientchar_t smb_ServerOS[];
764 extern int smb_ServerOSLength;
765 extern clientchar_t smb_ServerLanManager[];
766 extern int smb_ServerLanManagerLength;
767 extern GUID smb_ServerGUID;
768 extern LSA_STRING smb_lsaLogonOrigin;
769 extern LONG smb_UseUnicode;
770 extern DWORD smb_monitorReqs;
772 /* used for getting a challenge for SMB auth */
773 typedef struct _MSV1_0_LM20_CHALLENGE_REQUEST {
774 MSV1_0_PROTOCOL_MESSAGE_TYPE MessageType;
775 } MSV1_0_LM20_CHALLENGE_REQUEST, *PMSV1_0_LM20_CHALLENGE_REQUEST;
777 typedef struct _MSV1_0_LM20_CHALLENGE_RESPONSE {
778 MSV1_0_PROTOCOL_MESSAGE_TYPE MessageType;
779 UCHAR ChallengeToClient[MSV1_0_CHALLENGE_LENGTH];
780 } MSV1_0_LM20_CHALLENGE_RESPONSE, *PMSV1_0_LM20_CHALLENGE_RESPONSE;
783 extern long smb_AuthenticateUserLM(smb_vc_t *vcp, clientchar_t * accountName, clientchar_t * primaryDomain, char * ciPwd, unsigned ciPwdLength, char * csPwd, unsigned csPwdLength);
785 extern long smb_GetNormalizedUsername(clientchar_t * usern, const clientchar_t * accountName, const clientchar_t * domainName);
787 extern void smb_FormatResponsePacket(smb_vc_t *vcp, smb_packet_t *inp,
790 extern char *myCrt_Dispatch(int i);
792 extern char *myCrt_2Dispatch(int i);
794 extern char *myCrt_RapDispatch(int i);
796 extern char * myCrt_NmpipeDispatch(int i);
798 extern unsigned int smb_Attributes(cm_scache_t *scp);
800 extern int smb_ChainFID(int fid, smb_packet_t *inp);
802 extern unsigned char *smb_ParseDataBlock(unsigned char *inp, char **chainpp, int *lengthp);
804 extern unsigned char *smb_ParseVblBlock(unsigned char *inp, char **chainpp, int *lengthp);
806 extern int smb_SUser(cm_user_t *userp);
808 long smb_WriteData(smb_fid_t *fidp, osi_hyper_t *offsetp, afs_uint32 count, char *op,
809 cm_user_t *userp, long *writtenp);
811 extern long smb_ReadData(smb_fid_t *fidp, osi_hyper_t *offsetp, afs_uint32 count,
812 char *op, cm_user_t *userp, long *readp);
814 extern long smb_Rename(smb_vc_t *vcp, smb_packet_t *inp, clientchar_t *oldPathp, clientchar_t *newPathp, int attrs);
816 extern long smb_Link(smb_vc_t *vcp, smb_packet_t *inp, clientchar_t *oldPathp, clientchar_t *newPathp);
818 extern BOOL smb_IsLegalFilename(clientchar_t *filename);
820 extern char *smb_GetSharename(void);
822 extern DWORD smb_ServerExceptionFilter(void);
824 extern void smb_RestartListeners(int);
825 extern void smb_StopListeners(int);
826 extern void smb_StopListener(NCB *ncbp, int lana, int wait);
827 extern long smb_IsNetworkStarted(void);
828 extern void smb_LanAdapterChange(int);
829 extern void smb_SetLanAdapterChangeDetected(void);
831 extern void smb_InitReq(cm_req_t *reqp);
833 #define SMB_LISTENER_UNINITIALIZED -1
834 #define SMB_LISTENER_STOPPED 0
835 #define SMB_LISTENER_STARTED 1
837 /* include other include files */
839 #include "smb_ioctl.h"
840 #include "smb_iocons.h"
842 #include "cm_vnodeops.h"
844 extern int smb_unixModeDefaultFile;
845 extern int smb_unixModeDefaultDir;
846 extern void smb_SetInitialModeBitsForFile(int smb_attr, cm_attr_t * attr);
847 extern void smb_SetInitialModeBitsForDir(int smb_attr, cm_attr_t * attr);
849 cm_user_t *smb_FindOrCreateUser(smb_vc_t *vcp, clientchar_t *usern);
851 int smb_DumpVCP(FILE *outputFile, char *cookie, int lock);
853 void smb_Shutdown(void);
856 extern void smb_LogPacket(smb_packet_t *packet);
857 #endif /* NOTSERVICE */
859 #ifndef MSV1_0_OPTION_ALLOW_BLANK_PASSWORD
860 #define MSV1_0_OPTION_ALLOW_BLANK_PASSWORD 0x1
861 #define MSV1_0_OPTION_DISABLE_ADMIN_LOCKOUT 0x2
862 #define MSV1_0_OPTION_DISABLE_FORCE_GUEST 0x4
863 #define MSV1_0_OPTION_TRY_CACHE_FIRST 0x10
865 typedef struct _MSV1_0_SETPROCESSOPTION_REQUEST {
866 MSV1_0_PROTOCOL_MESSAGE_TYPE MessageType;
867 ULONG ProcessOptions;
868 BOOLEAN DisableOptions;
869 } MSV1_0_SETPROCESSOPTION_REQUEST, *PMSV1_0_SETPROCESSOPTION_REQUEST;
872 #endif /* whole file */