4 * Copyright (c) International Business Machines Corp., 2009, 2013
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
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.
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)
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 */
110 __le16 CreditRequest
; /* CreditResponse */
113 __u64 MessageId
; /* opaque - so can stay little endian */
115 __u32 TreeId
; /* opaque - so do not make little endian */
116 __u64 SessionId
; /* opaque - so do not make little endian */
122 __le16 StructureSize2
; /* size of wct area (varies, request specific) */
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' */
133 __le32 OriginalMessageSize
;
135 __le16 EncryptionAlgorithm
;
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
{
164 __le16 StructureSize
;
165 __le16 Reserved
; /* MBZ */
166 __le32 ByteCount
; /* even if zero, at least one byte follows */
167 __u8 ErrorData
[1]; /* variable length */
170 struct smb2_symlink_err_rsp
{
171 __le32 SymLinkLength
;
172 __le32 SymLinkErrorTag
;
174 __le16 ReparseDataLength
;
175 __le16 UnparsedPathLength
;
176 __le16 SubstituteNameOffset
;
177 __le16 SubstituteNameLength
;
178 __le16 PrintNameOffset
;
179 __le16 PrintNameLength
;
184 #define SMB2_CLIENT_GUID_SIZE 16
186 extern __u8 cifs_client_guid
[SMB2_CLIENT_GUID_SIZE
];
188 struct smb2_negotiate_req
{
190 __le16 StructureSize
; /* Must be 36 */
193 __le16 Reserved
; /* MBZ */
195 __u8 ClientGUID
[SMB2_CLIENT_GUID_SIZE
];
196 __le64 ClientStartTime
; /* MBZ */
197 __le16 Dialects
[1]; /* One dialect (vers=) at a time for now */
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 */
219 #define SMB2_NT_FIND 0x00100000
220 #define SMB2_LARGE_FILES 0x00200000
222 struct smb2_negotiate_rsp
{
224 __le16 StructureSize
; /* Must be 65 */
226 __le16 DialectRevision
;
227 __le16 Reserved
; /* MBZ */
230 __le32 MaxTransactSize
;
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 */
241 struct smb2_sess_setup_req
{
243 __le16 StructureSize
; /* Must be 25 */
248 __le16 SecurityBufferOffset
;
249 __le16 SecurityBufferLength
;
250 __le64 PreviousSessionId
;
251 __u8 Buffer
[1]; /* variable length GSS security buffer */
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
{
260 __le16 StructureSize
; /* Must be 9 */
262 __le16 SecurityBufferOffset
;
263 __le16 SecurityBufferLength
;
264 __u8 Buffer
[1]; /* variable length GSS security buffer */
267 struct smb2_logoff_req
{
269 __le16 StructureSize
; /* Must be 4 */
273 struct smb2_logoff_rsp
{
275 __le16 StructureSize
; /* Must be 4 */
279 struct smb2_tree_connect_req
{
281 __le16 StructureSize
; /* Must be 9 */
285 __u8 Buffer
[1]; /* variable length */
288 struct smb2_tree_connect_rsp
{
290 __le16 StructureSize
; /* Must be 16 */
291 __u8 ShareType
; /* see below */
293 __le32 ShareFlags
; /* see below */
294 __le32 Capabilities
; /* see below */
295 __le32 MaximalAccess
;
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
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
{
333 __le16 StructureSize
; /* Must be 4 */
337 struct smb2_tree_disconnect_rsp
{
339 __le16 StructureSize
; /* Must be 4 */
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
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
{
448 __le16 StructureSize
; /* Must be 57 */
450 __u8 RequestedOplockLevel
;
451 __le32 ImpersonationLevel
;
452 __le64 SmbCreateFlags
;
454 __le32 DesiredAccess
;
455 __le32 FileAttributes
;
457 __le32 CreateDisposition
;
458 __le32 CreateOptions
;
461 __le32 CreateContextsOffset
;
462 __le32 CreateContextsLength
;
466 struct smb2_create_rsp
{
468 __le16 StructureSize
; /* Must be 89 */
473 __le64 LastAccessTime
;
474 __le64 LastWriteTime
;
476 __le64 AllocationSize
;
478 __le32 FileAttributes
;
480 __u64 PersistentFileId
; /* opaque endianness */
481 __u64 VolatileFileId
; /* opaque endianness */
482 __le32 CreateContextsOffset
;
483 __le32 CreateContextsLength
;
487 struct create_context
{
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
{
515 __le64 LeaseDuration
;
518 struct lease_context_v2
{
523 __le64 LeaseDuration
;
524 __le64 ParentLeaseKeyLow
;
525 __le64 ParentLeaseKeyHigh
;
530 struct create_lease
{
531 struct create_context ccontext
;
533 struct lease_context lcontext
;
536 struct create_lease_v2
{
537 struct create_context ccontext
;
539 struct lease_context_v2 lcontext
;
543 struct create_durable
{
544 struct create_context ccontext
;
549 __u64 PersistentFileId
;
550 __u64 VolatileFileId
;
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 */
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 */
567 /* array will only be one chunk long for us */
570 __le32 Length
; /* how many bytes to copy */
574 struct copychunk_ioctl_rsp
{
575 __le32 ChunksWritten
;
576 __le32 ChunkBytesWritten
;
577 __le32 TotalBytesWritten
;
580 /* Response and Request are the same format */
581 struct validate_negotiate_info
{
583 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
589 #define RSS_CAPABLE 0x00000001
590 #define RDMA_CAPABLE 0x00000002
592 struct network_interface_info_ioctl_rsp
{
593 __le32 Next
; /* next interface. zero if this is last one */
595 __le32 Capability
; /* RSS or RDMA Capable */
598 char SockAddr_Storage
[128];
601 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
603 struct compress_ioctl
{
604 __le16 CompressionState
; /* See cifspdu.h for possible flag values */
607 struct smb2_ioctl_req
{
609 __le16 StructureSize
; /* Must be 57 */
612 __u64 PersistentFileId
; /* opaque endianness */
613 __u64 VolatileFileId
; /* opaque endianness */
616 __le32 MaxInputResponse
;
619 __le32 MaxOutputResponse
;
625 struct smb2_ioctl_rsp
{
627 __le16 StructureSize
; /* Must be 57 */
630 __u64 PersistentFileId
; /* opaque endianness */
631 __u64 VolatileFileId
; /* opaque endianness */
638 /* char * buffer[] */
641 /* Currently defined values for close flags */
642 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
643 struct smb2_close_req
{
645 __le16 StructureSize
; /* Must be 24 */
648 __u64 PersistentFileId
; /* opaque endianness */
649 __u64 VolatileFileId
; /* opaque endianness */
652 struct smb2_close_rsp
{
654 __le16 StructureSize
; /* 60 */
658 __le64 LastAccessTime
;
659 __le64 LastWriteTime
;
661 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
666 struct smb2_flush_req
{
668 __le16 StructureSize
; /* Must be 24 */
671 __u64 PersistentFileId
; /* opaque endianness */
672 __u64 VolatileFileId
; /* opaque endianness */
675 struct smb2_flush_rsp
{
677 __le16 StructureSize
;
681 /* For read request Flags field below, following flag is defined for SMB3.02 */
682 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
684 /* Channel field for read and write: exactly one of following flags can be set*/
685 #define SMB2_CHANNEL_NONE 0x00000000
686 #define SMB2_CHANNEL_RDMA_V1 0x00000001 /* SMB3 or later */
687 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE 0x00000001 /* SMB3.02 or later */
689 struct smb2_read_req
{
691 __le16 StructureSize
; /* Must be 49 */
692 __u8 Padding
; /* offset from start of SMB2 header to place read */
693 __u8 Flags
; /* MBZ unless SMB3.02 or later */
696 __u64 PersistentFileId
; /* opaque endianness */
697 __u64 VolatileFileId
; /* opaque endianness */
699 __le32 Channel
; /* MBZ except for SMB3 or later */
700 __le32 RemainingBytes
;
701 __le16 ReadChannelInfoOffset
; /* Reserved MBZ */
702 __le16 ReadChannelInfoLength
; /* Reserved MBZ */
706 struct smb2_read_rsp
{
708 __le16 StructureSize
; /* Must be 17 */
712 __le32 DataRemaining
;
717 /* For write request Flags field below the following flags are defined: */
718 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
719 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
721 struct smb2_write_req
{
723 __le16 StructureSize
; /* Must be 49 */
724 __le16 DataOffset
; /* offset from start of SMB2 header to write data */
727 __u64 PersistentFileId
; /* opaque endianness */
728 __u64 VolatileFileId
; /* opaque endianness */
729 __le32 Channel
; /* Reserved MBZ */
730 __le32 RemainingBytes
;
731 __le16 WriteChannelInfoOffset
; /* Reserved MBZ */
732 __le16 WriteChannelInfoLength
; /* Reserved MBZ */
737 struct smb2_write_rsp
{
739 __le16 StructureSize
; /* Must be 17 */
743 __le32 DataRemaining
;
748 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
749 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
750 #define SMB2_LOCKFLAG_UNLOCK 0x0004
751 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
753 struct smb2_lock_element
{
760 struct smb2_lock_req
{
762 __le16 StructureSize
; /* Must be 48 */
765 __u64 PersistentFileId
; /* opaque endianness */
766 __u64 VolatileFileId
; /* opaque endianness */
767 /* Followed by at least one */
768 struct smb2_lock_element locks
[1];
771 struct smb2_lock_rsp
{
773 __le16 StructureSize
; /* Must be 4 */
777 struct smb2_echo_req
{
779 __le16 StructureSize
; /* Must be 4 */
783 struct smb2_echo_rsp
{
785 __le16 StructureSize
; /* Must be 4 */
789 /* search (query_directory) Flags field */
790 #define SMB2_RESTART_SCANS 0x01
791 #define SMB2_RETURN_SINGLE_ENTRY 0x02
792 #define SMB2_INDEX_SPECIFIED 0x04
793 #define SMB2_REOPEN 0x10
795 struct smb2_query_directory_req
{
797 __le16 StructureSize
; /* Must be 33 */
798 __u8 FileInformationClass
;
801 __u64 PersistentFileId
; /* opaque endianness */
802 __u64 VolatileFileId
; /* opaque endianness */
803 __le16 FileNameOffset
;
804 __le16 FileNameLength
;
805 __le32 OutputBufferLength
;
809 struct smb2_query_directory_rsp
{
811 __le16 StructureSize
; /* Must be 9 */
812 __le16 OutputBufferOffset
;
813 __le32 OutputBufferLength
;
817 /* Possible InfoType values */
818 #define SMB2_O_INFO_FILE 0x01
819 #define SMB2_O_INFO_FILESYSTEM 0x02
820 #define SMB2_O_INFO_SECURITY 0x03
821 #define SMB2_O_INFO_QUOTA 0x04
823 struct smb2_query_info_req
{
825 __le16 StructureSize
; /* Must be 41 */
828 __le32 OutputBufferLength
;
829 __le16 InputBufferOffset
;
831 __le32 InputBufferLength
;
832 __le32 AdditionalInformation
;
834 __u64 PersistentFileId
; /* opaque endianness */
835 __u64 VolatileFileId
; /* opaque endianness */
839 struct smb2_query_info_rsp
{
841 __le16 StructureSize
; /* Must be 9 */
842 __le16 OutputBufferOffset
;
843 __le32 OutputBufferLength
;
847 struct smb2_set_info_req
{
849 __le16 StructureSize
; /* Must be 33 */
855 __le32 AdditionalInformation
;
856 __u64 PersistentFileId
; /* opaque endianness */
857 __u64 VolatileFileId
; /* opaque endianness */
861 struct smb2_set_info_rsp
{
863 __le16 StructureSize
; /* Must be 2 */
866 struct smb2_oplock_break
{
868 __le16 StructureSize
; /* Must be 24 */
876 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
878 struct smb2_lease_break
{
880 __le16 StructureSize
; /* Must be 44 */
884 __le32 CurrentLeaseState
;
885 __le32 NewLeaseState
;
887 __le32 AccessMaskHint
;
888 __le32 ShareMaskHint
;
891 struct smb2_lease_ack
{
893 __le16 StructureSize
; /* Must be 36 */
898 __le64 LeaseDuration
;
902 * PDU infolevel structure definitions
903 * BB consider moving to a different header
906 /* File System Information Classes */
907 #define FS_VOLUME_INFORMATION 1 /* Query */
908 #define FS_LABEL_INFORMATION 2 /* Local only */
909 #define FS_SIZE_INFORMATION 3 /* Query */
910 #define FS_DEVICE_INFORMATION 4 /* Query */
911 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
912 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
913 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
914 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
915 #define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
916 #define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
917 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
919 struct smb2_fs_full_size_info
{
920 __le64 TotalAllocationUnits
;
921 __le64 CallerAvailableAllocationUnits
;
922 __le64 ActualAvailableAllocationUnits
;
923 __le32 SectorsPerAllocationUnit
;
924 __le32 BytesPerSector
;
927 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
928 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
929 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
930 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
932 /* sector size info struct */
933 struct smb3_fs_ss_info
{
934 __le32 LogicalBytesPerSector
;
935 __le32 PhysicalBytesPerSectorForAtomicity
;
936 __le32 PhysicalBytesPerSectorForPerf
;
937 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity
;
939 __le32 ByteOffsetForSectorAlignment
;
940 __le32 ByteOffsetForPartitionAlignment
;
943 /* partial list of QUERY INFO levels */
944 #define FILE_DIRECTORY_INFORMATION 1
945 #define FILE_FULL_DIRECTORY_INFORMATION 2
946 #define FILE_BOTH_DIRECTORY_INFORMATION 3
947 #define FILE_BASIC_INFORMATION 4
948 #define FILE_STANDARD_INFORMATION 5
949 #define FILE_INTERNAL_INFORMATION 6
950 #define FILE_EA_INFORMATION 7
951 #define FILE_ACCESS_INFORMATION 8
952 #define FILE_NAME_INFORMATION 9
953 #define FILE_RENAME_INFORMATION 10
954 #define FILE_LINK_INFORMATION 11
955 #define FILE_NAMES_INFORMATION 12
956 #define FILE_DISPOSITION_INFORMATION 13
957 #define FILE_POSITION_INFORMATION 14
958 #define FILE_FULL_EA_INFORMATION 15
959 #define FILE_MODE_INFORMATION 16
960 #define FILE_ALIGNMENT_INFORMATION 17
961 #define FILE_ALL_INFORMATION 18
962 #define FILE_ALLOCATION_INFORMATION 19
963 #define FILE_END_OF_FILE_INFORMATION 20
964 #define FILE_ALTERNATE_NAME_INFORMATION 21
965 #define FILE_STREAM_INFORMATION 22
966 #define FILE_PIPE_INFORMATION 23
967 #define FILE_PIPE_LOCAL_INFORMATION 24
968 #define FILE_PIPE_REMOTE_INFORMATION 25
969 #define FILE_MAILSLOT_QUERY_INFORMATION 26
970 #define FILE_MAILSLOT_SET_INFORMATION 27
971 #define FILE_COMPRESSION_INFORMATION 28
972 #define FILE_OBJECT_ID_INFORMATION 29
973 /* Number 30 not defined in documents */
974 #define FILE_MOVE_CLUSTER_INFORMATION 31
975 #define FILE_QUOTA_INFORMATION 32
976 #define FILE_REPARSE_POINT_INFORMATION 33
977 #define FILE_NETWORK_OPEN_INFORMATION 34
978 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
979 #define FILE_TRACKING_INFORMATION 36
980 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
981 #define FILEID_FULL_DIRECTORY_INFORMATION 38
982 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
983 #define FILE_SHORT_NAME_INFORMATION 40
984 #define FILE_SFIO_RESERVE_INFORMATION 44
985 #define FILE_SFIO_VOLUME_INFORMATION 45
986 #define FILE_HARD_LINK_INFORMATION 46
987 #define FILE_NORMALIZED_NAME_INFORMATION 48
988 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
989 #define FILE_STANDARD_LINK_INFORMATION 54
991 struct smb2_file_internal_info
{
993 } __packed
; /* level 6 Query */
995 struct smb2_file_rename_info
{ /* encoding of request for level 10 */
996 __u8 ReplaceIfExists
; /* 1 = replace existing target with new */
997 /* 0 = fail if target already exists */
999 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1000 __le32 FileNameLength
;
1001 char FileName
[0]; /* New name to be assigned */
1002 } __packed
; /* level 10 Set */
1004 struct smb2_file_link_info
{ /* encoding of request for level 11 */
1005 __u8 ReplaceIfExists
; /* 1 = replace existing link with new */
1006 /* 0 = fail if link already exists */
1008 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1009 __le32 FileNameLength
;
1010 char FileName
[0]; /* Name to be assigned to new link */
1011 } __packed
; /* level 11 Set */
1014 * This level 18, although with struct with same name is different from cifs
1015 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1016 * CurrentByteOffset.
1018 struct smb2_file_all_info
{ /* data block encoding of response to level 18 */
1019 __le64 CreationTime
; /* Beginning of FILE_BASIC_INFO equivalent */
1020 __le64 LastAccessTime
;
1021 __le64 LastWriteTime
;
1024 __u32 Pad1
; /* End of FILE_BASIC_INFO_INFO equivalent */
1025 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
1026 __le64 EndOfFile
; /* size ie offset to first free byte in file */
1027 __le32 NumberOfLinks
; /* hard links */
1030 __u16 Pad2
; /* End of FILE_STANDARD_INFO equivalent */
1034 __le64 CurrentByteOffset
;
1036 __le32 AlignmentRequirement
;
1037 __le32 FileNameLength
;
1039 } __packed
; /* level 18 Query */
1041 struct smb2_file_eof_info
{ /* encoding of request for level 10 */
1042 __le64 EndOfFile
; /* new end of file value */
1043 } __packed
; /* level 20 Set */
1045 #endif /* _SMB2PDU_H */