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