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