fs/cifs/smb2pdu.h

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