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