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