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