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