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