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