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
31 * Note that, due to trying to use names similar to the protocol specifications,
32 * there are many mixed case field names in the structures below. Although
33 * this does not match typical Linux kernel style, it is necessary to be
34 * be able to match against the protocol specfication.
37 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
38 * (ie no useful data other than the SMB error code itself) and are marked such.
39 * Knowing this helps avoid response buffer allocations and copy in some cases.
42 /* List of commands in host endian */
43 #define SMB2_NEGOTIATE_HE 0x0000
44 #define SMB2_SESSION_SETUP_HE 0x0001
45 #define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
46 #define SMB2_TREE_CONNECT_HE 0x0003
47 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
48 #define SMB2_CREATE_HE 0x0005
49 #define SMB2_CLOSE_HE 0x0006
50 #define SMB2_FLUSH_HE 0x0007 /* trivial resp */
51 #define SMB2_READ_HE 0x0008
52 #define SMB2_WRITE_HE 0x0009
53 #define SMB2_LOCK_HE 0x000A
54 #define SMB2_IOCTL_HE 0x000B
55 #define SMB2_CANCEL_HE 0x000C
56 #define SMB2_ECHO_HE 0x000D
57 #define SMB2_QUERY_DIRECTORY_HE 0x000E
58 #define SMB2_CHANGE_NOTIFY_HE 0x000F
59 #define SMB2_QUERY_INFO_HE 0x0010
60 #define SMB2_SET_INFO_HE 0x0011
61 #define SMB2_OPLOCK_BREAK_HE 0x0012
63 /* The same list in little endian */
64 #define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
65 #define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
66 #define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
67 #define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
68 #define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
69 #define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
70 #define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
71 #define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
72 #define SMB2_READ cpu_to_le16(SMB2_READ_HE)
73 #define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
74 #define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
75 #define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
76 #define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
77 #define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
78 #define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
79 #define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
80 #define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
81 #define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
82 #define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
84 #define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
86 #define NUMBER_OF_SMB2_COMMANDS 0x0013
88 /* 52 transform hdr + 64 hdr + 88 create rsp */
89 #define SMB2_TRANSFORM_HEADER_SIZE 52
90 #define MAX_SMB2_HDR_SIZE 204
92 #define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
93 #define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
96 * SMB2 Header Definition
98 * "MBZ" : Must be Zero
99 * "BB" : BugBug, Something to check/review/analyze later
100 * "PDU" : "Protocol Data Unit" (ie a network "frame")
104 #define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
106 struct smb2_sync_hdr
{
107 __le32 ProtocolId
; /* 0xFE 'S' 'M' 'B' */
108 __le16 StructureSize
; /* 64 */
109 __le16 CreditCharge
; /* MBZ */
110 __le32 Status
; /* Error from server */
112 __le16 CreditRequest
; /* CreditResponse */
117 __u32 TreeId
; /* opaque - so do not make little endian */
118 __u64 SessionId
; /* opaque - so do not make little endian */
122 struct smb2_sync_pdu
{
123 struct smb2_sync_hdr sync_hdr
;
124 __le16 StructureSize2
; /* size of wct area (varies, request specific) */
127 #define SMB3_AES128CCM_NONCE 11
128 #define SMB3_AES128GCM_NONCE 12
130 struct smb2_transform_hdr
{
131 __le32 ProtocolId
; /* 0xFD 'S' 'M' 'B' */
134 __le32 OriginalMessageSize
;
136 __le16 Flags
; /* EncryptionAlgorithm */
141 * SMB2 flag definitions
143 #define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
144 #define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
145 #define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
146 #define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
147 #define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
148 #define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
149 #define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
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 COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
162 #define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
164 struct smb2_err_rsp
{
165 struct smb2_sync_hdr sync_hdr
;
166 __le16 StructureSize
;
167 __le16 Reserved
; /* MBZ */
168 __le32 ByteCount
; /* even if zero, at least one byte follows */
169 __u8 ErrorData
[1]; /* variable length */
172 #define SYMLINK_ERROR_TAG 0x4c4d5953
174 struct smb2_symlink_err_rsp
{
175 __le32 SymLinkLength
;
176 __le32 SymLinkErrorTag
;
178 __le16 ReparseDataLength
;
179 __le16 UnparsedPathLength
;
180 __le16 SubstituteNameOffset
;
181 __le16 SubstituteNameLength
;
182 __le16 PrintNameOffset
;
183 __le16 PrintNameLength
;
188 /* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
189 struct smb2_error_context_rsp
{
190 __le32 ErrorDataLength
;
192 __u8 ErrorContextData
; /* ErrorDataLength long array */
195 /* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
196 #define MOVE_DST_IPADDR_V4 cpu_to_le32(0x00000001)
197 #define MOVE_DST_IPADDR_V6 cpu_to_le32(0x00000002)
199 struct move_dst_ipaddr
{
202 __u8 address
[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
205 struct share_redirect_error_context_rsp
{
206 __le32 StructureSize
;
207 __le32 NotificationType
;
208 __le32 ResourceNameOffset
;
209 __le32 ResourceNameLength
;
213 struct move_dst_ipaddr IpAddrMoveList
[0];
214 /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
217 #define SMB2_CLIENT_GUID_SIZE 16
219 struct smb2_negotiate_req
{
220 struct smb2_sync_hdr sync_hdr
;
221 __le16 StructureSize
; /* Must be 36 */
224 __le16 Reserved
; /* MBZ */
226 __u8 ClientGUID
[SMB2_CLIENT_GUID_SIZE
];
227 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
228 __le32 NegotiateContextOffset
; /* SMB3.1.1 only. MBZ earlier */
229 __le16 NegotiateContextCount
; /* SMB3.1.1 only. MBZ earlier */
231 __le16 Dialects
[1]; /* One dialect (vers=) at a time for now */
235 #define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
236 #define SMB20_PROT_ID 0x0202
237 #define SMB21_PROT_ID 0x0210
238 #define SMB30_PROT_ID 0x0300
239 #define SMB302_PROT_ID 0x0302
240 #define SMB311_PROT_ID 0x0311
241 #define BAD_PROT_ID 0xFFFF
243 /* SecurityMode flags */
244 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
245 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
246 #define SMB2_SEC_MODE_FLAGS_ALL 0x0003
248 /* Capabilities flags */
249 #define SMB2_GLOBAL_CAP_DFS 0x00000001
250 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
251 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
252 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
253 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
254 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
255 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
257 #define SMB2_NT_FIND 0x00100000
258 #define SMB2_LARGE_FILES 0x00200000
261 /* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
262 #define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
263 #define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
264 #define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
265 #define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
266 #define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
268 struct smb2_neg_context
{
272 /* Followed by array of data */
275 #define SMB311_SALT_SIZE 32
276 /* Hash Algorithm Types */
277 #define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
278 #define SMB2_PREAUTH_HASH_SIZE 64
280 #define MIN_PREAUTH_CTXT_DATA_LEN (SMB311_SALT_SIZE + 6)
281 struct smb2_preauth_neg_context
{
282 __le16 ContextType
; /* 1 */
285 __le16 HashAlgorithmCount
; /* 1 */
287 __le16 HashAlgorithms
; /* HashAlgorithms[0] since only one defined */
288 __u8 Salt
[SMB311_SALT_SIZE
];
291 /* Encryption Algorithms Ciphers */
292 #define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
293 #define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
295 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
296 #define MIN_ENCRYPT_CTXT_DATA_LEN 4
297 struct smb2_encryption_neg_context
{
298 __le16 ContextType
; /* 2 */
301 __le16 CipherCount
; /* AES-128-GCM and AES-128-CCM */
305 /* See MS-SMB2 2.2.3.1.3 */
306 #define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
307 #define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
308 #define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
309 #define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
311 struct smb2_compression_capabilities_context
{
312 __le16 ContextType
; /* 3 */
315 __le16 CompressionAlgorithmCount
;
318 __le16 CompressionAlgorithms
[3];
322 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
323 * Its struct simply contains NetName, an array of Unicode characters
325 struct smb2_netname_neg_context
{
326 __le16 ContextType
; /* 0x100 */
329 __le16 NetName
[0]; /* hostname of target converted to UCS-2 */
332 #define POSIX_CTXT_DATA_LEN 16
333 struct smb2_posix_neg_context
{
334 __le16 ContextType
; /* 0x100 */
337 __u8 Name
[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
340 struct smb2_negotiate_rsp
{
341 struct smb2_sync_hdr sync_hdr
;
342 __le16 StructureSize
; /* Must be 65 */
344 __le16 DialectRevision
;
345 __le16 NegotiateContextCount
; /* Prior to SMB3.1.1 was Reserved & MBZ */
348 __le32 MaxTransactSize
;
351 __le64 SystemTime
; /* MBZ */
352 __le64 ServerStartTime
;
353 __le16 SecurityBufferOffset
;
354 __le16 SecurityBufferLength
;
355 __le32 NegotiateContextOffset
; /* Pre:SMB3.1.1 was reserved/ignored */
356 __u8 Buffer
[1]; /* variable length GSS security buffer */
360 #define SMB2_SESSION_REQ_FLAG_BINDING 0x01
361 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
363 struct smb2_sess_setup_req
{
364 struct smb2_sync_hdr sync_hdr
;
365 __le16 StructureSize
; /* Must be 25 */
370 __le16 SecurityBufferOffset
;
371 __le16 SecurityBufferLength
;
372 __u64 PreviousSessionId
;
373 __u8 Buffer
[1]; /* variable length GSS security buffer */
376 /* Currently defined SessionFlags */
377 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
378 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
379 #define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
380 struct smb2_sess_setup_rsp
{
381 struct smb2_sync_hdr sync_hdr
;
382 __le16 StructureSize
; /* Must be 9 */
384 __le16 SecurityBufferOffset
;
385 __le16 SecurityBufferLength
;
386 __u8 Buffer
[1]; /* variable length GSS security buffer */
389 struct smb2_logoff_req
{
390 struct smb2_sync_hdr sync_hdr
;
391 __le16 StructureSize
; /* Must be 4 */
395 struct smb2_logoff_rsp
{
396 struct smb2_sync_hdr sync_hdr
;
397 __le16 StructureSize
; /* Must be 4 */
401 /* Flags/Reserved for SMB3.1.1 */
402 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
403 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
404 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
406 struct smb2_tree_connect_req
{
407 struct smb2_sync_hdr sync_hdr
;
408 __le16 StructureSize
; /* Must be 9 */
409 __le16 Reserved
; /* Flags in SMB3.1.1 */
412 __u8 Buffer
[1]; /* variable length */
415 /* See MS-SMB2 section 2.2.9.2 */
417 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
418 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
420 struct tree_connect_contexts
{
427 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
428 struct smb3_blob_data
{
433 /* Valid values for Attr */
434 #define SE_GROUP_MANDATORY 0x00000001
435 #define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
436 #define SE_GROUP_ENABLED 0x00000004
437 #define SE_GROUP_OWNER 0x00000008
438 #define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
439 #define SE_GROUP_INTEGRITY 0x00000020
440 #define SE_GROUP_INTEGRITY_ENABLED 0x00000040
441 #define SE_GROUP_RESOURCE 0x20000000
442 #define SE_GROUP_LOGON_ID 0xC0000000
444 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
446 struct sid_array_data
{
448 /* SidAttrList - array of sid_attr_data structs */
451 struct luid_attr_data
{
456 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
457 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
460 struct privilege_array_data
{
461 __le16 PrivilegeCount
;
462 /* array of privilege_data structs */
465 struct remoted_identity_tcon_context
{
466 __le16 TicketType
; /* must be 0x0001 */
467 __le16 TicketSize
; /* total size of this struct */
468 __le16 User
; /* offset to SID_ATTR_DATA struct with user info */
469 __le16 UserName
; /* offset to null terminated Unicode username string */
470 __le16 Domain
; /* offset to null terminated Unicode domain name */
471 __le16 Groups
; /* offset to SID_ARRAY_DATA struct with group info */
472 __le16 RestrictedGroups
; /* similar to above */
473 __le16 Privileges
; /* offset to PRIVILEGE_ARRAY_DATA struct */
474 __le16 PrimaryGroup
; /* offset to SID_ARRAY_DATA struct */
475 __le16 Owner
; /* offset to BLOB_DATA struct */
476 __le16 DefaultDacl
; /* offset to BLOB_DATA struct */
477 __le16 DeviceGroups
; /* offset to SID_ARRAY_DATA struct */
478 __le16 UserClaims
; /* offset to BLOB_DATA struct */
479 __le16 DeviceClaims
; /* offset to BLOB_DATA struct */
480 __u8 TicketInfo
[0]; /* variable length buf - remoted identity data */
483 struct smb2_tree_connect_req_extension
{
484 __le32 TreeConnectContextOffset
;
485 __le16 TreeConnectContextCount
;
487 __u8 PathName
[0]; /* variable sized array */
488 /* followed by array of TreeConnectContexts */
491 struct smb2_tree_connect_rsp
{
492 struct smb2_sync_hdr sync_hdr
;
493 __le16 StructureSize
; /* Must be 16 */
494 __u8 ShareType
; /* see below */
496 __le32 ShareFlags
; /* see below */
497 __le32 Capabilities
; /* see below */
498 __le32 MaximalAccess
;
501 /* Possible ShareType values */
502 #define SMB2_SHARE_TYPE_DISK 0x01
503 #define SMB2_SHARE_TYPE_PIPE 0x02
504 #define SMB2_SHARE_TYPE_PRINT 0x03
507 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
508 * must be set (any of the remaining, SHI1005, flags may be set individually
511 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
512 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
513 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
514 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
515 #define SHI1005_FLAGS_DFS 0x00000001
516 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
517 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
518 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
519 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
520 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
521 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
522 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
523 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
524 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
525 #define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
526 #define SHI1005_FLAGS_ALL 0x0004FF33
528 /* Possible share capabilities */
529 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
530 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
531 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
532 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
533 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
534 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
536 struct smb2_tree_disconnect_req
{
537 struct smb2_sync_hdr sync_hdr
;
538 __le16 StructureSize
; /* Must be 4 */
542 struct smb2_tree_disconnect_rsp
{
543 struct smb2_sync_hdr sync_hdr
;
544 __le16 StructureSize
; /* Must be 4 */
548 /* File Attrubutes */
549 #define FILE_ATTRIBUTE_READONLY 0x00000001
550 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
551 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
552 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
553 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
554 #define FILE_ATTRIBUTE_NORMAL 0x00000080
555 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
556 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
557 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
558 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
559 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
560 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
561 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
562 #define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
563 #define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
566 #define SMB2_OPLOCK_LEVEL_NONE 0x00
567 #define SMB2_OPLOCK_LEVEL_II 0x01
568 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
569 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
570 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
571 /* Non-spec internal type */
572 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
574 /* Desired Access Flags */
575 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
576 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
577 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
578 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
579 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
580 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
581 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
582 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
583 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
584 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
585 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
586 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
587 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
588 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
589 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
590 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
591 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
592 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
593 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
595 /* ShareAccess Flags */
596 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
597 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
598 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
599 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
601 /* CreateDisposition Flags */
602 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
603 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
604 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
605 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
606 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
607 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
609 /* CreateOptions Flags */
610 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
611 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
612 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
613 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
614 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
615 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
616 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
617 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
618 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
619 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
620 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
621 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
622 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
623 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
624 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
625 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
626 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
627 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
628 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
630 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
631 | FILE_READ_ATTRIBUTES_LE)
632 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
633 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
634 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
636 /* Impersonation Levels */
637 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
638 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
639 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
640 #define IL_DELEGATE cpu_to_le32(0x00000003)
642 /* Create Context Values */
643 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
644 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
645 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
646 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
647 #define SMB2_CREATE_ALLOCATION_SIZE "AISi"
648 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
649 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
650 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
651 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
652 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
653 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
654 #define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
655 #define SMB2_CREATE_APP_INSTANCE_VERSION 0xB982D0B73B56074FA07B524A8116A010
656 #define SVHDX_OPEN_DEVICE_CONTEX 0x9CCBCF9E04C1E643980E158DA1F6EC83
657 #define SMB2_CREATE_TAG_POSIX 0x93AD25509CB411E7B42383DE968BCD7C
659 /* Flag (SMB3 open response) values */
660 #define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
663 * Maximum number of iovs we need for an open/create request.
664 * [0] : struct smb2_create_req
666 * [2] : lease context
667 * [3] : durable context
668 * [4] : posix context
669 * [5] : time warp context
670 * [6] : query id context
671 * [7] : compound padding
673 #define SMB2_CREATE_IOV_SIZE 8
675 struct smb2_create_req
{
676 struct smb2_sync_hdr sync_hdr
;
677 __le16 StructureSize
; /* Must be 57 */
679 __u8 RequestedOplockLevel
;
680 __le32 ImpersonationLevel
;
681 __le64 SmbCreateFlags
;
683 __le32 DesiredAccess
;
684 __le32 FileAttributes
;
686 __le32 CreateDisposition
;
687 __le32 CreateOptions
;
690 __le32 CreateContextsOffset
;
691 __le32 CreateContextsLength
;
696 * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
697 * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
698 * 2 bytes of padding.
700 #define MAX_SMB2_CREATE_RESPONSE_SIZE 880
702 struct smb2_create_rsp
{
703 struct smb2_sync_hdr sync_hdr
;
704 __le16 StructureSize
; /* Must be 89 */
706 __u8 Flag
; /* 0x01 if reparse point */
709 __le64 LastAccessTime
;
710 __le64 LastWriteTime
;
712 __le64 AllocationSize
;
714 __le32 FileAttributes
;
716 __u64 PersistentFileId
; /* opaque endianness */
717 __u64 VolatileFileId
; /* opaque endianness */
718 __le32 CreateContextsOffset
;
719 __le32 CreateContextsLength
;
723 struct create_context
{
733 #define SMB2_LEASE_READ_CACHING_HE 0x01
734 #define SMB2_LEASE_HANDLE_CACHING_HE 0x02
735 #define SMB2_LEASE_WRITE_CACHING_HE 0x04
737 #define SMB2_LEASE_NONE cpu_to_le32(0x00)
738 #define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
739 #define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
740 #define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
742 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x02)
743 #define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
745 #define SMB2_LEASE_KEY_SIZE 16
747 struct lease_context
{
748 u8 LeaseKey
[SMB2_LEASE_KEY_SIZE
];
751 __le64 LeaseDuration
;
754 struct lease_context_v2
{
755 u8 LeaseKey
[SMB2_LEASE_KEY_SIZE
];
758 __le64 LeaseDuration
;
759 __le64 ParentLeaseKeyLow
;
760 __le64 ParentLeaseKeyHigh
;
765 struct create_lease
{
766 struct create_context ccontext
;
768 struct lease_context lcontext
;
771 struct create_lease_v2
{
772 struct create_context ccontext
;
774 struct lease_context_v2 lcontext
;
778 struct create_durable
{
779 struct create_context ccontext
;
784 __u64 PersistentFileId
;
785 __u64 VolatileFileId
;
790 struct create_posix
{
791 struct create_context ccontext
;
797 /* See MS-SMB2 2.2.13.2.11 */
799 #define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
800 struct durable_context_v2
{
807 struct create_durable_v2
{
808 struct create_context ccontext
;
810 struct durable_context_v2 dcontext
;
813 /* See MS-SMB2 2.2.13.2.12 */
814 struct durable_reconnect_context_v2
{
816 __u64 PersistentFileId
;
817 __u64 VolatileFileId
;
820 __le32 Flags
; /* see above DHANDLE_FLAG_PERSISTENT */
823 /* See MS-SMB2 2.2.14.2.9 */
824 struct create_on_disk_id
{
825 struct create_context ccontext
;
832 /* See MS-SMB2 2.2.14.2.12 */
833 struct durable_reconnect_context_v2_rsp
{
835 __le32 Flags
; /* see above DHANDLE_FLAG_PERSISTENT */
838 struct create_durable_handle_reconnect_v2
{
839 struct create_context ccontext
;
841 struct durable_reconnect_context_v2 dcontext
;
845 /* See MS-SMB2 2.2.13.2.5 */
846 struct crt_twarp_ctxt
{
847 struct create_context ccontext
;
853 /* See MS-SMB2 2.2.13.2.9 */
854 struct crt_query_id_ctxt
{
855 struct create_context ccontext
;
860 struct create_context ccontext
;
864 /* Followed by at least 4 ACEs */
868 #define COPY_CHUNK_RES_KEY_SIZE 24
869 struct resume_key_req
{
870 char ResumeKey
[COPY_CHUNK_RES_KEY_SIZE
];
871 __le32 ContextLength
; /* MBZ */
872 char Context
[0]; /* ignored, Windows sets to 4 bytes of zero */
875 /* this goes in the ioctl buffer when doing a copychunk request */
876 struct copychunk_ioctl
{
877 char SourceKey
[COPY_CHUNK_RES_KEY_SIZE
];
878 __le32 ChunkCount
; /* we are only sending 1 */
880 /* array will only be one chunk long for us */
883 __le32 Length
; /* how many bytes to copy */
887 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
888 struct file_zero_data_information
{
890 __le64 BeyondFinalZero
;
893 struct copychunk_ioctl_rsp
{
894 __le32 ChunksWritten
;
895 __le32 ChunkBytesWritten
;
896 __le32 TotalBytesWritten
;
899 struct fsctl_set_integrity_information_req
{
900 __le16 ChecksumAlgorithm
;
905 struct fsctl_get_integrity_information_rsp
{
906 __le16 ChecksumAlgorithm
;
909 __le32 ChecksumChunkSizeInBytes
;
910 __le32 ClusterSizeInBytes
;
913 struct file_allocated_range_buffer
{
918 /* Integrity ChecksumAlgorithm choices for above */
919 #define CHECKSUM_TYPE_NONE 0x0000
920 #define CHECKSUM_TYPE_CRC64 0x0002
921 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
923 /* Integrity flags for above */
924 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
926 /* Reparse structures - see MS-FSCC 2.1.2 */
928 /* struct fsctl_reparse_info_req is empty, only response structs (see below) */
930 struct reparse_data_buffer
{
932 __le16 ReparseDataLength
;
934 __u8 DataBuffer
[0]; /* Variable Length */
937 struct reparse_guid_data_buffer
{
939 __le16 ReparseDataLength
;
941 __u8 ReparseGuid
[16];
942 __u8 DataBuffer
[0]; /* Variable Length */
945 struct reparse_mount_point_data_buffer
{
947 __le16 ReparseDataLength
;
949 __le16 SubstituteNameOffset
;
950 __le16 SubstituteNameLength
;
951 __le16 PrintNameOffset
;
952 __le16 PrintNameLength
;
953 __u8 PathBuffer
[0]; /* Variable Length */
956 #define SYMLINK_FLAG_RELATIVE 0x00000001
958 struct reparse_symlink_data_buffer
{
960 __le16 ReparseDataLength
;
962 __le16 SubstituteNameOffset
;
963 __le16 SubstituteNameLength
;
964 __le16 PrintNameOffset
;
965 __le16 PrintNameLength
;
967 __u8 PathBuffer
[0]; /* Variable Length */
970 /* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
973 /* See MS-DFSC 2.2.2 */
974 struct fsctl_get_dfs_referral_req
{
975 __le16 MaxReferralLevel
;
976 __u8 RequestFileName
[];
979 /* DFS response is struct get_dfs_refer_rsp */
981 /* See MS-SMB2 2.2.31.3 */
982 struct network_resiliency_req
{
986 /* There is no buffer for the response ie no struct network_resiliency_rsp */
989 struct validate_negotiate_info_req
{
991 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
994 __le16 Dialects
[4]; /* BB expand this if autonegotiate > 4 dialects */
997 struct validate_negotiate_info_rsp
{
999 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
1000 __le16 SecurityMode
;
1001 __le16 Dialect
; /* Dialect in use for the connection */
1004 #define RSS_CAPABLE cpu_to_le32(0x00000001)
1005 #define RDMA_CAPABLE cpu_to_le32(0x00000002)
1007 #define INTERNETWORK cpu_to_le16(0x0002)
1008 #define INTERNETWORKV6 cpu_to_le16(0x0017)
1010 struct network_interface_info_ioctl_rsp
{
1011 __le32 Next
; /* next interface. zero if this is last one */
1013 __le32 Capability
; /* RSS or RDMA Capable */
1020 struct iface_info_ipv4
{
1026 struct iface_info_ipv6
{
1029 __u8 IPv6Address
[16];
1033 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
1035 struct compress_ioctl
{
1036 __le16 CompressionState
; /* See cifspdu.h for possible flag values */
1039 struct duplicate_extents_to_file
{
1040 __u64 PersistentFileHandle
; /* source file handle, opaque endianness */
1041 __u64 VolatileFileHandle
;
1042 __le64 SourceFileOffset
;
1043 __le64 TargetFileOffset
;
1044 __le64 ByteCount
; /* Bytes to be copied */
1048 * Maximum number of iovs we need for an ioctl request.
1049 * [0] : struct smb2_ioctl_req
1052 #define SMB2_IOCTL_IOV_SIZE 2
1054 struct smb2_ioctl_req
{
1055 struct smb2_sync_hdr sync_hdr
;
1056 __le16 StructureSize
; /* Must be 57 */
1059 __u64 PersistentFileId
; /* opaque endianness */
1060 __u64 VolatileFileId
; /* opaque endianness */
1063 __le32 MaxInputResponse
;
1064 __le32 OutputOffset
;
1066 __le32 MaxOutputResponse
;
1072 struct smb2_ioctl_rsp
{
1073 struct smb2_sync_hdr sync_hdr
;
1074 __le16 StructureSize
; /* Must be 57 */
1077 __u64 PersistentFileId
; /* opaque endianness */
1078 __u64 VolatileFileId
; /* opaque endianness */
1081 __le32 OutputOffset
;
1085 /* char * buffer[] */
1088 /* Currently defined values for close flags */
1089 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
1090 struct smb2_close_req
{
1091 struct smb2_sync_hdr sync_hdr
;
1092 __le16 StructureSize
; /* Must be 24 */
1095 __u64 PersistentFileId
; /* opaque endianness */
1096 __u64 VolatileFileId
; /* opaque endianness */
1100 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
1102 #define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
1104 struct smb2_close_rsp
{
1105 struct smb2_sync_hdr sync_hdr
;
1106 __le16 StructureSize
; /* 60 */
1109 __le64 CreationTime
;
1110 __le64 LastAccessTime
;
1111 __le64 LastWriteTime
;
1113 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
1118 struct smb2_flush_req
{
1119 struct smb2_sync_hdr sync_hdr
;
1120 __le16 StructureSize
; /* Must be 24 */
1123 __u64 PersistentFileId
; /* opaque endianness */
1124 __u64 VolatileFileId
; /* opaque endianness */
1127 struct smb2_flush_rsp
{
1128 struct smb2_sync_hdr sync_hdr
;
1129 __le16 StructureSize
;
1133 /* For read request Flags field below, following flag is defined for SMB3.02 */
1134 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
1135 #define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
1137 /* Channel field for read and write: exactly one of following flags can be set*/
1138 #define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
1139 #define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001) /* SMB3 or later */
1140 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1142 /* SMB2 read request without RFC1001 length at the beginning */
1143 struct smb2_read_plain_req
{
1144 struct smb2_sync_hdr sync_hdr
;
1145 __le16 StructureSize
; /* Must be 49 */
1146 __u8 Padding
; /* offset from start of SMB2 header to place read */
1147 __u8 Flags
; /* MBZ unless SMB3.02 or later */
1150 __u64 PersistentFileId
; /* opaque endianness */
1151 __u64 VolatileFileId
; /* opaque endianness */
1152 __le32 MinimumCount
;
1153 __le32 Channel
; /* MBZ except for SMB3 or later */
1154 __le32 RemainingBytes
;
1155 __le16 ReadChannelInfoOffset
;
1156 __le16 ReadChannelInfoLength
;
1160 struct smb2_read_rsp
{
1161 struct smb2_sync_hdr sync_hdr
;
1162 __le16 StructureSize
; /* Must be 17 */
1166 __le32 DataRemaining
;
1171 /* For write request Flags field below the following flags are defined: */
1172 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
1173 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
1175 struct smb2_write_req
{
1176 struct smb2_sync_hdr sync_hdr
;
1177 __le16 StructureSize
; /* Must be 49 */
1178 __le16 DataOffset
; /* offset from start of SMB2 header to write data */
1181 __u64 PersistentFileId
; /* opaque endianness */
1182 __u64 VolatileFileId
; /* opaque endianness */
1183 __le32 Channel
; /* Reserved MBZ */
1184 __le32 RemainingBytes
;
1185 __le16 WriteChannelInfoOffset
;
1186 __le16 WriteChannelInfoLength
;
1191 struct smb2_write_rsp
{
1192 struct smb2_sync_hdr sync_hdr
;
1193 __le16 StructureSize
; /* Must be 17 */
1197 __le32 DataRemaining
;
1203 #define SMB2_WATCH_TREE 0x0001
1205 /* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
1206 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
1207 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
1208 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
1209 #define FILE_NOTIFY_CHANGE_SIZE 0x00000008
1210 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
1211 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
1212 #define FILE_NOTIFY_CHANGE_CREATION 0x00000040
1213 #define FILE_NOTIFY_CHANGE_EA 0x00000080
1214 #define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
1215 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1216 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1217 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1219 struct smb2_change_notify_req
{
1220 struct smb2_sync_hdr sync_hdr
;
1221 __le16 StructureSize
;
1223 __le32 OutputBufferLength
;
1224 __u64 PersistentFileId
; /* opaque endianness */
1225 __u64 VolatileFileId
; /* opaque endianness */
1226 __le32 CompletionFilter
;
1230 struct smb2_change_notify_rsp
{
1231 struct smb2_sync_hdr sync_hdr
;
1232 __le16 StructureSize
; /* Must be 9 */
1233 __le16 OutputBufferOffset
;
1234 __le32 OutputBufferLength
;
1235 __u8 Buffer
[1]; /* array of file notify structs */
1238 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
1239 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
1240 #define SMB2_LOCKFLAG_UNLOCK 0x0004
1241 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
1243 struct smb2_lock_element
{
1250 struct smb2_lock_req
{
1251 struct smb2_sync_hdr sync_hdr
;
1252 __le16 StructureSize
; /* Must be 48 */
1255 __u64 PersistentFileId
; /* opaque endianness */
1256 __u64 VolatileFileId
; /* opaque endianness */
1257 /* Followed by at least one */
1258 struct smb2_lock_element locks
[1];
1261 struct smb2_lock_rsp
{
1262 struct smb2_sync_hdr sync_hdr
;
1263 __le16 StructureSize
; /* Must be 4 */
1267 struct smb2_echo_req
{
1268 struct smb2_sync_hdr sync_hdr
;
1269 __le16 StructureSize
; /* Must be 4 */
1273 struct smb2_echo_rsp
{
1274 struct smb2_sync_hdr sync_hdr
;
1275 __le16 StructureSize
; /* Must be 4 */
1279 /* search (query_directory) Flags field */
1280 #define SMB2_RESTART_SCANS 0x01
1281 #define SMB2_RETURN_SINGLE_ENTRY 0x02
1282 #define SMB2_INDEX_SPECIFIED 0x04
1283 #define SMB2_REOPEN 0x10
1285 #define SMB2_QUERY_DIRECTORY_IOV_SIZE 2
1287 struct smb2_query_directory_req
{
1288 struct smb2_sync_hdr sync_hdr
;
1289 __le16 StructureSize
; /* Must be 33 */
1290 __u8 FileInformationClass
;
1293 __u64 PersistentFileId
; /* opaque endianness */
1294 __u64 VolatileFileId
; /* opaque endianness */
1295 __le16 FileNameOffset
;
1296 __le16 FileNameLength
;
1297 __le32 OutputBufferLength
;
1301 struct smb2_query_directory_rsp
{
1302 struct smb2_sync_hdr sync_hdr
;
1303 __le16 StructureSize
; /* Must be 9 */
1304 __le16 OutputBufferOffset
;
1305 __le32 OutputBufferLength
;
1309 /* Possible InfoType values */
1310 #define SMB2_O_INFO_FILE 0x01
1311 #define SMB2_O_INFO_FILESYSTEM 0x02
1312 #define SMB2_O_INFO_SECURITY 0x03
1313 #define SMB2_O_INFO_QUOTA 0x04
1315 /* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1316 #define OWNER_SECINFO 0x00000001
1317 #define GROUP_SECINFO 0x00000002
1318 #define DACL_SECINFO 0x00000004
1319 #define SACL_SECINFO 0x00000008
1320 #define LABEL_SECINFO 0x00000010
1321 #define ATTRIBUTE_SECINFO 0x00000020
1322 #define SCOPE_SECINFO 0x00000040
1323 #define BACKUP_SECINFO 0x00010000
1324 #define UNPROTECTED_SACL_SECINFO 0x10000000
1325 #define UNPROTECTED_DACL_SECINFO 0x20000000
1326 #define PROTECTED_SACL_SECINFO 0x40000000
1327 #define PROTECTED_DACL_SECINFO 0x80000000
1329 /* Flags used for FileFullEAinfo */
1330 #define SL_RESTART_SCAN 0x00000001
1331 #define SL_RETURN_SINGLE_ENTRY 0x00000002
1332 #define SL_INDEX_SPECIFIED 0x00000004
1334 struct smb2_query_info_req
{
1335 struct smb2_sync_hdr sync_hdr
;
1336 __le16 StructureSize
; /* Must be 41 */
1339 __le32 OutputBufferLength
;
1340 __le16 InputBufferOffset
;
1342 __le32 InputBufferLength
;
1343 __le32 AdditionalInformation
;
1345 __u64 PersistentFileId
; /* opaque endianness */
1346 __u64 VolatileFileId
; /* opaque endianness */
1350 struct smb2_query_info_rsp
{
1351 struct smb2_sync_hdr sync_hdr
;
1352 __le16 StructureSize
; /* Must be 9 */
1353 __le16 OutputBufferOffset
;
1354 __le32 OutputBufferLength
;
1359 * Maximum number of iovs we need for a set-info request.
1360 * The largest one is rename/hardlink
1361 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
1363 * [2] : compound padding
1365 #define SMB2_SET_INFO_IOV_SIZE 3
1367 struct smb2_set_info_req
{
1368 struct smb2_sync_hdr sync_hdr
;
1369 __le16 StructureSize
; /* Must be 33 */
1372 __le32 BufferLength
;
1373 __le16 BufferOffset
;
1375 __le32 AdditionalInformation
;
1376 __u64 PersistentFileId
; /* opaque endianness */
1377 __u64 VolatileFileId
; /* opaque endianness */
1381 struct smb2_set_info_rsp
{
1382 struct smb2_sync_hdr sync_hdr
;
1383 __le16 StructureSize
; /* Must be 2 */
1386 struct smb2_oplock_break
{
1387 struct smb2_sync_hdr sync_hdr
;
1388 __le16 StructureSize
; /* Must be 24 */
1392 __u64 PersistentFid
;
1396 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1398 struct smb2_lease_break
{
1399 struct smb2_sync_hdr sync_hdr
;
1400 __le16 StructureSize
; /* Must be 44 */
1404 __le32 CurrentLeaseState
;
1405 __le32 NewLeaseState
;
1407 __le32 AccessMaskHint
;
1408 __le32 ShareMaskHint
;
1411 struct smb2_lease_ack
{
1412 struct smb2_sync_hdr sync_hdr
;
1413 __le16 StructureSize
; /* Must be 36 */
1418 __le64 LeaseDuration
;
1422 * PDU infolevel structure definitions
1423 * BB consider moving to a different header
1426 /* File System Information Classes */
1427 #define FS_VOLUME_INFORMATION 1 /* Query */
1428 #define FS_LABEL_INFORMATION 2 /* Local only */
1429 #define FS_SIZE_INFORMATION 3 /* Query */
1430 #define FS_DEVICE_INFORMATION 4 /* Query */
1431 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1432 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
1433 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
1434 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1435 #define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1436 #define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1437 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1438 #define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1440 struct smb2_fs_full_size_info
{
1441 __le64 TotalAllocationUnits
;
1442 __le64 CallerAvailableAllocationUnits
;
1443 __le64 ActualAvailableAllocationUnits
;
1444 __le32 SectorsPerAllocationUnit
;
1445 __le32 BytesPerSector
;
1448 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1449 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1450 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1451 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1453 /* sector size info struct */
1454 struct smb3_fs_ss_info
{
1455 __le32 LogicalBytesPerSector
;
1456 __le32 PhysicalBytesPerSectorForAtomicity
;
1457 __le32 PhysicalBytesPerSectorForPerf
;
1458 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity
;
1460 __le32 ByteOffsetForSectorAlignment
;
1461 __le32 ByteOffsetForPartitionAlignment
;
1464 /* volume info struct - see MS-FSCC 2.5.9 */
1465 #define MAX_VOL_LABEL_LEN 32
1466 struct smb3_fs_vol_info
{
1467 __le64 VolumeCreationTime
;
1468 __u32 VolumeSerialNumber
;
1469 __le32 VolumeLabelLength
; /* includes trailing null */
1470 __u8 SupportsObjects
; /* True if eg like NTFS, supports objects */
1472 __u8 VolumeLabel
[0]; /* variable len */
1475 /* partial list of QUERY INFO levels */
1476 #define FILE_DIRECTORY_INFORMATION 1
1477 #define FILE_FULL_DIRECTORY_INFORMATION 2
1478 #define FILE_BOTH_DIRECTORY_INFORMATION 3
1479 #define FILE_BASIC_INFORMATION 4
1480 #define FILE_STANDARD_INFORMATION 5
1481 #define FILE_INTERNAL_INFORMATION 6
1482 #define FILE_EA_INFORMATION 7
1483 #define FILE_ACCESS_INFORMATION 8
1484 #define FILE_NAME_INFORMATION 9
1485 #define FILE_RENAME_INFORMATION 10
1486 #define FILE_LINK_INFORMATION 11
1487 #define FILE_NAMES_INFORMATION 12
1488 #define FILE_DISPOSITION_INFORMATION 13
1489 #define FILE_POSITION_INFORMATION 14
1490 #define FILE_FULL_EA_INFORMATION 15
1491 #define FILE_MODE_INFORMATION 16
1492 #define FILE_ALIGNMENT_INFORMATION 17
1493 #define FILE_ALL_INFORMATION 18
1494 #define FILE_ALLOCATION_INFORMATION 19
1495 #define FILE_END_OF_FILE_INFORMATION 20
1496 #define FILE_ALTERNATE_NAME_INFORMATION 21
1497 #define FILE_STREAM_INFORMATION 22
1498 #define FILE_PIPE_INFORMATION 23
1499 #define FILE_PIPE_LOCAL_INFORMATION 24
1500 #define FILE_PIPE_REMOTE_INFORMATION 25
1501 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1502 #define FILE_MAILSLOT_SET_INFORMATION 27
1503 #define FILE_COMPRESSION_INFORMATION 28
1504 #define FILE_OBJECT_ID_INFORMATION 29
1505 /* Number 30 not defined in documents */
1506 #define FILE_MOVE_CLUSTER_INFORMATION 31
1507 #define FILE_QUOTA_INFORMATION 32
1508 #define FILE_REPARSE_POINT_INFORMATION 33
1509 #define FILE_NETWORK_OPEN_INFORMATION 34
1510 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
1511 #define FILE_TRACKING_INFORMATION 36
1512 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
1513 #define FILEID_FULL_DIRECTORY_INFORMATION 38
1514 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1515 #define FILE_SHORT_NAME_INFORMATION 40
1516 #define FILE_SFIO_RESERVE_INFORMATION 44
1517 #define FILE_SFIO_VOLUME_INFORMATION 45
1518 #define FILE_HARD_LINK_INFORMATION 46
1519 #define FILE_NORMALIZED_NAME_INFORMATION 48
1520 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1521 #define FILE_STANDARD_LINK_INFORMATION 54
1522 #define FILE_ID_INFORMATION 59
1524 struct smb2_file_internal_info
{
1526 } __packed
; /* level 6 Query */
1528 struct smb2_file_rename_info
{ /* encoding of request for level 10 */
1529 __u8 ReplaceIfExists
; /* 1 = replace existing target with new */
1530 /* 0 = fail if target already exists */
1532 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1533 __le32 FileNameLength
;
1534 char FileName
[0]; /* New name to be assigned */
1535 } __packed
; /* level 10 Set */
1537 struct smb2_file_link_info
{ /* encoding of request for level 11 */
1538 __u8 ReplaceIfExists
; /* 1 = replace existing link with new */
1539 /* 0 = fail if link already exists */
1541 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1542 __le32 FileNameLength
;
1543 char FileName
[0]; /* Name to be assigned to new link */
1544 } __packed
; /* level 11 Set */
1546 struct smb2_file_full_ea_info
{ /* encoding of response for level 15 */
1547 __le32 next_entry_offset
;
1549 __u8 ea_name_length
;
1550 __le16 ea_value_length
;
1551 char ea_data
[0]; /* \0 terminated name plus value */
1552 } __packed
; /* level 15 Set */
1555 * This level 18, although with struct with same name is different from cifs
1556 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1557 * CurrentByteOffset.
1559 struct smb2_file_all_info
{ /* data block encoding of response to level 18 */
1560 __le64 CreationTime
; /* Beginning of FILE_BASIC_INFO equivalent */
1561 __le64 LastAccessTime
;
1562 __le64 LastWriteTime
;
1565 __u32 Pad1
; /* End of FILE_BASIC_INFO_INFO equivalent */
1566 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
1567 __le64 EndOfFile
; /* size ie offset to first free byte in file */
1568 __le32 NumberOfLinks
; /* hard links */
1571 __u16 Pad2
; /* End of FILE_STANDARD_INFO equivalent */
1575 __le64 CurrentByteOffset
;
1577 __le32 AlignmentRequirement
;
1578 __le32 FileNameLength
;
1580 } __packed
; /* level 18 Query */
1582 struct smb2_file_eof_info
{ /* encoding of request for level 10 */
1583 __le64 EndOfFile
; /* new end of file value */
1584 } __packed
; /* level 20 Set */
1586 struct smb2_file_network_open_info
{
1587 __le64 CreationTime
;
1588 __le64 LastAccessTime
;
1589 __le64 LastWriteTime
;
1591 __le64 AllocationSize
;
1595 } __packed
; /* level 34 Query also similar returned in close rsp and open rsp */
1597 /* See MS-FSCC 2.4.43 */
1598 struct smb2_file_id_information
{
1599 __le64 VolumeSerialNumber
;
1600 __u64 PersistentFileId
; /* opaque endianness */
1601 __u64 VolatileFileId
; /* opaque endianness */
1602 } __packed
; /* level 59 */
1604 extern char smb2_padding
[7];
1606 /* equivalent of the contents of SMB3.1.1 POSIX open context response */
1607 struct smb_posix_info
{
1614 #endif /* _SMB2PDU_H */