Allow setting per-file compression via CIFS protocol
[deliverable/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 NUMBER_OF_SMB2_COMMANDS 0x0013
84
85 /* BB FIXME - analyze following length BB */
86 #define MAX_SMB2_HDR_SIZE 0x78 /* 4 len + 64 hdr + (2*24 wct) + 2 bct + 2 pad */
87
88 #define SMB2_PROTO_NUMBER __constant_cpu_to_le32(0x424d53fe)
89
90 /*
91 * SMB2 Header Definition
92 *
93 * "MBZ" : Must be Zero
94 * "BB" : BugBug, Something to check/review/analyze later
95 * "PDU" : "Protocol Data Unit" (ie a network "frame")
96 *
97 */
98
99 #define SMB2_HEADER_STRUCTURE_SIZE __constant_cpu_to_le16(64)
100
101 struct smb2_hdr {
102 __be32 smb2_buf_length; /* big endian on wire */
103 /* length is only two or three bytes - with
104 one or two byte type preceding it that MBZ */
105 __u8 ProtocolId[4]; /* 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 __u64 MessageId; /* opaque - so can stay little endian */
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_pdu {
121 struct smb2_hdr hdr;
122 __le16 StructureSize2; /* size of wct area (varies, request specific) */
123 } __packed;
124
125 /*
126 * SMB2 flag definitions
127 */
128 #define SMB2_FLAGS_SERVER_TO_REDIR __constant_cpu_to_le32(0x00000001)
129 #define SMB2_FLAGS_ASYNC_COMMAND __constant_cpu_to_le32(0x00000002)
130 #define SMB2_FLAGS_RELATED_OPERATIONS __constant_cpu_to_le32(0x00000004)
131 #define SMB2_FLAGS_SIGNED __constant_cpu_to_le32(0x00000008)
132 #define SMB2_FLAGS_DFS_OPERATIONS __constant_cpu_to_le32(0x10000000)
133
134 /*
135 * Definitions for SMB2 Protocol Data Units (network frames)
136 *
137 * See MS-SMB2.PDF specification for protocol details.
138 * The Naming convention is the lower case version of the SMB2
139 * command code name for the struct. Note that structures must be packed.
140 *
141 */
142
143 #define SMB2_ERROR_STRUCTURE_SIZE2 __constant_cpu_to_le16(9)
144
145 struct smb2_err_rsp {
146 struct smb2_hdr hdr;
147 __le16 StructureSize;
148 __le16 Reserved; /* MBZ */
149 __le32 ByteCount; /* even if zero, at least one byte follows */
150 __u8 ErrorData[1]; /* variable length */
151 } __packed;
152
153 struct smb2_symlink_err_rsp {
154 __le32 SymLinkLength;
155 __le32 SymLinkErrorTag;
156 __le32 ReparseTag;
157 __le16 ReparseDataLength;
158 __le16 UnparsedPathLength;
159 __le16 SubstituteNameOffset;
160 __le16 SubstituteNameLength;
161 __le16 PrintNameOffset;
162 __le16 PrintNameLength;
163 __le32 Flags;
164 __u8 PathBuffer[0];
165 } __packed;
166
167 #define SMB2_CLIENT_GUID_SIZE 16
168
169 extern __u8 cifs_client_guid[SMB2_CLIENT_GUID_SIZE];
170
171 struct smb2_negotiate_req {
172 struct smb2_hdr hdr;
173 __le16 StructureSize; /* Must be 36 */
174 __le16 DialectCount;
175 __le16 SecurityMode;
176 __le16 Reserved; /* MBZ */
177 __le32 Capabilities;
178 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
179 __le64 ClientStartTime; /* MBZ */
180 __le16 Dialects[1]; /* One dialect (vers=) at a time for now */
181 } __packed;
182
183 /* Dialects */
184 #define SMB20_PROT_ID 0x0202
185 #define SMB21_PROT_ID 0x0210
186 #define SMB30_PROT_ID 0x0300
187 #define SMB302_PROT_ID 0x0302
188 #define BAD_PROT_ID 0xFFFF
189
190 /* SecurityMode flags */
191 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
192 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
193 /* Capabilities flags */
194 #define SMB2_GLOBAL_CAP_DFS 0x00000001
195 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
196 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
197 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
198 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
199 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
200 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
201 /* Internal types */
202 #define SMB2_NT_FIND 0x00100000
203 #define SMB2_LARGE_FILES 0x00200000
204
205 struct smb2_negotiate_rsp {
206 struct smb2_hdr hdr;
207 __le16 StructureSize; /* Must be 65 */
208 __le16 SecurityMode;
209 __le16 DialectRevision;
210 __le16 Reserved; /* MBZ */
211 __u8 ServerGUID[16];
212 __le32 Capabilities;
213 __le32 MaxTransactSize;
214 __le32 MaxReadSize;
215 __le32 MaxWriteSize;
216 __le64 SystemTime; /* MBZ */
217 __le64 ServerStartTime;
218 __le16 SecurityBufferOffset;
219 __le16 SecurityBufferLength;
220 __le32 Reserved2; /* may be any value, ignore */
221 __u8 Buffer[1]; /* variable length GSS security buffer */
222 } __packed;
223
224 struct smb2_sess_setup_req {
225 struct smb2_hdr hdr;
226 __le16 StructureSize; /* Must be 25 */
227 __u8 VcNumber;
228 __u8 SecurityMode;
229 __le32 Capabilities;
230 __le32 Channel;
231 __le16 SecurityBufferOffset;
232 __le16 SecurityBufferLength;
233 __le64 PreviousSessionId;
234 __u8 Buffer[1]; /* variable length GSS security buffer */
235 } __packed;
236
237 /* Currently defined SessionFlags */
238 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
239 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
240 struct smb2_sess_setup_rsp {
241 struct smb2_hdr hdr;
242 __le16 StructureSize; /* Must be 9 */
243 __le16 SessionFlags;
244 __le16 SecurityBufferOffset;
245 __le16 SecurityBufferLength;
246 __u8 Buffer[1]; /* variable length GSS security buffer */
247 } __packed;
248
249 struct smb2_logoff_req {
250 struct smb2_hdr hdr;
251 __le16 StructureSize; /* Must be 4 */
252 __le16 Reserved;
253 } __packed;
254
255 struct smb2_logoff_rsp {
256 struct smb2_hdr hdr;
257 __le16 StructureSize; /* Must be 4 */
258 __le16 Reserved;
259 } __packed;
260
261 struct smb2_tree_connect_req {
262 struct smb2_hdr hdr;
263 __le16 StructureSize; /* Must be 9 */
264 __le16 Reserved;
265 __le16 PathOffset;
266 __le16 PathLength;
267 __u8 Buffer[1]; /* variable length */
268 } __packed;
269
270 struct smb2_tree_connect_rsp {
271 struct smb2_hdr hdr;
272 __le16 StructureSize; /* Must be 16 */
273 __u8 ShareType; /* see below */
274 __u8 Reserved;
275 __le32 ShareFlags; /* see below */
276 __le32 Capabilities; /* see below */
277 __le32 MaximalAccess;
278 } __packed;
279
280 /* Possible ShareType values */
281 #define SMB2_SHARE_TYPE_DISK 0x01
282 #define SMB2_SHARE_TYPE_PIPE 0x02
283 #define SMB2_SHARE_TYPE_PRINT 0x03
284
285 /*
286 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
287 * must be set (any of the remaining, SHI1005, flags may be set individually
288 * or in combination.
289 */
290 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
291 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
292 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
293 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
294 #define SHI1005_FLAGS_DFS 0x00000001
295 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
296 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
297 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
298 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
299 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
300 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
301 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
302 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
303 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
304 #define SHI1005_FLAGS_ALL 0x0000FF33
305
306 /* Possible share capabilities */
307 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
308 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
309 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
310 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
311 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
312
313 struct smb2_tree_disconnect_req {
314 struct smb2_hdr hdr;
315 __le16 StructureSize; /* Must be 4 */
316 __le16 Reserved;
317 } __packed;
318
319 struct smb2_tree_disconnect_rsp {
320 struct smb2_hdr hdr;
321 __le16 StructureSize; /* Must be 4 */
322 __le16 Reserved;
323 } __packed;
324
325 /* File Attrubutes */
326 #define FILE_ATTRIBUTE_READONLY 0x00000001
327 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
328 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
329 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
330 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
331 #define FILE_ATTRIBUTE_NORMAL 0x00000080
332 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
333 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
334 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
335 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
336 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
337 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
338 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
339
340 /* Oplock levels */
341 #define SMB2_OPLOCK_LEVEL_NONE 0x00
342 #define SMB2_OPLOCK_LEVEL_II 0x01
343 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
344 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
345 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
346 /* Non-spec internal type */
347 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
348
349 /* Desired Access Flags */
350 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
351 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
352 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
353 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
354 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
355 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
356 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
357 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
358 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
359 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
360 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
361 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
362 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
363 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
364 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
365 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
366 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
367 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
368 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
369
370 /* ShareAccess Flags */
371 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
372 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
373 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
374 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
375
376 /* CreateDisposition Flags */
377 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
378 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
379 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
380 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
381 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
382 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
383
384 /* CreateOptions Flags */
385 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
386 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
387 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
388 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
389 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
390 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
391 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
392 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
393 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
394 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
395 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
396 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
397 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
398 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
399 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
400 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
401 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
402 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
403 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
404
405 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
406 | FILE_READ_ATTRIBUTES_LE)
407 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
408 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
409 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
410
411 /* Impersonation Levels */
412 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
413 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
414 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
415 #define IL_DELEGATE cpu_to_le32(0x00000003)
416
417 /* Create Context Values */
418 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
419 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
420 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
421 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
422 #define SMB2_CREATE_ALLOCATION_SIZE "AlSi"
423 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
424 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
425 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
426 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
427
428 struct smb2_create_req {
429 struct smb2_hdr hdr;
430 __le16 StructureSize; /* Must be 57 */
431 __u8 SecurityFlags;
432 __u8 RequestedOplockLevel;
433 __le32 ImpersonationLevel;
434 __le64 SmbCreateFlags;
435 __le64 Reserved;
436 __le32 DesiredAccess;
437 __le32 FileAttributes;
438 __le32 ShareAccess;
439 __le32 CreateDisposition;
440 __le32 CreateOptions;
441 __le16 NameOffset;
442 __le16 NameLength;
443 __le32 CreateContextsOffset;
444 __le32 CreateContextsLength;
445 __u8 Buffer[0];
446 } __packed;
447
448 struct smb2_create_rsp {
449 struct smb2_hdr hdr;
450 __le16 StructureSize; /* Must be 89 */
451 __u8 OplockLevel;
452 __u8 Reserved;
453 __le32 CreateAction;
454 __le64 CreationTime;
455 __le64 LastAccessTime;
456 __le64 LastWriteTime;
457 __le64 ChangeTime;
458 __le64 AllocationSize;
459 __le64 EndofFile;
460 __le32 FileAttributes;
461 __le32 Reserved2;
462 __u64 PersistentFileId; /* opaque endianness */
463 __u64 VolatileFileId; /* opaque endianness */
464 __le32 CreateContextsOffset;
465 __le32 CreateContextsLength;
466 __u8 Buffer[1];
467 } __packed;
468
469 struct create_context {
470 __le32 Next;
471 __le16 NameOffset;
472 __le16 NameLength;
473 __le16 Reserved;
474 __le16 DataOffset;
475 __le32 DataLength;
476 __u8 Buffer[0];
477 } __packed;
478
479 #define SMB2_LEASE_READ_CACHING_HE 0x01
480 #define SMB2_LEASE_HANDLE_CACHING_HE 0x02
481 #define SMB2_LEASE_WRITE_CACHING_HE 0x04
482
483 #define SMB2_LEASE_NONE __constant_cpu_to_le32(0x00)
484 #define SMB2_LEASE_READ_CACHING __constant_cpu_to_le32(0x01)
485 #define SMB2_LEASE_HANDLE_CACHING __constant_cpu_to_le32(0x02)
486 #define SMB2_LEASE_WRITE_CACHING __constant_cpu_to_le32(0x04)
487
488 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS __constant_cpu_to_le32(0x02)
489
490 #define SMB2_LEASE_KEY_SIZE 16
491
492 struct lease_context {
493 __le64 LeaseKeyLow;
494 __le64 LeaseKeyHigh;
495 __le32 LeaseState;
496 __le32 LeaseFlags;
497 __le64 LeaseDuration;
498 } __packed;
499
500 struct lease_context_v2 {
501 __le64 LeaseKeyLow;
502 __le64 LeaseKeyHigh;
503 __le32 LeaseState;
504 __le32 LeaseFlags;
505 __le64 LeaseDuration;
506 __le64 ParentLeaseKeyLow;
507 __le64 ParentLeaseKeyHigh;
508 __le16 Epoch;
509 __le16 Reserved;
510 } __packed;
511
512 struct create_lease {
513 struct create_context ccontext;
514 __u8 Name[8];
515 struct lease_context lcontext;
516 } __packed;
517
518 struct create_lease_v2 {
519 struct create_context ccontext;
520 __u8 Name[8];
521 struct lease_context_v2 lcontext;
522 __u8 Pad[4];
523 } __packed;
524
525 struct create_durable {
526 struct create_context ccontext;
527 __u8 Name[8];
528 union {
529 __u8 Reserved[16];
530 struct {
531 __u64 PersistentFileId;
532 __u64 VolatileFileId;
533 } Fid;
534 } Data;
535 } __packed;
536
537 /* this goes in the ioctl buffer when doing a copychunk request */
538 struct copychunk_ioctl {
539 char SourceKey[24];
540 __le32 ChunkCount; /* we are only sending 1 */
541 __le32 Reserved;
542 /* array will only be one chunk long for us */
543 __le64 SourceOffset;
544 __le64 TargetOffset;
545 __le32 Length; /* how many bytes to copy */
546 __u32 Reserved2;
547 } __packed;
548
549 /* Response and Request are the same format */
550 struct validate_negotiate_info {
551 __le32 Capabilities;
552 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
553 __le16 SecurityMode;
554 __le16 DialectCount;
555 __le16 Dialect[1];
556 } __packed;
557
558 #define RSS_CAPABLE 0x00000001
559 #define RDMA_CAPABLE 0x00000002
560
561 struct network_interface_info_ioctl_rsp {
562 __le32 Next; /* next interface. zero if this is last one */
563 __le32 IfIndex;
564 __le32 Capability; /* RSS or RDMA Capable */
565 __le32 Reserved;
566 __le64 LinkSpeed;
567 char SockAddr_Storage[128];
568 } __packed;
569
570 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
571
572 struct compress_ioctl {
573 __le16 CompressionState; /* See cifspdu.h for possible flag values */
574 } __packed;
575
576 struct smb2_ioctl_req {
577 struct smb2_hdr hdr;
578 __le16 StructureSize; /* Must be 57 */
579 __u16 Reserved;
580 __le32 CtlCode;
581 __u64 PersistentFileId; /* opaque endianness */
582 __u64 VolatileFileId; /* opaque endianness */
583 __le32 InputOffset;
584 __le32 InputCount;
585 __le32 MaxInputResponse;
586 __le32 OutputOffset;
587 __le32 OutputCount;
588 __le32 MaxOutputResponse;
589 __le32 Flags;
590 __u32 Reserved2;
591 __u8 Buffer[0];
592 } __packed;
593
594 struct smb2_ioctl_rsp {
595 struct smb2_hdr hdr;
596 __le16 StructureSize; /* Must be 57 */
597 __u16 Reserved;
598 __le32 CtlCode;
599 __u64 PersistentFileId; /* opaque endianness */
600 __u64 VolatileFileId; /* opaque endianness */
601 __le32 InputOffset;
602 __le32 InputCount;
603 __le32 OutputOffset;
604 __le32 OutputCount;
605 __le32 Flags;
606 __u32 Reserved2;
607 /* char * buffer[] */
608 } __packed;
609
610 /* Currently defined values for close flags */
611 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
612 struct smb2_close_req {
613 struct smb2_hdr hdr;
614 __le16 StructureSize; /* Must be 24 */
615 __le16 Flags;
616 __le32 Reserved;
617 __u64 PersistentFileId; /* opaque endianness */
618 __u64 VolatileFileId; /* opaque endianness */
619 } __packed;
620
621 struct smb2_close_rsp {
622 struct smb2_hdr hdr;
623 __le16 StructureSize; /* 60 */
624 __le16 Flags;
625 __le32 Reserved;
626 __le64 CreationTime;
627 __le64 LastAccessTime;
628 __le64 LastWriteTime;
629 __le64 ChangeTime;
630 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
631 __le64 EndOfFile;
632 __le32 Attributes;
633 } __packed;
634
635 struct smb2_flush_req {
636 struct smb2_hdr hdr;
637 __le16 StructureSize; /* Must be 24 */
638 __le16 Reserved1;
639 __le32 Reserved2;
640 __u64 PersistentFileId; /* opaque endianness */
641 __u64 VolatileFileId; /* opaque endianness */
642 } __packed;
643
644 struct smb2_flush_rsp {
645 struct smb2_hdr hdr;
646 __le16 StructureSize;
647 __le16 Reserved;
648 } __packed;
649
650 /* For read request Flags field below, following flag is defined for SMB3.02 */
651 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
652
653 /* Channel field for read and write: exactly one of following flags can be set*/
654 #define SMB2_CHANNEL_NONE 0x00000000
655 #define SMB2_CHANNEL_RDMA_V1 0x00000001 /* SMB3 or later */
656 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE 0x00000001 /* SMB3.02 or later */
657
658 struct smb2_read_req {
659 struct smb2_hdr hdr;
660 __le16 StructureSize; /* Must be 49 */
661 __u8 Padding; /* offset from start of SMB2 header to place read */
662 __u8 Flags; /* MBZ unless SMB3.02 or later */
663 __le32 Length;
664 __le64 Offset;
665 __u64 PersistentFileId; /* opaque endianness */
666 __u64 VolatileFileId; /* opaque endianness */
667 __le32 MinimumCount;
668 __le32 Channel; /* MBZ except for SMB3 or later */
669 __le32 RemainingBytes;
670 __le16 ReadChannelInfoOffset; /* Reserved MBZ */
671 __le16 ReadChannelInfoLength; /* Reserved MBZ */
672 __u8 Buffer[1];
673 } __packed;
674
675 struct smb2_read_rsp {
676 struct smb2_hdr hdr;
677 __le16 StructureSize; /* Must be 17 */
678 __u8 DataOffset;
679 __u8 Reserved;
680 __le32 DataLength;
681 __le32 DataRemaining;
682 __u32 Reserved2;
683 __u8 Buffer[1];
684 } __packed;
685
686 /* For write request Flags field below the following flags are defined: */
687 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
688 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
689
690 struct smb2_write_req {
691 struct smb2_hdr hdr;
692 __le16 StructureSize; /* Must be 49 */
693 __le16 DataOffset; /* offset from start of SMB2 header to write data */
694 __le32 Length;
695 __le64 Offset;
696 __u64 PersistentFileId; /* opaque endianness */
697 __u64 VolatileFileId; /* opaque endianness */
698 __le32 Channel; /* Reserved MBZ */
699 __le32 RemainingBytes;
700 __le16 WriteChannelInfoOffset; /* Reserved MBZ */
701 __le16 WriteChannelInfoLength; /* Reserved MBZ */
702 __le32 Flags;
703 __u8 Buffer[1];
704 } __packed;
705
706 struct smb2_write_rsp {
707 struct smb2_hdr hdr;
708 __le16 StructureSize; /* Must be 17 */
709 __u8 DataOffset;
710 __u8 Reserved;
711 __le32 DataLength;
712 __le32 DataRemaining;
713 __u32 Reserved2;
714 __u8 Buffer[1];
715 } __packed;
716
717 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
718 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
719 #define SMB2_LOCKFLAG_UNLOCK 0x0004
720 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
721
722 struct smb2_lock_element {
723 __le64 Offset;
724 __le64 Length;
725 __le32 Flags;
726 __le32 Reserved;
727 } __packed;
728
729 struct smb2_lock_req {
730 struct smb2_hdr hdr;
731 __le16 StructureSize; /* Must be 48 */
732 __le16 LockCount;
733 __le32 Reserved;
734 __u64 PersistentFileId; /* opaque endianness */
735 __u64 VolatileFileId; /* opaque endianness */
736 /* Followed by at least one */
737 struct smb2_lock_element locks[1];
738 } __packed;
739
740 struct smb2_lock_rsp {
741 struct smb2_hdr hdr;
742 __le16 StructureSize; /* Must be 4 */
743 __le16 Reserved;
744 } __packed;
745
746 struct smb2_echo_req {
747 struct smb2_hdr hdr;
748 __le16 StructureSize; /* Must be 4 */
749 __u16 Reserved;
750 } __packed;
751
752 struct smb2_echo_rsp {
753 struct smb2_hdr hdr;
754 __le16 StructureSize; /* Must be 4 */
755 __u16 Reserved;
756 } __packed;
757
758 /* search (query_directory) Flags field */
759 #define SMB2_RESTART_SCANS 0x01
760 #define SMB2_RETURN_SINGLE_ENTRY 0x02
761 #define SMB2_INDEX_SPECIFIED 0x04
762 #define SMB2_REOPEN 0x10
763
764 struct smb2_query_directory_req {
765 struct smb2_hdr hdr;
766 __le16 StructureSize; /* Must be 33 */
767 __u8 FileInformationClass;
768 __u8 Flags;
769 __le32 FileIndex;
770 __u64 PersistentFileId; /* opaque endianness */
771 __u64 VolatileFileId; /* opaque endianness */
772 __le16 FileNameOffset;
773 __le16 FileNameLength;
774 __le32 OutputBufferLength;
775 __u8 Buffer[1];
776 } __packed;
777
778 struct smb2_query_directory_rsp {
779 struct smb2_hdr hdr;
780 __le16 StructureSize; /* Must be 9 */
781 __le16 OutputBufferOffset;
782 __le32 OutputBufferLength;
783 __u8 Buffer[1];
784 } __packed;
785
786 /* Possible InfoType values */
787 #define SMB2_O_INFO_FILE 0x01
788 #define SMB2_O_INFO_FILESYSTEM 0x02
789 #define SMB2_O_INFO_SECURITY 0x03
790 #define SMB2_O_INFO_QUOTA 0x04
791
792 struct smb2_query_info_req {
793 struct smb2_hdr hdr;
794 __le16 StructureSize; /* Must be 41 */
795 __u8 InfoType;
796 __u8 FileInfoClass;
797 __le32 OutputBufferLength;
798 __le16 InputBufferOffset;
799 __u16 Reserved;
800 __le32 InputBufferLength;
801 __le32 AdditionalInformation;
802 __le32 Flags;
803 __u64 PersistentFileId; /* opaque endianness */
804 __u64 VolatileFileId; /* opaque endianness */
805 __u8 Buffer[1];
806 } __packed;
807
808 struct smb2_query_info_rsp {
809 struct smb2_hdr hdr;
810 __le16 StructureSize; /* Must be 9 */
811 __le16 OutputBufferOffset;
812 __le32 OutputBufferLength;
813 __u8 Buffer[1];
814 } __packed;
815
816 struct smb2_set_info_req {
817 struct smb2_hdr hdr;
818 __le16 StructureSize; /* Must be 33 */
819 __u8 InfoType;
820 __u8 FileInfoClass;
821 __le32 BufferLength;
822 __le16 BufferOffset;
823 __u16 Reserved;
824 __le32 AdditionalInformation;
825 __u64 PersistentFileId; /* opaque endianness */
826 __u64 VolatileFileId; /* opaque endianness */
827 __u8 Buffer[1];
828 } __packed;
829
830 struct smb2_set_info_rsp {
831 struct smb2_hdr hdr;
832 __le16 StructureSize; /* Must be 2 */
833 } __packed;
834
835 struct smb2_oplock_break {
836 struct smb2_hdr hdr;
837 __le16 StructureSize; /* Must be 24 */
838 __u8 OplockLevel;
839 __u8 Reserved;
840 __le32 Reserved2;
841 __u64 PersistentFid;
842 __u64 VolatileFid;
843 } __packed;
844
845 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
846
847 struct smb2_lease_break {
848 struct smb2_hdr hdr;
849 __le16 StructureSize; /* Must be 44 */
850 __le16 Reserved;
851 __le32 Flags;
852 __u8 LeaseKey[16];
853 __le32 CurrentLeaseState;
854 __le32 NewLeaseState;
855 __le32 BreakReason;
856 __le32 AccessMaskHint;
857 __le32 ShareMaskHint;
858 } __packed;
859
860 struct smb2_lease_ack {
861 struct smb2_hdr hdr;
862 __le16 StructureSize; /* Must be 36 */
863 __le16 Reserved;
864 __le32 Flags;
865 __u8 LeaseKey[16];
866 __le32 LeaseState;
867 __le64 LeaseDuration;
868 } __packed;
869
870 /*
871 * PDU infolevel structure definitions
872 * BB consider moving to a different header
873 */
874
875 /* File System Information Classes */
876 #define FS_VOLUME_INFORMATION 1 /* Query */
877 #define FS_LABEL_INFORMATION 2 /* Local only */
878 #define FS_SIZE_INFORMATION 3 /* Query */
879 #define FS_DEVICE_INFORMATION 4 /* Query */
880 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
881 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
882 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
883 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
884 #define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
885 #define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
886 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
887
888 struct smb2_fs_full_size_info {
889 __le64 TotalAllocationUnits;
890 __le64 CallerAvailableAllocationUnits;
891 __le64 ActualAvailableAllocationUnits;
892 __le32 SectorsPerAllocationUnit;
893 __le32 BytesPerSector;
894 } __packed;
895
896 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
897 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
898 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
899 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
900
901 /* sector size info struct */
902 struct smb3_fs_ss_info {
903 __le32 LogicalBytesPerSector;
904 __le32 PhysicalBytesPerSectorForAtomicity;
905 __le32 PhysicalBytesPerSectorForPerf;
906 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
907 __le32 Flags;
908 __le32 ByteOffsetForSectorAlignment;
909 __le32 ByteOffsetForPartitionAlignment;
910 } __packed;
911
912 /* partial list of QUERY INFO levels */
913 #define FILE_DIRECTORY_INFORMATION 1
914 #define FILE_FULL_DIRECTORY_INFORMATION 2
915 #define FILE_BOTH_DIRECTORY_INFORMATION 3
916 #define FILE_BASIC_INFORMATION 4
917 #define FILE_STANDARD_INFORMATION 5
918 #define FILE_INTERNAL_INFORMATION 6
919 #define FILE_EA_INFORMATION 7
920 #define FILE_ACCESS_INFORMATION 8
921 #define FILE_NAME_INFORMATION 9
922 #define FILE_RENAME_INFORMATION 10
923 #define FILE_LINK_INFORMATION 11
924 #define FILE_NAMES_INFORMATION 12
925 #define FILE_DISPOSITION_INFORMATION 13
926 #define FILE_POSITION_INFORMATION 14
927 #define FILE_FULL_EA_INFORMATION 15
928 #define FILE_MODE_INFORMATION 16
929 #define FILE_ALIGNMENT_INFORMATION 17
930 #define FILE_ALL_INFORMATION 18
931 #define FILE_ALLOCATION_INFORMATION 19
932 #define FILE_END_OF_FILE_INFORMATION 20
933 #define FILE_ALTERNATE_NAME_INFORMATION 21
934 #define FILE_STREAM_INFORMATION 22
935 #define FILE_PIPE_INFORMATION 23
936 #define FILE_PIPE_LOCAL_INFORMATION 24
937 #define FILE_PIPE_REMOTE_INFORMATION 25
938 #define FILE_MAILSLOT_QUERY_INFORMATION 26
939 #define FILE_MAILSLOT_SET_INFORMATION 27
940 #define FILE_COMPRESSION_INFORMATION 28
941 #define FILE_OBJECT_ID_INFORMATION 29
942 /* Number 30 not defined in documents */
943 #define FILE_MOVE_CLUSTER_INFORMATION 31
944 #define FILE_QUOTA_INFORMATION 32
945 #define FILE_REPARSE_POINT_INFORMATION 33
946 #define FILE_NETWORK_OPEN_INFORMATION 34
947 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
948 #define FILE_TRACKING_INFORMATION 36
949 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
950 #define FILEID_FULL_DIRECTORY_INFORMATION 38
951 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
952 #define FILE_SHORT_NAME_INFORMATION 40
953 #define FILE_SFIO_RESERVE_INFORMATION 44
954 #define FILE_SFIO_VOLUME_INFORMATION 45
955 #define FILE_HARD_LINK_INFORMATION 46
956 #define FILE_NORMALIZED_NAME_INFORMATION 48
957 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
958 #define FILE_STANDARD_LINK_INFORMATION 54
959
960 struct smb2_file_internal_info {
961 __le64 IndexNumber;
962 } __packed; /* level 6 Query */
963
964 struct smb2_file_rename_info { /* encoding of request for level 10 */
965 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
966 /* 0 = fail if target already exists */
967 __u8 Reserved[7];
968 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
969 __le32 FileNameLength;
970 char FileName[0]; /* New name to be assigned */
971 } __packed; /* level 10 Set */
972
973 struct smb2_file_link_info { /* encoding of request for level 11 */
974 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
975 /* 0 = fail if link already exists */
976 __u8 Reserved[7];
977 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
978 __le32 FileNameLength;
979 char FileName[0]; /* Name to be assigned to new link */
980 } __packed; /* level 11 Set */
981
982 /*
983 * This level 18, although with struct with same name is different from cifs
984 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
985 * CurrentByteOffset.
986 */
987 struct smb2_file_all_info { /* data block encoding of response to level 18 */
988 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
989 __le64 LastAccessTime;
990 __le64 LastWriteTime;
991 __le64 ChangeTime;
992 __le32 Attributes;
993 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
994 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
995 __le64 EndOfFile; /* size ie offset to first free byte in file */
996 __le32 NumberOfLinks; /* hard links */
997 __u8 DeletePending;
998 __u8 Directory;
999 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
1000 __le64 IndexNumber;
1001 __le32 EASize;
1002 __le32 AccessFlags;
1003 __le64 CurrentByteOffset;
1004 __le32 Mode;
1005 __le32 AlignmentRequirement;
1006 __le32 FileNameLength;
1007 char FileName[1];
1008 } __packed; /* level 18 Query */
1009
1010 struct smb2_file_eof_info { /* encoding of request for level 10 */
1011 __le64 EndOfFile; /* new end of file value */
1012 } __packed; /* level 20 Set */
1013
1014 #endif /* _SMB2PDU_H */
This page took 0.079314 seconds and 5 git commands to generate.