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)
94 #define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)
97 * SMB2 Header Definition
99 * "MBZ" : Must be Zero
100 * "BB" : BugBug, Something to check/review/analyze later
101 * "PDU" : "Protocol Data Unit" (ie a network "frame")
105 #define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
107 struct smb2_sync_hdr
{
108 __le32 ProtocolId
; /* 0xFE 'S' 'M' 'B' */
109 __le16 StructureSize
; /* 64 */
110 __le16 CreditCharge
; /* MBZ */
111 __le32 Status
; /* Error from server */
113 __le16 CreditRequest
; /* CreditResponse */
118 __u32 TreeId
; /* opaque - so do not make little endian */
119 __u64 SessionId
; /* opaque - so do not make little endian */
123 /* The total header size for SMB2 read and write */
124 #define SMB2_READWRITE_PDU_HEADER_SIZE (48 + sizeof(struct smb2_sync_hdr))
126 struct smb2_sync_pdu
{
127 struct smb2_sync_hdr sync_hdr
;
128 __le16 StructureSize2
; /* size of wct area (varies, request specific) */
131 #define SMB3_AES128CCM_NONCE 11
132 #define SMB3_AES128GCM_NONCE 12
134 /* Transform flags (for 3.0 dialect this flag indicates CCM */
135 #define TRANSFORM_FLAG_ENCRYPTED 0x0001
136 struct smb2_transform_hdr
{
137 __le32 ProtocolId
; /* 0xFD 'S' 'M' 'B' */
140 __le32 OriginalMessageSize
;
142 __le16 Flags
; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
146 /* See MS-SMB2 2.2.42 */
147 struct smb2_compression_transform_hdr
{
148 __le32 ProtocolId
; /* 0xFC 'S' 'M' 'B' */
149 __le32 OriginalCompressedSegmentSize
;
150 __le16 CompressionAlgorithm
;
152 __le16 Length
; /* if chained it is length, else offset */
155 /* See MS-SMB2 2.2.42.1 */
156 struct compression_payload_header
{
162 /* See MS-SMB2 2.2.42.2 */
163 struct compression_pattern_payload_v1
{
171 * SMB2 flag definitions
173 #define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
174 #define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
175 #define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
176 #define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
177 #define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
178 #define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
179 #define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
182 * Definitions for SMB2 Protocol Data Units (network frames)
184 * See MS-SMB2.PDF specification for protocol details.
185 * The Naming convention is the lower case version of the SMB2
186 * command code name for the struct. Note that structures must be packed.
190 #define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
192 #define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
194 struct smb2_err_rsp
{
195 struct smb2_sync_hdr sync_hdr
;
196 __le16 StructureSize
;
197 __le16 Reserved
; /* MBZ */
198 __le32 ByteCount
; /* even if zero, at least one byte follows */
199 __u8 ErrorData
[1]; /* variable length */
202 #define SYMLINK_ERROR_TAG 0x4c4d5953
204 struct smb2_symlink_err_rsp
{
205 __le32 SymLinkLength
;
206 __le32 SymLinkErrorTag
;
208 __le16 ReparseDataLength
;
209 __le16 UnparsedPathLength
;
210 __le16 SubstituteNameOffset
;
211 __le16 SubstituteNameLength
;
212 __le16 PrintNameOffset
;
213 __le16 PrintNameLength
;
218 /* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
219 struct smb2_error_context_rsp
{
220 __le32 ErrorDataLength
;
222 __u8 ErrorContextData
; /* ErrorDataLength long array */
226 #define SMB2_ERROR_ID_DEFAULT 0x00000000
227 #define SMB2_ERROR_ID_SHARE_REDIRECT cpu_to_le32(0x72645253) /* "rdRS" */
229 /* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
230 #define MOVE_DST_IPADDR_V4 cpu_to_le32(0x00000001)
231 #define MOVE_DST_IPADDR_V6 cpu_to_le32(0x00000002)
233 struct move_dst_ipaddr
{
236 __u8 address
[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
239 struct share_redirect_error_context_rsp
{
240 __le32 StructureSize
;
241 __le32 NotificationType
;
242 __le32 ResourceNameOffset
;
243 __le32 ResourceNameLength
;
247 struct move_dst_ipaddr IpAddrMoveList
[];
248 /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
251 #define SMB2_CLIENT_GUID_SIZE 16
253 struct smb2_negotiate_req
{
254 struct smb2_sync_hdr sync_hdr
;
255 __le16 StructureSize
; /* Must be 36 */
258 __le16 Reserved
; /* MBZ */
260 __u8 ClientGUID
[SMB2_CLIENT_GUID_SIZE
];
261 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
262 __le32 NegotiateContextOffset
; /* SMB3.1.1 only. MBZ earlier */
263 __le16 NegotiateContextCount
; /* SMB3.1.1 only. MBZ earlier */
265 __le16 Dialects
[1]; /* One dialect (vers=) at a time for now */
269 #define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
270 #define SMB20_PROT_ID 0x0202
271 #define SMB21_PROT_ID 0x0210
272 #define SMB30_PROT_ID 0x0300
273 #define SMB302_PROT_ID 0x0302
274 #define SMB311_PROT_ID 0x0311
275 #define BAD_PROT_ID 0xFFFF
277 /* SecurityMode flags */
278 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
279 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
280 #define SMB2_SEC_MODE_FLAGS_ALL 0x0003
282 /* Capabilities flags */
283 #define SMB2_GLOBAL_CAP_DFS 0x00000001
284 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
285 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
286 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
287 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
288 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
289 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
291 #define SMB2_NT_FIND 0x00100000
292 #define SMB2_LARGE_FILES 0x00200000
295 /* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
296 #define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
297 #define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
298 #define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
299 #define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
300 #define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
302 struct smb2_neg_context
{
306 /* Followed by array of data */
309 #define SMB311_SALT_SIZE 32
310 /* Hash Algorithm Types */
311 #define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
312 #define SMB2_PREAUTH_HASH_SIZE 64
314 #define MIN_PREAUTH_CTXT_DATA_LEN (SMB311_SALT_SIZE + 6)
315 struct smb2_preauth_neg_context
{
316 __le16 ContextType
; /* 1 */
319 __le16 HashAlgorithmCount
; /* 1 */
321 __le16 HashAlgorithms
; /* HashAlgorithms[0] since only one defined */
322 __u8 Salt
[SMB311_SALT_SIZE
];
325 /* Encryption Algorithms Ciphers */
326 #define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
327 #define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
329 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
330 #define MIN_ENCRYPT_CTXT_DATA_LEN 4
331 struct smb2_encryption_neg_context
{
332 __le16 ContextType
; /* 2 */
335 __le16 CipherCount
; /* AES-128-GCM and AES-128-CCM */
339 /* See MS-SMB2 2.2.3.1.3 */
340 #define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
341 #define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
342 #define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
343 #define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
344 /* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
345 #define SMB3_COMPRESS_PATTERN cpu_to_le16(0x0004) /* Pattern_V1 */
347 /* Compression Flags */
348 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE cpu_to_le32(0x00000000)
349 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED cpu_to_le32(0x00000001)
351 struct smb2_compression_capabilities_context
{
352 __le16 ContextType
; /* 3 */
355 __le16 CompressionAlgorithmCount
;
358 __le16 CompressionAlgorithms
[3];
362 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
363 * Its struct simply contains NetName, an array of Unicode characters
365 struct smb2_netname_neg_context
{
366 __le16 ContextType
; /* 0x100 */
369 __le16 NetName
[]; /* hostname of target converted to UCS-2 */
372 #define POSIX_CTXT_DATA_LEN 16
373 struct smb2_posix_neg_context
{
374 __le16 ContextType
; /* 0x100 */
377 __u8 Name
[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
380 struct smb2_negotiate_rsp
{
381 struct smb2_sync_hdr sync_hdr
;
382 __le16 StructureSize
; /* Must be 65 */
384 __le16 DialectRevision
;
385 __le16 NegotiateContextCount
; /* Prior to SMB3.1.1 was Reserved & MBZ */
388 __le32 MaxTransactSize
;
391 __le64 SystemTime
; /* MBZ */
392 __le64 ServerStartTime
;
393 __le16 SecurityBufferOffset
;
394 __le16 SecurityBufferLength
;
395 __le32 NegotiateContextOffset
; /* Pre:SMB3.1.1 was reserved/ignored */
396 __u8 Buffer
[1]; /* variable length GSS security buffer */
400 #define SMB2_SESSION_REQ_FLAG_BINDING 0x01
401 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
403 struct smb2_sess_setup_req
{
404 struct smb2_sync_hdr sync_hdr
;
405 __le16 StructureSize
; /* Must be 25 */
410 __le16 SecurityBufferOffset
;
411 __le16 SecurityBufferLength
;
412 __u64 PreviousSessionId
;
413 __u8 Buffer
[1]; /* variable length GSS security buffer */
416 /* Currently defined SessionFlags */
417 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
418 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
419 #define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
420 struct smb2_sess_setup_rsp
{
421 struct smb2_sync_hdr sync_hdr
;
422 __le16 StructureSize
; /* Must be 9 */
424 __le16 SecurityBufferOffset
;
425 __le16 SecurityBufferLength
;
426 __u8 Buffer
[1]; /* variable length GSS security buffer */
429 struct smb2_logoff_req
{
430 struct smb2_sync_hdr sync_hdr
;
431 __le16 StructureSize
; /* Must be 4 */
435 struct smb2_logoff_rsp
{
436 struct smb2_sync_hdr sync_hdr
;
437 __le16 StructureSize
; /* Must be 4 */
441 /* Flags/Reserved for SMB3.1.1 */
442 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
443 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
444 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
446 struct smb2_tree_connect_req
{
447 struct smb2_sync_hdr sync_hdr
;
448 __le16 StructureSize
; /* Must be 9 */
449 __le16 Flags
; /* Reserved MBZ for dialects prior to SMB3.1.1 */
452 __u8 Buffer
[1]; /* variable length */
455 /* See MS-SMB2 section 2.2.9.2 */
457 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
458 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
460 struct tree_connect_contexts
{
467 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
468 struct smb3_blob_data
{
473 /* Valid values for Attr */
474 #define SE_GROUP_MANDATORY 0x00000001
475 #define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
476 #define SE_GROUP_ENABLED 0x00000004
477 #define SE_GROUP_OWNER 0x00000008
478 #define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
479 #define SE_GROUP_INTEGRITY 0x00000020
480 #define SE_GROUP_INTEGRITY_ENABLED 0x00000040
481 #define SE_GROUP_RESOURCE 0x20000000
482 #define SE_GROUP_LOGON_ID 0xC0000000
484 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
486 struct sid_array_data
{
488 /* SidAttrList - array of sid_attr_data structs */
491 struct luid_attr_data
{
496 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
497 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
500 struct privilege_array_data
{
501 __le16 PrivilegeCount
;
502 /* array of privilege_data structs */
505 struct remoted_identity_tcon_context
{
506 __le16 TicketType
; /* must be 0x0001 */
507 __le16 TicketSize
; /* total size of this struct */
508 __le16 User
; /* offset to SID_ATTR_DATA struct with user info */
509 __le16 UserName
; /* offset to null terminated Unicode username string */
510 __le16 Domain
; /* offset to null terminated Unicode domain name */
511 __le16 Groups
; /* offset to SID_ARRAY_DATA struct with group info */
512 __le16 RestrictedGroups
; /* similar to above */
513 __le16 Privileges
; /* offset to PRIVILEGE_ARRAY_DATA struct */
514 __le16 PrimaryGroup
; /* offset to SID_ARRAY_DATA struct */
515 __le16 Owner
; /* offset to BLOB_DATA struct */
516 __le16 DefaultDacl
; /* offset to BLOB_DATA struct */
517 __le16 DeviceGroups
; /* offset to SID_ARRAY_DATA struct */
518 __le16 UserClaims
; /* offset to BLOB_DATA struct */
519 __le16 DeviceClaims
; /* offset to BLOB_DATA struct */
520 __u8 TicketInfo
[]; /* variable length buf - remoted identity data */
523 struct smb2_tree_connect_req_extension
{
524 __le32 TreeConnectContextOffset
;
525 __le16 TreeConnectContextCount
;
527 __u8 PathName
[]; /* variable sized array */
528 /* followed by array of TreeConnectContexts */
531 struct smb2_tree_connect_rsp
{
532 struct smb2_sync_hdr sync_hdr
;
533 __le16 StructureSize
; /* Must be 16 */
534 __u8 ShareType
; /* see below */
536 __le32 ShareFlags
; /* see below */
537 __le32 Capabilities
; /* see below */
538 __le32 MaximalAccess
;
541 /* Possible ShareType values */
542 #define SMB2_SHARE_TYPE_DISK 0x01
543 #define SMB2_SHARE_TYPE_PIPE 0x02
544 #define SMB2_SHARE_TYPE_PRINT 0x03
547 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
548 * must be set (any of the remaining, SHI1005, flags may be set individually
551 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
552 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
553 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
554 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
555 #define SHI1005_FLAGS_DFS 0x00000001
556 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
557 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
558 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
559 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
560 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
561 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
562 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
563 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
564 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
565 #define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
566 #define SHI1005_FLAGS_ALL 0x0004FF33
568 /* Possible share capabilities */
569 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
570 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
571 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
572 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
573 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
574 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
576 struct smb2_tree_disconnect_req
{
577 struct smb2_sync_hdr sync_hdr
;
578 __le16 StructureSize
; /* Must be 4 */
582 struct smb2_tree_disconnect_rsp
{
583 struct smb2_sync_hdr sync_hdr
;
584 __le16 StructureSize
; /* Must be 4 */
588 /* File Attrubutes */
589 #define FILE_ATTRIBUTE_READONLY 0x00000001
590 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
591 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
592 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
593 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
594 #define FILE_ATTRIBUTE_NORMAL 0x00000080
595 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
596 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
597 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
598 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
599 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
600 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
601 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
602 #define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
603 #define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
606 #define SMB2_OPLOCK_LEVEL_NONE 0x00
607 #define SMB2_OPLOCK_LEVEL_II 0x01
608 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
609 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
610 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
611 /* Non-spec internal type */
612 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
614 /* Desired Access Flags */
615 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
616 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
617 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
618 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
619 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
620 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
621 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
622 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
623 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
624 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
625 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
626 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
627 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
628 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
629 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
630 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
631 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
632 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
633 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
635 /* ShareAccess Flags */
636 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
637 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
638 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
639 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
641 /* CreateDisposition Flags */
642 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
643 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
644 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
645 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
646 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
647 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
649 /* CreateOptions Flags */
650 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
651 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
652 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
653 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
654 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
655 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
656 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
657 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
658 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
659 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
660 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
661 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
662 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
663 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
664 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
665 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
666 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
667 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
668 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
670 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
671 | FILE_READ_ATTRIBUTES_LE)
672 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
673 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
674 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
676 /* Impersonation Levels. See MS-WPO section 9.7 and MSDN-IMPERS */
677 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
678 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
679 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
680 #define IL_DELEGATE cpu_to_le32(0x00000003)
682 /* Create Context Values */
683 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
684 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
685 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
686 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
687 #define SMB2_CREATE_ALLOCATION_SIZE "AISi"
688 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
689 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
690 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
691 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
692 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
693 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
694 #define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
695 #define SMB2_CREATE_APP_INSTANCE_VERSION 0xB982D0B73B56074FA07B524A8116A010
696 #define SVHDX_OPEN_DEVICE_CONTEX 0x9CCBCF9E04C1E643980E158DA1F6EC83
697 #define SMB2_CREATE_TAG_POSIX 0x93AD25509CB411E7B42383DE968BCD7C
699 /* Flag (SMB3 open response) values */
700 #define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
703 * Maximum number of iovs we need for an open/create request.
704 * [0] : struct smb2_create_req
706 * [2] : lease context
707 * [3] : durable context
708 * [4] : posix context
709 * [5] : time warp context
710 * [6] : query id context
711 * [7] : compound padding
713 #define SMB2_CREATE_IOV_SIZE 8
715 struct smb2_create_req
{
716 struct smb2_sync_hdr sync_hdr
;
717 __le16 StructureSize
; /* Must be 57 */
719 __u8 RequestedOplockLevel
;
720 __le32 ImpersonationLevel
;
721 __le64 SmbCreateFlags
;
723 __le32 DesiredAccess
;
724 __le32 FileAttributes
;
726 __le32 CreateDisposition
;
727 __le32 CreateOptions
;
730 __le32 CreateContextsOffset
;
731 __le32 CreateContextsLength
;
736 * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
737 * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
738 * 2 bytes of padding.
740 #define MAX_SMB2_CREATE_RESPONSE_SIZE 880
742 struct smb2_create_rsp
{
743 struct smb2_sync_hdr sync_hdr
;
744 __le16 StructureSize
; /* Must be 89 */
746 __u8 Flag
; /* 0x01 if reparse point */
749 __le64 LastAccessTime
;
750 __le64 LastWriteTime
;
752 __le64 AllocationSize
;
754 __le32 FileAttributes
;
756 __u64 PersistentFileId
; /* opaque endianness */
757 __u64 VolatileFileId
; /* opaque endianness */
758 __le32 CreateContextsOffset
;
759 __le32 CreateContextsLength
;
763 struct create_context
{
773 #define SMB2_LEASE_READ_CACHING_HE 0x01
774 #define SMB2_LEASE_HANDLE_CACHING_HE 0x02
775 #define SMB2_LEASE_WRITE_CACHING_HE 0x04
777 #define SMB2_LEASE_NONE cpu_to_le32(0x00)
778 #define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
779 #define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
780 #define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
782 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x00000002)
783 #define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
785 #define SMB2_LEASE_KEY_SIZE 16
787 struct lease_context
{
788 u8 LeaseKey
[SMB2_LEASE_KEY_SIZE
];
791 __le64 LeaseDuration
;
794 struct lease_context_v2
{
795 u8 LeaseKey
[SMB2_LEASE_KEY_SIZE
];
798 __le64 LeaseDuration
;
799 __le64 ParentLeaseKeyLow
;
800 __le64 ParentLeaseKeyHigh
;
805 struct create_lease
{
806 struct create_context ccontext
;
808 struct lease_context lcontext
;
811 struct create_lease_v2
{
812 struct create_context ccontext
;
814 struct lease_context_v2 lcontext
;
818 struct create_durable
{
819 struct create_context ccontext
;
824 __u64 PersistentFileId
;
825 __u64 VolatileFileId
;
830 struct create_posix
{
831 struct create_context ccontext
;
837 /* See MS-SMB2 2.2.13.2.11 */
839 #define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
840 struct durable_context_v2
{
847 struct create_durable_v2
{
848 struct create_context ccontext
;
850 struct durable_context_v2 dcontext
;
853 /* See MS-SMB2 2.2.13.2.12 */
854 struct durable_reconnect_context_v2
{
856 __u64 PersistentFileId
;
857 __u64 VolatileFileId
;
860 __le32 Flags
; /* see above DHANDLE_FLAG_PERSISTENT */
863 /* See MS-SMB2 2.2.14.2.9 */
864 struct create_on_disk_id
{
865 struct create_context ccontext
;
872 /* See MS-SMB2 2.2.14.2.12 */
873 struct durable_reconnect_context_v2_rsp
{
875 __le32 Flags
; /* see above DHANDLE_FLAG_PERSISTENT */
878 struct create_durable_handle_reconnect_v2
{
879 struct create_context ccontext
;
881 struct durable_reconnect_context_v2 dcontext
;
885 /* See MS-SMB2 2.2.13.2.5 */
886 struct crt_twarp_ctxt
{
887 struct create_context ccontext
;
893 /* See MS-SMB2 2.2.13.2.9 */
894 struct crt_query_id_ctxt
{
895 struct create_context ccontext
;
900 struct create_context ccontext
;
904 /* Followed by at least 4 ACEs */
908 #define COPY_CHUNK_RES_KEY_SIZE 24
909 struct resume_key_req
{
910 char ResumeKey
[COPY_CHUNK_RES_KEY_SIZE
];
911 __le32 ContextLength
; /* MBZ */
912 char Context
[]; /* ignored, Windows sets to 4 bytes of zero */
915 /* this goes in the ioctl buffer when doing a copychunk request */
916 struct copychunk_ioctl
{
917 char SourceKey
[COPY_CHUNK_RES_KEY_SIZE
];
918 __le32 ChunkCount
; /* we are only sending 1 */
920 /* array will only be one chunk long for us */
923 __le32 Length
; /* how many bytes to copy */
927 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
928 struct file_zero_data_information
{
930 __le64 BeyondFinalZero
;
933 struct copychunk_ioctl_rsp
{
934 __le32 ChunksWritten
;
935 __le32 ChunkBytesWritten
;
936 __le32 TotalBytesWritten
;
939 struct fsctl_set_integrity_information_req
{
940 __le16 ChecksumAlgorithm
;
945 struct fsctl_get_integrity_information_rsp
{
946 __le16 ChecksumAlgorithm
;
949 __le32 ChecksumChunkSizeInBytes
;
950 __le32 ClusterSizeInBytes
;
953 struct file_allocated_range_buffer
{
958 /* Integrity ChecksumAlgorithm choices for above */
959 #define CHECKSUM_TYPE_NONE 0x0000
960 #define CHECKSUM_TYPE_CRC64 0x0002
961 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
963 /* Integrity flags for above */
964 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
966 /* Reparse structures - see MS-FSCC 2.1.2 */
968 /* struct fsctl_reparse_info_req is empty, only response structs (see below) */
970 struct reparse_data_buffer
{
972 __le16 ReparseDataLength
;
974 __u8 DataBuffer
[]; /* Variable Length */
977 struct reparse_guid_data_buffer
{
979 __le16 ReparseDataLength
;
981 __u8 ReparseGuid
[16];
982 __u8 DataBuffer
[]; /* Variable Length */
985 struct reparse_mount_point_data_buffer
{
987 __le16 ReparseDataLength
;
989 __le16 SubstituteNameOffset
;
990 __le16 SubstituteNameLength
;
991 __le16 PrintNameOffset
;
992 __le16 PrintNameLength
;
993 __u8 PathBuffer
[]; /* Variable Length */
996 #define SYMLINK_FLAG_RELATIVE 0x00000001
998 struct reparse_symlink_data_buffer
{
1000 __le16 ReparseDataLength
;
1002 __le16 SubstituteNameOffset
;
1003 __le16 SubstituteNameLength
;
1004 __le16 PrintNameOffset
;
1005 __le16 PrintNameLength
;
1007 __u8 PathBuffer
[]; /* Variable Length */
1010 /* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
1013 /* See MS-DFSC 2.2.2 */
1014 struct fsctl_get_dfs_referral_req
{
1015 __le16 MaxReferralLevel
;
1016 __u8 RequestFileName
[];
1019 /* DFS response is struct get_dfs_refer_rsp */
1021 /* See MS-SMB2 2.2.31.3 */
1022 struct network_resiliency_req
{
1026 /* There is no buffer for the response ie no struct network_resiliency_rsp */
1029 struct validate_negotiate_info_req
{
1030 __le32 Capabilities
;
1031 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
1032 __le16 SecurityMode
;
1033 __le16 DialectCount
;
1034 __le16 Dialects
[4]; /* BB expand this if autonegotiate > 4 dialects */
1037 struct validate_negotiate_info_rsp
{
1038 __le32 Capabilities
;
1039 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
1040 __le16 SecurityMode
;
1041 __le16 Dialect
; /* Dialect in use for the connection */
1044 #define RSS_CAPABLE cpu_to_le32(0x00000001)
1045 #define RDMA_CAPABLE cpu_to_le32(0x00000002)
1047 #define INTERNETWORK cpu_to_le16(0x0002)
1048 #define INTERNETWORKV6 cpu_to_le16(0x0017)
1050 struct network_interface_info_ioctl_rsp
{
1051 __le32 Next
; /* next interface. zero if this is last one */
1053 __le32 Capability
; /* RSS or RDMA Capable */
1060 struct iface_info_ipv4
{
1066 struct iface_info_ipv6
{
1069 __u8 IPv6Address
[16];
1073 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
1075 struct compress_ioctl
{
1076 __le16 CompressionState
; /* See cifspdu.h for possible flag values */
1079 struct duplicate_extents_to_file
{
1080 __u64 PersistentFileHandle
; /* source file handle, opaque endianness */
1081 __u64 VolatileFileHandle
;
1082 __le64 SourceFileOffset
;
1083 __le64 TargetFileOffset
;
1084 __le64 ByteCount
; /* Bytes to be copied */
1088 * Maximum number of iovs we need for an ioctl request.
1089 * [0] : struct smb2_ioctl_req
1092 #define SMB2_IOCTL_IOV_SIZE 2
1094 struct smb2_ioctl_req
{
1095 struct smb2_sync_hdr sync_hdr
;
1096 __le16 StructureSize
; /* Must be 57 */
1099 __u64 PersistentFileId
; /* opaque endianness */
1100 __u64 VolatileFileId
; /* opaque endianness */
1103 __le32 MaxInputResponse
;
1104 __le32 OutputOffset
;
1106 __le32 MaxOutputResponse
;
1112 struct smb2_ioctl_rsp
{
1113 struct smb2_sync_hdr sync_hdr
;
1114 __le16 StructureSize
; /* Must be 57 */
1117 __u64 PersistentFileId
; /* opaque endianness */
1118 __u64 VolatileFileId
; /* opaque endianness */
1121 __le32 OutputOffset
;
1125 /* char * buffer[] */
1128 /* Currently defined values for close flags */
1129 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
1130 struct smb2_close_req
{
1131 struct smb2_sync_hdr sync_hdr
;
1132 __le16 StructureSize
; /* Must be 24 */
1135 __u64 PersistentFileId
; /* opaque endianness */
1136 __u64 VolatileFileId
; /* opaque endianness */
1140 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
1142 #define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
1144 struct smb2_close_rsp
{
1145 struct smb2_sync_hdr sync_hdr
;
1146 __le16 StructureSize
; /* 60 */
1149 __le64 CreationTime
;
1150 __le64 LastAccessTime
;
1151 __le64 LastWriteTime
;
1153 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
1158 struct smb2_flush_req
{
1159 struct smb2_sync_hdr sync_hdr
;
1160 __le16 StructureSize
; /* Must be 24 */
1163 __u64 PersistentFileId
; /* opaque endianness */
1164 __u64 VolatileFileId
; /* opaque endianness */
1167 struct smb2_flush_rsp
{
1168 struct smb2_sync_hdr sync_hdr
;
1169 __le16 StructureSize
;
1173 /* For read request Flags field below, following flag is defined for SMB3.02 */
1174 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
1175 #define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
1177 /* Channel field for read and write: exactly one of following flags can be set*/
1178 #define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
1179 #define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001) /* SMB3 or later */
1180 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1182 /* SMB2 read request without RFC1001 length at the beginning */
1183 struct smb2_read_plain_req
{
1184 struct smb2_sync_hdr sync_hdr
;
1185 __le16 StructureSize
; /* Must be 49 */
1186 __u8 Padding
; /* offset from start of SMB2 header to place read */
1187 __u8 Flags
; /* MBZ unless SMB3.02 or later */
1190 __u64 PersistentFileId
; /* opaque endianness */
1191 __u64 VolatileFileId
; /* opaque endianness */
1192 __le32 MinimumCount
;
1193 __le32 Channel
; /* MBZ except for SMB3 or later */
1194 __le32 RemainingBytes
;
1195 __le16 ReadChannelInfoOffset
;
1196 __le16 ReadChannelInfoLength
;
1200 struct smb2_read_rsp
{
1201 struct smb2_sync_hdr sync_hdr
;
1202 __le16 StructureSize
; /* Must be 17 */
1206 __le32 DataRemaining
;
1211 /* For write request Flags field below the following flags are defined: */
1212 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
1213 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
1215 struct smb2_write_req
{
1216 struct smb2_sync_hdr sync_hdr
;
1217 __le16 StructureSize
; /* Must be 49 */
1218 __le16 DataOffset
; /* offset from start of SMB2 header to write data */
1221 __u64 PersistentFileId
; /* opaque endianness */
1222 __u64 VolatileFileId
; /* opaque endianness */
1223 __le32 Channel
; /* MBZ unless SMB3.02 or later */
1224 __le32 RemainingBytes
;
1225 __le16 WriteChannelInfoOffset
;
1226 __le16 WriteChannelInfoLength
;
1231 struct smb2_write_rsp
{
1232 struct smb2_sync_hdr sync_hdr
;
1233 __le16 StructureSize
; /* Must be 17 */
1237 __le32 DataRemaining
;
1243 #define SMB2_WATCH_TREE 0x0001
1245 /* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
1246 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
1247 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
1248 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
1249 #define FILE_NOTIFY_CHANGE_SIZE 0x00000008
1250 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
1251 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
1252 #define FILE_NOTIFY_CHANGE_CREATION 0x00000040
1253 #define FILE_NOTIFY_CHANGE_EA 0x00000080
1254 #define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
1255 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1256 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1257 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1259 struct smb2_change_notify_req
{
1260 struct smb2_sync_hdr sync_hdr
;
1261 __le16 StructureSize
;
1263 __le32 OutputBufferLength
;
1264 __u64 PersistentFileId
; /* opaque endianness */
1265 __u64 VolatileFileId
; /* opaque endianness */
1266 __le32 CompletionFilter
;
1270 struct smb2_change_notify_rsp
{
1271 struct smb2_sync_hdr sync_hdr
;
1272 __le16 StructureSize
; /* Must be 9 */
1273 __le16 OutputBufferOffset
;
1274 __le32 OutputBufferLength
;
1275 __u8 Buffer
[1]; /* array of file notify structs */
1278 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
1279 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
1280 #define SMB2_LOCKFLAG_UNLOCK 0x0004
1281 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
1283 struct smb2_lock_element
{
1290 struct smb2_lock_req
{
1291 struct smb2_sync_hdr sync_hdr
;
1292 __le16 StructureSize
; /* Must be 48 */
1295 __u64 PersistentFileId
; /* opaque endianness */
1296 __u64 VolatileFileId
; /* opaque endianness */
1297 /* Followed by at least one */
1298 struct smb2_lock_element locks
[1];
1301 struct smb2_lock_rsp
{
1302 struct smb2_sync_hdr sync_hdr
;
1303 __le16 StructureSize
; /* Must be 4 */
1307 struct smb2_echo_req
{
1308 struct smb2_sync_hdr sync_hdr
;
1309 __le16 StructureSize
; /* Must be 4 */
1313 struct smb2_echo_rsp
{
1314 struct smb2_sync_hdr sync_hdr
;
1315 __le16 StructureSize
; /* Must be 4 */
1319 /* search (query_directory) Flags field */
1320 #define SMB2_RESTART_SCANS 0x01
1321 #define SMB2_RETURN_SINGLE_ENTRY 0x02
1322 #define SMB2_INDEX_SPECIFIED 0x04
1323 #define SMB2_REOPEN 0x10
1325 #define SMB2_QUERY_DIRECTORY_IOV_SIZE 2
1327 struct smb2_query_directory_req
{
1328 struct smb2_sync_hdr sync_hdr
;
1329 __le16 StructureSize
; /* Must be 33 */
1330 __u8 FileInformationClass
;
1333 __u64 PersistentFileId
; /* opaque endianness */
1334 __u64 VolatileFileId
; /* opaque endianness */
1335 __le16 FileNameOffset
;
1336 __le16 FileNameLength
;
1337 __le32 OutputBufferLength
;
1341 struct smb2_query_directory_rsp
{
1342 struct smb2_sync_hdr sync_hdr
;
1343 __le16 StructureSize
; /* Must be 9 */
1344 __le16 OutputBufferOffset
;
1345 __le32 OutputBufferLength
;
1349 /* Possible InfoType values */
1350 #define SMB2_O_INFO_FILE 0x01
1351 #define SMB2_O_INFO_FILESYSTEM 0x02
1352 #define SMB2_O_INFO_SECURITY 0x03
1353 #define SMB2_O_INFO_QUOTA 0x04
1355 /* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1356 #define OWNER_SECINFO 0x00000001
1357 #define GROUP_SECINFO 0x00000002
1358 #define DACL_SECINFO 0x00000004
1359 #define SACL_SECINFO 0x00000008
1360 #define LABEL_SECINFO 0x00000010
1361 #define ATTRIBUTE_SECINFO 0x00000020
1362 #define SCOPE_SECINFO 0x00000040
1363 #define BACKUP_SECINFO 0x00010000
1364 #define UNPROTECTED_SACL_SECINFO 0x10000000
1365 #define UNPROTECTED_DACL_SECINFO 0x20000000
1366 #define PROTECTED_SACL_SECINFO 0x40000000
1367 #define PROTECTED_DACL_SECINFO 0x80000000
1369 /* Flags used for FileFullEAinfo */
1370 #define SL_RESTART_SCAN 0x00000001
1371 #define SL_RETURN_SINGLE_ENTRY 0x00000002
1372 #define SL_INDEX_SPECIFIED 0x00000004
1374 struct smb2_query_info_req
{
1375 struct smb2_sync_hdr sync_hdr
;
1376 __le16 StructureSize
; /* Must be 41 */
1379 __le32 OutputBufferLength
;
1380 __le16 InputBufferOffset
;
1382 __le32 InputBufferLength
;
1383 __le32 AdditionalInformation
;
1385 __u64 PersistentFileId
; /* opaque endianness */
1386 __u64 VolatileFileId
; /* opaque endianness */
1390 struct smb2_query_info_rsp
{
1391 struct smb2_sync_hdr sync_hdr
;
1392 __le16 StructureSize
; /* Must be 9 */
1393 __le16 OutputBufferOffset
;
1394 __le32 OutputBufferLength
;
1399 * Maximum number of iovs we need for a set-info request.
1400 * The largest one is rename/hardlink
1401 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
1403 * [2] : compound padding
1405 #define SMB2_SET_INFO_IOV_SIZE 3
1407 struct smb2_set_info_req
{
1408 struct smb2_sync_hdr sync_hdr
;
1409 __le16 StructureSize
; /* Must be 33 */
1412 __le32 BufferLength
;
1413 __le16 BufferOffset
;
1415 __le32 AdditionalInformation
;
1416 __u64 PersistentFileId
; /* opaque endianness */
1417 __u64 VolatileFileId
; /* opaque endianness */
1421 struct smb2_set_info_rsp
{
1422 struct smb2_sync_hdr sync_hdr
;
1423 __le16 StructureSize
; /* Must be 2 */
1426 struct smb2_oplock_break
{
1427 struct smb2_sync_hdr sync_hdr
;
1428 __le16 StructureSize
; /* Must be 24 */
1432 __u64 PersistentFid
;
1436 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1438 struct smb2_lease_break
{
1439 struct smb2_sync_hdr sync_hdr
;
1440 __le16 StructureSize
; /* Must be 44 */
1444 __le32 CurrentLeaseState
;
1445 __le32 NewLeaseState
;
1447 __le32 AccessMaskHint
;
1448 __le32 ShareMaskHint
;
1451 struct smb2_lease_ack
{
1452 struct smb2_sync_hdr sync_hdr
;
1453 __le16 StructureSize
; /* Must be 36 */
1458 __le64 LeaseDuration
;
1462 * PDU infolevel structure definitions
1463 * BB consider moving to a different header
1466 /* File System Information Classes */
1467 #define FS_VOLUME_INFORMATION 1 /* Query */
1468 #define FS_LABEL_INFORMATION 2 /* Local only */
1469 #define FS_SIZE_INFORMATION 3 /* Query */
1470 #define FS_DEVICE_INFORMATION 4 /* Query */
1471 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1472 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
1473 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
1474 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1475 #define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1476 #define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1477 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1478 #define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1480 struct smb2_fs_full_size_info
{
1481 __le64 TotalAllocationUnits
;
1482 __le64 CallerAvailableAllocationUnits
;
1483 __le64 ActualAvailableAllocationUnits
;
1484 __le32 SectorsPerAllocationUnit
;
1485 __le32 BytesPerSector
;
1488 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1489 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1490 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1491 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1493 /* sector size info struct */
1494 struct smb3_fs_ss_info
{
1495 __le32 LogicalBytesPerSector
;
1496 __le32 PhysicalBytesPerSectorForAtomicity
;
1497 __le32 PhysicalBytesPerSectorForPerf
;
1498 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity
;
1500 __le32 ByteOffsetForSectorAlignment
;
1501 __le32 ByteOffsetForPartitionAlignment
;
1504 /* volume info struct - see MS-FSCC 2.5.9 */
1505 #define MAX_VOL_LABEL_LEN 32
1506 struct smb3_fs_vol_info
{
1507 __le64 VolumeCreationTime
;
1508 __u32 VolumeSerialNumber
;
1509 __le32 VolumeLabelLength
; /* includes trailing null */
1510 __u8 SupportsObjects
; /* True if eg like NTFS, supports objects */
1512 __u8 VolumeLabel
[]; /* variable len */
1515 /* partial list of QUERY INFO levels */
1516 #define FILE_DIRECTORY_INFORMATION 1
1517 #define FILE_FULL_DIRECTORY_INFORMATION 2
1518 #define FILE_BOTH_DIRECTORY_INFORMATION 3
1519 #define FILE_BASIC_INFORMATION 4
1520 #define FILE_STANDARD_INFORMATION 5
1521 #define FILE_INTERNAL_INFORMATION 6
1522 #define FILE_EA_INFORMATION 7
1523 #define FILE_ACCESS_INFORMATION 8
1524 #define FILE_NAME_INFORMATION 9
1525 #define FILE_RENAME_INFORMATION 10
1526 #define FILE_LINK_INFORMATION 11
1527 #define FILE_NAMES_INFORMATION 12
1528 #define FILE_DISPOSITION_INFORMATION 13
1529 #define FILE_POSITION_INFORMATION 14
1530 #define FILE_FULL_EA_INFORMATION 15
1531 #define FILE_MODE_INFORMATION 16
1532 #define FILE_ALIGNMENT_INFORMATION 17
1533 #define FILE_ALL_INFORMATION 18
1534 #define FILE_ALLOCATION_INFORMATION 19
1535 #define FILE_END_OF_FILE_INFORMATION 20
1536 #define FILE_ALTERNATE_NAME_INFORMATION 21
1537 #define FILE_STREAM_INFORMATION 22
1538 #define FILE_PIPE_INFORMATION 23
1539 #define FILE_PIPE_LOCAL_INFORMATION 24
1540 #define FILE_PIPE_REMOTE_INFORMATION 25
1541 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1542 #define FILE_MAILSLOT_SET_INFORMATION 27
1543 #define FILE_COMPRESSION_INFORMATION 28
1544 #define FILE_OBJECT_ID_INFORMATION 29
1545 /* Number 30 not defined in documents */
1546 #define FILE_MOVE_CLUSTER_INFORMATION 31
1547 #define FILE_QUOTA_INFORMATION 32
1548 #define FILE_REPARSE_POINT_INFORMATION 33
1549 #define FILE_NETWORK_OPEN_INFORMATION 34
1550 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
1551 #define FILE_TRACKING_INFORMATION 36
1552 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
1553 #define FILEID_FULL_DIRECTORY_INFORMATION 38
1554 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1555 #define FILE_SHORT_NAME_INFORMATION 40
1556 #define FILE_SFIO_RESERVE_INFORMATION 44
1557 #define FILE_SFIO_VOLUME_INFORMATION 45
1558 #define FILE_HARD_LINK_INFORMATION 46
1559 #define FILE_NORMALIZED_NAME_INFORMATION 48
1560 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1561 #define FILE_STANDARD_LINK_INFORMATION 54
1562 #define FILE_ID_INFORMATION 59
1564 struct smb2_file_internal_info
{
1566 } __packed
; /* level 6 Query */
1568 struct smb2_file_rename_info
{ /* encoding of request for level 10 */
1569 __u8 ReplaceIfExists
; /* 1 = replace existing target with new */
1570 /* 0 = fail if target already exists */
1572 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1573 __le32 FileNameLength
;
1574 char FileName
[]; /* New name to be assigned */
1575 } __packed
; /* level 10 Set */
1577 struct smb2_file_link_info
{ /* encoding of request for level 11 */
1578 __u8 ReplaceIfExists
; /* 1 = replace existing link with new */
1579 /* 0 = fail if link already exists */
1581 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1582 __le32 FileNameLength
;
1583 char FileName
[]; /* Name to be assigned to new link */
1584 } __packed
; /* level 11 Set */
1586 struct smb2_file_full_ea_info
{ /* encoding of response for level 15 */
1587 __le32 next_entry_offset
;
1589 __u8 ea_name_length
;
1590 __le16 ea_value_length
;
1591 char ea_data
[]; /* \0 terminated name plus value */
1592 } __packed
; /* level 15 Set */
1595 * This level 18, although with struct with same name is different from cifs
1596 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1597 * CurrentByteOffset.
1599 struct smb2_file_all_info
{ /* data block encoding of response to level 18 */
1600 __le64 CreationTime
; /* Beginning of FILE_BASIC_INFO equivalent */
1601 __le64 LastAccessTime
;
1602 __le64 LastWriteTime
;
1605 __u32 Pad1
; /* End of FILE_BASIC_INFO_INFO equivalent */
1606 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
1607 __le64 EndOfFile
; /* size ie offset to first free byte in file */
1608 __le32 NumberOfLinks
; /* hard links */
1611 __u16 Pad2
; /* End of FILE_STANDARD_INFO equivalent */
1615 __le64 CurrentByteOffset
;
1617 __le32 AlignmentRequirement
;
1618 __le32 FileNameLength
;
1620 } __packed
; /* level 18 Query */
1622 struct smb2_file_eof_info
{ /* encoding of request for level 10 */
1623 __le64 EndOfFile
; /* new end of file value */
1624 } __packed
; /* level 20 Set */
1626 struct smb2_file_network_open_info
{
1627 __le64 CreationTime
;
1628 __le64 LastAccessTime
;
1629 __le64 LastWriteTime
;
1631 __le64 AllocationSize
;
1635 } __packed
; /* level 34 Query also similar returned in close rsp and open rsp */
1637 /* See MS-FSCC 2.4.43 */
1638 struct smb2_file_id_information
{
1639 __le64 VolumeSerialNumber
;
1640 __u64 PersistentFileId
; /* opaque endianness */
1641 __u64 VolatileFileId
; /* opaque endianness */
1642 } __packed
; /* level 59 */
1644 extern char smb2_padding
[7];
1646 /* equivalent of the contents of SMB3.1.1 POSIX open context response */
1647 struct create_posix_rsp
{
1651 struct cifs_sid owner
; /* var-sized on the wire */
1652 struct cifs_sid group
; /* var-sized on the wire */
1656 * SMB2-only POSIX info level for query dir
1658 * See posix_info_sid_size(), posix_info_extra_size() and
1659 * posix_info_parse() to help with the handling of this struct.
1661 struct smb2_posix_info
{
1662 __le32 NextEntryOffset
;
1664 __le64 CreationTime
;
1665 __le64 LastAccessTime
;
1666 __le64 LastWriteTime
;
1669 __le64 AllocationSize
;
1670 __le32 DosAttributes
;
1674 /* beginning of POSIX Create Context Response */
1679 * var sized owner SID
1680 * var sized group SID
1681 * le32 filenamelength
1686 /* Level 100 query info */
1687 struct smb311_posix_qinfo
{
1688 __le64 CreationTime
;
1689 __le64 LastAccessTime
;
1690 __le64 LastWriteTime
;
1693 __le64 AllocationSize
;
1694 __le32 DosAttributes
;
1698 /* beginning of POSIX Create Context Response */
1704 * var sized owner SID
1705 * var sized group SID
1706 * le32 filenamelength
1712 * Parsed version of the above struct. Allows direct access to the
1713 * variable length fields
1715 struct smb2_posix_info_parsed
{
1716 const struct smb2_posix_info
*base
;
1718 struct cifs_sid owner
;
1719 struct cifs_sid group
;
1724 #endif /* _SMB2PDU_H */