fs/cifs/smb2pdu.h

   1 /* SPDX-License-Identifier: LGPL-2.1 */
   2 /*
   3  *   fs/cifs/smb2pdu.h
   4  *
   5  *   Copyright (c) International Business Machines  Corp., 2009, 2013
   6  *                 Etersoft, 2012
   7  *   Author(s): Steve French (sfrench@us.ibm.com)
   8  *              Pavel Shilovsky (pshilovsky@samba.org) 2012
   9  *
  10  */
  11
  12 #ifndef _SMB2PDU_H
  13 #define _SMB2PDU_H
  14
  15 #include <net/sock.h>
  16 #include "cifsacl.h"
  17
  18 /*
  19  * Note that, due to trying to use names similar to the protocol specifications,
  20  * there are many mixed case field names in the structures below.  Although
  21  * this does not match typical Linux kernel style, it is necessary to be
  22  * able to match against the protocol specfication.
  23  *
  24  * SMB2 commands
  25  * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
  26  * (ie no useful data other than the SMB error code itself) and are marked such.
  27  * Knowing this helps avoid response buffer allocations and copy in some cases.
  28  */
  29
  30 /* List of commands in host endian */
  31 #define SMB2_NEGOTIATE_HE       0x0000
  32 #define SMB2_SESSION_SETUP_HE   0x0001
  33 #define SMB2_LOGOFF_HE          0x0002 /* trivial request/resp */
  34 #define SMB2_TREE_CONNECT_HE    0x0003
  35 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
  36 #define SMB2_CREATE_HE          0x0005
  37 #define SMB2_CLOSE_HE           0x0006
  38 #define SMB2_FLUSH_HE           0x0007 /* trivial resp */
  39 #define SMB2_READ_HE            0x0008
  40 #define SMB2_WRITE_HE           0x0009
  41 #define SMB2_LOCK_HE            0x000A
  42 #define SMB2_IOCTL_HE           0x000B
  43 #define SMB2_CANCEL_HE          0x000C
  44 #define SMB2_ECHO_HE            0x000D
  45 #define SMB2_QUERY_DIRECTORY_HE 0x000E
  46 #define SMB2_CHANGE_NOTIFY_HE   0x000F
  47 #define SMB2_QUERY_INFO_HE      0x0010
  48 #define SMB2_SET_INFO_HE        0x0011
  49 #define SMB2_OPLOCK_BREAK_HE    0x0012
  50
  51 /* The same list in little endian */
  52 #define SMB2_NEGOTIATE          cpu_to_le16(SMB2_NEGOTIATE_HE)
  53 #define SMB2_SESSION_SETUP      cpu_to_le16(SMB2_SESSION_SETUP_HE)
  54 #define SMB2_LOGOFF             cpu_to_le16(SMB2_LOGOFF_HE)
  55 #define SMB2_TREE_CONNECT       cpu_to_le16(SMB2_TREE_CONNECT_HE)
  56 #define SMB2_TREE_DISCONNECT    cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
  57 #define SMB2_CREATE             cpu_to_le16(SMB2_CREATE_HE)
  58 #define SMB2_CLOSE              cpu_to_le16(SMB2_CLOSE_HE)
  59 #define SMB2_FLUSH              cpu_to_le16(SMB2_FLUSH_HE)
  60 #define SMB2_READ               cpu_to_le16(SMB2_READ_HE)
  61 #define SMB2_WRITE              cpu_to_le16(SMB2_WRITE_HE)
  62 #define SMB2_LOCK               cpu_to_le16(SMB2_LOCK_HE)
  63 #define SMB2_IOCTL              cpu_to_le16(SMB2_IOCTL_HE)
  64 #define SMB2_CANCEL             cpu_to_le16(SMB2_CANCEL_HE)
  65 #define SMB2_ECHO               cpu_to_le16(SMB2_ECHO_HE)
  66 #define SMB2_QUERY_DIRECTORY    cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
  67 #define SMB2_CHANGE_NOTIFY      cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
  68 #define SMB2_QUERY_INFO         cpu_to_le16(SMB2_QUERY_INFO_HE)
  69 #define SMB2_SET_INFO           cpu_to_le16(SMB2_SET_INFO_HE)
  70 #define SMB2_OPLOCK_BREAK       cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
  71
  72 #define SMB2_INTERNAL_CMD       cpu_to_le16(0xFFFF)
  73
  74 #define NUMBER_OF_SMB2_COMMANDS 0x0013
  75
  76 /* 52 transform hdr + 64 hdr + 88 create rsp */
  77 #define SMB2_TRANSFORM_HEADER_SIZE 52
  78 #define MAX_SMB2_HDR_SIZE 204
  79
  80 #define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
  81 #define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
  82 #define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)
  83
  84 /*
  85  * SMB2 Header Definition
  86  *
  87  * "MBZ" :  Must be Zero
  88  * "BB"  :  BugBug, Something to check/review/analyze later
  89  * "PDU" :  "Protocol Data Unit" (ie a network "frame")
  90  *
  91  */
  92
  93 #define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
  94
  95 struct smb2_sync_hdr {
  96         __le32 ProtocolId;      /* 0xFE 'S' 'M' 'B' */
  97         __le16 StructureSize;   /* 64 */
  98         __le16 CreditCharge;    /* MBZ */
  99         __le32 Status;          /* Error from server */
 100         __le16 Command;
 101         __le16 CreditRequest;  /* CreditResponse */
 102         __le32 Flags;
 103         __le32 NextCommand;
 104         __le64 MessageId;
 105         __le32 ProcessId;
 106         __u32  TreeId;          /* opaque - so do not make little endian */
 107         __u64  SessionId;       /* opaque - so do not make little endian */
 108         __u8   Signature[16];
 109 } __packed;
 110
 111 /* The total header size for SMB2 read and write */
 112 #define SMB2_READWRITE_PDU_HEADER_SIZE (48 + sizeof(struct smb2_sync_hdr))
 113
 114 struct smb2_sync_pdu {
 115         struct smb2_sync_hdr sync_hdr;
 116         __le16 StructureSize2; /* size of wct area (varies, request specific) */
 117 } __packed;
 118
 119 #define SMB3_AES_CCM_NONCE 11
 120 #define SMB3_AES_GCM_NONCE 12
 121
 122 /* Transform flags (for 3.0 dialect this flag indicates CCM */
 123 #define TRANSFORM_FLAG_ENCRYPTED        0x0001
 124 struct smb2_transform_hdr {
 125         __le32 ProtocolId;      /* 0xFD 'S' 'M' 'B' */
 126         __u8   Signature[16];
 127         __u8   Nonce[16];
 128         __le32 OriginalMessageSize;
 129         __u16  Reserved1;
 130         __le16 Flags; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
 131         __u64  SessionId;
 132 } __packed;
 133
 134 /* See MS-SMB2 2.2.42 */
 135 struct smb2_compression_transform_hdr_unchained {
 136         __le32 ProtocolId;      /* 0xFC 'S' 'M' 'B' */
 137         __le32 OriginalCompressedSegmentSize;
 138         __le16 CompressionAlgorithm;
 139         __le16 Flags;
 140         __le16 Length; /* if chained it is length, else offset */
 141 } __packed;
 142
 143 /* See MS-SMB2 2.2.42.1 */
 144 #define SMB2_COMPRESSION_FLAG_NONE      0x0000
 145 #define SMB2_COMPRESSION_FLAG_CHAINED   0x0001
 146
 147 struct compression_payload_header {
 148         __le16  CompressionAlgorithm;
 149         __le16  Flags;
 150         __le32  Length; /* length of compressed playload including field below if present */
 151         /* __le32 OriginalPayloadSize; */ /* optional, present when LZNT1, LZ77, LZ77+Huffman */
 152 } __packed;
 153
 154 /* See MS-SMB2 2.2.42.2 */
 155 struct smb2_compression_transform_hdr_chained {
 156         __le32 ProtocolId;      /* 0xFC 'S' 'M' 'B' */
 157         __le32 OriginalCompressedSegmentSize;
 158         /* struct compression_payload_header[] */
 159 } __packed;
 160
 161 /* See MS-SMB2 2.2.42.2.2 */
 162 struct compression_pattern_payload_v1 {
 163         __le16  Pattern;
 164         __le16  Reserved1;
 165         __le16  Reserved2;
 166         __le32  Repetitions;
 167 } __packed;
 168
 169 /* See MS-SMB2 2.2.43 */
 170 struct smb2_rdma_transform {
 171         __le16 RdmaDescriptorOffset;
 172         __le16 RdmaDescriptorLength;
 173         __le32 Channel; /* for values see channel description in smb2 read above */
 174         __le16 TransformCount;
 175         __le16 Reserved1;
 176         __le32 Reserved2;
 177 } __packed;
 178
 179 /* TransformType */
 180 #define SMB2_RDMA_TRANSFORM_TYPE_ENCRYPTION     0x0001
 181 #define SMB2_RDMA_TRANSFORM_TYPE_SIGNING        0x0002
 182
 183 struct smb2_rdma_crypto_transform {
 184         __le16  TransformType;
 185         __le16  SignatureLength;
 186         __le16  NonceLength;
 187         __u16   Reserved;
 188         __u8    Signature[]; /* variable length */
 189         /* u8 Nonce[] */
 190         /* followed by padding */
 191 } __packed;
 192
 193 /*
 194  *      SMB2 flag definitions
 195  */
 196 #define SMB2_FLAGS_SERVER_TO_REDIR      cpu_to_le32(0x00000001)
 197 #define SMB2_FLAGS_ASYNC_COMMAND        cpu_to_le32(0x00000002)
 198 #define SMB2_FLAGS_RELATED_OPERATIONS   cpu_to_le32(0x00000004)
 199 #define SMB2_FLAGS_SIGNED               cpu_to_le32(0x00000008)
 200 #define SMB2_FLAGS_PRIORITY_MASK        cpu_to_le32(0x00000070) /* SMB3.1.1 */
 201 #define SMB2_FLAGS_DFS_OPERATIONS       cpu_to_le32(0x10000000)
 202 #define SMB2_FLAGS_REPLAY_OPERATION     cpu_to_le32(0x20000000) /* SMB3 & up */
 203
 204 /*
 205  *      Definitions for SMB2 Protocol Data Units (network frames)
 206  *
 207  *  See MS-SMB2.PDF specification for protocol details.
 208  *  The Naming convention is the lower case version of the SMB2
 209  *  command code name for the struct. Note that structures must be packed.
 210  *
 211  */
 212
 213 #define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
 214
 215 #define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
 216
 217 struct smb2_err_rsp {
 218         struct smb2_sync_hdr sync_hdr;
 219         __le16 StructureSize;
 220         __le16 Reserved; /* MBZ */
 221         __le32 ByteCount;  /* even if zero, at least one byte follows */
 222         __u8   ErrorData[1];  /* variable length */
 223 } __packed;
 224
 225 #define SYMLINK_ERROR_TAG 0x4c4d5953
 226
 227 struct smb2_symlink_err_rsp {
 228         __le32 SymLinkLength;
 229         __le32 SymLinkErrorTag;
 230         __le32 ReparseTag;
 231         __le16 ReparseDataLength;
 232         __le16 UnparsedPathLength;
 233         __le16 SubstituteNameOffset;
 234         __le16 SubstituteNameLength;
 235         __le16 PrintNameOffset;
 236         __le16 PrintNameLength;
 237         __le32 Flags;
 238         __u8  PathBuffer[];
 239 } __packed;
 240
 241 /* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
 242 struct smb2_error_context_rsp {
 243         __le32 ErrorDataLength;
 244         __le32 ErrorId;
 245         __u8  ErrorContextData; /* ErrorDataLength long array */
 246 } __packed;
 247
 248 /* ErrorId values */
 249 #define SMB2_ERROR_ID_DEFAULT           0x00000000
 250 #define SMB2_ERROR_ID_SHARE_REDIRECT    cpu_to_le32(0x72645253) /* "rdRS" */
 251
 252 /* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
 253 #define MOVE_DST_IPADDR_V4      cpu_to_le32(0x00000001)
 254 #define MOVE_DST_IPADDR_V6      cpu_to_le32(0x00000002)
 255
 256 struct move_dst_ipaddr {
 257         __le32 Type;
 258         __u32  Reserved;
 259         __u8   address[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
 260 } __packed;
 261
 262 struct share_redirect_error_context_rsp {
 263         __le32 StructureSize;
 264         __le32 NotificationType;
 265         __le32 ResourceNameOffset;
 266         __le32 ResourceNameLength;
 267         __le16 Reserved;
 268         __le16 TargetType;
 269         __le32 IPAddrCount;
 270         struct move_dst_ipaddr IpAddrMoveList[];
 271         /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
 272 } __packed;
 273
 274 #define SMB2_CLIENT_GUID_SIZE 16
 275
 276 struct smb2_negotiate_req {
 277         struct smb2_sync_hdr sync_hdr;
 278         __le16 StructureSize; /* Must be 36 */
 279         __le16 DialectCount;
 280         __le16 SecurityMode;
 281         __le16 Reserved;        /* MBZ */
 282         __le32 Capabilities;
 283         __u8   ClientGUID[SMB2_CLIENT_GUID_SIZE];
 284         /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
 285         __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
 286         __le16 NegotiateContextCount;  /* SMB3.1.1 only. MBZ earlier */
 287         __le16 Reserved2;
 288         __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
 289 } __packed;
 290
 291 /* Dialects */
 292 #define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
 293 #define SMB20_PROT_ID 0x0202
 294 #define SMB21_PROT_ID 0x0210
 295 #define SMB30_PROT_ID 0x0300
 296 #define SMB302_PROT_ID 0x0302
 297 #define SMB311_PROT_ID 0x0311
 298 #define BAD_PROT_ID   0xFFFF
 299
 300 /* SecurityMode flags */
 301 #define SMB2_NEGOTIATE_SIGNING_ENABLED  0x0001
 302 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
 303 #define SMB2_SEC_MODE_FLAGS_ALL         0x0003
 304
 305 /* Capabilities flags */
 306 #define SMB2_GLOBAL_CAP_DFS             0x00000001
 307 #define SMB2_GLOBAL_CAP_LEASING         0x00000002 /* Resp only New to SMB2.1 */
 308 #define SMB2_GLOBAL_CAP_LARGE_MTU       0X00000004 /* Resp only New to SMB2.1 */
 309 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL   0x00000008 /* New to SMB3 */
 310 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
 311 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING  0x00000020 /* New to SMB3 */
 312 #define SMB2_GLOBAL_CAP_ENCRYPTION      0x00000040 /* New to SMB3 */
 313 /* Internal types */
 314 #define SMB2_NT_FIND                    0x00100000
 315 #define SMB2_LARGE_FILES                0x00200000
 316
 317
 318 /* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
 319 #define SMB2_PREAUTH_INTEGRITY_CAPABILITIES     cpu_to_le16(1)
 320 #define SMB2_ENCRYPTION_CAPABILITIES            cpu_to_le16(2)
 321 #define SMB2_COMPRESSION_CAPABILITIES           cpu_to_le16(3)
 322 #define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID       cpu_to_le16(5)
 323 #define SMB2_TRANSPORT_CAPABILITIES             cpu_to_le16(6)
 324 #define SMB2_RDMA_TRANSFORM_CAPABILITIES        cpu_to_le16(7)
 325 #define SMB2_SIGNING_CAPABILITIES               cpu_to_le16(8)
 326 #define SMB2_POSIX_EXTENSIONS_AVAILABLE         cpu_to_le16(0x100)
 327
 328 struct smb2_neg_context {
 329         __le16  ContextType;
 330         __le16  DataLength;
 331         __le32  Reserved;
 332         /* Followed by array of data. NOTE: some servers require padding to 8 byte boundary */
 333 } __packed;
 334
 335 #define SMB311_LINUX_CLIENT_SALT_SIZE                   32
 336 /* Hash Algorithm Types */
 337 #define SMB2_PREAUTH_INTEGRITY_SHA512   cpu_to_le16(0x0001)
 338 #define SMB2_PREAUTH_HASH_SIZE 64
 339
 340 /*
 341  * SaltLength that the server send can be zero, so the only three required
 342  * fields (all __le16) end up six bytes total, so the minimum context data len
 343  * in the response is six bytes which accounts for
 344  *
 345  *      HashAlgorithmCount, SaltLength, and 1 HashAlgorithm.
 346  */
 347 #define MIN_PREAUTH_CTXT_DATA_LEN 6
 348
 349 struct smb2_preauth_neg_context {
 350         __le16  ContextType; /* 1 */
 351         __le16  DataLength;
 352         __le32  Reserved;
 353         __le16  HashAlgorithmCount; /* 1 */
 354         __le16  SaltLength;
 355         __le16  HashAlgorithms; /* HashAlgorithms[0] since only one defined */
 356         __u8    Salt[SMB311_LINUX_CLIENT_SALT_SIZE];
 357 } __packed;
 358
 359 /* Encryption Algorithms Ciphers */
 360 #define SMB2_ENCRYPTION_AES128_CCM      cpu_to_le16(0x0001)
 361 #define SMB2_ENCRYPTION_AES128_GCM      cpu_to_le16(0x0002)
 362 /* we currently do not request AES256_CCM since presumably GCM faster */
 363 #define SMB2_ENCRYPTION_AES256_CCM      cpu_to_le16(0x0003)
 364 #define SMB2_ENCRYPTION_AES256_GCM      cpu_to_le16(0x0004)
 365
 366 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
 367 #define MIN_ENCRYPT_CTXT_DATA_LEN       4
 368 struct smb2_encryption_neg_context {
 369         __le16  ContextType; /* 2 */
 370         __le16  DataLength;
 371         __le32  Reserved;
 372         /* CipherCount usally 2, but can be 3 when AES256-GCM enabled */
 373         __le16  CipherCount; /* AES128-GCM and AES128-CCM by default */
 374         __le16  Ciphers[3];
 375 } __packed;
 376
 377 /* See MS-SMB2 2.2.3.1.3 */
 378 #define SMB3_COMPRESS_NONE      cpu_to_le16(0x0000)
 379 #define SMB3_COMPRESS_LZNT1     cpu_to_le16(0x0001)
 380 #define SMB3_COMPRESS_LZ77      cpu_to_le16(0x0002)
 381 #define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
 382 /* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
 383 #define SMB3_COMPRESS_PATTERN   cpu_to_le16(0x0004) /* Pattern_V1 */
 384
 385 /* Compression Flags */
 386 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE         cpu_to_le32(0x00000000)
 387 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED      cpu_to_le32(0x00000001)
 388
 389 struct smb2_compression_capabilities_context {
 390         __le16  ContextType; /* 3 */
 391         __le16  DataLength;
 392         __u32   Reserved;
 393         __le16  CompressionAlgorithmCount;
 394         __u16   Padding;
 395         __u32   Flags;
 396         __le16  CompressionAlgorithms[3];
 397         /* Check if pad needed */
 398 } __packed;
 399
 400 /*
 401  * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
 402  * Its struct simply contains NetName, an array of Unicode characters
 403  */
 404 struct smb2_netname_neg_context {
 405         __le16  ContextType; /* 5 */
 406         __le16  DataLength;
 407         __le32  Reserved;
 408         __le16  NetName[]; /* hostname of target converted to UCS-2 */
 409 } __packed;
 410
 411 /*
 412  * For smb2_transport_capabilities context see MS-SMB2 2.2.3.1.5
 413  * and 2.2.4.1.5
 414  */
 415
 416 /* Flags */
 417 #define SMB2_ACCEPT_TRANSFORM_LEVEL_SECURITY    0x00000001
 418
 419 struct smb2_transport_capabilities_context {
 420         __le16  ContextType; /* 6 */
 421         __le16  DataLength;
 422         __u32   Reserved;
 423         __le32  Flags;
 424         __u32   Pad;
 425 } __packed;
 426
 427 /*
 428  * For rdma transform capabilities context see MS-SMB2 2.2.3.1.6
 429  * and 2.2.4.1.6
 430  */
 431
 432 /* RDMA Transform IDs */
 433 #define SMB2_RDMA_TRANSFORM_NONE        0x0000
 434 #define SMB2_RDMA_TRANSFORM_ENCRYPTION  0x0001
 435 #define SMB2_RDMA_TRANSFORM_SIGNING     0x0002
 436
 437 struct smb2_rdma_transform_capabilities_context {
 438         __le16  ContextType; /* 7 */
 439         __le16  DataLength;
 440         __u32   Reserved;
 441         __le16  TransformCount;
 442         __u16   Reserved1;
 443         __u32   Reserved2;
 444         __le16  RDMATransformIds[];
 445 } __packed;
 446
 447 /*
 448  * For signing capabilities context see MS-SMB2 2.2.3.1.7
 449  * and 2.2.4.1.7
 450  */
 451
 452 /* Signing algorithms */
 453 #define SIGNING_ALG_HMAC_SHA256 0
 454 #define SIGNING_ALG_AES_CMAC    1
 455 #define SIGNING_ALG_AES_GMAC    2
 456
 457 struct smb2_signing_capabilities {
 458         __le16  ContextType; /* 8 */
 459         __le16  DataLength;
 460         __u32   Reserved;
 461         __le16  SigningAlgorithmCount;
 462         __le16  SigningAlgorithms[];
 463         /*  Followed by padding to 8 byte boundary (required by some servers) */
 464 } __packed;
 465
 466 #define POSIX_CTXT_DATA_LEN     16
 467 struct smb2_posix_neg_context {
 468         __le16  ContextType; /* 0x100 */
 469         __le16  DataLength;
 470         __le32  Reserved;
 471         __u8    Name[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
 472 } __packed;
 473
 474 struct smb2_negotiate_rsp {
 475         struct smb2_sync_hdr sync_hdr;
 476         __le16 StructureSize;   /* Must be 65 */
 477         __le16 SecurityMode;
 478         __le16 DialectRevision;
 479         __le16 NegotiateContextCount;   /* Prior to SMB3.1.1 was Reserved & MBZ */
 480         __u8   ServerGUID[16];
 481         __le32 Capabilities;
 482         __le32 MaxTransactSize;
 483         __le32 MaxReadSize;
 484         __le32 MaxWriteSize;
 485         __le64 SystemTime;      /* MBZ */
 486         __le64 ServerStartTime;
 487         __le16 SecurityBufferOffset;
 488         __le16 SecurityBufferLength;
 489         __le32 NegotiateContextOffset;  /* Pre:SMB3.1.1 was reserved/ignored */
 490         __u8   Buffer[1];       /* variable length GSS security buffer */
 491 } __packed;
 492
 493 /* Flags */
 494 #define SMB2_SESSION_REQ_FLAG_BINDING           0x01
 495 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA      0x04
 496
 497 struct smb2_sess_setup_req {
 498         struct smb2_sync_hdr sync_hdr;
 499         __le16 StructureSize; /* Must be 25 */
 500         __u8   Flags;
 501         __u8   SecurityMode;
 502         __le32 Capabilities;
 503         __le32 Channel;
 504         __le16 SecurityBufferOffset;
 505         __le16 SecurityBufferLength;
 506         __u64 PreviousSessionId;
 507         __u8   Buffer[1];       /* variable length GSS security buffer */
 508 } __packed;
 509
 510 /* Currently defined SessionFlags */
 511 #define SMB2_SESSION_FLAG_IS_GUEST      0x0001
 512 #define SMB2_SESSION_FLAG_IS_NULL       0x0002
 513 #define SMB2_SESSION_FLAG_ENCRYPT_DATA  0x0004
 514 struct smb2_sess_setup_rsp {
 515         struct smb2_sync_hdr sync_hdr;
 516         __le16 StructureSize; /* Must be 9 */
 517         __le16 SessionFlags;
 518         __le16 SecurityBufferOffset;
 519         __le16 SecurityBufferLength;
 520         __u8   Buffer[1];       /* variable length GSS security buffer */
 521 } __packed;
 522
 523 struct smb2_logoff_req {
 524         struct smb2_sync_hdr sync_hdr;
 525         __le16 StructureSize;   /* Must be 4 */
 526         __le16 Reserved;
 527 } __packed;
 528
 529 struct smb2_logoff_rsp {
 530         struct smb2_sync_hdr sync_hdr;
 531         __le16 StructureSize;   /* Must be 4 */
 532         __le16 Reserved;
 533 } __packed;
 534
 535 /* Flags/Reserved for SMB3.1.1 */
 536 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
 537 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
 538 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
 539
 540 struct smb2_tree_connect_req {
 541         struct smb2_sync_hdr sync_hdr;
 542         __le16 StructureSize;   /* Must be 9 */
 543         __le16 Flags; /* Reserved MBZ for dialects prior to SMB3.1.1 */
 544         __le16 PathOffset;
 545         __le16 PathLength;
 546         __u8   Buffer[1];       /* variable length */
 547 } __packed;
 548
 549 /* See MS-SMB2 section 2.2.9.2 */
 550 /* Context Types */
 551 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
 552 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
 553
 554 struct tree_connect_contexts {
 555         __le16 ContextType;
 556         __le16 DataLength;
 557         __le32 Reserved;
 558         __u8   Data[];
 559 } __packed;
 560
 561 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
 562 struct smb3_blob_data {
 563         __le16 BlobSize;
 564         __u8   BlobData[];
 565 } __packed;
 566
 567 /* Valid values for Attr */
 568 #define SE_GROUP_MANDATORY              0x00000001
 569 #define SE_GROUP_ENABLED_BY_DEFAULT     0x00000002
 570 #define SE_GROUP_ENABLED                0x00000004
 571 #define SE_GROUP_OWNER                  0x00000008
 572 #define SE_GROUP_USE_FOR_DENY_ONLY      0x00000010
 573 #define SE_GROUP_INTEGRITY              0x00000020
 574 #define SE_GROUP_INTEGRITY_ENABLED      0x00000040
 575 #define SE_GROUP_RESOURCE               0x20000000
 576 #define SE_GROUP_LOGON_ID               0xC0000000
 577
 578 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
 579
 580 struct sid_array_data {
 581         __le16 SidAttrCount;
 582         /* SidAttrList - array of sid_attr_data structs */
 583 } __packed;
 584
 585 struct luid_attr_data {
 586
 587 } __packed;
 588
 589 /*
 590  * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
 591  * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
 592  */
 593
 594 struct privilege_array_data {
 595         __le16 PrivilegeCount;
 596         /* array of privilege_data structs */
 597 } __packed;
 598
 599 struct remoted_identity_tcon_context {
 600         __le16 TicketType; /* must be 0x0001 */
 601         __le16 TicketSize; /* total size of this struct */
 602         __le16 User; /* offset to SID_ATTR_DATA struct with user info */
 603         __le16 UserName; /* offset to null terminated Unicode username string */
 604         __le16 Domain; /* offset to null terminated Unicode domain name */
 605         __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
 606         __le16 RestrictedGroups; /* similar to above */
 607         __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
 608         __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
 609         __le16 Owner; /* offset to BLOB_DATA struct */
 610         __le16 DefaultDacl; /* offset to BLOB_DATA struct */
 611         __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
 612         __le16 UserClaims; /* offset to BLOB_DATA struct */
 613         __le16 DeviceClaims; /* offset to BLOB_DATA struct */
 614         __u8   TicketInfo[]; /* variable length buf - remoted identity data */
 615 } __packed;
 616
 617 struct smb2_tree_connect_req_extension {
 618         __le32 TreeConnectContextOffset;
 619         __le16 TreeConnectContextCount;
 620         __u8  Reserved[10];
 621         __u8  PathName[]; /* variable sized array */
 622         /* followed by array of TreeConnectContexts */
 623 } __packed;
 624
 625 struct smb2_tree_connect_rsp {
 626         struct smb2_sync_hdr sync_hdr;
 627         __le16 StructureSize;   /* Must be 16 */
 628         __u8   ShareType;  /* see below */
 629         __u8   Reserved;
 630         __le32 ShareFlags; /* see below */
 631         __le32 Capabilities; /* see below */
 632         __le32 MaximalAccess;
 633 } __packed;
 634
 635 /* Possible ShareType values */
 636 #define SMB2_SHARE_TYPE_DISK    0x01
 637 #define SMB2_SHARE_TYPE_PIPE    0x02
 638 #define SMB2_SHARE_TYPE_PRINT   0x03
 639
 640 /*
 641  * Possible ShareFlags - exactly one and only one of the first 4 caching flags
 642  * must be set (any of the remaining, SHI1005, flags may be set individually
 643  * or in combination.
 644  */
 645 #define SMB2_SHAREFLAG_MANUAL_CACHING                   0x00000000
 646 #define SMB2_SHAREFLAG_AUTO_CACHING                     0x00000010
 647 #define SMB2_SHAREFLAG_VDO_CACHING                      0x00000020
 648 #define SMB2_SHAREFLAG_NO_CACHING                       0x00000030
 649 #define SHI1005_FLAGS_DFS                               0x00000001
 650 #define SHI1005_FLAGS_DFS_ROOT                          0x00000002
 651 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS          0x00000100
 652 #define SHI1005_FLAGS_FORCE_SHARED_DELETE               0x00000200
 653 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING           0x00000400
 654 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM       0x00000800
 655 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK              0x00001000
 656 #define SHI1005_FLAGS_ENABLE_HASH_V1                    0x00002000
 657 #define SHI1005_FLAGS_ENABLE_HASH_V2                    0x00004000
 658 #define SHI1005_FLAGS_ENCRYPT_DATA                      0x00008000
 659 #define SMB2_SHAREFLAG_IDENTITY_REMOTING                0x00040000 /* 3.1.1 */
 660 #define SMB2_SHAREFLAG_COMPRESS_DATA                    0x00100000 /* 3.1.1 */
 661 #define SHI1005_FLAGS_ALL                               0x0014FF33
 662
 663 /* Possible share capabilities */
 664 #define SMB2_SHARE_CAP_DFS      cpu_to_le32(0x00000008) /* all dialects */
 665 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
 666 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
 667 #define SMB2_SHARE_CAP_CLUSTER  cpu_to_le32(0x00000040) /* 3.0 */
 668 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
 669 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
 670
 671 struct smb2_tree_disconnect_req {
 672         struct smb2_sync_hdr sync_hdr;
 673         __le16 StructureSize;   /* Must be 4 */
 674         __le16 Reserved;
 675 } __packed;
 676
 677 struct smb2_tree_disconnect_rsp {
 678         struct smb2_sync_hdr sync_hdr;
 679         __le16 StructureSize;   /* Must be 4 */
 680         __le16 Reserved;
 681 } __packed;
 682
 683 /* File Attrubutes */
 684 #define FILE_ATTRIBUTE_READONLY                 0x00000001
 685 #define FILE_ATTRIBUTE_HIDDEN                   0x00000002
 686 #define FILE_ATTRIBUTE_SYSTEM                   0x00000004
 687 #define FILE_ATTRIBUTE_DIRECTORY                0x00000010
 688 #define FILE_ATTRIBUTE_ARCHIVE                  0x00000020
 689 #define FILE_ATTRIBUTE_NORMAL                   0x00000080
 690 #define FILE_ATTRIBUTE_TEMPORARY                0x00000100
 691 #define FILE_ATTRIBUTE_SPARSE_FILE              0x00000200
 692 #define FILE_ATTRIBUTE_REPARSE_POINT            0x00000400
 693 #define FILE_ATTRIBUTE_COMPRESSED               0x00000800
 694 #define FILE_ATTRIBUTE_OFFLINE                  0x00001000
 695 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED      0x00002000
 696 #define FILE_ATTRIBUTE_ENCRYPTED                0x00004000
 697 #define FILE_ATTRIBUTE_INTEGRITY_STREAM         0x00008000
 698 #define FILE_ATTRIBUTE_NO_SCRUB_DATA            0x00020000
 699
 700 /* Oplock levels */
 701 #define SMB2_OPLOCK_LEVEL_NONE          0x00
 702 #define SMB2_OPLOCK_LEVEL_II            0x01
 703 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE     0x08
 704 #define SMB2_OPLOCK_LEVEL_BATCH         0x09
 705 #define SMB2_OPLOCK_LEVEL_LEASE         0xFF
 706 /* Non-spec internal type */
 707 #define SMB2_OPLOCK_LEVEL_NOCHANGE      0x99
 708
 709 /* Desired Access Flags */
 710 #define FILE_READ_DATA_LE               cpu_to_le32(0x00000001)
 711 #define FILE_WRITE_DATA_LE              cpu_to_le32(0x00000002)
 712 #define FILE_APPEND_DATA_LE             cpu_to_le32(0x00000004)
 713 #define FILE_READ_EA_LE                 cpu_to_le32(0x00000008)
 714 #define FILE_WRITE_EA_LE                cpu_to_le32(0x00000010)
 715 #define FILE_EXECUTE_LE                 cpu_to_le32(0x00000020)
 716 #define FILE_READ_ATTRIBUTES_LE         cpu_to_le32(0x00000080)
 717 #define FILE_WRITE_ATTRIBUTES_LE        cpu_to_le32(0x00000100)
 718 #define FILE_DELETE_LE                  cpu_to_le32(0x00010000)
 719 #define FILE_READ_CONTROL_LE            cpu_to_le32(0x00020000)
 720 #define FILE_WRITE_DAC_LE               cpu_to_le32(0x00040000)
 721 #define FILE_WRITE_OWNER_LE             cpu_to_le32(0x00080000)
 722 #define FILE_SYNCHRONIZE_LE             cpu_to_le32(0x00100000)
 723 #define FILE_ACCESS_SYSTEM_SECURITY_LE  cpu_to_le32(0x01000000)
 724 #define FILE_MAXIMAL_ACCESS_LE          cpu_to_le32(0x02000000)
 725 #define FILE_GENERIC_ALL_LE             cpu_to_le32(0x10000000)
 726 #define FILE_GENERIC_EXECUTE_LE         cpu_to_le32(0x20000000)
 727 #define FILE_GENERIC_WRITE_LE           cpu_to_le32(0x40000000)
 728 #define FILE_GENERIC_READ_LE            cpu_to_le32(0x80000000)
 729
 730 /* ShareAccess Flags */
 731 #define FILE_SHARE_READ_LE              cpu_to_le32(0x00000001)
 732 #define FILE_SHARE_WRITE_LE             cpu_to_le32(0x00000002)
 733 #define FILE_SHARE_DELETE_LE            cpu_to_le32(0x00000004)
 734 #define FILE_SHARE_ALL_LE               cpu_to_le32(0x00000007)
 735
 736 /* CreateDisposition Flags */
 737 #define FILE_SUPERSEDE_LE               cpu_to_le32(0x00000000)
 738 #define FILE_OPEN_LE                    cpu_to_le32(0x00000001)
 739 #define FILE_CREATE_LE                  cpu_to_le32(0x00000002)
 740 #define FILE_OPEN_IF_LE                 cpu_to_le32(0x00000003)
 741 #define FILE_OVERWRITE_LE               cpu_to_le32(0x00000004)
 742 #define FILE_OVERWRITE_IF_LE            cpu_to_le32(0x00000005)
 743
 744 /* CreateOptions Flags */
 745 #define FILE_DIRECTORY_FILE_LE          cpu_to_le32(0x00000001)
 746 /* same as #define CREATE_NOT_FILE_LE   cpu_to_le32(0x00000001) */
 747 #define FILE_WRITE_THROUGH_LE           cpu_to_le32(0x00000002)
 748 #define FILE_SEQUENTIAL_ONLY_LE         cpu_to_le32(0x00000004)
 749 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
 750 #define FILE_SYNCHRONOUS_IO_ALERT_LE    cpu_to_le32(0x00000010)
 751 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE        cpu_to_le32(0x00000020)
 752 #define FILE_NON_DIRECTORY_FILE_LE      cpu_to_le32(0x00000040)
 753 #define FILE_COMPLETE_IF_OPLOCKED_LE    cpu_to_le32(0x00000100)
 754 #define FILE_NO_EA_KNOWLEDGE_LE         cpu_to_le32(0x00000200)
 755 #define FILE_RANDOM_ACCESS_LE           cpu_to_le32(0x00000800)
 756 #define FILE_DELETE_ON_CLOSE_LE         cpu_to_le32(0x00001000)
 757 #define FILE_OPEN_BY_FILE_ID_LE         cpu_to_le32(0x00002000)
 758 #define FILE_OPEN_FOR_BACKUP_INTENT_LE  cpu_to_le32(0x00004000)
 759 #define FILE_NO_COMPRESSION_LE          cpu_to_le32(0x00008000)
 760 #define FILE_RESERVE_OPFILTER_LE        cpu_to_le32(0x00100000)
 761 #define FILE_OPEN_REPARSE_POINT_LE      cpu_to_le32(0x00200000)
 762 #define FILE_OPEN_NO_RECALL_LE          cpu_to_le32(0x00400000)
 763 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
 764
 765 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
 766                         | FILE_READ_ATTRIBUTES_LE)
 767 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
 768                         | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
 769 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
 770
 771 /* Impersonation Levels. See MS-WPO section 9.7 and MSDN-IMPERS */
 772 #define IL_ANONYMOUS            cpu_to_le32(0x00000000)
 773 #define IL_IDENTIFICATION       cpu_to_le32(0x00000001)
 774 #define IL_IMPERSONATION        cpu_to_le32(0x00000002)
 775 #define IL_DELEGATE             cpu_to_le32(0x00000003)
 776
 777 /* Create Context Values */
 778 #define SMB2_CREATE_EA_BUFFER                   "ExtA" /* extended attributes */
 779 #define SMB2_CREATE_SD_BUFFER                   "SecD" /* security descriptor */
 780 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST      "DHnQ"
 781 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT    "DHnC"
 782 #define SMB2_CREATE_ALLOCATION_SIZE             "AISi"
 783 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
 784 #define SMB2_CREATE_TIMEWARP_REQUEST            "TWrp"
 785 #define SMB2_CREATE_QUERY_ON_DISK_ID            "QFid"
 786 #define SMB2_CREATE_REQUEST_LEASE               "RqLs"
 787 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2   "DH2Q"
 788 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
 789 #define SMB2_CREATE_APP_INSTANCE_ID     0x45BCA66AEFA7F74A9008FA462E144D74
 790 #define SMB2_CREATE_APP_INSTANCE_VERSION 0xB982D0B73B56074FA07B524A8116A010
 791 #define SVHDX_OPEN_DEVICE_CONTEX        0x9CCBCF9E04C1E643980E158DA1F6EC83
 792 #define SMB2_CREATE_TAG_POSIX           0x93AD25509CB411E7B42383DE968BCD7C
 793
 794 /* Flag (SMB3 open response) values */
 795 #define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
 796
 797 /*
 798  * Maximum number of iovs we need for an open/create request.
 799  * [0] : struct smb2_create_req
 800  * [1] : path
 801  * [2] : lease context
 802  * [3] : durable context
 803  * [4] : posix context
 804  * [5] : time warp context
 805  * [6] : query id context
 806  * [7] : compound padding
 807  */
 808 #define SMB2_CREATE_IOV_SIZE 8
 809
 810 struct smb2_create_req {
 811         struct smb2_sync_hdr sync_hdr;
 812         __le16 StructureSize;   /* Must be 57 */
 813         __u8   SecurityFlags;
 814         __u8   RequestedOplockLevel;
 815         __le32 ImpersonationLevel;
 816         __le64 SmbCreateFlags;
 817         __le64 Reserved;
 818         __le32 DesiredAccess;
 819         __le32 FileAttributes;
 820         __le32 ShareAccess;
 821         __le32 CreateDisposition;
 822         __le32 CreateOptions;
 823         __le16 NameOffset;
 824         __le16 NameLength;
 825         __le32 CreateContextsOffset;
 826         __le32 CreateContextsLength;
 827         __u8   Buffer[];
 828 } __packed;
 829
 830 /*
 831  * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
 832  * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
 833  * 2 bytes of padding.
 834  */
 835 #define MAX_SMB2_CREATE_RESPONSE_SIZE 880
 836
 837 struct smb2_create_rsp {
 838         struct smb2_sync_hdr sync_hdr;
 839         __le16 StructureSize;   /* Must be 89 */
 840         __u8   OplockLevel;
 841         __u8   Flag;  /* 0x01 if reparse point */
 842         __le32 CreateAction;
 843         __le64 CreationTime;
 844         __le64 LastAccessTime;
 845         __le64 LastWriteTime;
 846         __le64 ChangeTime;
 847         __le64 AllocationSize;
 848         __le64 EndofFile;
 849         __le32 FileAttributes;
 850         __le32 Reserved2;
 851         __u64  PersistentFileId; /* opaque endianness */
 852         __u64  VolatileFileId; /* opaque endianness */
 853         __le32 CreateContextsOffset;
 854         __le32 CreateContextsLength;
 855         __u8   Buffer[1];
 856 } __packed;
 857
 858 struct create_context {
 859         __le32 Next;
 860         __le16 NameOffset;
 861         __le16 NameLength;
 862         __le16 Reserved;
 863         __le16 DataOffset;
 864         __le32 DataLength;
 865         __u8 Buffer[];
 866 } __packed;
 867
 868 #define SMB2_LEASE_READ_CACHING_HE      0x01
 869 #define SMB2_LEASE_HANDLE_CACHING_HE    0x02
 870 #define SMB2_LEASE_WRITE_CACHING_HE     0x04
 871
 872 #define SMB2_LEASE_NONE                 cpu_to_le32(0x00)
 873 #define SMB2_LEASE_READ_CACHING         cpu_to_le32(0x01)
 874 #define SMB2_LEASE_HANDLE_CACHING       cpu_to_le32(0x02)
 875 #define SMB2_LEASE_WRITE_CACHING        cpu_to_le32(0x04)
 876
 877 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x00000002)
 878 #define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
 879
 880 #define SMB2_LEASE_KEY_SIZE 16
 881
 882 struct lease_context {
 883         u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
 884         __le32 LeaseState;
 885         __le32 LeaseFlags;
 886         __le64 LeaseDuration;
 887 } __packed;
 888
 889 struct lease_context_v2 {
 890         u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
 891         __le32 LeaseState;
 892         __le32 LeaseFlags;
 893         __le64 LeaseDuration;
 894         __le64 ParentLeaseKeyLow;
 895         __le64 ParentLeaseKeyHigh;
 896         __le16 Epoch;
 897         __le16 Reserved;
 898 } __packed;
 899
 900 struct create_lease {
 901         struct create_context ccontext;
 902         __u8   Name[8];
 903         struct lease_context lcontext;
 904 } __packed;
 905
 906 struct create_lease_v2 {
 907         struct create_context ccontext;
 908         __u8   Name[8];
 909         struct lease_context_v2 lcontext;
 910         __u8   Pad[4];
 911 } __packed;
 912
 913 struct create_durable {
 914         struct create_context ccontext;
 915         __u8   Name[8];
 916         union {
 917                 __u8  Reserved[16];
 918                 struct {
 919                         __u64 PersistentFileId;
 920                         __u64 VolatileFileId;
 921                 } Fid;
 922         } Data;
 923 } __packed;
 924
 925 struct create_posix {
 926         struct create_context ccontext;
 927         __u8    Name[16];
 928         __le32  Mode;
 929         __u32   Reserved;
 930 } __packed;
 931
 932 /* See MS-SMB2 2.2.13.2.11 */
 933 /* Flags */
 934 #define SMB2_DHANDLE_FLAG_PERSISTENT    0x00000002
 935 struct durable_context_v2 {
 936         __le32 Timeout;
 937         __le32 Flags;
 938         __u64 Reserved;
 939         __u8 CreateGuid[16];
 940 } __packed;
 941
 942 struct create_durable_v2 {
 943         struct create_context ccontext;
 944         __u8   Name[8];
 945         struct durable_context_v2 dcontext;
 946 } __packed;
 947
 948 /* See MS-SMB2 2.2.13.2.12 */
 949 struct durable_reconnect_context_v2 {
 950         struct {
 951                 __u64 PersistentFileId;
 952                 __u64 VolatileFileId;
 953         } Fid;
 954         __u8 CreateGuid[16];
 955         __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
 956 } __packed;
 957
 958 /* See MS-SMB2 2.2.14.2.9 */
 959 struct create_on_disk_id {
 960         struct create_context ccontext;
 961         __u8   Name[8];
 962         __le64 DiskFileId;
 963         __le64 VolumeId;
 964         __u32  Reserved[4];
 965 } __packed;
 966
 967 /* See MS-SMB2 2.2.14.2.12 */
 968 struct durable_reconnect_context_v2_rsp {
 969         __le32 Timeout;
 970         __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
 971 } __packed;
 972
 973 struct create_durable_handle_reconnect_v2 {
 974         struct create_context ccontext;
 975         __u8   Name[8];
 976         struct durable_reconnect_context_v2 dcontext;
 977         __u8   Pad[4];
 978 } __packed;
 979
 980 /* See MS-SMB2 2.2.13.2.5 */
 981 struct crt_twarp_ctxt {
 982         struct create_context ccontext;
 983         __u8    Name[8];
 984         __le64  Timestamp;
 985
 986 } __packed;
 987
 988 /* See MS-SMB2 2.2.13.2.9 */
 989 struct crt_query_id_ctxt {
 990         struct create_context ccontext;
 991         __u8    Name[8];
 992 } __packed;
 993
 994 struct crt_sd_ctxt {
 995         struct create_context ccontext;
 996         __u8    Name[8];
 997         struct smb3_sd sd;
 998 } __packed;
 999
