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