windows-volume-status-plugin-20070705
[openafs.git] / src / WINNT / afsd / smb.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
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
8  */
9
10 #ifndef __SMB_H_ENV__
11 #define __SMB_H_ENV__ 1
12
13 #if _WIN32_WINNT < 0x0501
14 #undef _WIN32_WINNT
15 #define _WIN32_WINNT 0x0501
16 #endif
17 #include <ntsecapi.h>
18
19 /* Support largefiles by default */
20 #define AFS_LARGEFILES
21
22 /* basic core protocol SMB structure */
23 #pragma pack(push, 1)
24 typedef struct smb {
25     unsigned char id[4];
26     unsigned char com;
27     unsigned char rcls;
28     unsigned char reh;
29     unsigned char errLow;
30     unsigned char errHigh;
31     unsigned char reb;
32     unsigned short flg2;
33     unsigned short res[6];
34     unsigned short tid;
35     unsigned short pid;
36     unsigned short uid;
37     unsigned short mid;
38     unsigned char wct;
39     unsigned char vdata[1];
40 } smb_t;
41 #pragma pack(pop)
42
43 /* reb values */
44 #define SMB_FLAGS_SUPPORT_LOCKREAD         0x01
45 #define SMB_FLAGS_CLIENT_BUF_AVAIL         0x02
46 #define SMB_FLAGS_CASELESS_PATHNAMES       0x08
47 #define SMB_FLAGS_CANONICAL_PATHNAMES      0x10
48 #define SMB_FLAGS_REQUEST_OPLOCK           0x20
49 #define SMB_FLAGS_REQUEST_BATCH_OPLOCK     0x40
50 #define SMB_FLAGS_SERVER_TO_CLIENT         0x80           
51
52 /* flg2 values */
53
54 #define SMB_FLAGS2_KNOWS_LONG_NAMES        0x0001
55 #define SMB_FLAGS2_KNOWS_EAS               0x0002
56 #define SMB_FLAGS2_SECURITY_SIGNATURE      0x0004
57 #define SMB_FLAGS2_RESERVED1               0x0008
58 #define SMB_FLAGS2_IS_LONG_NAME            0x0040
59 #define SMB_FLAGS2_EXT_SEC                 0x0800
60 #define SMB_FLAGS2_DFS_PATHNAMES           0x1000
61 #define SMB_FLAGS2_PAGING_IO               0x2000
62 #define SMB_FLAGS2_32BIT_STATUS            0x4000
63 #define SMB_FLAGS2_UNICODE                 0x8000
64
65 #define KNOWS_LONG_NAMES(inp) ((((smb_t *)inp)->flg2 & SMB_FLAGS2_KNOWS_LONG_NAMES)?1:0)
66 #define WANTS_DFS_PATHNAMES(inp) ((((smb_t *)inp)->flg2 & SMB_FLAGS2_DFS_PATHNAMES)?1:0)
67
68 /* Information Levels */
69 #define SMB_INFO_STANDARD               1
70 #define SMB_INFO_QUERY_EA_SIZE          2
71 #define SMB_INFO_QUERY_EAS_FROM_LIST    3
72 #define SMB_INFO_QUERY_ALL_EAS          4
73 #define SMB_INFO_IS_NAME_VALID          6
74
75 #define SMB_QUERY_FILE_BASIC_INFO       0x101
76 #define SMB_QUERY_FILE_STANDARD_INFO    0x102
77 #define SMB_QUERY_FILE_EA_INFO          0x103
78 #define SMB_QUERY_FILE_NAME_INFO        0x104
79 #define SMB_QUERY_FILE_ALL_INFO         0x107
80 #define SMB_QUERY_FILE_ALT_NAME_INFO    0x108
81 #define SMB_QUERY_FILE_STREAM_INFO      0x109
82 #define SMB_QUERY_FILE_COMPRESSION_INFO 0x10B
83 #define SMB_QUERY_FILE_UNIX_BASIC       0x200
84 #define SMB_QUERY_FILE_UNIX_LINK        0x201
85 #define SMB_INFO_PASSTHROUGH           0x1000
86
87 #define SMB_SET_FILE_BASIC_INFO         0x101
88 #define SMB_SET_FILE_DISPOSITION_INFO   0x102
89 #define SMB_SET_FILE_ALLOCATION_INFO    0x103
90 #define SMB_SET_FILE_END_OF_FILE_INFO   0x104
91 #define SMB_SET_FILE_UNIX_BASIC         0x200
92 #define SMB_SET_FILE_UNIX_LINK          0x201
93 #define SMB_SET_FILE_UNIX_HLINK         0x203
94
95 #define SMB_INFO_ALLOCATION             1
96 #define SMB_INFO_VOLUME                 2
97 #define SMB_QUERY_FS_LABEL_INFO         0x101
98 #define SMB_QUERY_FS_VOLUME_INFO        0x102
99 #define SMB_QUERY_FS_SIZE_INFO          0x103
100 #define SMB_QUERY_FS_DEVICE_INFO        0x104
101 #define SMB_QUERY_FS_ATTRIBUTE_INFO     0x105
102 #define SMB_QUERY_FS_QUOTA_INFO         0x106
103 #define SMB_QUERY_FS_CONTROL_INFO       0x107
104 #define SMB_INFO_UNIX                   0x200
105 #define SMB_INFO_MACOS                  0x301
106
107 #define SMB_FIND_FILE_DIRECTORY_INFO      0x101
108 #define SMB_FIND_FILE_FULL_DIRECTORY_INFO 0x102
109 #define SMB_FIND_FILE_NAMES_INFO          0x103
110 #define SMB_FIND_FILE_BOTH_DIRECTORY_INFO 0x104
111
112 /* more defines */
113 #define SMB_NOPCODES            256     /* # of opcodes in the dispatch table */
114
115 /* threads per VC */
116 #define SMB_THREADSPERVC        4       /* threads per VC */
117
118 /* flags for functions */
119 #define SMB_FLAG_CREATE         1       /* create the structure if necessary */
120 #define SMB_FLAG_AFSLOGON       2       /* operating on behalf of afslogon.dll */
121
122 /* max # of bytes we'll receive in an incoming SMB message */
123 /* the maximum is 2^18-1 for NBT and 2^25-1 for Raw transport messages */
124 /* we will use something smaller but large enough to be efficient */
125 #define SMB_PACKETSIZE  32768 /* was 8400 */
126 /* raw mode is considered obsolete and cannot be used with message signing */
127 #define SMB_MAXRAWSIZE  65536
128
129 /* Negotiate protocol constants */
130 /* Security */
131 #define NEGOTIATE_SECURITY_USER_LEVEL               0x01
132 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE       0x02
133 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED       0x04
134 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED      0x08
135
136 /* Capabilities */
137 #define NTNEGOTIATE_CAPABILITY_RAWMODE                  0x00000001L
138 #define NTNEGOTIATE_CAPABILITY_MPXMODE                  0x00000002L
139 #define NTNEGOTIATE_CAPABILITY_UNICODE                  0x00000004L
140 #define NTNEGOTIATE_CAPABILITY_LARGEFILES               0x00000008L
141 #define NTNEGOTIATE_CAPABILITY_NTSMB                    0x00000010L
142 #define NTNEGOTIATE_CAPABILITY_RPCAPI                   0x00000020L
143 #define NTNEGOTIATE_CAPABILITY_NTSTATUS                 0x00000040L
144 #define NTNEGOTIATE_CAPABILITY_LEVEL_II_OPLOCKS         0x00000080L
145 #define NTNEGOTIATE_CAPABILITY_LOCK_AND_READ            0x00000100L
146 #define NTNEGOTIATE_CAPABILITY_NTFIND                   0x00000200L
147 #define NTNEGOTIATE_CAPABILITY_DFS                      0x00001000L
148 #define NTNEGOTIATE_CAPABILITY_NT_INFO_PASSTHRU         0x00002000L
149 #define NTNEGOTIATE_CAPABILITY_LARGE_READX              0x00004000L
150 #define NTNEGOTIATE_CAPABILITY_LARGE_WRITEX             0x00008000L
151 #define NTNEGOTIATE_CAPABILITY_UNIX                     0x00800000L
152 #define NTNEGOTIATE_CAPABILITY_BULK_TRANSFER            0x20000000L
153 #define NTNEGOTIATE_CAPABILITY_COMPRESSED               0x40000000L
154 #define NTNEGOTIATE_CAPABILITY_EXTENDED_SECURITY        0x80000000L
155
156 /* a packet structure for receiving SMB messages; locked by smb_globalLock.
157  * Most of the work involved is in handling chained requests and responses.
158  *
159  * When handling input, inWctp points to the current request's wct field (and
160  * the other parameters and request data can be found from this field).  The
161  * opcode, unfortunately, isn't available there, so is instead copied to the
162  * packet's inCom field.  It is initially set to com, but each chained
163  * operation sets it, also.
164  * The function smb_AdvanceInput advances an input packet to the next request
165  * in the chain.  The inCom field is set to 0xFF when there are no more
166  * requests.  The inCount field is 0 if this is the first request, and
167  * otherwise counts which request it is.
168  *
169  * When handling output, we also have to chain all of the responses together.
170  * The function smb_GetResponsePacket will setup outWctp to point to the right
171  * place.
172  */
173 #define SMB_PACKETMAGIC 0x7436353       /* magic # for packets */
174 typedef struct smb_packet {
175     char data[SMB_PACKETSIZE];
176     struct smb_packet *nextp;           /* in free list, or whatever */
177     long magic;
178     cm_space_t *spacep;                 /* use this for stripping last component */
179     NCB *ncbp;                          /* use this for sending */
180     struct smb_vc *vcp;
181     unsigned long resumeCode;
182     unsigned short inCount;
183     unsigned short fid;                 /* for calls bundled with openAndX */
184     unsigned char *wctp;
185     unsigned char inCom;
186     unsigned char oddByte;
187     unsigned short ncb_length;
188     unsigned char flags;
189 } smb_packet_t;
190
191 /* smb_packet flags */
192 #define SMB_PACKETFLAG_NOSEND                   1
193 #define SMB_PACKETFLAG_SUSPENDED                2
194
195 /* a structure for making Netbios calls; locked by smb_globalLock */
196 #define SMB_NCBMAGIC    0x2334344
197 typedef struct myncb {
198     NCB ncb;                            /* ncb to use */
199     struct myncb *nextp;                /* when on free list */
200     long magic;
201 } smb_ncb_t;
202
203 /* structures representing environments from kernel / SMB network.
204  * Most have their own locks, but the tree connection fields and
205  * reference counts are locked by the smb_rctLock.  Those fields will
206  * be marked in comments.
207  */
208
209 /* one per virtual circuit */
210 typedef struct smb_vc {
211     struct smb_vc *nextp;               /* not used */
212     afs_uint32 magic;                   /* a magic value to detect bad entries */
213     unsigned long refCount;             /* the reference count */
214     long flags;                         /* the flags, if any; locked by mx */
215     osi_mutex_t mx;                     /* the mutex */
216     long vcID;                          /* VC id */
217     unsigned short lsn;                 /* the NCB LSN associated with this */
218     unsigned short uidCounter;          /* session ID counter */
219     unsigned short tidCounter;          /* tree ID counter */
220     unsigned short fidCounter;          /* file handle ID counter */
221     struct smb_tid *tidsp;              /* the first child in the tid list */
222     struct smb_user *usersp;            /* the first child in the user session list */
223     struct smb_fid *fidsp;              /* the first child in the open file list */
224     unsigned char errorCount;
225     char rname[17];
226     int lana;
227     char encKey[MSV1_0_CHALLENGE_LENGTH]; /* MSV1_0_CHALLENGE_LENGTH is 8 */
228     void * secCtx;                      /* security context when negotiating SMB extended auth
229                                          * valid when SMB_VCFLAG_AUTH_IN_PROGRESS is set
230                                          */
231     unsigned short session;             /* This is the Session Index associated with the NCBs */
232 } smb_vc_t;
233
234 #define SMB_VC_MAGIC ('S' | 'C'<<8 | 'A'<<16 | 'C'<<24)
235                                         /* have we negotiated ... */
236 #define SMB_VCFLAG_USEV3        1       /* ... version 3 of the protocol */
237 #define SMB_VCFLAG_USECORE      2       /* ... the core protocol */
238 #define SMB_VCFLAG_USENT        4       /* ... NT LM 0.12 or beyond */
239 #define SMB_VCFLAG_STATUS32     8       /* use 32-bit NT status codes */
240 #define SMB_VCFLAG_REMOTECONN   0x10    /* bad: remote conns not allowed */
241 #define SMB_VCFLAG_ALREADYDEAD  0x20    /* do not get tokens from this vc */
242 #define SMB_VCFLAG_SESSX_RCVD   0x40    /* we received at least one session setups on this vc */
243 #define SMB_VCFLAG_AUTH_IN_PROGRESS 0x80 /* a SMB NT extended authentication is in progress */
244 #define SMB_VCFLAG_CLEAN_IN_PROGRESS 0x100
245
246 /* one per user session */
247 typedef struct smb_user {
248     struct smb_user *nextp;             /* next sibling */
249     unsigned long refCount;             /* ref count */
250     afs_uint32 flags;                   /* flags; locked by mx */
251     osi_mutex_t mx;
252     unsigned short userID;              /* the session identifier */
253     struct smb_vc *vcp;                 /* back ptr to virtual circuit */
254     struct smb_username *unp;           /* user name struct */
255     afs_uint32  delete;                 /* ok to del: locked by smb_rctLock */
256 } smb_user_t;
257
258 #define SMB_USERFLAG_DELETE         1   /* delete struct when ref count zero */
259
260 typedef struct smb_username {
261     struct smb_username *nextp;         /* next sibling */
262     unsigned long refCount;             /* ref count */
263     long flags;                         /* flags; locked by mx */
264     osi_mutex_t mx;
265     struct cm_user *userp;              /* CM user structure */
266     char *name;                         /* user name */
267     char *machine;                      /* machine name */
268     time_t last_logoff_t;               /* most recent logoff time */
269 } smb_username_t;
270
271 /* The SMB_USERNAMEFLAG_AFSLOGON is used to preserve the existence of an 
272  * smb_username_t even when the refCount is zero.  This is used to ensure
273  * that tokens set to a username during the integrated logon process are 
274  * preserved until the SMB Session that will require the tokens is created.
275  * The cm_IoctlSetTokens() function when executed from the Network Provider
276  * connects to the AFS Client Service using the credentials of the machine
277  * and not the user for whom the tokens are being configured. */
278 #define SMB_USERNAMEFLAG_AFSLOGON   1
279
280 /* The SMB_USERNAMEFLAG_LOGOFF is used to indicate that the user most
281  * recently logged off at 'last_logoff_t'.  The smb_username_t should not
282  * be deleted even if the refCount is zero before 'last_logoff_t' + 
283  * 'smb_LogoffTransferTimeout' if 'smb_LogoffTokenTransfer' is non-zero.
284  * The smb_Daemon() thread is responsible for purging the expired objects */
285
286 #define SMB_USERNAMEFLAG_LOGOFF     2
287
288 #define SMB_MAX_USERNAME_LENGTH 256
289
290 /* one per tree-connect */
291 typedef struct smb_tid {
292     struct smb_tid *nextp;              /* next sibling */
293     unsigned long refCount;
294     afs_uint32 flags;                   /* protected by mx */
295     osi_mutex_t mx;                     /* for non-tree-related stuff */
296     unsigned short tid;                 /* the tid */
297     struct smb_vc *vcp;                 /* back ptr */
298     struct cm_user *userp;              /* user logged in at the
299                                          * tree connect level (base) */
300     char *pathname;                     /* pathname derived from sharename */
301     afs_uint32  delete;                 /* ok to del: locked by smb_rctLock */
302 } smb_tid_t;
303
304 #define SMB_TIDFLAG_IPC         1       /* IPC$ */
305
306 /* one per process ID */
307 typedef struct smb_pid {
308     struct smb_pid *nextp;              /* next sibling */
309     unsigned long refCount;
310     long flags;
311     osi_mutex_t mx;                     /* for non-tree-related stuff */
312     unsigned short pid;                 /* the pid */
313     struct smb_tid *tidp;               /* back ptr */
314 } smb_pid_t;
315
316 /* ioctl parameter, while being assembled and/or processed */
317 typedef struct smb_ioctl {
318     /* input side */
319     char *inDatap;                      /* ioctl func's current position
320                                          * in input parameter block */
321     char *inAllocp;                     /* allocated input parameter block */
322     long inCopied;                      /* # of input bytes copied in so far
323                                          * by write calls */
324     cm_space_t *prefix;                 /* prefix for subst drives */
325     char *tidPathp;                     /* Pathname associated with Tree ID */
326
327     /* output side */
328     char *outDatap;                     /* output results assembled so far */
329     char *outAllocp;                    /* output results assembled so far */
330     long outCopied;                     /* # of output bytes copied back so far
331                                          * by read calls */
332         
333     /* flags */
334     long flags;
335
336     /* fid pointer */
337     struct smb_fid *fidp;
338
339     /* uid pointer */
340     smb_user_t *uidp;
341 } smb_ioctl_t;
342
343 /* flags for smb_ioctl_t */
344 #define SMB_IOCTLFLAG_DATAIN    1       /* reading data from client to server */
345 #define SMB_IOCTLFLAG_LOGON     2       /* got tokens from integrated logon */
346
347 /* one per file ID; these are really file descriptors */
348 typedef struct smb_fid {
349     osi_queue_t q;
350     unsigned long refCount;
351     afs_uint32 flags;                   /* protected by mx */
352     osi_mutex_t mx;                     /* for non-tree-related stuff */
353     unsigned short fid;                 /* the file ID */
354     struct smb_vc *vcp;                 /* back ptr */
355     struct cm_scache *scp;              /* scache of open file */
356     struct cm_user *userp;              /* user that opened the file
357                                            originally (used to close
358                                            the file if session is
359                                            terminated) */
360     osi_hyper_t offset;                 /* our file pointer */
361     smb_ioctl_t *ioctlp;                /* ptr to ioctl structure */
362                                         /* Under NT, we may need to know the
363                                          * parent directory and pathname used
364                                          * to open the file, either to delete
365                                          * the file on close, or to do a
366                                          * change notification */
367     struct cm_scache *NTopen_dscp;      /* parent directory (NT) */
368     char *NTopen_pathp;                 /* path used in open (NT) */
369     char *NTopen_wholepathp;            /* entire path, not just last name */
370     int curr_chunk;                     /* chunk being read */
371     int prev_chunk;                     /* previous chunk read */
372     int raw_writers;                    /* pending async raw writes */
373     EVENT_HANDLE raw_write_event;       /* signal this when raw_writers zero */
374     afs_uint32  delete;                 /* ok to del: locked by smb_rctLock */
375 } smb_fid_t;
376
377 #define SMB_FID_OPENREAD_LISTDIR        1       /* open for reading / listing directory */
378 #define SMB_FID_OPENWRITE               2       /* open for writing */
379 #define SMB_FID_CREATED                 4       /* a new file */
380 #define SMB_FID_IOCTL                   8       /* a file descriptor for the
381                                                  * magic ioctl file */
382 #define SMB_FID_OPENDELETE              0x10    /* open for deletion (NT) */
383 #define SMB_FID_DELONCLOSE              0x20    /* marked for deletion */
384
385 /*
386  * Now some special flags to work around a bug in NT Client
387  */
388 #define SMB_FID_LENGTHSETDONE           0x40    /* have done 0-length write */
389 #define SMB_FID_MTIMESETDONE            0x80    /* have set modtime via Tr2 */
390 #define SMB_FID_LOOKSLIKECOPY   (SMB_FID_LENGTHSETDONE | SMB_FID_MTIMESETDONE)
391 #define SMB_FID_NTOPEN                  0x100   /* have dscp and pathp */
392 #define SMB_FID_SEQUENTIAL              0x200
393 #define SMB_FID_RANDOM                  0x400
394
395 #define SMB_FID_SHARE_READ              0x1000
396 #define SMB_FID_SHARE_WRITE             0x2000
397
398 #define SMB_FID_QLOCK_HIGH              0x7f000000
399 #define SMB_FID_QLOCK_LOW               0x00000000
400 #define SMB_FID_QLOCK_LENGTH            1
401 #define SMB_FID_QLOCK_PID               0
402
403 /*
404  * SMB file attributes (16-bit)
405  */
406 #define SMB_ATTR_READONLY       0x0001
407 #define SMB_ATTR_HIDDEN         0x0002 /* hidden file for the purpose of dir listings */
408 #define SMB_ATTR_SYSTEM         0x0004
409 #define SMB_ATTR_VOLUMEID       0x0008 /* obsolete */
410 #define SMB_ATTR_DIRECTORY      0x0010
411 #define SMB_ATTR_ARCHIVE        0x0020
412 #define SMB_ATTR_DEVICE         0x0040
413
414 /* the following are Extended File Attributes (32-bit) */
415 #define SMB_ATTR_NORMAL         0x0080 /* normal file. Only valid if used alone */
416 #define SMB_ATTR_TEMPORARY      0x0100
417 #define SMB_ATTR_SPARSE_FILE    0x0200 /* used with dfs links */
418 #define SMB_ATTR_REPARSE_POINT  0x0400
419 #define SMB_ATTR_COMPRESSED     0x0800 /* file or dir is compressed */
420 #define SMB_ATTR_OFFLINE        0x1000
421 #define SMB_ATTR_NOT_CONTENT_INDEXED 0x2000
422 #define SMB_ATTR_ENCRYPTED      0x4000
423 #define SMB_ATTR_POSIX_SEMANTICS        0x01000000
424 #define SMB_ATTR_BACKUP_SEMANTICS       0x02000000
425 #define SMB_ATTR_DELETE_ON_CLOSE        0x04000000
426 #define SMB_ATTR_SEQUENTIAL_SCAN        0x08000000
427 #define SMB_ATTR_RANDOM_ACCESS          0x10000000
428 #define SMB_ATTR_NO_BUFFERING           0x20000000
429 #define SMB_ATTR_WRITE_THROUGH          0x80000000
430
431 #define LOCKING_ANDX_SHARED_LOCK        0x01 /* Read-only lock */
432 #define LOCKING_ANDX_OPLOCK_RELEASE     0x02 /* Oplock break notification */
433 #define LOCKING_ANDX_CHANGE_LOCKTYPE    0x04 /* Change lock type */
434 #define LOCKING_ANDX_CANCEL_LOCK        0x08 /* Cancel outstanding request */
435 #define LOCKING_ANDX_LARGE_FILES        0x10 /* Large file locking format */
436
437 /* for tracking in-progress directory searches */
438 typedef struct smb_dirSearch {
439     osi_queue_t q;                      /* queue of all outstanding cookies */
440     osi_mutex_t mx;                     /* just in case the caller screws up */
441     unsigned long refCount;             /* reference count */
442     long cookie;                        /* value returned to the caller */
443     struct cm_scache *scp;              /* vnode of the dir we're searching */
444     time_t lastTime;                    /* last time we used this (osi_Time) */
445     long flags;                         /* flags (see below);
446                                          * locked by smb_globalLock */
447     unsigned short attribute;           /* search attribute
448                                          * (used for extended protocol) */
449     char mask[256];                     /* search mask for V3 */
450 } smb_dirSearch_t;
451
452 #define SMB_DIRSEARCH_DELETE    1       /* delete struct when ref count zero */
453 #define SMB_DIRSEARCH_HITEOF    2       /* perhaps useful for advisory later */
454 #define SMB_DIRSEARCH_SMALLID   4       /* cookie can only be 8 bits, not 16 */
455 #define SMB_DIRSEARCH_BULKST    8       /* get bulk stat info */
456
457 /* type for patching directory listings */
458 typedef struct smb_dirListPatch {
459     osi_queue_t q;
460     char *dptr;                         /* ptr to attr, time, data, sizel, sizeh */
461     long flags;                         /* flags.  See below */
462     cm_fid_t fid;
463     cm_dirEntry_t *dep;                 /* temp */
464 } smb_dirListPatch_t;
465
466 /* dirListPatch Flags */
467 #define SMB_DIRLISTPATCH_DOTFILE 1  
468 /* the file referenced is a dot file
469  * Note: will not be set if smb_hideDotFiles is false 
470  */
471
472 /* individual lock on a waiting lock request */
473 typedef struct smb_waitingLock {
474     osi_queue_t      q;
475     cm_key_t         key;
476     LARGE_INTEGER    LOffset;
477     LARGE_INTEGER    LLength;
478     cm_file_lock_t * lockp;
479     int              state;
480 } smb_waitingLock_t;
481
482 #define SMB_WAITINGLOCKSTATE_WAITING 0
483 #define SMB_WAITINGLOCKSTATE_DONE    1
484 #define SMB_WAITINGLOCKSTATE_ERROR   2
485
486 /* waiting lock request */
487 typedef struct smb_waitingLockRequest {
488     osi_queue_t   q;
489     smb_vc_t *    vcp;
490     cm_scache_t * scp;
491     smb_packet_t *inp;
492     smb_packet_t *outp;
493     int           lockType;
494     time_t        timeRemaining;
495     smb_waitingLock_t * locks;
496 } smb_waitingLockRequest_t;
497
498 extern smb_waitingLockRequest_t *smb_allWaitingLocks;
499
500 typedef long (smb_proc_t)(smb_vc_t *vcp, smb_packet_t *inp, smb_packet_t *outp);
501
502 typedef struct smb_dispatch {
503     smb_proc_t *procp;                  /* proc to call */
504     int flags;                          /* flags describing function */
505 } smb_dispatch_t;
506
507 #define SMB_DISPATCHFLAG_CHAINED        1       /* this is an _AND_X function */
508 #define SMB_DISPATCHFLAG_NORESPONSE     2       /* don't send the response
509                                                  * packet, typically because
510                                                  * the response was already
511                                                  * sent.
512                                                  */
513 #define SMB_MAX_PATH                    256     /* max path length */
514
515 /* prototypes */
516
517 extern void smb_Init(osi_log_t *logp, int useV3,
518         int nThreads
519         , void *aMBfunc
520   );
521
522 extern void smb_LargeSearchTimeFromUnixTime(FILETIME *largeTimep, time_t unixTime);
523
524 extern void smb_UnixTimeFromLargeSearchTime(time_t *unixTimep, FILETIME *largeTimep);
525
526 extern void smb_SearchTimeFromUnixTime(afs_uint32 *searchTimep, time_t unixTime);
527
528 extern void smb_UnixTimeFromSearchTime(time_t *unixTimep, afs_uint32 searchTime);
529
530 extern void smb_DosUTimeFromUnixTime(afs_uint32 *dosUTimep, time_t unixTime);
531
532 extern void smb_UnixTimeFromDosUTime(time_t *unixTimep, afs_uint32 dosUTime);
533
534 extern void CompensateForSmbClientLastWriteTimeBugs(afs_uint32 *dosTimep);
535
536 extern smb_vc_t *smb_FindVC(unsigned short lsn, int flags, int lana);
537
538 extern void smb_CleanupDeadVC(smb_vc_t *vcp);
539
540 extern void smb_ReleaseVC(smb_vc_t *vcp);
541
542 extern void smb_ReleaseVCNoLock(smb_vc_t *vcp);
543
544 extern smb_tid_t *smb_FindTID(smb_vc_t *vcp, unsigned short tid, int flags);
545
546 extern void smb_HoldTIDNoLock(smb_tid_t *tidp);
547
548 extern void smb_ReleaseTID(smb_tid_t *tidp);
549
550 extern smb_user_t *smb_FindUID(smb_vc_t *vcp, unsigned short uid, int flags);
551
552 extern smb_username_t *smb_FindUserByName(char *usern, char *machine, afs_uint32 flags);
553
554 extern smb_user_t *smb_FindUserByNameThisSession(smb_vc_t *vcp, char *usern); 
555
556 extern void smb_ReleaseUsername(smb_username_t *unp);
557
558 extern void smb_HoldUIDNoLock(smb_user_t *uidp);
559
560 extern void smb_ReleaseUID(smb_user_t *uidp);
561
562 extern cm_user_t *smb_GetUserFromVCP(smb_vc_t *vcp, smb_packet_t *inp);
563
564 extern cm_user_t *smb_GetUserFromUID(smb_user_t *uidp);
565
566 extern long smb_LookupTIDPath(smb_vc_t *vcp, unsigned short tid, char ** tidPathp);
567
568 extern smb_fid_t *smb_FindFID(smb_vc_t *vcp, unsigned short fid, int flags);
569
570 extern smb_fid_t *smb_FindFIDByScache(smb_vc_t *vcp, cm_scache_t * scp);
571
572 extern void smb_HoldFIDNoLock(smb_fid_t *fidp);
573
574 extern void smb_ReleaseFID(smb_fid_t *fidp);
575
576 extern long smb_CloseFID(smb_vc_t *vcp, smb_fid_t *fidp, cm_user_t *userp,
577                          afs_uint32 dosTime);
578
579 extern int smb_FindShare(smb_vc_t *vcp, smb_user_t *uidp, char *shareName, char **pathNamep);
580
581 extern int smb_FindShareCSCPolicy(char *shareName);
582
583 extern smb_dirSearch_t *smb_FindDirSearchNL(long cookie);
584
585 extern void smb_DeleteDirSearch(smb_dirSearch_t *dsp);
586
587 extern void smb_ReleaseDirSearch(smb_dirSearch_t *dsp);
588
589 extern smb_dirSearch_t *smb_FindDirSearch(long cookie);
590
591 extern smb_dirSearch_t *smb_NewDirSearch(int isV3);
592
593 extern smb_packet_t *smb_CopyPacket(smb_packet_t *packetp);
594
595 extern void smb_FreePacket(smb_packet_t *packetp);
596
597 extern unsigned char *smb_GetSMBData(smb_packet_t *smbp, int *nbytesp);
598
599 extern void smb_SetSMBDataLength(smb_packet_t *smbp, unsigned int dsize);
600
601 extern unsigned short smb_GetSMBParm(smb_packet_t *smbp, int parm);
602
603 extern unsigned char smb_GetSMBParmByte(smb_packet_t *smbp, int parm);
604
605 extern unsigned int smb_GetSMBParmLong(smb_packet_t *smbp, int parm);
606
607 extern unsigned int smb_GetSMBOffsetParm(smb_packet_t *smbp, int parm, int offset);
608
609 extern void smb_SetSMBParm(smb_packet_t *smbp, int slot, unsigned int parmValue);
610
611 extern void smb_SetSMBParmLong(smb_packet_t *smbp, int slot, unsigned int parmValue);
612
613 extern void smb_SetSMBParmDouble(smb_packet_t *smbp, int slot, char *parmValuep);
614
615 extern void smb_SetSMBParmByte(smb_packet_t *smbp, int slot, unsigned int parmValue);
616
617 extern void smb_StripLastComponent(char *outPathp, char **lastComponentp,
618         char *inPathp);
619
620 extern unsigned char *smb_ParseASCIIBlock(unsigned char *inp, char **chainpp);
621
622 extern unsigned char *smb_ParseVblBlock(unsigned char *inp, char **chainpp,
623         int *lengthp);
624
625 extern smb_packet_t *smb_GetResponsePacket(smb_vc_t *vcp, smb_packet_t *inp);
626
627 extern void smb_SendPacket(smb_vc_t *vcp, smb_packet_t *inp);
628
629 extern void smb_MapCoreError(long code, smb_vc_t *vcp, unsigned short *scodep,
630         unsigned char *classp);
631
632 extern void smb_MapNTError(long code, unsigned long *NTStatusp);
633
634 extern void smb_HoldVC(smb_vc_t *vcp);
635
636 extern void smb_HoldVCNoLock(smb_vc_t *vcp);
637
638 /* some globals, too */
639 extern char *smb_localNamep;
640
641 extern osi_log_t *smb_logp;
642
643 extern osi_rwlock_t smb_globalLock;
644
645 extern osi_rwlock_t smb_rctLock;
646
647 extern int smb_LogoffTokenTransfer;
648 extern time_t smb_LogoffTransferTimeout;
649
650 extern int smb_maxVCPerServer; /* max # of VCs per server */
651 extern int smb_maxMpxRequests; /* max # of mpx requests */
652
653 extern int smb_StoreAnsiFilenames;
654 extern int smb_hideDotFiles;
655 extern unsigned int smb_IsDotFile(char *lastComp);
656
657 /* the following are used for smb auth */
658 extern int smb_authType; /* Type of SMB authentication to be used. One from below. */
659
660 #define SMB_AUTH_NONE 0
661 #define SMB_AUTH_NTLM 1
662 #define SMB_AUTH_EXTENDED 2
663
664 extern HANDLE smb_lsaHandle; /* LSA handle obtained during smb_init if using SMB auth */
665 extern ULONG smb_lsaSecPackage; /* LSA security package id. Set during smb_init */
666 extern char smb_ServerDomainName[];
667 extern int smb_ServerDomainNameLength;
668 extern char smb_ServerOS[];
669 extern int smb_ServerOSLength;
670 extern char smb_ServerLanManager[];
671 extern int smb_ServerLanManagerLength;
672 extern GUID smb_ServerGUID;
673 extern LSA_STRING smb_lsaLogonOrigin;
674
675 /* used for getting a challenge for SMB auth */
676 typedef struct _MSV1_0_LM20_CHALLENGE_REQUEST {  
677     MSV1_0_PROTOCOL_MESSAGE_TYPE MessageType;
678 } MSV1_0_LM20_CHALLENGE_REQUEST, *PMSV1_0_LM20_CHALLENGE_REQUEST;
679
680 typedef struct _MSV1_0_LM20_CHALLENGE_RESPONSE {  
681     MSV1_0_PROTOCOL_MESSAGE_TYPE MessageType;  
682     UCHAR ChallengeToClient[MSV1_0_CHALLENGE_LENGTH];
683 } MSV1_0_LM20_CHALLENGE_RESPONSE, *PMSV1_0_LM20_CHALLENGE_RESPONSE;
684 /**/
685
686 extern long smb_AuthenticateUserLM(smb_vc_t *vcp, char * accountName, char * primaryDomain, char * ciPwd, unsigned ciPwdLength, char * csPwd, unsigned csPwdLength);
687
688 extern long smb_GetNormalizedUsername(char * usern, const char * accountName, const char * domainName);
689
690 extern void smb_FormatResponsePacket(smb_vc_t *vcp, smb_packet_t *inp,
691         smb_packet_t *op);
692
693 extern char *myCrt_Dispatch(int i); 
694
695 extern char *myCrt_2Dispatch(int i);
696
697 extern char *myCrt_RapDispatch(int i);
698
699 extern unsigned int smb_Attributes(cm_scache_t *scp);
700
701 extern int smb_ChainFID(int fid, smb_packet_t *inp);
702
703 extern unsigned char *smb_ParseDataBlock(unsigned char *inp, char **chainpp, int *lengthp);
704
705 extern unsigned char *smb_ParseASCIIBlock(unsigned char *inp, char **chainpp);
706
707 extern unsigned char *smb_ParseVblBlock(unsigned char *inp, char **chainpp, int *lengthp);
708
709 extern int smb_SUser(cm_user_t *userp);
710
711 long smb_WriteData(smb_fid_t *fidp, osi_hyper_t *offsetp, long count, char *op,
712         cm_user_t *userp, long *writtenp);
713
714 extern long smb_ReadData(smb_fid_t *fidp, osi_hyper_t *offsetp, long count,
715         char *op, cm_user_t *userp, long *readp);
716
717 extern long smb_Rename(smb_vc_t *vcp, smb_packet_t *inp, char *oldPathp, char *newPathp, int attrs);
718
719 extern long smb_Link(smb_vc_t *vcp, smb_packet_t *inp, char *oldPathp, char *newPathp);
720
721 extern BOOL smb_IsLegalFilename(char *filename);
722
723 extern char *smb_GetSharename(void);
724
725 extern DWORD smb_ServerExceptionFilter(void);
726
727 extern void smb_UpdateServerPriority(void);
728 extern void smb_SetRequestStartTime(void);
729 extern void smb_ResetServerPriority(void);
730 extern void smb_RestartListeners(void);
731 extern void smb_StopListeners(void);
732 extern void smb_StopListener(NCB *ncbp, int lana);
733 extern long smb_IsNetworkStarted(void);
734
735 #define SMB_LISTENER_UNINITIALIZED -1
736 #define SMB_LISTENER_STOPPED 0
737 #define SMB_LISTENER_STARTED 1
738
739 /* include other include files */
740 #include "smb3.h"
741 #include "smb_ioctl.h"
742 #include "smb_iocons.h"
743
744 cm_user_t *smb_FindOrCreateUser(smb_vc_t *vcp, char *usern);
745
746 #ifdef NOTSERVICE
747 extern void smb_LogPacket(smb_packet_t *packet);
748 #endif /* NOTSERVICE */
749
750 #ifndef MSV1_0_OPTION_ALLOW_BLANK_PASSWORD
751 #define MSV1_0_OPTION_ALLOW_BLANK_PASSWORD      0x1
752 #define MSV1_0_OPTION_DISABLE_ADMIN_LOCKOUT     0x2
753 #define MSV1_0_OPTION_DISABLE_FORCE_GUEST       0x4
754 #define MSV1_0_OPTION_TRY_CACHE_FIRST           0x10
755
756 typedef struct _MSV1_0_SETPROCESSOPTION_REQUEST {
757     MSV1_0_PROTOCOL_MESSAGE_TYPE MessageType;
758     ULONG ProcessOptions;
759     BOOLEAN DisableOptions;
760 } MSV1_0_SETPROCESSOPTION_REQUEST, *PMSV1_0_SETPROCESSOPTION_REQUEST; 
761 #endif
762
763 #endif /* whole file */