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