fs/cifs/smb2pdu.h

   1 /*
   2  *   fs/cifs/smb2pdu.h
   3  *
   4  *   Copyright (c) International Business Machines  Corp., 2009, 2013
   5  *                 Etersoft, 2012
   6  *   Author(s): Steve French (sfrench@us.ibm.com)
   7  *              Pavel Shilovsky (pshilovsky@samba.org) 2012
   8  *
   9  *   This library is free software; you can redistribute it and/or modify
  10  *   it under the terms of the GNU Lesser General Public License as published
  11  *   by the Free Software Foundation; either version 2.1 of the License, or
  12  *   (at your option) any later version.
  13  *
  14  *   This library is distributed in the hope that it will be useful,
  15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  17  *   the GNU Lesser General Public License for more details.
  18  *
  19  *   You should have received a copy of the GNU Lesser General Public License
  20  *   along with this library; if not, write to the Free Software
  21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22  */
  23
  24 #ifndef _SMB2PDU_H
  25 #define _SMB2PDU_H
  26
  27 #include <net/sock.h>
  28
  29 /*
  30  * Note that, due to trying to use names similar to the protocol specifications,
  31  * there are many mixed case field names in the structures below.  Although
  32  * this does not match typical Linux kernel style, it is necessary to be
  33  * be able to match against the protocol specfication.
  34  *
  35  * SMB2 commands
  36  * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
  37  * (ie no useful data other than the SMB error code itself) and are marked such.
  38  * Knowing this helps avoid response buffer allocations and copy in some cases.
  39  */
  40
  41 /* List of commands in host endian */
  42 #define SMB2_NEGOTIATE_HE       0x0000
  43 #define SMB2_SESSION_SETUP_HE   0x0001
  44 #define SMB2_LOGOFF_HE          0x0002 /* trivial request/resp */
  45 #define SMB2_TREE_CONNECT_HE    0x0003
  46 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
  47 #define SMB2_CREATE_HE          0x0005
  48 #define SMB2_CLOSE_HE           0x0006
  49 #define SMB2_FLUSH_HE           0x0007 /* trivial resp */
  50 #define SMB2_READ_HE            0x0008
  51 #define SMB2_WRITE_HE           0x0009
  52 #define SMB2_LOCK_HE            0x000A
  53 #define SMB2_IOCTL_HE           0x000B
  54 #define SMB2_CANCEL_HE          0x000C
  55 #define SMB2_ECHO_HE            0x000D
  56 #define SMB2_QUERY_DIRECTORY_HE 0x000E
  57 #define SMB2_CHANGE_NOTIFY_HE   0x000F
  58 #define SMB2_QUERY_INFO_HE      0x0010
  59 #define SMB2_SET_INFO_HE        0x0011
  60 #define SMB2_OPLOCK_BREAK_HE    0x0012
  61
  62 /* The same list in little endian */
  63 #define SMB2_NEGOTIATE          cpu_to_le16(SMB2_NEGOTIATE_HE)
  64 #define SMB2_SESSION_SETUP      cpu_to_le16(SMB2_SESSION_SETUP_HE)
  65 #define SMB2_LOGOFF             cpu_to_le16(SMB2_LOGOFF_HE)
  66 #define SMB2_TREE_CONNECT       cpu_to_le16(SMB2_TREE_CONNECT_HE)
  67 #define SMB2_TREE_DISCONNECT    cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
  68 #define SMB2_CREATE             cpu_to_le16(SMB2_CREATE_HE)
  69 #define SMB2_CLOSE              cpu_to_le16(SMB2_CLOSE_HE)
  70 #define SMB2_FLUSH              cpu_to_le16(SMB2_FLUSH_HE)
  71 #define SMB2_READ               cpu_to_le16(SMB2_READ_HE)
  72 #define SMB2_WRITE              cpu_to_le16(SMB2_WRITE_HE)
  73 #define SMB2_LOCK               cpu_to_le16(SMB2_LOCK_HE)
  74 #define SMB2_IOCTL              cpu_to_le16(SMB2_IOCTL_HE)
  75 #define SMB2_CANCEL             cpu_to_le16(SMB2_CANCEL_HE)
  76 #define SMB2_ECHO               cpu_to_le16(SMB2_ECHO_HE)
  77 #define SMB2_QUERY_DIRECTORY    cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
  78 #define SMB2_CHANGE_NOTIFY      cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
  79 #define SMB2_QUERY_INFO         cpu_to_le16(SMB2_QUERY_INFO_HE)
  80 #define SMB2_SET_INFO           cpu_to_le16(SMB2_SET_INFO_HE)
  81 #define SMB2_OPLOCK_BREAK       cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
  82
  83 #define SMB2_INTERNAL_CMD       cpu_to_le16(0xFFFF)
  84
  85 #define NUMBER_OF_SMB2_COMMANDS 0x0013
  86
  87 /* 52 transform hdr + 64 hdr + 88 create rsp */
  88 #define MAX_SMB2_HDR_SIZE 204
  89
  90 #define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
  91 #define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
  92
  93 /*
  94  * SMB2 Header Definition
  95  *
  96  * "MBZ" :  Must be Zero
  97  * "BB"  :  BugBug, Something to check/review/analyze later
  98  * "PDU" :  "Protocol Data Unit" (ie a network "frame")
  99  *
 100  */
 101
 102 #define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
 103
 104 struct smb2_sync_hdr {
 105         __le32 ProtocolId;      /* 0xFE 'S' 'M' 'B' */
 106         __le16 StructureSize;   /* 64 */
 107         __le16 CreditCharge;    /* MBZ */
 108         __le32 Status;          /* Error from server */
 109         __le16 Command;
 110         __le16 CreditRequest;  /* CreditResponse */
 111         __le32 Flags;
 112         __le32 NextCommand;
 113         __le64 MessageId;
 114         __le32 ProcessId;
 115         __u32  TreeId;          /* opaque - so do not make little endian */
 116         __u64  SessionId;       /* opaque - so do not make little endian */
 117         __u8   Signature[16];
 118 } __packed;
 119
 120 struct smb2_sync_pdu {
 121         struct smb2_sync_hdr sync_hdr;
 122         __le16 StructureSize2; /* size of wct area (varies, request specific) */
 123 } __packed;
 124
 125 #define SMB3_AES128CMM_NONCE 11
 126 #define SMB3_AES128GCM_NONCE 12
 127
 128 struct smb2_transform_hdr {
 129         __le32 ProtocolId;      /* 0xFD 'S' 'M' 'B' */
 130         __u8   Signature[16];
 131         __u8   Nonce[16];
 132         __le32 OriginalMessageSize;
 133         __u16  Reserved1;
 134         __le16 Flags; /* EncryptionAlgorithm */
 135         __u64  SessionId;
 136 } __packed;
 137
 138 /*
 139  *      SMB2 flag definitions
 140  */
 141 #define SMB2_FLAGS_SERVER_TO_REDIR      cpu_to_le32(0x00000001)
 142 #define SMB2_FLAGS_ASYNC_COMMAND        cpu_to_le32(0x00000002)
 143 #define SMB2_FLAGS_RELATED_OPERATIONS   cpu_to_le32(0x00000004)
 144 #define SMB2_FLAGS_SIGNED               cpu_to_le32(0x00000008)
 145 #define SMB2_FLAGS_DFS_OPERATIONS       cpu_to_le32(0x10000000)
 146
 147 /*
 148  *      Definitions for SMB2 Protocol Data Units (network frames)
 149  *
 150  *  See MS-SMB2.PDF specification for protocol details.
 151  *  The Naming convention is the lower case version of the SMB2
 152  *  command code name for the struct. Note that structures must be packed.
 153  *
 154  */
 155
 156 #define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
 157
 158 #define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
 159
 160 struct smb2_err_rsp {
 161         struct smb2_sync_hdr sync_hdr;
 162         __le16 StructureSize;
 163         __le16 Reserved; /* MBZ */
 164         __le32 ByteCount;  /* even if zero, at least one byte follows */
 165         __u8   ErrorData[1];  /* variable length */
 166 } __packed;
 167
 168 struct smb2_symlink_err_rsp {
 169         __le32 SymLinkLength;
 170         __le32 SymLinkErrorTag;
 171         __le32 ReparseTag;
 172         __le16 ReparseDataLength;
 173         __le16 UnparsedPathLength;
 174         __le16 SubstituteNameOffset;
 175         __le16 SubstituteNameLength;
 176         __le16 PrintNameOffset;
 177         __le16 PrintNameLength;
 178         __le32 Flags;
 179         __u8  PathBuffer[0];
 180 } __packed;
 181
 182 /* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
 183 struct smb2_error_context_rsp {
 184         __le32 ErrorDataLength;
 185         __le32 ErrorId;
 186         __u8  ErrorContextData; /* ErrorDataLength long array */
 187 } __packed;
 188
 189 /* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
 190 #define MOVE_DST_IPADDR_V4      cpu_to_le32(0x00000001)
 191 #define MOVE_DST_IPADDR_V6      cpu_to_le32(0x00000002)
 192
 193 struct move_dst_ipaddr {
 194         __le32 Type;
 195         __u32  Reserved;
 196         __u8   address[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
 197 } __packed;
 198
 199 struct share_redirect_error_context_rsp {
 200         __le32 StructureSize;
 201         __le32 NotificationType;
 202         __le32 ResourceNameOffset;
 203         __le32 ResourceNameLength;
 204         __le16 Flags;
 205         __le16 TargetType;
 206         __le32 IPAddrCount;
 207         struct move_dst_ipaddr IpAddrMoveList[0];
 208         /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
 209 } __packed;
 210
 211 #define SMB2_CLIENT_GUID_SIZE 16
 212
 213 struct smb2_negotiate_req {
 214         struct smb2_sync_hdr sync_hdr;
 215         __le16 StructureSize; /* Must be 36 */
 216         __le16 DialectCount;
 217         __le16 SecurityMode;
 218         __le16 Reserved;        /* MBZ */
 219         __le32 Capabilities;
 220         __u8   ClientGUID[SMB2_CLIENT_GUID_SIZE];
 221         /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
 222         __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
 223         __le16 NegotiateContextCount;  /* SMB3.1.1 only. MBZ earlier */
 224         __le16 Reserved2;
 225         __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
 226 } __packed;
 227
 228 /* Dialects */
 229 #define SMB20_PROT_ID 0x0202
 230 #define SMB21_PROT_ID 0x0210
 231 #define SMB30_PROT_ID 0x0300
 232 #define SMB302_PROT_ID 0x0302
 233 #define SMB311_PROT_ID 0x0311
 234 #define BAD_PROT_ID   0xFFFF
 235
 236 /* SecurityMode flags */
 237 #define SMB2_NEGOTIATE_SIGNING_ENABLED  0x0001
 238 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
 239 #define SMB2_SEC_MODE_FLAGS_ALL         0x0003
 240
 241 /* Capabilities flags */
 242 #define SMB2_GLOBAL_CAP_DFS             0x00000001
 243 #define SMB2_GLOBAL_CAP_LEASING         0x00000002 /* Resp only New to SMB2.1 */
 244 #define SMB2_GLOBAL_CAP_LARGE_MTU       0X00000004 /* Resp only New to SMB2.1 */
 245 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL   0x00000008 /* New to SMB3 */
 246 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
 247 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING  0x00000020 /* New to SMB3 */
 248 #define SMB2_GLOBAL_CAP_ENCRYPTION      0x00000040 /* New to SMB3 */
 249 /* Internal types */
 250 #define SMB2_NT_FIND                    0x00100000
 251 #define SMB2_LARGE_FILES                0x00200000
 252
 253 struct smb2_neg_context {
 254         __le16  ContextType;
 255         __le16  DataLength;
 256         __le32  Reserved;
 257         /* Followed by array of data */
 258 } __packed;
 259
 260 #define SMB311_LINUX_CLIENT_SALT_SIZE                   32
 261 /* Hash Algorithm Types */
 262 #define SMB2_PREAUTH_INTEGRITY_SHA512   cpu_to_le16(0x0001)
 263 #define SMB2_PREAUTH_HASH_SIZE 64
 264
 265 /*
 266  * SaltLength that the server send can be zero, so the only three required
 267  * fields (all __le16) end up six bytes total, so the minimum context data len
 268  * in the response is six bytes which accounts for
 269  *
 270  *      HashAlgorithmCount, SaltLength, and 1 HashAlgorithm.
 271  */
 272 #define MIN_PREAUTH_CTXT_DATA_LEN 6
 273
 274 struct smb2_preauth_neg_context {
 275         __le16  ContextType; /* 1 */
 276         __le16  DataLength;
 277         __le32  Reserved;
 278         __le16  HashAlgorithmCount; /* 1 */
 279         __le16  SaltLength;
 280         __le16  HashAlgorithms; /* HashAlgorithms[0] since only one defined */
 281         __u8    Salt[SMB311_LINUX_CLIENT_SALT_SIZE];
 282 } __packed;
 283
 284 /* Encryption Algorithms Ciphers */
 285 #define SMB2_ENCRYPTION_AES128_CCM      cpu_to_le16(0x0001)
 286 #define SMB2_ENCRYPTION_AES128_GCM      cpu_to_le16(0x0002)
 287
 288 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
 289 #define MIN_ENCRYPT_CTXT_DATA_LEN       4
 290 struct smb2_encryption_neg_context {
 291         __le16  ContextType; /* 2 */
 292         __le16  DataLength;
 293         __le32  Reserved;
 294         __le16  CipherCount; /* AES-128-GCM and AES-128-CCM */
 295         __le16  Ciphers[1]; /* Ciphers[0] since only one used now */
 296 } __packed;
 297
 298 #define POSIX_CTXT_DATA_LEN     8
 299 struct smb2_posix_neg_context {
 300         __le16  ContextType; /* 0x100 */
 301         __le16  DataLength;
 302         __le32  Reserved;
 303         __le64  Reserved1; /* In case needed for future (eg version or caps) */
 304 } __packed;
 305
 306 struct smb2_negotiate_rsp {
 307         struct smb2_sync_hdr sync_hdr;
 308         __le16 StructureSize;   /* Must be 65 */
 309         __le16 SecurityMode;
 310         __le16 DialectRevision;
 311         __le16 NegotiateContextCount;   /* Prior to SMB3.1.1 was Reserved & MBZ */
 312         __u8   ServerGUID[16];
 313         __le32 Capabilities;
 314         __le32 MaxTransactSize;
 315         __le32 MaxReadSize;
 316         __le32 MaxWriteSize;
 317         __le64 SystemTime;      /* MBZ */
 318         __le64 ServerStartTime;
 319         __le16 SecurityBufferOffset;
 320         __le16 SecurityBufferLength;
 321         __le32 NegotiateContextOffset;  /* Pre:SMB3.1.1 was reserved/ignored */
 322         __u8   Buffer[1];       /* variable length GSS security buffer */
 323 } __packed;
 324
 325 /* Flags */
 326 #define SMB2_SESSION_REQ_FLAG_BINDING           0x01
 327 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA      0x04
 328
 329 struct smb2_sess_setup_req {
 330         struct smb2_sync_hdr sync_hdr;
 331         __le16 StructureSize; /* Must be 25 */
 332         __u8   Flags;
 333         __u8   SecurityMode;
 334         __le32 Capabilities;
 335         __le32 Channel;
 336         __le16 SecurityBufferOffset;
 337         __le16 SecurityBufferLength;
 338         __u64 PreviousSessionId;
 339         __u8   Buffer[1];       /* variable length GSS security buffer */
 340 } __packed;
 341
 342 /* Currently defined SessionFlags */
 343 #define SMB2_SESSION_FLAG_IS_GUEST      0x0001
 344 #define SMB2_SESSION_FLAG_IS_NULL       0x0002
 345 #define SMB2_SESSION_FLAG_ENCRYPT_DATA  0x0004
 346 struct smb2_sess_setup_rsp {
 347         struct smb2_sync_hdr sync_hdr;
 348         __le16 StructureSize; /* Must be 9 */
 349         __le16 SessionFlags;
 350         __le16 SecurityBufferOffset;
 351         __le16 SecurityBufferLength;
 352         __u8   Buffer[1];       /* variable length GSS security buffer */
 353 } __packed;
 354
 355 struct smb2_logoff_req {
 356         struct smb2_sync_hdr sync_hdr;
 357         __le16 StructureSize;   /* Must be 4 */
 358         __le16 Reserved;
 359 } __packed;
 360
 361 struct smb2_logoff_rsp {
 362         struct smb2_sync_hdr sync_hdr;
 363         __le16 StructureSize;   /* Must be 4 */
 364         __le16 Reserved;
 365 } __packed;
 366
 367 /* Flags/Reserved for SMB3.1.1 */
 368 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
 369 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
 370 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
 371
 372 struct smb2_tree_connect_req {
 373         struct smb2_sync_hdr sync_hdr;
 374         __le16 StructureSize;   /* Must be 9 */
 375         __le16 Reserved; /* Flags in SMB3.1.1 */
 376         __le16 PathOffset;
 377         __le16 PathLength;
 378         __u8   Buffer[1];       /* variable length */
 379 } __packed;
 380
 381 /* See MS-SMB2 section 2.2.9.2 */
 382 /* Context Types */
 383 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
 384 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
 385
 386 struct tree_connect_contexts {
 387         __le16 ContextType;
 388         __le16 DataLength;
 389         __le32 Reserved;
 390         __u8   Data[0];
 391 } __packed;
 392
 393 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
 394 struct smb3_blob_data {
 395         __le16 BlobSize;
 396         __u8   BlobData[0];
 397 } __packed;
 398
 399 /* Valid values for Attr */
 400 #define SE_GROUP_MANDATORY              0x00000001
 401 #define SE_GROUP_ENABLED_BY_DEFAULT     0x00000002
 402 #define SE_GROUP_ENABLED                0x00000004
 403 #define SE_GROUP_OWNER                  0x00000008
 404 #define SE_GROUP_USE_FOR_DENY_ONLY      0x00000010
 405 #define SE_GROUP_INTEGRITY              0x00000020
 406 #define SE_GROUP_INTEGRITY_ENABLED      0x00000040
 407 #define SE_GROUP_RESOURCE               0x20000000
 408 #define SE_GROUP_LOGON_ID               0xC0000000
 409
 410 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
 411
 412 struct sid_array_data {
 413         __le16 SidAttrCount;
 414         /* SidAttrList - array of sid_attr_data structs */
 415 } __packed;
 416
 417 struct luid_attr_data {
 418
 419 } __packed;
 420
 421 /*
 422  * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
 423  * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
 424  */
 425
 426 struct privilege_array_data {
 427         __le16 PrivilegeCount;
 428         /* array of privilege_data structs */
 429 } __packed;
 430
 431 struct remoted_identity_tcon_context {
 432         __le16 TicketType; /* must be 0x0001 */
 433         __le16 TicketSize; /* total size of this struct */
 434         __le16 User; /* offset to SID_ATTR_DATA struct with user info */
 435         __le16 UserName; /* offset to null terminated Unicode username string */
 436         __le16 Domain; /* offset to null terminated Unicode domain name */
 437         __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
 438         __le16 RestrictedGroups; /* similar to above */
 439         __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
 440         __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
 441         __le16 Owner; /* offset to BLOB_DATA struct */
 442         __le16 DefaultDacl; /* offset to BLOB_DATA struct */
 443         __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
 444         __le16 UserClaims; /* offset to BLOB_DATA struct */
 445         __le16 DeviceClaims; /* offset to BLOB_DATA struct */
 446         __u8   TicketInfo[0]; /* variable length buf - remoted identity data */
 447 } __packed;
 448
 449 struct smb2_tree_connect_req_extension {
 450         __le32 TreeConnectContextOffset;
 451         __le16 TreeConnectContextCount;
 452         __u8  Reserved[10];
 453         __u8  PathName[0]; /* variable sized array */
 454         /* followed by array of TreeConnectContexts */
 455 } __packed;
 456
 457 struct smb2_tree_connect_rsp {
 458         struct smb2_sync_hdr sync_hdr;
 459         __le16 StructureSize;   /* Must be 16 */
 460         __u8   ShareType;  /* see below */
 461         __u8   Reserved;
 462         __le32 ShareFlags; /* see below */
 463         __le32 Capabilities; /* see below */
 464         __le32 MaximalAccess;
 465 } __packed;
 466
 467 /* Possible ShareType values */
 468 #define SMB2_SHARE_TYPE_DISK    0x01
 469 #define SMB2_SHARE_TYPE_PIPE    0x02
 470 #define SMB2_SHARE_TYPE_PRINT   0x03
 471
 472 /*
 473  * Possible ShareFlags - exactly one and only one of the first 4 caching flags
 474  * must be set (any of the remaining, SHI1005, flags may be set individually
 475  * or in combination.
 476  */
 477 #define SMB2_SHAREFLAG_MANUAL_CACHING                   0x00000000
 478 #define SMB2_SHAREFLAG_AUTO_CACHING                     0x00000010
 479 #define SMB2_SHAREFLAG_VDO_CACHING                      0x00000020
 480 #define SMB2_SHAREFLAG_NO_CACHING                       0x00000030
 481 #define SHI1005_FLAGS_DFS                               0x00000001
 482 #define SHI1005_FLAGS_DFS_ROOT                          0x00000002
 483 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS          0x00000100
 484 #define SHI1005_FLAGS_FORCE_SHARED_DELETE               0x00000200
 485 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING           0x00000400
 486 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM       0x00000800
 487 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK              0x00001000
 488 #define SHI1005_FLAGS_ENABLE_HASH_V1                    0x00002000
 489 #define SHI1005_FLAGS_ENABLE_HASH_V2                    0x00004000
 490 #define SHI1005_FLAGS_ENCRYPT_DATA                      0x00008000
 491 #define SMB2_SHAREFLAG_IDENTITY_REMOTING                0x00040000 /* 3.1.1 */
 492 #define SHI1005_FLAGS_ALL                               0x0004FF33
 493
 494 /* Possible share capabilities */
 495 #define SMB2_SHARE_CAP_DFS      cpu_to_le32(0x00000008) /* all dialects */
 496 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
 497 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
 498 #define SMB2_SHARE_CAP_CLUSTER  cpu_to_le32(0x00000040) /* 3.0 */
 499 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
 500 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
 501
 502 struct smb2_tree_disconnect_req {
 503         struct smb2_sync_hdr sync_hdr;
 504         __le16 StructureSize;   /* Must be 4 */
 505         __le16 Reserved;
 506 } __packed;
 507
 508 struct smb2_tree_disconnect_rsp {
 509         struct smb2_sync_hdr sync_hdr;
 510         __le16 StructureSize;   /* Must be 4 */
 511         __le16 Reserved;
 512 } __packed;
 513
 514 /* File Attrubutes */
 515 #define FILE_ATTRIBUTE_READONLY                 0x00000001
 516 #define FILE_ATTRIBUTE_HIDDEN                   0x00000002
 517 #define FILE_ATTRIBUTE_SYSTEM                   0x00000004
 518 #define FILE_ATTRIBUTE_DIRECTORY                0x00000010
 519 #define FILE_ATTRIBUTE_ARCHIVE                  0x00000020
 520 #define FILE_ATTRIBUTE_NORMAL                   0x00000080
 521 #define FILE_ATTRIBUTE_TEMPORARY                0x00000100
 522 #define FILE_ATTRIBUTE_SPARSE_FILE              0x00000200
 523 #define FILE_ATTRIBUTE_REPARSE_POINT            0x00000400
 524 #define FILE_ATTRIBUTE_COMPRESSED               0x00000800
 525 #define FILE_ATTRIBUTE_OFFLINE                  0x00001000
 526 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED      0x00002000
 527 #define FILE_ATTRIBUTE_ENCRYPTED                0x00004000
 528 #define FILE_ATTRIBUTE_INTEGRITY_STREAM         0x00008000
 529 #define FILE_ATTRIBUTE_NO_SCRUB_DATA            0x00020000
 530
 531 /* Oplock levels */
 532 #define SMB2_OPLOCK_LEVEL_NONE          0x00
 533 #define SMB2_OPLOCK_LEVEL_II            0x01
 534 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE     0x08
 535 #define SMB2_OPLOCK_LEVEL_BATCH         0x09
 536 #define SMB2_OPLOCK_LEVEL_LEASE         0xFF
 537 /* Non-spec internal type */
 538 #define SMB2_OPLOCK_LEVEL_NOCHANGE      0x99
 539
 540 /* Desired Access Flags */
 541 #define FILE_READ_DATA_LE               cpu_to_le32(0x00000001)
 542 #define FILE_WRITE_DATA_LE              cpu_to_le32(0x00000002)
 543 #define FILE_APPEND_DATA_LE             cpu_to_le32(0x00000004)
 544 #define FILE_READ_EA_LE                 cpu_to_le32(0x00000008)
 545 #define FILE_WRITE_EA_LE                cpu_to_le32(0x00000010)
 546 #define FILE_EXECUTE_LE                 cpu_to_le32(0x00000020)
 547 #define FILE_READ_ATTRIBUTES_LE         cpu_to_le32(0x00000080)
 548 #define FILE_WRITE_ATTRIBUTES_LE        cpu_to_le32(0x00000100)
 549 #define FILE_DELETE_LE                  cpu_to_le32(0x00010000)
 550 #define FILE_READ_CONTROL_LE            cpu_to_le32(0x00020000)
 551 #define FILE_WRITE_DAC_LE               cpu_to_le32(0x00040000)
 552 #define FILE_WRITE_OWNER_LE             cpu_to_le32(0x00080000)
 553 #define FILE_SYNCHRONIZE_LE             cpu_to_le32(0x00100000)
 554 #define FILE_ACCESS_SYSTEM_SECURITY_LE  cpu_to_le32(0x01000000)
 555 #define FILE_MAXIMAL_ACCESS_LE          cpu_to_le32(0x02000000)
 556 #define FILE_GENERIC_ALL_LE             cpu_to_le32(0x10000000)
 557 #define FILE_GENERIC_EXECUTE_LE         cpu_to_le32(0x20000000)
 558 #define FILE_GENERIC_WRITE_LE           cpu_to_le32(0x40000000)
 559 #define FILE_GENERIC_READ_LE            cpu_to_le32(0x80000000)
 560
 561 /* ShareAccess Flags */
 562 #define FILE_SHARE_READ_LE              cpu_to_le32(0x00000001)
 563 #define FILE_SHARE_WRITE_LE             cpu_to_le32(0x00000002)
 564 #define FILE_SHARE_DELETE_LE            cpu_to_le32(0x00000004)
 565 #define FILE_SHARE_ALL_LE               cpu_to_le32(0x00000007)
 566
 567 /* CreateDisposition Flags */
 568 #define FILE_SUPERSEDE_LE               cpu_to_le32(0x00000000)
 569 #define FILE_OPEN_LE                    cpu_to_le32(0x00000001)
 570 #define FILE_CREATE_LE                  cpu_to_le32(0x00000002)
 571 #define FILE_OPEN_IF_LE                 cpu_to_le32(0x00000003)
 572 #define FILE_OVERWRITE_LE               cpu_to_le32(0x00000004)
 573 #define FILE_OVERWRITE_IF_LE            cpu_to_le32(0x00000005)
 574
 575 /* CreateOptions Flags */
 576 #define FILE_DIRECTORY_FILE_LE          cpu_to_le32(0x00000001)
 577 /* same as #define CREATE_NOT_FILE_LE   cpu_to_le32(0x00000001) */
 578 #define FILE_WRITE_THROUGH_LE           cpu_to_le32(0x00000002)
 579 #define FILE_SEQUENTIAL_ONLY_LE         cpu_to_le32(0x00000004)
 580 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
 581 #define FILE_SYNCHRONOUS_IO_ALERT_LE    cpu_to_le32(0x00000010)
 582 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE        cpu_to_le32(0x00000020)
 583 #define FILE_NON_DIRECTORY_FILE_LE      cpu_to_le32(0x00000040)
 584 #define FILE_COMPLETE_IF_OPLOCKED_LE    cpu_to_le32(0x00000100)
 585 #define FILE_NO_EA_KNOWLEDGE_LE         cpu_to_le32(0x00000200)
 586 #define FILE_RANDOM_ACCESS_LE           cpu_to_le32(0x00000800)
 587 #define FILE_DELETE_ON_CLOSE_LE         cpu_to_le32(0x00001000)
 588 #define FILE_OPEN_BY_FILE_ID_LE         cpu_to_le32(0x00002000)
 589 #define FILE_OPEN_FOR_BACKUP_INTENT_LE  cpu_to_le32(0x00004000)
 590 #define FILE_NO_COMPRESSION_LE          cpu_to_le32(0x00008000)
 591 #define FILE_RESERVE_OPFILTER_LE        cpu_to_le32(0x00100000)
 592 #define FILE_OPEN_REPARSE_POINT_LE      cpu_to_le32(0x00200000)
 593 #define FILE_OPEN_NO_RECALL_LE          cpu_to_le32(0x00400000)
 594 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
 595
 596 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
 597                         | FILE_READ_ATTRIBUTES_LE)
 598 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
 599                         | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
 600 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
 601
 602 /* Impersonation Levels */
 603 #define IL_ANONYMOUS            cpu_to_le32(0x00000000)
 604 #define IL_IDENTIFICATION       cpu_to_le32(0x00000001)
 605 #define IL_IMPERSONATION        cpu_to_le32(0x00000002)
 606 #define IL_DELEGATE             cpu_to_le32(0x00000003)
 607
 608 /* Create Context Values */
 609 #define SMB2_CREATE_EA_BUFFER                   "ExtA" /* extended attributes */
 610 #define SMB2_CREATE_SD_BUFFER                   "SecD" /* security descriptor */
 611 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST      "DHnQ"
 612 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT    "DHnC"
 613 #define SMB2_CREATE_ALLOCATION_SIZE             "AISi"
 614 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
 615 #define SMB2_CREATE_TIMEWARP_REQUEST            "TWrp"
 616 #define SMB2_CREATE_QUERY_ON_DISK_ID            "QFid"
 617 #define SMB2_CREATE_REQUEST_LEASE               "RqLs"
 618 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2   "DH2Q"
 619 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
 620 #define SMB2_CREATE_APP_INSTANCE_ID     0x45BCA66AEFA7F74A9008FA462E144D74
 621 #define SVHDX_OPEN_DEVICE_CONTEX        0x9CCBCF9E04C1E643980E158DA1F6EC83
 622 #define SMB2_CREATE_TAG_POSIX           0x93AD25509CB411E7B42383DE968BCD7C
 623
 624
 625 /*
 626  * Maximum number of iovs we need for an open/create request.
 627  * [0] : struct smb2_create_req
 628  * [1] : path
 629  * [2] : lease context
 630  * [3] : durable context
 631  * [4] : posix context
 632  * [5] : time warp context
 633  * [6] : compound padding
 634  */
 635 #define SMB2_CREATE_IOV_SIZE 7
 636
 637 struct smb2_create_req {
 638         struct smb2_sync_hdr sync_hdr;
 639         __le16 StructureSize;   /* Must be 57 */
 640         __u8   SecurityFlags;
 641         __u8   RequestedOplockLevel;
 642         __le32 ImpersonationLevel;
 643         __le64 SmbCreateFlags;
 644         __le64 Reserved;
 645         __le32 DesiredAccess;
 646         __le32 FileAttributes;
 647         __le32 ShareAccess;
 648         __le32 CreateDisposition;
 649         __le32 CreateOptions;
 650         __le16 NameOffset;
 651         __le16 NameLength;
 652         __le32 CreateContextsOffset;
 653         __le32 CreateContextsLength;
 654         __u8   Buffer[0];
 655 } __packed;
 656
 657 struct smb2_create_rsp {
 658         struct smb2_sync_hdr sync_hdr;
 659         __le16 StructureSize;   /* Must be 89 */
 660         __u8   OplockLevel;
 661         __u8   Reserved;
 662         __le32 CreateAction;
 663         __le64 CreationTime;
 664         __le64 LastAccessTime;
 665         __le64 LastWriteTime;
 666         __le64 ChangeTime;
 667         __le64 AllocationSize;
 668         __le64 EndofFile;
 669         __le32 FileAttributes;
 670         __le32 Reserved2;
 671         __u64  PersistentFileId; /* opaque endianness */
 672         __u64  VolatileFileId; /* opaque endianness */
 673         __le32 CreateContextsOffset;
 674         __le32 CreateContextsLength;
 675         __u8   Buffer[1];
 676 } __packed;
 677
 678 struct create_context {
 679         __le32 Next;
 680         __le16 NameOffset;
 681         __le16 NameLength;
 682         __le16 Reserved;
 683         __le16 DataOffset;
 684         __le32 DataLength;
 685         __u8 Buffer[0];
 686 } __packed;
 687
 688 #define SMB2_LEASE_READ_CACHING_HE      0x01
 689 #define SMB2_LEASE_HANDLE_CACHING_HE    0x02
 690 #define SMB2_LEASE_WRITE_CACHING_HE     0x04
 691
 692 #define SMB2_LEASE_NONE                 cpu_to_le32(0x00)
 693 #define SMB2_LEASE_READ_CACHING         cpu_to_le32(0x01)
 694 #define SMB2_LEASE_HANDLE_CACHING       cpu_to_le32(0x02)
 695 #define SMB2_LEASE_WRITE_CACHING        cpu_to_le32(0x04)
 696
 697 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x02)
 698 #define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
 699
 700 #define SMB2_LEASE_KEY_SIZE 16
 701
 702 struct lease_context {
 703         u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
 704         __le32 LeaseState;
 705         __le32 LeaseFlags;
 706         __le64 LeaseDuration;
 707 } __packed;
 708
 709 struct lease_context_v2 {
 710         u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
 711         __le32 LeaseState;
 712         __le32 LeaseFlags;
 713         __le64 LeaseDuration;
 714         __le64 ParentLeaseKeyLow;
 715         __le64 ParentLeaseKeyHigh;
 716         __le16 Epoch;
 717         __le16 Reserved;
 718 } __packed;
 719
 720 struct create_lease {
 721         struct create_context ccontext;
 722         __u8   Name[8];
 723         struct lease_context lcontext;
 724 } __packed;
 725
 726 struct create_lease_v2 {
 727         struct create_context ccontext;
 728         __u8   Name[8];
 729         struct lease_context_v2 lcontext;
 730         __u8   Pad[4];
 731 } __packed;
 732
 733 struct create_durable {
 734         struct create_context ccontext;
 735         __u8   Name[8];
 736         union {
 737                 __u8  Reserved[16];
 738                 struct {
 739                         __u64 PersistentFileId;
 740                         __u64 VolatileFileId;
 741                 } Fid;
 742         } Data;
 743 } __packed;
 744
 745 struct create_posix {
 746         struct create_context ccontext;
 747         __u8    Name[16];
 748         __le32  Mode;
 749         __u32   Reserved;
 750 } __packed;
 751
 752 /* See MS-SMB2 2.2.13.2.11 */
 753 /* Flags */
 754 #define SMB2_DHANDLE_FLAG_PERSISTENT    0x00000002
 755 struct durable_context_v2 {
 756         __le32 Timeout;
 757         __le32 Flags;
 758         __u64 Reserved;
 759         __u8 CreateGuid[16];
 760 } __packed;
 761
 762 struct create_durable_v2 {
 763         struct create_context ccontext;
 764         __u8   Name[8];
 765         struct durable_context_v2 dcontext;
 766 } __packed;
 767
 768 /* See MS-SMB2 2.2.13.2.12 */
 769 struct durable_reconnect_context_v2 {
 770         struct {
 771                 __u64 PersistentFileId;
 772                 __u64 VolatileFileId;
 773         } Fid;
 774         __u8 CreateGuid[16];
 775         __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
 776 } __packed;
 777
 778 /* See MS-SMB2 2.2.14.2.12 */
 779 struct durable_reconnect_context_v2_rsp {
 780         __le32 Timeout;
 781         __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
 782 } __packed;
 783
 784 struct create_durable_handle_reconnect_v2 {
 785         struct create_context ccontext;
 786         __u8   Name[8];
 787         struct durable_reconnect_context_v2 dcontext;
 788         __u8   Pad[4];
 789 } __packed;
 790
 791 /* See MS-SMB2 2.2.13.2.5 */
 792 struct crt_twarp_ctxt {
 793         struct create_context ccontext;
 794         __u8    Name[8];
 795         __le64  Timestamp;
 796
 797 } __packed;
 798
 799 #define COPY_CHUNK_RES_KEY_SIZE 24
 800 struct resume_key_req {
 801         char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
 802         __le32  ContextLength;  /* MBZ */
 803         char    Context[0];     /* ignored, Windows sets to 4 bytes of zero */
 804 } __packed;
 805
 806 /* this goes in the ioctl buffer when doing a copychunk request */
 807 struct copychunk_ioctl {
 808         char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
 809         __le32 ChunkCount; /* we are only sending 1 */
 810         __le32 Reserved;
 811         /* array will only be one chunk long for us */
 812         __le64 SourceOffset;
 813         __le64 TargetOffset;
 814         __le32 Length; /* how many bytes to copy */
 815         __u32 Reserved2;
 816 } __packed;
 817
 818 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
 819 struct file_zero_data_information {
 820         __le64  FileOffset;
 821         __le64  BeyondFinalZero;
 822 } __packed;
 823
 824 struct copychunk_ioctl_rsp {
 825         __le32 ChunksWritten;
 826         __le32 ChunkBytesWritten;
 827         __le32 TotalBytesWritten;
 828 } __packed;
 829
 830 struct fsctl_set_integrity_information_req {
 831         __le16  ChecksumAlgorithm;
 832         __le16  Reserved;
 833         __le32  Flags;
 834 } __packed;
 835
 836 struct fsctl_get_integrity_information_rsp {
 837         __le16  ChecksumAlgorithm;
 838         __le16  Reserved;
 839         __le32  Flags;
 840         __le32  ChecksumChunkSizeInBytes;
 841         __le32  ClusterSizeInBytes;
 842 } __packed;
 843
 844 /* Integrity ChecksumAlgorithm choices for above */
 845 #define CHECKSUM_TYPE_NONE      0x0000
 846 #define CHECKSUM_TYPE_CRC64     0x0002
 847 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF  /* set only */
 848
 849 /* Integrity flags for above */
 850 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF   0x00000001
 851
 852 /* See MS-DFSC 2.2.2 */
 853 struct fsctl_get_dfs_referral_req {
 854         __le16 MaxReferralLevel;
 855         __u8 RequestFileName[];
 856 } __packed;
 857
 858 /* DFS response is struct get_dfs_refer_rsp */
 859
 860 /* See MS-SMB2 2.2.31.3 */
 861 struct network_resiliency_req {
 862         __le32 Timeout;
 863         __le32 Reserved;
 864 } __packed;
 865 /* There is no buffer for the response ie no struct network_resiliency_rsp */
 866
 867
 868 struct validate_negotiate_info_req {
 869         __le32 Capabilities;
 870         __u8   Guid[SMB2_CLIENT_GUID_SIZE];
 871         __le16 SecurityMode;
 872         __le16 DialectCount;
 873         __le16 Dialects[3]; /* BB expand this if autonegotiate > 3 dialects */
 874 } __packed;
 875
 876 struct validate_negotiate_info_rsp {
 877         __le32 Capabilities;
 878         __u8   Guid[SMB2_CLIENT_GUID_SIZE];
 879         __le16 SecurityMode;
 880         __le16 Dialect; /* Dialect in use for the connection */
 881 } __packed;
 882
 883 #define RSS_CAPABLE     cpu_to_le32(0x00000001)
 884 #define RDMA_CAPABLE    cpu_to_le32(0x00000002)
 885
 886 #define INTERNETWORK    cpu_to_le16(0x0002)
 887 #define INTERNETWORKV6  cpu_to_le16(0x0017)
 888
 889 struct network_interface_info_ioctl_rsp {
 890         __le32 Next; /* next interface. zero if this is last one */
 891         __le32 IfIndex;
 892         __le32 Capability; /* RSS or RDMA Capable */
 893         __le32 Reserved;
 894         __le64 LinkSpeed;
 895         __le16 Family;
 896         __u8 Buffer[126];
 897 } __packed;
 898
 899 struct iface_info_ipv4 {
 900         __be16 Port;
 901         __be32 IPv4Address;
 902         __be64 Reserved;
 903 } __packed;
 904
 905 struct iface_info_ipv6 {
 906         __be16 Port;
 907         __be32 FlowInfo;
 908         __u8   IPv6Address[16];
 909         __be32 ScopeId;
 910 } __packed;
 911
 912 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
 913
 914 struct compress_ioctl {
 915         __le16 CompressionState; /* See cifspdu.h for possible flag values */
 916 } __packed;
 917
 918 struct duplicate_extents_to_file {
 919         __u64 PersistentFileHandle; /* source file handle, opaque endianness */
 920         __u64 VolatileFileHandle;
 921         __le64 SourceFileOffset;
 922         __le64 TargetFileOffset;
 923         __le64 ByteCount;  /* Bytes to be copied */
 924 } __packed;
 925
 926 struct smb2_ioctl_req {
 927         struct smb2_sync_hdr sync_hdr;
 928         __le16 StructureSize;   /* Must be 57 */
 929         __u16 Reserved;
 930         __le32 CtlCode;
 931         __u64  PersistentFileId; /* opaque endianness */
 932         __u64  VolatileFileId; /* opaque endianness */
 933         __le32 InputOffset;
 934         __le32 InputCount;
 935         __le32 MaxInputResponse;
 936         __le32 OutputOffset;
 937         __le32 OutputCount;
 938         __le32 MaxOutputResponse;
 939         __le32 Flags;
 940         __u32  Reserved2;
 941         __u8   Buffer[0];
 942 } __packed;
 943
 944 struct smb2_ioctl_rsp {
 945         struct smb2_sync_hdr sync_hdr;
 946         __le16 StructureSize;   /* Must be 57 */
 947         __u16 Reserved;
 948         __le32 CtlCode;
 949         __u64  PersistentFileId; /* opaque endianness */
 950         __u64  VolatileFileId; /* opaque endianness */
 951         __le32 InputOffset;
 952         __le32 InputCount;
 953         __le32 OutputOffset;
 954         __le32 OutputCount;
 955         __le32 Flags;
 956         __u32  Reserved2;
 957         /* char * buffer[] */
 958 } __packed;
 959
 960 /* Currently defined values for close flags */
 961 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB        cpu_to_le16(0x0001)
 962 struct smb2_close_req {
 963         struct smb2_sync_hdr sync_hdr;
 964         __le16 StructureSize;   /* Must be 24 */
 965         __le16 Flags;
 966         __le32 Reserved;
 967         __u64  PersistentFileId; /* opaque endianness */
 968         __u64  VolatileFileId; /* opaque endianness */
 969 } __packed;
 970
 971 struct smb2_close_rsp {
 972         struct smb2_sync_hdr sync_hdr;
 973         __le16 StructureSize; /* 60 */
 974         __le16 Flags;
 975         __le32 Reserved;
 976         __le64 CreationTime;
 977         __le64 LastAccessTime;
 978         __le64 LastWriteTime;
 979         __le64 ChangeTime;
 980         __le64 AllocationSize;  /* Beginning of FILE_STANDARD_INFO equivalent */
 981         __le64 EndOfFile;
 982         __le32 Attributes;
 983 } __packed;
 984
 985 struct smb2_flush_req {
 986         struct smb2_sync_hdr sync_hdr;
 987         __le16 StructureSize;   /* Must be 24 */
 988         __le16 Reserved1;
 989         __le32 Reserved2;
 990         __u64  PersistentFileId; /* opaque endianness */
 991         __u64  VolatileFileId; /* opaque endianness */
 992 } __packed;
 993
 994 struct smb2_flush_rsp {
 995         struct smb2_sync_hdr sync_hdr;
 996         __le16 StructureSize;
 997         __le16 Reserved;
 998 } __packed;
 999
