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