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