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