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 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 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 */
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
;
140 * SMB2 flag definitions
142 #define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
143 #define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
144 #define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
145 #define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
146 #define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
149 * Definitions for SMB2 Protocol Data Units (network frames)
151 * See MS-SMB2.PDF specification for protocol details.
152 * The Naming convention is the lower case version of the SMB2
153 * command code name for the struct. Note that structures must be packed.
157 #define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
159 struct smb2_err_rsp
{
161 __le16 StructureSize
;
162 __le16 Reserved
; /* MBZ */
163 __le32 ByteCount
; /* even if zero, at least one byte follows */
164 __u8 ErrorData
[1]; /* variable length */
167 struct smb2_symlink_err_rsp
{
168 __le32 SymLinkLength
;
169 __le32 SymLinkErrorTag
;
171 __le16 ReparseDataLength
;
172 __le16 UnparsedPathLength
;
173 __le16 SubstituteNameOffset
;
174 __le16 SubstituteNameLength
;
175 __le16 PrintNameOffset
;
176 __le16 PrintNameLength
;
181 #define SMB2_CLIENT_GUID_SIZE 16
183 struct smb2_negotiate_req
{
185 __le16 StructureSize
; /* Must be 36 */
188 __le16 Reserved
; /* MBZ */
190 __u8 ClientGUID
[SMB2_CLIENT_GUID_SIZE
];
191 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
192 __le32 NegotiateContextOffset
; /* SMB3.1.1 only. MBZ earlier */
193 __le16 NegotiateContextCount
; /* SMB3.1.1 only. MBZ earlier */
195 __le16 Dialects
[1]; /* One dialect (vers=) at a time for now */
199 #define SMB20_PROT_ID 0x0202
200 #define SMB21_PROT_ID 0x0210
201 #define SMB30_PROT_ID 0x0300
202 #define SMB302_PROT_ID 0x0302
203 #define SMB311_PROT_ID 0x0311
204 #define BAD_PROT_ID 0xFFFF
206 /* SecurityMode flags */
207 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
208 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
209 /* Capabilities flags */
210 #define SMB2_GLOBAL_CAP_DFS 0x00000001
211 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
212 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
213 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
214 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
215 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
216 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
218 #define SMB2_NT_FIND 0x00100000
219 #define SMB2_LARGE_FILES 0x00200000
221 #define SMB311_SALT_SIZE 32
222 /* Hash Algorithm Types */
223 #define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
225 struct smb2_preauth_neg_context
{
226 __le16 ContextType
; /* 1 */
229 __le16 HashAlgorithmCount
; /* 1 */
231 __le16 HashAlgorithms
; /* HashAlgorithms[0] since only one defined */
232 __u8 Salt
[SMB311_SALT_SIZE
];
235 /* Encryption Algorithms Ciphers */
236 #define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
237 #define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
239 struct smb2_encryption_neg_context
{
240 __le16 ContextType
; /* 2 */
243 __le16 CipherCount
; /* AES-128-GCM and AES-128-CCM */
244 __le16 Ciphers
[2]; /* Ciphers[0] since only one used now */
247 struct smb2_negotiate_rsp
{
249 __le16 StructureSize
; /* Must be 65 */
251 __le16 DialectRevision
;
252 __le16 NegotiateContextCount
; /* Prior to SMB3.1.1 was Reserved & MBZ */
255 __le32 MaxTransactSize
;
258 __le64 SystemTime
; /* MBZ */
259 __le64 ServerStartTime
;
260 __le16 SecurityBufferOffset
;
261 __le16 SecurityBufferLength
;
262 __le32 NegotiateContextOffset
; /* Pre:SMB3.1.1 was reserved/ignored */
263 __u8 Buffer
[1]; /* variable length GSS security buffer */
267 #define SMB2_SESSION_REQ_FLAG_BINDING 0x01
268 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
270 struct smb2_sess_setup_req
{
272 __le16 StructureSize
; /* Must be 25 */
277 __le16 SecurityBufferOffset
;
278 __le16 SecurityBufferLength
;
279 __le64 PreviousSessionId
;
280 __u8 Buffer
[1]; /* variable length GSS security buffer */
283 /* Currently defined SessionFlags */
284 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
285 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
286 #define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
287 struct smb2_sess_setup_rsp
{
289 __le16 StructureSize
; /* Must be 9 */
291 __le16 SecurityBufferOffset
;
292 __le16 SecurityBufferLength
;
293 __u8 Buffer
[1]; /* variable length GSS security buffer */
296 struct smb2_logoff_req
{
298 __le16 StructureSize
; /* Must be 4 */
302 struct smb2_logoff_rsp
{
304 __le16 StructureSize
; /* Must be 4 */
308 /* Flags/Reserved for SMB3.1.1 */
309 #define SMB2_SHAREFLAG_CLUSTER_RECONNECT 0x0001
311 struct smb2_tree_connect_req
{
313 __le16 StructureSize
; /* Must be 9 */
314 __le16 Reserved
; /* Flags in SMB3.1.1 */
317 __u8 Buffer
[1]; /* variable length */
320 struct smb2_tree_connect_rsp
{
322 __le16 StructureSize
; /* Must be 16 */
323 __u8 ShareType
; /* see below */
325 __le32 ShareFlags
; /* see below */
326 __le32 Capabilities
; /* see below */
327 __le32 MaximalAccess
;
330 /* Possible ShareType values */
331 #define SMB2_SHARE_TYPE_DISK 0x01
332 #define SMB2_SHARE_TYPE_PIPE 0x02
333 #define SMB2_SHARE_TYPE_PRINT 0x03
336 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
337 * must be set (any of the remaining, SHI1005, flags may be set individually
340 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
341 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
342 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
343 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
344 #define SHI1005_FLAGS_DFS 0x00000001
345 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
346 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
347 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
348 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
349 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
350 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
351 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
352 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
353 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
354 #define SHI1005_FLAGS_ALL 0x0000FF33
356 /* Possible share capabilities */
357 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
358 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
359 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
360 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
361 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
363 struct smb2_tree_disconnect_req
{
365 __le16 StructureSize
; /* Must be 4 */
369 struct smb2_tree_disconnect_rsp
{
371 __le16 StructureSize
; /* Must be 4 */
375 /* File Attrubutes */
376 #define FILE_ATTRIBUTE_READONLY 0x00000001
377 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
378 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
379 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
380 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
381 #define FILE_ATTRIBUTE_NORMAL 0x00000080
382 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
383 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
384 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
385 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
386 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
387 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
388 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
389 #define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
390 #define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
393 #define SMB2_OPLOCK_LEVEL_NONE 0x00
394 #define SMB2_OPLOCK_LEVEL_II 0x01
395 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
396 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
397 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
398 /* Non-spec internal type */
399 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
401 /* Desired Access Flags */
402 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
403 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
404 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
405 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
406 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
407 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
408 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
409 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
410 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
411 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
412 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
413 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
414 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
415 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
416 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
417 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
418 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
419 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
420 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
422 /* ShareAccess Flags */
423 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
424 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
425 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
426 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
428 /* CreateDisposition Flags */
429 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
430 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
431 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
432 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
433 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
434 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
436 /* CreateOptions Flags */
437 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
438 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
439 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
440 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
441 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
442 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
443 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
444 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
445 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
446 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
447 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
448 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
449 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
450 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
451 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
452 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
453 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
454 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
455 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
457 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
458 | FILE_READ_ATTRIBUTES_LE)
459 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
460 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
461 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
463 /* Impersonation Levels */
464 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
465 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
466 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
467 #define IL_DELEGATE cpu_to_le32(0x00000003)
469 /* Create Context Values */
470 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
471 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
472 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
473 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
474 #define SMB2_CREATE_ALLOCATION_SIZE "AISi"
475 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
476 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
477 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
478 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
479 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
480 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
481 #define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
482 #define SVHDX_OPEN_DEVICE_CONTEXT 0x83CE6F1AD851E0986E34401CC9BCFCE9
484 struct smb2_create_req
{
486 __le16 StructureSize
; /* Must be 57 */
488 __u8 RequestedOplockLevel
;
489 __le32 ImpersonationLevel
;
490 __le64 SmbCreateFlags
;
492 __le32 DesiredAccess
;
493 __le32 FileAttributes
;
495 __le32 CreateDisposition
;
496 __le32 CreateOptions
;
499 __le32 CreateContextsOffset
;
500 __le32 CreateContextsLength
;
504 struct smb2_create_rsp
{
506 __le16 StructureSize
; /* Must be 89 */
511 __le64 LastAccessTime
;
512 __le64 LastWriteTime
;
514 __le64 AllocationSize
;
516 __le32 FileAttributes
;
518 __u64 PersistentFileId
; /* opaque endianness */
519 __u64 VolatileFileId
; /* opaque endianness */
520 __le32 CreateContextsOffset
;
521 __le32 CreateContextsLength
;
525 struct create_context
{
535 #define SMB2_LEASE_READ_CACHING_HE 0x01
536 #define SMB2_LEASE_HANDLE_CACHING_HE 0x02
537 #define SMB2_LEASE_WRITE_CACHING_HE 0x04
539 #define SMB2_LEASE_NONE cpu_to_le32(0x00)
540 #define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
541 #define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
542 #define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
544 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x02)
546 #define SMB2_LEASE_KEY_SIZE 16
548 struct lease_context
{
553 __le64 LeaseDuration
;
556 struct lease_context_v2
{
561 __le64 LeaseDuration
;
562 __le64 ParentLeaseKeyLow
;
563 __le64 ParentLeaseKeyHigh
;
568 struct create_lease
{
569 struct create_context ccontext
;
571 struct lease_context lcontext
;
574 struct create_lease_v2
{
575 struct create_context ccontext
;
577 struct lease_context_v2 lcontext
;
581 struct create_durable
{
582 struct create_context ccontext
;
587 __u64 PersistentFileId
;
588 __u64 VolatileFileId
;
593 #define COPY_CHUNK_RES_KEY_SIZE 24
594 struct resume_key_req
{
595 char ResumeKey
[COPY_CHUNK_RES_KEY_SIZE
];
596 __le32 ContextLength
; /* MBZ */
597 char Context
[0]; /* ignored, Windows sets to 4 bytes of zero */
600 /* this goes in the ioctl buffer when doing a copychunk request */
601 struct copychunk_ioctl
{
602 char SourceKey
[COPY_CHUNK_RES_KEY_SIZE
];
603 __le32 ChunkCount
; /* we are only sending 1 */
605 /* array will only be one chunk long for us */
608 __le32 Length
; /* how many bytes to copy */
612 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
613 struct file_zero_data_information
{
615 __le64 BeyondFinalZero
;
618 struct copychunk_ioctl_rsp
{
619 __le32 ChunksWritten
;
620 __le32 ChunkBytesWritten
;
621 __le32 TotalBytesWritten
;
624 struct fsctl_set_integrity_information_req
{
625 __le16 ChecksumAlgorithm
;
630 struct fsctl_get_integrity_information_rsp
{
631 __le16 ChecksumAlgorithm
;
634 __le32 ChecksumChunkSizeInBytes
;
635 __le32 ClusterSizeInBytes
;
638 /* Integrity ChecksumAlgorithm choices for above */
639 #define CHECKSUM_TYPE_NONE 0x0000
640 #define CHECKSUM_TYPE_CRC64 0x0002
641 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
643 /* Integrity flags for above */
644 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
647 struct validate_negotiate_info_req
{
649 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
652 __le16 Dialects
[1]; /* dialect (someday maybe list) client asked for */
655 struct validate_negotiate_info_rsp
{
657 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
659 __le16 Dialect
; /* Dialect in use for the connection */
662 #define RSS_CAPABLE 0x00000001
663 #define RDMA_CAPABLE 0x00000002
665 struct network_interface_info_ioctl_rsp
{
666 __le32 Next
; /* next interface. zero if this is last one */
668 __le32 Capability
; /* RSS or RDMA Capable */
671 char SockAddr_Storage
[128];
674 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
676 struct compress_ioctl
{
677 __le16 CompressionState
; /* See cifspdu.h for possible flag values */
680 struct duplicate_extents_to_file
{
681 __u64 PersistentFileHandle
; /* source file handle, opaque endianness */
682 __u64 VolatileFileHandle
;
683 __le64 SourceFileOffset
;
684 __le64 TargetFileOffset
;
685 __le64 ByteCount
; /* Bytes to be copied */
688 struct smb2_ioctl_req
{
690 __le16 StructureSize
; /* Must be 57 */
693 __u64 PersistentFileId
; /* opaque endianness */
694 __u64 VolatileFileId
; /* opaque endianness */
697 __le32 MaxInputResponse
;
700 __le32 MaxOutputResponse
;
706 struct smb2_ioctl_rsp
{
708 __le16 StructureSize
; /* Must be 57 */
711 __u64 PersistentFileId
; /* opaque endianness */
712 __u64 VolatileFileId
; /* opaque endianness */
719 /* char * buffer[] */
722 /* Currently defined values for close flags */
723 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
724 struct smb2_close_req
{
726 __le16 StructureSize
; /* Must be 24 */
729 __u64 PersistentFileId
; /* opaque endianness */
730 __u64 VolatileFileId
; /* opaque endianness */
733 struct smb2_close_rsp
{
735 __le16 StructureSize
; /* 60 */
739 __le64 LastAccessTime
;
740 __le64 LastWriteTime
;
742 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
747 struct smb2_flush_req
{
749 __le16 StructureSize
; /* Must be 24 */
752 __u64 PersistentFileId
; /* opaque endianness */
753 __u64 VolatileFileId
; /* opaque endianness */
756 struct smb2_flush_rsp
{
758 __le16 StructureSize
;
762 /* For read request Flags field below, following flag is defined for SMB3.02 */
763 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
765 /* Channel field for read and write: exactly one of following flags can be set*/
766 #define SMB2_CHANNEL_NONE 0x00000000
767 #define SMB2_CHANNEL_RDMA_V1 0x00000001 /* SMB3 or later */
768 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE 0x00000001 /* SMB3.02 or later */
770 struct smb2_read_req
{
772 __le16 StructureSize
; /* Must be 49 */
773 __u8 Padding
; /* offset from start of SMB2 header to place read */
774 __u8 Flags
; /* MBZ unless SMB3.02 or later */
777 __u64 PersistentFileId
; /* opaque endianness */
778 __u64 VolatileFileId
; /* opaque endianness */
780 __le32 Channel
; /* MBZ except for SMB3 or later */
781 __le32 RemainingBytes
;
782 __le16 ReadChannelInfoOffset
; /* Reserved MBZ */
783 __le16 ReadChannelInfoLength
; /* Reserved MBZ */
787 struct smb2_read_rsp
{
789 __le16 StructureSize
; /* Must be 17 */
793 __le32 DataRemaining
;
798 /* For write request Flags field below the following flags are defined: */
799 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
800 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
802 struct smb2_write_req
{
804 __le16 StructureSize
; /* Must be 49 */
805 __le16 DataOffset
; /* offset from start of SMB2 header to write data */
808 __u64 PersistentFileId
; /* opaque endianness */
809 __u64 VolatileFileId
; /* opaque endianness */
810 __le32 Channel
; /* Reserved MBZ */
811 __le32 RemainingBytes
;
812 __le16 WriteChannelInfoOffset
; /* Reserved MBZ */
813 __le16 WriteChannelInfoLength
; /* Reserved MBZ */
818 struct smb2_write_rsp
{
820 __le16 StructureSize
; /* Must be 17 */
824 __le32 DataRemaining
;
829 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
830 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
831 #define SMB2_LOCKFLAG_UNLOCK 0x0004
832 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
834 struct smb2_lock_element
{
841 struct smb2_lock_req
{
843 __le16 StructureSize
; /* Must be 48 */
846 __u64 PersistentFileId
; /* opaque endianness */
847 __u64 VolatileFileId
; /* opaque endianness */
848 /* Followed by at least one */
849 struct smb2_lock_element locks
[1];
852 struct smb2_lock_rsp
{
854 __le16 StructureSize
; /* Must be 4 */
858 struct smb2_echo_req
{
860 __le16 StructureSize
; /* Must be 4 */
864 struct smb2_echo_rsp
{
866 __le16 StructureSize
; /* Must be 4 */
870 /* search (query_directory) Flags field */
871 #define SMB2_RESTART_SCANS 0x01
872 #define SMB2_RETURN_SINGLE_ENTRY 0x02
873 #define SMB2_INDEX_SPECIFIED 0x04
874 #define SMB2_REOPEN 0x10
876 struct smb2_query_directory_req
{
878 __le16 StructureSize
; /* Must be 33 */
879 __u8 FileInformationClass
;
882 __u64 PersistentFileId
; /* opaque endianness */
883 __u64 VolatileFileId
; /* opaque endianness */
884 __le16 FileNameOffset
;
885 __le16 FileNameLength
;
886 __le32 OutputBufferLength
;
890 struct smb2_query_directory_rsp
{
892 __le16 StructureSize
; /* Must be 9 */
893 __le16 OutputBufferOffset
;
894 __le32 OutputBufferLength
;
898 /* Possible InfoType values */
899 #define SMB2_O_INFO_FILE 0x01
900 #define SMB2_O_INFO_FILESYSTEM 0x02
901 #define SMB2_O_INFO_SECURITY 0x03
902 #define SMB2_O_INFO_QUOTA 0x04
904 /* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
905 #define OWNER_SECINFO 0x00000001
906 #define GROUP_SECINFO 0x00000002
907 #define DACL_SECINFO 0x00000004
908 #define SACL_SECINFO 0x00000008
909 #define LABEL_SECINFO 0x00000010
910 #define ATTRIBUTE_SECINFO 0x00000020
911 #define SCOPE_SECINFO 0x00000040
912 #define BACKUP_SECINFO 0x00010000
913 #define UNPROTECTED_SACL_SECINFO 0x10000000
914 #define UNPROTECTED_DACL_SECINFO 0x20000000
915 #define PROTECTED_SACL_SECINFO 0x40000000
916 #define PROTECTED_DACL_SECINFO 0x80000000
918 /* Flags used for FileFullEAinfo */
919 #define SL_RESTART_SCAN 0x00000001
920 #define SL_RETURN_SINGLE_ENTRY 0x00000002
921 #define SL_INDEX_SPECIFIED 0x00000004
923 struct smb2_query_info_req
{
925 __le16 StructureSize
; /* Must be 41 */
928 __le32 OutputBufferLength
;
929 __le16 InputBufferOffset
;
931 __le32 InputBufferLength
;
932 __le32 AdditionalInformation
;
934 __u64 PersistentFileId
; /* opaque endianness */
935 __u64 VolatileFileId
; /* opaque endianness */
939 struct smb2_query_info_rsp
{
941 __le16 StructureSize
; /* Must be 9 */
942 __le16 OutputBufferOffset
;
943 __le32 OutputBufferLength
;
947 struct smb2_set_info_req
{
949 __le16 StructureSize
; /* Must be 33 */
955 __le32 AdditionalInformation
;
956 __u64 PersistentFileId
; /* opaque endianness */
957 __u64 VolatileFileId
; /* opaque endianness */
961 struct smb2_set_info_rsp
{
963 __le16 StructureSize
; /* Must be 2 */
966 struct smb2_oplock_break
{
968 __le16 StructureSize
; /* Must be 24 */
976 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
978 struct smb2_lease_break
{
980 __le16 StructureSize
; /* Must be 44 */
984 __le32 CurrentLeaseState
;
985 __le32 NewLeaseState
;
987 __le32 AccessMaskHint
;
988 __le32 ShareMaskHint
;
991 struct smb2_lease_ack
{
993 __le16 StructureSize
; /* Must be 36 */
998 __le64 LeaseDuration
;
1002 * PDU infolevel structure definitions
1003 * BB consider moving to a different header
1006 /* File System Information Classes */
1007 #define FS_VOLUME_INFORMATION 1 /* Query */
1008 #define FS_LABEL_INFORMATION 2 /* Local only */
1009 #define FS_SIZE_INFORMATION 3 /* Query */
1010 #define FS_DEVICE_INFORMATION 4 /* Query */
1011 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1012 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
1013 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
1014 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1015 #define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1016 #define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1017 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1019 struct smb2_fs_full_size_info
{
1020 __le64 TotalAllocationUnits
;
1021 __le64 CallerAvailableAllocationUnits
;
1022 __le64 ActualAvailableAllocationUnits
;
1023 __le32 SectorsPerAllocationUnit
;
1024 __le32 BytesPerSector
;
1027 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1028 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1029 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1030 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1032 /* sector size info struct */
1033 struct smb3_fs_ss_info
{
1034 __le32 LogicalBytesPerSector
;
1035 __le32 PhysicalBytesPerSectorForAtomicity
;
1036 __le32 PhysicalBytesPerSectorForPerf
;
1037 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity
;
1039 __le32 ByteOffsetForSectorAlignment
;
1040 __le32 ByteOffsetForPartitionAlignment
;
1043 /* partial list of QUERY INFO levels */
1044 #define FILE_DIRECTORY_INFORMATION 1
1045 #define FILE_FULL_DIRECTORY_INFORMATION 2
1046 #define FILE_BOTH_DIRECTORY_INFORMATION 3
1047 #define FILE_BASIC_INFORMATION 4
1048 #define FILE_STANDARD_INFORMATION 5
1049 #define FILE_INTERNAL_INFORMATION 6
1050 #define FILE_EA_INFORMATION 7
1051 #define FILE_ACCESS_INFORMATION 8
1052 #define FILE_NAME_INFORMATION 9
1053 #define FILE_RENAME_INFORMATION 10
1054 #define FILE_LINK_INFORMATION 11
1055 #define FILE_NAMES_INFORMATION 12
1056 #define FILE_DISPOSITION_INFORMATION 13
1057 #define FILE_POSITION_INFORMATION 14
1058 #define FILE_FULL_EA_INFORMATION 15
1059 #define FILE_MODE_INFORMATION 16
1060 #define FILE_ALIGNMENT_INFORMATION 17
1061 #define FILE_ALL_INFORMATION 18
1062 #define FILE_ALLOCATION_INFORMATION 19
1063 #define FILE_END_OF_FILE_INFORMATION 20
1064 #define FILE_ALTERNATE_NAME_INFORMATION 21
1065 #define FILE_STREAM_INFORMATION 22
1066 #define FILE_PIPE_INFORMATION 23
1067 #define FILE_PIPE_LOCAL_INFORMATION 24
1068 #define FILE_PIPE_REMOTE_INFORMATION 25
1069 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1070 #define FILE_MAILSLOT_SET_INFORMATION 27
1071 #define FILE_COMPRESSION_INFORMATION 28
1072 #define FILE_OBJECT_ID_INFORMATION 29
1073 /* Number 30 not defined in documents */
1074 #define FILE_MOVE_CLUSTER_INFORMATION 31
1075 #define FILE_QUOTA_INFORMATION 32
1076 #define FILE_REPARSE_POINT_INFORMATION 33
1077 #define FILE_NETWORK_OPEN_INFORMATION 34
1078 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
1079 #define FILE_TRACKING_INFORMATION 36
1080 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
1081 #define FILEID_FULL_DIRECTORY_INFORMATION 38
1082 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1083 #define FILE_SHORT_NAME_INFORMATION 40
1084 #define FILE_SFIO_RESERVE_INFORMATION 44
1085 #define FILE_SFIO_VOLUME_INFORMATION 45
1086 #define FILE_HARD_LINK_INFORMATION 46
1087 #define FILE_NORMALIZED_NAME_INFORMATION 48
1088 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1089 #define FILE_STANDARD_LINK_INFORMATION 54
1091 struct smb2_file_internal_info
{
1093 } __packed
; /* level 6 Query */
1095 struct smb2_file_rename_info
{ /* encoding of request for level 10 */
1096 __u8 ReplaceIfExists
; /* 1 = replace existing target with new */
1097 /* 0 = fail if target already exists */
1099 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1100 __le32 FileNameLength
;
1101 char FileName
[0]; /* New name to be assigned */
1102 } __packed
; /* level 10 Set */
1104 struct smb2_file_link_info
{ /* encoding of request for level 11 */
1105 __u8 ReplaceIfExists
; /* 1 = replace existing link with new */
1106 /* 0 = fail if link already exists */
1108 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1109 __le32 FileNameLength
;
1110 char FileName
[0]; /* Name to be assigned to new link */
1111 } __packed
; /* level 11 Set */
1114 * This level 18, although with struct with same name is different from cifs
1115 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1116 * CurrentByteOffset.
1118 struct smb2_file_all_info
{ /* data block encoding of response to level 18 */
1119 __le64 CreationTime
; /* Beginning of FILE_BASIC_INFO equivalent */
1120 __le64 LastAccessTime
;
1121 __le64 LastWriteTime
;
1124 __u32 Pad1
; /* End of FILE_BASIC_INFO_INFO equivalent */
1125 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
1126 __le64 EndOfFile
; /* size ie offset to first free byte in file */
1127 __le32 NumberOfLinks
; /* hard links */
1130 __u16 Pad2
; /* End of FILE_STANDARD_INFO equivalent */
1134 __le64 CurrentByteOffset
;
1136 __le32 AlignmentRequirement
;
1137 __le32 FileNameLength
;
1139 } __packed
; /* level 18 Query */
1141 struct smb2_file_eof_info
{ /* encoding of request for level 10 */
1142 __le64 EndOfFile
; /* new end of file value */
1143 } __packed
; /* level 20 Set */
1145 #endif /* _SMB2PDU_H */