1000 /* For read request Flags field below, following flag is defined for SMB3.02 */
1001 #define SMB2_READFLAG_READ_UNBUFFERED   0x01
1002
1003 /* Channel field for read and write: exactly one of following flags can be set*/
1004 #define SMB2_CHANNEL_NONE       cpu_to_le32(0x00000000)
1005 #define SMB2_CHANNEL_RDMA_V1    cpu_to_le32(0x00000001) /* SMB3 or later */
1006 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1007
1008 /* SMB2 read request without RFC1001 length at the beginning */
1009 struct smb2_read_plain_req {
1010         struct smb2_sync_hdr sync_hdr;
1011         __le16 StructureSize; /* Must be 49 */
1012         __u8   Padding; /* offset from start of SMB2 header to place read */
1013         __u8   Flags; /* MBZ unless SMB3.02 or later */
1014         __le32 Length;
1015         __le64 Offset;
1016         __u64  PersistentFileId; /* opaque endianness */
1017         __u64  VolatileFileId; /* opaque endianness */
1018         __le32 MinimumCount;
1019         __le32 Channel; /* MBZ except for SMB3 or later */
1020         __le32 RemainingBytes;
1021         __le16 ReadChannelInfoOffset;
1022         __le16 ReadChannelInfoLength;
1023         __u8   Buffer[1];
1024 } __packed;
1025
1026 struct smb2_read_rsp {
1027         struct smb2_sync_hdr sync_hdr;
1028         __le16 StructureSize; /* Must be 17 */
1029         __u8   DataOffset;
1030         __u8   Reserved;
1031         __le32 DataLength;
1032         __le32 DataRemaining;
1033         __u32  Reserved2;
1034         __u8   Buffer[1];
1035 } __packed;
1036
1037 /* For write request Flags field below the following flags are defined: */
1038 #define SMB2_WRITEFLAG_WRITE_THROUGH    0x00000001      /* SMB2.1 or later */
1039 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002      /* SMB3.02 or later */
1040
1041 struct smb2_write_req {
1042         struct smb2_sync_hdr sync_hdr;
1043         __le16 StructureSize; /* Must be 49 */
1044         __le16 DataOffset; /* offset from start of SMB2 header to write data */
1045         __le32 Length;
1046         __le64 Offset;
1047         __u64  PersistentFileId; /* opaque endianness */
1048         __u64  VolatileFileId; /* opaque endianness */
1049         __le32 Channel; /* Reserved MBZ */
1050         __le32 RemainingBytes;
1051         __le16 WriteChannelInfoOffset;
1052         __le16 WriteChannelInfoLength;
1053         __le32 Flags;
1054         __u8   Buffer[1];
1055 } __packed;
1056
1057 struct smb2_write_rsp {
1058         struct smb2_sync_hdr sync_hdr;
1059         __le16 StructureSize; /* Must be 17 */
1060         __u8   DataOffset;
1061         __u8   Reserved;
1062         __le32 DataLength;
1063         __le32 DataRemaining;
1064         __u32  Reserved2;
1065         __u8   Buffer[1];
1066 } __packed;
1067
1068 #define SMB2_LOCKFLAG_SHARED_LOCK       0x0001
1069 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK    0x0002
1070 #define SMB2_LOCKFLAG_UNLOCK            0x0004
1071 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY  0x0010
1072
1073 struct smb2_lock_element {
1074         __le64 Offset;
1075         __le64 Length;
1076         __le32 Flags;
1077         __le32 Reserved;
1078 } __packed;
1079
1080 struct smb2_lock_req {
1081         struct smb2_sync_hdr sync_hdr;
1082         __le16 StructureSize; /* Must be 48 */
1083         __le16 LockCount;
1084         __le32 Reserved;
1085         __u64  PersistentFileId; /* opaque endianness */
1086         __u64  VolatileFileId; /* opaque endianness */
1087         /* Followed by at least one */
1088         struct smb2_lock_element locks[1];
1089 } __packed;
1090
1091 struct smb2_lock_rsp {
1092         struct smb2_sync_hdr sync_hdr;
1093         __le16 StructureSize; /* Must be 4 */
1094         __le16 Reserved;
1095 } __packed;
1096
1097 struct smb2_echo_req {
1098         struct smb2_sync_hdr sync_hdr;
1099         __le16 StructureSize;   /* Must be 4 */
1100         __u16  Reserved;
1101 } __packed;
1102
1103 struct smb2_echo_rsp {
1104         struct smb2_sync_hdr sync_hdr;
1105         __le16 StructureSize;   /* Must be 4 */
1106         __u16  Reserved;
1107 } __packed;
1108
1109 /* search (query_directory) Flags field */
1110 #define SMB2_RESTART_SCANS              0x01
1111 #define SMB2_RETURN_SINGLE_ENTRY        0x02
1112 #define SMB2_INDEX_SPECIFIED            0x04
1113 #define SMB2_REOPEN                     0x10
1114
1115 struct smb2_query_directory_req {
1116         struct smb2_sync_hdr sync_hdr;
1117         __le16 StructureSize; /* Must be 33 */
1118         __u8   FileInformationClass;
1119         __u8   Flags;
1120         __le32 FileIndex;
1121         __u64  PersistentFileId; /* opaque endianness */
1122         __u64  VolatileFileId; /* opaque endianness */
1123         __le16 FileNameOffset;
1124         __le16 FileNameLength;
1125         __le32 OutputBufferLength;
1126         __u8   Buffer[1];
1127 } __packed;
1128
1129 struct smb2_query_directory_rsp {
1130         struct smb2_sync_hdr sync_hdr;
1131         __le16 StructureSize; /* Must be 9 */
1132         __le16 OutputBufferOffset;
1133         __le32 OutputBufferLength;
1134         __u8   Buffer[1];
1135 } __packed;
1136
1137 /* Possible InfoType values */
1138 #define SMB2_O_INFO_FILE        0x01
1139 #define SMB2_O_INFO_FILESYSTEM  0x02
1140 #define SMB2_O_INFO_SECURITY    0x03
1141 #define SMB2_O_INFO_QUOTA       0x04
1142
1143 /* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1144 #define OWNER_SECINFO   0x00000001
1145 #define GROUP_SECINFO   0x00000002
1146 #define DACL_SECINFO   0x00000004
1147 #define SACL_SECINFO   0x00000008
1148 #define LABEL_SECINFO   0x00000010
1149 #define ATTRIBUTE_SECINFO   0x00000020
1150 #define SCOPE_SECINFO   0x00000040
1151 #define BACKUP_SECINFO   0x00010000
1152 #define UNPROTECTED_SACL_SECINFO   0x10000000
1153 #define UNPROTECTED_DACL_SECINFO   0x20000000
1154 #define PROTECTED_SACL_SECINFO   0x40000000
1155 #define PROTECTED_DACL_SECINFO   0x80000000
1156
1157 /* Flags used for FileFullEAinfo */
1158 #define SL_RESTART_SCAN         0x00000001
1159 #define SL_RETURN_SINGLE_ENTRY  0x00000002
1160 #define SL_INDEX_SPECIFIED      0x00000004
1161
1162 struct smb2_query_info_req {
1163         struct smb2_sync_hdr sync_hdr;
1164         __le16 StructureSize; /* Must be 41 */
1165         __u8   InfoType;
1166         __u8   FileInfoClass;
1167         __le32 OutputBufferLength;
1168         __le16 InputBufferOffset;
1169         __u16  Reserved;
1170         __le32 InputBufferLength;
1171         __le32 AdditionalInformation;
1172         __le32 Flags;
1173         __u64  PersistentFileId; /* opaque endianness */
1174         __u64  VolatileFileId; /* opaque endianness */
1175         __u8   Buffer[1];
1176 } __packed;
1177
1178 struct smb2_query_info_rsp {
1179         struct smb2_sync_hdr sync_hdr;
1180         __le16 StructureSize; /* Must be 9 */
1181         __le16 OutputBufferOffset;
1182         __le32 OutputBufferLength;
1183         __u8   Buffer[1];
1184 } __packed;
1185
1186 struct smb2_set_info_req {
1187         struct smb2_sync_hdr sync_hdr;
1188         __le16 StructureSize; /* Must be 33 */
1189         __u8   InfoType;
1190         __u8   FileInfoClass;
1191         __le32 BufferLength;
1192         __le16 BufferOffset;
1193         __u16  Reserved;
1194         __le32 AdditionalInformation;
1195         __u64  PersistentFileId; /* opaque endianness */
1196         __u64  VolatileFileId; /* opaque endianness */
1197         __u8   Buffer[1];
1198 } __packed;
1199
1200 struct smb2_set_info_rsp {
1201         struct smb2_sync_hdr sync_hdr;
1202         __le16 StructureSize; /* Must be 2 */
1203 } __packed;
1204
1205 struct smb2_oplock_break {
1206         struct smb2_sync_hdr sync_hdr;
1207         __le16 StructureSize; /* Must be 24 */
1208         __u8   OplockLevel;
1209         __u8   Reserved;
1210         __le32 Reserved2;
1211         __u64  PersistentFid;
1212         __u64  VolatileFid;
1213 } __packed;
1214
1215 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1216
1217 struct smb2_lease_break {
1218         struct smb2_sync_hdr sync_hdr;
1219         __le16 StructureSize; /* Must be 44 */
1220         __le16 Epoch;
1221         __le32 Flags;
1222         __u8   LeaseKey[16];
1223         __le32 CurrentLeaseState;
1224         __le32 NewLeaseState;
1225         __le32 BreakReason;
1226         __le32 AccessMaskHint;
1227         __le32 ShareMaskHint;
1228 } __packed;
1229
1230 struct smb2_lease_ack {
1231         struct smb2_sync_hdr sync_hdr;
1232         __le16 StructureSize; /* Must be 36 */
1233         __le16 Reserved;
1234         __le32 Flags;
1235         __u8   LeaseKey[16];
1236         __le32 LeaseState;
1237         __le64 LeaseDuration;
1238 } __packed;
1239
1240 /*
1241  *      PDU infolevel structure definitions
1242  *      BB consider moving to a different header
1243  */
1244
1245 /* File System Information Classes */
1246 #define FS_VOLUME_INFORMATION           1 /* Query */
1247 #define FS_LABEL_INFORMATION            2 /* Local only */
1248 #define FS_SIZE_INFORMATION             3 /* Query */
1249 #define FS_DEVICE_INFORMATION           4 /* Query */
1250 #define FS_ATTRIBUTE_INFORMATION        5 /* Query */
1251 #define FS_CONTROL_INFORMATION          6 /* Query, Set */
1252 #define FS_FULL_SIZE_INFORMATION        7 /* Query */
1253 #define FS_OBJECT_ID_INFORMATION        8 /* Query, Set */
1254 #define FS_DRIVER_PATH_INFORMATION      9 /* Local only */
1255 #define FS_VOLUME_FLAGS_INFORMATION     10 /* Local only */
1256 #define FS_SECTOR_SIZE_INFORMATION      11 /* SMB3 or later. Query */
1257 #define FS_POSIX_INFORMATION            100 /* SMB3.1.1 POSIX. Query */
1258
1259 struct smb2_fs_full_size_info {
1260         __le64 TotalAllocationUnits;
1261         __le64 CallerAvailableAllocationUnits;
1262         __le64 ActualAvailableAllocationUnits;
1263         __le32 SectorsPerAllocationUnit;
1264         __le32 BytesPerSector;
1265 } __packed;
1266
1267 #define SSINFO_FLAGS_ALIGNED_DEVICE             0x00000001
1268 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1269 #define SSINFO_FLAGS_NO_SEEK_PENALTY            0x00000004
1270 #define SSINFO_FLAGS_TRIM_ENABLED               0x00000008
1271
1272 /* sector size info struct */
1273 struct smb3_fs_ss_info {
1274         __le32 LogicalBytesPerSector;
1275         __le32 PhysicalBytesPerSectorForAtomicity;
1276         __le32 PhysicalBytesPerSectorForPerf;
1277         __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
1278         __le32 Flags;
1279         __le32 ByteOffsetForSectorAlignment;
1280         __le32 ByteOffsetForPartitionAlignment;
1281 } __packed;
1282
1283 /* volume info struct - see MS-FSCC 2.5.9 */
1284 #define MAX_VOL_LABEL_LEN       32
1285 struct smb3_fs_vol_info {
1286         __le64  VolumeCreationTime;
1287         __u32   VolumeSerialNumber;
1288         __le32  VolumeLabelLength; /* includes trailing null */
1289         __u8    SupportsObjects; /* True if eg like NTFS, supports objects */
1290         __u8    Reserved;
1291         __u8    VolumeLabel[0]; /* variable len */
1292 } __packed;
1293
1294 /* partial list of QUERY INFO levels */
1295 #define FILE_DIRECTORY_INFORMATION      1
1296 #define FILE_FULL_DIRECTORY_INFORMATION 2
1297 #define FILE_BOTH_DIRECTORY_INFORMATION 3
1298 #define FILE_BASIC_INFORMATION          4
1299 #define FILE_STANDARD_INFORMATION       5
1300 #define FILE_INTERNAL_INFORMATION       6
1301 #define FILE_EA_INFORMATION             7
1302 #define FILE_ACCESS_INFORMATION         8
1303 #define FILE_NAME_INFORMATION           9
1304 #define FILE_RENAME_INFORMATION         10
1305 #define FILE_LINK_INFORMATION           11
1306 #define FILE_NAMES_INFORMATION          12
1307 #define FILE_DISPOSITION_INFORMATION    13
1308 #define FILE_POSITION_INFORMATION       14
1309 #define FILE_FULL_EA_INFORMATION        15
1310 #define FILE_MODE_INFORMATION           16
1311 #define FILE_ALIGNMENT_INFORMATION      17
1312 #define FILE_ALL_INFORMATION            18
1313 #define FILE_ALLOCATION_INFORMATION     19
1314 #define FILE_END_OF_FILE_INFORMATION    20
1315 #define FILE_ALTERNATE_NAME_INFORMATION 21
1316 #define FILE_STREAM_INFORMATION         22
1317 #define FILE_PIPE_INFORMATION           23
1318 #define FILE_PIPE_LOCAL_INFORMATION     24
1319 #define FILE_PIPE_REMOTE_INFORMATION    25
1320 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1321 #define FILE_MAILSLOT_SET_INFORMATION   27
1322 #define FILE_COMPRESSION_INFORMATION    28
1323 #define FILE_OBJECT_ID_INFORMATION      29
1324 /* Number 30 not defined in documents */
1325 #define FILE_MOVE_CLUSTER_INFORMATION   31
1326 #define FILE_QUOTA_INFORMATION          32
1327 #define FILE_REPARSE_POINT_INFORMATION  33
1328 #define FILE_NETWORK_OPEN_INFORMATION   34
1329 #define FILE_ATTRIBUTE_TAG_INFORMATION  35
1330 #define FILE_TRACKING_INFORMATION       36
1331 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
1332 #define FILEID_FULL_DIRECTORY_INFORMATION 38
1333 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1334 #define FILE_SHORT_NAME_INFORMATION     40
1335 #define FILE_SFIO_RESERVE_INFORMATION   44
1336 #define FILE_SFIO_VOLUME_INFORMATION    45
1337 #define FILE_HARD_LINK_INFORMATION      46
1338 #define FILE_NORMALIZED_NAME_INFORMATION 48
1339 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1340 #define FILE_STANDARD_LINK_INFORMATION  54
1341
1342 struct smb2_file_internal_info {
1343         __le64 IndexNumber;
1344 } __packed; /* level 6 Query */
1345
1346 struct smb2_file_rename_info { /* encoding of request for level 10 */
1347         __u8   ReplaceIfExists; /* 1 = replace existing target with new */
1348                                 /* 0 = fail if target already exists */
1349         __u8   Reserved[7];
1350         __u64  RootDirectory;  /* MBZ for network operations (why says spec?) */
1351         __le32 FileNameLength;
1352         char   FileName[0];     /* New name to be assigned */
1353 } __packed; /* level 10 Set */
1354
1355 struct smb2_file_link_info { /* encoding of request for level 11 */
1356         __u8   ReplaceIfExists; /* 1 = replace existing link with new */
1357                                 /* 0 = fail if link already exists */
1358         __u8   Reserved[7];
1359         __u64  RootDirectory;  /* MBZ for network operations (why says spec?) */
1360         __le32 FileNameLength;
1361         char   FileName[0];     /* Name to be assigned to new link */
1362 } __packed; /* level 11 Set */
1363
1364 #define SMB2_MIN_EA_BUF  2048
1365 #define SMB2_MAX_EA_BUF 65536
1366
1367 struct smb2_file_full_ea_info { /* encoding of response for level 15 */
1368         __le32 next_entry_offset;
1369         __u8   flags;
1370         __u8   ea_name_length;
1371         __le16 ea_value_length;
1372         char   ea_data[0]; /* \0 terminated name plus value */
1373 } __packed; /* level 15 Set */
1374
1375 /*
1376  * This level 18, although with struct with same name is different from cifs
1377  * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1378  * CurrentByteOffset.
1379  */
1380 struct smb2_file_all_info { /* data block encoding of response to level 18 */
1381         __le64 CreationTime;    /* Beginning of FILE_BASIC_INFO equivalent */
1382         __le64 LastAccessTime;
1383         __le64 LastWriteTime;
1384         __le64 ChangeTime;
1385         __le32 Attributes;
1386         __u32  Pad1;            /* End of FILE_BASIC_INFO_INFO equivalent */
1387         __le64 AllocationSize;  /* Beginning of FILE_STANDARD_INFO equivalent */
1388         __le64 EndOfFile;       /* size ie offset to first free byte in file */
1389         __le32 NumberOfLinks;   /* hard links */
1390         __u8   DeletePending;
1391         __u8   Directory;
1392         __u16  Pad2;            /* End of FILE_STANDARD_INFO equivalent */
1393         __le64 IndexNumber;
1394         __le32 EASize;
1395         __le32 AccessFlags;
1396         __le64 CurrentByteOffset;
1397         __le32 Mode;
1398         __le32 AlignmentRequirement;
1399         __le32 FileNameLength;
1400         char   FileName[1];
1401 } __packed; /* level 18 Query */
1402
1403 struct smb2_file_eof_info { /* encoding of request for level 10 */
1404         __le64 EndOfFile; /* new end of file value */
1405 } __packed; /* level 20 Set */
1406
1407 extern char smb2_padding[7];
1408
1409 #endif                          /* _SMB2PDU_H */