1000
1001 #define COPY_CHUNK_RES_KEY_SIZE 24
1002 struct resume_key_req {
1003         char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
1004         __le32  ContextLength;  /* MBZ */
1005         char    Context[];      /* ignored, Windows sets to 4 bytes of zero */
1006 } __packed;
1007
1008 /* this goes in the ioctl buffer when doing a copychunk request */
1009 struct copychunk_ioctl {
1010         char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
1011         __le32 ChunkCount; /* we are only sending 1 */
1012         __le32 Reserved;
1013         /* array will only be one chunk long for us */
1014         __le64 SourceOffset;
1015         __le64 TargetOffset;
1016         __le32 Length; /* how many bytes to copy */
1017         __u32 Reserved2;
1018 } __packed;
1019
1020 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
1021 struct file_zero_data_information {
1022         __le64  FileOffset;
1023         __le64  BeyondFinalZero;
1024 } __packed;
1025
1026 struct copychunk_ioctl_rsp {
1027         __le32 ChunksWritten;
1028         __le32 ChunkBytesWritten;
1029         __le32 TotalBytesWritten;
1030 } __packed;
1031
1032 /* See MS-FSCC 2.3.29 and 2.3.30 */
1033 struct get_retrieval_pointer_count_req {
1034         __le64 StartingVcn; /* virtual cluster number (signed) */
1035 } __packed;
1036
1037 struct get_retrieval_pointer_count_rsp {
1038         __le32 ExtentCount;
1039 } __packed;
1040
1041 /*
1042  * See MS-FSCC 2.3.33 and 2.3.34
1043  * request is the same as get_retrieval_point_count_req struct above
1044  */
1045 struct smb3_extents {
1046         __le64 NextVcn;
1047         __le64 Lcn; /* logical cluster number */
1048 } __packed;
1049
1050 struct get_retrieval_pointers_refcount_rsp {
1051         __le32 ExtentCount;
1052         __u32  Reserved;
1053         __le64 StartingVcn;
1054         struct smb3_extents extents[];
1055 } __packed;
1056
1057 struct fsctl_set_integrity_information_req {
1058         __le16  ChecksumAlgorithm;
1059         __le16  Reserved;
1060         __le32  Flags;
1061 } __packed;
1062
1063 struct fsctl_get_integrity_information_rsp {
1064         __le16  ChecksumAlgorithm;
1065         __le16  Reserved;
1066         __le32  Flags;
1067         __le32  ChecksumChunkSizeInBytes;
1068         __le32  ClusterSizeInBytes;
1069 } __packed;
1070
1071 struct file_allocated_range_buffer {
1072         __le64  file_offset;
1073         __le64  length;
1074 } __packed;
1075
1076 /* Integrity ChecksumAlgorithm choices for above */
1077 #define CHECKSUM_TYPE_NONE      0x0000
1078 #define CHECKSUM_TYPE_CRC64     0x0002
1079 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF  /* set only */
1080
1081 /* Integrity flags for above */
1082 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF   0x00000001
1083
1084 /* Reparse structures - see MS-FSCC 2.1.2 */
1085
1086 /* struct fsctl_reparse_info_req is empty, only response structs (see below) */
1087
1088 struct reparse_data_buffer {
1089         __le32  ReparseTag;
1090         __le16  ReparseDataLength;
1091         __u16   Reserved;
1092         __u8    DataBuffer[]; /* Variable Length */
1093 } __packed;
1094
1095 struct reparse_guid_data_buffer {
1096         __le32  ReparseTag;
1097         __le16  ReparseDataLength;
1098         __u16   Reserved;
1099         __u8    ReparseGuid[16];
1100         __u8    DataBuffer[]; /* Variable Length */
1101 } __packed;
1102
1103 struct reparse_mount_point_data_buffer {
1104         __le32  ReparseTag;
1105         __le16  ReparseDataLength;
1106         __u16   Reserved;
1107         __le16  SubstituteNameOffset;
1108         __le16  SubstituteNameLength;
1109         __le16  PrintNameOffset;
1110         __le16  PrintNameLength;
1111         __u8    PathBuffer[]; /* Variable Length */
1112 } __packed;
1113
1114 #define SYMLINK_FLAG_RELATIVE 0x00000001
1115
1116 struct reparse_symlink_data_buffer {
1117         __le32  ReparseTag;
1118         __le16  ReparseDataLength;
1119         __u16   Reserved;
1120         __le16  SubstituteNameOffset;
1121         __le16  SubstituteNameLength;
1122         __le16  PrintNameOffset;
1123         __le16  PrintNameLength;
1124         __le32  Flags;
1125         __u8    PathBuffer[]; /* Variable Length */
1126 } __packed;
1127
1128 /* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
1129
1130
1131 /* See MS-DFSC 2.2.2 */
1132 struct fsctl_get_dfs_referral_req {
1133         __le16 MaxReferralLevel;
1134         __u8 RequestFileName[];
1135 } __packed;
1136
1137 /* DFS response is struct get_dfs_refer_rsp */
1138
1139 /* See MS-SMB2 2.2.31.3 */
1140 struct network_resiliency_req {
1141         __le32 Timeout;
1142         __le32 Reserved;
1143 } __packed;
1144 /* There is no buffer for the response ie no struct network_resiliency_rsp */
1145
1146
1147 struct validate_negotiate_info_req {
1148         __le32 Capabilities;
1149         __u8   Guid[SMB2_CLIENT_GUID_SIZE];
1150         __le16 SecurityMode;
1151         __le16 DialectCount;
1152         __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
1153 } __packed;
1154
1155 struct validate_negotiate_info_rsp {
1156         __le32 Capabilities;
1157         __u8   Guid[SMB2_CLIENT_GUID_SIZE];
1158         __le16 SecurityMode;
1159         __le16 Dialect; /* Dialect in use for the connection */
1160 } __packed;
1161
1162 #define RSS_CAPABLE     cpu_to_le32(0x00000001)
1163 #define RDMA_CAPABLE    cpu_to_le32(0x00000002)
1164
1165 #define INTERNETWORK    cpu_to_le16(0x0002)
1166 #define INTERNETWORKV6  cpu_to_le16(0x0017)
1167
1168 struct network_interface_info_ioctl_rsp {
1169         __le32 Next; /* next interface. zero if this is last one */
1170         __le32 IfIndex;
1171         __le32 Capability; /* RSS or RDMA Capable */
1172         __le32 Reserved;
1173         __le64 LinkSpeed;
1174         __le16 Family;
1175         __u8 Buffer[126];
1176 } __packed;
1177
1178 struct iface_info_ipv4 {
1179         __be16 Port;
1180         __be32 IPv4Address;
1181         __be64 Reserved;
1182 } __packed;
1183
1184 struct iface_info_ipv6 {
1185         __be16 Port;
1186         __be32 FlowInfo;
1187         __u8   IPv6Address[16];
1188         __be32 ScopeId;
1189 } __packed;
1190
1191 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
1192
1193 struct compress_ioctl {
1194         __le16 CompressionState; /* See cifspdu.h for possible flag values */
1195 } __packed;
1196
1197 struct duplicate_extents_to_file {
1198         __u64 PersistentFileHandle; /* source file handle, opaque endianness */
1199         __u64 VolatileFileHandle;
1200         __le64 SourceFileOffset;
1201         __le64 TargetFileOffset;
1202         __le64 ByteCount;  /* Bytes to be copied */
1203 } __packed;
1204
1205 /*
1206  * Maximum number of iovs we need for an ioctl request.
1207  * [0] : struct smb2_ioctl_req
1208  * [1] : in_data
1209  */
1210 #define SMB2_IOCTL_IOV_SIZE 2
1211
1212 struct smb2_ioctl_req {
1213         struct smb2_sync_hdr sync_hdr;
1214         __le16 StructureSize;   /* Must be 57 */
1215         __u16 Reserved;
1216         __le32 CtlCode;
1217         __u64  PersistentFileId; /* opaque endianness */
1218         __u64  VolatileFileId; /* opaque endianness */
1219         __le32 InputOffset;
1220         __le32 InputCount;
1221         __le32 MaxInputResponse;
1222         __le32 OutputOffset;
1223         __le32 OutputCount;
1224         __le32 MaxOutputResponse;
1225         __le32 Flags;
1226         __u32  Reserved2;
1227         __u8   Buffer[];
1228 } __packed;
1229
1230 struct smb2_ioctl_rsp {
1231         struct smb2_sync_hdr sync_hdr;
1232         __le16 StructureSize;   /* Must be 57 */
1233         __u16 Reserved;
1234         __le32 CtlCode;
1235         __u64  PersistentFileId; /* opaque endianness */
1236         __u64  VolatileFileId; /* opaque endianness */
1237         __le32 InputOffset;
1238         __le32 InputCount;
1239         __le32 OutputOffset;
1240         __le32 OutputCount;
1241         __le32 Flags;
1242         __u32  Reserved2;
1243         /* char * buffer[] */
1244 } __packed;
1245
1246 /* Currently defined values for close flags */
1247 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB        cpu_to_le16(0x0001)
1248 struct smb2_close_req {
1249         struct smb2_sync_hdr sync_hdr;
1250         __le16 StructureSize;   /* Must be 24 */
1251         __le16 Flags;
1252         __le32 Reserved;
1253         __u64  PersistentFileId; /* opaque endianness */
1254         __u64  VolatileFileId; /* opaque endianness */
1255 } __packed;
1256
1257 /*
1258  * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
1259  */
1260 #define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
1261
1262 struct smb2_close_rsp {
1263         struct smb2_sync_hdr sync_hdr;
1264         __le16 StructureSize; /* 60 */
1265         __le16 Flags;
1266         __le32 Reserved;
1267         __le64 CreationTime;
1268         __le64 LastAccessTime;
1269         __le64 LastWriteTime;
1270         __le64 ChangeTime;
1271         __le64 AllocationSize;  /* Beginning of FILE_STANDARD_INFO equivalent */
1272         __le64 EndOfFile;
1273         __le32 Attributes;
1274 } __packed;
1275
1276 struct smb2_flush_req {
1277         struct smb2_sync_hdr sync_hdr;
1278         __le16 StructureSize;   /* Must be 24 */
1279         __le16 Reserved1;
1280         __le32 Reserved2;
1281         __u64  PersistentFileId; /* opaque endianness */
1282         __u64  VolatileFileId; /* opaque endianness */
1283 } __packed;
1284
1285 struct smb2_flush_rsp {
1286         struct smb2_sync_hdr sync_hdr;
1287         __le16 StructureSize;
1288         __le16 Reserved;
1289 } __packed;
1290
1291 /* For read request Flags field below, following flag is defined for SMB3.02 */
1292 #define SMB2_READFLAG_READ_UNBUFFERED   0x01
1293 #define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
1294
1295 /* Channel field for read and write: exactly one of following flags can be set*/
1296 #define SMB2_CHANNEL_NONE       cpu_to_le32(0x00000000)
1297 #define SMB2_CHANNEL_RDMA_V1    cpu_to_le32(0x00000001) /* SMB3 or later */
1298 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1299 #define SMB2_CHANNEL_RDMA_TRANSFORM cpu_to_le32(0x00000003) /* >= SMB3.02, only used on write */
1300
1301 /* SMB2 read request without RFC1001 length at the beginning */
1302 struct smb2_read_plain_req {
1303         struct smb2_sync_hdr sync_hdr;
1304         __le16 StructureSize; /* Must be 49 */
1305         __u8   Padding; /* offset from start of SMB2 header to place read */
1306         __u8   Flags; /* MBZ unless SMB3.02 or later */
1307         __le32 Length;
1308         __le64 Offset;
1309         __u64  PersistentFileId; /* opaque endianness */
1310         __u64  VolatileFileId; /* opaque endianness */
1311         __le32 MinimumCount;
1312         __le32 Channel; /* MBZ except for SMB3 or later */
1313         __le32 RemainingBytes;
1314         __le16 ReadChannelInfoOffset;
1315         __le16 ReadChannelInfoLength;
1316         __u8   Buffer[1];
1317 } __packed;
1318
1319 /* Read flags */
1320 #define SMB2_READFLAG_RESPONSE_NONE     0x00000000
1321 #define SMB2_READFLAG_RESPONSE_RDMA_TRANSFORM   0x00000001
1322
1323 struct smb2_read_rsp {
1324         struct smb2_sync_hdr sync_hdr;
1325         __le16 StructureSize; /* Must be 17 */
1326         __u8   DataOffset;
1327         __u8   Reserved;
1328         __le32 DataLength;
1329         __le32 DataRemaining;
1330         __u32  Flags;
1331         __u8   Buffer[1];
1332 } __packed;
1333
1334 /* For write request Flags field below the following flags are defined: */
1335 #define SMB2_WRITEFLAG_WRITE_THROUGH    0x00000001      /* SMB2.1 or later */
1336 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002      /* SMB3.02 or later */
1337
1338 struct smb2_write_req {
1339         struct smb2_sync_hdr sync_hdr;
1340         __le16 StructureSize; /* Must be 49 */
1341         __le16 DataOffset; /* offset from start of SMB2 header to write data */
1342         __le32 Length;
1343         __le64 Offset;
1344         __u64  PersistentFileId; /* opaque endianness */
1345         __u64  VolatileFileId; /* opaque endianness */
1346         __le32 Channel; /* MBZ unless SMB3.02 or later */
1347         __le32 RemainingBytes;
1348         __le16 WriteChannelInfoOffset;
1349         __le16 WriteChannelInfoLength;
1350         __le32 Flags;
1351         __u8   Buffer[1];
1352 } __packed;
1353
1354 struct smb2_write_rsp {
1355         struct smb2_sync_hdr sync_hdr;
1356         __le16 StructureSize; /* Must be 17 */
1357         __u8   DataOffset;
1358         __u8   Reserved;
1359         __le32 DataLength;
1360         __le32 DataRemaining;
1361         __u32  Reserved2;
1362         __u8   Buffer[1];
1363 } __packed;
1364
1365 /* notify flags */
1366 #define SMB2_WATCH_TREE                 0x0001
1367
1368 /* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
1369 #define FILE_NOTIFY_CHANGE_FILE_NAME            0x00000001
1370 #define FILE_NOTIFY_CHANGE_DIR_NAME             0x00000002
1371 #define FILE_NOTIFY_CHANGE_ATTRIBUTES           0x00000004
1372 #define FILE_NOTIFY_CHANGE_SIZE                 0x00000008
1373 #define FILE_NOTIFY_CHANGE_LAST_WRITE           0x00000010
1374 #define FILE_NOTIFY_CHANGE_LAST_ACCESS          0x00000020
1375 #define FILE_NOTIFY_CHANGE_CREATION             0x00000040
1376 #define FILE_NOTIFY_CHANGE_EA                   0x00000080
1377 #define FILE_NOTIFY_CHANGE_SECURITY             0x00000100
1378 #define FILE_NOTIFY_CHANGE_STREAM_NAME          0x00000200
1379 #define FILE_NOTIFY_CHANGE_STREAM_SIZE          0x00000400
1380 #define FILE_NOTIFY_CHANGE_STREAM_WRITE         0x00000800
1381
1382 struct smb2_change_notify_req {
1383         struct smb2_sync_hdr sync_hdr;
1384         __le16  StructureSize;
1385         __le16  Flags;
1386         __le32  OutputBufferLength;
1387         __u64   PersistentFileId; /* opaque endianness */
1388         __u64   VolatileFileId; /* opaque endianness */
1389         __le32  CompletionFilter;
1390         __u32   Reserved;
1391 } __packed;
1392
1393 struct smb2_change_notify_rsp {
1394         struct smb2_sync_hdr sync_hdr;
1395         __le16  StructureSize;  /* Must be 9 */
1396         __le16  OutputBufferOffset;
1397         __le32  OutputBufferLength;
1398         __u8    Buffer[1]; /* array of file notify structs */
1399 } __packed;
1400
1401 #define SMB2_LOCKFLAG_SHARED_LOCK       0x0001
1402 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK    0x0002
1403 #define SMB2_LOCKFLAG_UNLOCK            0x0004
1404 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY  0x0010
1405
1406 struct smb2_lock_element {
1407         __le64 Offset;
1408         __le64 Length;
1409         __le32 Flags;
1410         __le32 Reserved;
1411 } __packed;
1412
1413 struct smb2_lock_req {
1414         struct smb2_sync_hdr sync_hdr;
1415         __le16 StructureSize; /* Must be 48 */
1416         __le16 LockCount;
1417         /*
1418          * The least significant four bits are the index, the other 28 bits are
1419          * the lock sequence number (0 to 64). See MS-SMB2 2.2.26
1420          */
1421         __le32 LockSequenceNumber;
1422         __u64  PersistentFileId; /* opaque endianness */
1423         __u64  VolatileFileId; /* opaque endianness */
1424         /* Followed by at least one */
1425         struct smb2_lock_element locks[1];
1426 } __packed;
1427
1428 struct smb2_lock_rsp {
1429         struct smb2_sync_hdr sync_hdr;
1430         __le16 StructureSize; /* Must be 4 */
1431         __le16 Reserved;
1432 } __packed;
1433
1434 struct smb2_echo_req {
1435         struct smb2_sync_hdr sync_hdr;
1436         __le16 StructureSize;   /* Must be 4 */
1437         __u16  Reserved;
1438 } __packed;
1439
1440 struct smb2_echo_rsp {
1441         struct smb2_sync_hdr sync_hdr;
1442         __le16 StructureSize;   /* Must be 4 */
1443         __u16  Reserved;
1444 } __packed;
1445
1446 /* search (query_directory) Flags field */
1447 #define SMB2_RESTART_SCANS              0x01
1448 #define SMB2_RETURN_SINGLE_ENTRY        0x02
1449 #define SMB2_INDEX_SPECIFIED            0x04
1450 #define SMB2_REOPEN                     0x10
1451
1452 #define SMB2_QUERY_DIRECTORY_IOV_SIZE 2
1453
1454 /*
1455  * Valid FileInformation classes.
1456  *
1457  * Note that these are a subset of the (file) QUERY_INFO levels defined
1458  * later in this file (but since QUERY_DIRECTORY uses equivalent numbers
1459  * we do not redefine them here)
1460  *
1461  * FileDirectoryInfomation              0x01
1462  * FileFullDirectoryInformation         0x02
1463  * FileIdFullDirectoryInformation       0x26
1464  * FileBothDirectoryInformation         0x03
1465  * FileIdBothDirectoryInformation       0x25
1466  * FileNamesInformation                 0x0C
1467  * FileIdExtdDirectoryInformation       0x3C
1468  */
1469
1470 struct smb2_query_directory_req {
1471         struct smb2_sync_hdr sync_hdr;
1472         __le16 StructureSize; /* Must be 33 */
1473         __u8   FileInformationClass;
1474         __u8   Flags;
1475         __le32 FileIndex;
1476         __u64  PersistentFileId; /* opaque endianness */
1477         __u64  VolatileFileId; /* opaque endianness */
1478         __le16 FileNameOffset;
1479         __le16 FileNameLength;
1480         __le32 OutputBufferLength;
1481         __u8   Buffer[1];
1482 } __packed;
1483
1484 struct smb2_query_directory_rsp {
1485         struct smb2_sync_hdr sync_hdr;
1486         __le16 StructureSize; /* Must be 9 */
1487         __le16 OutputBufferOffset;
1488         __le32 OutputBufferLength;
1489         __u8   Buffer[1];
1490 } __packed;
1491
1492 /* Possible InfoType values */
1493 #define SMB2_O_INFO_FILE        0x01
1494 #define SMB2_O_INFO_FILESYSTEM  0x02
1495 #define SMB2_O_INFO_SECURITY    0x03
1496 #define SMB2_O_INFO_QUOTA       0x04
1497
1498 /* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1499 #define OWNER_SECINFO   0x00000001
1500 #define GROUP_SECINFO   0x00000002
1501 #define DACL_SECINFO   0x00000004
1502 #define SACL_SECINFO   0x00000008
1503 #define LABEL_SECINFO   0x00000010
1504 #define ATTRIBUTE_SECINFO   0x00000020
1505 #define SCOPE_SECINFO   0x00000040
1506 #define BACKUP_SECINFO   0x00010000
1507 #define UNPROTECTED_SACL_SECINFO   0x10000000
1508 #define UNPROTECTED_DACL_SECINFO   0x20000000
1509 #define PROTECTED_SACL_SECINFO   0x40000000
1510 #define PROTECTED_DACL_SECINFO   0x80000000
1511
1512 /* Flags used for FileFullEAinfo */
1513 #define SL_RESTART_SCAN         0x00000001
1514 #define SL_RETURN_SINGLE_ENTRY  0x00000002
1515 #define SL_INDEX_SPECIFIED      0x00000004
1516
1517 struct smb2_query_info_req {
1518         struct smb2_sync_hdr sync_hdr;
1519         __le16 StructureSize; /* Must be 41 */
1520         __u8   InfoType;
1521         __u8   FileInfoClass;
1522         __le32 OutputBufferLength;
1523         __le16 InputBufferOffset;
1524         __u16  Reserved;
1525         __le32 InputBufferLength;
1526         __le32 AdditionalInformation;
1527         __le32 Flags;
1528         __u64  PersistentFileId; /* opaque endianness */
1529         __u64  VolatileFileId; /* opaque endianness */
1530         __u8   Buffer[1];
1531 } __packed;
1532
1533 struct smb2_query_info_rsp {
1534         struct smb2_sync_hdr sync_hdr;
1535         __le16 StructureSize; /* Must be 9 */
1536         __le16 OutputBufferOffset;
1537         __le32 OutputBufferLength;
1538         __u8   Buffer[1];
1539 } __packed;
1540
1541 /*
1542  * Maximum number of iovs we need for a set-info request.
1543  * The largest one is rename/hardlink
1544  * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
1545  * [1] : path
1546  * [2] : compound padding
1547  */
1548 #define SMB2_SET_INFO_IOV_SIZE 3
1549
1550 struct smb2_set_info_req {
1551         struct smb2_sync_hdr sync_hdr;
1552         __le16 StructureSize; /* Must be 33 */
1553         __u8   InfoType;
1554         __u8   FileInfoClass;
1555         __le32 BufferLength;
1556         __le16 BufferOffset;
1557         __u16  Reserved;
1558         __le32 AdditionalInformation;
1559         __u64  PersistentFileId; /* opaque endianness */
1560         __u64  VolatileFileId; /* opaque endianness */
1561         __u8   Buffer[1];
1562 } __packed;
1563
1564 struct smb2_set_info_rsp {
1565         struct smb2_sync_hdr sync_hdr;
1566         __le16 StructureSize; /* Must be 2 */
1567 } __packed;
1568
1569 struct smb2_oplock_break {
1570         struct smb2_sync_hdr sync_hdr;
1571         __le16 StructureSize; /* Must be 24 */
1572         __u8   OplockLevel;
1573         __u8   Reserved;
1574         __le32 Reserved2;
1575         __u64  PersistentFid;
1576         __u64  VolatileFid;
1577 } __packed;
1578
1579 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1580
1581 struct smb2_lease_break {
1582         struct smb2_sync_hdr sync_hdr;
1583         __le16 StructureSize; /* Must be 44 */
1584         __le16 Epoch;
1585         __le32 Flags;
1586         __u8   LeaseKey[16];
1587         __le32 CurrentLeaseState;
1588         __le32 NewLeaseState;
1589         __le32 BreakReason;
1590         __le32 AccessMaskHint;
1591         __le32 ShareMaskHint;
1592 } __packed;
1593
1594 struct smb2_lease_ack {
1595         struct smb2_sync_hdr sync_hdr;
1596         __le16 StructureSize; /* Must be 36 */
1597         __le16 Reserved;
1598         __le32 Flags;
1599         __u8   LeaseKey[16];
1600         __le32 LeaseState;
1601         __le64 LeaseDuration;
1602 } __packed;
1603
1604 /*
1605  *      PDU infolevel structure definitions
1606  *      BB consider moving to a different header
1607  */
1608
1609 /* File System Information Classes */
1610 #define FS_VOLUME_INFORMATION           1 /* Query */
1611 #define FS_LABEL_INFORMATION            2 /* Local only */
1612 #define FS_SIZE_INFORMATION             3 /* Query */
1613 #define FS_DEVICE_INFORMATION           4 /* Query */
1614 #define FS_ATTRIBUTE_INFORMATION        5 /* Query */
1615 #define FS_CONTROL_INFORMATION          6 /* Query, Set */
1616 #define FS_FULL_SIZE_INFORMATION        7 /* Query */
1617 #define FS_OBJECT_ID_INFORMATION        8 /* Query, Set */
1618 #define FS_DRIVER_PATH_INFORMATION      9 /* Local only */
1619 #define FS_VOLUME_FLAGS_INFORMATION     10 /* Local only */
1620 #define FS_SECTOR_SIZE_INFORMATION      11 /* SMB3 or later. Query */
1621 #define FS_POSIX_INFORMATION            100 /* SMB3.1.1 POSIX. Query */
1622
1623 struct smb2_fs_full_size_info {
1624         __le64 TotalAllocationUnits;
1625         __le64 CallerAvailableAllocationUnits;
1626         __le64 ActualAvailableAllocationUnits;
1627         __le32 SectorsPerAllocationUnit;
1628         __le32 BytesPerSector;
1629 } __packed;
1630
1631 #define SSINFO_FLAGS_ALIGNED_DEVICE             0x00000001
1632 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1633 #define SSINFO_FLAGS_NO_SEEK_PENALTY            0x00000004
1634 #define SSINFO_FLAGS_TRIM_ENABLED               0x00000008
1635
1636 /* sector size info struct */
1637 struct smb3_fs_ss_info {
1638         __le32 LogicalBytesPerSector;
1639         __le32 PhysicalBytesPerSectorForAtomicity;
1640         __le32 PhysicalBytesPerSectorForPerf;
1641         __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
1642         __le32 Flags;
1643         __le32 ByteOffsetForSectorAlignment;
1644         __le32 ByteOffsetForPartitionAlignment;
1645 } __packed;
1646
1647 /* volume info struct - see MS-FSCC 2.5.9 */
1648 #define MAX_VOL_LABEL_LEN       32
1649 struct smb3_fs_vol_info {
1650         __le64  VolumeCreationTime;
1651         __u32   VolumeSerialNumber;
1652         __le32  VolumeLabelLength; /* includes trailing null */
1653         __u8    SupportsObjects; /* True if eg like NTFS, supports objects */
1654         __u8    Reserved;
1655         __u8    VolumeLabel[]; /* variable len */
1656 } __packed;
1657
1658 /* partial list of QUERY INFO levels */
1659 #define FILE_DIRECTORY_INFORMATION      1
1660 #define FILE_FULL_DIRECTORY_INFORMATION 2
1661 #define FILE_BOTH_DIRECTORY_INFORMATION 3
1662 #define FILE_BASIC_INFORMATION          4
1663 #define FILE_STANDARD_INFORMATION       5
1664 #define FILE_INTERNAL_INFORMATION       6
1665 #define FILE_EA_INFORMATION             7
1666 #define FILE_ACCESS_INFORMATION         8
1667 #define FILE_NAME_INFORMATION           9
1668 #define FILE_RENAME_INFORMATION         10
1669 #define FILE_LINK_INFORMATION           11
1670 #define FILE_NAMES_INFORMATION          12
1671 #define FILE_DISPOSITION_INFORMATION    13
1672 #define FILE_POSITION_INFORMATION       14
1673 #define FILE_FULL_EA_INFORMATION        15
1674 #define FILE_MODE_INFORMATION           16
1675 #define FILE_ALIGNMENT_INFORMATION      17
1676 #define FILE_ALL_INFORMATION            18
1677 #define FILE_ALLOCATION_INFORMATION     19
1678 #define FILE_END_OF_FILE_INFORMATION    20
1679 #define FILE_ALTERNATE_NAME_INFORMATION 21
1680 #define FILE_STREAM_INFORMATION         22
1681 #define FILE_PIPE_INFORMATION           23
1682 #define FILE_PIPE_LOCAL_INFORMATION     24
1683 #define FILE_PIPE_REMOTE_INFORMATION    25
1684 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1685 #define FILE_MAILSLOT_SET_INFORMATION   27
1686 #define FILE_COMPRESSION_INFORMATION    28
1687 #define FILE_OBJECT_ID_INFORMATION      29
1688 /* Number 30 not defined in documents */
1689 #define FILE_MOVE_CLUSTER_INFORMATION   31
1690 #define FILE_QUOTA_INFORMATION          32
1691 #define FILE_REPARSE_POINT_INFORMATION  33
1692 #define FILE_NETWORK_OPEN_INFORMATION   34
1693 #define FILE_ATTRIBUTE_TAG_INFORMATION  35
1694 #define FILE_TRACKING_INFORMATION       36
1695 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
1696 #define FILEID_FULL_DIRECTORY_INFORMATION 38
1697 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1698 #define FILE_SHORT_NAME_INFORMATION     40
1699 #define FILE_SFIO_RESERVE_INFORMATION   44
1700 #define FILE_SFIO_VOLUME_INFORMATION    45
1701 #define FILE_HARD_LINK_INFORMATION      46
1702 #define FILE_NORMALIZED_NAME_INFORMATION 48
1703 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1704 #define FILE_STANDARD_LINK_INFORMATION  54
1705 #define FILE_ID_INFORMATION             59
1706 #define FILE_ID_EXTD_DIRECTORY_INFORMATION 60
1707
1708 struct smb2_file_internal_info {
1709         __le64 IndexNumber;
1710 } __packed; /* level 6 Query */
1711
1712 struct smb2_file_rename_info { /* encoding of request for level 10 */
1713         __u8   ReplaceIfExists; /* 1 = replace existing target with new */
1714                                 /* 0 = fail if target already exists */
1715         __u8   Reserved[7];
1716         __u64  RootDirectory;  /* MBZ for network operations (why says spec?) */
1717         __le32 FileNameLength;
1718         char   FileName[];     /* New name to be assigned */
1719         /* padding - overall struct size must be >= 24 so filename + pad >= 6 */
1720 } __packed; /* level 10 Set */
1721
1722 struct smb2_file_link_info { /* encoding of request for level 11 */
1723         __u8   ReplaceIfExists; /* 1 = replace existing link with new */
1724                                 /* 0 = fail if link already exists */
1725         __u8   Reserved[7];
1726         __u64  RootDirectory;  /* MBZ for network operations (why says spec?) */
1727         __le32 FileNameLength;
1728         char   FileName[];     /* Name to be assigned to new link */
1729 } __packed; /* level 11 Set */
1730
1731 struct smb2_file_full_ea_info { /* encoding of response for level 15 */
1732         __le32 next_entry_offset;
1733         __u8   flags;
1734         __u8   ea_name_length;
1735         __le16 ea_value_length;
1736         char   ea_data[]; /* \0 terminated name plus value */
1737 } __packed; /* level 15 Set */
1738
1739 /*
1740  * This level 18, although with struct with same name is different from cifs
1741  * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1742  * CurrentByteOffset.
1743  */
1744 struct smb2_file_all_info { /* data block encoding of response to level 18 */
1745         __le64 CreationTime;    /* Beginning of FILE_BASIC_INFO equivalent */
1746         __le64 LastAccessTime;
1747         __le64 LastWriteTime;
1748         __le64 ChangeTime;
1749         __le32 Attributes;
1750         __u32  Pad1;            /* End of FILE_BASIC_INFO_INFO equivalent */
1751         __le64 AllocationSize;  /* Beginning of FILE_STANDARD_INFO equivalent */
1752         __le64 EndOfFile;       /* size ie offset to first free byte in file */
1753         __le32 NumberOfLinks;   /* hard links */
1754         __u8   DeletePending;
1755         __u8   Directory;
1756         __u16  Pad2;            /* End of FILE_STANDARD_INFO equivalent */
1757         __le64 IndexNumber;
1758         __le32 EASize;
1759         __le32 AccessFlags;
1760         __le64 CurrentByteOffset;
1761         __le32 Mode;
1762         __le32 AlignmentRequirement;
1763         __le32 FileNameLength;
1764         char   FileName[1];
1765 } __packed; /* level 18 Query */
1766
1767 struct smb2_file_eof_info { /* encoding of request for level 10 */
1768         __le64 EndOfFile; /* new end of file value */
1769 } __packed; /* level 20 Set */
1770
1771 struct smb2_file_reparse_point_info {
1772         __le64 IndexNumber;
1773         __le32 Tag;
1774 } __packed;
1775
1776 struct smb2_file_network_open_info {
1777         __le64 CreationTime;
1778         __le64 LastAccessTime;
1779         __le64 LastWriteTime;
1780         __le64 ChangeTime;
1781         __le64 AllocationSize;
1782         __le64 EndOfFile;
1783         __le32 Attributes;
1784         __le32 Reserved;
1785 } __packed; /* level 34 Query also similar returned in close rsp and open rsp */
1786
1787 /* See MS-FSCC 2.4.21 */
1788 struct smb2_file_id_information {
1789         __le64  VolumeSerialNumber;
1790         __u64  PersistentFileId; /* opaque endianness */
1791         __u64  VolatileFileId; /* opaque endianness */
1792 } __packed; /* level 59 */
1793
1794 /* See MS-FSCC 2.4.18 */
1795 struct smb2_file_id_extd_directory_info {
1796         __le32 NextEntryOffset;
1797         __u32 FileIndex;
1798         __le64 CreationTime;
1799         __le64 LastAccessTime;
1800         __le64 LastWriteTime;
1801         __le64 ChangeTime;
1802         __le64 EndOfFile;
1803         __le64 AllocationSize;
1804         __le32 FileAttributes;
1805         __le32 FileNameLength;
1806         __le32 EaSize; /* EA size */
1807         __le32 ReparsePointTag; /* valid if FILE_ATTR_REPARSE_POINT set in FileAttributes */
1808         __le64 UniqueId; /* inode num - le since Samba puts ino in low 32 bit */
1809         char FileName[1];
1810 } __packed; /* level 60 */
1811
1812 extern char smb2_padding[7];
1813
1814 /* equivalent of the contents of SMB3.1.1 POSIX open context response */
1815 struct create_posix_rsp {
1816         u32 nlink;
1817         u32 reparse_tag;
1818         u32 mode;
1819         struct cifs_sid owner; /* var-sized on the wire */
1820         struct cifs_sid group; /* var-sized on the wire */
1821 } __packed;
1822
1823 /*
1824  * SMB2-only POSIX info level for query dir
1825  *
1826  * See posix_info_sid_size(), posix_info_extra_size() and
1827  * posix_info_parse() to help with the handling of this struct.
1828  */
1829 struct smb2_posix_info {
1830         __le32 NextEntryOffset;
1831         __u32 Ignored;
1832         __le64 CreationTime;
1833         __le64 LastAccessTime;
1834         __le64 LastWriteTime;
1835         __le64 ChangeTime;
1836         __le64 EndOfFile;
1837         __le64 AllocationSize;
1838         __le32 DosAttributes;
1839         __le64 Inode;
1840         __le32 DeviceId;
1841         __le32 Zero;
1842         /* beginning of POSIX Create Context Response */
1843         __le32 HardLinks;
1844         __le32 ReparseTag;
1845         __le32 Mode;
1846         /*
1847          * var sized owner SID
1848          * var sized group SID
1849          * le32 filenamelength
1850          * u8  filename[]
1851          */
1852 } __packed;
1853
1854 /* Level 100 query info */
1855 struct smb311_posix_qinfo {
1856         __le64 CreationTime;
1857         __le64 LastAccessTime;
1858         __le64 LastWriteTime;
1859         __le64 ChangeTime;
1860         __le64 EndOfFile;
1861         __le64 AllocationSize;
1862         __le32 DosAttributes;
1863         __le64 Inode;
1864         __le32 DeviceId;
1865         __le32 Zero;
1866         /* beginning of POSIX Create Context Response */
1867         __le32 HardLinks;
1868         __le32 ReparseTag;
1869         __le32 Mode;
1870         u8     Sids[];
1871         /*
1872          * var sized owner SID
1873          * var sized group SID
1874          * le32 filenamelength
1875          * u8  filename[]
1876          */
1877 } __packed;
1878
1879 /*
1880  * Parsed version of the above struct. Allows direct access to the
1881  * variable length fields
1882  */
1883 struct smb2_posix_info_parsed {
1884         const struct smb2_posix_info *base;
1885         size_t size;
1886         struct cifs_sid owner;
1887         struct cifs_sid group;
1888         int name_len;
1889         const u8 *name;
1890 };
1891
1892 #endif                          /* _SMB2PDU_H */