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