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